zones

package
v2.4.0 Latest Latest
Warning

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

 Go to latest Published: Jul 16, 2024 License: Apache-2.0 Imports: 17 Imported by: 1

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 CertificateRequestTypeKeylessCertificate = shared.CertificateRequestTypeKeylessCertificate

This is an alias to an internal value.

View Source 
const CertificateRequestTypeOriginECC = shared.CertificateRequestTypeOriginECC

This is an alias to an internal value.

View Source 
const CertificateRequestTypeOriginRSA = shared.CertificateRequestTypeOriginRSA

This is an alias to an internal value.

View Source 
const CloudflareTunnelStatusDegraded = shared.CloudflareTunnelStatusDegraded

This is an alias to an internal value.

View Source 
const CloudflareTunnelStatusDown = shared.CloudflareTunnelStatusDown

This is an alias to an internal value.

View Source 
const CloudflareTunnelStatusHealthy = shared.CloudflareTunnelStatusHealthy

This is an alias to an internal value.

View Source 
const CloudflareTunnelStatusInactive = shared.CloudflareTunnelStatusInactive

This is an alias to an internal value.

View Source 
const CloudflareTunnelTunTypeCNI = shared.CloudflareTunnelTunTypeCNI

This is an alias to an internal value.

View Source 
const CloudflareTunnelTunTypeCfdTunnel = shared.CloudflareTunnelTunTypeCfdTunnel

This is an alias to an internal value.

View Source 
const CloudflareTunnelTunTypeGRE = shared.CloudflareTunnelTunTypeGRE

This is an alias to an internal value.

View Source 
const CloudflareTunnelTunTypeIPSec = shared.CloudflareTunnelTunTypeIPSec

This is an alias to an internal value.

View Source 
const CloudflareTunnelTunTypeWARPConnector = shared.CloudflareTunnelTunTypeWARPConnector

This is an alias to an internal value.

View Source 
const MemberStatusAccepted = shared.MemberStatusAccepted

This is an alias to an internal value.

View Source 
const MemberStatusPending = shared.MemberStatusPending

This is an alias to an internal value.

View Source 
const SortDirectionAsc = shared.SortDirectionAsc

This is an alias to an internal value.

View Source 
const SortDirectionDesc = shared.SortDirectionDesc

This is an alias to an internal value.

Variables

This section is empty.

Functions

This section is empty.

Types

type ASN added in v2.1.0 

type ASN = shared.ASN

This is an alias to an internal type.

type ASNParam added in v2.1.0 

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   []shared.ResponseInfo `json:"errors,required"`
	Messages []shared.ResponseInfo `json:"messages,required"`
	// Whether the API call was successful
	Success ActivationCheckTriggerResponseEnvelopeSuccess `json:"success,required"`
	Result  ActivationCheckTriggerResponse                `json:"result"`
	JSON    activationCheckTriggerResponseEnvelopeJSON    `json:"-"`
}

func (*ActivationCheckTriggerResponseEnvelope) UnmarshalJSON 

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

type ActivationCheckTriggerResponseEnvelopeSuccess 

type ActivationCheckTriggerResponseEnvelopeSuccess bool

Whether the API call was successful 

const (
	ActivationCheckTriggerResponseEnvelopeSuccessTrue ActivationCheckTriggerResponseEnvelopeSuccess = true
)

func (ActivationCheckTriggerResponseEnvelopeSuccess) IsKnown 

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 AdvancedDDoSParam added in v2.4.0 

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

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

func (AdvancedDDoSParam) MarshalJSON added in v2.4.0 

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

type AdvancedDDoSValue 

type AdvancedDDoSValue string

Current value of the zone setting. 

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

func (AdvancedDDoSValue) IsKnown 

func (r AdvancedDDoSValue) IsKnown() bool

type AlwaysOnline 

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

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

func (*AlwaysOnline) UnmarshalJSON 

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

type AlwaysOnlineEditable 

type AlwaysOnlineEditable bool

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

const (
	AlwaysOnlineEditableTrue  AlwaysOnlineEditable = true
	AlwaysOnlineEditableFalse AlwaysOnlineEditable = false
)

func (AlwaysOnlineEditable) IsKnown 

func (r AlwaysOnlineEditable) IsKnown() bool

type AlwaysOnlineID 

type AlwaysOnlineID string

ID of the zone setting. 

const (
	AlwaysOnlineIDAlwaysOnline AlwaysOnlineID = "always_online"
)

func (AlwaysOnlineID) IsKnown 

func (r AlwaysOnlineID) IsKnown() bool

type AlwaysOnlineParam added in v2.4.0 

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

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

func (AlwaysOnlineParam) MarshalJSON added in v2.4.0 

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

type AlwaysOnlineValue 

type AlwaysOnlineValue string

Current value of the zone setting. 

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

func (AlwaysOnlineValue) IsKnown 

func (r AlwaysOnlineValue) IsKnown() bool

type AlwaysUseHTTPS 

type AlwaysUseHTTPS struct {
	// ID of the zone setting.
	ID AlwaysUseHTTPSID `json:"id,required"`
	// Current value of the zone setting.
	Value AlwaysUseHTTPSValue `json:"value,required"`
	// Whether or not this setting can be modified for this zone (based on your
	// Cloudflare plan level).
	Editable AlwaysUseHTTPSEditable `json:"editable"`
	// last time this setting was modified.
	ModifiedOn time.Time          `json:"modified_on,nullable" format:"date-time"`
	JSON       alwaysUseHTTPSJSON `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 (*AlwaysUseHTTPS) UnmarshalJSON 

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

type AlwaysUseHTTPSEditable 

type AlwaysUseHTTPSEditable bool

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

const (
	AlwaysUseHTTPSEditableTrue  AlwaysUseHTTPSEditable = true
	AlwaysUseHTTPSEditableFalse AlwaysUseHTTPSEditable = false
)

func (AlwaysUseHTTPSEditable) IsKnown 

func (r AlwaysUseHTTPSEditable) IsKnown() bool

type AlwaysUseHTTPSID 

type AlwaysUseHTTPSID string

ID of the zone setting. 

const (
	AlwaysUseHTTPSIDAlwaysUseHTTPS AlwaysUseHTTPSID = "always_use_https"
)

func (AlwaysUseHTTPSID) IsKnown 

func (r AlwaysUseHTTPSID) IsKnown() bool

type AlwaysUseHTTPSParam added in v2.4.0 

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

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

func (AlwaysUseHTTPSParam) MarshalJSON added in v2.4.0 

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

type AlwaysUseHTTPSValue 

type AlwaysUseHTTPSValue string

Current value of the zone setting. 

const (
	AlwaysUseHTTPSValueOn  AlwaysUseHTTPSValue = "on"
	AlwaysUseHTTPSValueOff AlwaysUseHTTPSValue = "off"
)

func (AlwaysUseHTTPSValue) IsKnown 

func (r AlwaysUseHTTPSValue) IsKnown() bool

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 {
	// ID of the zone setting.
	ID AutomaticHTTPSRewritesID `json:"id,required"`
	// Current value of the zone setting.
	Value AutomaticHTTPSRewritesValue `json:"value,required"`
	// Whether or not this setting can be modified for this zone (based on your
	// Cloudflare plan level).
	Editable AutomaticHTTPSRewritesEditable `json:"editable"`
	// last time this setting was modified.
	ModifiedOn time.Time                  `json:"modified_on,nullable" format:"date-time"`
	JSON       automaticHTTPSRewritesJSON `json:"-"`
}

Enable the Automatic HTTPS Rewrites feature for this zone.

func (*AutomaticHTTPSRewrites) UnmarshalJSON 

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

type AutomaticHTTPSRewritesEditable 

type AutomaticHTTPSRewritesEditable bool

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

const (
	AutomaticHTTPSRewritesEditableTrue  AutomaticHTTPSRewritesEditable = true
	AutomaticHTTPSRewritesEditableFalse AutomaticHTTPSRewritesEditable = false
)

func (AutomaticHTTPSRewritesEditable) IsKnown 

func (r AutomaticHTTPSRewritesEditable) IsKnown() bool

type AutomaticHTTPSRewritesID 

type AutomaticHTTPSRewritesID string

ID of the zone setting. 

const (
	AutomaticHTTPSRewritesIDAutomaticHTTPSRewrites AutomaticHTTPSRewritesID = "automatic_https_rewrites"
)

func (AutomaticHTTPSRewritesID) IsKnown 

func (r AutomaticHTTPSRewritesID) IsKnown() bool

type AutomaticHTTPSRewritesParam added in v2.4.0 

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

Enable the Automatic HTTPS Rewrites feature for this zone.

func (AutomaticHTTPSRewritesParam) MarshalJSON added in v2.4.0 

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

type AutomaticHTTPSRewritesValue 

type AutomaticHTTPSRewritesValue string

Current value of the zone setting. 

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

func (AutomaticHTTPSRewritesValue) IsKnown 

func (r AutomaticHTTPSRewritesValue) IsKnown() bool

type AutomaticPlatformOptimization 

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

func (*AutomaticPlatformOptimization) UnmarshalJSON 

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

type AutomaticPlatformOptimizationParam 

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

func (AutomaticPlatformOptimizationParam) MarshalJSON 

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

type Brotli 

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

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

func (*Brotli) UnmarshalJSON 

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

type BrotliEditable 

type BrotliEditable bool

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

const (
	BrotliEditableTrue  BrotliEditable = true
	BrotliEditableFalse BrotliEditable = false
)

func (BrotliEditable) IsKnown 

func (r BrotliEditable) IsKnown() bool

type BrotliID 

type BrotliID string

ID of the zone setting. 

const (
	BrotliIDBrotli BrotliID = "brotli"
)

func (BrotliID) IsKnown 

func (r BrotliID) IsKnown() bool

type BrotliParam added in v2.4.0 

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

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

func (BrotliParam) MarshalJSON added in v2.4.0 

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

type BrotliValue 

type BrotliValue string

Current value of the zone setting. 

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

func (BrotliValue) IsKnown 

func (r BrotliValue) IsKnown() bool

type BrowserCacheTTL 

type BrowserCacheTTL struct {
	// ID of the zone setting.
	ID BrowserCacheTTLID `json:"id,required"`
	// Current value of the zone setting.
	Value BrowserCacheTTLValue `json:"value,required"`
	// Whether or not this setting can be modified for this zone (based on your
	// Cloudflare plan level).
	Editable BrowserCacheTTLEditable `json:"editable"`
	// last time this setting was modified.
	ModifiedOn time.Time           `json:"modified_on,nullable" format:"date-time"`
	JSON       browserCacheTTLJSON `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 (*BrowserCacheTTL) UnmarshalJSON 

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

type BrowserCacheTTLEditable 

type BrowserCacheTTLEditable bool

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

const (
	BrowserCacheTTLEditableTrue  BrowserCacheTTLEditable = true
	BrowserCacheTTLEditableFalse BrowserCacheTTLEditable = false
)

func (BrowserCacheTTLEditable) IsKnown 

func (r BrowserCacheTTLEditable) IsKnown() bool

type BrowserCacheTTLID 

type BrowserCacheTTLID string

ID of the zone setting. 

const (
	BrowserCacheTTLIDBrowserCacheTTL BrowserCacheTTLID = "browser_cache_ttl"
)

func (BrowserCacheTTLID) IsKnown 

func (r BrowserCacheTTLID) IsKnown() bool

type BrowserCacheTTLParam added in v2.4.0 

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

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

func (BrowserCacheTTLParam) MarshalJSON added in v2.4.0 

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

type BrowserCacheTTLValue 

type BrowserCacheTTLValue float64

Current value of the zone setting. 

const (
	BrowserCacheTTLValue0        BrowserCacheTTLValue = 0
	BrowserCacheTTLValue30       BrowserCacheTTLValue = 30
	BrowserCacheTTLValue60       BrowserCacheTTLValue = 60
	BrowserCacheTTLValue120      BrowserCacheTTLValue = 120
	BrowserCacheTTLValue300      BrowserCacheTTLValue = 300
	BrowserCacheTTLValue1200     BrowserCacheTTLValue = 1200
	BrowserCacheTTLValue1800     BrowserCacheTTLValue = 1800
	BrowserCacheTTLValue3600     BrowserCacheTTLValue = 3600
	BrowserCacheTTLValue7200     BrowserCacheTTLValue = 7200
	BrowserCacheTTLValue10800    BrowserCacheTTLValue = 10800
	BrowserCacheTTLValue14400    BrowserCacheTTLValue = 14400
	BrowserCacheTTLValue18000    BrowserCacheTTLValue = 18000
	BrowserCacheTTLValue28800    BrowserCacheTTLValue = 28800
	BrowserCacheTTLValue43200    BrowserCacheTTLValue = 43200
	BrowserCacheTTLValue57600    BrowserCacheTTLValue = 57600
	BrowserCacheTTLValue72000    BrowserCacheTTLValue = 72000
	BrowserCacheTTLValue86400    BrowserCacheTTLValue = 86400
	BrowserCacheTTLValue172800   BrowserCacheTTLValue = 172800
	BrowserCacheTTLValue259200   BrowserCacheTTLValue = 259200
	BrowserCacheTTLValue345600   BrowserCacheTTLValue = 345600
	BrowserCacheTTLValue432000   BrowserCacheTTLValue = 432000
	BrowserCacheTTLValue691200   BrowserCacheTTLValue = 691200
	BrowserCacheTTLValue1382400  BrowserCacheTTLValue = 1382400
	BrowserCacheTTLValue2073600  BrowserCacheTTLValue = 2073600
	BrowserCacheTTLValue2678400  BrowserCacheTTLValue = 2678400
	BrowserCacheTTLValue5356800  BrowserCacheTTLValue = 5356800
	BrowserCacheTTLValue16070400 BrowserCacheTTLValue = 16070400
	BrowserCacheTTLValue31536000 BrowserCacheTTLValue = 31536000
)

func (BrowserCacheTTLValue) IsKnown 

func (r BrowserCacheTTLValue) IsKnown() bool

type BrowserCheck 

type BrowserCheck struct {
	// ID of the zone setting.
	ID BrowserCheckID `json:"id,required"`
	// Current value of the zone setting.
	Value BrowserCheckValue `json:"value,required"`
	// Whether or not this setting can be modified for this zone (based on your
	// Cloudflare plan level).
	Editable BrowserCheckEditable `json:"editable"`
	// last time this setting was modified.
	ModifiedOn time.Time        `json:"modified_on,nullable" format:"date-time"`
	JSON       browserCheckJSON `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 (*BrowserCheck) UnmarshalJSON 

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

type BrowserCheckEditable 

type BrowserCheckEditable bool

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

const (
	BrowserCheckEditableTrue  BrowserCheckEditable = true
	BrowserCheckEditableFalse BrowserCheckEditable = false
)

func (BrowserCheckEditable) IsKnown 

func (r BrowserCheckEditable) IsKnown() bool

type BrowserCheckID 

type BrowserCheckID string

ID of the zone setting. 

const (
	BrowserCheckIDBrowserCheck BrowserCheckID = "browser_check"
)

func (BrowserCheckID) IsKnown 

func (r BrowserCheckID) IsKnown() bool

type BrowserCheckParam added in v2.4.0 

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

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

func (BrowserCheckParam) MarshalJSON added in v2.4.0 

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

type BrowserCheckValue 

type BrowserCheckValue string

Current value of the zone setting. 

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

func (BrowserCheckValue) IsKnown 

func (r BrowserCheckValue) IsKnown() bool

type CacheLevel 

type CacheLevel struct {
	// ID of the zone setting.
	ID CacheLevelID `json:"id,required"`
	// Current value of the zone setting.
	Value CacheLevelValue `json:"value,required"`
	// Whether or not this setting can be modified for this zone (based on your
	// Cloudflare plan level).
	Editable CacheLevelEditable `json:"editable"`
	// last time this setting was modified.
	ModifiedOn time.Time      `json:"modified_on,nullable" format:"date-time"`
	JSON       cacheLevelJSON `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 (*CacheLevel) UnmarshalJSON 

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

type CacheLevelEditable 

type CacheLevelEditable bool

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

const (
	CacheLevelEditableTrue  CacheLevelEditable = true
	CacheLevelEditableFalse CacheLevelEditable = false
)

func (CacheLevelEditable) IsKnown 

func (r CacheLevelEditable) IsKnown() bool

type CacheLevelID 

type CacheLevelID string

ID of the zone setting. 

const (
	CacheLevelIDCacheLevel CacheLevelID = "cache_level"
)

func (CacheLevelID) IsKnown 

func (r CacheLevelID) IsKnown() bool

type CacheLevelParam added in v2.4.0 

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

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

func (CacheLevelParam) MarshalJSON added in v2.4.0 

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

type CacheLevelValue 

type CacheLevelValue string

Current value of the zone setting. 

const (
	CacheLevelValueAggressive CacheLevelValue = "aggressive"
	CacheLevelValueBasic      CacheLevelValue = "basic"
	CacheLevelValueSimplified CacheLevelValue = "simplified"
)

func (CacheLevelValue) IsKnown 

func (r CacheLevelValue) IsKnown() bool

type CertificateCA added in v2.2.0 

type CertificateCA = shared.CertificateCA

The Certificate Authority that will issue the certificate

This is an alias to an internal type.

type CertificateRequestType added in v2.2.0 

type CertificateRequestType = shared.CertificateRequestType

Signature type desired on certificate ("origin-rsa" (rsa), "origin-ecc" (ecdsa), or "keyless-certificate" (for Keyless SSL servers).

This is an alias to an internal type.

type ChallengeTTL 

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

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

func (*ChallengeTTL) UnmarshalJSON 

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

type ChallengeTTLEditable 

type ChallengeTTLEditable bool

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

const (
	ChallengeTTLEditableTrue  ChallengeTTLEditable = true
	ChallengeTTLEditableFalse ChallengeTTLEditable = false
)

func (ChallengeTTLEditable) IsKnown 

func (r ChallengeTTLEditable) IsKnown() bool

type ChallengeTTLID 

type ChallengeTTLID string

ID of the zone setting. 

const (
	ChallengeTTLIDChallengeTTL ChallengeTTLID = "challenge_ttl"
)

func (ChallengeTTLID) IsKnown 

func (r ChallengeTTLID) IsKnown() bool

type ChallengeTTLParam added in v2.4.0 

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

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

func (ChallengeTTLParam) MarshalJSON added in v2.4.0 

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

type ChallengeTTLValue 

type ChallengeTTLValue float64

Current value of the zone setting. 

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

func (ChallengeTTLValue) IsKnown 

func (r ChallengeTTLValue) IsKnown() bool

type Ciphers 

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

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

func (*Ciphers) UnmarshalJSON 

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

type CiphersEditable 

type CiphersEditable bool

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

const (
	CiphersEditableTrue  CiphersEditable = true
	CiphersEditableFalse CiphersEditable = false
)

func (CiphersEditable) IsKnown 

func (r CiphersEditable) IsKnown() bool

type CiphersID 

type CiphersID string

ID of the zone setting. 

const (
	CiphersIDCiphers CiphersID = "ciphers"
)

func (CiphersID) IsKnown 

func (r CiphersID) IsKnown() bool

type CiphersParam added in v2.4.0 

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

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

func (CiphersParam) MarshalJSON added in v2.4.0 

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

type CloudflareTunnel 

type CloudflareTunnel = shared.CloudflareTunnel

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

This is an alias to an internal type.

type CloudflareTunnelConnection 

type CloudflareTunnelConnection = shared.CloudflareTunnelConnection

This is an alias to an internal type.

type CloudflareTunnelStatus added in v2.3.0 

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 added in v2.2.0 

type CustomNameserverGetResponse = interface{}

type CustomNameserverGetResponseEnvelope 

type CustomNameserverGetResponseEnvelope struct {
	Errors   []shared.ResponseInfo `json:"errors,required"`
	Messages []shared.ResponseInfo `json:"messages,required"`
	// Whether the API call was successful
	Success CustomNameserverGetResponseEnvelopeSuccess `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"`
	Result     []CustomNameserverGetResponse                 `json:"result,nullable"`
	ResultInfo CustomNameserverGetResponseEnvelopeResultInfo `json:"result_info"`
	JSON       customNameserverGetResponseEnvelopeJSON       `json:"-"`
}

func (*CustomNameserverGetResponseEnvelope) UnmarshalJSON 

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

type CustomNameserverGetResponseEnvelopeResultInfo 

type CustomNameserverGetResponseEnvelopeResultInfo 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       customNameserverGetResponseEnvelopeResultInfoJSON `json:"-"`
}

func (*CustomNameserverGetResponseEnvelopeResultInfo) UnmarshalJSON 

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

type CustomNameserverGetResponseEnvelopeSuccess 

type CustomNameserverGetResponseEnvelopeSuccess bool

Whether the API call was successful 

const (
	CustomNameserverGetResponseEnvelopeSuccessTrue CustomNameserverGetResponseEnvelopeSuccess = true
)

func (CustomNameserverGetResponseEnvelopeSuccess) IsKnown 

func (r CustomNameserverGetResponseEnvelopeSuccess) IsKnown() bool

type CustomNameserverService 

type CustomNameserverService struct {
	Options []option.RequestOption
}

CustomNameserverService contains methods and other services that help with interacting with the cloudflare API.

Note, unlike clients, this service does not read variables from the environment automatically. You should not instantiate this service directly, and instead use the NewCustomNameserverService method instead.

func NewCustomNameserverService 

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

NewCustomNameserverService generates a new service that applies the given options to each request. These options are applied after the parent client's options (if there is one), and before any request-specific options.

func (*CustomNameserverService) Get 

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.

func (*CustomNameserverService) Update 

func (r *CustomNameserverService) Update(ctx context.Context, params CustomNameserverUpdateParams, opts ...option.RequestOption) (res *[]CustomNameserverUpdateResponse, 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.

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 CustomNameserverUpdateResponse added in v2.2.0 

type CustomNameserverUpdateResponse = interface{}

type CustomNameserverUpdateResponseEnvelope 

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

func (*CustomNameserverUpdateResponseEnvelope) UnmarshalJSON 

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

type CustomNameserverUpdateResponseEnvelopeResultInfo 

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

func (*CustomNameserverUpdateResponseEnvelopeResultInfo) UnmarshalJSON 

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

type CustomNameserverUpdateResponseEnvelopeSuccess 

type CustomNameserverUpdateResponseEnvelopeSuccess bool

Whether the API call was successful 

const (
	CustomNameserverUpdateResponseEnvelopeSuccessTrue CustomNameserverUpdateResponseEnvelopeSuccess = true
)

func (CustomNameserverUpdateResponseEnvelopeSuccess) IsKnown 

func (r CustomNameserverUpdateResponseEnvelopeSuccess) IsKnown() bool

type DevelopmentMode 

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

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

func (*DevelopmentMode) UnmarshalJSON 

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

type DevelopmentModeEditable 

type DevelopmentModeEditable bool

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

const (
	DevelopmentModeEditableTrue  DevelopmentModeEditable = true
	DevelopmentModeEditableFalse DevelopmentModeEditable = false
)

func (DevelopmentModeEditable) IsKnown 

func (r DevelopmentModeEditable) IsKnown() bool

type DevelopmentModeID 

type DevelopmentModeID string

ID of the zone setting. 

const (
	DevelopmentModeIDDevelopmentMode DevelopmentModeID = "development_mode"
)

func (DevelopmentModeID) IsKnown 

func (r DevelopmentModeID) IsKnown() bool

type DevelopmentModeParam added in v2.4.0 

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

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

func (DevelopmentModeParam) MarshalJSON added in v2.4.0 

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

type DevelopmentModeValue 

type DevelopmentModeValue string

Current value of the zone setting. 

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

func (DevelopmentModeValue) IsKnown 

func (r DevelopmentModeValue) IsKnown() bool

type EarlyHints 

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

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

func (*EarlyHints) UnmarshalJSON 

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

type EarlyHintsEditable 

type EarlyHintsEditable bool

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

const (
	EarlyHintsEditableTrue  EarlyHintsEditable = true
	EarlyHintsEditableFalse EarlyHintsEditable = false
)

func (EarlyHintsEditable) IsKnown 

func (r EarlyHintsEditable) IsKnown() bool

type EarlyHintsID 

type EarlyHintsID string

ID of the zone setting. 

const (
	EarlyHintsIDEarlyHints EarlyHintsID = "early_hints"
)

func (EarlyHintsID) IsKnown 

func (r EarlyHintsID) IsKnown() bool

type EarlyHintsParam added in v2.4.0 

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

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

func (EarlyHintsParam) MarshalJSON added in v2.4.0 

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

type EarlyHintsValue 

type EarlyHintsValue string

Current value of the zone setting. 

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

func (EarlyHintsValue) IsKnown 

func (r EarlyHintsValue) IsKnown() bool

type EmailObfuscation 

type EmailObfuscation struct {
	// ID of the zone setting.
	ID EmailObfuscationID `json:"id,required"`
	// Current value of the zone setting.
	Value EmailObfuscationValue `json:"value,required"`
	// Whether or not this setting can be modified for this zone (based on your
	// Cloudflare plan level).
	Editable EmailObfuscationEditable `json:"editable"`
	// last time this setting was modified.
	ModifiedOn time.Time            `json:"modified_on,nullable" format:"date-time"`
	JSON       emailObfuscationJSON `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 (*EmailObfuscation) UnmarshalJSON 

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

type EmailObfuscationEditable 

type EmailObfuscationEditable bool

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

const (
	EmailObfuscationEditableTrue  EmailObfuscationEditable = true
	EmailObfuscationEditableFalse EmailObfuscationEditable = false
)

func (EmailObfuscationEditable) IsKnown 

func (r EmailObfuscationEditable) IsKnown() bool

type EmailObfuscationID 

type EmailObfuscationID string

ID of the zone setting. 

const (
	EmailObfuscationIDEmailObfuscation EmailObfuscationID = "email_obfuscation"
)

func (EmailObfuscationID) IsKnown 

func (r EmailObfuscationID) IsKnown() bool

type EmailObfuscationParam added in v2.4.0 

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

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

func (EmailObfuscationParam) MarshalJSON added in v2.4.0 

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

type EmailObfuscationValue 

type EmailObfuscationValue string

Current value of the zone setting. 

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

func (EmailObfuscationValue) IsKnown 

func (r EmailObfuscationValue) IsKnown() bool

type Error 

type Error = apierror.Error

type ErrorData 

type ErrorData = shared.ErrorData

This is an alias to an internal type.

type H2Prioritization 

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

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

func (*H2Prioritization) UnmarshalJSON 

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

type H2PrioritizationEditable 

type H2PrioritizationEditable bool

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

const (
	H2PrioritizationEditableTrue  H2PrioritizationEditable = true
	H2PrioritizationEditableFalse H2PrioritizationEditable = false
)

func (H2PrioritizationEditable) IsKnown 

func (r H2PrioritizationEditable) IsKnown() bool

type H2PrioritizationID 

type H2PrioritizationID string

ID of the zone setting. 

const (
	H2PrioritizationIDH2Prioritization H2PrioritizationID = "h2_prioritization"
)

func (H2PrioritizationID) IsKnown 

func (r H2PrioritizationID) IsKnown() bool

type H2PrioritizationParam 

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

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

func (H2PrioritizationParam) MarshalJSON 

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

type H2PrioritizationValue 

type H2PrioritizationValue string

Current value of the zone setting. 

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

func (H2PrioritizationValue) IsKnown 

func (r H2PrioritizationValue) IsKnown() bool

type HTTP2 

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

HTTP2 enabled for this zone.

func (*HTTP2) UnmarshalJSON 

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

type HTTP2Editable 

type HTTP2Editable bool

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

const (
	HTTP2EditableTrue  HTTP2Editable = true
	HTTP2EditableFalse HTTP2Editable = false
)

func (HTTP2Editable) IsKnown 

func (r HTTP2Editable) IsKnown() bool

type HTTP2ID 

type HTTP2ID string

ID of the zone setting. 

const (
	HTTP2IDHTTP2 HTTP2ID = "http2"
)

func (HTTP2ID) IsKnown 

func (r HTTP2ID) IsKnown() bool

type HTTP2Param added in v2.4.0 

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

HTTP2 enabled for this zone.

func (HTTP2Param) MarshalJSON added in v2.4.0 

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

type HTTP2Value 

type HTTP2Value string

Current value of the zone setting. 

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

func (HTTP2Value) IsKnown 

func (r HTTP2Value) IsKnown() bool

type HTTP3 

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

HTTP3 enabled for this zone.

func (*HTTP3) UnmarshalJSON 

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

type HTTP3Editable 

type HTTP3Editable bool

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

const (
	HTTP3EditableTrue  HTTP3Editable = true
	HTTP3EditableFalse HTTP3Editable = false
)

func (HTTP3Editable) IsKnown 

func (r HTTP3Editable) IsKnown() bool

type HTTP3ID 

type HTTP3ID string

ID of the zone setting. 

const (
	HTTP3IDHTTP3 HTTP3ID = "http3"
)

func (HTTP3ID) IsKnown 

func (r HTTP3ID) IsKnown() bool

type HTTP3Param added in v2.4.0 

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

HTTP3 enabled for this zone.

func (HTTP3Param) MarshalJSON added in v2.4.0 

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

type HTTP3Value 

type HTTP3Value string

Current value of the zone setting. 

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

func (HTTP3Value) IsKnown 

func (r HTTP3Value) IsKnown() bool

type HoldDeleteParams 

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

func (HoldDeleteParams) URLQuery 

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

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

type HoldDeleteResponseEnvelope 

type HoldDeleteResponseEnvelope struct {
	Result ZoneHold                       `json:"result"`
	JSON   holdDeleteResponseEnvelopeJSON `json:"-"`
}

func (*HoldDeleteResponseEnvelope) UnmarshalJSON 

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

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

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

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

func (*HoldService) New 

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

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

type HotlinkProtection 

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

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

func (*HotlinkProtection) UnmarshalJSON 

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

type HotlinkProtectionEditable 

type HotlinkProtectionEditable bool

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

const (
	HotlinkProtectionEditableTrue  HotlinkProtectionEditable = true
	HotlinkProtectionEditableFalse HotlinkProtectionEditable = false
)

func (HotlinkProtectionEditable) IsKnown 

func (r HotlinkProtectionEditable) IsKnown() bool

type HotlinkProtectionID 

type HotlinkProtectionID string

ID of the zone setting. 

const (
	HotlinkProtectionIDHotlinkProtection HotlinkProtectionID = "hotlink_protection"
)

func (HotlinkProtectionID) IsKnown 

func (r HotlinkProtectionID) IsKnown() bool

type HotlinkProtectionParam added in v2.4.0 

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

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

func (HotlinkProtectionParam) MarshalJSON added in v2.4.0 

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

type HotlinkProtectionValue 

type HotlinkProtectionValue string

Current value of the zone setting. 

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

func (HotlinkProtectionValue) IsKnown 

func (r HotlinkProtectionValue) IsKnown() bool

type IPGeolocation 

type IPGeolocation struct {
	// ID of the zone setting.
	ID IPGeolocationID `json:"id,required"`
	// Current value of the zone setting.
	Value IPGeolocationValue `json:"value,required"`
	// Whether or not this setting can be modified for this zone (based on your
	// Cloudflare plan level).
	Editable IPGeolocationEditable `json:"editable"`
	// last time this setting was modified.
	ModifiedOn time.Time         `json:"modified_on,nullable" format:"date-time"`
	JSON       ipGeolocationJSON `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 (*IPGeolocation) UnmarshalJSON 

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

type IPGeolocationEditable 

type IPGeolocationEditable bool

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

const (
	IPGeolocationEditableTrue  IPGeolocationEditable = true
	IPGeolocationEditableFalse IPGeolocationEditable = false
)

func (IPGeolocationEditable) IsKnown 

func (r IPGeolocationEditable) IsKnown() bool

type IPGeolocationID 

type IPGeolocationID string

ID of the zone setting. 

const (
	IPGeolocationIDIPGeolocation IPGeolocationID = "ip_geolocation"
)

func (IPGeolocationID) IsKnown 

func (r IPGeolocationID) IsKnown() bool

type IPGeolocationParam added in v2.4.0 

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

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

func (IPGeolocationParam) MarshalJSON added in v2.4.0 

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

type IPGeolocationValue 

type IPGeolocationValue string

Current value of the zone setting. 

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

func (IPGeolocationValue) IsKnown 

func (r IPGeolocationValue) IsKnown() bool

type IPV6 

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

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

func (*IPV6) UnmarshalJSON 

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

type IPV6Editable 

type IPV6Editable bool

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

const (
	IPV6EditableTrue  IPV6Editable = true
	IPV6EditableFalse IPV6Editable = false
)

func (IPV6Editable) IsKnown 

func (r IPV6Editable) IsKnown() bool

type IPV6ID 

type IPV6ID string

ID of the zone setting. 

const (
	IPV6IDIPV6 IPV6ID = "ipv6"
)

func (IPV6ID) IsKnown 

func (r IPV6ID) IsKnown() bool

type IPV6Param added in v2.4.0 

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

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

func (IPV6Param) MarshalJSON added in v2.4.0 

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

type IPV6Value 

type IPV6Value string

Current value of the zone setting. 

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

func (IPV6Value) IsKnown 

func (r IPV6Value) IsKnown() bool

type ImageResizing 

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

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

func (*ImageResizing) UnmarshalJSON 

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

type ImageResizingEditable 

type ImageResizingEditable bool

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

const (
	ImageResizingEditableTrue  ImageResizingEditable = true
	ImageResizingEditableFalse ImageResizingEditable = false
)

func (ImageResizingEditable) IsKnown 

func (r ImageResizingEditable) IsKnown() bool

type ImageResizingID 

type ImageResizingID string

ID of the zone setting. 

const (
	ImageResizingIDImageResizing ImageResizingID = "image_resizing"
)

func (ImageResizingID) IsKnown 

func (r ImageResizingID) IsKnown() bool

type ImageResizingParam 

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

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

func (ImageResizingParam) MarshalJSON 

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

type ImageResizingValue 

type ImageResizingValue string

Current value of the zone setting. 

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

func (ImageResizingValue) IsKnown 

func (r ImageResizingValue) IsKnown() bool

type MemberParam added in v2.1.0 

type MemberParam = shared.MemberParam

This is an alias to an internal type.

type MemberRoleParam added in v2.1.0 

type MemberRoleParam = shared.MemberRoleParam

This is an alias to an internal type.

type MemberRolesPermissionsParam added in v2.1.0 

type MemberRolesPermissionsParam = shared.MemberRolesPermissionsParam

This is an alias to an internal type.

type MemberStatus added in v2.3.0 

type MemberStatus = shared.MemberStatus

A member's status in the account.

This is an alias to an internal type.

type MemberUserParam added in v2.1.0 

type MemberUserParam = shared.MemberUserParam

Details of the user associated to the membership.

This is an alias to an internal type.

type MinTLSVersion 

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

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

func (*MinTLSVersion) UnmarshalJSON 

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

type MinTLSVersionEditable 

type MinTLSVersionEditable bool

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

const (
	MinTLSVersionEditableTrue  MinTLSVersionEditable = true
	MinTLSVersionEditableFalse MinTLSVersionEditable = false
)

func (MinTLSVersionEditable) IsKnown 

func (r MinTLSVersionEditable) IsKnown() bool

type MinTLSVersionID 

type MinTLSVersionID string

ID of the zone setting. 

const (
	MinTLSVersionIDMinTLSVersion MinTLSVersionID = "min_tls_version"
)

func (MinTLSVersionID) IsKnown 

func (r MinTLSVersionID) IsKnown() bool

type MinTLSVersionParam added in v2.4.0 

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

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

func (MinTLSVersionParam) MarshalJSON added in v2.4.0 

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

type MinTLSVersionValue 

type MinTLSVersionValue string

Current value of the zone setting. 

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

func (MinTLSVersionValue) IsKnown 

func (r MinTLSVersionValue) IsKnown() bool

type Minify 

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

Automatically minify certain assets for your website. Refer to [Using Cloudflare Auto Minify](https://support.cloudflare.com/hc/en-us/articles/200168196) for more information.

func (*Minify) UnmarshalJSON 

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

type MinifyEditable 

type MinifyEditable bool

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

const (
	MinifyEditableTrue  MinifyEditable = true
	MinifyEditableFalse MinifyEditable = false
)

func (MinifyEditable) IsKnown 

func (r MinifyEditable) IsKnown() bool

type MinifyID 

type MinifyID string

Zone setting identifier. 

const (
	MinifyIDMinify MinifyID = "minify"
)

func (MinifyID) IsKnown 

func (r MinifyID) IsKnown() bool

type MinifyParam added in v2.4.0 

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

Automatically minify certain assets for your website. Refer to [Using Cloudflare Auto Minify](https://support.cloudflare.com/hc/en-us/articles/200168196) for more information.

func (MinifyParam) MarshalJSON added in v2.4.0 

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

type MinifyValue 

type MinifyValue struct {
	// Automatically minify all CSS files for your website.
	Css MinifyValueCss `json:"css"`
	// Automatically minify all HTML files for your website.
	HTML MinifyValueHTML `json:"html"`
	// Automatically minify all JavaScript files for your website.
	JS   MinifyValueJS   `json:"js"`
	JSON minifyValueJSON `json:"-"`
}

Current value of the zone setting.

func (*MinifyValue) UnmarshalJSON 

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

type MinifyValueCss 

type MinifyValueCss string

Automatically minify all CSS files for your website. 

const (
	MinifyValueCssOn  MinifyValueCss = "on"
	MinifyValueCssOff MinifyValueCss = "off"
)

func (MinifyValueCss) IsKnown 

func (r MinifyValueCss) IsKnown() bool

type MinifyValueHTML 

type MinifyValueHTML string

Automatically minify all HTML files for your website. 

const (
	MinifyValueHTMLOn  MinifyValueHTML = "on"
	MinifyValueHTMLOff MinifyValueHTML = "off"
)

func (MinifyValueHTML) IsKnown 

func (r MinifyValueHTML) IsKnown() bool

type MinifyValueJS 

type MinifyValueJS string

Automatically minify all JavaScript files for your website. 

const (
	MinifyValueJSOn  MinifyValueJS = "on"
	MinifyValueJSOff MinifyValueJS = "off"
)

func (MinifyValueJS) IsKnown 

func (r MinifyValueJS) IsKnown() bool

type MinifyValueParam added in v2.4.0 

type MinifyValueParam struct {
	// Automatically minify all CSS files for your website.
	Css param.Field[MinifyValueCss] `json:"css"`
	// Automatically minify all HTML files for your website.
	HTML param.Field[MinifyValueHTML] `json:"html"`
	// Automatically minify all JavaScript files for your website.
	JS param.Field[MinifyValueJS] `json:"js"`
}

Current value of the zone setting.

func (MinifyValueParam) MarshalJSON added in v2.4.0 

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

type Mirage 

type Mirage struct {
	// ID of the zone setting.
	ID MirageID `json:"id,required"`
	// Current value of the zone setting.
	Value MirageValue `json:"value,required"`
	// Whether or not this setting can be modified for this zone (based on your
	// Cloudflare plan level).
	Editable MirageEditable `json:"editable"`
	// last time this setting was modified.
	ModifiedOn time.Time  `json:"modified_on,nullable" format:"date-time"`
	JSON       mirageJSON `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 (*Mirage) UnmarshalJSON 

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

type MirageEditable 

type MirageEditable bool

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

const (
	MirageEditableTrue  MirageEditable = true
	MirageEditableFalse MirageEditable = false
)

func (MirageEditable) IsKnown 

func (r MirageEditable) IsKnown() bool

type MirageID 

type MirageID string

ID of the zone setting. 

const (
	MirageIDMirage MirageID = "mirage"
)

func (MirageID) IsKnown 

func (r MirageID) IsKnown() bool

type MirageParam added in v2.4.0 

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

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

func (MirageParam) MarshalJSON added in v2.4.0 

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

type MirageValue 

type MirageValue string

Current value of the zone setting. 

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

func (MirageValue) IsKnown 

func (r MirageValue) IsKnown() bool

type MobileRedirect deprecated 

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

Deprecated: Use Single Redirects instead https://developers.cloudflare.com/rules/url-forwarding/single-redirects/examples/#perform-mobile-redirects. Automatically redirect visitors on mobile devices to a mobile-optimized subdomain.

func (*MobileRedirect) UnmarshalJSON 

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

type MobileRedirectEditable 

type MobileRedirectEditable bool

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

const (
	MobileRedirectEditableTrue  MobileRedirectEditable = true
	MobileRedirectEditableFalse MobileRedirectEditable = false
)

func (MobileRedirectEditable) IsKnown 

func (r MobileRedirectEditable) IsKnown() bool

type MobileRedirectID 

type MobileRedirectID string

Identifier of the zone setting. 

const (
	MobileRedirectIDMobileRedirect MobileRedirectID = "mobile_redirect"
)

func (MobileRedirectID) IsKnown 

func (r MobileRedirectID) IsKnown() bool

type MobileRedirectParam deprecated added in v2.4.0 

type MobileRedirectParam struct {
	// Identifier of the zone setting.
	ID param.Field[MobileRedirectID] `json:"id,required"`
	// Current value of the zone setting.
	Value param.Field[MobileRedirectValueParam] `json:"value,required"`
}

Deprecated: Use Single Redirects instead https://developers.cloudflare.com/rules/url-forwarding/single-redirects/examples/#perform-mobile-redirects. Automatically redirect visitors on mobile devices to a mobile-optimized subdomain.

func (MobileRedirectParam) MarshalJSON added in v2.4.0 

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

type MobileRedirectValue 

type MobileRedirectValue struct {
	// Which subdomain prefix you wish to redirect visitors on mobile devices to
	// (subdomain must already exist).
	MobileSubdomain string `json:"mobile_subdomain,nullable"`
	// Deprecated: Use Single Redirects instead
	// https://developers.cloudflare.com/rules/url-forwarding/single-redirects/examples/#perform-mobile-redirects.
	// Whether or not mobile redirect is enabled.
	Status MobileRedirectValueStatus `json:"status"`
	// Whether to drop the current page path and redirect to the mobile subdomain URL
	// root, or keep the path and redirect to the same page on the mobile subdomain.
	StripURI bool                    `json:"strip_uri"`
	JSON     mobileRedirectValueJSON `json:"-"`
}

Current value of the zone setting.

func (*MobileRedirectValue) UnmarshalJSON 

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

type MobileRedirectValueParam added in v2.4.0 

type MobileRedirectValueParam struct {
	// Which subdomain prefix you wish to redirect visitors on mobile devices to
	// (subdomain must already exist).
	MobileSubdomain param.Field[string] `json:"mobile_subdomain"`
	// Deprecated: Use Single Redirects instead
	// https://developers.cloudflare.com/rules/url-forwarding/single-redirects/examples/#perform-mobile-redirects.
	// Whether or not mobile redirect is enabled.
	Status param.Field[MobileRedirectValueStatus] `json:"status"`
	// Whether to drop the current page path and redirect to the mobile subdomain URL
	// root, or keep the path and redirect to the same page on the mobile subdomain.
	StripURI param.Field[bool] `json:"strip_uri"`
}

Current value of the zone setting.

func (MobileRedirectValueParam) MarshalJSON added in v2.4.0 

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

type MobileRedirectValueStatus deprecated 

type MobileRedirectValueStatus string

Deprecated: Use Single Redirects instead https://developers.cloudflare.com/rules/url-forwarding/single-redirects/examples/#perform-mobile-redirects. Whether or not mobile redirect is enabled. 

const (
	MobileRedirectValueStatusOn  MobileRedirectValueStatus = "on"
	MobileRedirectValueStatusOff MobileRedirectValueStatus = "off"
)

func (MobileRedirectValueStatus) IsKnown 

func (r MobileRedirectValueStatus) IsKnown() bool

type NEL 

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

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

func (*NEL) UnmarshalJSON 

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

type NELEditable 

type NELEditable bool

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

const (
	NELEditableTrue  NELEditable = true
	NELEditableFalse NELEditable = false
)

func (NELEditable) IsKnown 

func (r NELEditable) IsKnown() bool

type NELID 

type NELID string

Zone setting identifier. 

const (
	NELIDNEL NELID = "nel"
)

func (NELID) IsKnown 

func (r NELID) IsKnown() bool

type NELParam 

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

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

func (NELParam) MarshalJSON 

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

type NELValue 

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

Current value of the zone setting.

func (*NELValue) UnmarshalJSON 

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

type NELValueParam 

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

Current value of the zone setting.

func (NELValueParam) MarshalJSON 

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

type OpportunisticEncryption 

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

Enables the Opportunistic Encryption feature for a zone.

func (*OpportunisticEncryption) UnmarshalJSON 

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

type OpportunisticEncryptionEditable 

type OpportunisticEncryptionEditable bool

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

const (
	OpportunisticEncryptionEditableTrue  OpportunisticEncryptionEditable = true
	OpportunisticEncryptionEditableFalse OpportunisticEncryptionEditable = false
)

func (OpportunisticEncryptionEditable) IsKnown 

func (r OpportunisticEncryptionEditable) IsKnown() bool

type OpportunisticEncryptionID 

type OpportunisticEncryptionID string

ID of the zone setting. 

const (
	OpportunisticEncryptionIDOpportunisticEncryption OpportunisticEncryptionID = "opportunistic_encryption"
)

func (OpportunisticEncryptionID) IsKnown 

func (r OpportunisticEncryptionID) IsKnown() bool

type OpportunisticEncryptionParam added in v2.4.0 

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

Enables the Opportunistic Encryption feature for a zone.

func (OpportunisticEncryptionParam) MarshalJSON added in v2.4.0 

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

type OpportunisticEncryptionValue 

type OpportunisticEncryptionValue string

Current value of the zone setting. 

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

func (OpportunisticEncryptionValue) IsKnown 

func (r OpportunisticEncryptionValue) IsKnown() bool

type OpportunisticOnion 

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

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

func (*OpportunisticOnion) UnmarshalJSON 

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

type OpportunisticOnionEditable 

type OpportunisticOnionEditable bool

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

const (
	OpportunisticOnionEditableTrue  OpportunisticOnionEditable = true
	OpportunisticOnionEditableFalse OpportunisticOnionEditable = false
)

func (OpportunisticOnionEditable) IsKnown 

func (r OpportunisticOnionEditable) IsKnown() bool

type OpportunisticOnionID 

type OpportunisticOnionID string

ID of the zone setting. 

const (
	OpportunisticOnionIDOpportunisticOnion OpportunisticOnionID = "opportunistic_onion"
)

func (OpportunisticOnionID) IsKnown 

func (r OpportunisticOnionID) IsKnown() bool

type OpportunisticOnionParam added in v2.4.0 

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

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

func (OpportunisticOnionParam) MarshalJSON added in v2.4.0 

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

type OpportunisticOnionValue 

type OpportunisticOnionValue string

Current value of the zone setting. 

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

func (OpportunisticOnionValue) IsKnown 

func (r OpportunisticOnionValue) IsKnown() bool

type OrangeToOrange 

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

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

func (*OrangeToOrange) UnmarshalJSON 

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

type OrangeToOrangeEditable 

type OrangeToOrangeEditable bool

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

const (
	OrangeToOrangeEditableTrue  OrangeToOrangeEditable = true
	OrangeToOrangeEditableFalse OrangeToOrangeEditable = false
)

func (OrangeToOrangeEditable) IsKnown 

func (r OrangeToOrangeEditable) IsKnown() bool

type OrangeToOrangeID 

type OrangeToOrangeID string

ID of the zone setting. 

const (
	OrangeToOrangeIDOrangeToOrange OrangeToOrangeID = "orange_to_orange"
)

func (OrangeToOrangeID) IsKnown 

func (r OrangeToOrangeID) IsKnown() bool

type OrangeToOrangeParam 

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

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

func (OrangeToOrangeParam) MarshalJSON 

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

type OrangeToOrangeValue 

type OrangeToOrangeValue string

Current value of the zone setting. 

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

func (OrangeToOrangeValue) IsKnown 

func (r OrangeToOrangeValue) IsKnown() bool

type OriginErrorPagePassThru 

type OriginErrorPagePassThru struct {
	// ID of the zone setting.
	ID OriginErrorPagePassThruID `json:"id,required"`
	// Current value of the zone setting.
	Value OriginErrorPagePassThruValue `json:"value,required"`
	// Whether or not this setting can be modified for this zone (based on your
	// Cloudflare plan level).
	Editable OriginErrorPagePassThruEditable `json:"editable"`
	// last time this setting was modified.
	ModifiedOn time.Time                   `json:"modified_on,nullable" format:"date-time"`
	JSON       originErrorPagePassThruJSON `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 (*OriginErrorPagePassThru) UnmarshalJSON 

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

type OriginErrorPagePassThruEditable 

type OriginErrorPagePassThruEditable bool

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

const (
	OriginErrorPagePassThruEditableTrue  OriginErrorPagePassThruEditable = true
	OriginErrorPagePassThruEditableFalse OriginErrorPagePassThruEditable = false
)

func (OriginErrorPagePassThruEditable) IsKnown 

func (r OriginErrorPagePassThruEditable) IsKnown() bool

type OriginErrorPagePassThruID 

type OriginErrorPagePassThruID string

ID of the zone setting. 

const (
	OriginErrorPagePassThruIDOriginErrorPagePassThru OriginErrorPagePassThruID = "origin_error_page_pass_thru"
)

func (OriginErrorPagePassThruID) IsKnown 

func (r OriginErrorPagePassThruID) IsKnown() bool

type OriginErrorPagePassThruParam added in v2.4.0 

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

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

func (OriginErrorPagePassThruParam) MarshalJSON added in v2.4.0 

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

type OriginErrorPagePassThruValue 

type OriginErrorPagePassThruValue string

Current value of the zone setting. 

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 Polish 

type Polish struct {
	// ID of the zone setting.
	ID PolishID `json:"id,required"`
	// Current value of the zone setting.
	Value PolishValue `json:"value,required"`
	// Whether or not this setting can be modified for this zone (based on your
	// Cloudflare plan level).
	Editable PolishEditable `json:"editable"`
	// last time this setting was modified.
	ModifiedOn time.Time  `json:"modified_on,nullable" format:"date-time"`
	JSON       polishJSON `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 (*Polish) UnmarshalJSON 

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

type PolishEditable 

type PolishEditable bool

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

const (
	PolishEditableTrue  PolishEditable = true
	PolishEditableFalse PolishEditable = false
)

func (PolishEditable) IsKnown 

func (r PolishEditable) IsKnown() bool

type PolishID 

type PolishID string

ID of the zone setting. 

const (
	PolishIDPolish PolishID = "polish"
)

func (PolishID) IsKnown 

func (r PolishID) IsKnown() bool

type PolishParam 

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

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

func (PolishParam) MarshalJSON 

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

type PolishValue 

type PolishValue string

Current value of the zone setting. 

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

func (PolishValue) IsKnown 

func (r PolishValue) IsKnown() bool

type PrefetchPreload 

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

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

func (*PrefetchPreload) UnmarshalJSON 

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

type PrefetchPreloadEditable 

type PrefetchPreloadEditable bool

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

const (
	PrefetchPreloadEditableTrue  PrefetchPreloadEditable = true
	PrefetchPreloadEditableFalse PrefetchPreloadEditable = false
)

func (PrefetchPreloadEditable) IsKnown 

func (r PrefetchPreloadEditable) IsKnown() bool

type PrefetchPreloadID 

type PrefetchPreloadID string

ID of the zone setting. 

const (
	PrefetchPreloadIDPrefetchPreload PrefetchPreloadID = "prefetch_preload"
)

func (PrefetchPreloadID) IsKnown 

func (r PrefetchPreloadID) IsKnown() bool

type PrefetchPreloadParam added in v2.4.0 

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

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

func (PrefetchPreloadParam) MarshalJSON added in v2.4.0 

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

type PrefetchPreloadValue 

type PrefetchPreloadValue string

Current value of the zone setting. 

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

func (PrefetchPreloadValue) IsKnown 

func (r PrefetchPreloadValue) IsKnown() bool

type ProxyReadTimeout 

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

Maximum time between two read operations from origin.

func (*ProxyReadTimeout) UnmarshalJSON 

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

type ProxyReadTimeoutEditable 

type ProxyReadTimeoutEditable bool

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

const (
	ProxyReadTimeoutEditableTrue  ProxyReadTimeoutEditable = true
	ProxyReadTimeoutEditableFalse ProxyReadTimeoutEditable = false
)

func (ProxyReadTimeoutEditable) IsKnown 

func (r ProxyReadTimeoutEditable) IsKnown() bool

type ProxyReadTimeoutID 

type ProxyReadTimeoutID string

ID of the zone setting. 

const (
	ProxyReadTimeoutIDProxyReadTimeout ProxyReadTimeoutID = "proxy_read_timeout"
)

func (ProxyReadTimeoutID) IsKnown 

func (r ProxyReadTimeoutID) IsKnown() bool

type ProxyReadTimeoutParam 

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

Maximum time between two read operations from origin.

func (ProxyReadTimeoutParam) MarshalJSON 

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

type PseudoIPV4 

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

The value set for the Pseudo IPv4 setting.

func (*PseudoIPV4) UnmarshalJSON 

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

type PseudoIPV4Editable 

type PseudoIPV4Editable bool

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

const (
	PseudoIPV4EditableTrue  PseudoIPV4Editable = true
	PseudoIPV4EditableFalse PseudoIPV4Editable = false
)

func (PseudoIPV4Editable) IsKnown 

func (r PseudoIPV4Editable) IsKnown() bool

type PseudoIPV4ID 

type PseudoIPV4ID string

Value of the Pseudo IPv4 setting. 

const (
	PseudoIPV4IDPseudoIPV4 PseudoIPV4ID = "pseudo_ipv4"
)

func (PseudoIPV4ID) IsKnown 

func (r PseudoIPV4ID) IsKnown() bool

type PseudoIPV4Param added in v2.4.0 

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

The value set for the Pseudo IPv4 setting.

func (PseudoIPV4Param) MarshalJSON added in v2.4.0 

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

type PseudoIPV4Value 

type PseudoIPV4Value string

Current value of the zone setting. 

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

func (PseudoIPV4Value) IsKnown 

func (r PseudoIPV4Value) IsKnown() bool

type ResponseBuffering 

type ResponseBuffering struct {
	// ID of the zone setting.
	ID ResponseBufferingID `json:"id,required"`
	// Current value of the zone setting.
	Value ResponseBufferingValue `json:"value,required"`
	// Whether or not this setting can be modified for this zone (based on your
	// Cloudflare plan level).
	Editable ResponseBufferingEditable `json:"editable"`
	// last time this setting was modified.
	ModifiedOn time.Time             `json:"modified_on,nullable" format:"date-time"`
	JSON       responseBufferingJSON `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 (*ResponseBuffering) UnmarshalJSON 

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

type ResponseBufferingEditable 

type ResponseBufferingEditable bool

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

const (
	ResponseBufferingEditableTrue  ResponseBufferingEditable = true
	ResponseBufferingEditableFalse ResponseBufferingEditable = false
)

func (ResponseBufferingEditable) IsKnown 

func (r ResponseBufferingEditable) IsKnown() bool

type ResponseBufferingID 

type ResponseBufferingID string

ID of the zone setting. 

const (
	ResponseBufferingIDResponseBuffering ResponseBufferingID = "response_buffering"
)

func (ResponseBufferingID) IsKnown 

func (r ResponseBufferingID) IsKnown() bool

type ResponseBufferingParam added in v2.4.0 

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

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

func (ResponseBufferingParam) MarshalJSON added in v2.4.0 

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

type ResponseBufferingValue 

type ResponseBufferingValue string

Current value of the zone setting. 

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

func (ResponseBufferingValue) IsKnown 

func (r ResponseBufferingValue) IsKnown() bool

type ResponseInfo 

type ResponseInfo = shared.ResponseInfo

This is an alias to an internal type.

type RocketLoader 

type RocketLoader struct {
	// ID of the zone setting.
	ID RocketLoaderID `json:"id,required"`
	// Current value of the zone setting.
	Value RocketLoaderValue `json:"value,required"`
	// Whether or not this setting can be modified for this zone (based on your
	// Cloudflare plan level).
	Editable RocketLoaderEditable `json:"editable"`
	// last time this setting was modified.
	ModifiedOn time.Time        `json:"modified_on,nullable" format:"date-time"`
	JSON       rocketLoaderJSON `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 (*RocketLoader) UnmarshalJSON 

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

type RocketLoaderEditable 

type RocketLoaderEditable bool

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

const (
	RocketLoaderEditableTrue  RocketLoaderEditable = true
	RocketLoaderEditableFalse RocketLoaderEditable = false
)

func (RocketLoaderEditable) IsKnown 

func (r RocketLoaderEditable) IsKnown() bool

type RocketLoaderID 

type RocketLoaderID string

ID of the zone setting. 

const (
	RocketLoaderIDRocketLoader RocketLoaderID = "rocket_loader"
)

func (RocketLoaderID) IsKnown 

func (r RocketLoaderID) IsKnown() bool

type RocketLoaderParam 

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

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

func (RocketLoaderParam) MarshalJSON 

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

type RocketLoaderValue 

type RocketLoaderValue string

Current value of the zone setting. 

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 SSL 

type SSL struct {
	// ID of the zone setting.
	ID SSLID `json:"id,required"`
	// Current value of the zone setting.
	Value SSLValue `json:"value,required"`
	// Whether or not this setting can be modified for this zone (based on your
	// Cloudflare plan level).
	Editable SSLEditable `json:"editable"`
	// last time this setting was modified.
	ModifiedOn time.Time `json:"modified_on,nullable" format:"date-time"`
	JSON       sslJSON   `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 (*SSL) UnmarshalJSON 

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

type SSLEditable 

type SSLEditable bool

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

const (
	SSLEditableTrue  SSLEditable = true
	SSLEditableFalse SSLEditable = false
)

func (SSLEditable) IsKnown 

func (r SSLEditable) IsKnown() bool

type SSLID 

type SSLID string

ID of the zone setting. 

const (
	SSLIDSSL SSLID = "ssl"
)

func (SSLID) IsKnown 

func (r SSLID) IsKnown() bool

type SSLParam added in v2.4.0 

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

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

func (SSLParam) MarshalJSON added in v2.4.0 

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

type SSLRecommender 

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

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

func (*SSLRecommender) UnmarshalJSON 

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

type SSLRecommenderID 

type SSLRecommenderID string

Enrollment value for SSL/TLS Recommender. 

const (
	SSLRecommenderIDSSLRecommender SSLRecommenderID = "ssl_recommender"
)

func (SSLRecommenderID) IsKnown 

func (r SSLRecommenderID) IsKnown() bool

type SSLRecommenderParam 

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

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

func (SSLRecommenderParam) MarshalJSON 

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

type SSLValue 

type SSLValue string

Current value of the zone setting. 

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

func (SSLValue) IsKnown 

func (r SSLValue) IsKnown() bool

type SecurityHeaders 

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

Cloudflare security header for a zone.

func (*SecurityHeaders) UnmarshalJSON 

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

type SecurityHeadersEditable 

type SecurityHeadersEditable bool

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

const (
	SecurityHeadersEditableTrue  SecurityHeadersEditable = true
	SecurityHeadersEditableFalse SecurityHeadersEditable = false
)

func (SecurityHeadersEditable) IsKnown 

func (r SecurityHeadersEditable) IsKnown() bool

type SecurityHeadersID 

type SecurityHeadersID string

ID of the zone's security header. 

const (
	SecurityHeadersIDSecurityHeader SecurityHeadersID = "security_header"
)

func (SecurityHeadersID) IsKnown 

func (r SecurityHeadersID) IsKnown() bool

type SecurityHeadersParam added in v2.4.0 

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

Cloudflare security header for a zone.

func (SecurityHeadersParam) MarshalJSON added in v2.4.0 

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

type SecurityHeadersValue 

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

Current value of the zone setting.

func (*SecurityHeadersValue) UnmarshalJSON 

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

type SecurityHeadersValueParam added in v2.4.0 

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

Current value of the zone setting.

func (SecurityHeadersValueParam) MarshalJSON added in v2.4.0 

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

type SecurityHeadersValueStrictTransportSecurity 

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

Strict Transport Security.

func (*SecurityHeadersValueStrictTransportSecurity) UnmarshalJSON 

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

type SecurityHeadersValueStrictTransportSecurityParam added in v2.4.0 

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

Strict Transport Security.

func (SecurityHeadersValueStrictTransportSecurityParam) MarshalJSON added in v2.4.0 

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

type SecurityLevel 

type SecurityLevel struct {
	// ID of the zone setting.
	ID SecurityLevelID `json:"id,required"`
	// Current value of the zone setting.
	Value SecurityLevelValue `json:"value,required"`
	// Whether or not this setting can be modified for this zone (based on your
	// Cloudflare plan level).
	Editable SecurityLevelEditable `json:"editable"`
	// last time this setting was modified.
	ModifiedOn time.Time         `json:"modified_on,nullable" format:"date-time"`
	JSON       securityLevelJSON `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 (*SecurityLevel) UnmarshalJSON 

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

type SecurityLevelEditable 

type SecurityLevelEditable bool

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

const (
	SecurityLevelEditableTrue  SecurityLevelEditable = true
	SecurityLevelEditableFalse SecurityLevelEditable = false
)

func (SecurityLevelEditable) IsKnown 

func (r SecurityLevelEditable) IsKnown() bool

type SecurityLevelID 

type SecurityLevelID string

ID of the zone setting. 

const (
	SecurityLevelIDSecurityLevel SecurityLevelID = "security_level"
)

func (SecurityLevelID) IsKnown 

func (r SecurityLevelID) IsKnown() bool

type SecurityLevelParam added in v2.4.0 

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

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

func (SecurityLevelParam) MarshalJSON added in v2.4.0 

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

type SecurityLevelValue 

type SecurityLevelValue string

Current value of the zone setting. 

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

func (SecurityLevelValue) IsKnown 

func (r SecurityLevelValue) IsKnown() bool

type ServerSideExcludes 

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

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

func (*ServerSideExcludes) UnmarshalJSON 

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

type ServerSideExcludesEditable 

type ServerSideExcludesEditable bool

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

const (
	ServerSideExcludesEditableTrue  ServerSideExcludesEditable = true
	ServerSideExcludesEditableFalse ServerSideExcludesEditable = false
)

func (ServerSideExcludesEditable) IsKnown 

func (r ServerSideExcludesEditable) IsKnown() bool

type ServerSideExcludesID 

type ServerSideExcludesID string

ID of the zone setting. 

const (
	ServerSideExcludesIDServerSideExclude ServerSideExcludesID = "server_side_exclude"
)

func (ServerSideExcludesID) IsKnown 

func (r ServerSideExcludesID) IsKnown() bool

type ServerSideExcludesParam added in v2.4.0 

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

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

func (ServerSideExcludesParam) MarshalJSON added in v2.4.0 

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

type ServerSideExcludesValue 

type ServerSideExcludesValue string

Current value of the zone setting. 

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

func (ServerSideExcludesValue) IsKnown 

func (r ServerSideExcludesValue) IsKnown() bool

type SettingEditParams added in v2.4.0 

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

func (SettingEditParams) MarshalJSON added in v2.4.0 

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

type SettingEditParamsBody added in v2.4.0 

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

0-RTT session resumption enabled for this zone.

func (SettingEditParamsBody) MarshalJSON added in v2.4.0 

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

type SettingEditParamsBodyEditable added in v2.4.0 

type SettingEditParamsBodyEditable bool

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

const (
	SettingEditParamsBodyEditableTrue  SettingEditParamsBodyEditable = true
	SettingEditParamsBodyEditableFalse SettingEditParamsBodyEditable = false
)

func (SettingEditParamsBodyEditable) IsKnown added in v2.4.0 

func (r SettingEditParamsBodyEditable) IsKnown() bool

type SettingEditParamsBodyID added in v2.4.0 

type SettingEditParamsBodyID string

ID of the zone setting. 

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

func (SettingEditParamsBodyID) IsKnown added in v2.4.0 

func (r SettingEditParamsBodyID) IsKnown() bool

type SettingEditParamsBodyUnion added in v2.4.0 

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

0-RTT session resumption enabled for this zone.

Satisfied by zones.ZeroRTTParam, zones.AdvancedDDoSParam, zones.AlwaysOnlineParam, zones.AlwaysUseHTTPSParam, zones.AutomaticHTTPSRewritesParam, zones.BrotliParam, zones.BrowserCacheTTLParam, zones.BrowserCheckParam, zones.CacheLevelParam, zones.ChallengeTTLParam, zones.CiphersParam, zones.SettingEditParamsBodyZonesCNAMEFlattening, zones.DevelopmentModeParam, zones.EarlyHintsParam, zones.SettingEditParamsBodyZonesEdgeCacheTTL, zones.EmailObfuscationParam, zones.H2PrioritizationParam, zones.HotlinkProtectionParam, zones.HTTP2Param, zones.HTTP3Param, zones.ImageResizingParam, zones.IPGeolocationParam, zones.IPV6Param, zones.SettingEditParamsBodyZonesMaxUpload, zones.MinTLSVersionParam, zones.MinifyParam, zones.MirageParam, zones.MobileRedirectParam, zones.NELParam, zones.OpportunisticEncryptionParam, zones.OpportunisticOnionParam, zones.OrangeToOrangeParam, zones.OriginErrorPagePassThruParam, zones.PolishParam, zones.PrefetchPreloadParam, zones.ProxyReadTimeoutParam, zones.PseudoIPV4Param, zones.SettingEditParamsBodyZonesReplaceInsecureJS, zones.ResponseBufferingParam, zones.RocketLoaderParam, zones.SettingEditParamsBodyZonesSchemasAutomaticPlatformOptimization, zones.SecurityHeadersParam, zones.SecurityLevelParam, zones.ServerSideExcludesParam, zones.SettingEditParamsBodyZonesSha1Support, zones.SortQueryStringForCacheParam, zones.SSLParam, zones.SSLRecommenderParam, zones.SettingEditParamsBodyZonesTLS1_2Only, zones.TLS1_3Param, zones.TLSClientAuthParam, zones.TrueClientIPHeaderParam, zones.WAFParam, zones.WebPParam, zones.WebsocketParam, SettingEditParamsBody.

type SettingEditParamsBodyZonesCNAMEFlattening added in v2.4.0 

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

Whether or not cname flattening is on.

func (SettingEditParamsBodyZonesCNAMEFlattening) MarshalJSON added in v2.4.0 

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

type SettingEditParamsBodyZonesCNAMEFlatteningEditable added in v2.4.0 

type SettingEditParamsBodyZonesCNAMEFlatteningEditable bool

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

const (
	SettingEditParamsBodyZonesCNAMEFlatteningEditableTrue  SettingEditParamsBodyZonesCNAMEFlatteningEditable = true
	SettingEditParamsBodyZonesCNAMEFlatteningEditableFalse SettingEditParamsBodyZonesCNAMEFlatteningEditable = false
)

func (SettingEditParamsBodyZonesCNAMEFlatteningEditable) IsKnown added in v2.4.0 

func (r SettingEditParamsBodyZonesCNAMEFlatteningEditable) IsKnown() bool

type SettingEditParamsBodyZonesCNAMEFlatteningID added in v2.4.0 

type SettingEditParamsBodyZonesCNAMEFlatteningID string

How to flatten the cname destination. 

const (
	SettingEditParamsBodyZonesCNAMEFlatteningIDCNAMEFlattening SettingEditParamsBodyZonesCNAMEFlatteningID = "cname_flattening"
)

func (SettingEditParamsBodyZonesCNAMEFlatteningID) IsKnown added in v2.4.0 

func (r SettingEditParamsBodyZonesCNAMEFlatteningID) IsKnown() bool

type SettingEditParamsBodyZonesCNAMEFlatteningValue added in v2.4.0 

type SettingEditParamsBodyZonesCNAMEFlatteningValue string

Current value of the zone setting. 

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

func (SettingEditParamsBodyZonesCNAMEFlatteningValue) IsKnown added in v2.4.0 

func (r SettingEditParamsBodyZonesCNAMEFlatteningValue) IsKnown() bool

type SettingEditParamsBodyZonesEdgeCacheTTL added in v2.4.0 

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

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

func (SettingEditParamsBodyZonesEdgeCacheTTL) MarshalJSON added in v2.4.0 

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

type SettingEditParamsBodyZonesEdgeCacheTTLEditable added in v2.4.0 

type SettingEditParamsBodyZonesEdgeCacheTTLEditable bool

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

const (
	SettingEditParamsBodyZonesEdgeCacheTTLEditableTrue  SettingEditParamsBodyZonesEdgeCacheTTLEditable = true
	SettingEditParamsBodyZonesEdgeCacheTTLEditableFalse SettingEditParamsBodyZonesEdgeCacheTTLEditable = false
)

func (SettingEditParamsBodyZonesEdgeCacheTTLEditable) IsKnown added in v2.4.0 

func (r SettingEditParamsBodyZonesEdgeCacheTTLEditable) IsKnown() bool

type SettingEditParamsBodyZonesEdgeCacheTTLID added in v2.4.0 

type SettingEditParamsBodyZonesEdgeCacheTTLID string

ID of the zone setting. 

const (
	SettingEditParamsBodyZonesEdgeCacheTTLIDEdgeCacheTTL SettingEditParamsBodyZonesEdgeCacheTTLID = "edge_cache_ttl"
)

func (SettingEditParamsBodyZonesEdgeCacheTTLID) IsKnown added in v2.4.0 

func (r SettingEditParamsBodyZonesEdgeCacheTTLID) IsKnown() bool

type SettingEditParamsBodyZonesEdgeCacheTTLValue added in v2.4.0 

type SettingEditParamsBodyZonesEdgeCacheTTLValue float64

Current value of the zone setting. 

const (
	SettingEditParamsBodyZonesEdgeCacheTTLValue30     SettingEditParamsBodyZonesEdgeCacheTTLValue = 30
	SettingEditParamsBodyZonesEdgeCacheTTLValue60     SettingEditParamsBodyZonesEdgeCacheTTLValue = 60
	SettingEditParamsBodyZonesEdgeCacheTTLValue300    SettingEditParamsBodyZonesEdgeCacheTTLValue = 300
	SettingEditParamsBodyZonesEdgeCacheTTLValue1200   SettingEditParamsBodyZonesEdgeCacheTTLValue = 1200
	SettingEditParamsBodyZonesEdgeCacheTTLValue1800   SettingEditParamsBodyZonesEdgeCacheTTLValue = 1800
	SettingEditParamsBodyZonesEdgeCacheTTLValue3600   SettingEditParamsBodyZonesEdgeCacheTTLValue = 3600
	SettingEditParamsBodyZonesEdgeCacheTTLValue7200   SettingEditParamsBodyZonesEdgeCacheTTLValue = 7200
	SettingEditParamsBodyZonesEdgeCacheTTLValue10800  SettingEditParamsBodyZonesEdgeCacheTTLValue = 10800
	SettingEditParamsBodyZonesEdgeCacheTTLValue14400  SettingEditParamsBodyZonesEdgeCacheTTLValue = 14400
	SettingEditParamsBodyZonesEdgeCacheTTLValue18000  SettingEditParamsBodyZonesEdgeCacheTTLValue = 18000
	SettingEditParamsBodyZonesEdgeCacheTTLValue28800  SettingEditParamsBodyZonesEdgeCacheTTLValue = 28800
	SettingEditParamsBodyZonesEdgeCacheTTLValue43200  SettingEditParamsBodyZonesEdgeCacheTTLValue = 43200
	SettingEditParamsBodyZonesEdgeCacheTTLValue57600  SettingEditParamsBodyZonesEdgeCacheTTLValue = 57600
	SettingEditParamsBodyZonesEdgeCacheTTLValue72000  SettingEditParamsBodyZonesEdgeCacheTTLValue = 72000
	SettingEditParamsBodyZonesEdgeCacheTTLValue86400  SettingEditParamsBodyZonesEdgeCacheTTLValue = 86400
	SettingEditParamsBodyZonesEdgeCacheTTLValue172800 SettingEditParamsBodyZonesEdgeCacheTTLValue = 172800
	SettingEditParamsBodyZonesEdgeCacheTTLValue259200 SettingEditParamsBodyZonesEdgeCacheTTLValue = 259200
	SettingEditParamsBodyZonesEdgeCacheTTLValue345600 SettingEditParamsBodyZonesEdgeCacheTTLValue = 345600
	SettingEditParamsBodyZonesEdgeCacheTTLValue432000 SettingEditParamsBodyZonesEdgeCacheTTLValue = 432000
	SettingEditParamsBodyZonesEdgeCacheTTLValue518400 SettingEditParamsBodyZonesEdgeCacheTTLValue = 518400
	SettingEditParamsBodyZonesEdgeCacheTTLValue604800 SettingEditParamsBodyZonesEdgeCacheTTLValue = 604800
)

func (SettingEditParamsBodyZonesEdgeCacheTTLValue) IsKnown added in v2.4.0 

func (r SettingEditParamsBodyZonesEdgeCacheTTLValue) IsKnown() bool

type SettingEditParamsBodyZonesMaxUpload added in v2.4.0 

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

Maximum size of an allowable upload.

func (SettingEditParamsBodyZonesMaxUpload) MarshalJSON added in v2.4.0 

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

type SettingEditParamsBodyZonesMaxUploadEditable added in v2.4.0 

type SettingEditParamsBodyZonesMaxUploadEditable bool

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

const (
	SettingEditParamsBodyZonesMaxUploadEditableTrue  SettingEditParamsBodyZonesMaxUploadEditable = true
	SettingEditParamsBodyZonesMaxUploadEditableFalse SettingEditParamsBodyZonesMaxUploadEditable = false
)

func (SettingEditParamsBodyZonesMaxUploadEditable) IsKnown added in v2.4.0 

func (r SettingEditParamsBodyZonesMaxUploadEditable) IsKnown() bool

type SettingEditParamsBodyZonesMaxUploadID added in v2.4.0 

type SettingEditParamsBodyZonesMaxUploadID string

identifier of the zone setting. 

const (
	SettingEditParamsBodyZonesMaxUploadIDMaxUpload SettingEditParamsBodyZonesMaxUploadID = "max_upload"
)

func (SettingEditParamsBodyZonesMaxUploadID) IsKnown added in v2.4.0 

func (r SettingEditParamsBodyZonesMaxUploadID) IsKnown() bool

type SettingEditParamsBodyZonesMaxUploadValue added in v2.4.0 

type SettingEditParamsBodyZonesMaxUploadValue float64

Current value of the zone setting. 

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

func (SettingEditParamsBodyZonesMaxUploadValue) IsKnown added in v2.4.0 

func (r SettingEditParamsBodyZonesMaxUploadValue) IsKnown() bool

type SettingEditParamsBodyZonesReplaceInsecureJS added in v2.4.0 

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

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

func (SettingEditParamsBodyZonesReplaceInsecureJS) MarshalJSON added in v2.4.0 

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

type SettingEditParamsBodyZonesReplaceInsecureJSEditable added in v2.4.0 

type SettingEditParamsBodyZonesReplaceInsecureJSEditable bool

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

const (
	SettingEditParamsBodyZonesReplaceInsecureJSEditableTrue  SettingEditParamsBodyZonesReplaceInsecureJSEditable = true
	SettingEditParamsBodyZonesReplaceInsecureJSEditableFalse SettingEditParamsBodyZonesReplaceInsecureJSEditable = false
)

func (SettingEditParamsBodyZonesReplaceInsecureJSEditable) IsKnown added in v2.4.0 

func (r SettingEditParamsBodyZonesReplaceInsecureJSEditable) IsKnown() bool

type SettingEditParamsBodyZonesReplaceInsecureJSID added in v2.4.0 

type SettingEditParamsBodyZonesReplaceInsecureJSID string

ID of the zone setting. 

const (
	SettingEditParamsBodyZonesReplaceInsecureJSIDReplaceInsecureJS SettingEditParamsBodyZonesReplaceInsecureJSID = "replace_insecure_js"
)

func (SettingEditParamsBodyZonesReplaceInsecureJSID) IsKnown added in v2.4.0 

func (r SettingEditParamsBodyZonesReplaceInsecureJSID) IsKnown() bool

type SettingEditParamsBodyZonesReplaceInsecureJSValue added in v2.4.0 

type SettingEditParamsBodyZonesReplaceInsecureJSValue string

Current value of the zone setting. 

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

func (SettingEditParamsBodyZonesReplaceInsecureJSValue) IsKnown added in v2.4.0 

func (r SettingEditParamsBodyZonesReplaceInsecureJSValue) IsKnown() bool

type SettingEditParamsBodyZonesSchemasAutomaticPlatformOptimization added in v2.4.0 

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

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

func (SettingEditParamsBodyZonesSchemasAutomaticPlatformOptimization) MarshalJSON added in v2.4.0 

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

type SettingEditParamsBodyZonesSchemasAutomaticPlatformOptimizationEditable added in v2.4.0 

type SettingEditParamsBodyZonesSchemasAutomaticPlatformOptimizationEditable bool

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

const (
	SettingEditParamsBodyZonesSchemasAutomaticPlatformOptimizationEditableTrue  SettingEditParamsBodyZonesSchemasAutomaticPlatformOptimizationEditable = true
	SettingEditParamsBodyZonesSchemasAutomaticPlatformOptimizationEditableFalse SettingEditParamsBodyZonesSchemasAutomaticPlatformOptimizationEditable = false
)

func (SettingEditParamsBodyZonesSchemasAutomaticPlatformOptimizationEditable) IsKnown added in v2.4.0 

func (r SettingEditParamsBodyZonesSchemasAutomaticPlatformOptimizationEditable) IsKnown() bool

type SettingEditParamsBodyZonesSchemasAutomaticPlatformOptimizationID added in v2.4.0 

type SettingEditParamsBodyZonesSchemasAutomaticPlatformOptimizationID string

ID of the zone setting. 

const (
	SettingEditParamsBodyZonesSchemasAutomaticPlatformOptimizationIDAutomaticPlatformOptimization SettingEditParamsBodyZonesSchemasAutomaticPlatformOptimizationID = "automatic_platform_optimization"
)

func (SettingEditParamsBodyZonesSchemasAutomaticPlatformOptimizationID) IsKnown added in v2.4.0 

func (r SettingEditParamsBodyZonesSchemasAutomaticPlatformOptimizationID) IsKnown() bool

type SettingEditParamsBodyZonesSha1Support added in v2.4.0 

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

Allow SHA1 support.

func (SettingEditParamsBodyZonesSha1Support) MarshalJSON added in v2.4.0 

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

type SettingEditParamsBodyZonesSha1SupportEditable added in v2.4.0 

type SettingEditParamsBodyZonesSha1SupportEditable bool

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

const (
	SettingEditParamsBodyZonesSha1SupportEditableTrue  SettingEditParamsBodyZonesSha1SupportEditable = true
	SettingEditParamsBodyZonesSha1SupportEditableFalse SettingEditParamsBodyZonesSha1SupportEditable = false
)

func (SettingEditParamsBodyZonesSha1SupportEditable) IsKnown added in v2.4.0 

func (r SettingEditParamsBodyZonesSha1SupportEditable) IsKnown() bool

type SettingEditParamsBodyZonesSha1SupportID added in v2.4.0 

type SettingEditParamsBodyZonesSha1SupportID string

Zone setting identifier. 

const (
	SettingEditParamsBodyZonesSha1SupportIDSha1Support SettingEditParamsBodyZonesSha1SupportID = "sha1_support"
)

func (SettingEditParamsBodyZonesSha1SupportID) IsKnown added in v2.4.0 

func (r SettingEditParamsBodyZonesSha1SupportID) IsKnown() bool

type SettingEditParamsBodyZonesSha1SupportValue added in v2.4.0 

type SettingEditParamsBodyZonesSha1SupportValue string

Current value of the zone setting. 

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

func (SettingEditParamsBodyZonesSha1SupportValue) IsKnown added in v2.4.0 

func (r SettingEditParamsBodyZonesSha1SupportValue) IsKnown() bool

type SettingEditParamsBodyZonesTLS1_2Only added in v2.4.0 

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

Only allows TLS1.2.

func (SettingEditParamsBodyZonesTLS1_2Only) MarshalJSON added in v2.4.0 

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

type SettingEditParamsBodyZonesTLS1_2OnlyEditable added in v2.4.0 

type SettingEditParamsBodyZonesTLS1_2OnlyEditable bool

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

const (
	SettingEditParamsBodyZonesTLS1_2OnlyEditableTrue  SettingEditParamsBodyZonesTLS1_2OnlyEditable = true
	SettingEditParamsBodyZonesTLS1_2OnlyEditableFalse SettingEditParamsBodyZonesTLS1_2OnlyEditable = false
)

func (SettingEditParamsBodyZonesTLS1_2OnlyEditable) IsKnown added in v2.4.0 

func (r SettingEditParamsBodyZonesTLS1_2OnlyEditable) IsKnown() bool

type SettingEditParamsBodyZonesTLS1_2OnlyID added in v2.4.0 

type SettingEditParamsBodyZonesTLS1_2OnlyID string

Zone setting identifier. 

const (
	SettingEditParamsBodyZonesTLS1_2OnlyIDTLS1_2Only SettingEditParamsBodyZonesTLS1_2OnlyID = "tls_1_2_only"
)

func (SettingEditParamsBodyZonesTLS1_2OnlyID) IsKnown added in v2.4.0 

func (r SettingEditParamsBodyZonesTLS1_2OnlyID) IsKnown() bool

type SettingEditParamsBodyZonesTLS1_2OnlyValue added in v2.4.0 

type SettingEditParamsBodyZonesTLS1_2OnlyValue string

Current value of the zone setting. 

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

func (SettingEditParamsBodyZonesTLS1_2OnlyValue) IsKnown added in v2.4.0 

func (r SettingEditParamsBodyZonesTLS1_2OnlyValue) IsKnown() bool

type SettingEditResponse added in v2.4.0 

type SettingEditResponse struct {
	// Whether or not this setting can be modified for this zone (based on your
	// Cloudflare plan level).
	Editable SettingEditResponseEditable `json:"editable"`
	// ID of the zone setting.
	ID SettingEditResponseID `json:"id"`
	// last time this setting was modified.
	ModifiedOn time.Time `json:"modified_on,nullable" format:"date-time"`
	// This field can have the runtime type of [ZeroRTTValue], [AdvancedDDoSValue],
	// [AlwaysOnlineValue], [AlwaysUseHTTPSValue], [AutomaticHTTPSRewritesValue],
	// [BrotliValue], [BrowserCacheTTLValue], [BrowserCheckValue], [CacheLevelValue],
	// [ChallengeTTLValue], [[]string], [SettingEditResponseZonesCNAMEFlatteningValue],
	// [DevelopmentModeValue], [EarlyHintsValue],
	// [SettingEditResponseZonesEdgeCacheTTLValue], [EmailObfuscationValue],
	// [H2PrioritizationValue], [HotlinkProtectionValue], [HTTP2Value], [HTTP3Value],
	// [ImageResizingValue], [IPGeolocationValue], [IPV6Value],
	// [SettingEditResponseZonesMaxUploadValue], [MinTLSVersionValue], [MinifyValue],
	// [MirageValue], [MobileRedirectValue], [NELValue],
	// [OpportunisticEncryptionValue], [OpportunisticOnionValue],
	// [OrangeToOrangeValue], [OriginErrorPagePassThruValue], [PolishValue],
	// [PrefetchPreloadValue], [float64], [PseudoIPV4Value],
	// [SettingEditResponseZonesReplaceInsecureJSValue], [ResponseBufferingValue],
	// [RocketLoaderValue], [AutomaticPlatformOptimization], [SecurityHeadersValue],
	// [SecurityLevelValue], [ServerSideExcludesValue],
	// [SettingEditResponseZonesSha1SupportValue], [SortQueryStringForCacheValue],
	// [SSLValue], [SettingEditResponseZonesTLS1_2OnlyValue], [TLS1_3Value],
	// [TLSClientAuthValue], [TrueClientIPHeaderValue], [WAFValue], [WebPValue],
	// [WebsocketValue].
	Value interface{} `json:"value,required"`
	// 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"`
	// ssl-recommender enrollment setting.
	Enabled bool                    `json:"enabled"`
	JSON    settingEditResponseJSON `json:"-"`
	// contains filtered or unexported fields
}

0-RTT session resumption enabled for this zone.

func (SettingEditResponse) AsUnion added in v2.4.0 

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 zones.ZeroRTT, zones.AdvancedDDoS, zones.AlwaysOnline, zones.AlwaysUseHTTPS, zones.AutomaticHTTPSRewrites, zones.Brotli, zones.BrowserCacheTTL, zones.BrowserCheck, zones.CacheLevel, zones.ChallengeTTL, zones.Ciphers, zones.SettingEditResponseZonesCNAMEFlattening, zones.DevelopmentMode, zones.EarlyHints, zones.SettingEditResponseZonesEdgeCacheTTL, zones.EmailObfuscation, zones.H2Prioritization, zones.HotlinkProtection, zones.HTTP2, zones.HTTP3, zones.ImageResizing, zones.IPGeolocation, zones.IPV6, zones.SettingEditResponseZonesMaxUpload, zones.MinTLSVersion, zones.Minify, zones.Mirage, zones.MobileRedirect, zones.NEL, zones.OpportunisticEncryption, zones.OpportunisticOnion, zones.OrangeToOrange, zones.OriginErrorPagePassThru, zones.Polish, zones.PrefetchPreload, zones.ProxyReadTimeout, zones.PseudoIPV4, zones.SettingEditResponseZonesReplaceInsecureJS, zones.ResponseBuffering, zones.RocketLoader, zones.SettingEditResponseZonesSchemasAutomaticPlatformOptimization, zones.SecurityHeaders, zones.SecurityLevel, zones.ServerSideExcludes, zones.SettingEditResponseZonesSha1Support, zones.SortQueryStringForCache, zones.SSL, zones.SSLRecommender, zones.SettingEditResponseZonesTLS1_2Only, zones.TLS1_3, zones.TLSClientAuth, zones.TrueClientIPHeader, zones.WAF, zones.WebP, zones.Websocket.

func (*SettingEditResponse) UnmarshalJSON added in v2.4.0 

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

type SettingEditResponseEditable added in v2.4.0 

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 added in v2.4.0 

func (r SettingEditResponseEditable) IsKnown() bool

type SettingEditResponseEnvelope added in v2.4.0 

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 added in v2.4.0 

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

type SettingEditResponseID added in v2.4.0 

type SettingEditResponseID string

ID of the zone setting. 

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

func (SettingEditResponseID) IsKnown added in v2.4.0 

func (r SettingEditResponseID) IsKnown() bool

type SettingEditResponseUnion added in v2.4.0 

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

0-RTT session resumption enabled for this zone.

Union satisfied by zones.ZeroRTT, zones.AdvancedDDoS, zones.AlwaysOnline, zones.AlwaysUseHTTPS, zones.AutomaticHTTPSRewrites, zones.Brotli, zones.BrowserCacheTTL, zones.BrowserCheck, zones.CacheLevel, zones.ChallengeTTL, zones.Ciphers, zones.SettingEditResponseZonesCNAMEFlattening, zones.DevelopmentMode, zones.EarlyHints, zones.SettingEditResponseZonesEdgeCacheTTL, zones.EmailObfuscation, zones.H2Prioritization, zones.HotlinkProtection, zones.HTTP2, zones.HTTP3, zones.ImageResizing, zones.IPGeolocation, zones.IPV6, zones.SettingEditResponseZonesMaxUpload, zones.MinTLSVersion, zones.Minify, zones.Mirage, zones.MobileRedirect, zones.NEL, zones.OpportunisticEncryption, zones.OpportunisticOnion, zones.OrangeToOrange, zones.OriginErrorPagePassThru, zones.Polish, zones.PrefetchPreload, zones.ProxyReadTimeout, zones.PseudoIPV4, zones.SettingEditResponseZonesReplaceInsecureJS, zones.ResponseBuffering, zones.RocketLoader, zones.SettingEditResponseZonesSchemasAutomaticPlatformOptimization, zones.SecurityHeaders, zones.SecurityLevel, zones.ServerSideExcludes, zones.SettingEditResponseZonesSha1Support, zones.SortQueryStringForCache, zones.SSL, zones.SSLRecommender, zones.SettingEditResponseZonesTLS1_2Only, zones.TLS1_3, zones.TLSClientAuth, zones.TrueClientIPHeader, zones.WAF, zones.WebP or zones.Websocket.

type SettingEditResponseZonesCNAMEFlattening added in v2.4.0 

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

Whether or not cname flattening is on.

func (*SettingEditResponseZonesCNAMEFlattening) UnmarshalJSON added in v2.4.0 

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

type SettingEditResponseZonesCNAMEFlatteningEditable added in v2.4.0 

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 added in v2.4.0 

func (r SettingEditResponseZonesCNAMEFlatteningEditable) IsKnown() bool

type SettingEditResponseZonesCNAMEFlatteningID added in v2.4.0 

type SettingEditResponseZonesCNAMEFlatteningID string

How to flatten the cname destination. 

const (
	SettingEditResponseZonesCNAMEFlatteningIDCNAMEFlattening SettingEditResponseZonesCNAMEFlatteningID = "cname_flattening"
)

func (SettingEditResponseZonesCNAMEFlatteningID) IsKnown added in v2.4.0 

func (r SettingEditResponseZonesCNAMEFlatteningID) IsKnown() bool

type SettingEditResponseZonesCNAMEFlatteningValue added in v2.4.0 

type SettingEditResponseZonesCNAMEFlatteningValue string

Current value of the zone setting. 

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

func (SettingEditResponseZonesCNAMEFlatteningValue) IsKnown added in v2.4.0 

func (r SettingEditResponseZonesCNAMEFlatteningValue) IsKnown() bool

type SettingEditResponseZonesEdgeCacheTTL added in v2.4.0 

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

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

func (*SettingEditResponseZonesEdgeCacheTTL) UnmarshalJSON added in v2.4.0 

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

type SettingEditResponseZonesEdgeCacheTTLEditable added in v2.4.0 

type SettingEditResponseZonesEdgeCacheTTLEditable bool

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

const (
	SettingEditResponseZonesEdgeCacheTTLEditableTrue  SettingEditResponseZonesEdgeCacheTTLEditable = true
	SettingEditResponseZonesEdgeCacheTTLEditableFalse SettingEditResponseZonesEdgeCacheTTLEditable = false
)

func (SettingEditResponseZonesEdgeCacheTTLEditable) IsKnown added in v2.4.0 

func (r SettingEditResponseZonesEdgeCacheTTLEditable) IsKnown() bool

type SettingEditResponseZonesEdgeCacheTTLID added in v2.4.0 

type SettingEditResponseZonesEdgeCacheTTLID string

ID of the zone setting. 

const (
	SettingEditResponseZonesEdgeCacheTTLIDEdgeCacheTTL SettingEditResponseZonesEdgeCacheTTLID = "edge_cache_ttl"
)

func (SettingEditResponseZonesEdgeCacheTTLID) IsKnown added in v2.4.0 

func (r SettingEditResponseZonesEdgeCacheTTLID) IsKnown() bool

type SettingEditResponseZonesEdgeCacheTTLValue added in v2.4.0 

type SettingEditResponseZonesEdgeCacheTTLValue float64

Current value of the zone setting. 

const (
	SettingEditResponseZonesEdgeCacheTTLValue30     SettingEditResponseZonesEdgeCacheTTLValue = 30
	SettingEditResponseZonesEdgeCacheTTLValue60     SettingEditResponseZonesEdgeCacheTTLValue = 60
	SettingEditResponseZonesEdgeCacheTTLValue300    SettingEditResponseZonesEdgeCacheTTLValue = 300
	SettingEditResponseZonesEdgeCacheTTLValue1200   SettingEditResponseZonesEdgeCacheTTLValue = 1200
	SettingEditResponseZonesEdgeCacheTTLValue1800   SettingEditResponseZonesEdgeCacheTTLValue = 1800
	SettingEditResponseZonesEdgeCacheTTLValue3600   SettingEditResponseZonesEdgeCacheTTLValue = 3600
	SettingEditResponseZonesEdgeCacheTTLValue7200   SettingEditResponseZonesEdgeCacheTTLValue = 7200
	SettingEditResponseZonesEdgeCacheTTLValue10800  SettingEditResponseZonesEdgeCacheTTLValue = 10800
	SettingEditResponseZonesEdgeCacheTTLValue14400  SettingEditResponseZonesEdgeCacheTTLValue = 14400
	SettingEditResponseZonesEdgeCacheTTLValue18000  SettingEditResponseZonesEdgeCacheTTLValue = 18000
	SettingEditResponseZonesEdgeCacheTTLValue28800  SettingEditResponseZonesEdgeCacheTTLValue = 28800
	SettingEditResponseZonesEdgeCacheTTLValue43200  SettingEditResponseZonesEdgeCacheTTLValue = 43200
	SettingEditResponseZonesEdgeCacheTTLValue57600  SettingEditResponseZonesEdgeCacheTTLValue = 57600
	SettingEditResponseZonesEdgeCacheTTLValue72000  SettingEditResponseZonesEdgeCacheTTLValue = 72000
	SettingEditResponseZonesEdgeCacheTTLValue86400  SettingEditResponseZonesEdgeCacheTTLValue = 86400
	SettingEditResponseZonesEdgeCacheTTLValue172800 SettingEditResponseZonesEdgeCacheTTLValue = 172800
	SettingEditResponseZonesEdgeCacheTTLValue259200 SettingEditResponseZonesEdgeCacheTTLValue = 259200
	SettingEditResponseZonesEdgeCacheTTLValue345600 SettingEditResponseZonesEdgeCacheTTLValue = 345600
	SettingEditResponseZonesEdgeCacheTTLValue432000 SettingEditResponseZonesEdgeCacheTTLValue = 432000
	SettingEditResponseZonesEdgeCacheTTLValue518400 SettingEditResponseZonesEdgeCacheTTLValue = 518400
	SettingEditResponseZonesEdgeCacheTTLValue604800 SettingEditResponseZonesEdgeCacheTTLValue = 604800
)

func (SettingEditResponseZonesEdgeCacheTTLValue) IsKnown added in v2.4.0 

func (r SettingEditResponseZonesEdgeCacheTTLValue) IsKnown() bool

type SettingEditResponseZonesMaxUpload added in v2.4.0 

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 added in v2.4.0 

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

type SettingEditResponseZonesMaxUploadEditable added in v2.4.0 

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 added in v2.4.0 

func (r SettingEditResponseZonesMaxUploadEditable) IsKnown() bool

type SettingEditResponseZonesMaxUploadID added in v2.4.0 

type SettingEditResponseZonesMaxUploadID string

identifier of the zone setting. 

const (
	SettingEditResponseZonesMaxUploadIDMaxUpload SettingEditResponseZonesMaxUploadID = "max_upload"
)

func (SettingEditResponseZonesMaxUploadID) IsKnown added in v2.4.0 

func (r SettingEditResponseZonesMaxUploadID) IsKnown() bool

type SettingEditResponseZonesMaxUploadValue added in v2.4.0 

type SettingEditResponseZonesMaxUploadValue float64

Current value of the zone setting. 

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

func (SettingEditResponseZonesMaxUploadValue) IsKnown added in v2.4.0 

func (r SettingEditResponseZonesMaxUploadValue) IsKnown() bool

type SettingEditResponseZonesReplaceInsecureJS added in v2.4.0 

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 added in v2.4.0 

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

type SettingEditResponseZonesReplaceInsecureJSEditable added in v2.4.0 

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 added in v2.4.0 

func (r SettingEditResponseZonesReplaceInsecureJSEditable) IsKnown() bool

type SettingEditResponseZonesReplaceInsecureJSID added in v2.4.0 

type SettingEditResponseZonesReplaceInsecureJSID string

ID of the zone setting. 

const (
	SettingEditResponseZonesReplaceInsecureJSIDReplaceInsecureJS SettingEditResponseZonesReplaceInsecureJSID = "replace_insecure_js"
)

func (SettingEditResponseZonesReplaceInsecureJSID) IsKnown added in v2.4.0 

func (r SettingEditResponseZonesReplaceInsecureJSID) IsKnown() bool

type SettingEditResponseZonesReplaceInsecureJSValue added in v2.4.0 

type SettingEditResponseZonesReplaceInsecureJSValue string

Current value of the zone setting. 

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

func (SettingEditResponseZonesReplaceInsecureJSValue) IsKnown added in v2.4.0 

func (r SettingEditResponseZonesReplaceInsecureJSValue) IsKnown() bool

type SettingEditResponseZonesSchemasAutomaticPlatformOptimization added in v2.4.0 

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 added in v2.4.0 

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

type SettingEditResponseZonesSchemasAutomaticPlatformOptimizationEditable added in v2.4.0 

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 added in v2.4.0 

func (r SettingEditResponseZonesSchemasAutomaticPlatformOptimizationEditable) IsKnown() bool

type SettingEditResponseZonesSchemasAutomaticPlatformOptimizationID added in v2.4.0 

type SettingEditResponseZonesSchemasAutomaticPlatformOptimizationID string

ID of the zone setting. 

const (
	SettingEditResponseZonesSchemasAutomaticPlatformOptimizationIDAutomaticPlatformOptimization SettingEditResponseZonesSchemasAutomaticPlatformOptimizationID = "automatic_platform_optimization"
)

func (SettingEditResponseZonesSchemasAutomaticPlatformOptimizationID) IsKnown added in v2.4.0 

func (r SettingEditResponseZonesSchemasAutomaticPlatformOptimizationID) IsKnown() bool

type SettingEditResponseZonesSha1Support added in v2.4.0 

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 added in v2.4.0 

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

type SettingEditResponseZonesSha1SupportEditable added in v2.4.0 

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 added in v2.4.0 

func (r SettingEditResponseZonesSha1SupportEditable) IsKnown() bool

type SettingEditResponseZonesSha1SupportID added in v2.4.0 

type SettingEditResponseZonesSha1SupportID string

Zone setting identifier. 

const (
	SettingEditResponseZonesSha1SupportIDSha1Support SettingEditResponseZonesSha1SupportID = "sha1_support"
)

func (SettingEditResponseZonesSha1SupportID) IsKnown added in v2.4.0 

func (r SettingEditResponseZonesSha1SupportID) IsKnown() bool

type SettingEditResponseZonesSha1SupportValue added in v2.4.0 

type SettingEditResponseZonesSha1SupportValue string

Current value of the zone setting. 

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

func (SettingEditResponseZonesSha1SupportValue) IsKnown added in v2.4.0 

func (r SettingEditResponseZonesSha1SupportValue) IsKnown() bool

type SettingEditResponseZonesTLS1_2Only added in v2.4.0 

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 added in v2.4.0 

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

type SettingEditResponseZonesTLS1_2OnlyEditable added in v2.4.0 

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 added in v2.4.0 

func (r SettingEditResponseZonesTLS1_2OnlyEditable) IsKnown() bool

type SettingEditResponseZonesTLS1_2OnlyID added in v2.4.0 

type SettingEditResponseZonesTLS1_2OnlyID string

Zone setting identifier. 

const (
	SettingEditResponseZonesTLS1_2OnlyIDTLS1_2Only SettingEditResponseZonesTLS1_2OnlyID = "tls_1_2_only"
)

func (SettingEditResponseZonesTLS1_2OnlyID) IsKnown added in v2.4.0 

func (r SettingEditResponseZonesTLS1_2OnlyID) IsKnown() bool

type SettingEditResponseZonesTLS1_2OnlyValue added in v2.4.0 

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 added in v2.4.0 

func (r SettingEditResponseZonesTLS1_2OnlyValue) IsKnown() bool

type SettingGetParams added in v2.4.0 

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

type SettingGetResponse added in v2.4.0 

type SettingGetResponse struct {
	// Whether or not this setting can be modified for this zone (based on your
	// Cloudflare plan level).
	Editable SettingGetResponseEditable `json:"editable"`
	// ID of the zone setting.
	ID SettingGetResponseID `json:"id"`
	// last time this setting was modified.
	ModifiedOn time.Time `json:"modified_on,nullable" format:"date-time"`
	// This field can have the runtime type of [ZeroRTTValue], [AdvancedDDoSValue],
	// [AlwaysOnlineValue], [AlwaysUseHTTPSValue], [AutomaticHTTPSRewritesValue],
	// [BrotliValue], [BrowserCacheTTLValue], [BrowserCheckValue], [CacheLevelValue],
	// [ChallengeTTLValue], [[]string], [SettingGetResponseZonesCNAMEFlatteningValue],
	// [DevelopmentModeValue], [EarlyHintsValue],
	// [SettingGetResponseZonesEdgeCacheTTLValue], [EmailObfuscationValue],
	// [H2PrioritizationValue], [HotlinkProtectionValue], [HTTP2Value], [HTTP3Value],
	// [ImageResizingValue], [IPGeolocationValue], [IPV6Value],
	// [SettingGetResponseZonesMaxUploadValue], [MinTLSVersionValue], [MinifyValue],
	// [MirageValue], [MobileRedirectValue], [NELValue],
	// [OpportunisticEncryptionValue], [OpportunisticOnionValue],
	// [OrangeToOrangeValue], [OriginErrorPagePassThruValue], [PolishValue],
	// [PrefetchPreloadValue], [float64], [PseudoIPV4Value],
	// [SettingGetResponseZonesReplaceInsecureJSValue], [ResponseBufferingValue],
	// [RocketLoaderValue], [AutomaticPlatformOptimization], [SecurityHeadersValue],
	// [SecurityLevelValue], [ServerSideExcludesValue],
	// [SettingGetResponseZonesSha1SupportValue], [SortQueryStringForCacheValue],
	// [SSLValue], [SettingGetResponseZonesTLS1_2OnlyValue], [TLS1_3Value],
	// [TLSClientAuthValue], [TrueClientIPHeaderValue], [WAFValue], [WebPValue],
	// [WebsocketValue].
	Value interface{} `json:"value,required"`
	// 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"`
	// ssl-recommender enrollment setting.
	Enabled bool                   `json:"enabled"`
	JSON    settingGetResponseJSON `json:"-"`
	// contains filtered or unexported fields
}

0-RTT session resumption enabled for this zone.

func (SettingGetResponse) AsUnion added in v2.4.0 

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 zones.ZeroRTT, zones.AdvancedDDoS, zones.AlwaysOnline, zones.AlwaysUseHTTPS, zones.AutomaticHTTPSRewrites, zones.Brotli, zones.BrowserCacheTTL, zones.BrowserCheck, zones.CacheLevel, zones.ChallengeTTL, zones.Ciphers, zones.SettingGetResponseZonesCNAMEFlattening, zones.DevelopmentMode, zones.EarlyHints, zones.SettingGetResponseZonesEdgeCacheTTL, zones.EmailObfuscation, zones.H2Prioritization, zones.HotlinkProtection, zones.HTTP2, zones.HTTP3, zones.ImageResizing, zones.IPGeolocation, zones.IPV6, zones.SettingGetResponseZonesMaxUpload, zones.MinTLSVersion, zones.Minify, zones.Mirage, zones.MobileRedirect, zones.NEL, zones.OpportunisticEncryption, zones.OpportunisticOnion, zones.OrangeToOrange, zones.OriginErrorPagePassThru, zones.Polish, zones.PrefetchPreload, zones.ProxyReadTimeout, zones.PseudoIPV4, zones.SettingGetResponseZonesReplaceInsecureJS, zones.ResponseBuffering, zones.RocketLoader, zones.SettingGetResponseZonesSchemasAutomaticPlatformOptimization, zones.SecurityHeaders, zones.SecurityLevel, zones.ServerSideExcludes, zones.SettingGetResponseZonesSha1Support, zones.SortQueryStringForCache, zones.SSL, zones.SSLRecommender, zones.SettingGetResponseZonesTLS1_2Only, zones.TLS1_3, zones.TLSClientAuth, zones.TrueClientIPHeader, zones.WAF, zones.WebP, zones.Websocket.

func (*SettingGetResponse) UnmarshalJSON added in v2.4.0 

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

type SettingGetResponseEditable added in v2.4.0 

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 added in v2.4.0 

func (r SettingGetResponseEditable) IsKnown() bool

type SettingGetResponseEnvelope added in v2.4.0 

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 added in v2.4.0 

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

type SettingGetResponseID added in v2.4.0 

type SettingGetResponseID string

ID of the zone setting. 

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

func (SettingGetResponseID) IsKnown added in v2.4.0 

func (r SettingGetResponseID) IsKnown() bool

type SettingGetResponseUnion added in v2.4.0 

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

0-RTT session resumption enabled for this zone.

Union satisfied by zones.ZeroRTT, zones.AdvancedDDoS, zones.AlwaysOnline, zones.AlwaysUseHTTPS, zones.AutomaticHTTPSRewrites, zones.Brotli, zones.BrowserCacheTTL, zones.BrowserCheck, zones.CacheLevel, zones.ChallengeTTL, zones.Ciphers, zones.SettingGetResponseZonesCNAMEFlattening, zones.DevelopmentMode, zones.EarlyHints, zones.SettingGetResponseZonesEdgeCacheTTL, zones.EmailObfuscation, zones.H2Prioritization, zones.HotlinkProtection, zones.HTTP2, zones.HTTP3, zones.ImageResizing, zones.IPGeolocation, zones.IPV6, zones.SettingGetResponseZonesMaxUpload, zones.MinTLSVersion, zones.Minify, zones.Mirage, zones.MobileRedirect, zones.NEL, zones.OpportunisticEncryption, zones.OpportunisticOnion, zones.OrangeToOrange, zones.OriginErrorPagePassThru, zones.Polish, zones.PrefetchPreload, zones.ProxyReadTimeout, zones.PseudoIPV4, zones.SettingGetResponseZonesReplaceInsecureJS, zones.ResponseBuffering, zones.RocketLoader, zones.SettingGetResponseZonesSchemasAutomaticPlatformOptimization, zones.SecurityHeaders, zones.SecurityLevel, zones.ServerSideExcludes, zones.SettingGetResponseZonesSha1Support, zones.SortQueryStringForCache, zones.SSL, zones.SSLRecommender, zones.SettingGetResponseZonesTLS1_2Only, zones.TLS1_3, zones.TLSClientAuth, zones.TrueClientIPHeader, zones.WAF, zones.WebP or zones.Websocket.

type SettingGetResponseZonesCNAMEFlattening added in v2.4.0 

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

Whether or not cname flattening is on.

func (*SettingGetResponseZonesCNAMEFlattening) UnmarshalJSON added in v2.4.0 

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

type SettingGetResponseZonesCNAMEFlatteningEditable added in v2.4.0 

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 added in v2.4.0 

func (r SettingGetResponseZonesCNAMEFlatteningEditable) IsKnown() bool

type SettingGetResponseZonesCNAMEFlatteningID added in v2.4.0 

type SettingGetResponseZonesCNAMEFlatteningID string

How to flatten the cname destination. 

const (
	SettingGetResponseZonesCNAMEFlatteningIDCNAMEFlattening SettingGetResponseZonesCNAMEFlatteningID = "cname_flattening"
)

func (SettingGetResponseZonesCNAMEFlatteningID) IsKnown added in v2.4.0 

func (r SettingGetResponseZonesCNAMEFlatteningID) IsKnown() bool

type SettingGetResponseZonesCNAMEFlatteningValue added in v2.4.0 

type SettingGetResponseZonesCNAMEFlatteningValue string

Current value of the zone setting. 

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

func (SettingGetResponseZonesCNAMEFlatteningValue) IsKnown added in v2.4.0 

func (r SettingGetResponseZonesCNAMEFlatteningValue) IsKnown() bool

type SettingGetResponseZonesEdgeCacheTTL added in v2.4.0 

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

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

func (*SettingGetResponseZonesEdgeCacheTTL) UnmarshalJSON added in v2.4.0 

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

type SettingGetResponseZonesEdgeCacheTTLEditable added in v2.4.0 

type SettingGetResponseZonesEdgeCacheTTLEditable bool

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

const (
	SettingGetResponseZonesEdgeCacheTTLEditableTrue  SettingGetResponseZonesEdgeCacheTTLEditable = true
	SettingGetResponseZonesEdgeCacheTTLEditableFalse SettingGetResponseZonesEdgeCacheTTLEditable = false
)

func (SettingGetResponseZonesEdgeCacheTTLEditable) IsKnown added in v2.4.0 

func (r SettingGetResponseZonesEdgeCacheTTLEditable) IsKnown() bool

type SettingGetResponseZonesEdgeCacheTTLID added in v2.4.0 

type SettingGetResponseZonesEdgeCacheTTLID string

ID of the zone setting. 

const (
	SettingGetResponseZonesEdgeCacheTTLIDEdgeCacheTTL SettingGetResponseZonesEdgeCacheTTLID = "edge_cache_ttl"
)

func (SettingGetResponseZonesEdgeCacheTTLID) IsKnown added in v2.4.0 

func (r SettingGetResponseZonesEdgeCacheTTLID) IsKnown() bool

type SettingGetResponseZonesEdgeCacheTTLValue added in v2.4.0 

type SettingGetResponseZonesEdgeCacheTTLValue float64

Current value of the zone setting. 

const (
	SettingGetResponseZonesEdgeCacheTTLValue30     SettingGetResponseZonesEdgeCacheTTLValue = 30
	SettingGetResponseZonesEdgeCacheTTLValue60     SettingGetResponseZonesEdgeCacheTTLValue = 60
	SettingGetResponseZonesEdgeCacheTTLValue300    SettingGetResponseZonesEdgeCacheTTLValue = 300
	SettingGetResponseZonesEdgeCacheTTLValue1200   SettingGetResponseZonesEdgeCacheTTLValue = 1200
	SettingGetResponseZonesEdgeCacheTTLValue1800   SettingGetResponseZonesEdgeCacheTTLValue = 1800
	SettingGetResponseZonesEdgeCacheTTLValue3600   SettingGetResponseZonesEdgeCacheTTLValue = 3600
	SettingGetResponseZonesEdgeCacheTTLValue7200   SettingGetResponseZonesEdgeCacheTTLValue = 7200
	SettingGetResponseZonesEdgeCacheTTLValue10800  SettingGetResponseZonesEdgeCacheTTLValue = 10800
	SettingGetResponseZonesEdgeCacheTTLValue14400  SettingGetResponseZonesEdgeCacheTTLValue = 14400
	SettingGetResponseZonesEdgeCacheTTLValue18000  SettingGetResponseZonesEdgeCacheTTLValue = 18000
	SettingGetResponseZonesEdgeCacheTTLValue28800  SettingGetResponseZonesEdgeCacheTTLValue = 28800
	SettingGetResponseZonesEdgeCacheTTLValue43200  SettingGetResponseZonesEdgeCacheTTLValue = 43200
	SettingGetResponseZonesEdgeCacheTTLValue57600  SettingGetResponseZonesEdgeCacheTTLValue = 57600
	SettingGetResponseZonesEdgeCacheTTLValue72000  SettingGetResponseZonesEdgeCacheTTLValue = 72000
	SettingGetResponseZonesEdgeCacheTTLValue86400  SettingGetResponseZonesEdgeCacheTTLValue = 86400
	SettingGetResponseZonesEdgeCacheTTLValue172800 SettingGetResponseZonesEdgeCacheTTLValue = 172800
	SettingGetResponseZonesEdgeCacheTTLValue259200 SettingGetResponseZonesEdgeCacheTTLValue = 259200
	SettingGetResponseZonesEdgeCacheTTLValue345600 SettingGetResponseZonesEdgeCacheTTLValue = 345600
	SettingGetResponseZonesEdgeCacheTTLValue432000 SettingGetResponseZonesEdgeCacheTTLValue = 432000
	SettingGetResponseZonesEdgeCacheTTLValue518400 SettingGetResponseZonesEdgeCacheTTLValue = 518400
	SettingGetResponseZonesEdgeCacheTTLValue604800 SettingGetResponseZonesEdgeCacheTTLValue = 604800
)

func (SettingGetResponseZonesEdgeCacheTTLValue) IsKnown added in v2.4.0 

func (r SettingGetResponseZonesEdgeCacheTTLValue) IsKnown() bool

type SettingGetResponseZonesMaxUpload added in v2.4.0 

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 added in v2.4.0 

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

type SettingGetResponseZonesMaxUploadEditable added in v2.4.0 

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 added in v2.4.0 

func (r SettingGetResponseZonesMaxUploadEditable) IsKnown() bool

type SettingGetResponseZonesMaxUploadID added in v2.4.0 

type SettingGetResponseZonesMaxUploadID string

identifier of the zone setting. 

const (
	SettingGetResponseZonesMaxUploadIDMaxUpload SettingGetResponseZonesMaxUploadID = "max_upload"
)

func (SettingGetResponseZonesMaxUploadID) IsKnown added in v2.4.0 

func (r SettingGetResponseZonesMaxUploadID) IsKnown() bool

type SettingGetResponseZonesMaxUploadValue added in v2.4.0 

type SettingGetResponseZonesMaxUploadValue float64

Current value of the zone setting. 

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

func (SettingGetResponseZonesMaxUploadValue) IsKnown added in v2.4.0 

func (r SettingGetResponseZonesMaxUploadValue) IsKnown() bool

type SettingGetResponseZonesReplaceInsecureJS added in v2.4.0 

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 added in v2.4.0 

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

type SettingGetResponseZonesReplaceInsecureJSEditable added in v2.4.0 

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 added in v2.4.0 

func (r SettingGetResponseZonesReplaceInsecureJSEditable) IsKnown() bool

type SettingGetResponseZonesReplaceInsecureJSID added in v2.4.0 

type SettingGetResponseZonesReplaceInsecureJSID string

ID of the zone setting. 

const (
	SettingGetResponseZonesReplaceInsecureJSIDReplaceInsecureJS SettingGetResponseZonesReplaceInsecureJSID = "replace_insecure_js"
)

func (SettingGetResponseZonesReplaceInsecureJSID) IsKnown added in v2.4.0 

func (r SettingGetResponseZonesReplaceInsecureJSID) IsKnown() bool

type SettingGetResponseZonesReplaceInsecureJSValue added in v2.4.0 

type SettingGetResponseZonesReplaceInsecureJSValue string

Current value of the zone setting. 

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

func (SettingGetResponseZonesReplaceInsecureJSValue) IsKnown added in v2.4.0 

func (r SettingGetResponseZonesReplaceInsecureJSValue) IsKnown() bool

type SettingGetResponseZonesSchemasAutomaticPlatformOptimization added in v2.4.0 

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 added in v2.4.0 

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

type SettingGetResponseZonesSchemasAutomaticPlatformOptimizationEditable added in v2.4.0 

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 added in v2.4.0 

func (r SettingGetResponseZonesSchemasAutomaticPlatformOptimizationEditable) IsKnown() bool

type SettingGetResponseZonesSchemasAutomaticPlatformOptimizationID added in v2.4.0 

type SettingGetResponseZonesSchemasAutomaticPlatformOptimizationID string

ID of the zone setting. 

const (
	SettingGetResponseZonesSchemasAutomaticPlatformOptimizationIDAutomaticPlatformOptimization SettingGetResponseZonesSchemasAutomaticPlatformOptimizationID = "automatic_platform_optimization"
)

func (SettingGetResponseZonesSchemasAutomaticPlatformOptimizationID) IsKnown added in v2.4.0 

func (r SettingGetResponseZonesSchemasAutomaticPlatformOptimizationID) IsKnown() bool

type SettingGetResponseZonesSha1Support added in v2.4.0 

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 added in v2.4.0 

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

type SettingGetResponseZonesSha1SupportEditable added in v2.4.0 

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 added in v2.4.0 

func (r SettingGetResponseZonesSha1SupportEditable) IsKnown() bool

type SettingGetResponseZonesSha1SupportID added in v2.4.0 

type SettingGetResponseZonesSha1SupportID string

Zone setting identifier. 

const (
	SettingGetResponseZonesSha1SupportIDSha1Support SettingGetResponseZonesSha1SupportID = "sha1_support"
)

func (SettingGetResponseZonesSha1SupportID) IsKnown added in v2.4.0 

func (r SettingGetResponseZonesSha1SupportID) IsKnown() bool

type SettingGetResponseZonesSha1SupportValue added in v2.4.0 

type SettingGetResponseZonesSha1SupportValue string

Current value of the zone setting. 

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

func (SettingGetResponseZonesSha1SupportValue) IsKnown added in v2.4.0 

func (r SettingGetResponseZonesSha1SupportValue) IsKnown() bool

type SettingGetResponseZonesTLS1_2Only added in v2.4.0 

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 added in v2.4.0 

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

type SettingGetResponseZonesTLS1_2OnlyEditable added in v2.4.0 

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 added in v2.4.0 

func (r SettingGetResponseZonesTLS1_2OnlyEditable) IsKnown() bool

type SettingGetResponseZonesTLS1_2OnlyID added in v2.4.0 

type SettingGetResponseZonesTLS1_2OnlyID string

Zone setting identifier. 

const (
	SettingGetResponseZonesTLS1_2OnlyIDTLS1_2Only SettingGetResponseZonesTLS1_2OnlyID = "tls_1_2_only"
)

func (SettingGetResponseZonesTLS1_2OnlyID) IsKnown added in v2.4.0 

func (r SettingGetResponseZonesTLS1_2OnlyID) IsKnown() bool

type SettingGetResponseZonesTLS1_2OnlyValue added in v2.4.0 

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 added in v2.4.0 

func (r SettingGetResponseZonesTLS1_2OnlyValue) 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 added in v2.4.0 

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 added in v2.4.0 

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 added in v2.2.0 

type SortDirection = shared.SortDirection

Direction to order DNS records in.

This is an alias to an internal type.

type SortQueryStringForCache 

type SortQueryStringForCache struct {
	// ID of the zone setting.
	ID SortQueryStringForCacheID `json:"id,required"`
	// Current value of the zone setting.
	Value SortQueryStringForCacheValue `json:"value,required"`
	// Whether or not this setting can be modified for this zone (based on your
	// Cloudflare plan level).
	Editable SortQueryStringForCacheEditable `json:"editable"`
	// last time this setting was modified.
	ModifiedOn time.Time                   `json:"modified_on,nullable" format:"date-time"`
	JSON       sortQueryStringForCacheJSON `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 (*SortQueryStringForCache) UnmarshalJSON 

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

type SortQueryStringForCacheEditable 

type SortQueryStringForCacheEditable bool

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

const (
	SortQueryStringForCacheEditableTrue  SortQueryStringForCacheEditable = true
	SortQueryStringForCacheEditableFalse SortQueryStringForCacheEditable = false
)

func (SortQueryStringForCacheEditable) IsKnown 

func (r SortQueryStringForCacheEditable) IsKnown() bool

type SortQueryStringForCacheID 

type SortQueryStringForCacheID string

ID of the zone setting. 

const (
	SortQueryStringForCacheIDSortQueryStringForCache SortQueryStringForCacheID = "sort_query_string_for_cache"
)

func (SortQueryStringForCacheID) IsKnown 

func (r SortQueryStringForCacheID) IsKnown() bool

type SortQueryStringForCacheParam added in v2.4.0 

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

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

func (SortQueryStringForCacheParam) MarshalJSON added in v2.4.0 

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

type SortQueryStringForCacheValue 

type SortQueryStringForCacheValue string

Current value of the zone setting. 

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

func (SortQueryStringForCacheValue) IsKnown 

func (r SortQueryStringForCacheValue) IsKnown() bool

type SubscriptionGetResponseEnvelope 

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

type SubscriptionGetResponseUnion interface {
	ImplementsZonesSubscriptionGetResponseUnion()
}

Union satisfied by zones.SubscriptionGetResponseUnknown or shared.UnionString.

type SubscriptionNewParams 

type SubscriptionNewParams struct {
	Subscription user.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   SubscriptionNewResponseUnion `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 SubscriptionNewResponseUnion 

type SubscriptionNewResponseUnion interface {
	ImplementsZonesSubscriptionNewResponseUnion()
}

Union satisfied by zones.SubscriptionNewResponseUnknown or shared.UnionString.

type SubscriptionService 

type SubscriptionService struct {
	Options []option.RequestOption
}

SubscriptionService contains methods and other services that help with interacting with the cloudflare API.

Note, unlike clients, this service does not read variables from the environment automatically. You should not instantiate this service directly, and instead use the NewSubscriptionService method instead.

func NewSubscriptionService 

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

NewSubscriptionService generates a new service that applies the given options to each request. These options are applied after the parent client's options (if there is one), and before any request-specific options.

func (*SubscriptionService) Get 

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

Lists zone subscription details.

func (*SubscriptionService) List 

func (r *SubscriptionService) List(ctx context.Context, accountIdentifier string, opts ...option.RequestOption) (res *pagination.SinglePage[user.Subscription], err error)

Lists all of an account's subscriptions.

func (*SubscriptionService) ListAutoPaging 

func (r *SubscriptionService) ListAutoPaging(ctx context.Context, accountIdentifier string, opts ...option.RequestOption) *pagination.SinglePageAutoPager[user.Subscription]

Lists all of an account's subscriptions.

func (*SubscriptionService) New 

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

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

type TLS1_3 

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

Enables Crypto TLS 1.3 feature for a zone.

func (*TLS1_3) UnmarshalJSON 

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

type TLS1_3Editable 

type TLS1_3Editable bool

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

const (
	TLS1_3EditableTrue  TLS1_3Editable = true
	TLS1_3EditableFalse TLS1_3Editable = false
)

func (TLS1_3Editable) IsKnown 

func (r TLS1_3Editable) IsKnown() bool

type TLS1_3ID 

type TLS1_3ID string

ID of the zone setting. 

const (
	TLS1_3IDTLS1_3 TLS1_3ID = "tls_1_3"
)

func (TLS1_3ID) IsKnown 

func (r TLS1_3ID) IsKnown() bool

type TLS1_3Param added in v2.4.0 

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

Enables Crypto TLS 1.3 feature for a zone.

func (TLS1_3Param) MarshalJSON added in v2.4.0 

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

type TLS1_3Value 

type TLS1_3Value string

Current value of the zone setting. 

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

func (TLS1_3Value) IsKnown 

func (r TLS1_3Value) IsKnown() bool

type TLSClientAuth 

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

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

func (*TLSClientAuth) UnmarshalJSON 

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

type TLSClientAuthEditable 

type TLSClientAuthEditable bool

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

const (
	TLSClientAuthEditableTrue  TLSClientAuthEditable = true
	TLSClientAuthEditableFalse TLSClientAuthEditable = false
)

func (TLSClientAuthEditable) IsKnown 

func (r TLSClientAuthEditable) IsKnown() bool

type TLSClientAuthID 

type TLSClientAuthID string

ID of the zone setting. 

const (
	TLSClientAuthIDTLSClientAuth TLSClientAuthID = "tls_client_auth"
)

func (TLSClientAuthID) IsKnown 

func (r TLSClientAuthID) IsKnown() bool

type TLSClientAuthParam added in v2.4.0 

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

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

func (TLSClientAuthParam) MarshalJSON added in v2.4.0 

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

type TLSClientAuthValue 

type TLSClientAuthValue string

Current value of the zone setting. 

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

func (TLSClientAuthValue) IsKnown 

func (r TLSClientAuthValue) IsKnown() bool

type TrueClientIPHeader 

type TrueClientIPHeader struct {
	// ID of the zone setting.
	ID TrueClientIPHeaderID `json:"id,required"`
	// Current value of the zone setting.
	Value TrueClientIPHeaderValue `json:"value,required"`
	// Whether or not this setting can be modified for this zone (based on your
	// Cloudflare plan level).
	Editable TrueClientIPHeaderEditable `json:"editable"`
	// last time this setting was modified.
	ModifiedOn time.Time              `json:"modified_on,nullable" format:"date-time"`
	JSON       trueClientIPHeaderJSON `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 (*TrueClientIPHeader) UnmarshalJSON 

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

type TrueClientIPHeaderEditable 

type TrueClientIPHeaderEditable bool

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

const (
	TrueClientIPHeaderEditableTrue  TrueClientIPHeaderEditable = true
	TrueClientIPHeaderEditableFalse TrueClientIPHeaderEditable = false
)

func (TrueClientIPHeaderEditable) IsKnown 

func (r TrueClientIPHeaderEditable) IsKnown() bool

type TrueClientIPHeaderID 

type TrueClientIPHeaderID string

ID of the zone setting. 

const (
	TrueClientIPHeaderIDTrueClientIPHeader TrueClientIPHeaderID = "true_client_ip_header"
)

func (TrueClientIPHeaderID) IsKnown 

func (r TrueClientIPHeaderID) IsKnown() bool

type TrueClientIPHeaderParam added in v2.4.0 

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

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

func (TrueClientIPHeaderParam) MarshalJSON added in v2.4.0 

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

type TrueClientIPHeaderValue 

type TrueClientIPHeaderValue string

Current value of the zone setting. 

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

func (TrueClientIPHeaderValue) IsKnown 

func (r TrueClientIPHeaderValue) IsKnown() bool

type Type added in v2.2.0 

type Type string

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

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

func (Type) IsKnown added in v2.2.0 

func (r Type) IsKnown() bool

type WAF 

type WAF struct {
	// ID of the zone setting.
	ID WAFID `json:"id,required"`
	// Current value of the zone setting.
	Value WAFValue `json:"value,required"`
	// Whether or not this setting can be modified for this zone (based on your
	// Cloudflare plan level).
	Editable WAFEditable `json:"editable"`
	// last time this setting was modified.
	ModifiedOn time.Time `json:"modified_on,nullable" format:"date-time"`
	JSON       wafJSON   `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 (*WAF) UnmarshalJSON 

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

type WAFEditable 

type WAFEditable bool

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

const (
	WAFEditableTrue  WAFEditable = true
	WAFEditableFalse WAFEditable = false
)

func (WAFEditable) IsKnown 

func (r WAFEditable) IsKnown() bool

type WAFID 

type WAFID string

ID of the zone setting. 

const (
	WAFIDWAF WAFID = "waf"
)

func (WAFID) IsKnown 

func (r WAFID) IsKnown() bool

type WAFParam added in v2.4.0 

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

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

func (WAFParam) MarshalJSON added in v2.4.0 

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

type WAFValue 

type WAFValue string

Current value of the zone setting. 

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

func (WAFValue) IsKnown 

func (r WAFValue) IsKnown() bool

type WebP 

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

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

func (*WebP) UnmarshalJSON 

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

type WebPEditable 

type WebPEditable bool

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

const (
	WebPEditableTrue  WebPEditable = true
	WebPEditableFalse WebPEditable = false
)

func (WebPEditable) IsKnown 

func (r WebPEditable) IsKnown() bool

type WebPID 

type WebPID string

ID of the zone setting. 

const (
	WebPIDWebP WebPID = "webp"
)

func (WebPID) IsKnown 

func (r WebPID) IsKnown() bool

type WebPJSON 

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

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

WebPJSON contains the JSON metadata for the struct WebP

func (WebPJSON) RawJSON 

func (r WebPJSON) RawJSON() string

type WebPParam added in v2.4.0 

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

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

func (WebPParam) MarshalJSON added in v2.4.0 

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

type WebPValue 

type WebPValue string

Current value of the zone setting. 

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

func (WebPValue) IsKnown 

func (r WebPValue) IsKnown() bool

type Websocket 

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

WebSockets are open connections sustained between the client and the origin server. Inside a WebSockets connection, the client and the origin can pass data back and forth without having to reestablish sessions. This makes exchanging data within a WebSockets connection fast. WebSockets are often used for real-time applications such as live chat and gaming. For more information refer to [Can I use Cloudflare with Websockets](https://support.cloudflare.com/hc/en-us/articles/200169466-Can-I-use-Cloudflare-with-WebSockets-).

func (*Websocket) UnmarshalJSON 

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

type WebsocketEditable 

type WebsocketEditable bool

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

const (
	WebsocketEditableTrue  WebsocketEditable = true
	WebsocketEditableFalse WebsocketEditable = false
)

func (WebsocketEditable) IsKnown 

func (r WebsocketEditable) IsKnown() bool

type WebsocketID 

type WebsocketID string

ID of the zone setting. 

const (
	WebsocketIDWebsockets WebsocketID = "websockets"
)

func (WebsocketID) IsKnown 

func (r WebsocketID) IsKnown() bool

type WebsocketParam added in v2.4.0 

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

WebSockets are open connections sustained between the client and the origin server. Inside a WebSockets connection, the client and the origin can pass data back and forth without having to reestablish sessions. This makes exchanging data within a WebSockets connection fast. WebSockets are often used for real-time applications such as live chat and gaming. For more information refer to [Can I use Cloudflare with Websockets](https://support.cloudflare.com/hc/en-us/articles/200169466-Can-I-use-Cloudflare-with-WebSockets-).

func (WebsocketParam) MarshalJSON added in v2.4.0 

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

type WebsocketValue 

type WebsocketValue string

Current value of the zone setting. 

const (
	WebsocketValueOff WebsocketValue = "off"
	WebsocketValueOn  WebsocketValue = "on"
)

func (WebsocketValue) IsKnown 

func (r WebsocketValue) IsKnown() bool

type ZeroRTT 

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

0-RTT session resumption enabled for this zone.

func (*ZeroRTT) UnmarshalJSON 

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

type ZeroRTTEditable 

type ZeroRTTEditable bool

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

const (
	ZeroRTTEditableTrue  ZeroRTTEditable = true
	ZeroRTTEditableFalse ZeroRTTEditable = false
)

func (ZeroRTTEditable) IsKnown 

func (r ZeroRTTEditable) IsKnown() bool

type ZeroRTTID 

type ZeroRTTID string

ID of the zone setting. 

const (
	ZeroRTTID0rtt ZeroRTTID = "0rtt"
)

func (ZeroRTTID) IsKnown 

func (r ZeroRTTID) IsKnown() bool

type ZeroRTTParam added in v2.4.0 

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

0-RTT session resumption enabled for this zone.

func (ZeroRTTParam) MarshalJSON added in v2.4.0 

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

type ZeroRTTValue 

type ZeroRTTValue string

Current value of the zone setting. 

const (
	ZeroRTTValueOn  ZeroRTTValue = "on"
	ZeroRTTValueOff ZeroRTTValue = "off"
)

func (ZeroRTTValue) IsKnown 

func (r ZeroRTTValue) IsKnown() bool

type Zone 

type Zone struct {
	// Identifier
	ID string `json:"id,required"`
	// The account the zone belongs to
	Account ZoneAccount `json:"account,required"`
	// The last time proof of ownership was detected and the zone was made active
	ActivatedOn time.Time `json:"activated_on,required,nullable" format:"date-time"`
	// When the zone was created
	CreatedOn time.Time `json:"created_on,required" format:"date-time"`
	// The interval (in seconds) from when development mode expires (positive integer)
	// or last expired (negative integer) for the domain. If development mode has never
	// been enabled, this value is 0.
	DevelopmentMode float64 `json:"development_mode,required"`
	// Metadata about the zone
	Meta ZoneMeta `json:"meta,required"`
	// When the zone was last modified
	ModifiedOn time.Time `json:"modified_on,required" format:"date-time"`
	// The domain name
	Name string `json:"name,required"`
	// The name servers Cloudflare assigns to a zone
	NameServers []string `json:"name_servers,required" format:"hostname"`
	// DNS host at the time of switching to Cloudflare
	OriginalDnshost string `json:"original_dnshost,required,nullable"`
	// Original name servers before moving to Cloudflare
	OriginalNameServers []string `json:"original_name_servers,required,nullable" format:"hostname"`
	// Registrar for the domain at the time of switching to Cloudflare
	OriginalRegistrar string `json:"original_registrar,required,nullable"`
	// The owner of the zone
	Owner ZoneOwner `json:"owner,required"`
	// An array of domains used for custom name servers. This is only available for
	// Business and Enterprise plans.
	VanityNameServers []string `json:"vanity_name_servers" format:"hostname"`
	JSON              zoneJSON `json:"-"`
}

func (*Zone) UnmarshalJSON 

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

type ZoneAccount 

type ZoneAccount struct {
	// Identifier
	ID string `json:"id"`
	// The name of the account
	Name string          `json:"name"`
	JSON zoneAccountJSON `json:"-"`
}

The account the zone belongs to

func (*ZoneAccount) UnmarshalJSON 

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

type ZoneDeleteParams 

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

type ZoneDeleteResponse 

type ZoneDeleteResponse struct {
	// Identifier
	ID   string                 `json:"id,required"`
	JSON zoneDeleteResponseJSON `json:"-"`
}

func (*ZoneDeleteResponse) UnmarshalJSON 

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

type ZoneDeleteResponseEnvelope 

type ZoneDeleteResponseEnvelope struct {
	Errors   []shared.ResponseInfo `json:"errors,required"`
	Messages []shared.ResponseInfo `json:"messages,required"`
	// Whether the API call was successful
	Success bool                           `json:"success,required"`
	Result  ZoneDeleteResponse             `json:"result,nullable"`
	JSON    zoneDeleteResponseEnvelopeJSON `json:"-"`
}

func (*ZoneDeleteResponseEnvelope) UnmarshalJSON 

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

type ZoneEditParams 

type ZoneEditParams struct {
	// Identifier
	ZoneID param.Field[string] `path:"zone_id,required"`
	// (Deprecated) Please use the `/zones/{zone_id}/subscription` API to update a
	// zone's plan. Changing this value will create/cancel associated subscriptions. To
	// view available plans for this zone, see Zone Plans.
	Plan param.Field[ZoneEditParamsPlan] `json:"plan"`
	// 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 ZoneEditParamsPlan 

type ZoneEditParamsPlan struct {
	// Identifier
	ID param.Field[string] `json:"id"`
}

(Deprecated) Please use the `/zones/{zone_id}/subscription` API to update a zone's plan. Changing this value will create/cancel associated subscriptions. To view available plans for this zone, see Zone Plans.

func (ZoneEditParamsPlan) MarshalJSON 

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

type ZoneEditParamsType 

type ZoneEditParamsType string

A full zone implies that DNS is hosted with Cloudflare. A partial zone is typically a partner-hosted zone or a CNAME setup. This parameter is only available to Enterprise customers or if it has been explicitly enabled on a zone. 

const (
	ZoneEditParamsTypeFull      ZoneEditParamsType = "full"
	ZoneEditParamsTypePartial   ZoneEditParamsType = "partial"
	ZoneEditParamsTypeSecondary ZoneEditParamsType = "secondary"
)

func (ZoneEditParamsType) IsKnown 

func (r ZoneEditParamsType) IsKnown() bool

type ZoneEditResponseEnvelope 

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

func (*ZoneEditResponseEnvelope) UnmarshalJSON 

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

type ZoneGetParams 

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

type ZoneGetResponseEnvelope 

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

func (*ZoneGetResponseEnvelope) UnmarshalJSON 

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

type ZoneHold 

type ZoneHold struct {
	Hold              bool         `json:"hold"`
	HoldAfter         string       `json:"hold_after"`
	IncludeSubdomains string       `json:"include_subdomains"`
	JSON              zoneHoldJSON `json:"-"`
}

func (*ZoneHold) UnmarshalJSON 

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

type ZoneListParams 

type ZoneListParams struct {
	Account param.Field[ZoneListParamsAccount] `query:"account"`
	// Direction to order zones.
	Direction param.Field[ZoneListParamsDirection] `query:"direction"`
	// Whether to match all search requirements or at least one (any).
	Match param.Field[ZoneListParamsMatch] `query:"match"`
	// A domain name. Optional filter operators can be provided to extend refine the
	// search:
	//
	// - `equal` (default)
	// - `not_equal`
	// - `starts_with`
	// - `ends_with`
	// - `contains`
	// - `starts_with_case_sensitive`
	// - `ends_with_case_sensitive`
	// - `contains_case_sensitive`
	Name param.Field[string] `query:"name"`
	// Field to order zones by.
	Order param.Field[ZoneListParamsOrder] `query:"order"`
	// Page number of paginated results.
	Page param.Field[float64] `query:"page"`
	// Number of zones per page.
	PerPage param.Field[float64] `query:"per_page"`
	// A zone status
	Status param.Field[ZoneListParamsStatus] `query:"status"`
}

func (ZoneListParams) URLQuery 

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

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

type ZoneListParamsAccount 

type ZoneListParamsAccount struct {
	// An account ID
	ID param.Field[string] `query:"id"`
	// An account Name. Optional filter operators can be provided to extend refine the
	// search:
	//
	// - `equal` (default)
	// - `not_equal`
	// - `starts_with`
	// - `ends_with`
	// - `contains`
	// - `starts_with_case_sensitive`
	// - `ends_with_case_sensitive`
	// - `contains_case_sensitive`
	Name param.Field[string] `query:"name"`
}

func (ZoneListParamsAccount) URLQuery 

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

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

type ZoneListParamsDirection 

type ZoneListParamsDirection string

Direction to order zones. 

const (
	ZoneListParamsDirectionAsc  ZoneListParamsDirection = "asc"
	ZoneListParamsDirectionDesc ZoneListParamsDirection = "desc"
)

func (ZoneListParamsDirection) IsKnown 

func (r ZoneListParamsDirection) IsKnown() bool

type ZoneListParamsMatch 

type ZoneListParamsMatch string

Whether to match all search requirements or at least one (any). 

const (
	ZoneListParamsMatchAny ZoneListParamsMatch = "any"
	ZoneListParamsMatchAll ZoneListParamsMatch = "all"
)

func (ZoneListParamsMatch) IsKnown 

func (r ZoneListParamsMatch) IsKnown() bool

type ZoneListParamsOrder 

type ZoneListParamsOrder string

Field to order zones by. 

const (
	ZoneListParamsOrderName        ZoneListParamsOrder = "name"
	ZoneListParamsOrderStatus      ZoneListParamsOrder = "status"
	ZoneListParamsOrderAccountID   ZoneListParamsOrder = "account.id"
	ZoneListParamsOrderAccountName ZoneListParamsOrder = "account.name"
)

func (ZoneListParamsOrder) IsKnown 

func (r ZoneListParamsOrder) IsKnown() bool

type ZoneListParamsStatus 

type ZoneListParamsStatus string

A zone status 

const (
	ZoneListParamsStatusInitializing ZoneListParamsStatus = "initializing"
	ZoneListParamsStatusPending      ZoneListParamsStatus = "pending"
	ZoneListParamsStatusActive       ZoneListParamsStatus = "active"
	ZoneListParamsStatusMoved        ZoneListParamsStatus = "moved"
)

func (ZoneListParamsStatus) IsKnown 

func (r ZoneListParamsStatus) IsKnown() bool

type ZoneMeta 

type ZoneMeta struct {
	// The zone is only configured for CDN
	CDNOnly bool `json:"cdn_only"`
	// Number of Custom Certificates the zone can have
	CustomCertificateQuota int64 `json:"custom_certificate_quota"`
	// The zone is only configured for DNS
	DNSOnly bool `json:"dns_only"`
	// The zone is setup with Foundation DNS
	FoundationDNS bool `json:"foundation_dns"`
	// Number of Page Rules a zone can have
	PageRuleQuota int64 `json:"page_rule_quota"`
	// The zone has been flagged for phishing
	PhishingDetected bool         `json:"phishing_detected"`
	Step             int64        `json:"step"`
	JSON             zoneMetaJSON `json:"-"`
}

Metadata about the zone

func (*ZoneMeta) UnmarshalJSON 

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

type ZoneNewParams 

type ZoneNewParams struct {
	Account param.Field[ZoneNewParamsAccount] `json:"account,required"`
	// The domain name
	Name param.Field[string] `json:"name,required"`
	// A full zone implies that DNS is hosted with Cloudflare. A partial zone is
	// typically a partner-hosted zone or a CNAME setup.
	Type param.Field[Type] `json:"type"`
}

func (ZoneNewParams) MarshalJSON 

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

type ZoneNewParamsAccount 

type ZoneNewParamsAccount struct {
	// Identifier
	ID param.Field[string] `json:"id"`
}

func (ZoneNewParamsAccount) MarshalJSON 

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

type ZoneNewResponseEnvelope 

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

func (*ZoneNewResponseEnvelope) UnmarshalJSON 

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

type ZoneOwner 

type ZoneOwner struct {
	// Identifier
	ID string `json:"id"`
	// Name of the owner
	Name string `json:"name"`
	// The type of owner
	Type string        `json:"type"`
	JSON zoneOwnerJSON `json:"-"`
}

The owner of the zone

func (*ZoneOwner) UnmarshalJSON 

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

type ZoneService 

type ZoneService struct {
	Options           []option.RequestOption
	ActivationCheck   *ActivationCheckService
	Settings          *SettingService
	CustomNameservers *CustomNameserverService
	Holds             *HoldService
	Subscriptions     *SubscriptionService
}

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.

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.

func (*ZoneService) New 

func (r *ZoneService) New(ctx context.Context, body ZoneNewParams, opts ...option.RequestOption) (res *Zone, err error)

Create Zone

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.