zones

package
v2.0.0-beta.6 Latest Latest
Warning

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

 Go to latest Published: Mar 14, 2024 License: Apache-2.0 Imports: 14 Imported by: 1

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type ActivationCheckService 

type ActivationCheckService struct {
	Options []option.RequestOption
}

ActivationCheckService contains methods and other services that help with interacting with the cloudflare API. Note, unlike clients, this service does not read variables from the environment automatically. You should not instantiate this service directly, and instead use the NewActivationCheckService method instead.

func NewActivationCheckService 

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

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

func (*ActivationCheckService) Trigger 

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

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

type ActivationCheckTriggerParams 

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

type ActivationCheckTriggerResponse 

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

func (*ActivationCheckTriggerResponse) UnmarshalJSON 

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

type ActivationCheckTriggerResponseEnvelope 

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

func (*ActivationCheckTriggerResponseEnvelope) UnmarshalJSON 

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

type ActivationCheckTriggerResponseEnvelopeErrors 

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

func (*ActivationCheckTriggerResponseEnvelopeErrors) UnmarshalJSON 

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

type ActivationCheckTriggerResponseEnvelopeMessages 

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

func (*ActivationCheckTriggerResponseEnvelopeMessages) UnmarshalJSON 

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

type ActivationCheckTriggerResponseEnvelopeSuccess 

type ActivationCheckTriggerResponseEnvelopeSuccess bool

Whether the API call was successful 

const (
	ActivationCheckTriggerResponseEnvelopeSuccessTrue ActivationCheckTriggerResponseEnvelopeSuccess = true
)

type CustomNameserverGetParams 

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

type CustomNameserverGetResponse added in v2.2.0 

type CustomNameserverGetResponse interface {
	ImplementsZonesCustomNameserverGetResponse()
}

Union satisfied by zones.CustomNameserverGetResponseUnknown, zones.CustomNameserverGetResponseArray or shared.UnionString.

type CustomNameserverGetResponseArray 

type CustomNameserverGetResponseArray []interface{}

func (CustomNameserverGetResponseArray) ImplementsZonesCustomNameserverGetResponse 

func (r CustomNameserverGetResponseArray) ImplementsZonesCustomNameserverGetResponse()

type CustomNameserverGetResponseEnvelope 

type CustomNameserverGetResponseEnvelope struct {
	Errors   []CustomNameserverGetResponseEnvelopeErrors   `json:"errors,required"`
	Messages []CustomNameserverGetResponseEnvelopeMessages `json:"messages,required"`
	Result   CustomNameserverGetResponse                   `json:"result,required,nullable"`
	// 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"`
	ResultInfo CustomNameserverGetResponseEnvelopeResultInfo `json:"result_info"`
	JSON       customNameserverGetResponseEnvelopeJSON       `json:"-"`
}

func (*CustomNameserverGetResponseEnvelope) UnmarshalJSON 

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

type CustomNameserverGetResponseEnvelopeErrors 

type CustomNameserverGetResponseEnvelopeErrors struct {
	Code    int64                                         `json:"code,required"`
	Message string                                        `json:"message,required"`
	JSON    customNameserverGetResponseEnvelopeErrorsJSON `json:"-"`
}

func (*CustomNameserverGetResponseEnvelopeErrors) UnmarshalJSON 

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

type CustomNameserverGetResponseEnvelopeMessages 

type CustomNameserverGetResponseEnvelopeMessages struct {
	Code    int64                                           `json:"code,required"`
	Message string                                          `json:"message,required"`
	JSON    customNameserverGetResponseEnvelopeMessagesJSON `json:"-"`
}

func (*CustomNameserverGetResponseEnvelopeMessages) UnmarshalJSON 

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

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 {
	ImplementsZonesCustomNameserverUpdateResponse()
}

Union satisfied by zones.CustomNameserverUpdateResponseUnknown, zones.CustomNameserverUpdateResponseArray or shared.UnionString.

type CustomNameserverUpdateResponseArray 

type CustomNameserverUpdateResponseArray []interface{}

func (CustomNameserverUpdateResponseArray) ImplementsZonesCustomNameserverUpdateResponse 

func (r CustomNameserverUpdateResponseArray) ImplementsZonesCustomNameserverUpdateResponse()

type CustomNameserverUpdateResponseEnvelope 

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

func (*CustomNameserverUpdateResponseEnvelope) UnmarshalJSON 

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

type CustomNameserverUpdateResponseEnvelopeErrors 

type CustomNameserverUpdateResponseEnvelopeErrors struct {
	Code    int64                                            `json:"code,required"`
	Message string                                           `json:"message,required"`
	JSON    customNameserverUpdateResponseEnvelopeErrorsJSON `json:"-"`
}

func (*CustomNameserverUpdateResponseEnvelopeErrors) UnmarshalJSON 

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

type CustomNameserverUpdateResponseEnvelopeMessages 

type CustomNameserverUpdateResponseEnvelopeMessages struct {
	Code    int64                                              `json:"code,required"`
	Message string                                             `json:"message,required"`
	JSON    customNameserverUpdateResponseEnvelopeMessagesJSON `json:"-"`
}

func (*CustomNameserverUpdateResponseEnvelopeMessages) UnmarshalJSON 

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

type Error 

type Error = apierror.Error

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 HoldDeleteResponse 

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

func (*HoldDeleteResponse) UnmarshalJSON 

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

type HoldDeleteResponseEnvelope 

type HoldDeleteResponseEnvelope struct {
	Result HoldDeleteResponse             `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 HoldGetResponse 

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

func (*HoldGetResponse) UnmarshalJSON 

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

type HoldGetResponseEnvelope 

type HoldGetResponseEnvelope struct {
	Errors   []HoldGetResponseEnvelopeErrors   `json:"errors,required"`
	Messages []HoldGetResponseEnvelopeMessages `json:"messages,required"`
	Result   HoldGetResponse                   `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 HoldGetResponseEnvelopeErrors 

type HoldGetResponseEnvelopeErrors struct {
	Code    int64                             `json:"code,required"`
	Message string                            `json:"message,required"`
	JSON    holdGetResponseEnvelopeErrorsJSON `json:"-"`
}

func (*HoldGetResponseEnvelopeErrors) UnmarshalJSON 

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

type HoldGetResponseEnvelopeMessages 

type HoldGetResponseEnvelopeMessages struct {
	Code    int64                               `json:"code,required"`
	Message string                              `json:"message,required"`
	JSON    holdGetResponseEnvelopeMessagesJSON `json:"-"`
}

func (*HoldGetResponseEnvelopeMessages) UnmarshalJSON 

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

type HoldGetResponseEnvelopeSuccess 

type HoldGetResponseEnvelopeSuccess bool

Whether the API call was successful 

const (
	HoldGetResponseEnvelopeSuccessTrue HoldGetResponseEnvelopeSuccess = true
)

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 HoldNewResponse 

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

func (*HoldNewResponse) UnmarshalJSON 

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

type HoldNewResponseEnvelope 

type HoldNewResponseEnvelope struct {
	Errors   []HoldNewResponseEnvelopeErrors   `json:"errors,required"`
	Messages []HoldNewResponseEnvelopeMessages `json:"messages,required"`
	Result   HoldNewResponse                   `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 HoldNewResponseEnvelopeErrors 

type HoldNewResponseEnvelopeErrors struct {
	Code    int64                             `json:"code,required"`
	Message string                            `json:"message,required"`
	JSON    holdNewResponseEnvelopeErrorsJSON `json:"-"`
}

func (*HoldNewResponseEnvelopeErrors) UnmarshalJSON 

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

type HoldNewResponseEnvelopeMessages 

type HoldNewResponseEnvelopeMessages struct {
	Code    int64                               `json:"code,required"`
	Message string                              `json:"message,required"`
	JSON    holdNewResponseEnvelopeMessagesJSON `json:"-"`
}

func (*HoldNewResponseEnvelopeMessages) UnmarshalJSON 

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

type HoldNewResponseEnvelopeSuccess 

type HoldNewResponseEnvelopeSuccess bool

Whether the API call was successful 

const (
	HoldNewResponseEnvelopeSuccessTrue HoldNewResponseEnvelopeSuccess = true
)

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 *HoldDeleteResponse, 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 *HoldGetResponse, 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 *HoldNewResponse, err error)

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

type SettingAdvancedDDOSGetParams 

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

type SettingAdvancedDDOSGetResponseEnvelope 

type SettingAdvancedDDOSGetResponseEnvelope struct {
	Errors   []SettingAdvancedDDOSGetResponseEnvelopeErrors   `json:"errors,required"`
	Messages []SettingAdvancedDDOSGetResponseEnvelopeMessages `json:"messages,required"`
	// Whether the API call was successful
	Success bool `json:"success,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.
	Result ZonesAdvancedDDOS                          `json:"result"`
	JSON   settingAdvancedDDOSGetResponseEnvelopeJSON `json:"-"`
}

func (*SettingAdvancedDDOSGetResponseEnvelope) UnmarshalJSON 

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

type SettingAdvancedDDOSGetResponseEnvelopeErrors 

type SettingAdvancedDDOSGetResponseEnvelopeErrors struct {
	Code    int64                                            `json:"code,required"`
	Message string                                           `json:"message,required"`
	JSON    settingAdvancedDDOSGetResponseEnvelopeErrorsJSON `json:"-"`
}

func (*SettingAdvancedDDOSGetResponseEnvelopeErrors) UnmarshalJSON 

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

type SettingAdvancedDDOSGetResponseEnvelopeMessages 

type SettingAdvancedDDOSGetResponseEnvelopeMessages struct {
	Code    int64                                              `json:"code,required"`
	Message string                                             `json:"message,required"`
	JSON    settingAdvancedDDOSGetResponseEnvelopeMessagesJSON `json:"-"`
}

func (*SettingAdvancedDDOSGetResponseEnvelopeMessages) UnmarshalJSON 

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

type SettingAdvancedDDOSService 

type SettingAdvancedDDOSService struct {
	Options []option.RequestOption
}

SettingAdvancedDDOSService 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 NewSettingAdvancedDDOSService method instead.

func NewSettingAdvancedDDOSService 

func NewSettingAdvancedDDOSService(opts ...option.RequestOption) (r *SettingAdvancedDDOSService)

NewSettingAdvancedDDOSService 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 (*SettingAdvancedDDOSService) Get 

func (r *SettingAdvancedDDOSService) Get(ctx context.Context, query SettingAdvancedDDOSGetParams, opts ...option.RequestOption) (res *ZonesAdvancedDDOS, err error)

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.

type SettingAlwaysOnlineEditParams 

type SettingAlwaysOnlineEditParams struct {
	// Identifier
	ZoneID param.Field[string] `path:"zone_id,required"`
	// Value of the zone setting.
	Value param.Field[SettingAlwaysOnlineEditParamsValue] `json:"value,required"`
}

func (SettingAlwaysOnlineEditParams) MarshalJSON 

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

type SettingAlwaysOnlineEditParamsValue 

type SettingAlwaysOnlineEditParamsValue string

Value of the zone setting. 

const (
	SettingAlwaysOnlineEditParamsValueOn  SettingAlwaysOnlineEditParamsValue = "on"
	SettingAlwaysOnlineEditParamsValueOff SettingAlwaysOnlineEditParamsValue = "off"
)

type SettingAlwaysOnlineEditResponseEnvelope 

type SettingAlwaysOnlineEditResponseEnvelope struct {
	Errors   []SettingAlwaysOnlineEditResponseEnvelopeErrors   `json:"errors,required"`
	Messages []SettingAlwaysOnlineEditResponseEnvelopeMessages `json:"messages,required"`
	// Whether the API call was successful
	Success bool `json:"success,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.
	Result ZonesAlwaysOnline                           `json:"result"`
	JSON   settingAlwaysOnlineEditResponseEnvelopeJSON `json:"-"`
}

func (*SettingAlwaysOnlineEditResponseEnvelope) UnmarshalJSON 

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

type SettingAlwaysOnlineEditResponseEnvelopeErrors 

type SettingAlwaysOnlineEditResponseEnvelopeErrors struct {
	Code    int64                                             `json:"code,required"`
	Message string                                            `json:"message,required"`
	JSON    settingAlwaysOnlineEditResponseEnvelopeErrorsJSON `json:"-"`
}

func (*SettingAlwaysOnlineEditResponseEnvelopeErrors) UnmarshalJSON 

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

type SettingAlwaysOnlineEditResponseEnvelopeMessages 

type SettingAlwaysOnlineEditResponseEnvelopeMessages struct {
	Code    int64                                               `json:"code,required"`
	Message string                                              `json:"message,required"`
	JSON    settingAlwaysOnlineEditResponseEnvelopeMessagesJSON `json:"-"`
}

func (*SettingAlwaysOnlineEditResponseEnvelopeMessages) UnmarshalJSON 

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

type SettingAlwaysOnlineGetParams 

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

type SettingAlwaysOnlineGetResponseEnvelope 

type SettingAlwaysOnlineGetResponseEnvelope struct {
	Errors   []SettingAlwaysOnlineGetResponseEnvelopeErrors   `json:"errors,required"`
	Messages []SettingAlwaysOnlineGetResponseEnvelopeMessages `json:"messages,required"`
	// Whether the API call was successful
	Success bool `json:"success,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.
	Result ZonesAlwaysOnline                          `json:"result"`
	JSON   settingAlwaysOnlineGetResponseEnvelopeJSON `json:"-"`
}

func (*SettingAlwaysOnlineGetResponseEnvelope) UnmarshalJSON 

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

type SettingAlwaysOnlineGetResponseEnvelopeErrors 

type SettingAlwaysOnlineGetResponseEnvelopeErrors struct {
	Code    int64                                            `json:"code,required"`
	Message string                                           `json:"message,required"`
	JSON    settingAlwaysOnlineGetResponseEnvelopeErrorsJSON `json:"-"`
}

func (*SettingAlwaysOnlineGetResponseEnvelopeErrors) UnmarshalJSON 

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

type SettingAlwaysOnlineGetResponseEnvelopeMessages 

type SettingAlwaysOnlineGetResponseEnvelopeMessages struct {
	Code    int64                                              `json:"code,required"`
	Message string                                             `json:"message,required"`
	JSON    settingAlwaysOnlineGetResponseEnvelopeMessagesJSON `json:"-"`
}

func (*SettingAlwaysOnlineGetResponseEnvelopeMessages) UnmarshalJSON 

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

type SettingAlwaysOnlineService 

type SettingAlwaysOnlineService struct {
	Options []option.RequestOption
}

SettingAlwaysOnlineService 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 NewSettingAlwaysOnlineService method instead.

func NewSettingAlwaysOnlineService 

func NewSettingAlwaysOnlineService(opts ...option.RequestOption) (r *SettingAlwaysOnlineService)

NewSettingAlwaysOnlineService 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 (*SettingAlwaysOnlineService) Edit 

func (r *SettingAlwaysOnlineService) Edit(ctx context.Context, params SettingAlwaysOnlineEditParams, opts ...option.RequestOption) (res *ZonesAlwaysOnline, err error)

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

func (r *SettingAlwaysOnlineService) Get(ctx context.Context, query SettingAlwaysOnlineGetParams, opts ...option.RequestOption) (res *ZonesAlwaysOnline, err error)

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.

type SettingAlwaysUseHTTPSEditParams 

type SettingAlwaysUseHTTPSEditParams struct {
	// Identifier
	ZoneID param.Field[string] `path:"zone_id,required"`
	// Value of the zone setting.
	Value param.Field[SettingAlwaysUseHTTPSEditParamsValue] `json:"value,required"`
}

func (SettingAlwaysUseHTTPSEditParams) MarshalJSON 

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

type SettingAlwaysUseHTTPSEditParamsValue 

type SettingAlwaysUseHTTPSEditParamsValue string

Value of the zone setting. 

const (
	SettingAlwaysUseHTTPSEditParamsValueOn  SettingAlwaysUseHTTPSEditParamsValue = "on"
	SettingAlwaysUseHTTPSEditParamsValueOff SettingAlwaysUseHTTPSEditParamsValue = "off"
)

type SettingAlwaysUseHTTPSEditResponseEnvelope 

type SettingAlwaysUseHTTPSEditResponseEnvelope struct {
	Errors   []SettingAlwaysUseHTTPSEditResponseEnvelopeErrors   `json:"errors,required"`
	Messages []SettingAlwaysUseHTTPSEditResponseEnvelopeMessages `json:"messages,required"`
	// Whether the API call was successful
	Success bool `json:"success,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.
	Result ZonesAlwaysUseHTTPS                           `json:"result"`
	JSON   settingAlwaysUseHTTPSEditResponseEnvelopeJSON `json:"-"`
}

func (*SettingAlwaysUseHTTPSEditResponseEnvelope) UnmarshalJSON 

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

type SettingAlwaysUseHTTPSEditResponseEnvelopeErrors 

type SettingAlwaysUseHTTPSEditResponseEnvelopeErrors struct {
	Code    int64                                               `json:"code,required"`
	Message string                                              `json:"message,required"`
	JSON    settingAlwaysUseHTTPSEditResponseEnvelopeErrorsJSON `json:"-"`
}

func (*SettingAlwaysUseHTTPSEditResponseEnvelopeErrors) UnmarshalJSON 

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

type SettingAlwaysUseHTTPSEditResponseEnvelopeMessages 

type SettingAlwaysUseHTTPSEditResponseEnvelopeMessages struct {
	Code    int64                                                 `json:"code,required"`
	Message string                                                `json:"message,required"`
	JSON    settingAlwaysUseHTTPSEditResponseEnvelopeMessagesJSON `json:"-"`
}

func (*SettingAlwaysUseHTTPSEditResponseEnvelopeMessages) UnmarshalJSON 

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

type SettingAlwaysUseHTTPSGetParams 

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

type SettingAlwaysUseHTTPSGetResponseEnvelope 

type SettingAlwaysUseHTTPSGetResponseEnvelope struct {
	Errors   []SettingAlwaysUseHTTPSGetResponseEnvelopeErrors   `json:"errors,required"`
	Messages []SettingAlwaysUseHTTPSGetResponseEnvelopeMessages `json:"messages,required"`
	// Whether the API call was successful
	Success bool `json:"success,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.
	Result ZonesAlwaysUseHTTPS                          `json:"result"`
	JSON   settingAlwaysUseHTTPSGetResponseEnvelopeJSON `json:"-"`
}

func (*SettingAlwaysUseHTTPSGetResponseEnvelope) UnmarshalJSON 

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

type SettingAlwaysUseHTTPSGetResponseEnvelopeErrors 

type SettingAlwaysUseHTTPSGetResponseEnvelopeErrors struct {
	Code    int64                                              `json:"code,required"`
	Message string                                             `json:"message,required"`
	JSON    settingAlwaysUseHTTPSGetResponseEnvelopeErrorsJSON `json:"-"`
}

func (*SettingAlwaysUseHTTPSGetResponseEnvelopeErrors) UnmarshalJSON 

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

type SettingAlwaysUseHTTPSGetResponseEnvelopeMessages 

type SettingAlwaysUseHTTPSGetResponseEnvelopeMessages struct {
	Code    int64                                                `json:"code,required"`
	Message string                                               `json:"message,required"`
	JSON    settingAlwaysUseHTTPSGetResponseEnvelopeMessagesJSON `json:"-"`
}

func (*SettingAlwaysUseHTTPSGetResponseEnvelopeMessages) UnmarshalJSON 

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

type SettingAlwaysUseHTTPSService 

type SettingAlwaysUseHTTPSService struct {
	Options []option.RequestOption
}

SettingAlwaysUseHTTPSService 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 NewSettingAlwaysUseHTTPSService method instead.

func NewSettingAlwaysUseHTTPSService 

func NewSettingAlwaysUseHTTPSService(opts ...option.RequestOption) (r *SettingAlwaysUseHTTPSService)

NewSettingAlwaysUseHTTPSService 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 (*SettingAlwaysUseHTTPSService) Edit 

func (r *SettingAlwaysUseHTTPSService) Edit(ctx context.Context, params SettingAlwaysUseHTTPSEditParams, opts ...option.RequestOption) (res *ZonesAlwaysUseHTTPS, err error)

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

func (r *SettingAlwaysUseHTTPSService) Get(ctx context.Context, query SettingAlwaysUseHTTPSGetParams, opts ...option.RequestOption) (res *ZonesAlwaysUseHTTPS, err error)

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.

type SettingAutomaticHTTPSRewriteEditParams 

type SettingAutomaticHTTPSRewriteEditParams struct {
	// Identifier
	ZoneID param.Field[string] `path:"zone_id,required"`
	// Value of the zone setting. Notes: Default value depends on the zone's plan
	// level.
	Value param.Field[SettingAutomaticHTTPSRewriteEditParamsValue] `json:"value,required"`
}

func (SettingAutomaticHTTPSRewriteEditParams) MarshalJSON 

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

type SettingAutomaticHTTPSRewriteEditParamsValue 

type SettingAutomaticHTTPSRewriteEditParamsValue string

Value of the zone setting. Notes: Default value depends on the zone's plan level. 

const (
	SettingAutomaticHTTPSRewriteEditParamsValueOn  SettingAutomaticHTTPSRewriteEditParamsValue = "on"
	SettingAutomaticHTTPSRewriteEditParamsValueOff SettingAutomaticHTTPSRewriteEditParamsValue = "off"
)

type SettingAutomaticHTTPSRewriteEditResponseEnvelope 

type SettingAutomaticHTTPSRewriteEditResponseEnvelope struct {
	Errors   []SettingAutomaticHTTPSRewriteEditResponseEnvelopeErrors   `json:"errors,required"`
	Messages []SettingAutomaticHTTPSRewriteEditResponseEnvelopeMessages `json:"messages,required"`
	// Whether the API call was successful
	Success bool `json:"success,required"`
	// Enable the Automatic HTTPS Rewrites feature for this zone.
	Result ZonesAutomaticHTTPSRewrites                          `json:"result"`
	JSON   settingAutomaticHTTPSRewriteEditResponseEnvelopeJSON `json:"-"`
}

func (*SettingAutomaticHTTPSRewriteEditResponseEnvelope) UnmarshalJSON 

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

type SettingAutomaticHTTPSRewriteEditResponseEnvelopeErrors 

type SettingAutomaticHTTPSRewriteEditResponseEnvelopeErrors struct {
	Code    int64                                                      `json:"code,required"`
	Message string                                                     `json:"message,required"`
	JSON    settingAutomaticHTTPSRewriteEditResponseEnvelopeErrorsJSON `json:"-"`
}

func (*SettingAutomaticHTTPSRewriteEditResponseEnvelopeErrors) UnmarshalJSON 

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

type SettingAutomaticHTTPSRewriteEditResponseEnvelopeMessages 

type SettingAutomaticHTTPSRewriteEditResponseEnvelopeMessages struct {
	Code    int64                                                        `json:"code,required"`
	Message string                                                       `json:"message,required"`
	JSON    settingAutomaticHTTPSRewriteEditResponseEnvelopeMessagesJSON `json:"-"`
}

func (*SettingAutomaticHTTPSRewriteEditResponseEnvelopeMessages) UnmarshalJSON 

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

type SettingAutomaticHTTPSRewriteGetParams 

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

type SettingAutomaticHTTPSRewriteGetResponseEnvelope 

type SettingAutomaticHTTPSRewriteGetResponseEnvelope struct {
	Errors   []SettingAutomaticHTTPSRewriteGetResponseEnvelopeErrors   `json:"errors,required"`
	Messages []SettingAutomaticHTTPSRewriteGetResponseEnvelopeMessages `json:"messages,required"`
	// Whether the API call was successful
	Success bool `json:"success,required"`
	// Enable the Automatic HTTPS Rewrites feature for this zone.
	Result ZonesAutomaticHTTPSRewrites                         `json:"result"`
	JSON   settingAutomaticHTTPSRewriteGetResponseEnvelopeJSON `json:"-"`
}

func (*SettingAutomaticHTTPSRewriteGetResponseEnvelope) UnmarshalJSON 

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

type SettingAutomaticHTTPSRewriteGetResponseEnvelopeErrors 

type SettingAutomaticHTTPSRewriteGetResponseEnvelopeErrors struct {
	Code    int64                                                     `json:"code,required"`
	Message string                                                    `json:"message,required"`
	JSON    settingAutomaticHTTPSRewriteGetResponseEnvelopeErrorsJSON `json:"-"`
}

func (*SettingAutomaticHTTPSRewriteGetResponseEnvelopeErrors) UnmarshalJSON 

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

type SettingAutomaticHTTPSRewriteGetResponseEnvelopeMessages 

type SettingAutomaticHTTPSRewriteGetResponseEnvelopeMessages struct {
	Code    int64                                                       `json:"code,required"`
	Message string                                                      `json:"message,required"`
	JSON    settingAutomaticHTTPSRewriteGetResponseEnvelopeMessagesJSON `json:"-"`
}

func (*SettingAutomaticHTTPSRewriteGetResponseEnvelopeMessages) UnmarshalJSON 

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

type SettingAutomaticHTTPSRewriteService 

type SettingAutomaticHTTPSRewriteService struct {
	Options []option.RequestOption
}

SettingAutomaticHTTPSRewriteService 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 NewSettingAutomaticHTTPSRewriteService method instead.

func NewSettingAutomaticHTTPSRewriteService 

func NewSettingAutomaticHTTPSRewriteService(opts ...option.RequestOption) (r *SettingAutomaticHTTPSRewriteService)

NewSettingAutomaticHTTPSRewriteService 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 (*SettingAutomaticHTTPSRewriteService) Edit 

func (r *SettingAutomaticHTTPSRewriteService) Edit(ctx context.Context, params SettingAutomaticHTTPSRewriteEditParams, opts ...option.RequestOption) (res *ZonesAutomaticHTTPSRewrites, err error)

Enable the Automatic HTTPS Rewrites feature for this zone.

func (*SettingAutomaticHTTPSRewriteService) Get 

func (r *SettingAutomaticHTTPSRewriteService) Get(ctx context.Context, query SettingAutomaticHTTPSRewriteGetParams, opts ...option.RequestOption) (res *ZonesAutomaticHTTPSRewrites, err error)

Enable the Automatic HTTPS Rewrites feature for this zone.

type SettingAutomaticPlatformOptimizationEditParams 

type SettingAutomaticPlatformOptimizationEditParams struct {
	// Identifier
	ZoneID param.Field[string]                                  `path:"zone_id,required"`
	Value  param.Field[ZonesAutomaticPlatformOptimizationParam] `json:"value,required"`
}

func (SettingAutomaticPlatformOptimizationEditParams) MarshalJSON 

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

type SettingAutomaticPlatformOptimizationEditResponseEnvelope 

type SettingAutomaticPlatformOptimizationEditResponseEnvelope struct {
	Errors   []SettingAutomaticPlatformOptimizationEditResponseEnvelopeErrors   `json:"errors,required"`
	Messages []SettingAutomaticPlatformOptimizationEditResponseEnvelopeMessages `json:"messages,required"`
	// Whether the API call was successful
	Success bool                                                         `json:"success,required"`
	Result  ZonesAutomaticPlatformOptimization                           `json:"result"`
	JSON    settingAutomaticPlatformOptimizationEditResponseEnvelopeJSON `json:"-"`
}

func (*SettingAutomaticPlatformOptimizationEditResponseEnvelope) UnmarshalJSON 

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

type SettingAutomaticPlatformOptimizationEditResponseEnvelopeErrors 

type SettingAutomaticPlatformOptimizationEditResponseEnvelopeErrors struct {
	Code    int64                                                              `json:"code,required"`
	Message string                                                             `json:"message,required"`
	JSON    settingAutomaticPlatformOptimizationEditResponseEnvelopeErrorsJSON `json:"-"`
}

func (*SettingAutomaticPlatformOptimizationEditResponseEnvelopeErrors) UnmarshalJSON 

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

type SettingAutomaticPlatformOptimizationEditResponseEnvelopeMessages 

type SettingAutomaticPlatformOptimizationEditResponseEnvelopeMessages struct {
	Code    int64                                                                `json:"code,required"`
	Message string                                                               `json:"message,required"`
	JSON    settingAutomaticPlatformOptimizationEditResponseEnvelopeMessagesJSON `json:"-"`
}

func (*SettingAutomaticPlatformOptimizationEditResponseEnvelopeMessages) UnmarshalJSON 

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

type SettingAutomaticPlatformOptimizationGetParams 

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

type SettingAutomaticPlatformOptimizationGetResponseEnvelope 

type SettingAutomaticPlatformOptimizationGetResponseEnvelope struct {
	Errors   []SettingAutomaticPlatformOptimizationGetResponseEnvelopeErrors   `json:"errors,required"`
	Messages []SettingAutomaticPlatformOptimizationGetResponseEnvelopeMessages `json:"messages,required"`
	// Whether the API call was successful
	Success bool                                                        `json:"success,required"`
	Result  ZonesAutomaticPlatformOptimization                          `json:"result"`
	JSON    settingAutomaticPlatformOptimizationGetResponseEnvelopeJSON `json:"-"`
}

func (*SettingAutomaticPlatformOptimizationGetResponseEnvelope) UnmarshalJSON 

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

type SettingAutomaticPlatformOptimizationGetResponseEnvelopeErrors 

type SettingAutomaticPlatformOptimizationGetResponseEnvelopeErrors struct {
	Code    int64                                                             `json:"code,required"`
	Message string                                                            `json:"message,required"`
	JSON    settingAutomaticPlatformOptimizationGetResponseEnvelopeErrorsJSON `json:"-"`
}

func (*SettingAutomaticPlatformOptimizationGetResponseEnvelopeErrors) UnmarshalJSON 

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

type SettingAutomaticPlatformOptimizationGetResponseEnvelopeMessages 

type SettingAutomaticPlatformOptimizationGetResponseEnvelopeMessages struct {
	Code    int64                                                               `json:"code,required"`
	Message string                                                              `json:"message,required"`
	JSON    settingAutomaticPlatformOptimizationGetResponseEnvelopeMessagesJSON `json:"-"`
}

func (*SettingAutomaticPlatformOptimizationGetResponseEnvelopeMessages) UnmarshalJSON 

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

type SettingAutomaticPlatformOptimizationService 

type SettingAutomaticPlatformOptimizationService struct {
	Options []option.RequestOption
}

SettingAutomaticPlatformOptimizationService 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 NewSettingAutomaticPlatformOptimizationService method instead.

func NewSettingAutomaticPlatformOptimizationService 

func NewSettingAutomaticPlatformOptimizationService(opts ...option.RequestOption) (r *SettingAutomaticPlatformOptimizationService)

NewSettingAutomaticPlatformOptimizationService 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 (*SettingAutomaticPlatformOptimizationService) Edit 

func (r *SettingAutomaticPlatformOptimizationService) Edit(ctx context.Context, params SettingAutomaticPlatformOptimizationEditParams, opts ...option.RequestOption) (res *ZonesAutomaticPlatformOptimization, err error)

[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 (*SettingAutomaticPlatformOptimizationService) Get 

func (r *SettingAutomaticPlatformOptimizationService) Get(ctx context.Context, query SettingAutomaticPlatformOptimizationGetParams, opts ...option.RequestOption) (res *ZonesAutomaticPlatformOptimization, err error)

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

type SettingBrotliEditParams 

type SettingBrotliEditParams struct {
	// Identifier
	ZoneID param.Field[string] `path:"zone_id,required"`
	// Value of the zone setting.
	Value param.Field[SettingBrotliEditParamsValue] `json:"value,required"`
}

func (SettingBrotliEditParams) MarshalJSON 

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

type SettingBrotliEditParamsValue 

type SettingBrotliEditParamsValue string

Value of the zone setting. 

const (
	SettingBrotliEditParamsValueOff SettingBrotliEditParamsValue = "off"
	SettingBrotliEditParamsValueOn  SettingBrotliEditParamsValue = "on"
)

type SettingBrotliEditResponseEnvelope 

type SettingBrotliEditResponseEnvelope struct {
	Errors   []SettingBrotliEditResponseEnvelopeErrors   `json:"errors,required"`
	Messages []SettingBrotliEditResponseEnvelopeMessages `json:"messages,required"`
	// Whether the API call was successful
	Success bool `json:"success,required"`
	// When the client requesting an asset supports the Brotli compression algorithm,
	// Cloudflare will serve a Brotli compressed version of the asset.
	Result ZonesBrotli                           `json:"result"`
	JSON   settingBrotliEditResponseEnvelopeJSON `json:"-"`
}

func (*SettingBrotliEditResponseEnvelope) UnmarshalJSON 

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

type SettingBrotliEditResponseEnvelopeErrors 

type SettingBrotliEditResponseEnvelopeErrors struct {
	Code    int64                                       `json:"code,required"`
	Message string                                      `json:"message,required"`
	JSON    settingBrotliEditResponseEnvelopeErrorsJSON `json:"-"`
}

func (*SettingBrotliEditResponseEnvelopeErrors) UnmarshalJSON 

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

type SettingBrotliEditResponseEnvelopeMessages 

type SettingBrotliEditResponseEnvelopeMessages struct {
	Code    int64                                         `json:"code,required"`
	Message string                                        `json:"message,required"`
	JSON    settingBrotliEditResponseEnvelopeMessagesJSON `json:"-"`
}

func (*SettingBrotliEditResponseEnvelopeMessages) UnmarshalJSON 

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

type SettingBrotliGetParams 

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

type SettingBrotliGetResponseEnvelope 

type SettingBrotliGetResponseEnvelope struct {
	Errors   []SettingBrotliGetResponseEnvelopeErrors   `json:"errors,required"`
	Messages []SettingBrotliGetResponseEnvelopeMessages `json:"messages,required"`
	// Whether the API call was successful
	Success bool `json:"success,required"`
	// When the client requesting an asset supports the Brotli compression algorithm,
	// Cloudflare will serve a Brotli compressed version of the asset.
	Result ZonesBrotli                          `json:"result"`
	JSON   settingBrotliGetResponseEnvelopeJSON `json:"-"`
}

func (*SettingBrotliGetResponseEnvelope) UnmarshalJSON 

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

type SettingBrotliGetResponseEnvelopeErrors 

type SettingBrotliGetResponseEnvelopeErrors struct {
	Code    int64                                      `json:"code,required"`
	Message string                                     `json:"message,required"`
	JSON    settingBrotliGetResponseEnvelopeErrorsJSON `json:"-"`
}

func (*SettingBrotliGetResponseEnvelopeErrors) UnmarshalJSON 

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

type SettingBrotliGetResponseEnvelopeMessages 

type SettingBrotliGetResponseEnvelopeMessages struct {
	Code    int64                                        `json:"code,required"`
	Message string                                       `json:"message,required"`
	JSON    settingBrotliGetResponseEnvelopeMessagesJSON `json:"-"`
}

func (*SettingBrotliGetResponseEnvelopeMessages) UnmarshalJSON 

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

type SettingBrotliService 

type SettingBrotliService struct {
	Options []option.RequestOption
}

SettingBrotliService 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 NewSettingBrotliService method instead.

func NewSettingBrotliService 

func NewSettingBrotliService(opts ...option.RequestOption) (r *SettingBrotliService)

NewSettingBrotliService 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 (*SettingBrotliService) Edit 

func (r *SettingBrotliService) Edit(ctx context.Context, params SettingBrotliEditParams, opts ...option.RequestOption) (res *ZonesBrotli, err error)

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

func (*SettingBrotliService) Get 

func (r *SettingBrotliService) Get(ctx context.Context, query SettingBrotliGetParams, opts ...option.RequestOption) (res *ZonesBrotli, err error)

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

type SettingBrowserCacheTTLEditParams 

type SettingBrowserCacheTTLEditParams struct {
	// Identifier
	ZoneID param.Field[string] `path:"zone_id,required"`
	// Value of the zone setting. Notes: Setting a TTL of 0 is equivalent to selecting
	// `Respect Existing Headers`
	Value param.Field[SettingBrowserCacheTTLEditParamsValue] `json:"value,required"`
}

func (SettingBrowserCacheTTLEditParams) MarshalJSON 

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

type SettingBrowserCacheTTLEditParamsValue 

type SettingBrowserCacheTTLEditParamsValue float64

Value of the zone setting. Notes: Setting a TTL of 0 is equivalent to selecting `Respect Existing Headers` 

const (
	SettingBrowserCacheTTLEditParamsValue0        SettingBrowserCacheTTLEditParamsValue = 0
	SettingBrowserCacheTTLEditParamsValue30       SettingBrowserCacheTTLEditParamsValue = 30
	SettingBrowserCacheTTLEditParamsValue60       SettingBrowserCacheTTLEditParamsValue = 60
	SettingBrowserCacheTTLEditParamsValue120      SettingBrowserCacheTTLEditParamsValue = 120
	SettingBrowserCacheTTLEditParamsValue300      SettingBrowserCacheTTLEditParamsValue = 300
	SettingBrowserCacheTTLEditParamsValue1200     SettingBrowserCacheTTLEditParamsValue = 1200
	SettingBrowserCacheTTLEditParamsValue1800     SettingBrowserCacheTTLEditParamsValue = 1800
	SettingBrowserCacheTTLEditParamsValue3600     SettingBrowserCacheTTLEditParamsValue = 3600
	SettingBrowserCacheTTLEditParamsValue7200     SettingBrowserCacheTTLEditParamsValue = 7200
	SettingBrowserCacheTTLEditParamsValue10800    SettingBrowserCacheTTLEditParamsValue = 10800
	SettingBrowserCacheTTLEditParamsValue14400    SettingBrowserCacheTTLEditParamsValue = 14400
	SettingBrowserCacheTTLEditParamsValue18000    SettingBrowserCacheTTLEditParamsValue = 18000
	SettingBrowserCacheTTLEditParamsValue28800    SettingBrowserCacheTTLEditParamsValue = 28800
	SettingBrowserCacheTTLEditParamsValue43200    SettingBrowserCacheTTLEditParamsValue = 43200
	SettingBrowserCacheTTLEditParamsValue57600    SettingBrowserCacheTTLEditParamsValue = 57600
	SettingBrowserCacheTTLEditParamsValue72000    SettingBrowserCacheTTLEditParamsValue = 72000
	SettingBrowserCacheTTLEditParamsValue86400    SettingBrowserCacheTTLEditParamsValue = 86400
	SettingBrowserCacheTTLEditParamsValue172800   SettingBrowserCacheTTLEditParamsValue = 172800
	SettingBrowserCacheTTLEditParamsValue259200   SettingBrowserCacheTTLEditParamsValue = 259200
	SettingBrowserCacheTTLEditParamsValue345600   SettingBrowserCacheTTLEditParamsValue = 345600
	SettingBrowserCacheTTLEditParamsValue432000   SettingBrowserCacheTTLEditParamsValue = 432000
	SettingBrowserCacheTTLEditParamsValue691200   SettingBrowserCacheTTLEditParamsValue = 691200
	SettingBrowserCacheTTLEditParamsValue1382400  SettingBrowserCacheTTLEditParamsValue = 1382400
	SettingBrowserCacheTTLEditParamsValue2073600  SettingBrowserCacheTTLEditParamsValue = 2073600
	SettingBrowserCacheTTLEditParamsValue2678400  SettingBrowserCacheTTLEditParamsValue = 2678400
	SettingBrowserCacheTTLEditParamsValue5356800  SettingBrowserCacheTTLEditParamsValue = 5356800
	SettingBrowserCacheTTLEditParamsValue16070400 SettingBrowserCacheTTLEditParamsValue = 16070400
	SettingBrowserCacheTTLEditParamsValue31536000 SettingBrowserCacheTTLEditParamsValue = 31536000
)

type SettingBrowserCacheTTLEditResponseEnvelope 

type SettingBrowserCacheTTLEditResponseEnvelope struct {
	Errors   []SettingBrowserCacheTTLEditResponseEnvelopeErrors   `json:"errors,required"`
	Messages []SettingBrowserCacheTTLEditResponseEnvelopeMessages `json:"messages,required"`
	// Whether the API call was successful
	Success bool `json:"success,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).
	Result ZonesBrowserCacheTTL                           `json:"result"`
	JSON   settingBrowserCacheTTLEditResponseEnvelopeJSON `json:"-"`
}

func (*SettingBrowserCacheTTLEditResponseEnvelope) UnmarshalJSON 

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

type SettingBrowserCacheTTLEditResponseEnvelopeErrors 

type SettingBrowserCacheTTLEditResponseEnvelopeErrors struct {
	Code    int64                                                `json:"code,required"`
	Message string                                               `json:"message,required"`
	JSON    settingBrowserCacheTTLEditResponseEnvelopeErrorsJSON `json:"-"`
}

func (*SettingBrowserCacheTTLEditResponseEnvelopeErrors) UnmarshalJSON 

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

type SettingBrowserCacheTTLEditResponseEnvelopeMessages 

type SettingBrowserCacheTTLEditResponseEnvelopeMessages struct {
	Code    int64                                                  `json:"code,required"`
	Message string                                                 `json:"message,required"`
	JSON    settingBrowserCacheTTLEditResponseEnvelopeMessagesJSON `json:"-"`
}

func (*SettingBrowserCacheTTLEditResponseEnvelopeMessages) UnmarshalJSON 

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

type SettingBrowserCacheTTLGetParams 

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

type SettingBrowserCacheTTLGetResponseEnvelope 

type SettingBrowserCacheTTLGetResponseEnvelope struct {
	Errors   []SettingBrowserCacheTTLGetResponseEnvelopeErrors   `json:"errors,required"`
	Messages []SettingBrowserCacheTTLGetResponseEnvelopeMessages `json:"messages,required"`
	// Whether the API call was successful
	Success bool `json:"success,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).
	Result ZonesBrowserCacheTTL                          `json:"result"`
	JSON   settingBrowserCacheTTLGetResponseEnvelopeJSON `json:"-"`
}

func (*SettingBrowserCacheTTLGetResponseEnvelope) UnmarshalJSON 

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

type SettingBrowserCacheTTLGetResponseEnvelopeErrors 

type SettingBrowserCacheTTLGetResponseEnvelopeErrors struct {
	Code    int64                                               `json:"code,required"`
	Message string                                              `json:"message,required"`
	JSON    settingBrowserCacheTTLGetResponseEnvelopeErrorsJSON `json:"-"`
}

func (*SettingBrowserCacheTTLGetResponseEnvelopeErrors) UnmarshalJSON 

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

type SettingBrowserCacheTTLGetResponseEnvelopeMessages 

type SettingBrowserCacheTTLGetResponseEnvelopeMessages struct {
	Code    int64                                                 `json:"code,required"`
	Message string                                                `json:"message,required"`
	JSON    settingBrowserCacheTTLGetResponseEnvelopeMessagesJSON `json:"-"`
}

func (*SettingBrowserCacheTTLGetResponseEnvelopeMessages) UnmarshalJSON 

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

type SettingBrowserCacheTTLService 

type SettingBrowserCacheTTLService struct {
	Options []option.RequestOption
}

SettingBrowserCacheTTLService 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 NewSettingBrowserCacheTTLService method instead.

func NewSettingBrowserCacheTTLService 

func NewSettingBrowserCacheTTLService(opts ...option.RequestOption) (r *SettingBrowserCacheTTLService)

NewSettingBrowserCacheTTLService 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 (*SettingBrowserCacheTTLService) Edit 

func (r *SettingBrowserCacheTTLService) Edit(ctx context.Context, params SettingBrowserCacheTTLEditParams, opts ...option.RequestOption) (res *ZonesBrowserCacheTTL, err error)

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

func (r *SettingBrowserCacheTTLService) Get(ctx context.Context, query SettingBrowserCacheTTLGetParams, opts ...option.RequestOption) (res *ZonesBrowserCacheTTL, err error)

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

type SettingBrowserCheckEditParams 

type SettingBrowserCheckEditParams struct {
	// Identifier
	ZoneID param.Field[string] `path:"zone_id,required"`
	// Value of the zone setting.
	Value param.Field[SettingBrowserCheckEditParamsValue] `json:"value,required"`
}

func (SettingBrowserCheckEditParams) MarshalJSON 

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

type SettingBrowserCheckEditParamsValue 

type SettingBrowserCheckEditParamsValue string

Value of the zone setting. 

const (
	SettingBrowserCheckEditParamsValueOn  SettingBrowserCheckEditParamsValue = "on"
	SettingBrowserCheckEditParamsValueOff SettingBrowserCheckEditParamsValue = "off"
)

type SettingBrowserCheckEditResponseEnvelope 

type SettingBrowserCheckEditResponseEnvelope struct {
	Errors   []SettingBrowserCheckEditResponseEnvelopeErrors   `json:"errors,required"`
	Messages []SettingBrowserCheckEditResponseEnvelopeMessages `json:"messages,required"`
	// Whether the API call was successful
	Success bool `json:"success,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).
	Result ZonesBrowserCheck                           `json:"result"`
	JSON   settingBrowserCheckEditResponseEnvelopeJSON `json:"-"`
}

func (*SettingBrowserCheckEditResponseEnvelope) UnmarshalJSON 

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

type SettingBrowserCheckEditResponseEnvelopeErrors 

type SettingBrowserCheckEditResponseEnvelopeErrors struct {
	Code    int64                                             `json:"code,required"`
	Message string                                            `json:"message,required"`
	JSON    settingBrowserCheckEditResponseEnvelopeErrorsJSON `json:"-"`
}

func (*SettingBrowserCheckEditResponseEnvelopeErrors) UnmarshalJSON 

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

type SettingBrowserCheckEditResponseEnvelopeMessages 

type SettingBrowserCheckEditResponseEnvelopeMessages struct {
	Code    int64                                               `json:"code,required"`
	Message string                                              `json:"message,required"`
	JSON    settingBrowserCheckEditResponseEnvelopeMessagesJSON `json:"-"`
}

func (*SettingBrowserCheckEditResponseEnvelopeMessages) UnmarshalJSON 

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

type SettingBrowserCheckGetParams 

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

type SettingBrowserCheckGetResponseEnvelope 

type SettingBrowserCheckGetResponseEnvelope struct {
	Errors   []SettingBrowserCheckGetResponseEnvelopeErrors   `json:"errors,required"`
	Messages []SettingBrowserCheckGetResponseEnvelopeMessages `json:"messages,required"`
	// Whether the API call was successful
	Success bool `json:"success,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).
	Result ZonesBrowserCheck                          `json:"result"`
	JSON   settingBrowserCheckGetResponseEnvelopeJSON `json:"-"`
}

func (*SettingBrowserCheckGetResponseEnvelope) UnmarshalJSON 

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

type SettingBrowserCheckGetResponseEnvelopeErrors 

type SettingBrowserCheckGetResponseEnvelopeErrors struct {
	Code    int64                                            `json:"code,required"`
	Message string                                           `json:"message,required"`
	JSON    settingBrowserCheckGetResponseEnvelopeErrorsJSON `json:"-"`
}

func (*SettingBrowserCheckGetResponseEnvelopeErrors) UnmarshalJSON 

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

type SettingBrowserCheckGetResponseEnvelopeMessages 

type SettingBrowserCheckGetResponseEnvelopeMessages struct {
	Code    int64                                              `json:"code,required"`
	Message string                                             `json:"message,required"`
	JSON    settingBrowserCheckGetResponseEnvelopeMessagesJSON `json:"-"`
}

func (*SettingBrowserCheckGetResponseEnvelopeMessages) UnmarshalJSON 

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

type SettingBrowserCheckService 

type SettingBrowserCheckService struct {
	Options []option.RequestOption
}

SettingBrowserCheckService 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 NewSettingBrowserCheckService method instead.

func NewSettingBrowserCheckService 

func NewSettingBrowserCheckService(opts ...option.RequestOption) (r *SettingBrowserCheckService)

NewSettingBrowserCheckService 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 (*SettingBrowserCheckService) Edit 

func (r *SettingBrowserCheckService) Edit(ctx context.Context, params SettingBrowserCheckEditParams, opts ...option.RequestOption) (res *ZonesBrowserCheck, err error)

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

func (r *SettingBrowserCheckService) Get(ctx context.Context, query SettingBrowserCheckGetParams, opts ...option.RequestOption) (res *ZonesBrowserCheck, err error)

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

type SettingCacheLevelEditParams 

type SettingCacheLevelEditParams struct {
	// Identifier
	ZoneID param.Field[string] `path:"zone_id,required"`
	// Value of the zone setting.
	Value param.Field[SettingCacheLevelEditParamsValue] `json:"value,required"`
}

func (SettingCacheLevelEditParams) MarshalJSON 

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

type SettingCacheLevelEditParamsValue 

type SettingCacheLevelEditParamsValue string

Value of the zone setting. 

const (
	SettingCacheLevelEditParamsValueAggressive SettingCacheLevelEditParamsValue = "aggressive"
	SettingCacheLevelEditParamsValueBasic      SettingCacheLevelEditParamsValue = "basic"
	SettingCacheLevelEditParamsValueSimplified SettingCacheLevelEditParamsValue = "simplified"
)

type SettingCacheLevelEditResponseEnvelope 

type SettingCacheLevelEditResponseEnvelope struct {
	Errors   []SettingCacheLevelEditResponseEnvelopeErrors   `json:"errors,required"`
	Messages []SettingCacheLevelEditResponseEnvelopeMessages `json:"messages,required"`
	// Whether the API call was successful
	Success bool `json:"success,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).
	Result ZonesCacheLevel                           `json:"result"`
	JSON   settingCacheLevelEditResponseEnvelopeJSON `json:"-"`
}

func (*SettingCacheLevelEditResponseEnvelope) UnmarshalJSON 

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

type SettingCacheLevelEditResponseEnvelopeErrors 

type SettingCacheLevelEditResponseEnvelopeErrors struct {
	Code    int64                                           `json:"code,required"`
	Message string                                          `json:"message,required"`
	JSON    settingCacheLevelEditResponseEnvelopeErrorsJSON `json:"-"`
}

func (*SettingCacheLevelEditResponseEnvelopeErrors) UnmarshalJSON 

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

type SettingCacheLevelEditResponseEnvelopeMessages 

type SettingCacheLevelEditResponseEnvelopeMessages struct {
	Code    int64                                             `json:"code,required"`
	Message string                                            `json:"message,required"`
	JSON    settingCacheLevelEditResponseEnvelopeMessagesJSON `json:"-"`
}

func (*SettingCacheLevelEditResponseEnvelopeMessages) UnmarshalJSON 

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

type SettingCacheLevelGetParams 

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

type SettingCacheLevelGetResponseEnvelope 

type SettingCacheLevelGetResponseEnvelope struct {
	Errors   []SettingCacheLevelGetResponseEnvelopeErrors   `json:"errors,required"`
	Messages []SettingCacheLevelGetResponseEnvelopeMessages `json:"messages,required"`
	// Whether the API call was successful
	Success bool `json:"success,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).
	Result ZonesCacheLevel                          `json:"result"`
	JSON   settingCacheLevelGetResponseEnvelopeJSON `json:"-"`
}

func (*SettingCacheLevelGetResponseEnvelope) UnmarshalJSON 

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

type SettingCacheLevelGetResponseEnvelopeErrors 

type SettingCacheLevelGetResponseEnvelopeErrors struct {
	Code    int64                                          `json:"code,required"`
	Message string                                         `json:"message,required"`
	JSON    settingCacheLevelGetResponseEnvelopeErrorsJSON `json:"-"`
}

func (*SettingCacheLevelGetResponseEnvelopeErrors) UnmarshalJSON 

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

type SettingCacheLevelGetResponseEnvelopeMessages 

type SettingCacheLevelGetResponseEnvelopeMessages struct {
	Code    int64                                            `json:"code,required"`
	Message string                                           `json:"message,required"`
	JSON    settingCacheLevelGetResponseEnvelopeMessagesJSON `json:"-"`
}

func (*SettingCacheLevelGetResponseEnvelopeMessages) UnmarshalJSON 

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

type SettingCacheLevelService 

type SettingCacheLevelService struct {
	Options []option.RequestOption
}

SettingCacheLevelService 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 NewSettingCacheLevelService method instead.

func NewSettingCacheLevelService 

func NewSettingCacheLevelService(opts ...option.RequestOption) (r *SettingCacheLevelService)

NewSettingCacheLevelService 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 (*SettingCacheLevelService) Edit 

func (r *SettingCacheLevelService) Edit(ctx context.Context, params SettingCacheLevelEditParams, opts ...option.RequestOption) (res *ZonesCacheLevel, err error)

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

func (r *SettingCacheLevelService) Get(ctx context.Context, query SettingCacheLevelGetParams, opts ...option.RequestOption) (res *ZonesCacheLevel, err error)

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

type SettingChallengeTTLEditParams 

type SettingChallengeTTLEditParams struct {
	// Identifier
	ZoneID param.Field[string] `path:"zone_id,required"`
	// Value of the zone setting.
	Value param.Field[SettingChallengeTTLEditParamsValue] `json:"value,required"`
}

func (SettingChallengeTTLEditParams) MarshalJSON 

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

type SettingChallengeTTLEditParamsValue 

type SettingChallengeTTLEditParamsValue float64

Value of the zone setting. 

const (
	SettingChallengeTTLEditParamsValue300      SettingChallengeTTLEditParamsValue = 300
	SettingChallengeTTLEditParamsValue900      SettingChallengeTTLEditParamsValue = 900
	SettingChallengeTTLEditParamsValue1800     SettingChallengeTTLEditParamsValue = 1800
	SettingChallengeTTLEditParamsValue2700     SettingChallengeTTLEditParamsValue = 2700
	SettingChallengeTTLEditParamsValue3600     SettingChallengeTTLEditParamsValue = 3600
	SettingChallengeTTLEditParamsValue7200     SettingChallengeTTLEditParamsValue = 7200
	SettingChallengeTTLEditParamsValue10800    SettingChallengeTTLEditParamsValue = 10800
	SettingChallengeTTLEditParamsValue14400    SettingChallengeTTLEditParamsValue = 14400
	SettingChallengeTTLEditParamsValue28800    SettingChallengeTTLEditParamsValue = 28800
	SettingChallengeTTLEditParamsValue57600    SettingChallengeTTLEditParamsValue = 57600
	SettingChallengeTTLEditParamsValue86400    SettingChallengeTTLEditParamsValue = 86400
	SettingChallengeTTLEditParamsValue604800   SettingChallengeTTLEditParamsValue = 604800
	SettingChallengeTTLEditParamsValue2592000  SettingChallengeTTLEditParamsValue = 2592000
	SettingChallengeTTLEditParamsValue31536000 SettingChallengeTTLEditParamsValue = 31536000
)

type SettingChallengeTTLEditResponseEnvelope 

type SettingChallengeTTLEditResponseEnvelope struct {
	Errors   []SettingChallengeTTLEditResponseEnvelopeErrors   `json:"errors,required"`
	Messages []SettingChallengeTTLEditResponseEnvelopeMessages `json:"messages,required"`
	// Whether the API call was successful
	Success bool `json:"success,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).
	Result ZonesChallengeTTL                           `json:"result"`
	JSON   settingChallengeTTLEditResponseEnvelopeJSON `json:"-"`
}

func (*SettingChallengeTTLEditResponseEnvelope) UnmarshalJSON 

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

type SettingChallengeTTLEditResponseEnvelopeErrors 

type SettingChallengeTTLEditResponseEnvelopeErrors struct {
	Code    int64                                             `json:"code,required"`
	Message string                                            `json:"message,required"`
	JSON    settingChallengeTTLEditResponseEnvelopeErrorsJSON `json:"-"`
}

func (*SettingChallengeTTLEditResponseEnvelopeErrors) UnmarshalJSON 

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

type SettingChallengeTTLEditResponseEnvelopeMessages 

type SettingChallengeTTLEditResponseEnvelopeMessages struct {
	Code    int64                                               `json:"code,required"`
	Message string                                              `json:"message,required"`
	JSON    settingChallengeTTLEditResponseEnvelopeMessagesJSON `json:"-"`
}

func (*SettingChallengeTTLEditResponseEnvelopeMessages) UnmarshalJSON 

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

type SettingChallengeTTLGetParams 

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

type SettingChallengeTTLGetResponseEnvelope 

type SettingChallengeTTLGetResponseEnvelope struct {
	Errors   []SettingChallengeTTLGetResponseEnvelopeErrors   `json:"errors,required"`
	Messages []SettingChallengeTTLGetResponseEnvelopeMessages `json:"messages,required"`
	// Whether the API call was successful
	Success bool `json:"success,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).
	Result ZonesChallengeTTL                          `json:"result"`
	JSON   settingChallengeTTLGetResponseEnvelopeJSON `json:"-"`
}

func (*SettingChallengeTTLGetResponseEnvelope) UnmarshalJSON 

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

type SettingChallengeTTLGetResponseEnvelopeErrors 

type SettingChallengeTTLGetResponseEnvelopeErrors struct {
	Code    int64                                            `json:"code,required"`
	Message string                                           `json:"message,required"`
	JSON    settingChallengeTTLGetResponseEnvelopeErrorsJSON `json:"-"`
}

func (*SettingChallengeTTLGetResponseEnvelopeErrors) UnmarshalJSON 

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

type SettingChallengeTTLGetResponseEnvelopeMessages 

type SettingChallengeTTLGetResponseEnvelopeMessages struct {
	Code    int64                                              `json:"code,required"`
	Message string                                             `json:"message,required"`
	JSON    settingChallengeTTLGetResponseEnvelopeMessagesJSON `json:"-"`
}

func (*SettingChallengeTTLGetResponseEnvelopeMessages) UnmarshalJSON 

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

type SettingChallengeTTLService 

type SettingChallengeTTLService struct {
	Options []option.RequestOption
}

SettingChallengeTTLService 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 NewSettingChallengeTTLService method instead.

func NewSettingChallengeTTLService 

func NewSettingChallengeTTLService(opts ...option.RequestOption) (r *SettingChallengeTTLService)

NewSettingChallengeTTLService 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 (*SettingChallengeTTLService) Edit 

func (r *SettingChallengeTTLService) Edit(ctx context.Context, params SettingChallengeTTLEditParams, opts ...option.RequestOption) (res *ZonesChallengeTTL, err error)

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

func (r *SettingChallengeTTLService) Get(ctx context.Context, query SettingChallengeTTLGetParams, opts ...option.RequestOption) (res *ZonesChallengeTTL, err error)

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

type SettingCipherEditParams 

type SettingCipherEditParams struct {
	// Identifier
	ZoneID param.Field[string] `path:"zone_id,required"`
	// Value of the zone setting.
	Value param.Field[[]string] `json:"value,required"`
}

func (SettingCipherEditParams) MarshalJSON 

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

type SettingCipherEditResponseEnvelope 

type SettingCipherEditResponseEnvelope struct {
	Errors   []SettingCipherEditResponseEnvelopeErrors   `json:"errors,required"`
	Messages []SettingCipherEditResponseEnvelopeMessages `json:"messages,required"`
	// Whether the API call was successful
	Success bool `json:"success,required"`
	// An allowlist of ciphers for TLS termination. These ciphers must be in the
	// BoringSSL format.
	Result ZonesCiphers                          `json:"result"`
	JSON   settingCipherEditResponseEnvelopeJSON `json:"-"`
}

func (*SettingCipherEditResponseEnvelope) UnmarshalJSON 

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

type SettingCipherEditResponseEnvelopeErrors 

type SettingCipherEditResponseEnvelopeErrors struct {
	Code    int64                                       `json:"code,required"`
	Message string                                      `json:"message,required"`
	JSON    settingCipherEditResponseEnvelopeErrorsJSON `json:"-"`
}

func (*SettingCipherEditResponseEnvelopeErrors) UnmarshalJSON 

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

type SettingCipherEditResponseEnvelopeMessages 

type SettingCipherEditResponseEnvelopeMessages struct {
	Code    int64                                         `json:"code,required"`
	Message string                                        `json:"message,required"`
	JSON    settingCipherEditResponseEnvelopeMessagesJSON `json:"-"`
}

func (*SettingCipherEditResponseEnvelopeMessages) UnmarshalJSON 

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

type SettingCipherGetParams 

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

type SettingCipherGetResponseEnvelope 

type SettingCipherGetResponseEnvelope struct {
	Errors   []SettingCipherGetResponseEnvelopeErrors   `json:"errors,required"`
	Messages []SettingCipherGetResponseEnvelopeMessages `json:"messages,required"`
	// Whether the API call was successful
	Success bool `json:"success,required"`
	// An allowlist of ciphers for TLS termination. These ciphers must be in the
	// BoringSSL format.
	Result ZonesCiphers                         `json:"result"`
	JSON   settingCipherGetResponseEnvelopeJSON `json:"-"`
}

func (*SettingCipherGetResponseEnvelope) UnmarshalJSON 

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

type SettingCipherGetResponseEnvelopeErrors 

type SettingCipherGetResponseEnvelopeErrors struct {
	Code    int64                                      `json:"code,required"`
	Message string                                     `json:"message,required"`
	JSON    settingCipherGetResponseEnvelopeErrorsJSON `json:"-"`
}

func (*SettingCipherGetResponseEnvelopeErrors) UnmarshalJSON 

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

type SettingCipherGetResponseEnvelopeMessages 

type SettingCipherGetResponseEnvelopeMessages struct {
	Code    int64                                        `json:"code,required"`
	Message string                                       `json:"message,required"`
	JSON    settingCipherGetResponseEnvelopeMessagesJSON `json:"-"`
}

func (*SettingCipherGetResponseEnvelopeMessages) UnmarshalJSON 

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

type SettingCipherService 

type SettingCipherService struct {
	Options []option.RequestOption
}

SettingCipherService 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 NewSettingCipherService method instead.

func NewSettingCipherService 

func NewSettingCipherService(opts ...option.RequestOption) (r *SettingCipherService)

NewSettingCipherService 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 (*SettingCipherService) Edit 

func (r *SettingCipherService) Edit(ctx context.Context, params SettingCipherEditParams, opts ...option.RequestOption) (res *ZonesCiphers, err error)

Changes ciphers setting.

func (*SettingCipherService) Get 

func (r *SettingCipherService) Get(ctx context.Context, query SettingCipherGetParams, opts ...option.RequestOption) (res *ZonesCiphers, err error)

Gets ciphers setting.

type SettingDevelopmentModeEditParams 

type SettingDevelopmentModeEditParams struct {
	// Identifier
	ZoneID param.Field[string] `path:"zone_id,required"`
	// Value of the zone setting.
	Value param.Field[SettingDevelopmentModeEditParamsValue] `json:"value,required"`
}

func (SettingDevelopmentModeEditParams) MarshalJSON 

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

type SettingDevelopmentModeEditParamsValue 

type SettingDevelopmentModeEditParamsValue string

Value of the zone setting. 

const (
	SettingDevelopmentModeEditParamsValueOn  SettingDevelopmentModeEditParamsValue = "on"
	SettingDevelopmentModeEditParamsValueOff SettingDevelopmentModeEditParamsValue = "off"
)

type SettingDevelopmentModeEditResponseEnvelope 

type SettingDevelopmentModeEditResponseEnvelope struct {
	Errors   []SettingDevelopmentModeEditResponseEnvelopeErrors   `json:"errors,required"`
	Messages []SettingDevelopmentModeEditResponseEnvelopeMessages `json:"messages,required"`
	// Whether the API call was successful
	Success bool `json:"success,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.
	Result ZonesDevelopmentMode                           `json:"result"`
	JSON   settingDevelopmentModeEditResponseEnvelopeJSON `json:"-"`
}

func (*SettingDevelopmentModeEditResponseEnvelope) UnmarshalJSON 

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

type SettingDevelopmentModeEditResponseEnvelopeErrors 

type SettingDevelopmentModeEditResponseEnvelopeErrors struct {
	Code    int64                                                `json:"code,required"`
	Message string                                               `json:"message,required"`
	JSON    settingDevelopmentModeEditResponseEnvelopeErrorsJSON `json:"-"`
}

func (*SettingDevelopmentModeEditResponseEnvelopeErrors) UnmarshalJSON 

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

type SettingDevelopmentModeEditResponseEnvelopeMessages 

type SettingDevelopmentModeEditResponseEnvelopeMessages struct {
	Code    int64                                                  `json:"code,required"`
	Message string                                                 `json:"message,required"`
	JSON    settingDevelopmentModeEditResponseEnvelopeMessagesJSON `json:"-"`
}

func (*SettingDevelopmentModeEditResponseEnvelopeMessages) UnmarshalJSON 

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

type SettingDevelopmentModeGetParams 

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

type SettingDevelopmentModeGetResponseEnvelope 

type SettingDevelopmentModeGetResponseEnvelope struct {
	Errors   []SettingDevelopmentModeGetResponseEnvelopeErrors   `json:"errors,required"`
	Messages []SettingDevelopmentModeGetResponseEnvelopeMessages `json:"messages,required"`
	// Whether the API call was successful
	Success bool `json:"success,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.
	Result ZonesDevelopmentMode                          `json:"result"`
	JSON   settingDevelopmentModeGetResponseEnvelopeJSON `json:"-"`
}

func (*SettingDevelopmentModeGetResponseEnvelope) UnmarshalJSON 

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

type SettingDevelopmentModeGetResponseEnvelopeErrors 

type SettingDevelopmentModeGetResponseEnvelopeErrors struct {
	Code    int64                                               `json:"code,required"`
	Message string                                              `json:"message,required"`
	JSON    settingDevelopmentModeGetResponseEnvelopeErrorsJSON `json:"-"`
}

func (*SettingDevelopmentModeGetResponseEnvelopeErrors) UnmarshalJSON 

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

type SettingDevelopmentModeGetResponseEnvelopeMessages 

type SettingDevelopmentModeGetResponseEnvelopeMessages struct {
	Code    int64                                                 `json:"code,required"`
	Message string                                                `json:"message,required"`
	JSON    settingDevelopmentModeGetResponseEnvelopeMessagesJSON `json:"-"`
}

func (*SettingDevelopmentModeGetResponseEnvelopeMessages) UnmarshalJSON 

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

type SettingDevelopmentModeService 

type SettingDevelopmentModeService struct {
	Options []option.RequestOption
}

SettingDevelopmentModeService 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 NewSettingDevelopmentModeService method instead.

func NewSettingDevelopmentModeService 

func NewSettingDevelopmentModeService(opts ...option.RequestOption) (r *SettingDevelopmentModeService)

NewSettingDevelopmentModeService 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 (*SettingDevelopmentModeService) Edit 

func (r *SettingDevelopmentModeService) Edit(ctx context.Context, params SettingDevelopmentModeEditParams, opts ...option.RequestOption) (res *ZonesDevelopmentMode, err error)

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

func (r *SettingDevelopmentModeService) Get(ctx context.Context, query SettingDevelopmentModeGetParams, opts ...option.RequestOption) (res *ZonesDevelopmentMode, err error)

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.

type SettingEarlyHintEditParams 

type SettingEarlyHintEditParams struct {
	// Identifier
	ZoneID param.Field[string] `path:"zone_id,required"`
	// Value of the zone setting.
	Value param.Field[SettingEarlyHintEditParamsValue] `json:"value,required"`
}

func (SettingEarlyHintEditParams) MarshalJSON 

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

type SettingEarlyHintEditParamsValue 

type SettingEarlyHintEditParamsValue string

Value of the zone setting. 

const (
	SettingEarlyHintEditParamsValueOn  SettingEarlyHintEditParamsValue = "on"
	SettingEarlyHintEditParamsValueOff SettingEarlyHintEditParamsValue = "off"
)

type SettingEarlyHintEditResponseEnvelope 

type SettingEarlyHintEditResponseEnvelope struct {
	Errors   []SettingEarlyHintEditResponseEnvelopeErrors   `json:"errors,required"`
	Messages []SettingEarlyHintEditResponseEnvelopeMessages `json:"messages,required"`
	// Whether the API call was successful
	Success bool `json:"success,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.
	Result ZonesEarlyHints                          `json:"result"`
	JSON   settingEarlyHintEditResponseEnvelopeJSON `json:"-"`
}

func (*SettingEarlyHintEditResponseEnvelope) UnmarshalJSON 

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

type SettingEarlyHintEditResponseEnvelopeErrors 

type SettingEarlyHintEditResponseEnvelopeErrors struct {
	Code    int64                                          `json:"code,required"`
	Message string                                         `json:"message,required"`
	JSON    settingEarlyHintEditResponseEnvelopeErrorsJSON `json:"-"`
}

func (*SettingEarlyHintEditResponseEnvelopeErrors) UnmarshalJSON 

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

type SettingEarlyHintEditResponseEnvelopeMessages 

type SettingEarlyHintEditResponseEnvelopeMessages struct {
	Code    int64                                            `json:"code,required"`
	Message string                                           `json:"message,required"`
	JSON    settingEarlyHintEditResponseEnvelopeMessagesJSON `json:"-"`
}

func (*SettingEarlyHintEditResponseEnvelopeMessages) UnmarshalJSON 

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

type SettingEarlyHintGetParams 

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

type SettingEarlyHintGetResponseEnvelope 

type SettingEarlyHintGetResponseEnvelope struct {
	Errors   []SettingEarlyHintGetResponseEnvelopeErrors   `json:"errors,required"`
	Messages []SettingEarlyHintGetResponseEnvelopeMessages `json:"messages,required"`
	// Whether the API call was successful
	Success bool `json:"success,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.
	Result ZonesEarlyHints                         `json:"result"`
	JSON   settingEarlyHintGetResponseEnvelopeJSON `json:"-"`
}

func (*SettingEarlyHintGetResponseEnvelope) UnmarshalJSON 

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

type SettingEarlyHintGetResponseEnvelopeErrors 

type SettingEarlyHintGetResponseEnvelopeErrors struct {
	Code    int64                                         `json:"code,required"`
	Message string                                        `json:"message,required"`
	JSON    settingEarlyHintGetResponseEnvelopeErrorsJSON `json:"-"`
}

func (*SettingEarlyHintGetResponseEnvelopeErrors) UnmarshalJSON 

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

type SettingEarlyHintGetResponseEnvelopeMessages 

type SettingEarlyHintGetResponseEnvelopeMessages struct {
	Code    int64                                           `json:"code,required"`
	Message string                                          `json:"message,required"`
	JSON    settingEarlyHintGetResponseEnvelopeMessagesJSON `json:"-"`
}

func (*SettingEarlyHintGetResponseEnvelopeMessages) UnmarshalJSON 

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

type SettingEarlyHintService 

type SettingEarlyHintService struct {
	Options []option.RequestOption
}

SettingEarlyHintService 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 NewSettingEarlyHintService method instead.

func NewSettingEarlyHintService 

func NewSettingEarlyHintService(opts ...option.RequestOption) (r *SettingEarlyHintService)

NewSettingEarlyHintService 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 (*SettingEarlyHintService) Edit 

func (r *SettingEarlyHintService) Edit(ctx context.Context, params SettingEarlyHintEditParams, opts ...option.RequestOption) (res *ZonesEarlyHints, err error)

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

func (r *SettingEarlyHintService) Get(ctx context.Context, query SettingEarlyHintGetParams, opts ...option.RequestOption) (res *ZonesEarlyHints, err error)

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.

type SettingEditParams added in v2.4.0 

type SettingEditParams struct {
	// Identifier
	ZoneID param.Field[string] `path:"zone_id,required"`
	// One or more zone setting objects. Must contain an ID and a value.
	Items param.Field[[]SettingEditParamsItem] `json:"items,required"`
}

func (SettingEditParams) MarshalJSON added in v2.4.0 

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

type SettingEditParamsItem 

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

0-RTT session resumption enabled for this zone.

Satisfied by zones.Zones0rttParam, zones.ZonesAdvancedDDOSParam, zones.ZonesAlwaysOnlineParam, zones.ZonesAlwaysUseHTTPSParam, zones.ZonesAutomaticHTTPSRewritesParam, zones.ZonesBrotliParam, zones.ZonesBrowserCacheTTLParam, zones.ZonesBrowserCheckParam, zones.ZonesCacheLevelParam, zones.ZonesChallengeTTLParam, zones.ZonesCiphersParam, zones.SettingEditParamsItemsZonesCNAMEFlattening, zones.ZonesDevelopmentModeParam, zones.ZonesEarlyHintsParam, zones.SettingEditParamsItemsZonesEdgeCacheTTL, zones.ZonesEmailObfuscationParam, zones.ZonesH2PrioritizationParam, zones.ZonesHotlinkProtectionParam, zones.ZonesHTTP2Param, zones.ZonesHTTP3Param, zones.ZonesImageResizingParam, zones.ZonesIPGeolocationParam, zones.ZonesIPV6Param, zones.SettingEditParamsItemsZonesMaxUpload, zones.ZonesMinTLSVersionParam, zones.ZonesMinifyParam, zones.ZonesMirageParam, zones.ZonesMobileRedirectParam, zones.ZonesNELParam, zones.ZonesOpportunisticEncryptionParam, zones.ZonesOpportunisticOnionParam, zones.ZonesOrangeToOrangeParam, zones.ZonesOriginErrorPagePassThruParam, zones.ZonesPolishParam, zones.ZonesPrefetchPreloadParam, zones.ZonesProxyReadTimeoutParam, zones.ZonesPseudoIPV4Param, zones.ZonesBufferingParam, zones.ZonesRocketLoaderParam, zones.SettingEditParamsItemsZonesSchemasAutomaticPlatformOptimization, zones.ZonesSecurityHeaderParam, zones.ZonesSecurityLevelParam, zones.ZonesServerSideExcludeParam, zones.SettingEditParamsItemsZonesSha1Support, zones.ZonesSortQueryStringForCacheParam, zones.ZonesSSLParam, zones.ZonesSSLRecommenderParam, zones.SettingEditParamsItemsZonesTLS1_2Only, zones.ZonesTLS1_3Param, zones.ZonesTLSClientAuthParam, zones.ZonesTrueClientIPHeaderParam, zones.ZonesWAFParam, zones.ZonesWebpParam, zones.ZonesWebsocketsParam.

type SettingEditParamsItemsZonesCNAMEFlattening 

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

Whether or not cname flattening is on.

func (SettingEditParamsItemsZonesCNAMEFlattening) MarshalJSON 

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

type SettingEditParamsItemsZonesCNAMEFlatteningEditable 

type SettingEditParamsItemsZonesCNAMEFlatteningEditable bool

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

const (
	SettingEditParamsItemsZonesCNAMEFlatteningEditableTrue  SettingEditParamsItemsZonesCNAMEFlatteningEditable = true
	SettingEditParamsItemsZonesCNAMEFlatteningEditableFalse SettingEditParamsItemsZonesCNAMEFlatteningEditable = false
)

type SettingEditParamsItemsZonesCNAMEFlatteningID 

type SettingEditParamsItemsZonesCNAMEFlatteningID string

How to flatten the cname destination. 

const (
	SettingEditParamsItemsZonesCNAMEFlatteningIDCNAMEFlattening SettingEditParamsItemsZonesCNAMEFlatteningID = "cname_flattening"
)

type SettingEditParamsItemsZonesCNAMEFlatteningValue 

type SettingEditParamsItemsZonesCNAMEFlatteningValue string

Current value of the zone setting. 

const (
	SettingEditParamsItemsZonesCNAMEFlatteningValueFlattenAtRoot SettingEditParamsItemsZonesCNAMEFlatteningValue = "flatten_at_root"
	SettingEditParamsItemsZonesCNAMEFlatteningValueFlattenAll    SettingEditParamsItemsZonesCNAMEFlatteningValue = "flatten_all"
)

type SettingEditParamsItemsZonesEdgeCacheTTL 

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

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

func (SettingEditParamsItemsZonesEdgeCacheTTL) MarshalJSON 

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

type SettingEditParamsItemsZonesEdgeCacheTTLEditable 

type SettingEditParamsItemsZonesEdgeCacheTTLEditable bool

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

const (
	SettingEditParamsItemsZonesEdgeCacheTTLEditableTrue  SettingEditParamsItemsZonesEdgeCacheTTLEditable = true
	SettingEditParamsItemsZonesEdgeCacheTTLEditableFalse SettingEditParamsItemsZonesEdgeCacheTTLEditable = false
)

type SettingEditParamsItemsZonesEdgeCacheTTLID 

type SettingEditParamsItemsZonesEdgeCacheTTLID string

ID of the zone setting. 

const (
	SettingEditParamsItemsZonesEdgeCacheTTLIDEdgeCacheTTL SettingEditParamsItemsZonesEdgeCacheTTLID = "edge_cache_ttl"
)

type SettingEditParamsItemsZonesEdgeCacheTTLValue 

type SettingEditParamsItemsZonesEdgeCacheTTLValue float64

Current value of the zone setting. 

const (
	SettingEditParamsItemsZonesEdgeCacheTTLValue30     SettingEditParamsItemsZonesEdgeCacheTTLValue = 30
	SettingEditParamsItemsZonesEdgeCacheTTLValue60     SettingEditParamsItemsZonesEdgeCacheTTLValue = 60
	SettingEditParamsItemsZonesEdgeCacheTTLValue300    SettingEditParamsItemsZonesEdgeCacheTTLValue = 300
	SettingEditParamsItemsZonesEdgeCacheTTLValue1200   SettingEditParamsItemsZonesEdgeCacheTTLValue = 1200
	SettingEditParamsItemsZonesEdgeCacheTTLValue1800   SettingEditParamsItemsZonesEdgeCacheTTLValue = 1800
	SettingEditParamsItemsZonesEdgeCacheTTLValue3600   SettingEditParamsItemsZonesEdgeCacheTTLValue = 3600
	SettingEditParamsItemsZonesEdgeCacheTTLValue7200   SettingEditParamsItemsZonesEdgeCacheTTLValue = 7200
	SettingEditParamsItemsZonesEdgeCacheTTLValue10800  SettingEditParamsItemsZonesEdgeCacheTTLValue = 10800
	SettingEditParamsItemsZonesEdgeCacheTTLValue14400  SettingEditParamsItemsZonesEdgeCacheTTLValue = 14400
	SettingEditParamsItemsZonesEdgeCacheTTLValue18000  SettingEditParamsItemsZonesEdgeCacheTTLValue = 18000
	SettingEditParamsItemsZonesEdgeCacheTTLValue28800  SettingEditParamsItemsZonesEdgeCacheTTLValue = 28800
	SettingEditParamsItemsZonesEdgeCacheTTLValue43200  SettingEditParamsItemsZonesEdgeCacheTTLValue = 43200
	SettingEditParamsItemsZonesEdgeCacheTTLValue57600  SettingEditParamsItemsZonesEdgeCacheTTLValue = 57600
	SettingEditParamsItemsZonesEdgeCacheTTLValue72000  SettingEditParamsItemsZonesEdgeCacheTTLValue = 72000
	SettingEditParamsItemsZonesEdgeCacheTTLValue86400  SettingEditParamsItemsZonesEdgeCacheTTLValue = 86400
	SettingEditParamsItemsZonesEdgeCacheTTLValue172800 SettingEditParamsItemsZonesEdgeCacheTTLValue = 172800
	SettingEditParamsItemsZonesEdgeCacheTTLValue259200 SettingEditParamsItemsZonesEdgeCacheTTLValue = 259200
	SettingEditParamsItemsZonesEdgeCacheTTLValue345600 SettingEditParamsItemsZonesEdgeCacheTTLValue = 345600
	SettingEditParamsItemsZonesEdgeCacheTTLValue432000 SettingEditParamsItemsZonesEdgeCacheTTLValue = 432000
	SettingEditParamsItemsZonesEdgeCacheTTLValue518400 SettingEditParamsItemsZonesEdgeCacheTTLValue = 518400
	SettingEditParamsItemsZonesEdgeCacheTTLValue604800 SettingEditParamsItemsZonesEdgeCacheTTLValue = 604800
)

type SettingEditParamsItemsZonesMaxUpload 

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

Maximum size of an allowable upload.

func (SettingEditParamsItemsZonesMaxUpload) MarshalJSON 

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

type SettingEditParamsItemsZonesMaxUploadEditable 

type SettingEditParamsItemsZonesMaxUploadEditable bool

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

const (
	SettingEditParamsItemsZonesMaxUploadEditableTrue  SettingEditParamsItemsZonesMaxUploadEditable = true
	SettingEditParamsItemsZonesMaxUploadEditableFalse SettingEditParamsItemsZonesMaxUploadEditable = false
)

type SettingEditParamsItemsZonesMaxUploadID 

type SettingEditParamsItemsZonesMaxUploadID string

identifier of the zone setting. 

const (
	SettingEditParamsItemsZonesMaxUploadIDMaxUpload SettingEditParamsItemsZonesMaxUploadID = "max_upload"
)

type SettingEditParamsItemsZonesMaxUploadValue 

type SettingEditParamsItemsZonesMaxUploadValue float64

Current value of the zone setting. 

const (
	SettingEditParamsItemsZonesMaxUploadValue100 SettingEditParamsItemsZonesMaxUploadValue = 100
	SettingEditParamsItemsZonesMaxUploadValue200 SettingEditParamsItemsZonesMaxUploadValue = 200
	SettingEditParamsItemsZonesMaxUploadValue500 SettingEditParamsItemsZonesMaxUploadValue = 500
)

type SettingEditParamsItemsZonesSchemasAutomaticPlatformOptimization 

type SettingEditParamsItemsZonesSchemasAutomaticPlatformOptimization struct {
	// ID of the zone setting.
	ID param.Field[SettingEditParamsItemsZonesSchemasAutomaticPlatformOptimizationID] `json:"id,required"`
	// Current value of the zone setting.
	Value param.Field[ZonesAutomaticPlatformOptimizationParam] `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 (SettingEditParamsItemsZonesSchemasAutomaticPlatformOptimization) MarshalJSON 

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

type SettingEditParamsItemsZonesSchemasAutomaticPlatformOptimizationEditable 

type SettingEditParamsItemsZonesSchemasAutomaticPlatformOptimizationEditable bool

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

const (
	SettingEditParamsItemsZonesSchemasAutomaticPlatformOptimizationEditableTrue  SettingEditParamsItemsZonesSchemasAutomaticPlatformOptimizationEditable = true
	SettingEditParamsItemsZonesSchemasAutomaticPlatformOptimizationEditableFalse SettingEditParamsItemsZonesSchemasAutomaticPlatformOptimizationEditable = false
)

type SettingEditParamsItemsZonesSchemasAutomaticPlatformOptimizationID 

type SettingEditParamsItemsZonesSchemasAutomaticPlatformOptimizationID string

ID of the zone setting. 

const (
	SettingEditParamsItemsZonesSchemasAutomaticPlatformOptimizationIDAutomaticPlatformOptimization SettingEditParamsItemsZonesSchemasAutomaticPlatformOptimizationID = "automatic_platform_optimization"
)

type SettingEditParamsItemsZonesSha1Support 

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

Allow SHA1 support.

func (SettingEditParamsItemsZonesSha1Support) MarshalJSON 

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

type SettingEditParamsItemsZonesSha1SupportEditable 

type SettingEditParamsItemsZonesSha1SupportEditable bool

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

const (
	SettingEditParamsItemsZonesSha1SupportEditableTrue  SettingEditParamsItemsZonesSha1SupportEditable = true
	SettingEditParamsItemsZonesSha1SupportEditableFalse SettingEditParamsItemsZonesSha1SupportEditable = false
)

type SettingEditParamsItemsZonesSha1SupportID 

type SettingEditParamsItemsZonesSha1SupportID string

Zone setting identifier. 

const (
	SettingEditParamsItemsZonesSha1SupportIDSha1Support SettingEditParamsItemsZonesSha1SupportID = "sha1_support"
)

type SettingEditParamsItemsZonesSha1SupportValue 

type SettingEditParamsItemsZonesSha1SupportValue string

Current value of the zone setting. 

const (
	SettingEditParamsItemsZonesSha1SupportValueOff SettingEditParamsItemsZonesSha1SupportValue = "off"
	SettingEditParamsItemsZonesSha1SupportValueOn  SettingEditParamsItemsZonesSha1SupportValue = "on"
)

type SettingEditParamsItemsZonesTLS1_2Only 

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

Only allows TLS1.2.

func (SettingEditParamsItemsZonesTLS1_2Only) MarshalJSON 

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

type SettingEditParamsItemsZonesTLS1_2OnlyEditable 

type SettingEditParamsItemsZonesTLS1_2OnlyEditable bool

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

const (
	SettingEditParamsItemsZonesTLS1_2OnlyEditableTrue  SettingEditParamsItemsZonesTLS1_2OnlyEditable = true
	SettingEditParamsItemsZonesTLS1_2OnlyEditableFalse SettingEditParamsItemsZonesTLS1_2OnlyEditable = false
)

type SettingEditParamsItemsZonesTLS1_2OnlyID 

type SettingEditParamsItemsZonesTLS1_2OnlyID string

Zone setting identifier. 

const (
	SettingEditParamsItemsZonesTLS1_2OnlyIDTLS1_2Only SettingEditParamsItemsZonesTLS1_2OnlyID = "tls_1_2_only"
)

type SettingEditParamsItemsZonesTLS1_2OnlyValue 

type SettingEditParamsItemsZonesTLS1_2OnlyValue string

Current value of the zone setting. 

const (
	SettingEditParamsItemsZonesTLS1_2OnlyValueOff SettingEditParamsItemsZonesTLS1_2OnlyValue = "off"
	SettingEditParamsItemsZonesTLS1_2OnlyValueOn  SettingEditParamsItemsZonesTLS1_2OnlyValue = "on"
)

type SettingEditResponse added in v2.4.0 

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

0-RTT session resumption enabled for this zone.

Union satisfied by zones.Zones0rtt, zones.ZonesAdvancedDDOS, zones.ZonesAlwaysOnline, zones.ZonesAlwaysUseHTTPS, zones.ZonesAutomaticHTTPSRewrites, zones.ZonesBrotli, zones.ZonesBrowserCacheTTL, zones.ZonesBrowserCheck, zones.ZonesCacheLevel, zones.ZonesChallengeTTL, zones.ZonesCiphers, zones.SettingEditResponseZonesCNAMEFlattening, zones.ZonesDevelopmentMode, zones.ZonesEarlyHints, zones.SettingEditResponseZonesEdgeCacheTTL, zones.ZonesEmailObfuscation, zones.ZonesH2Prioritization, zones.ZonesHotlinkProtection, zones.ZonesHTTP2, zones.ZonesHTTP3, zones.ZonesImageResizing, zones.ZonesIPGeolocation, zones.ZonesIPV6, zones.SettingEditResponseZonesMaxUpload, zones.ZonesMinTLSVersion, zones.ZonesMinify, zones.ZonesMirage, zones.ZonesMobileRedirect, zones.ZonesNEL, zones.ZonesOpportunisticEncryption, zones.ZonesOpportunisticOnion, zones.ZonesOrangeToOrange, zones.ZonesOriginErrorPagePassThru, zones.ZonesPolish, zones.ZonesPrefetchPreload, zones.ZonesProxyReadTimeout, zones.ZonesPseudoIPV4, zones.ZonesBuffering, zones.ZonesRocketLoader, zones.SettingEditResponseZonesSchemasAutomaticPlatformOptimization, zones.ZonesSecurityHeader, zones.ZonesSecurityLevel, zones.ZonesServerSideExclude, zones.SettingEditResponseZonesSha1Support, zones.ZonesSortQueryStringForCache, zones.ZonesSSL, zones.ZonesSSLRecommender, zones.SettingEditResponseZonesTLS1_2Only, zones.ZonesTLS1_3, zones.ZonesTLSClientAuth, zones.ZonesTrueClientIPHeader, zones.ZonesWAF, zones.ZonesWebp or zones.ZonesWebsockets.

type SettingEditResponseEnvelope added in v2.4.0 

type SettingEditResponseEnvelope struct {
	Errors   []SettingEditResponseEnvelopeErrors   `json:"errors,required"`
	Messages []SettingEditResponseEnvelopeMessages `json:"messages,required"`
	// Whether the API call was successful
	Success bool                            `json:"success,required"`
	Result  []SettingEditResponse           `json:"result"`
	JSON    settingEditResponseEnvelopeJSON `json:"-"`
}

func (*SettingEditResponseEnvelope) UnmarshalJSON added in v2.4.0 

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

type SettingEditResponseEnvelopeErrors 

type SettingEditResponseEnvelopeErrors struct {
	Code    int64                                 `json:"code,required"`
	Message string                                `json:"message,required"`
	JSON    settingEditResponseEnvelopeErrorsJSON `json:"-"`
}

func (*SettingEditResponseEnvelopeErrors) UnmarshalJSON 

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

type SettingEditResponseEnvelopeMessages 

type SettingEditResponseEnvelopeMessages struct {
	Code    int64                                   `json:"code,required"`
	Message string                                  `json:"message,required"`
	JSON    settingEditResponseEnvelopeMessagesJSON `json:"-"`
}

func (*SettingEditResponseEnvelopeMessages) UnmarshalJSON 

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

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
)

type SettingEditResponseZonesCNAMEFlatteningID added in v2.4.0 

type SettingEditResponseZonesCNAMEFlatteningID string

How to flatten the cname destination. 

const (
	SettingEditResponseZonesCNAMEFlatteningIDCNAMEFlattening SettingEditResponseZonesCNAMEFlatteningID = "cname_flattening"
)

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

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
)

type SettingEditResponseZonesEdgeCacheTTLID added in v2.4.0 

type SettingEditResponseZonesEdgeCacheTTLID string

ID of the zone setting. 

const (
	SettingEditResponseZonesEdgeCacheTTLIDEdgeCacheTTL SettingEditResponseZonesEdgeCacheTTLID = "edge_cache_ttl"
)

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
)

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
)

type SettingEditResponseZonesMaxUploadID added in v2.4.0 

type SettingEditResponseZonesMaxUploadID string

identifier of the zone setting. 

const (
	SettingEditResponseZonesMaxUploadIDMaxUpload SettingEditResponseZonesMaxUploadID = "max_upload"
)

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
)

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 ZonesAutomaticPlatformOptimization `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
)

type SettingEditResponseZonesSchemasAutomaticPlatformOptimizationID added in v2.4.0 

type SettingEditResponseZonesSchemasAutomaticPlatformOptimizationID string

ID of the zone setting. 

const (
	SettingEditResponseZonesSchemasAutomaticPlatformOptimizationIDAutomaticPlatformOptimization SettingEditResponseZonesSchemasAutomaticPlatformOptimizationID = "automatic_platform_optimization"
)

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
)

type SettingEditResponseZonesSha1SupportID added in v2.4.0 

type SettingEditResponseZonesSha1SupportID string

Zone setting identifier. 

const (
	SettingEditResponseZonesSha1SupportIDSha1Support SettingEditResponseZonesSha1SupportID = "sha1_support"
)

type SettingEditResponseZonesSha1SupportValue added in v2.4.0 

type SettingEditResponseZonesSha1SupportValue string

Current value of the zone setting. 

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

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
)

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

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

type SettingEmailObfuscationEditParams 

type SettingEmailObfuscationEditParams struct {
	// Identifier
	ZoneID param.Field[string] `path:"zone_id,required"`
	// Value of the zone setting.
	Value param.Field[SettingEmailObfuscationEditParamsValue] `json:"value,required"`
}

func (SettingEmailObfuscationEditParams) MarshalJSON 

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

type SettingEmailObfuscationEditParamsValue 

type SettingEmailObfuscationEditParamsValue string

Value of the zone setting. 

const (
	SettingEmailObfuscationEditParamsValueOn  SettingEmailObfuscationEditParamsValue = "on"
	SettingEmailObfuscationEditParamsValueOff SettingEmailObfuscationEditParamsValue = "off"
)

type SettingEmailObfuscationEditResponseEnvelope 

type SettingEmailObfuscationEditResponseEnvelope struct {
	Errors   []SettingEmailObfuscationEditResponseEnvelopeErrors   `json:"errors,required"`
	Messages []SettingEmailObfuscationEditResponseEnvelopeMessages `json:"messages,required"`
	// Whether the API call was successful
	Success bool `json:"success,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).
	Result ZonesEmailObfuscation                           `json:"result"`
	JSON   settingEmailObfuscationEditResponseEnvelopeJSON `json:"-"`
}

func (*SettingEmailObfuscationEditResponseEnvelope) UnmarshalJSON 

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

type SettingEmailObfuscationEditResponseEnvelopeErrors 

type SettingEmailObfuscationEditResponseEnvelopeErrors struct {
	Code    int64                                                 `json:"code,required"`
	Message string                                                `json:"message,required"`
	JSON    settingEmailObfuscationEditResponseEnvelopeErrorsJSON `json:"-"`
}

func (*SettingEmailObfuscationEditResponseEnvelopeErrors) UnmarshalJSON 

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

type SettingEmailObfuscationEditResponseEnvelopeMessages 

type SettingEmailObfuscationEditResponseEnvelopeMessages struct {
	Code    int64                                                   `json:"code,required"`
	Message string                                                  `json:"message,required"`
	JSON    settingEmailObfuscationEditResponseEnvelopeMessagesJSON `json:"-"`
}

func (*SettingEmailObfuscationEditResponseEnvelopeMessages) UnmarshalJSON 

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

type SettingEmailObfuscationGetParams 

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

type SettingEmailObfuscationGetResponseEnvelope 

type SettingEmailObfuscationGetResponseEnvelope struct {
	Errors   []SettingEmailObfuscationGetResponseEnvelopeErrors   `json:"errors,required"`
	Messages []SettingEmailObfuscationGetResponseEnvelopeMessages `json:"messages,required"`
	// Whether the API call was successful
	Success bool `json:"success,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).
	Result ZonesEmailObfuscation                          `json:"result"`
	JSON   settingEmailObfuscationGetResponseEnvelopeJSON `json:"-"`
}

func (*SettingEmailObfuscationGetResponseEnvelope) UnmarshalJSON 

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

type SettingEmailObfuscationGetResponseEnvelopeErrors 

type SettingEmailObfuscationGetResponseEnvelopeErrors struct {
	Code    int64                                                `json:"code,required"`
	Message string                                               `json:"message,required"`
	JSON    settingEmailObfuscationGetResponseEnvelopeErrorsJSON `json:"-"`
}

func (*SettingEmailObfuscationGetResponseEnvelopeErrors) UnmarshalJSON 

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

type SettingEmailObfuscationGetResponseEnvelopeMessages 

type SettingEmailObfuscationGetResponseEnvelopeMessages struct {
	Code    int64                                                  `json:"code,required"`
	Message string                                                 `json:"message,required"`
	JSON    settingEmailObfuscationGetResponseEnvelopeMessagesJSON `json:"-"`
}

func (*SettingEmailObfuscationGetResponseEnvelopeMessages) UnmarshalJSON 

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

type SettingEmailObfuscationService 

type SettingEmailObfuscationService struct {
	Options []option.RequestOption
}

SettingEmailObfuscationService 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 NewSettingEmailObfuscationService method instead.

func NewSettingEmailObfuscationService 

func NewSettingEmailObfuscationService(opts ...option.RequestOption) (r *SettingEmailObfuscationService)

NewSettingEmailObfuscationService 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 (*SettingEmailObfuscationService) Edit 

func (r *SettingEmailObfuscationService) Edit(ctx context.Context, params SettingEmailObfuscationEditParams, opts ...option.RequestOption) (res *ZonesEmailObfuscation, err error)

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

func (r *SettingEmailObfuscationService) Get(ctx context.Context, query SettingEmailObfuscationGetParams, opts ...option.RequestOption) (res *ZonesEmailObfuscation, err error)

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

type SettingFontSettingEditParams 

type SettingFontSettingEditParams struct {
	// Identifier
	ZoneID param.Field[string] `path:"zone_id,required"`
	// Whether the feature is enabled or disabled.
	Value param.Field[SettingFontSettingEditParamsValue] `json:"value,required"`
}

func (SettingFontSettingEditParams) MarshalJSON 

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

type SettingFontSettingEditParamsValue 

type SettingFontSettingEditParamsValue string

Whether the feature is enabled or disabled. 

const (
	SettingFontSettingEditParamsValueOn  SettingFontSettingEditParamsValue = "on"
	SettingFontSettingEditParamsValueOff SettingFontSettingEditParamsValue = "off"
)

type SettingFontSettingEditResponseEnvelope 

type SettingFontSettingEditResponseEnvelope struct {
	Errors   []SettingFontSettingEditResponseEnvelopeErrors   `json:"errors,required"`
	Messages []SettingFontSettingEditResponseEnvelopeMessages `json:"messages,required"`
	// Whether the API call was successful
	Success bool `json:"success,required"`
	// Enhance your website's font delivery with Cloudflare Fonts. Deliver Google
	// Hosted fonts from your own domain, boost performance, and enhance user privacy.
	// Refer to the Cloudflare Fonts documentation for more information.
	Result SpeedCloudflareFonts                       `json:"result"`
	JSON   settingFontSettingEditResponseEnvelopeJSON `json:"-"`
}

func (*SettingFontSettingEditResponseEnvelope) UnmarshalJSON 

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

type SettingFontSettingEditResponseEnvelopeErrors 

type SettingFontSettingEditResponseEnvelopeErrors struct {
	Code    int64                                            `json:"code,required"`
	Message string                                           `json:"message,required"`
	JSON    settingFontSettingEditResponseEnvelopeErrorsJSON `json:"-"`
}

func (*SettingFontSettingEditResponseEnvelopeErrors) UnmarshalJSON 

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

type SettingFontSettingEditResponseEnvelopeMessages 

type SettingFontSettingEditResponseEnvelopeMessages struct {
	Code    int64                                              `json:"code,required"`
	Message string                                             `json:"message,required"`
	JSON    settingFontSettingEditResponseEnvelopeMessagesJSON `json:"-"`
}

func (*SettingFontSettingEditResponseEnvelopeMessages) UnmarshalJSON 

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

type SettingFontSettingGetParams 

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

type SettingFontSettingGetResponseEnvelope 

type SettingFontSettingGetResponseEnvelope struct {
	Errors   []SettingFontSettingGetResponseEnvelopeErrors   `json:"errors,required"`
	Messages []SettingFontSettingGetResponseEnvelopeMessages `json:"messages,required"`
	// Whether the API call was successful
	Success bool `json:"success,required"`
	// Enhance your website's font delivery with Cloudflare Fonts. Deliver Google
	// Hosted fonts from your own domain, boost performance, and enhance user privacy.
	// Refer to the Cloudflare Fonts documentation for more information.
	Result SpeedCloudflareFonts                      `json:"result"`
	JSON   settingFontSettingGetResponseEnvelopeJSON `json:"-"`
}

func (*SettingFontSettingGetResponseEnvelope) UnmarshalJSON 

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

type SettingFontSettingGetResponseEnvelopeErrors 

type SettingFontSettingGetResponseEnvelopeErrors struct {
	Code    int64                                           `json:"code,required"`
	Message string                                          `json:"message,required"`
	JSON    settingFontSettingGetResponseEnvelopeErrorsJSON `json:"-"`
}

func (*SettingFontSettingGetResponseEnvelopeErrors) UnmarshalJSON 

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

type SettingFontSettingGetResponseEnvelopeMessages 

type SettingFontSettingGetResponseEnvelopeMessages struct {
	Code    int64                                             `json:"code,required"`
	Message string                                            `json:"message,required"`
	JSON    settingFontSettingGetResponseEnvelopeMessagesJSON `json:"-"`
}

func (*SettingFontSettingGetResponseEnvelopeMessages) UnmarshalJSON 

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

type SettingFontSettingService 

type SettingFontSettingService struct {
	Options []option.RequestOption
}

SettingFontSettingService 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 NewSettingFontSettingService method instead.

func NewSettingFontSettingService 

func NewSettingFontSettingService(opts ...option.RequestOption) (r *SettingFontSettingService)

NewSettingFontSettingService 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 (*SettingFontSettingService) Edit 

func (r *SettingFontSettingService) Edit(ctx context.Context, params SettingFontSettingEditParams, opts ...option.RequestOption) (res *SpeedCloudflareFonts, err error)

Enhance your website's font delivery with Cloudflare Fonts. Deliver Google Hosted fonts from your own domain, boost performance, and enhance user privacy. Refer to the Cloudflare Fonts documentation for more information.

func (*SettingFontSettingService) Get 

func (r *SettingFontSettingService) Get(ctx context.Context, query SettingFontSettingGetParams, opts ...option.RequestOption) (res *SpeedCloudflareFonts, err error)

Enhance your website's font delivery with Cloudflare Fonts. Deliver Google Hosted fonts from your own domain, boost performance, and enhance user privacy. Refer to the Cloudflare Fonts documentation for more information.

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 interface {
	// contains filtered or unexported methods
}

0-RTT session resumption enabled for this zone.

Union satisfied by zones.Zones0rtt, zones.ZonesAdvancedDDOS, zones.ZonesAlwaysOnline, zones.ZonesAlwaysUseHTTPS, zones.ZonesAutomaticHTTPSRewrites, zones.ZonesBrotli, zones.ZonesBrowserCacheTTL, zones.ZonesBrowserCheck, zones.ZonesCacheLevel, zones.ZonesChallengeTTL, zones.ZonesCiphers, zones.SettingGetResponseZonesCNAMEFlattening, zones.ZonesDevelopmentMode, zones.ZonesEarlyHints, zones.SettingGetResponseZonesEdgeCacheTTL, zones.ZonesEmailObfuscation, zones.ZonesH2Prioritization, zones.ZonesHotlinkProtection, zones.ZonesHTTP2, zones.ZonesHTTP3, zones.ZonesImageResizing, zones.ZonesIPGeolocation, zones.ZonesIPV6, zones.SettingGetResponseZonesMaxUpload, zones.ZonesMinTLSVersion, zones.ZonesMinify, zones.ZonesMirage, zones.ZonesMobileRedirect, zones.ZonesNEL, zones.ZonesOpportunisticEncryption, zones.ZonesOpportunisticOnion, zones.ZonesOrangeToOrange, zones.ZonesOriginErrorPagePassThru, zones.ZonesPolish, zones.ZonesPrefetchPreload, zones.ZonesProxyReadTimeout, zones.ZonesPseudoIPV4, zones.ZonesBuffering, zones.ZonesRocketLoader, zones.SettingGetResponseZonesSchemasAutomaticPlatformOptimization, zones.ZonesSecurityHeader, zones.ZonesSecurityLevel, zones.ZonesServerSideExclude, zones.SettingGetResponseZonesSha1Support, zones.ZonesSortQueryStringForCache, zones.ZonesSSL, zones.ZonesSSLRecommender, zones.SettingGetResponseZonesTLS1_2Only, zones.ZonesTLS1_3, zones.ZonesTLSClientAuth, zones.ZonesTrueClientIPHeader, zones.ZonesWAF, zones.ZonesWebp or zones.ZonesWebsockets.

type SettingGetResponseEnvelope added in v2.4.0 

type SettingGetResponseEnvelope struct {
	Errors   []SettingGetResponseEnvelopeErrors   `json:"errors,required"`
	Messages []SettingGetResponseEnvelopeMessages `json:"messages,required"`
	// Whether the API call was successful
	Success bool                           `json:"success,required"`
	Result  []SettingGetResponse           `json:"result"`
	JSON    settingGetResponseEnvelopeJSON `json:"-"`
}

func (*SettingGetResponseEnvelope) UnmarshalJSON added in v2.4.0 

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

type SettingGetResponseEnvelopeErrors 

type SettingGetResponseEnvelopeErrors struct {
	Code    int64                                `json:"code,required"`
	Message string                               `json:"message,required"`
	JSON    settingGetResponseEnvelopeErrorsJSON `json:"-"`
}

func (*SettingGetResponseEnvelopeErrors) UnmarshalJSON 

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

type SettingGetResponseEnvelopeMessages 

type SettingGetResponseEnvelopeMessages struct {
	Code    int64                                  `json:"code,required"`
	Message string                                 `json:"message,required"`
	JSON    settingGetResponseEnvelopeMessagesJSON `json:"-"`
}

func (*SettingGetResponseEnvelopeMessages) UnmarshalJSON 

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

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
)

type SettingGetResponseZonesCNAMEFlatteningID added in v2.4.0 

type SettingGetResponseZonesCNAMEFlatteningID string

How to flatten the cname destination. 

const (
	SettingGetResponseZonesCNAMEFlatteningIDCNAMEFlattening SettingGetResponseZonesCNAMEFlatteningID = "cname_flattening"
)

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

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
)

type SettingGetResponseZonesEdgeCacheTTLID added in v2.4.0 

type SettingGetResponseZonesEdgeCacheTTLID string

ID of the zone setting. 

const (
	SettingGetResponseZonesEdgeCacheTTLIDEdgeCacheTTL SettingGetResponseZonesEdgeCacheTTLID = "edge_cache_ttl"
)

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
)

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
)

type SettingGetResponseZonesMaxUploadID added in v2.4.0 

type SettingGetResponseZonesMaxUploadID string

identifier of the zone setting. 

const (
	SettingGetResponseZonesMaxUploadIDMaxUpload SettingGetResponseZonesMaxUploadID = "max_upload"
)

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
)

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 ZonesAutomaticPlatformOptimization `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
)

type SettingGetResponseZonesSchemasAutomaticPlatformOptimizationID added in v2.4.0 

type SettingGetResponseZonesSchemasAutomaticPlatformOptimizationID string

ID of the zone setting. 

const (
	SettingGetResponseZonesSchemasAutomaticPlatformOptimizationIDAutomaticPlatformOptimization SettingGetResponseZonesSchemasAutomaticPlatformOptimizationID = "automatic_platform_optimization"
)

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
)

type SettingGetResponseZonesSha1SupportID added in v2.4.0 

type SettingGetResponseZonesSha1SupportID string

Zone setting identifier. 

const (
	SettingGetResponseZonesSha1SupportIDSha1Support SettingGetResponseZonesSha1SupportID = "sha1_support"
)

type SettingGetResponseZonesSha1SupportValue added in v2.4.0 

type SettingGetResponseZonesSha1SupportValue string

Current value of the zone setting. 

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

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
)

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

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

type SettingH2PrioritizationEditParams 

type SettingH2PrioritizationEditParams struct {
	// Identifier
	ZoneID param.Field[string] `path:"zone_id,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.
	Value param.Field[ZonesH2PrioritizationParam] `json:"value,required"`
}

func (SettingH2PrioritizationEditParams) MarshalJSON 

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

type SettingH2PrioritizationEditResponseEnvelope 

type SettingH2PrioritizationEditResponseEnvelope struct {
	Errors   []SettingH2PrioritizationEditResponseEnvelopeErrors   `json:"errors,required"`
	Messages []SettingH2PrioritizationEditResponseEnvelopeMessages `json:"messages,required"`
	// Whether the API call was successful
	Success bool `json:"success,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.
	Result ZonesH2Prioritization                           `json:"result"`
	JSON   settingH2PrioritizationEditResponseEnvelopeJSON `json:"-"`
}

func (*SettingH2PrioritizationEditResponseEnvelope) UnmarshalJSON 

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

type SettingH2PrioritizationEditResponseEnvelopeErrors 

type SettingH2PrioritizationEditResponseEnvelopeErrors struct {
	Code    int64                                                 `json:"code,required"`
	Message string                                                `json:"message,required"`
	JSON    settingH2PrioritizationEditResponseEnvelopeErrorsJSON `json:"-"`
}

func (*SettingH2PrioritizationEditResponseEnvelopeErrors) UnmarshalJSON 

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

type SettingH2PrioritizationEditResponseEnvelopeMessages 

type SettingH2PrioritizationEditResponseEnvelopeMessages struct {
	Code    int64                                                   `json:"code,required"`
	Message string                                                  `json:"message,required"`
	JSON    settingH2PrioritizationEditResponseEnvelopeMessagesJSON `json:"-"`
}

func (*SettingH2PrioritizationEditResponseEnvelopeMessages) UnmarshalJSON 

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

type SettingH2PrioritizationGetParams 

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

type SettingH2PrioritizationGetResponseEnvelope 

type SettingH2PrioritizationGetResponseEnvelope struct {
	Errors   []SettingH2PrioritizationGetResponseEnvelopeErrors   `json:"errors,required"`
	Messages []SettingH2PrioritizationGetResponseEnvelopeMessages `json:"messages,required"`
	// Whether the API call was successful
	Success bool `json:"success,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.
	Result ZonesH2Prioritization                          `json:"result"`
	JSON   settingH2PrioritizationGetResponseEnvelopeJSON `json:"-"`
}

func (*SettingH2PrioritizationGetResponseEnvelope) UnmarshalJSON 

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

type SettingH2PrioritizationGetResponseEnvelopeErrors 

type SettingH2PrioritizationGetResponseEnvelopeErrors struct {
	Code    int64                                                `json:"code,required"`
	Message string                                               `json:"message,required"`
	JSON    settingH2PrioritizationGetResponseEnvelopeErrorsJSON `json:"-"`
}

func (*SettingH2PrioritizationGetResponseEnvelopeErrors) UnmarshalJSON 

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

type SettingH2PrioritizationGetResponseEnvelopeMessages 

type SettingH2PrioritizationGetResponseEnvelopeMessages struct {
	Code    int64                                                  `json:"code,required"`
	Message string                                                 `json:"message,required"`
	JSON    settingH2PrioritizationGetResponseEnvelopeMessagesJSON `json:"-"`
}

func (*SettingH2PrioritizationGetResponseEnvelopeMessages) UnmarshalJSON 

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

type SettingH2PrioritizationService 

type SettingH2PrioritizationService struct {
	Options []option.RequestOption
}

SettingH2PrioritizationService 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 NewSettingH2PrioritizationService method instead.

func NewSettingH2PrioritizationService 

func NewSettingH2PrioritizationService(opts ...option.RequestOption) (r *SettingH2PrioritizationService)

NewSettingH2PrioritizationService 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 (*SettingH2PrioritizationService) Edit 

func (r *SettingH2PrioritizationService) Edit(ctx context.Context, params SettingH2PrioritizationEditParams, opts ...option.RequestOption) (res *ZonesH2Prioritization, err error)

Gets HTTP/2 Edge Prioritization setting.

func (*SettingH2PrioritizationService) Get 

func (r *SettingH2PrioritizationService) Get(ctx context.Context, query SettingH2PrioritizationGetParams, opts ...option.RequestOption) (res *ZonesH2Prioritization, err error)

Gets HTTP/2 Edge Prioritization setting.

type SettingHTTP2EditParams 

type SettingHTTP2EditParams struct {
	// Identifier
	ZoneID param.Field[string] `path:"zone_id,required"`
	// Value of the HTTP2 setting.
	Value param.Field[SettingHTTP2EditParamsValue] `json:"value,required"`
}

func (SettingHTTP2EditParams) MarshalJSON 

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

type SettingHTTP2EditParamsValue 

type SettingHTTP2EditParamsValue string

Value of the HTTP2 setting. 

const (
	SettingHTTP2EditParamsValueOn  SettingHTTP2EditParamsValue = "on"
	SettingHTTP2EditParamsValueOff SettingHTTP2EditParamsValue = "off"
)

type SettingHTTP2EditResponseEnvelope 

type SettingHTTP2EditResponseEnvelope struct {
	Errors   []SettingHTTP2EditResponseEnvelopeErrors   `json:"errors,required"`
	Messages []SettingHTTP2EditResponseEnvelopeMessages `json:"messages,required"`
	// Whether the API call was successful
	Success bool `json:"success,required"`
	// HTTP2 enabled for this zone.
	Result ZonesHTTP2                           `json:"result"`
	JSON   settingHTTP2EditResponseEnvelopeJSON `json:"-"`
}

func (*SettingHTTP2EditResponseEnvelope) UnmarshalJSON 

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

type SettingHTTP2EditResponseEnvelopeErrors 

type SettingHTTP2EditResponseEnvelopeErrors struct {
	Code    int64                                      `json:"code,required"`
	Message string                                     `json:"message,required"`
	JSON    settingHTTP2EditResponseEnvelopeErrorsJSON `json:"-"`
}

func (*SettingHTTP2EditResponseEnvelopeErrors) UnmarshalJSON 

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

type SettingHTTP2EditResponseEnvelopeMessages 

type SettingHTTP2EditResponseEnvelopeMessages struct {
	Code    int64                                        `json:"code,required"`
	Message string                                       `json:"message,required"`
	JSON    settingHTTP2EditResponseEnvelopeMessagesJSON `json:"-"`
}

func (*SettingHTTP2EditResponseEnvelopeMessages) UnmarshalJSON 

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

type SettingHTTP2GetParams 

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

type SettingHTTP2GetResponseEnvelope 

type SettingHTTP2GetResponseEnvelope struct {
	Errors   []SettingHTTP2GetResponseEnvelopeErrors   `json:"errors,required"`
	Messages []SettingHTTP2GetResponseEnvelopeMessages `json:"messages,required"`
	// Whether the API call was successful
	Success bool `json:"success,required"`
	// HTTP2 enabled for this zone.
	Result ZonesHTTP2                          `json:"result"`
	JSON   settingHTTP2GetResponseEnvelopeJSON `json:"-"`
}

func (*SettingHTTP2GetResponseEnvelope) UnmarshalJSON 

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

type SettingHTTP2GetResponseEnvelopeErrors 

type SettingHTTP2GetResponseEnvelopeErrors struct {
	Code    int64                                     `json:"code,required"`
	Message string                                    `json:"message,required"`
	JSON    settingHTTP2GetResponseEnvelopeErrorsJSON `json:"-"`
}

func (*SettingHTTP2GetResponseEnvelopeErrors) UnmarshalJSON 

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

type SettingHTTP2GetResponseEnvelopeMessages 

type SettingHTTP2GetResponseEnvelopeMessages struct {
	Code    int64                                       `json:"code,required"`
	Message string                                      `json:"message,required"`
	JSON    settingHTTP2GetResponseEnvelopeMessagesJSON `json:"-"`
}

func (*SettingHTTP2GetResponseEnvelopeMessages) UnmarshalJSON 

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

type SettingHTTP2Service 

type SettingHTTP2Service struct {
	Options []option.RequestOption
}

SettingHTTP2Service 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 NewSettingHTTP2Service method instead.

func NewSettingHTTP2Service 

func NewSettingHTTP2Service(opts ...option.RequestOption) (r *SettingHTTP2Service)

NewSettingHTTP2Service 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 (*SettingHTTP2Service) Edit 

func (r *SettingHTTP2Service) Edit(ctx context.Context, params SettingHTTP2EditParams, opts ...option.RequestOption) (res *ZonesHTTP2, err error)

Value of the HTTP2 setting.

func (*SettingHTTP2Service) Get 

func (r *SettingHTTP2Service) Get(ctx context.Context, query SettingHTTP2GetParams, opts ...option.RequestOption) (res *ZonesHTTP2, err error)

Value of the HTTP2 setting.

type SettingHTTP3EditParams 

type SettingHTTP3EditParams struct {
	// Identifier
	ZoneID param.Field[string] `path:"zone_id,required"`
	// Value of the HTTP3 setting.
	Value param.Field[SettingHTTP3EditParamsValue] `json:"value,required"`
}

func (SettingHTTP3EditParams) MarshalJSON 

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

type SettingHTTP3EditParamsValue 

type SettingHTTP3EditParamsValue string

Value of the HTTP3 setting. 

const (
	SettingHTTP3EditParamsValueOn  SettingHTTP3EditParamsValue = "on"
	SettingHTTP3EditParamsValueOff SettingHTTP3EditParamsValue = "off"
)

type SettingHTTP3EditResponseEnvelope 

type SettingHTTP3EditResponseEnvelope struct {
	Errors   []SettingHTTP3EditResponseEnvelopeErrors   `json:"errors,required"`
	Messages []SettingHTTP3EditResponseEnvelopeMessages `json:"messages,required"`
	// Whether the API call was successful
	Success bool `json:"success,required"`
	// HTTP3 enabled for this zone.
	Result ZonesHTTP3                           `json:"result"`
	JSON   settingHTTP3EditResponseEnvelopeJSON `json:"-"`
}

func (*SettingHTTP3EditResponseEnvelope) UnmarshalJSON 

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

type SettingHTTP3EditResponseEnvelopeErrors 

type SettingHTTP3EditResponseEnvelopeErrors struct {
	Code    int64                                      `json:"code,required"`
	Message string                                     `json:"message,required"`
	JSON    settingHTTP3EditResponseEnvelopeErrorsJSON `json:"-"`
}

func (*SettingHTTP3EditResponseEnvelopeErrors) UnmarshalJSON 

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

type SettingHTTP3EditResponseEnvelopeMessages 

type SettingHTTP3EditResponseEnvelopeMessages struct {
	Code    int64                                        `json:"code,required"`
	Message string                                       `json:"message,required"`
	JSON    settingHTTP3EditResponseEnvelopeMessagesJSON `json:"-"`
}

func (*SettingHTTP3EditResponseEnvelopeMessages) UnmarshalJSON 

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

type SettingHTTP3GetParams 

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

type SettingHTTP3GetResponseEnvelope 

type SettingHTTP3GetResponseEnvelope struct {
	Errors   []SettingHTTP3GetResponseEnvelopeErrors   `json:"errors,required"`
	Messages []SettingHTTP3GetResponseEnvelopeMessages `json:"messages,required"`
	// Whether the API call was successful
	Success bool `json:"success,required"`
	// HTTP3 enabled for this zone.
	Result ZonesHTTP3                          `json:"result"`
	JSON   settingHTTP3GetResponseEnvelopeJSON `json:"-"`
}

func (*SettingHTTP3GetResponseEnvelope) UnmarshalJSON 

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

type SettingHTTP3GetResponseEnvelopeErrors 

type SettingHTTP3GetResponseEnvelopeErrors struct {
	Code    int64                                     `json:"code,required"`
	Message string                                    `json:"message,required"`
	JSON    settingHTTP3GetResponseEnvelopeErrorsJSON `json:"-"`
}

func (*SettingHTTP3GetResponseEnvelopeErrors) UnmarshalJSON 

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

type SettingHTTP3GetResponseEnvelopeMessages 

type SettingHTTP3GetResponseEnvelopeMessages struct {
	Code    int64                                       `json:"code,required"`
	Message string                                      `json:"message,required"`
	JSON    settingHTTP3GetResponseEnvelopeMessagesJSON `json:"-"`
}

func (*SettingHTTP3GetResponseEnvelopeMessages) UnmarshalJSON 

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

type SettingHTTP3Service 

type SettingHTTP3Service struct {
	Options []option.RequestOption
}

SettingHTTP3Service 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 NewSettingHTTP3Service method instead.

func NewSettingHTTP3Service 

func NewSettingHTTP3Service(opts ...option.RequestOption) (r *SettingHTTP3Service)

NewSettingHTTP3Service 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 (*SettingHTTP3Service) Edit 

func (r *SettingHTTP3Service) Edit(ctx context.Context, params SettingHTTP3EditParams, opts ...option.RequestOption) (res *ZonesHTTP3, err error)

Value of the HTTP3 setting.

func (*SettingHTTP3Service) Get 

func (r *SettingHTTP3Service) Get(ctx context.Context, query SettingHTTP3GetParams, opts ...option.RequestOption) (res *ZonesHTTP3, err error)

Value of the HTTP3 setting.

type SettingHotlinkProtectionEditParams 

type SettingHotlinkProtectionEditParams struct {
	// Identifier
	ZoneID param.Field[string] `path:"zone_id,required"`
	// Value of the zone setting.
	Value param.Field[SettingHotlinkProtectionEditParamsValue] `json:"value,required"`
}

func (SettingHotlinkProtectionEditParams) MarshalJSON 

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

type SettingHotlinkProtectionEditParamsValue 

type SettingHotlinkProtectionEditParamsValue string

Value of the zone setting. 

const (
	SettingHotlinkProtectionEditParamsValueOn  SettingHotlinkProtectionEditParamsValue = "on"
	SettingHotlinkProtectionEditParamsValueOff SettingHotlinkProtectionEditParamsValue = "off"
)

type SettingHotlinkProtectionEditResponseEnvelope 

type SettingHotlinkProtectionEditResponseEnvelope struct {
	Errors   []SettingHotlinkProtectionEditResponseEnvelopeErrors   `json:"errors,required"`
	Messages []SettingHotlinkProtectionEditResponseEnvelopeMessages `json:"messages,required"`
	// Whether the API call was successful
	Success bool `json:"success,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).
	Result ZonesHotlinkProtection                           `json:"result"`
	JSON   settingHotlinkProtectionEditResponseEnvelopeJSON `json:"-"`
}

func (*SettingHotlinkProtectionEditResponseEnvelope) UnmarshalJSON 

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

type SettingHotlinkProtectionEditResponseEnvelopeErrors 

type SettingHotlinkProtectionEditResponseEnvelopeErrors struct {
	Code    int64                                                  `json:"code,required"`
	Message string                                                 `json:"message,required"`
	JSON    settingHotlinkProtectionEditResponseEnvelopeErrorsJSON `json:"-"`
}

func (*SettingHotlinkProtectionEditResponseEnvelopeErrors) UnmarshalJSON 

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

type SettingHotlinkProtectionEditResponseEnvelopeMessages 

type SettingHotlinkProtectionEditResponseEnvelopeMessages struct {
	Code    int64                                                    `json:"code,required"`
	Message string                                                   `json:"message,required"`
	JSON    settingHotlinkProtectionEditResponseEnvelopeMessagesJSON `json:"-"`
}

func (*SettingHotlinkProtectionEditResponseEnvelopeMessages) UnmarshalJSON 

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

type SettingHotlinkProtectionGetParams 

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

type SettingHotlinkProtectionGetResponseEnvelope 

type SettingHotlinkProtectionGetResponseEnvelope struct {
	Errors   []SettingHotlinkProtectionGetResponseEnvelopeErrors   `json:"errors,required"`
	Messages []SettingHotlinkProtectionGetResponseEnvelopeMessages `json:"messages,required"`
	// Whether the API call was successful
	Success bool `json:"success,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).
	Result ZonesHotlinkProtection                          `json:"result"`
	JSON   settingHotlinkProtectionGetResponseEnvelopeJSON `json:"-"`
}

func (*SettingHotlinkProtectionGetResponseEnvelope) UnmarshalJSON 

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

type SettingHotlinkProtectionGetResponseEnvelopeErrors 

type SettingHotlinkProtectionGetResponseEnvelopeErrors struct {
	Code    int64                                                 `json:"code,required"`
	Message string                                                `json:"message,required"`
	JSON    settingHotlinkProtectionGetResponseEnvelopeErrorsJSON `json:"-"`
}

func (*SettingHotlinkProtectionGetResponseEnvelopeErrors) UnmarshalJSON 

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

type SettingHotlinkProtectionGetResponseEnvelopeMessages 

type SettingHotlinkProtectionGetResponseEnvelopeMessages struct {
	Code    int64                                                   `json:"code,required"`
	Message string                                                  `json:"message,required"`
	JSON    settingHotlinkProtectionGetResponseEnvelopeMessagesJSON `json:"-"`
}

func (*SettingHotlinkProtectionGetResponseEnvelopeMessages) UnmarshalJSON 

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

type SettingHotlinkProtectionService 

type SettingHotlinkProtectionService struct {
	Options []option.RequestOption
}

SettingHotlinkProtectionService 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 NewSettingHotlinkProtectionService method instead.

func NewSettingHotlinkProtectionService 

func NewSettingHotlinkProtectionService(opts ...option.RequestOption) (r *SettingHotlinkProtectionService)

NewSettingHotlinkProtectionService 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 (*SettingHotlinkProtectionService) Edit 

func (r *SettingHotlinkProtectionService) Edit(ctx context.Context, params SettingHotlinkProtectionEditParams, opts ...option.RequestOption) (res *ZonesHotlinkProtection, err error)

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

func (r *SettingHotlinkProtectionService) Get(ctx context.Context, query SettingHotlinkProtectionGetParams, opts ...option.RequestOption) (res *ZonesHotlinkProtection, err error)

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

type SettingIPGeolocationEditParams 

type SettingIPGeolocationEditParams struct {
	// Identifier
	ZoneID param.Field[string] `path:"zone_id,required"`
	// Value of the zone setting.
	Value param.Field[SettingIPGeolocationEditParamsValue] `json:"value,required"`
}

func (SettingIPGeolocationEditParams) MarshalJSON 

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

type SettingIPGeolocationEditParamsValue 

type SettingIPGeolocationEditParamsValue string

Value of the zone setting. 

const (
	SettingIPGeolocationEditParamsValueOn  SettingIPGeolocationEditParamsValue = "on"
	SettingIPGeolocationEditParamsValueOff SettingIPGeolocationEditParamsValue = "off"
)

type SettingIPGeolocationEditResponseEnvelope 

type SettingIPGeolocationEditResponseEnvelope struct {
	Errors   []SettingIPGeolocationEditResponseEnvelopeErrors   `json:"errors,required"`
	Messages []SettingIPGeolocationEditResponseEnvelopeMessages `json:"messages,required"`
	// Whether the API call was successful
	Success bool `json:"success,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).
	Result ZonesIPGeolocation                           `json:"result"`
	JSON   settingIPGeolocationEditResponseEnvelopeJSON `json:"-"`
}

func (*SettingIPGeolocationEditResponseEnvelope) UnmarshalJSON 

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

type SettingIPGeolocationEditResponseEnvelopeErrors 

type SettingIPGeolocationEditResponseEnvelopeErrors struct {
	Code    int64                                              `json:"code,required"`
	Message string                                             `json:"message,required"`
	JSON    settingIPGeolocationEditResponseEnvelopeErrorsJSON `json:"-"`
}

func (*SettingIPGeolocationEditResponseEnvelopeErrors) UnmarshalJSON 

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

type SettingIPGeolocationEditResponseEnvelopeMessages 

type SettingIPGeolocationEditResponseEnvelopeMessages struct {
	Code    int64                                                `json:"code,required"`
	Message string                                               `json:"message,required"`
	JSON    settingIPGeolocationEditResponseEnvelopeMessagesJSON `json:"-"`
}

func (*SettingIPGeolocationEditResponseEnvelopeMessages) UnmarshalJSON 

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

type SettingIPGeolocationGetParams 

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

type SettingIPGeolocationGetResponseEnvelope 

type SettingIPGeolocationGetResponseEnvelope struct {
	Errors   []SettingIPGeolocationGetResponseEnvelopeErrors   `json:"errors,required"`
	Messages []SettingIPGeolocationGetResponseEnvelopeMessages `json:"messages,required"`
	// Whether the API call was successful
	Success bool `json:"success,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).
	Result ZonesIPGeolocation                          `json:"result"`
	JSON   settingIPGeolocationGetResponseEnvelopeJSON `json:"-"`
}

func (*SettingIPGeolocationGetResponseEnvelope) UnmarshalJSON 

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

type SettingIPGeolocationGetResponseEnvelopeErrors 

type SettingIPGeolocationGetResponseEnvelopeErrors struct {
	Code    int64                                             `json:"code,required"`
	Message string                                            `json:"message,required"`
	JSON    settingIPGeolocationGetResponseEnvelopeErrorsJSON `json:"-"`
}

func (*SettingIPGeolocationGetResponseEnvelopeErrors) UnmarshalJSON 

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

type SettingIPGeolocationGetResponseEnvelopeMessages 

type SettingIPGeolocationGetResponseEnvelopeMessages struct {
	Code    int64                                               `json:"code,required"`
	Message string                                              `json:"message,required"`
	JSON    settingIPGeolocationGetResponseEnvelopeMessagesJSON `json:"-"`
}

func (*SettingIPGeolocationGetResponseEnvelopeMessages) UnmarshalJSON 

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

type SettingIPGeolocationService 

type SettingIPGeolocationService struct {
	Options []option.RequestOption
}

SettingIPGeolocationService 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 NewSettingIPGeolocationService method instead.

func NewSettingIPGeolocationService 

func NewSettingIPGeolocationService(opts ...option.RequestOption) (r *SettingIPGeolocationService)

NewSettingIPGeolocationService 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 (*SettingIPGeolocationService) Edit 

func (r *SettingIPGeolocationService) Edit(ctx context.Context, params SettingIPGeolocationEditParams, opts ...option.RequestOption) (res *ZonesIPGeolocation, err error)

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

func (r *SettingIPGeolocationService) Get(ctx context.Context, query SettingIPGeolocationGetParams, opts ...option.RequestOption) (res *ZonesIPGeolocation, err error)

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

type SettingIPV6EditParams 

type SettingIPV6EditParams struct {
	// Identifier
	ZoneID param.Field[string] `path:"zone_id,required"`
	// Value of the zone setting.
	Value param.Field[SettingIPV6EditParamsValue] `json:"value,required"`
}

func (SettingIPV6EditParams) MarshalJSON 

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

type SettingIPV6EditParamsValue 

type SettingIPV6EditParamsValue string

Value of the zone setting. 

const (
	SettingIPV6EditParamsValueOff SettingIPV6EditParamsValue = "off"
	SettingIPV6EditParamsValueOn  SettingIPV6EditParamsValue = "on"
)

type SettingIPV6EditResponseEnvelope 

type SettingIPV6EditResponseEnvelope struct {
	Errors   []SettingIPV6EditResponseEnvelopeErrors   `json:"errors,required"`
	Messages []SettingIPV6EditResponseEnvelopeMessages `json:"messages,required"`
	// Whether the API call was successful
	Success bool `json:"success,required"`
	// Enable IPv6 on all subdomains that are Cloudflare enabled.
	// (https://support.cloudflare.com/hc/en-us/articles/200168586).
	Result ZonesIPV6                           `json:"result"`
	JSON   settingIPV6EditResponseEnvelopeJSON `json:"-"`
}

func (*SettingIPV6EditResponseEnvelope) UnmarshalJSON 

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

type SettingIPV6EditResponseEnvelopeErrors 

type SettingIPV6EditResponseEnvelopeErrors struct {
	Code    int64                                     `json:"code,required"`
	Message string                                    `json:"message,required"`
	JSON    settingIPV6EditResponseEnvelopeErrorsJSON `json:"-"`
}

func (*SettingIPV6EditResponseEnvelopeErrors) UnmarshalJSON 

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

type SettingIPV6EditResponseEnvelopeMessages 

type SettingIPV6EditResponseEnvelopeMessages struct {
	Code    int64                                       `json:"code,required"`
	Message string                                      `json:"message,required"`
	JSON    settingIPV6EditResponseEnvelopeMessagesJSON `json:"-"`
}

func (*SettingIPV6EditResponseEnvelopeMessages) UnmarshalJSON 

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

type SettingIPV6GetParams 

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

type SettingIPV6GetResponseEnvelope 

type SettingIPV6GetResponseEnvelope struct {
	Errors   []SettingIPV6GetResponseEnvelopeErrors   `json:"errors,required"`
	Messages []SettingIPV6GetResponseEnvelopeMessages `json:"messages,required"`
	// Whether the API call was successful
	Success bool `json:"success,required"`
	// Enable IPv6 on all subdomains that are Cloudflare enabled.
	// (https://support.cloudflare.com/hc/en-us/articles/200168586).
	Result ZonesIPV6                          `json:"result"`
	JSON   settingIPV6GetResponseEnvelopeJSON `json:"-"`
}

func (*SettingIPV6GetResponseEnvelope) UnmarshalJSON 

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

type SettingIPV6GetResponseEnvelopeErrors 

type SettingIPV6GetResponseEnvelopeErrors struct {
	Code    int64                                    `json:"code,required"`
	Message string                                   `json:"message,required"`
	JSON    settingIPV6GetResponseEnvelopeErrorsJSON `json:"-"`
}

func (*SettingIPV6GetResponseEnvelopeErrors) UnmarshalJSON 

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

type SettingIPV6GetResponseEnvelopeMessages 

type SettingIPV6GetResponseEnvelopeMessages struct {
	Code    int64                                      `json:"code,required"`
	Message string                                     `json:"message,required"`
	JSON    settingIPV6GetResponseEnvelopeMessagesJSON `json:"-"`
}

func (*SettingIPV6GetResponseEnvelopeMessages) UnmarshalJSON 

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

type SettingIPV6Service 

type SettingIPV6Service struct {
	Options []option.RequestOption
}

SettingIPV6Service 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 NewSettingIPV6Service method instead.

func NewSettingIPV6Service 

func NewSettingIPV6Service(opts ...option.RequestOption) (r *SettingIPV6Service)

NewSettingIPV6Service 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 (*SettingIPV6Service) Edit 

func (r *SettingIPV6Service) Edit(ctx context.Context, params SettingIPV6EditParams, opts ...option.RequestOption) (res *ZonesIPV6, err error)

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

func (*SettingIPV6Service) Get 

func (r *SettingIPV6Service) Get(ctx context.Context, query SettingIPV6GetParams, opts ...option.RequestOption) (res *ZonesIPV6, err error)

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

type SettingImageResizingEditParams 

type SettingImageResizingEditParams struct {
	// Identifier
	ZoneID param.Field[string] `path:"zone_id,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.
	Value param.Field[ZonesImageResizingParam] `json:"value,required"`
}

func (SettingImageResizingEditParams) MarshalJSON 

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

type SettingImageResizingEditResponseEnvelope 

type SettingImageResizingEditResponseEnvelope struct {
	Errors   []SettingImageResizingEditResponseEnvelopeErrors   `json:"errors,required"`
	Messages []SettingImageResizingEditResponseEnvelopeMessages `json:"messages,required"`
	// Whether the API call was successful
	Success bool `json:"success,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.
	Result ZonesImageResizing                           `json:"result"`
	JSON   settingImageResizingEditResponseEnvelopeJSON `json:"-"`
}

func (*SettingImageResizingEditResponseEnvelope) UnmarshalJSON 

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

type SettingImageResizingEditResponseEnvelopeErrors 

type SettingImageResizingEditResponseEnvelopeErrors struct {
	Code    int64                                              `json:"code,required"`
	Message string                                             `json:"message,required"`
	JSON    settingImageResizingEditResponseEnvelopeErrorsJSON `json:"-"`
}

func (*SettingImageResizingEditResponseEnvelopeErrors) UnmarshalJSON 

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

type SettingImageResizingEditResponseEnvelopeMessages 

type SettingImageResizingEditResponseEnvelopeMessages struct {
	Code    int64                                                `json:"code,required"`
	Message string                                               `json:"message,required"`
	JSON    settingImageResizingEditResponseEnvelopeMessagesJSON `json:"-"`
}

func (*SettingImageResizingEditResponseEnvelopeMessages) UnmarshalJSON 

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

type SettingImageResizingGetParams 

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

type SettingImageResizingGetResponseEnvelope 

type SettingImageResizingGetResponseEnvelope struct {
	Errors   []SettingImageResizingGetResponseEnvelopeErrors   `json:"errors,required"`
	Messages []SettingImageResizingGetResponseEnvelopeMessages `json:"messages,required"`
	// Whether the API call was successful
	Success bool `json:"success,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.
	Result ZonesImageResizing                          `json:"result"`
	JSON   settingImageResizingGetResponseEnvelopeJSON `json:"-"`
}

func (*SettingImageResizingGetResponseEnvelope) UnmarshalJSON 

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

type SettingImageResizingGetResponseEnvelopeErrors 

type SettingImageResizingGetResponseEnvelopeErrors struct {
	Code    int64                                             `json:"code,required"`
	Message string                                            `json:"message,required"`
	JSON    settingImageResizingGetResponseEnvelopeErrorsJSON `json:"-"`
}

func (*SettingImageResizingGetResponseEnvelopeErrors) UnmarshalJSON 

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

type SettingImageResizingGetResponseEnvelopeMessages 

type SettingImageResizingGetResponseEnvelopeMessages struct {
	Code    int64                                               `json:"code,required"`
	Message string                                              `json:"message,required"`
	JSON    settingImageResizingGetResponseEnvelopeMessagesJSON `json:"-"`
}

func (*SettingImageResizingGetResponseEnvelopeMessages) UnmarshalJSON 

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

type SettingImageResizingService 

type SettingImageResizingService struct {
	Options []option.RequestOption
}

SettingImageResizingService 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 NewSettingImageResizingService method instead.

func NewSettingImageResizingService 

func NewSettingImageResizingService(opts ...option.RequestOption) (r *SettingImageResizingService)

NewSettingImageResizingService 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 (*SettingImageResizingService) Edit 

func (r *SettingImageResizingService) Edit(ctx context.Context, params SettingImageResizingEditParams, opts ...option.RequestOption) (res *ZonesImageResizing, err error)

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

func (r *SettingImageResizingService) Get(ctx context.Context, query SettingImageResizingGetParams, opts ...option.RequestOption) (res *ZonesImageResizing, err error)

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.

type SettingMinTLSVersionEditParams 

type SettingMinTLSVersionEditParams struct {
	// Identifier
	ZoneID param.Field[string] `path:"zone_id,required"`
	// Value of the zone setting.
	Value param.Field[SettingMinTLSVersionEditParamsValue] `json:"value,required"`
}

func (SettingMinTLSVersionEditParams) MarshalJSON 

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

type SettingMinTLSVersionEditParamsValue 

type SettingMinTLSVersionEditParamsValue string

Value of the zone setting. 

const (
	SettingMinTLSVersionEditParamsValue1_0 SettingMinTLSVersionEditParamsValue = "1.0"
	SettingMinTLSVersionEditParamsValue1_1 SettingMinTLSVersionEditParamsValue = "1.1"
	SettingMinTLSVersionEditParamsValue1_2 SettingMinTLSVersionEditParamsValue = "1.2"
	SettingMinTLSVersionEditParamsValue1_3 SettingMinTLSVersionEditParamsValue = "1.3"
)

type SettingMinTLSVersionEditResponseEnvelope 

type SettingMinTLSVersionEditResponseEnvelope struct {
	Errors   []SettingMinTLSVersionEditResponseEnvelopeErrors   `json:"errors,required"`
	Messages []SettingMinTLSVersionEditResponseEnvelopeMessages `json:"messages,required"`
	// Whether the API call was successful
	Success bool `json:"success,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.
	Result ZonesMinTLSVersion                           `json:"result"`
	JSON   settingMinTLSVersionEditResponseEnvelopeJSON `json:"-"`
}

func (*SettingMinTLSVersionEditResponseEnvelope) UnmarshalJSON 

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

type SettingMinTLSVersionEditResponseEnvelopeErrors 

type SettingMinTLSVersionEditResponseEnvelopeErrors struct {
	Code    int64                                              `json:"code,required"`
	Message string                                             `json:"message,required"`
	JSON    settingMinTLSVersionEditResponseEnvelopeErrorsJSON `json:"-"`
}

func (*SettingMinTLSVersionEditResponseEnvelopeErrors) UnmarshalJSON 

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

type SettingMinTLSVersionEditResponseEnvelopeMessages 

type SettingMinTLSVersionEditResponseEnvelopeMessages struct {
	Code    int64                                                `json:"code,required"`
	Message string                                               `json:"message,required"`
	JSON    settingMinTLSVersionEditResponseEnvelopeMessagesJSON `json:"-"`
}

func (*SettingMinTLSVersionEditResponseEnvelopeMessages) UnmarshalJSON 

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

type SettingMinTLSVersionGetParams 

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

type SettingMinTLSVersionGetResponseEnvelope 

type SettingMinTLSVersionGetResponseEnvelope struct {
	Errors   []SettingMinTLSVersionGetResponseEnvelopeErrors   `json:"errors,required"`
	Messages []SettingMinTLSVersionGetResponseEnvelopeMessages `json:"messages,required"`
	// Whether the API call was successful
	Success bool `json:"success,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.
	Result ZonesMinTLSVersion                          `json:"result"`
	JSON   settingMinTLSVersionGetResponseEnvelopeJSON `json:"-"`
}

func (*SettingMinTLSVersionGetResponseEnvelope) UnmarshalJSON 

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

type SettingMinTLSVersionGetResponseEnvelopeErrors 

type SettingMinTLSVersionGetResponseEnvelopeErrors struct {
	Code    int64                                             `json:"code,required"`
	Message string                                            `json:"message,required"`
	JSON    settingMinTLSVersionGetResponseEnvelopeErrorsJSON `json:"-"`
}

func (*SettingMinTLSVersionGetResponseEnvelopeErrors) UnmarshalJSON 

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

type SettingMinTLSVersionGetResponseEnvelopeMessages 

type SettingMinTLSVersionGetResponseEnvelopeMessages struct {
	Code    int64                                               `json:"code,required"`
	Message string                                              `json:"message,required"`
	JSON    settingMinTLSVersionGetResponseEnvelopeMessagesJSON `json:"-"`
}

func (*SettingMinTLSVersionGetResponseEnvelopeMessages) UnmarshalJSON 

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

type SettingMinTLSVersionService 

type SettingMinTLSVersionService struct {
	Options []option.RequestOption
}

SettingMinTLSVersionService 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 NewSettingMinTLSVersionService method instead.

func NewSettingMinTLSVersionService 

func NewSettingMinTLSVersionService(opts ...option.RequestOption) (r *SettingMinTLSVersionService)

NewSettingMinTLSVersionService 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 (*SettingMinTLSVersionService) Edit 

func (r *SettingMinTLSVersionService) Edit(ctx context.Context, params SettingMinTLSVersionEditParams, opts ...option.RequestOption) (res *ZonesMinTLSVersion, err error)

Changes Minimum TLS Version setting.

func (*SettingMinTLSVersionService) Get 

func (r *SettingMinTLSVersionService) Get(ctx context.Context, query SettingMinTLSVersionGetParams, opts ...option.RequestOption) (res *ZonesMinTLSVersion, err error)

Gets Minimum TLS Version setting.

type SettingMinifyEditParams 

type SettingMinifyEditParams struct {
	// Identifier
	ZoneID param.Field[string] `path:"zone_id,required"`
	// Value of the zone setting.
	Value param.Field[SettingMinifyEditParamsValue] `json:"value,required"`
}

func (SettingMinifyEditParams) MarshalJSON 

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

type SettingMinifyEditParamsValue 

type SettingMinifyEditParamsValue struct {
	// Automatically minify all CSS files for your website.
	Css param.Field[SettingMinifyEditParamsValueCss] `json:"css"`
	// Automatically minify all HTML files for your website.
	HTML param.Field[SettingMinifyEditParamsValueHTML] `json:"html"`
	// Automatically minify all JavaScript files for your website.
	Js param.Field[SettingMinifyEditParamsValueJs] `json:"js"`
}

Value of the zone setting.

func (SettingMinifyEditParamsValue) MarshalJSON 

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

type SettingMinifyEditParamsValueCss 

type SettingMinifyEditParamsValueCss string

Automatically minify all CSS files for your website. 

const (
	SettingMinifyEditParamsValueCssOn  SettingMinifyEditParamsValueCss = "on"
	SettingMinifyEditParamsValueCssOff SettingMinifyEditParamsValueCss = "off"
)

type SettingMinifyEditParamsValueHTML 

type SettingMinifyEditParamsValueHTML string

Automatically minify all HTML files for your website. 

const (
	SettingMinifyEditParamsValueHTMLOn  SettingMinifyEditParamsValueHTML = "on"
	SettingMinifyEditParamsValueHTMLOff SettingMinifyEditParamsValueHTML = "off"
)

type SettingMinifyEditParamsValueJs 

type SettingMinifyEditParamsValueJs string

Automatically minify all JavaScript files for your website. 

const (
	SettingMinifyEditParamsValueJsOn  SettingMinifyEditParamsValueJs = "on"
	SettingMinifyEditParamsValueJsOff SettingMinifyEditParamsValueJs = "off"
)

type SettingMinifyEditResponseEnvelope 

type SettingMinifyEditResponseEnvelope struct {
	Errors   []SettingMinifyEditResponseEnvelopeErrors   `json:"errors,required"`
	Messages []SettingMinifyEditResponseEnvelopeMessages `json:"messages,required"`
	// Whether the API call was successful
	Success bool `json:"success,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.
	Result ZonesMinify                           `json:"result"`
	JSON   settingMinifyEditResponseEnvelopeJSON `json:"-"`
}

func (*SettingMinifyEditResponseEnvelope) UnmarshalJSON 

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

type SettingMinifyEditResponseEnvelopeErrors 

type SettingMinifyEditResponseEnvelopeErrors struct {
	Code    int64                                       `json:"code,required"`
	Message string                                      `json:"message,required"`
	JSON    settingMinifyEditResponseEnvelopeErrorsJSON `json:"-"`
}

func (*SettingMinifyEditResponseEnvelopeErrors) UnmarshalJSON 

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

type SettingMinifyEditResponseEnvelopeMessages 

type SettingMinifyEditResponseEnvelopeMessages struct {
	Code    int64                                         `json:"code,required"`
	Message string                                        `json:"message,required"`
	JSON    settingMinifyEditResponseEnvelopeMessagesJSON `json:"-"`
}

func (*SettingMinifyEditResponseEnvelopeMessages) UnmarshalJSON 

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

type SettingMinifyGetParams 

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

type SettingMinifyGetResponseEnvelope 

type SettingMinifyGetResponseEnvelope struct {
	Errors   []SettingMinifyGetResponseEnvelopeErrors   `json:"errors,required"`
	Messages []SettingMinifyGetResponseEnvelopeMessages `json:"messages,required"`
	// Whether the API call was successful
	Success bool `json:"success,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.
	Result ZonesMinify                          `json:"result"`
	JSON   settingMinifyGetResponseEnvelopeJSON `json:"-"`
}

func (*SettingMinifyGetResponseEnvelope) UnmarshalJSON 

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

type SettingMinifyGetResponseEnvelopeErrors 

type SettingMinifyGetResponseEnvelopeErrors struct {
	Code    int64                                      `json:"code,required"`
	Message string                                     `json:"message,required"`
	JSON    settingMinifyGetResponseEnvelopeErrorsJSON `json:"-"`
}

func (*SettingMinifyGetResponseEnvelopeErrors) UnmarshalJSON 

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

type SettingMinifyGetResponseEnvelopeMessages 

type SettingMinifyGetResponseEnvelopeMessages struct {
	Code    int64                                        `json:"code,required"`
	Message string                                       `json:"message,required"`
	JSON    settingMinifyGetResponseEnvelopeMessagesJSON `json:"-"`
}

func (*SettingMinifyGetResponseEnvelopeMessages) UnmarshalJSON 

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

type SettingMinifyService 

type SettingMinifyService struct {
	Options []option.RequestOption
}

SettingMinifyService 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 NewSettingMinifyService method instead.

func NewSettingMinifyService 

func NewSettingMinifyService(opts ...option.RequestOption) (r *SettingMinifyService)

NewSettingMinifyService 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 (*SettingMinifyService) Edit 

func (r *SettingMinifyService) Edit(ctx context.Context, params SettingMinifyEditParams, opts ...option.RequestOption) (res *ZonesMinify, err error)

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

func (r *SettingMinifyService) Get(ctx context.Context, query SettingMinifyGetParams, opts ...option.RequestOption) (res *ZonesMinify, err error)

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.

type SettingMirageEditParams 

type SettingMirageEditParams struct {
	// Identifier
	ZoneID param.Field[string] `path:"zone_id,required"`
	// Value of the zone setting.
	Value param.Field[SettingMirageEditParamsValue] `json:"value,required"`
}

func (SettingMirageEditParams) MarshalJSON 

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

type SettingMirageEditParamsValue 

type SettingMirageEditParamsValue string

Value of the zone setting. 

const (
	SettingMirageEditParamsValueOn  SettingMirageEditParamsValue = "on"
	SettingMirageEditParamsValueOff SettingMirageEditParamsValue = "off"
)

type SettingMirageEditResponseEnvelope 

type SettingMirageEditResponseEnvelope struct {
	Errors   []SettingMirageEditResponseEnvelopeErrors   `json:"errors,required"`
	Messages []SettingMirageEditResponseEnvelopeMessages `json:"messages,required"`
	// Whether the API call was successful
	Success bool `json:"success,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.
	Result ZonesMirage                           `json:"result"`
	JSON   settingMirageEditResponseEnvelopeJSON `json:"-"`
}

func (*SettingMirageEditResponseEnvelope) UnmarshalJSON 

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

type SettingMirageEditResponseEnvelopeErrors 

type SettingMirageEditResponseEnvelopeErrors struct {
	Code    int64                                       `json:"code,required"`
	Message string                                      `json:"message,required"`
	JSON    settingMirageEditResponseEnvelopeErrorsJSON `json:"-"`
}

func (*SettingMirageEditResponseEnvelopeErrors) UnmarshalJSON 

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

type SettingMirageEditResponseEnvelopeMessages 

type SettingMirageEditResponseEnvelopeMessages struct {
	Code    int64                                         `json:"code,required"`
	Message string                                        `json:"message,required"`
	JSON    settingMirageEditResponseEnvelopeMessagesJSON `json:"-"`
}

func (*SettingMirageEditResponseEnvelopeMessages) UnmarshalJSON 

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

type SettingMirageGetParams 

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

type SettingMirageGetResponseEnvelope 

type SettingMirageGetResponseEnvelope struct {
	Errors   []SettingMirageGetResponseEnvelopeErrors   `json:"errors,required"`
	Messages []SettingMirageGetResponseEnvelopeMessages `json:"messages,required"`
	// Whether the API call was successful
	Success bool `json:"success,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.
	Result ZonesMirage                          `json:"result"`
	JSON   settingMirageGetResponseEnvelopeJSON `json:"-"`
}

func (*SettingMirageGetResponseEnvelope) UnmarshalJSON 

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

type SettingMirageGetResponseEnvelopeErrors 

type SettingMirageGetResponseEnvelopeErrors struct {
	Code    int64                                      `json:"code,required"`
	Message string                                     `json:"message,required"`
	JSON    settingMirageGetResponseEnvelopeErrorsJSON `json:"-"`
}

func (*SettingMirageGetResponseEnvelopeErrors) UnmarshalJSON 

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

type SettingMirageGetResponseEnvelopeMessages 

type SettingMirageGetResponseEnvelopeMessages struct {
	Code    int64                                        `json:"code,required"`
	Message string                                       `json:"message,required"`
	JSON    settingMirageGetResponseEnvelopeMessagesJSON `json:"-"`
}

func (*SettingMirageGetResponseEnvelopeMessages) UnmarshalJSON 

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

type SettingMirageService 

type SettingMirageService struct {
	Options []option.RequestOption
}

SettingMirageService 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 NewSettingMirageService method instead.

func NewSettingMirageService 

func NewSettingMirageService(opts ...option.RequestOption) (r *SettingMirageService)

NewSettingMirageService 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 (*SettingMirageService) Edit 

func (r *SettingMirageService) Edit(ctx context.Context, params SettingMirageEditParams, opts ...option.RequestOption) (res *ZonesMirage, err error)

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

func (r *SettingMirageService) Get(ctx context.Context, query SettingMirageGetParams, opts ...option.RequestOption) (res *ZonesMirage, err error)

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.

type SettingMobileRedirectEditParams 

type SettingMobileRedirectEditParams struct {
	// Identifier
	ZoneID param.Field[string] `path:"zone_id,required"`
	// Value of the zone setting.
	Value param.Field[SettingMobileRedirectEditParamsValue] `json:"value,required"`
}

func (SettingMobileRedirectEditParams) MarshalJSON 

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

type SettingMobileRedirectEditParamsValue 

type SettingMobileRedirectEditParamsValue struct {
	// Which subdomain prefix you wish to redirect visitors on mobile devices to
	// (subdomain must already exist).
	MobileSubdomain param.Field[string] `json:"mobile_subdomain"`
	// Whether or not mobile redirect is enabled.
	Status param.Field[SettingMobileRedirectEditParamsValueStatus] `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"`
}

Value of the zone setting.

func (SettingMobileRedirectEditParamsValue) MarshalJSON 

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

type SettingMobileRedirectEditParamsValueStatus 

type SettingMobileRedirectEditParamsValueStatus string

Whether or not mobile redirect is enabled. 

const (
	SettingMobileRedirectEditParamsValueStatusOn  SettingMobileRedirectEditParamsValueStatus = "on"
	SettingMobileRedirectEditParamsValueStatusOff SettingMobileRedirectEditParamsValueStatus = "off"
)

type SettingMobileRedirectEditResponseEnvelope 

type SettingMobileRedirectEditResponseEnvelope struct {
	Errors   []SettingMobileRedirectEditResponseEnvelopeErrors   `json:"errors,required"`
	Messages []SettingMobileRedirectEditResponseEnvelopeMessages `json:"messages,required"`
	// Whether the API call was successful
	Success bool `json:"success,required"`
	// Automatically redirect visitors on mobile devices to a mobile-optimized
	// subdomain. Refer to
	// [Understanding Cloudflare Mobile Redirect](https://support.cloudflare.com/hc/articles/200168336)
	// for more information.
	Result ZonesMobileRedirect                           `json:"result"`
	JSON   settingMobileRedirectEditResponseEnvelopeJSON `json:"-"`
}

func (*SettingMobileRedirectEditResponseEnvelope) UnmarshalJSON 

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

type SettingMobileRedirectEditResponseEnvelopeErrors 

type SettingMobileRedirectEditResponseEnvelopeErrors struct {
	Code    int64                                               `json:"code,required"`
	Message string                                              `json:"message,required"`
	JSON    settingMobileRedirectEditResponseEnvelopeErrorsJSON `json:"-"`
}

func (*SettingMobileRedirectEditResponseEnvelopeErrors) UnmarshalJSON 

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

type SettingMobileRedirectEditResponseEnvelopeMessages 

type SettingMobileRedirectEditResponseEnvelopeMessages struct {
	Code    int64                                                 `json:"code,required"`
	Message string                                                `json:"message,required"`
	JSON    settingMobileRedirectEditResponseEnvelopeMessagesJSON `json:"-"`
}

func (*SettingMobileRedirectEditResponseEnvelopeMessages) UnmarshalJSON 

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

type SettingMobileRedirectGetParams 

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

type SettingMobileRedirectGetResponseEnvelope 

type SettingMobileRedirectGetResponseEnvelope struct {
	Errors   []SettingMobileRedirectGetResponseEnvelopeErrors   `json:"errors,required"`
	Messages []SettingMobileRedirectGetResponseEnvelopeMessages `json:"messages,required"`
	// Whether the API call was successful
	Success bool `json:"success,required"`
	// Automatically redirect visitors on mobile devices to a mobile-optimized
	// subdomain. Refer to
	// [Understanding Cloudflare Mobile Redirect](https://support.cloudflare.com/hc/articles/200168336)
	// for more information.
	Result ZonesMobileRedirect                          `json:"result"`
	JSON   settingMobileRedirectGetResponseEnvelopeJSON `json:"-"`
}

func (*SettingMobileRedirectGetResponseEnvelope) UnmarshalJSON 

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

type SettingMobileRedirectGetResponseEnvelopeErrors 

type SettingMobileRedirectGetResponseEnvelopeErrors struct {
	Code    int64                                              `json:"code,required"`
	Message string                                             `json:"message,required"`
	JSON    settingMobileRedirectGetResponseEnvelopeErrorsJSON `json:"-"`
}

func (*SettingMobileRedirectGetResponseEnvelopeErrors) UnmarshalJSON 

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

type SettingMobileRedirectGetResponseEnvelopeMessages 

type SettingMobileRedirectGetResponseEnvelopeMessages struct {
	Code    int64                                                `json:"code,required"`
	Message string                                               `json:"message,required"`
	JSON    settingMobileRedirectGetResponseEnvelopeMessagesJSON `json:"-"`
}

func (*SettingMobileRedirectGetResponseEnvelopeMessages) UnmarshalJSON 

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

type SettingMobileRedirectService 

type SettingMobileRedirectService struct {
	Options []option.RequestOption
}

SettingMobileRedirectService 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 NewSettingMobileRedirectService method instead.

func NewSettingMobileRedirectService 

func NewSettingMobileRedirectService(opts ...option.RequestOption) (r *SettingMobileRedirectService)

NewSettingMobileRedirectService 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 (*SettingMobileRedirectService) Edit 

func (r *SettingMobileRedirectService) Edit(ctx context.Context, params SettingMobileRedirectEditParams, opts ...option.RequestOption) (res *ZonesMobileRedirect, err error)

Automatically redirect visitors on mobile devices to a mobile-optimized subdomain. Refer to [Understanding Cloudflare Mobile Redirect](https://support.cloudflare.com/hc/articles/200168336) for more information.

func (*SettingMobileRedirectService) Get 

func (r *SettingMobileRedirectService) Get(ctx context.Context, query SettingMobileRedirectGetParams, opts ...option.RequestOption) (res *ZonesMobileRedirect, err error)

Automatically redirect visitors on mobile devices to a mobile-optimized subdomain. Refer to [Understanding Cloudflare Mobile Redirect](https://support.cloudflare.com/hc/articles/200168336) for more information.

type SettingNELEditParams 

type SettingNELEditParams struct {
	// Identifier
	ZoneID param.Field[string] `path:"zone_id,required"`
	// Enable Network Error Logging reporting on your zone. (Beta)
	Value param.Field[ZonesNELParam] `json:"value,required"`
}

func (SettingNELEditParams) MarshalJSON 

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

type SettingNELEditResponseEnvelope 

type SettingNELEditResponseEnvelope struct {
	Errors   []SettingNELEditResponseEnvelopeErrors   `json:"errors,required"`
	Messages []SettingNELEditResponseEnvelopeMessages `json:"messages,required"`
	// Whether the API call was successful
	Success bool `json:"success,required"`
	// Enable Network Error Logging reporting on your zone. (Beta)
	Result ZonesNEL                           `json:"result"`
	JSON   settingNELEditResponseEnvelopeJSON `json:"-"`
}

func (*SettingNELEditResponseEnvelope) UnmarshalJSON 

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

type SettingNELEditResponseEnvelopeErrors 

type SettingNELEditResponseEnvelopeErrors struct {
	Code    int64                                    `json:"code,required"`
	Message string                                   `json:"message,required"`
	JSON    settingNELEditResponseEnvelopeErrorsJSON `json:"-"`
}

func (*SettingNELEditResponseEnvelopeErrors) UnmarshalJSON 

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

type SettingNELEditResponseEnvelopeMessages 

type SettingNELEditResponseEnvelopeMessages struct {
	Code    int64                                      `json:"code,required"`
	Message string                                     `json:"message,required"`
	JSON    settingNELEditResponseEnvelopeMessagesJSON `json:"-"`
}

func (*SettingNELEditResponseEnvelopeMessages) UnmarshalJSON 

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

type SettingNELGetParams 

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

type SettingNELGetResponseEnvelope 

type SettingNELGetResponseEnvelope struct {
	Errors   []SettingNELGetResponseEnvelopeErrors   `json:"errors,required"`
	Messages []SettingNELGetResponseEnvelopeMessages `json:"messages,required"`
	// Whether the API call was successful
	Success bool `json:"success,required"`
	// Enable Network Error Logging reporting on your zone. (Beta)
	Result ZonesNEL                          `json:"result"`
	JSON   settingNELGetResponseEnvelopeJSON `json:"-"`
}

func (*SettingNELGetResponseEnvelope) UnmarshalJSON 

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

type SettingNELGetResponseEnvelopeErrors 

type SettingNELGetResponseEnvelopeErrors struct {
	Code    int64                                   `json:"code,required"`
	Message string                                  `json:"message,required"`
	JSON    settingNELGetResponseEnvelopeErrorsJSON `json:"-"`
}

func (*SettingNELGetResponseEnvelopeErrors) UnmarshalJSON 

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

type SettingNELGetResponseEnvelopeMessages 

type SettingNELGetResponseEnvelopeMessages struct {
	Code    int64                                     `json:"code,required"`
	Message string                                    `json:"message,required"`
	JSON    settingNELGetResponseEnvelopeMessagesJSON `json:"-"`
}

func (*SettingNELGetResponseEnvelopeMessages) UnmarshalJSON 

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

type SettingNELService 

type SettingNELService struct {
	Options []option.RequestOption
}

SettingNELService 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 NewSettingNELService method instead.

func NewSettingNELService 

func NewSettingNELService(opts ...option.RequestOption) (r *SettingNELService)

NewSettingNELService 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 (*SettingNELService) Edit 

func (r *SettingNELService) Edit(ctx context.Context, params SettingNELEditParams, opts ...option.RequestOption) (res *ZonesNEL, err error)

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

func (*SettingNELService) Get 

func (r *SettingNELService) Get(ctx context.Context, query SettingNELGetParams, opts ...option.RequestOption) (res *ZonesNEL, err error)

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

type SettingOpportunisticEncryptionEditParams 

type SettingOpportunisticEncryptionEditParams struct {
	// Identifier
	ZoneID param.Field[string] `path:"zone_id,required"`
	// Value of the zone setting. Notes: Default value depends on the zone's plan
	// level.
	Value param.Field[SettingOpportunisticEncryptionEditParamsValue] `json:"value,required"`
}

func (SettingOpportunisticEncryptionEditParams) MarshalJSON 

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

type SettingOpportunisticEncryptionEditParamsValue 

type SettingOpportunisticEncryptionEditParamsValue string

Value of the zone setting. Notes: Default value depends on the zone's plan level. 

const (
	SettingOpportunisticEncryptionEditParamsValueOn  SettingOpportunisticEncryptionEditParamsValue = "on"
	SettingOpportunisticEncryptionEditParamsValueOff SettingOpportunisticEncryptionEditParamsValue = "off"
)

type SettingOpportunisticEncryptionEditResponseEnvelope 

type SettingOpportunisticEncryptionEditResponseEnvelope struct {
	Errors   []SettingOpportunisticEncryptionEditResponseEnvelopeErrors   `json:"errors,required"`
	Messages []SettingOpportunisticEncryptionEditResponseEnvelopeMessages `json:"messages,required"`
	// Whether the API call was successful
	Success bool `json:"success,required"`
	// Enables the Opportunistic Encryption feature for a zone.
	Result ZonesOpportunisticEncryption                           `json:"result"`
	JSON   settingOpportunisticEncryptionEditResponseEnvelopeJSON `json:"-"`
}

func (*SettingOpportunisticEncryptionEditResponseEnvelope) UnmarshalJSON 

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

type SettingOpportunisticEncryptionEditResponseEnvelopeErrors 

type SettingOpportunisticEncryptionEditResponseEnvelopeErrors struct {
	Code    int64                                                        `json:"code,required"`
	Message string                                                       `json:"message,required"`
	JSON    settingOpportunisticEncryptionEditResponseEnvelopeErrorsJSON `json:"-"`
}

func (*SettingOpportunisticEncryptionEditResponseEnvelopeErrors) UnmarshalJSON 

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

type SettingOpportunisticEncryptionEditResponseEnvelopeMessages 

type SettingOpportunisticEncryptionEditResponseEnvelopeMessages struct {
	Code    int64                                                          `json:"code,required"`
	Message string                                                         `json:"message,required"`
	JSON    settingOpportunisticEncryptionEditResponseEnvelopeMessagesJSON `json:"-"`
}

func (*SettingOpportunisticEncryptionEditResponseEnvelopeMessages) UnmarshalJSON 

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

type SettingOpportunisticEncryptionGetParams 

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

type SettingOpportunisticEncryptionGetResponseEnvelope 

type SettingOpportunisticEncryptionGetResponseEnvelope struct {
	Errors   []SettingOpportunisticEncryptionGetResponseEnvelopeErrors   `json:"errors,required"`
	Messages []SettingOpportunisticEncryptionGetResponseEnvelopeMessages `json:"messages,required"`
	// Whether the API call was successful
	Success bool `json:"success,required"`
	// Enables the Opportunistic Encryption feature for a zone.
	Result ZonesOpportunisticEncryption                          `json:"result"`
	JSON   settingOpportunisticEncryptionGetResponseEnvelopeJSON `json:"-"`
}

func (*SettingOpportunisticEncryptionGetResponseEnvelope) UnmarshalJSON 

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

type SettingOpportunisticEncryptionGetResponseEnvelopeErrors 

type SettingOpportunisticEncryptionGetResponseEnvelopeErrors struct {
	Code    int64                                                       `json:"code,required"`
	Message string                                                      `json:"message,required"`
	JSON    settingOpportunisticEncryptionGetResponseEnvelopeErrorsJSON `json:"-"`
}

func (*SettingOpportunisticEncryptionGetResponseEnvelopeErrors) UnmarshalJSON 

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

type SettingOpportunisticEncryptionGetResponseEnvelopeMessages 

type SettingOpportunisticEncryptionGetResponseEnvelopeMessages struct {
	Code    int64                                                         `json:"code,required"`
	Message string                                                        `json:"message,required"`
	JSON    settingOpportunisticEncryptionGetResponseEnvelopeMessagesJSON `json:"-"`
}

func (*SettingOpportunisticEncryptionGetResponseEnvelopeMessages) UnmarshalJSON 

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

type SettingOpportunisticEncryptionService 

type SettingOpportunisticEncryptionService struct {
	Options []option.RequestOption
}

SettingOpportunisticEncryptionService 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 NewSettingOpportunisticEncryptionService method instead.

func NewSettingOpportunisticEncryptionService 

func NewSettingOpportunisticEncryptionService(opts ...option.RequestOption) (r *SettingOpportunisticEncryptionService)

NewSettingOpportunisticEncryptionService 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 (*SettingOpportunisticEncryptionService) Edit 

func (r *SettingOpportunisticEncryptionService) Edit(ctx context.Context, params SettingOpportunisticEncryptionEditParams, opts ...option.RequestOption) (res *ZonesOpportunisticEncryption, err error)

Changes Opportunistic Encryption setting.

func (*SettingOpportunisticEncryptionService) Get 

func (r *SettingOpportunisticEncryptionService) Get(ctx context.Context, query SettingOpportunisticEncryptionGetParams, opts ...option.RequestOption) (res *ZonesOpportunisticEncryption, err error)

Gets Opportunistic Encryption setting.

type SettingOpportunisticOnionEditParams 

type SettingOpportunisticOnionEditParams struct {
	// Identifier
	ZoneID param.Field[string] `path:"zone_id,required"`
	// Value of the zone setting. Notes: Default value depends on the zone's plan
	// level.
	Value param.Field[SettingOpportunisticOnionEditParamsValue] `json:"value,required"`
}

func (SettingOpportunisticOnionEditParams) MarshalJSON 

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

type SettingOpportunisticOnionEditParamsValue 

type SettingOpportunisticOnionEditParamsValue string

Value of the zone setting. Notes: Default value depends on the zone's plan level. 

const (
	SettingOpportunisticOnionEditParamsValueOn  SettingOpportunisticOnionEditParamsValue = "on"
	SettingOpportunisticOnionEditParamsValueOff SettingOpportunisticOnionEditParamsValue = "off"
)

type SettingOpportunisticOnionEditResponseEnvelope 

type SettingOpportunisticOnionEditResponseEnvelope struct {
	Errors   []SettingOpportunisticOnionEditResponseEnvelopeErrors   `json:"errors,required"`
	Messages []SettingOpportunisticOnionEditResponseEnvelopeMessages `json:"messages,required"`
	// Whether the API call was successful
	Success bool `json:"success,required"`
	// Add an Alt-Svc header to all legitimate requests from Tor, allowing the
	// connection to use our onion services instead of exit nodes.
	Result ZonesOpportunisticOnion                           `json:"result"`
	JSON   settingOpportunisticOnionEditResponseEnvelopeJSON `json:"-"`
}

func (*SettingOpportunisticOnionEditResponseEnvelope) UnmarshalJSON 

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

type SettingOpportunisticOnionEditResponseEnvelopeErrors 

type SettingOpportunisticOnionEditResponseEnvelopeErrors struct {
	Code    int64                                                   `json:"code,required"`
	Message string                                                  `json:"message,required"`
	JSON    settingOpportunisticOnionEditResponseEnvelopeErrorsJSON `json:"-"`
}

func (*SettingOpportunisticOnionEditResponseEnvelopeErrors) UnmarshalJSON 

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

type SettingOpportunisticOnionEditResponseEnvelopeMessages 

type SettingOpportunisticOnionEditResponseEnvelopeMessages struct {
	Code    int64                                                     `json:"code,required"`
	Message string                                                    `json:"message,required"`
	JSON    settingOpportunisticOnionEditResponseEnvelopeMessagesJSON `json:"-"`
}

func (*SettingOpportunisticOnionEditResponseEnvelopeMessages) UnmarshalJSON 

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

type SettingOpportunisticOnionGetParams 

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

type SettingOpportunisticOnionGetResponseEnvelope 

type SettingOpportunisticOnionGetResponseEnvelope struct {
	Errors   []SettingOpportunisticOnionGetResponseEnvelopeErrors   `json:"errors,required"`
	Messages []SettingOpportunisticOnionGetResponseEnvelopeMessages `json:"messages,required"`
	// Whether the API call was successful
	Success bool `json:"success,required"`
	// Add an Alt-Svc header to all legitimate requests from Tor, allowing the
	// connection to use our onion services instead of exit nodes.
	Result ZonesOpportunisticOnion                          `json:"result"`
	JSON   settingOpportunisticOnionGetResponseEnvelopeJSON `json:"-"`
}

func (*SettingOpportunisticOnionGetResponseEnvelope) UnmarshalJSON 

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

type SettingOpportunisticOnionGetResponseEnvelopeErrors 

type SettingOpportunisticOnionGetResponseEnvelopeErrors struct {
	Code    int64                                                  `json:"code,required"`
	Message string                                                 `json:"message,required"`
	JSON    settingOpportunisticOnionGetResponseEnvelopeErrorsJSON `json:"-"`
}

func (*SettingOpportunisticOnionGetResponseEnvelopeErrors) UnmarshalJSON 

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

type SettingOpportunisticOnionGetResponseEnvelopeMessages 

type SettingOpportunisticOnionGetResponseEnvelopeMessages struct {
	Code    int64                                                    `json:"code,required"`
	Message string                                                   `json:"message,required"`
	JSON    settingOpportunisticOnionGetResponseEnvelopeMessagesJSON `json:"-"`
}

func (*SettingOpportunisticOnionGetResponseEnvelopeMessages) UnmarshalJSON 

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

type SettingOpportunisticOnionService 

type SettingOpportunisticOnionService struct {
	Options []option.RequestOption
}

SettingOpportunisticOnionService 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 NewSettingOpportunisticOnionService method instead.

func NewSettingOpportunisticOnionService 

func NewSettingOpportunisticOnionService(opts ...option.RequestOption) (r *SettingOpportunisticOnionService)

NewSettingOpportunisticOnionService 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 (*SettingOpportunisticOnionService) Edit 

func (r *SettingOpportunisticOnionService) Edit(ctx context.Context, params SettingOpportunisticOnionEditParams, opts ...option.RequestOption) (res *ZonesOpportunisticOnion, err error)

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

func (*SettingOpportunisticOnionService) Get 

func (r *SettingOpportunisticOnionService) Get(ctx context.Context, query SettingOpportunisticOnionGetParams, opts ...option.RequestOption) (res *ZonesOpportunisticOnion, err error)

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

type SettingOrangeToOrangeEditParams 

type SettingOrangeToOrangeEditParams struct {
	// Identifier
	ZoneID param.Field[string] `path:"zone_id,required"`
	// Orange to Orange (O2O) allows zones on Cloudflare to CNAME to other zones also
	// on Cloudflare.
	Value param.Field[ZonesOrangeToOrangeParam] `json:"value,required"`
}

func (SettingOrangeToOrangeEditParams) MarshalJSON 

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

type SettingOrangeToOrangeEditResponseEnvelope 

type SettingOrangeToOrangeEditResponseEnvelope struct {
	Errors   []SettingOrangeToOrangeEditResponseEnvelopeErrors   `json:"errors,required"`
	Messages []SettingOrangeToOrangeEditResponseEnvelopeMessages `json:"messages,required"`
	// Whether the API call was successful
	Success bool `json:"success,required"`
	// Orange to Orange (O2O) allows zones on Cloudflare to CNAME to other zones also
	// on Cloudflare.
	Result ZonesOrangeToOrange                           `json:"result"`
	JSON   settingOrangeToOrangeEditResponseEnvelopeJSON `json:"-"`
}

func (*SettingOrangeToOrangeEditResponseEnvelope) UnmarshalJSON 

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

type SettingOrangeToOrangeEditResponseEnvelopeErrors 

type SettingOrangeToOrangeEditResponseEnvelopeErrors struct {
	Code    int64                                               `json:"code,required"`
	Message string                                              `json:"message,required"`
	JSON    settingOrangeToOrangeEditResponseEnvelopeErrorsJSON `json:"-"`
}

func (*SettingOrangeToOrangeEditResponseEnvelopeErrors) UnmarshalJSON 

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

type SettingOrangeToOrangeEditResponseEnvelopeMessages 

type SettingOrangeToOrangeEditResponseEnvelopeMessages struct {
	Code    int64                                                 `json:"code,required"`
	Message string                                                `json:"message,required"`
	JSON    settingOrangeToOrangeEditResponseEnvelopeMessagesJSON `json:"-"`
}

func (*SettingOrangeToOrangeEditResponseEnvelopeMessages) UnmarshalJSON 

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

type SettingOrangeToOrangeGetParams 

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

type SettingOrangeToOrangeGetResponseEnvelope 

type SettingOrangeToOrangeGetResponseEnvelope struct {
	Errors   []SettingOrangeToOrangeGetResponseEnvelopeErrors   `json:"errors,required"`
	Messages []SettingOrangeToOrangeGetResponseEnvelopeMessages `json:"messages,required"`
	// Whether the API call was successful
	Success bool `json:"success,required"`
	// Orange to Orange (O2O) allows zones on Cloudflare to CNAME to other zones also
	// on Cloudflare.
	Result ZonesOrangeToOrange                          `json:"result"`
	JSON   settingOrangeToOrangeGetResponseEnvelopeJSON `json:"-"`
}

func (*SettingOrangeToOrangeGetResponseEnvelope) UnmarshalJSON 

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

type SettingOrangeToOrangeGetResponseEnvelopeErrors 

type SettingOrangeToOrangeGetResponseEnvelopeErrors struct {
	Code    int64                                              `json:"code,required"`
	Message string                                             `json:"message,required"`
	JSON    settingOrangeToOrangeGetResponseEnvelopeErrorsJSON `json:"-"`
}

func (*SettingOrangeToOrangeGetResponseEnvelopeErrors) UnmarshalJSON 

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

type SettingOrangeToOrangeGetResponseEnvelopeMessages 

type SettingOrangeToOrangeGetResponseEnvelopeMessages struct {
	Code    int64                                                `json:"code,required"`
	Message string                                               `json:"message,required"`
	JSON    settingOrangeToOrangeGetResponseEnvelopeMessagesJSON `json:"-"`
}

func (*SettingOrangeToOrangeGetResponseEnvelopeMessages) UnmarshalJSON 

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

type SettingOrangeToOrangeService 

type SettingOrangeToOrangeService struct {
	Options []option.RequestOption
}

SettingOrangeToOrangeService 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 NewSettingOrangeToOrangeService method instead.

func NewSettingOrangeToOrangeService 

func NewSettingOrangeToOrangeService(opts ...option.RequestOption) (r *SettingOrangeToOrangeService)

NewSettingOrangeToOrangeService 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 (*SettingOrangeToOrangeService) Edit 

func (r *SettingOrangeToOrangeService) Edit(ctx context.Context, params SettingOrangeToOrangeEditParams, opts ...option.RequestOption) (res *ZonesOrangeToOrange, err error)

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

func (*SettingOrangeToOrangeService) Get 

func (r *SettingOrangeToOrangeService) Get(ctx context.Context, query SettingOrangeToOrangeGetParams, opts ...option.RequestOption) (res *ZonesOrangeToOrange, err error)

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

type SettingOriginErrorPagePassThruEditParams 

type SettingOriginErrorPagePassThruEditParams struct {
	// Identifier
	ZoneID param.Field[string] `path:"zone_id,required"`
	// Value of the zone setting.
	Value param.Field[SettingOriginErrorPagePassThruEditParamsValue] `json:"value,required"`
}

func (SettingOriginErrorPagePassThruEditParams) MarshalJSON 

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

type SettingOriginErrorPagePassThruEditParamsValue 

type SettingOriginErrorPagePassThruEditParamsValue string

Value of the zone setting. 

const (
	SettingOriginErrorPagePassThruEditParamsValueOn  SettingOriginErrorPagePassThruEditParamsValue = "on"
	SettingOriginErrorPagePassThruEditParamsValueOff SettingOriginErrorPagePassThruEditParamsValue = "off"
)

type SettingOriginErrorPagePassThruEditResponseEnvelope 

type SettingOriginErrorPagePassThruEditResponseEnvelope struct {
	Errors   []SettingOriginErrorPagePassThruEditResponseEnvelopeErrors   `json:"errors,required"`
	Messages []SettingOriginErrorPagePassThruEditResponseEnvelopeMessages `json:"messages,required"`
	// Whether the API call was successful
	Success bool `json:"success,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.
	Result ZonesOriginErrorPagePassThru                           `json:"result"`
	JSON   settingOriginErrorPagePassThruEditResponseEnvelopeJSON `json:"-"`
}

func (*SettingOriginErrorPagePassThruEditResponseEnvelope) UnmarshalJSON 

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

type SettingOriginErrorPagePassThruEditResponseEnvelopeErrors 

type SettingOriginErrorPagePassThruEditResponseEnvelopeErrors struct {
	Code    int64                                                        `json:"code,required"`
	Message string                                                       `json:"message,required"`
	JSON    settingOriginErrorPagePassThruEditResponseEnvelopeErrorsJSON `json:"-"`
}

func (*SettingOriginErrorPagePassThruEditResponseEnvelopeErrors) UnmarshalJSON 

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

type SettingOriginErrorPagePassThruEditResponseEnvelopeMessages 

type SettingOriginErrorPagePassThruEditResponseEnvelopeMessages struct {
	Code    int64                                                          `json:"code,required"`
	Message string                                                         `json:"message,required"`
	JSON    settingOriginErrorPagePassThruEditResponseEnvelopeMessagesJSON `json:"-"`
}

func (*SettingOriginErrorPagePassThruEditResponseEnvelopeMessages) UnmarshalJSON 

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

type SettingOriginErrorPagePassThruGetParams 

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

type SettingOriginErrorPagePassThruGetResponseEnvelope 

type SettingOriginErrorPagePassThruGetResponseEnvelope struct {
	Errors   []SettingOriginErrorPagePassThruGetResponseEnvelopeErrors   `json:"errors,required"`
	Messages []SettingOriginErrorPagePassThruGetResponseEnvelopeMessages `json:"messages,required"`
	// Whether the API call was successful
	Success bool `json:"success,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.
	Result ZonesOriginErrorPagePassThru                          `json:"result"`
	JSON   settingOriginErrorPagePassThruGetResponseEnvelopeJSON `json:"-"`
}

func (*SettingOriginErrorPagePassThruGetResponseEnvelope) UnmarshalJSON 

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

type SettingOriginErrorPagePassThruGetResponseEnvelopeErrors 

type SettingOriginErrorPagePassThruGetResponseEnvelopeErrors struct {
	Code    int64                                                       `json:"code,required"`
	Message string                                                      `json:"message,required"`
	JSON    settingOriginErrorPagePassThruGetResponseEnvelopeErrorsJSON `json:"-"`
}

func (*SettingOriginErrorPagePassThruGetResponseEnvelopeErrors) UnmarshalJSON 

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

type SettingOriginErrorPagePassThruGetResponseEnvelopeMessages 

type SettingOriginErrorPagePassThruGetResponseEnvelopeMessages struct {
	Code    int64                                                         `json:"code,required"`
	Message string                                                        `json:"message,required"`
	JSON    settingOriginErrorPagePassThruGetResponseEnvelopeMessagesJSON `json:"-"`
}

func (*SettingOriginErrorPagePassThruGetResponseEnvelopeMessages) UnmarshalJSON 

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

type SettingOriginErrorPagePassThruService 

type SettingOriginErrorPagePassThruService struct {
	Options []option.RequestOption
}

SettingOriginErrorPagePassThruService 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 NewSettingOriginErrorPagePassThruService method instead.

func NewSettingOriginErrorPagePassThruService 

func NewSettingOriginErrorPagePassThruService(opts ...option.RequestOption) (r *SettingOriginErrorPagePassThruService)

NewSettingOriginErrorPagePassThruService 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 (*SettingOriginErrorPagePassThruService) Edit 

func (r *SettingOriginErrorPagePassThruService) Edit(ctx context.Context, params SettingOriginErrorPagePassThruEditParams, opts ...option.RequestOption) (res *ZonesOriginErrorPagePassThru, err error)

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

func (r *SettingOriginErrorPagePassThruService) Get(ctx context.Context, query SettingOriginErrorPagePassThruGetParams, opts ...option.RequestOption) (res *ZonesOriginErrorPagePassThru, err error)

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.

type SettingOriginMaxHTTPVersionEditParams 

type SettingOriginMaxHTTPVersionEditParams struct {
	// Identifier
	ZoneID param.Field[string] `path:"zone_id,required"`
	// Value of the Origin Max HTTP Version Setting.
	Value param.Field[SettingOriginMaxHTTPVersionEditParamsValue] `json:"value,required"`
}

func (SettingOriginMaxHTTPVersionEditParams) MarshalJSON 

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

type SettingOriginMaxHTTPVersionEditParamsValue 

type SettingOriginMaxHTTPVersionEditParamsValue string

Value of the Origin Max HTTP Version Setting. 

const (
	SettingOriginMaxHTTPVersionEditParamsValue2 SettingOriginMaxHTTPVersionEditParamsValue = "2"
	SettingOriginMaxHTTPVersionEditParamsValue1 SettingOriginMaxHTTPVersionEditParamsValue = "1"
)

type SettingOriginMaxHTTPVersionEditResponse 

type SettingOriginMaxHTTPVersionEditResponse struct {
	// Value of the zone setting.
	ID SettingOriginMaxHTTPVersionEditResponseID `json:"id,required"`
	// last time this setting was modified.
	ModifiedOn time.Time `json:"modified_on,required,nullable" format:"date-time"`
	// Value of the Origin Max HTTP Version Setting.
	Value SettingOriginMaxHTTPVersionEditResponseValue `json:"value,required"`
	JSON  settingOriginMaxHTTPVersionEditResponseJSON  `json:"-"`
}

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

func (*SettingOriginMaxHTTPVersionEditResponse) UnmarshalJSON 

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

type SettingOriginMaxHTTPVersionEditResponseEnvelope 

type SettingOriginMaxHTTPVersionEditResponseEnvelope struct {
	Errors   []SettingOriginMaxHTTPVersionEditResponseEnvelopeErrors   `json:"errors,required"`
	Messages []SettingOriginMaxHTTPVersionEditResponseEnvelopeMessages `json:"messages,required"`
	// Origin Max HTTP Setting Version sets the highest HTTP version Cloudflare will
	// attempt to use with your origin. This setting allows Cloudflare to make HTTP/2
	// requests to your origin. (Refer to
	// [Enable HTTP/2 to Origin](https://developers.cloudflare.com/cache/how-to/enable-http2-to-origin/),
	// for more information.). The default value is "2" for all plan types except ENT
	// where it is "1"
	Result SettingOriginMaxHTTPVersionEditResponse `json:"result,required"`
	// Whether the API call was successful
	Success SettingOriginMaxHTTPVersionEditResponseEnvelopeSuccess `json:"success,required"`
	JSON    settingOriginMaxHTTPVersionEditResponseEnvelopeJSON    `json:"-"`
}

func (*SettingOriginMaxHTTPVersionEditResponseEnvelope) UnmarshalJSON 

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

type SettingOriginMaxHTTPVersionEditResponseEnvelopeErrors 

type SettingOriginMaxHTTPVersionEditResponseEnvelopeErrors struct {
	Code    int64                                                     `json:"code,required"`
	Message string                                                    `json:"message,required"`
	JSON    settingOriginMaxHTTPVersionEditResponseEnvelopeErrorsJSON `json:"-"`
}

func (*SettingOriginMaxHTTPVersionEditResponseEnvelopeErrors) UnmarshalJSON 

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

type SettingOriginMaxHTTPVersionEditResponseEnvelopeMessages 

type SettingOriginMaxHTTPVersionEditResponseEnvelopeMessages struct {
	Code    int64                                                       `json:"code,required"`
	Message string                                                      `json:"message,required"`
	JSON    settingOriginMaxHTTPVersionEditResponseEnvelopeMessagesJSON `json:"-"`
}

func (*SettingOriginMaxHTTPVersionEditResponseEnvelopeMessages) UnmarshalJSON 

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

type SettingOriginMaxHTTPVersionEditResponseEnvelopeSuccess 

type SettingOriginMaxHTTPVersionEditResponseEnvelopeSuccess bool

Whether the API call was successful 

const (
	SettingOriginMaxHTTPVersionEditResponseEnvelopeSuccessTrue SettingOriginMaxHTTPVersionEditResponseEnvelopeSuccess = true
)

type SettingOriginMaxHTTPVersionEditResponseID 

type SettingOriginMaxHTTPVersionEditResponseID string

Value of the zone setting. 

const (
	SettingOriginMaxHTTPVersionEditResponseIDOriginMaxHTTPVersion SettingOriginMaxHTTPVersionEditResponseID = "origin_max_http_version"
)

type SettingOriginMaxHTTPVersionEditResponseValue 

type SettingOriginMaxHTTPVersionEditResponseValue string

Value of the Origin Max HTTP Version Setting. 

const (
	SettingOriginMaxHTTPVersionEditResponseValue2 SettingOriginMaxHTTPVersionEditResponseValue = "2"
	SettingOriginMaxHTTPVersionEditResponseValue1 SettingOriginMaxHTTPVersionEditResponseValue = "1"
)

type SettingOriginMaxHTTPVersionGetParams 

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

type SettingOriginMaxHTTPVersionGetResponse 

type SettingOriginMaxHTTPVersionGetResponse struct {
	// Value of the zone setting.
	ID SettingOriginMaxHTTPVersionGetResponseID `json:"id,required"`
	// last time this setting was modified.
	ModifiedOn time.Time `json:"modified_on,required,nullable" format:"date-time"`
	// Value of the Origin Max HTTP Version Setting.
	Value SettingOriginMaxHTTPVersionGetResponseValue `json:"value,required"`
	JSON  settingOriginMaxHTTPVersionGetResponseJSON  `json:"-"`
}

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

func (*SettingOriginMaxHTTPVersionGetResponse) UnmarshalJSON 

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

type SettingOriginMaxHTTPVersionGetResponseEnvelope 

type SettingOriginMaxHTTPVersionGetResponseEnvelope struct {
	Errors   []SettingOriginMaxHTTPVersionGetResponseEnvelopeErrors   `json:"errors,required"`
	Messages []SettingOriginMaxHTTPVersionGetResponseEnvelopeMessages `json:"messages,required"`
	// Origin Max HTTP Setting Version sets the highest HTTP version Cloudflare will
	// attempt to use with your origin. This setting allows Cloudflare to make HTTP/2
	// requests to your origin. (Refer to
	// [Enable HTTP/2 to Origin](https://developers.cloudflare.com/cache/how-to/enable-http2-to-origin/),
	// for more information.). The default value is "2" for all plan types except ENT
	// where it is "1"
	Result SettingOriginMaxHTTPVersionGetResponse `json:"result,required"`
	// Whether the API call was successful
	Success SettingOriginMaxHTTPVersionGetResponseEnvelopeSuccess `json:"success,required"`
	JSON    settingOriginMaxHTTPVersionGetResponseEnvelopeJSON    `json:"-"`
}

func (*SettingOriginMaxHTTPVersionGetResponseEnvelope) UnmarshalJSON 

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

type SettingOriginMaxHTTPVersionGetResponseEnvelopeErrors 

type SettingOriginMaxHTTPVersionGetResponseEnvelopeErrors struct {
	Code    int64                                                    `json:"code,required"`
	Message string                                                   `json:"message,required"`
	JSON    settingOriginMaxHTTPVersionGetResponseEnvelopeErrorsJSON `json:"-"`
}

func (*SettingOriginMaxHTTPVersionGetResponseEnvelopeErrors) UnmarshalJSON 

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

type SettingOriginMaxHTTPVersionGetResponseEnvelopeMessages 

type SettingOriginMaxHTTPVersionGetResponseEnvelopeMessages struct {
	Code    int64                                                      `json:"code,required"`
	Message string                                                     `json:"message,required"`
	JSON    settingOriginMaxHTTPVersionGetResponseEnvelopeMessagesJSON `json:"-"`
}

func (*SettingOriginMaxHTTPVersionGetResponseEnvelopeMessages) UnmarshalJSON 

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

type SettingOriginMaxHTTPVersionGetResponseEnvelopeSuccess 

type SettingOriginMaxHTTPVersionGetResponseEnvelopeSuccess bool

Whether the API call was successful 

const (
	SettingOriginMaxHTTPVersionGetResponseEnvelopeSuccessTrue SettingOriginMaxHTTPVersionGetResponseEnvelopeSuccess = true
)

type SettingOriginMaxHTTPVersionGetResponseID 

type SettingOriginMaxHTTPVersionGetResponseID string

Value of the zone setting. 

const (
	SettingOriginMaxHTTPVersionGetResponseIDOriginMaxHTTPVersion SettingOriginMaxHTTPVersionGetResponseID = "origin_max_http_version"
)

type SettingOriginMaxHTTPVersionGetResponseValue 

type SettingOriginMaxHTTPVersionGetResponseValue string

Value of the Origin Max HTTP Version Setting. 

const (
	SettingOriginMaxHTTPVersionGetResponseValue2 SettingOriginMaxHTTPVersionGetResponseValue = "2"
	SettingOriginMaxHTTPVersionGetResponseValue1 SettingOriginMaxHTTPVersionGetResponseValue = "1"
)

type SettingOriginMaxHTTPVersionService 

type SettingOriginMaxHTTPVersionService struct {
	Options []option.RequestOption
}

SettingOriginMaxHTTPVersionService 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 NewSettingOriginMaxHTTPVersionService method instead.

func NewSettingOriginMaxHTTPVersionService 

func NewSettingOriginMaxHTTPVersionService(opts ...option.RequestOption) (r *SettingOriginMaxHTTPVersionService)

NewSettingOriginMaxHTTPVersionService 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 (*SettingOriginMaxHTTPVersionService) Edit 

func (r *SettingOriginMaxHTTPVersionService) Edit(ctx context.Context, params SettingOriginMaxHTTPVersionEditParams, opts ...option.RequestOption) (res *SettingOriginMaxHTTPVersionEditResponse, err error)

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

func (*SettingOriginMaxHTTPVersionService) Get 

func (r *SettingOriginMaxHTTPVersionService) Get(ctx context.Context, query SettingOriginMaxHTTPVersionGetParams, opts ...option.RequestOption) (res *SettingOriginMaxHTTPVersionGetResponse, err error)

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

type SettingPolishEditParams 

type SettingPolishEditParams struct {
	// Identifier
	ZoneID param.Field[string] `path:"zone_id,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.
	Value param.Field[ZonesPolishParam] `json:"value,required"`
}

func (SettingPolishEditParams) MarshalJSON 

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

type SettingPolishEditResponseEnvelope 

type SettingPolishEditResponseEnvelope struct {
	Errors   []SettingPolishEditResponseEnvelopeErrors   `json:"errors,required"`
	Messages []SettingPolishEditResponseEnvelopeMessages `json:"messages,required"`
	// Whether the API call was successful
	Success bool `json:"success,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.
	Result ZonesPolish                           `json:"result"`
	JSON   settingPolishEditResponseEnvelopeJSON `json:"-"`
}

func (*SettingPolishEditResponseEnvelope) UnmarshalJSON 

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

type SettingPolishEditResponseEnvelopeErrors 

type SettingPolishEditResponseEnvelopeErrors struct {
	Code    int64                                       `json:"code,required"`
	Message string                                      `json:"message,required"`
	JSON    settingPolishEditResponseEnvelopeErrorsJSON `json:"-"`
}

func (*SettingPolishEditResponseEnvelopeErrors) UnmarshalJSON 

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

type SettingPolishEditResponseEnvelopeMessages 

type SettingPolishEditResponseEnvelopeMessages struct {
	Code    int64                                         `json:"code,required"`
	Message string                                        `json:"message,required"`
	JSON    settingPolishEditResponseEnvelopeMessagesJSON `json:"-"`
}

func (*SettingPolishEditResponseEnvelopeMessages) UnmarshalJSON 

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

type SettingPolishGetParams 

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

type SettingPolishGetResponseEnvelope 

type SettingPolishGetResponseEnvelope struct {
	Errors   []SettingPolishGetResponseEnvelopeErrors   `json:"errors,required"`
	Messages []SettingPolishGetResponseEnvelopeMessages `json:"messages,required"`
	// Whether the API call was successful
	Success bool `json:"success,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.
	Result ZonesPolish                          `json:"result"`
	JSON   settingPolishGetResponseEnvelopeJSON `json:"-"`
}

func (*SettingPolishGetResponseEnvelope) UnmarshalJSON 

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

type SettingPolishGetResponseEnvelopeErrors 

type SettingPolishGetResponseEnvelopeErrors struct {
	Code    int64                                      `json:"code,required"`
	Message string                                     `json:"message,required"`
	JSON    settingPolishGetResponseEnvelopeErrorsJSON `json:"-"`
}

func (*SettingPolishGetResponseEnvelopeErrors) UnmarshalJSON 

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

type SettingPolishGetResponseEnvelopeMessages 

type SettingPolishGetResponseEnvelopeMessages struct {
	Code    int64                                        `json:"code,required"`
	Message string                                       `json:"message,required"`
	JSON    settingPolishGetResponseEnvelopeMessagesJSON `json:"-"`
}

func (*SettingPolishGetResponseEnvelopeMessages) UnmarshalJSON 

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

type SettingPolishService 

type SettingPolishService struct {
	Options []option.RequestOption
}

SettingPolishService 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 NewSettingPolishService method instead.

func NewSettingPolishService 

func NewSettingPolishService(opts ...option.RequestOption) (r *SettingPolishService)

NewSettingPolishService 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 (*SettingPolishService) Edit 

func (r *SettingPolishService) Edit(ctx context.Context, params SettingPolishEditParams, opts ...option.RequestOption) (res *ZonesPolish, err error)

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

func (*SettingPolishService) Get 

func (r *SettingPolishService) Get(ctx context.Context, query SettingPolishGetParams, opts ...option.RequestOption) (res *ZonesPolish, err error)

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

type SettingPrefetchPreloadEditParams 

type SettingPrefetchPreloadEditParams struct {
	// Identifier
	ZoneID param.Field[string] `path:"zone_id,required"`
	// Value of the zone setting.
	Value param.Field[SettingPrefetchPreloadEditParamsValue] `json:"value,required"`
}

func (SettingPrefetchPreloadEditParams) MarshalJSON 

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

type SettingPrefetchPreloadEditParamsValue 

type SettingPrefetchPreloadEditParamsValue string

Value of the zone setting. 

const (
	SettingPrefetchPreloadEditParamsValueOn  SettingPrefetchPreloadEditParamsValue = "on"
	SettingPrefetchPreloadEditParamsValueOff SettingPrefetchPreloadEditParamsValue = "off"
)

type SettingPrefetchPreloadEditResponseEnvelope 

type SettingPrefetchPreloadEditResponseEnvelope struct {
	Errors   []SettingPrefetchPreloadEditResponseEnvelopeErrors   `json:"errors,required"`
	Messages []SettingPrefetchPreloadEditResponseEnvelopeMessages `json:"messages,required"`
	// Whether the API call was successful
	Success bool `json:"success,required"`
	// Cloudflare will prefetch any URLs that are included in the response headers.
	// This is limited to Enterprise Zones.
	Result ZonesPrefetchPreload                           `json:"result"`
	JSON   settingPrefetchPreloadEditResponseEnvelopeJSON `json:"-"`
}

func (*SettingPrefetchPreloadEditResponseEnvelope) UnmarshalJSON 

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

type SettingPrefetchPreloadEditResponseEnvelopeErrors 

type SettingPrefetchPreloadEditResponseEnvelopeErrors struct {
	Code    int64                                                `json:"code,required"`
	Message string                                               `json:"message,required"`
	JSON    settingPrefetchPreloadEditResponseEnvelopeErrorsJSON `json:"-"`
}

func (*SettingPrefetchPreloadEditResponseEnvelopeErrors) UnmarshalJSON 

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

type SettingPrefetchPreloadEditResponseEnvelopeMessages 

type SettingPrefetchPreloadEditResponseEnvelopeMessages struct {
	Code    int64                                                  `json:"code,required"`
	Message string                                                 `json:"message,required"`
	JSON    settingPrefetchPreloadEditResponseEnvelopeMessagesJSON `json:"-"`
}

func (*SettingPrefetchPreloadEditResponseEnvelopeMessages) UnmarshalJSON 

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

type SettingPrefetchPreloadGetParams 

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

type SettingPrefetchPreloadGetResponseEnvelope 

type SettingPrefetchPreloadGetResponseEnvelope struct {
	Errors   []SettingPrefetchPreloadGetResponseEnvelopeErrors   `json:"errors,required"`
	Messages []SettingPrefetchPreloadGetResponseEnvelopeMessages `json:"messages,required"`
	// Whether the API call was successful
	Success bool `json:"success,required"`
	// Cloudflare will prefetch any URLs that are included in the response headers.
	// This is limited to Enterprise Zones.
	Result ZonesPrefetchPreload                          `json:"result"`
	JSON   settingPrefetchPreloadGetResponseEnvelopeJSON `json:"-"`
}

func (*SettingPrefetchPreloadGetResponseEnvelope) UnmarshalJSON 

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

type SettingPrefetchPreloadGetResponseEnvelopeErrors 

type SettingPrefetchPreloadGetResponseEnvelopeErrors struct {
	Code    int64                                               `json:"code,required"`
	Message string                                              `json:"message,required"`
	JSON    settingPrefetchPreloadGetResponseEnvelopeErrorsJSON `json:"-"`
}

func (*SettingPrefetchPreloadGetResponseEnvelopeErrors) UnmarshalJSON 

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

type SettingPrefetchPreloadGetResponseEnvelopeMessages 

type SettingPrefetchPreloadGetResponseEnvelopeMessages struct {
	Code    int64                                                 `json:"code,required"`
	Message string                                                `json:"message,required"`
	JSON    settingPrefetchPreloadGetResponseEnvelopeMessagesJSON `json:"-"`
}

func (*SettingPrefetchPreloadGetResponseEnvelopeMessages) UnmarshalJSON 

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

type SettingPrefetchPreloadService 

type SettingPrefetchPreloadService struct {
	Options []option.RequestOption
}

SettingPrefetchPreloadService 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 NewSettingPrefetchPreloadService method instead.

func NewSettingPrefetchPreloadService 

func NewSettingPrefetchPreloadService(opts ...option.RequestOption) (r *SettingPrefetchPreloadService)

NewSettingPrefetchPreloadService 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 (*SettingPrefetchPreloadService) Edit 

func (r *SettingPrefetchPreloadService) Edit(ctx context.Context, params SettingPrefetchPreloadEditParams, opts ...option.RequestOption) (res *ZonesPrefetchPreload, err error)

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

func (*SettingPrefetchPreloadService) Get 

func (r *SettingPrefetchPreloadService) Get(ctx context.Context, query SettingPrefetchPreloadGetParams, opts ...option.RequestOption) (res *ZonesPrefetchPreload, err error)

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

type SettingProxyReadTimeoutEditParams 

type SettingProxyReadTimeoutEditParams struct {
	// Identifier
	ZoneID param.Field[string] `path:"zone_id,required"`
	// Maximum time between two read operations from origin.
	Value param.Field[ZonesProxyReadTimeoutParam] `json:"value,required"`
}

func (SettingProxyReadTimeoutEditParams) MarshalJSON 

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

type SettingProxyReadTimeoutEditResponseEnvelope 

type SettingProxyReadTimeoutEditResponseEnvelope struct {
	Errors   []SettingProxyReadTimeoutEditResponseEnvelopeErrors   `json:"errors,required"`
	Messages []SettingProxyReadTimeoutEditResponseEnvelopeMessages `json:"messages,required"`
	// Whether the API call was successful
	Success bool `json:"success,required"`
	// Maximum time between two read operations from origin.
	Result ZonesProxyReadTimeout                           `json:"result"`
	JSON   settingProxyReadTimeoutEditResponseEnvelopeJSON `json:"-"`
}

func (*SettingProxyReadTimeoutEditResponseEnvelope) UnmarshalJSON 

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

type SettingProxyReadTimeoutEditResponseEnvelopeErrors 

type SettingProxyReadTimeoutEditResponseEnvelopeErrors struct {
	Code    int64                                                 `json:"code,required"`
	Message string                                                `json:"message,required"`
	JSON    settingProxyReadTimeoutEditResponseEnvelopeErrorsJSON `json:"-"`
}

func (*SettingProxyReadTimeoutEditResponseEnvelopeErrors) UnmarshalJSON 

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

type SettingProxyReadTimeoutEditResponseEnvelopeMessages 

type SettingProxyReadTimeoutEditResponseEnvelopeMessages struct {
	Code    int64                                                   `json:"code,required"`
	Message string                                                  `json:"message,required"`
	JSON    settingProxyReadTimeoutEditResponseEnvelopeMessagesJSON `json:"-"`
}

func (*SettingProxyReadTimeoutEditResponseEnvelopeMessages) UnmarshalJSON 

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

type SettingProxyReadTimeoutGetParams 

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

type SettingProxyReadTimeoutGetResponseEnvelope 

type SettingProxyReadTimeoutGetResponseEnvelope struct {
	Errors   []SettingProxyReadTimeoutGetResponseEnvelopeErrors   `json:"errors,required"`
	Messages []SettingProxyReadTimeoutGetResponseEnvelopeMessages `json:"messages,required"`
	// Whether the API call was successful
	Success bool `json:"success,required"`
	// Maximum time between two read operations from origin.
	Result ZonesProxyReadTimeout                          `json:"result"`
	JSON   settingProxyReadTimeoutGetResponseEnvelopeJSON `json:"-"`
}

func (*SettingProxyReadTimeoutGetResponseEnvelope) UnmarshalJSON 

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

type SettingProxyReadTimeoutGetResponseEnvelopeErrors 

type SettingProxyReadTimeoutGetResponseEnvelopeErrors struct {
	Code    int64                                                `json:"code,required"`
	Message string                                               `json:"message,required"`
	JSON    settingProxyReadTimeoutGetResponseEnvelopeErrorsJSON `json:"-"`
}

func (*SettingProxyReadTimeoutGetResponseEnvelopeErrors) UnmarshalJSON 

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

type SettingProxyReadTimeoutGetResponseEnvelopeMessages 

type SettingProxyReadTimeoutGetResponseEnvelopeMessages struct {
	Code    int64                                                  `json:"code,required"`
	Message string                                                 `json:"message,required"`
	JSON    settingProxyReadTimeoutGetResponseEnvelopeMessagesJSON `json:"-"`
}

func (*SettingProxyReadTimeoutGetResponseEnvelopeMessages) UnmarshalJSON 

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

type SettingProxyReadTimeoutService 

type SettingProxyReadTimeoutService struct {
	Options []option.RequestOption
}

SettingProxyReadTimeoutService 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 NewSettingProxyReadTimeoutService method instead.

func NewSettingProxyReadTimeoutService 

func NewSettingProxyReadTimeoutService(opts ...option.RequestOption) (r *SettingProxyReadTimeoutService)

NewSettingProxyReadTimeoutService 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 (*SettingProxyReadTimeoutService) Edit 

func (r *SettingProxyReadTimeoutService) Edit(ctx context.Context, params SettingProxyReadTimeoutEditParams, opts ...option.RequestOption) (res *ZonesProxyReadTimeout, err error)

Maximum time between two read operations from origin.

func (*SettingProxyReadTimeoutService) Get 

func (r *SettingProxyReadTimeoutService) Get(ctx context.Context, query SettingProxyReadTimeoutGetParams, opts ...option.RequestOption) (res *ZonesProxyReadTimeout, err error)

Maximum time between two read operations from origin.

type SettingPseudoIPV4EditParams 

type SettingPseudoIPV4EditParams struct {
	// Identifier
	ZoneID param.Field[string] `path:"zone_id,required"`
	// Value of the Pseudo IPv4 setting.
	Value param.Field[SettingPseudoIPV4EditParamsValue] `json:"value,required"`
}

func (SettingPseudoIPV4EditParams) MarshalJSON 

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

type SettingPseudoIPV4EditParamsValue 

type SettingPseudoIPV4EditParamsValue string

Value of the Pseudo IPv4 setting. 

const (
	SettingPseudoIPV4EditParamsValueOff             SettingPseudoIPV4EditParamsValue = "off"
	SettingPseudoIPV4EditParamsValueAddHeader       SettingPseudoIPV4EditParamsValue = "add_header"
	SettingPseudoIPV4EditParamsValueOverwriteHeader SettingPseudoIPV4EditParamsValue = "overwrite_header"
)

type SettingPseudoIPV4EditResponseEnvelope 

type SettingPseudoIPV4EditResponseEnvelope struct {
	Errors   []SettingPseudoIPV4EditResponseEnvelopeErrors   `json:"errors,required"`
	Messages []SettingPseudoIPV4EditResponseEnvelopeMessages `json:"messages,required"`
	// Whether the API call was successful
	Success bool `json:"success,required"`
	// The value set for the Pseudo IPv4 setting.
	Result ZonesPseudoIPV4                           `json:"result"`
	JSON   settingPseudoIPV4EditResponseEnvelopeJSON `json:"-"`
}

func (*SettingPseudoIPV4EditResponseEnvelope) UnmarshalJSON 

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

type SettingPseudoIPV4EditResponseEnvelopeErrors 

type SettingPseudoIPV4EditResponseEnvelopeErrors struct {
	Code    int64                                           `json:"code,required"`
	Message string                                          `json:"message,required"`
	JSON    settingPseudoIPV4EditResponseEnvelopeErrorsJSON `json:"-"`
}

func (*SettingPseudoIPV4EditResponseEnvelopeErrors) UnmarshalJSON 

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

type SettingPseudoIPV4EditResponseEnvelopeMessages 

type SettingPseudoIPV4EditResponseEnvelopeMessages struct {
	Code    int64                                             `json:"code,required"`
	Message string                                            `json:"message,required"`
	JSON    settingPseudoIPV4EditResponseEnvelopeMessagesJSON `json:"-"`
}

func (*SettingPseudoIPV4EditResponseEnvelopeMessages) UnmarshalJSON 

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

type SettingPseudoIPV4GetParams 

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

type SettingPseudoIPV4GetResponseEnvelope 

type SettingPseudoIPV4GetResponseEnvelope struct {
	Errors   []SettingPseudoIPV4GetResponseEnvelopeErrors   `json:"errors,required"`
	Messages []SettingPseudoIPV4GetResponseEnvelopeMessages `json:"messages,required"`
	// Whether the API call was successful
	Success bool `json:"success,required"`
	// The value set for the Pseudo IPv4 setting.
	Result ZonesPseudoIPV4                          `json:"result"`
	JSON   settingPseudoIPV4GetResponseEnvelopeJSON `json:"-"`
}

func (*SettingPseudoIPV4GetResponseEnvelope) UnmarshalJSON 

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

type SettingPseudoIPV4GetResponseEnvelopeErrors 

type SettingPseudoIPV4GetResponseEnvelopeErrors struct {
	Code    int64                                          `json:"code,required"`
	Message string                                         `json:"message,required"`
	JSON    settingPseudoIPV4GetResponseEnvelopeErrorsJSON `json:"-"`
}

func (*SettingPseudoIPV4GetResponseEnvelopeErrors) UnmarshalJSON 

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

type SettingPseudoIPV4GetResponseEnvelopeMessages 

type SettingPseudoIPV4GetResponseEnvelopeMessages struct {
	Code    int64                                            `json:"code,required"`
	Message string                                           `json:"message,required"`
	JSON    settingPseudoIPV4GetResponseEnvelopeMessagesJSON `json:"-"`
}

func (*SettingPseudoIPV4GetResponseEnvelopeMessages) UnmarshalJSON 

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

type SettingPseudoIPV4Service 

type SettingPseudoIPV4Service struct {
	Options []option.RequestOption
}

SettingPseudoIPV4Service 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 NewSettingPseudoIPV4Service method instead.

func NewSettingPseudoIPV4Service 

func NewSettingPseudoIPV4Service(opts ...option.RequestOption) (r *SettingPseudoIPV4Service)

NewSettingPseudoIPV4Service 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 (*SettingPseudoIPV4Service) Edit 

func (r *SettingPseudoIPV4Service) Edit(ctx context.Context, params SettingPseudoIPV4EditParams, opts ...option.RequestOption) (res *ZonesPseudoIPV4, err error)

Value of the Pseudo IPv4 setting.

func (*SettingPseudoIPV4Service) Get 

func (r *SettingPseudoIPV4Service) Get(ctx context.Context, query SettingPseudoIPV4GetParams, opts ...option.RequestOption) (res *ZonesPseudoIPV4, err error)

Value of the Pseudo IPv4 setting.

type SettingResponseBufferingEditParams 

type SettingResponseBufferingEditParams struct {
	// Identifier
	ZoneID param.Field[string] `path:"zone_id,required"`
	// Value of the zone setting.
	Value param.Field[SettingResponseBufferingEditParamsValue] `json:"value,required"`
}

func (SettingResponseBufferingEditParams) MarshalJSON 

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

type SettingResponseBufferingEditParamsValue 

type SettingResponseBufferingEditParamsValue string

Value of the zone setting. 

const (
	SettingResponseBufferingEditParamsValueOn  SettingResponseBufferingEditParamsValue = "on"
	SettingResponseBufferingEditParamsValueOff SettingResponseBufferingEditParamsValue = "off"
)

type SettingResponseBufferingEditResponseEnvelope 

type SettingResponseBufferingEditResponseEnvelope struct {
	Errors   []SettingResponseBufferingEditResponseEnvelopeErrors   `json:"errors,required"`
	Messages []SettingResponseBufferingEditResponseEnvelopeMessages `json:"messages,required"`
	// Whether the API call was successful
	Success bool `json:"success,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.
	Result ZonesBuffering                                   `json:"result"`
	JSON   settingResponseBufferingEditResponseEnvelopeJSON `json:"-"`
}

func (*SettingResponseBufferingEditResponseEnvelope) UnmarshalJSON 

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

type SettingResponseBufferingEditResponseEnvelopeErrors 

type SettingResponseBufferingEditResponseEnvelopeErrors struct {
	Code    int64                                                  `json:"code,required"`
	Message string                                                 `json:"message,required"`
	JSON    settingResponseBufferingEditResponseEnvelopeErrorsJSON `json:"-"`
}

func (*SettingResponseBufferingEditResponseEnvelopeErrors) UnmarshalJSON 

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

type SettingResponseBufferingEditResponseEnvelopeMessages 

type SettingResponseBufferingEditResponseEnvelopeMessages struct {
	Code    int64                                                    `json:"code,required"`
	Message string                                                   `json:"message,required"`
	JSON    settingResponseBufferingEditResponseEnvelopeMessagesJSON `json:"-"`
}

func (*SettingResponseBufferingEditResponseEnvelopeMessages) UnmarshalJSON 

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

type SettingResponseBufferingGetParams 

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

type SettingResponseBufferingGetResponseEnvelope 

type SettingResponseBufferingGetResponseEnvelope struct {
	Errors   []SettingResponseBufferingGetResponseEnvelopeErrors   `json:"errors,required"`
	Messages []SettingResponseBufferingGetResponseEnvelopeMessages `json:"messages,required"`
	// Whether the API call was successful
	Success bool `json:"success,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.
	Result ZonesBuffering                                  `json:"result"`
	JSON   settingResponseBufferingGetResponseEnvelopeJSON `json:"-"`
}

func (*SettingResponseBufferingGetResponseEnvelope) UnmarshalJSON 

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

type SettingResponseBufferingGetResponseEnvelopeErrors 

type SettingResponseBufferingGetResponseEnvelopeErrors struct {
	Code    int64                                                 `json:"code,required"`
	Message string                                                `json:"message,required"`
	JSON    settingResponseBufferingGetResponseEnvelopeErrorsJSON `json:"-"`
}

func (*SettingResponseBufferingGetResponseEnvelopeErrors) UnmarshalJSON 

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

type SettingResponseBufferingGetResponseEnvelopeMessages 

type SettingResponseBufferingGetResponseEnvelopeMessages struct {
	Code    int64                                                   `json:"code,required"`
	Message string                                                  `json:"message,required"`
	JSON    settingResponseBufferingGetResponseEnvelopeMessagesJSON `json:"-"`
}

func (*SettingResponseBufferingGetResponseEnvelopeMessages) UnmarshalJSON 

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

type SettingResponseBufferingService 

type SettingResponseBufferingService struct {
	Options []option.RequestOption
}

SettingResponseBufferingService 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 NewSettingResponseBufferingService method instead.

func NewSettingResponseBufferingService 

func NewSettingResponseBufferingService(opts ...option.RequestOption) (r *SettingResponseBufferingService)

NewSettingResponseBufferingService 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 (*SettingResponseBufferingService) Edit 

func (r *SettingResponseBufferingService) Edit(ctx context.Context, params SettingResponseBufferingEditParams, opts ...option.RequestOption) (res *ZonesBuffering, err error)

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

func (r *SettingResponseBufferingService) Get(ctx context.Context, query SettingResponseBufferingGetParams, opts ...option.RequestOption) (res *ZonesBuffering, err error)

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.

type SettingRocketLoaderEditParams 

type SettingRocketLoaderEditParams struct {
	// Identifier
	ZoneID param.Field[string] `path:"zone_id,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.
	Value param.Field[ZonesRocketLoaderParam] `json:"value,required"`
}

func (SettingRocketLoaderEditParams) MarshalJSON 

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

type SettingRocketLoaderEditResponseEnvelope 

type SettingRocketLoaderEditResponseEnvelope struct {
	Errors   []SettingRocketLoaderEditResponseEnvelopeErrors   `json:"errors,required"`
	Messages []SettingRocketLoaderEditResponseEnvelopeMessages `json:"messages,required"`
	// Whether the API call was successful
	Success bool `json:"success,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.
	Result ZonesRocketLoader                           `json:"result"`
	JSON   settingRocketLoaderEditResponseEnvelopeJSON `json:"-"`
}

func (*SettingRocketLoaderEditResponseEnvelope) UnmarshalJSON 

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

type SettingRocketLoaderEditResponseEnvelopeErrors 

type SettingRocketLoaderEditResponseEnvelopeErrors struct {
	Code    int64                                             `json:"code,required"`
	Message string                                            `json:"message,required"`
	JSON    settingRocketLoaderEditResponseEnvelopeErrorsJSON `json:"-"`
}

func (*SettingRocketLoaderEditResponseEnvelopeErrors) UnmarshalJSON 

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

type SettingRocketLoaderEditResponseEnvelopeMessages 

type SettingRocketLoaderEditResponseEnvelopeMessages struct {
	Code    int64                                               `json:"code,required"`
	Message string                                              `json:"message,required"`
	JSON    settingRocketLoaderEditResponseEnvelopeMessagesJSON `json:"-"`
}

func (*SettingRocketLoaderEditResponseEnvelopeMessages) UnmarshalJSON 

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

type SettingRocketLoaderGetParams 

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

type SettingRocketLoaderGetResponseEnvelope 

type SettingRocketLoaderGetResponseEnvelope struct {
	Errors   []SettingRocketLoaderGetResponseEnvelopeErrors   `json:"errors,required"`
	Messages []SettingRocketLoaderGetResponseEnvelopeMessages `json:"messages,required"`
	// Whether the API call was successful
	Success bool `json:"success,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.
	Result ZonesRocketLoader                          `json:"result"`
	JSON   settingRocketLoaderGetResponseEnvelopeJSON `json:"-"`
}

func (*SettingRocketLoaderGetResponseEnvelope) UnmarshalJSON 

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

type SettingRocketLoaderGetResponseEnvelopeErrors 

type SettingRocketLoaderGetResponseEnvelopeErrors struct {
	Code    int64                                            `json:"code,required"`
	Message string                                           `json:"message,required"`
	JSON    settingRocketLoaderGetResponseEnvelopeErrorsJSON `json:"-"`
}

func (*SettingRocketLoaderGetResponseEnvelopeErrors) UnmarshalJSON 

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

type SettingRocketLoaderGetResponseEnvelopeMessages 

type SettingRocketLoaderGetResponseEnvelopeMessages struct {
	Code    int64                                              `json:"code,required"`
	Message string                                             `json:"message,required"`
	JSON    settingRocketLoaderGetResponseEnvelopeMessagesJSON `json:"-"`
}

func (*SettingRocketLoaderGetResponseEnvelopeMessages) UnmarshalJSON 

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

type SettingRocketLoaderService 

type SettingRocketLoaderService struct {
	Options []option.RequestOption
}

SettingRocketLoaderService 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 NewSettingRocketLoaderService method instead.

func NewSettingRocketLoaderService 

func NewSettingRocketLoaderService(opts ...option.RequestOption) (r *SettingRocketLoaderService)

NewSettingRocketLoaderService 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 (*SettingRocketLoaderService) Edit 

func (r *SettingRocketLoaderService) Edit(ctx context.Context, params SettingRocketLoaderEditParams, opts ...option.RequestOption) (res *ZonesRocketLoader, err error)

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

func (r *SettingRocketLoaderService) Get(ctx context.Context, query SettingRocketLoaderGetParams, opts ...option.RequestOption) (res *ZonesRocketLoader, err error)

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.

type SettingSSLEditParams 

type SettingSSLEditParams struct {
	// Identifier
	ZoneID param.Field[string] `path:"zone_id,required"`
	// Value of the zone setting. Notes: Depends on the zone's plan level
	Value param.Field[SettingSSLEditParamsValue] `json:"value,required"`
}

func (SettingSSLEditParams) MarshalJSON 

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

type SettingSSLEditParamsValue 

type SettingSSLEditParamsValue string

Value of the zone setting. Notes: Depends on the zone's plan level 

const (
	SettingSSLEditParamsValueOff      SettingSSLEditParamsValue = "off"
	SettingSSLEditParamsValueFlexible SettingSSLEditParamsValue = "flexible"
	SettingSSLEditParamsValueFull     SettingSSLEditParamsValue = "full"
	SettingSSLEditParamsValueStrict   SettingSSLEditParamsValue = "strict"
)

type SettingSSLEditResponseEnvelope 

type SettingSSLEditResponseEnvelope struct {
	Errors   []SettingSSLEditResponseEnvelopeErrors   `json:"errors,required"`
	Messages []SettingSSLEditResponseEnvelopeMessages `json:"messages,required"`
	// Whether the API call was successful
	Success bool `json:"success,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).
	Result ZonesSSL                           `json:"result"`
	JSON   settingSSLEditResponseEnvelopeJSON `json:"-"`
}

func (*SettingSSLEditResponseEnvelope) UnmarshalJSON 

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

type SettingSSLEditResponseEnvelopeErrors 

type SettingSSLEditResponseEnvelopeErrors struct {
	Code    int64                                    `json:"code,required"`
	Message string                                   `json:"message,required"`
	JSON    settingSSLEditResponseEnvelopeErrorsJSON `json:"-"`
}

func (*SettingSSLEditResponseEnvelopeErrors) UnmarshalJSON 

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

type SettingSSLEditResponseEnvelopeMessages 

type SettingSSLEditResponseEnvelopeMessages struct {
	Code    int64                                      `json:"code,required"`
	Message string                                     `json:"message,required"`
	JSON    settingSSLEditResponseEnvelopeMessagesJSON `json:"-"`
}

func (*SettingSSLEditResponseEnvelopeMessages) UnmarshalJSON 

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

type SettingSSLGetParams 

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

type SettingSSLGetResponseEnvelope 

type SettingSSLGetResponseEnvelope struct {
	Errors   []SettingSSLGetResponseEnvelopeErrors   `json:"errors,required"`
	Messages []SettingSSLGetResponseEnvelopeMessages `json:"messages,required"`
	// Whether the API call was successful
	Success bool `json:"success,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).
	Result ZonesSSL                          `json:"result"`
	JSON   settingSSLGetResponseEnvelopeJSON `json:"-"`
}

func (*SettingSSLGetResponseEnvelope) UnmarshalJSON 

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

type SettingSSLGetResponseEnvelopeErrors 

type SettingSSLGetResponseEnvelopeErrors struct {
	Code    int64                                   `json:"code,required"`
	Message string                                  `json:"message,required"`
	JSON    settingSSLGetResponseEnvelopeErrorsJSON `json:"-"`
}

func (*SettingSSLGetResponseEnvelopeErrors) UnmarshalJSON 

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

type SettingSSLGetResponseEnvelopeMessages 

type SettingSSLGetResponseEnvelopeMessages struct {
	Code    int64                                     `json:"code,required"`
	Message string                                    `json:"message,required"`
	JSON    settingSSLGetResponseEnvelopeMessagesJSON `json:"-"`
}

func (*SettingSSLGetResponseEnvelopeMessages) UnmarshalJSON 

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

type SettingSSLRecommenderEditParams 

type SettingSSLRecommenderEditParams struct {
	// Identifier
	ZoneID param.Field[string] `path:"zone_id,required"`
	// 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.
	Value param.Field[ZonesSSLRecommenderParam] `json:"value,required"`
}

func (SettingSSLRecommenderEditParams) MarshalJSON 

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

type SettingSSLRecommenderEditResponseEnvelope 

type SettingSSLRecommenderEditResponseEnvelope struct {
	Errors   []SettingSSLRecommenderEditResponseEnvelopeErrors   `json:"errors,required"`
	Messages []SettingSSLRecommenderEditResponseEnvelopeMessages `json:"messages,required"`
	// Whether the API call was successful
	Success bool `json:"success,required"`
	// 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.
	Result ZonesSSLRecommender                           `json:"result"`
	JSON   settingSSLRecommenderEditResponseEnvelopeJSON `json:"-"`
}

func (*SettingSSLRecommenderEditResponseEnvelope) UnmarshalJSON 

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

type SettingSSLRecommenderEditResponseEnvelopeErrors 

type SettingSSLRecommenderEditResponseEnvelopeErrors struct {
	Code    int64                                               `json:"code,required"`
	Message string                                              `json:"message,required"`
	JSON    settingSSLRecommenderEditResponseEnvelopeErrorsJSON `json:"-"`
}

func (*SettingSSLRecommenderEditResponseEnvelopeErrors) UnmarshalJSON 

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

type SettingSSLRecommenderEditResponseEnvelopeMessages 

type SettingSSLRecommenderEditResponseEnvelopeMessages struct {
	Code    int64                                                 `json:"code,required"`
	Message string                                                `json:"message,required"`
	JSON    settingSSLRecommenderEditResponseEnvelopeMessagesJSON `json:"-"`
}

func (*SettingSSLRecommenderEditResponseEnvelopeMessages) UnmarshalJSON 

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

type SettingSSLRecommenderGetParams 

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

type SettingSSLRecommenderGetResponseEnvelope 

type SettingSSLRecommenderGetResponseEnvelope struct {
	Errors   []SettingSSLRecommenderGetResponseEnvelopeErrors   `json:"errors,required"`
	Messages []SettingSSLRecommenderGetResponseEnvelopeMessages `json:"messages,required"`
	// Whether the API call was successful
	Success bool `json:"success,required"`
	// 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.
	Result ZonesSSLRecommender                          `json:"result"`
	JSON   settingSSLRecommenderGetResponseEnvelopeJSON `json:"-"`
}

func (*SettingSSLRecommenderGetResponseEnvelope) UnmarshalJSON 

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

type SettingSSLRecommenderGetResponseEnvelopeErrors 

type SettingSSLRecommenderGetResponseEnvelopeErrors struct {
	Code    int64                                              `json:"code,required"`
	Message string                                             `json:"message,required"`
	JSON    settingSSLRecommenderGetResponseEnvelopeErrorsJSON `json:"-"`
}

func (*SettingSSLRecommenderGetResponseEnvelopeErrors) UnmarshalJSON 

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

type SettingSSLRecommenderGetResponseEnvelopeMessages 

type SettingSSLRecommenderGetResponseEnvelopeMessages struct {
	Code    int64                                                `json:"code,required"`
	Message string                                               `json:"message,required"`
	JSON    settingSSLRecommenderGetResponseEnvelopeMessagesJSON `json:"-"`
}

func (*SettingSSLRecommenderGetResponseEnvelopeMessages) UnmarshalJSON 

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

type SettingSSLRecommenderService 

type SettingSSLRecommenderService struct {
	Options []option.RequestOption
}

SettingSSLRecommenderService 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 NewSettingSSLRecommenderService method instead.

func NewSettingSSLRecommenderService 

func NewSettingSSLRecommenderService(opts ...option.RequestOption) (r *SettingSSLRecommenderService)

NewSettingSSLRecommenderService 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 (*SettingSSLRecommenderService) Edit 

func (r *SettingSSLRecommenderService) Edit(ctx context.Context, params SettingSSLRecommenderEditParams, opts ...option.RequestOption) (res *ZonesSSLRecommender, err error)

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

func (r *SettingSSLRecommenderService) Get(ctx context.Context, query SettingSSLRecommenderGetParams, opts ...option.RequestOption) (res *ZonesSSLRecommender, err error)

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.

type SettingSSLService 

type SettingSSLService struct {
	Options []option.RequestOption
}

SettingSSLService 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 NewSettingSSLService method instead.

func NewSettingSSLService 

func NewSettingSSLService(opts ...option.RequestOption) (r *SettingSSLService)

NewSettingSSLService 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 (*SettingSSLService) Edit 

func (r *SettingSSLService) Edit(ctx context.Context, params SettingSSLEditParams, opts ...option.RequestOption) (res *ZonesSSL, err error)

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

func (r *SettingSSLService) Get(ctx context.Context, query SettingSSLGetParams, opts ...option.RequestOption) (res *ZonesSSL, err error)

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

type SettingSecurityHeaderEditParams 

type SettingSecurityHeaderEditParams struct {
	// Identifier
	ZoneID param.Field[string]                               `path:"zone_id,required"`
	Value  param.Field[SettingSecurityHeaderEditParamsValue] `json:"value,required"`
}

func (SettingSecurityHeaderEditParams) MarshalJSON 

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

type SettingSecurityHeaderEditParamsValue 

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

func (SettingSecurityHeaderEditParamsValue) MarshalJSON 

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

type SettingSecurityHeaderEditParamsValueStrictTransportSecurity 

type SettingSecurityHeaderEditParamsValueStrictTransportSecurity 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"`
}

Strict Transport Security.

func (SettingSecurityHeaderEditParamsValueStrictTransportSecurity) MarshalJSON 

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

type SettingSecurityHeaderEditResponseEnvelope 

type SettingSecurityHeaderEditResponseEnvelope struct {
	Errors   []SettingSecurityHeaderEditResponseEnvelopeErrors   `json:"errors,required"`
	Messages []SettingSecurityHeaderEditResponseEnvelopeMessages `json:"messages,required"`
	// Whether the API call was successful
	Success bool `json:"success,required"`
	// Cloudflare security header for a zone.
	Result ZonesSecurityHeader                           `json:"result"`
	JSON   settingSecurityHeaderEditResponseEnvelopeJSON `json:"-"`
}

func (*SettingSecurityHeaderEditResponseEnvelope) UnmarshalJSON 

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

type SettingSecurityHeaderEditResponseEnvelopeErrors 

type SettingSecurityHeaderEditResponseEnvelopeErrors struct {
	Code    int64                                               `json:"code,required"`
	Message string                                              `json:"message,required"`
	JSON    settingSecurityHeaderEditResponseEnvelopeErrorsJSON `json:"-"`
}

func (*SettingSecurityHeaderEditResponseEnvelopeErrors) UnmarshalJSON 

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

type SettingSecurityHeaderEditResponseEnvelopeMessages 

type SettingSecurityHeaderEditResponseEnvelopeMessages struct {
	Code    int64                                                 `json:"code,required"`
	Message string                                                `json:"message,required"`
	JSON    settingSecurityHeaderEditResponseEnvelopeMessagesJSON `json:"-"`
}

func (*SettingSecurityHeaderEditResponseEnvelopeMessages) UnmarshalJSON 

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

type SettingSecurityHeaderGetParams 

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

type SettingSecurityHeaderGetResponseEnvelope 

type SettingSecurityHeaderGetResponseEnvelope struct {
	Errors   []SettingSecurityHeaderGetResponseEnvelopeErrors   `json:"errors,required"`
	Messages []SettingSecurityHeaderGetResponseEnvelopeMessages `json:"messages,required"`
	// Whether the API call was successful
	Success bool `json:"success,required"`
	// Cloudflare security header for a zone.
	Result ZonesSecurityHeader                          `json:"result"`
	JSON   settingSecurityHeaderGetResponseEnvelopeJSON `json:"-"`
}

func (*SettingSecurityHeaderGetResponseEnvelope) UnmarshalJSON 

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

type SettingSecurityHeaderGetResponseEnvelopeErrors 

type SettingSecurityHeaderGetResponseEnvelopeErrors struct {
	Code    int64                                              `json:"code,required"`
	Message string                                             `json:"message,required"`
	JSON    settingSecurityHeaderGetResponseEnvelopeErrorsJSON `json:"-"`
}

func (*SettingSecurityHeaderGetResponseEnvelopeErrors) UnmarshalJSON 

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

type SettingSecurityHeaderGetResponseEnvelopeMessages 

type SettingSecurityHeaderGetResponseEnvelopeMessages struct {
	Code    int64                                                `json:"code,required"`
	Message string                                               `json:"message,required"`
	JSON    settingSecurityHeaderGetResponseEnvelopeMessagesJSON `json:"-"`
}

func (*SettingSecurityHeaderGetResponseEnvelopeMessages) UnmarshalJSON 

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

type SettingSecurityHeaderService 

type SettingSecurityHeaderService struct {
	Options []option.RequestOption
}

SettingSecurityHeaderService 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 NewSettingSecurityHeaderService method instead.

func NewSettingSecurityHeaderService 

func NewSettingSecurityHeaderService(opts ...option.RequestOption) (r *SettingSecurityHeaderService)

NewSettingSecurityHeaderService 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 (*SettingSecurityHeaderService) Edit 

func (r *SettingSecurityHeaderService) Edit(ctx context.Context, params SettingSecurityHeaderEditParams, opts ...option.RequestOption) (res *ZonesSecurityHeader, err error)

Cloudflare security header for a zone.

func (*SettingSecurityHeaderService) Get 

func (r *SettingSecurityHeaderService) Get(ctx context.Context, query SettingSecurityHeaderGetParams, opts ...option.RequestOption) (res *ZonesSecurityHeader, err error)

Cloudflare security header for a zone.

type SettingSecurityLevelEditParams 

type SettingSecurityLevelEditParams struct {
	// Identifier
	ZoneID param.Field[string] `path:"zone_id,required"`
	// Value of the zone setting.
	Value param.Field[SettingSecurityLevelEditParamsValue] `json:"value,required"`
}

func (SettingSecurityLevelEditParams) MarshalJSON 

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

type SettingSecurityLevelEditParamsValue 

type SettingSecurityLevelEditParamsValue string

Value of the zone setting. 

const (
	SettingSecurityLevelEditParamsValueOff            SettingSecurityLevelEditParamsValue = "off"
	SettingSecurityLevelEditParamsValueEssentiallyOff SettingSecurityLevelEditParamsValue = "essentially_off"
	SettingSecurityLevelEditParamsValueLow            SettingSecurityLevelEditParamsValue = "low"
	SettingSecurityLevelEditParamsValueMedium         SettingSecurityLevelEditParamsValue = "medium"
	SettingSecurityLevelEditParamsValueHigh           SettingSecurityLevelEditParamsValue = "high"
	SettingSecurityLevelEditParamsValueUnderAttack    SettingSecurityLevelEditParamsValue = "under_attack"
)

type SettingSecurityLevelEditResponseEnvelope 

type SettingSecurityLevelEditResponseEnvelope struct {
	Errors   []SettingSecurityLevelEditResponseEnvelopeErrors   `json:"errors,required"`
	Messages []SettingSecurityLevelEditResponseEnvelopeMessages `json:"messages,required"`
	// Whether the API call was successful
	Success bool `json:"success,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).
	Result ZonesSecurityLevel                           `json:"result"`
	JSON   settingSecurityLevelEditResponseEnvelopeJSON `json:"-"`
}

func (*SettingSecurityLevelEditResponseEnvelope) UnmarshalJSON 

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

type SettingSecurityLevelEditResponseEnvelopeErrors 

type SettingSecurityLevelEditResponseEnvelopeErrors struct {
	Code    int64                                              `json:"code,required"`
	Message string                                             `json:"message,required"`
	JSON    settingSecurityLevelEditResponseEnvelopeErrorsJSON `json:"-"`
}

func (*SettingSecurityLevelEditResponseEnvelopeErrors) UnmarshalJSON 

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

type SettingSecurityLevelEditResponseEnvelopeMessages 

type SettingSecurityLevelEditResponseEnvelopeMessages struct {
	Code    int64                                                `json:"code,required"`
	Message string                                               `json:"message,required"`
	JSON    settingSecurityLevelEditResponseEnvelopeMessagesJSON `json:"-"`
}

func (*SettingSecurityLevelEditResponseEnvelopeMessages) UnmarshalJSON 

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

type SettingSecurityLevelGetParams 

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

type SettingSecurityLevelGetResponseEnvelope 

type SettingSecurityLevelGetResponseEnvelope struct {
	Errors   []SettingSecurityLevelGetResponseEnvelopeErrors   `json:"errors,required"`
	Messages []SettingSecurityLevelGetResponseEnvelopeMessages `json:"messages,required"`
	// Whether the API call was successful
	Success bool `json:"success,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).
	Result ZonesSecurityLevel                          `json:"result"`
	JSON   settingSecurityLevelGetResponseEnvelopeJSON `json:"-"`
}

func (*SettingSecurityLevelGetResponseEnvelope) UnmarshalJSON 

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

type SettingSecurityLevelGetResponseEnvelopeErrors 

type SettingSecurityLevelGetResponseEnvelopeErrors struct {
	Code    int64                                             `json:"code,required"`
	Message string                                            `json:"message,required"`
	JSON    settingSecurityLevelGetResponseEnvelopeErrorsJSON `json:"-"`
}

func (*SettingSecurityLevelGetResponseEnvelopeErrors) UnmarshalJSON 

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

type SettingSecurityLevelGetResponseEnvelopeMessages 

type SettingSecurityLevelGetResponseEnvelopeMessages struct {
	Code    int64                                               `json:"code,required"`
	Message string                                              `json:"message,required"`
	JSON    settingSecurityLevelGetResponseEnvelopeMessagesJSON `json:"-"`
}

func (*SettingSecurityLevelGetResponseEnvelopeMessages) UnmarshalJSON 

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

type SettingSecurityLevelService 

type SettingSecurityLevelService struct {
	Options []option.RequestOption
}

SettingSecurityLevelService 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 NewSettingSecurityLevelService method instead.

func NewSettingSecurityLevelService 

func NewSettingSecurityLevelService(opts ...option.RequestOption) (r *SettingSecurityLevelService)

NewSettingSecurityLevelService 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 (*SettingSecurityLevelService) Edit 

func (r *SettingSecurityLevelService) Edit(ctx context.Context, params SettingSecurityLevelEditParams, opts ...option.RequestOption) (res *ZonesSecurityLevel, err error)

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

func (r *SettingSecurityLevelService) Get(ctx context.Context, query SettingSecurityLevelGetParams, opts ...option.RequestOption) (res *ZonesSecurityLevel, err error)

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

type SettingServerSideExcludeEditParams 

type SettingServerSideExcludeEditParams struct {
	// Identifier
	ZoneID param.Field[string] `path:"zone_id,required"`
	// Value of the zone setting.
	Value param.Field[SettingServerSideExcludeEditParamsValue] `json:"value,required"`
}

func (SettingServerSideExcludeEditParams) MarshalJSON 

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

type SettingServerSideExcludeEditParamsValue 

type SettingServerSideExcludeEditParamsValue string

Value of the zone setting. 

const (
	SettingServerSideExcludeEditParamsValueOn  SettingServerSideExcludeEditParamsValue = "on"
	SettingServerSideExcludeEditParamsValueOff SettingServerSideExcludeEditParamsValue = "off"
)

type SettingServerSideExcludeEditResponseEnvelope 

type SettingServerSideExcludeEditResponseEnvelope struct {
	Errors   []SettingServerSideExcludeEditResponseEnvelopeErrors   `json:"errors,required"`
	Messages []SettingServerSideExcludeEditResponseEnvelopeMessages `json:"messages,required"`
	// Whether the API call was successful
	Success bool `json:"success,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).
	Result ZonesServerSideExclude                           `json:"result"`
	JSON   settingServerSideExcludeEditResponseEnvelopeJSON `json:"-"`
}

func (*SettingServerSideExcludeEditResponseEnvelope) UnmarshalJSON 

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

type SettingServerSideExcludeEditResponseEnvelopeErrors 

type SettingServerSideExcludeEditResponseEnvelopeErrors struct {
	Code    int64                                                  `json:"code,required"`
	Message string                                                 `json:"message,required"`
	JSON    settingServerSideExcludeEditResponseEnvelopeErrorsJSON `json:"-"`
}

func (*SettingServerSideExcludeEditResponseEnvelopeErrors) UnmarshalJSON 

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

type SettingServerSideExcludeEditResponseEnvelopeMessages 

type SettingServerSideExcludeEditResponseEnvelopeMessages struct {
	Code    int64                                                    `json:"code,required"`
	Message string                                                   `json:"message,required"`
	JSON    settingServerSideExcludeEditResponseEnvelopeMessagesJSON `json:"-"`
}

func (*SettingServerSideExcludeEditResponseEnvelopeMessages) UnmarshalJSON 

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

type SettingServerSideExcludeGetParams 

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

type SettingServerSideExcludeGetResponseEnvelope 

type SettingServerSideExcludeGetResponseEnvelope struct {
	Errors   []SettingServerSideExcludeGetResponseEnvelopeErrors   `json:"errors,required"`
	Messages []SettingServerSideExcludeGetResponseEnvelopeMessages `json:"messages,required"`
	// Whether the API call was successful
	Success bool `json:"success,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).
	Result ZonesServerSideExclude                          `json:"result"`
	JSON   settingServerSideExcludeGetResponseEnvelopeJSON `json:"-"`
}

func (*SettingServerSideExcludeGetResponseEnvelope) UnmarshalJSON 

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

type SettingServerSideExcludeGetResponseEnvelopeErrors 

type SettingServerSideExcludeGetResponseEnvelopeErrors struct {
	Code    int64                                                 `json:"code,required"`
	Message string                                                `json:"message,required"`
	JSON    settingServerSideExcludeGetResponseEnvelopeErrorsJSON `json:"-"`
}

func (*SettingServerSideExcludeGetResponseEnvelopeErrors) UnmarshalJSON 

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

type SettingServerSideExcludeGetResponseEnvelopeMessages 

type SettingServerSideExcludeGetResponseEnvelopeMessages struct {
	Code    int64                                                   `json:"code,required"`
	Message string                                                  `json:"message,required"`
	JSON    settingServerSideExcludeGetResponseEnvelopeMessagesJSON `json:"-"`
}

func (*SettingServerSideExcludeGetResponseEnvelopeMessages) UnmarshalJSON 

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

type SettingServerSideExcludeService 

type SettingServerSideExcludeService struct {
	Options []option.RequestOption
}

SettingServerSideExcludeService 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 NewSettingServerSideExcludeService method instead.

func NewSettingServerSideExcludeService 

func NewSettingServerSideExcludeService(opts ...option.RequestOption) (r *SettingServerSideExcludeService)

NewSettingServerSideExcludeService 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 (*SettingServerSideExcludeService) Edit 

func (r *SettingServerSideExcludeService) Edit(ctx context.Context, params SettingServerSideExcludeEditParams, opts ...option.RequestOption) (res *ZonesServerSideExclude, err error)

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

func (r *SettingServerSideExcludeService) Get(ctx context.Context, query SettingServerSideExcludeGetParams, opts ...option.RequestOption) (res *ZonesServerSideExclude, err error)

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

type SettingService 

type SettingService struct {
	Options                       []option.RequestOption
	ZeroRTT                       *SettingZeroRTTService
	AdvancedDDOS                  *SettingAdvancedDDOSService
	AlwaysOnline                  *SettingAlwaysOnlineService
	AlwaysUseHTTPS                *SettingAlwaysUseHTTPSService
	AutomaticHTTPSRewrites        *SettingAutomaticHTTPSRewriteService
	AutomaticPlatformOptimization *SettingAutomaticPlatformOptimizationService
	Brotli                        *SettingBrotliService
	BrowserCacheTTL               *SettingBrowserCacheTTLService
	BrowserCheck                  *SettingBrowserCheckService
	CacheLevel                    *SettingCacheLevelService
	ChallengeTTL                  *SettingChallengeTTLService
	Ciphers                       *SettingCipherService
	DevelopmentMode               *SettingDevelopmentModeService
	EarlyHints                    *SettingEarlyHintService
	EmailObfuscation              *SettingEmailObfuscationService
	H2Prioritization              *SettingH2PrioritizationService
	HotlinkProtection             *SettingHotlinkProtectionService
	HTTP2                         *SettingHTTP2Service
	HTTP3                         *SettingHTTP3Service
	ImageResizing                 *SettingImageResizingService
	IPGeolocation                 *SettingIPGeolocationService
	IPV6                          *SettingIPV6Service
	MinTLSVersion                 *SettingMinTLSVersionService
	Minify                        *SettingMinifyService
	Mirage                        *SettingMirageService
	MobileRedirect                *SettingMobileRedirectService
	NEL                           *SettingNELService
	OpportunisticEncryption       *SettingOpportunisticEncryptionService
	OpportunisticOnion            *SettingOpportunisticOnionService
	OrangeToOrange                *SettingOrangeToOrangeService
	OriginErrorPagePassThru       *SettingOriginErrorPagePassThruService
	OriginMaxHTTPVersion          *SettingOriginMaxHTTPVersionService
	Polish                        *SettingPolishService
	PrefetchPreload               *SettingPrefetchPreloadService
	ProxyReadTimeout              *SettingProxyReadTimeoutService
	PseudoIPV4                    *SettingPseudoIPV4Service
	ResponseBuffering             *SettingResponseBufferingService
	RocketLoader                  *SettingRocketLoaderService
	SecurityHeaders               *SettingSecurityHeaderService
	SecurityLevel                 *SettingSecurityLevelService
	ServerSideExcludes            *SettingServerSideExcludeService
	SortQueryStringForCache       *SettingSortQueryStringForCacheService
	SSL                           *SettingSSLService
	SSLRecommender                *SettingSSLRecommenderService
	TLS1_3                        *SettingTLS1_3Service
	TLSClientAuth                 *SettingTLSClientAuthService
	TrueClientIPHeader            *SettingTrueClientIPHeaderService
	WAF                           *SettingWAFService
	Webp                          *SettingWebpService
	Websocket                     *SettingWebsocketService
	FontSettings                  *SettingFontSettingService
}

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, params SettingEditParams, opts ...option.RequestOption) (res *[]SettingEditResponse, err error)

Edit settings for a zone.

func (*SettingService) Get added in v2.4.0 

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

Available settings for your user in relation to a zone.

type SettingSortQueryStringForCacheEditParams 

type SettingSortQueryStringForCacheEditParams struct {
	// Identifier
	ZoneID param.Field[string] `path:"zone_id,required"`
	// Value of the zone setting.
	Value param.Field[SettingSortQueryStringForCacheEditParamsValue] `json:"value,required"`
}

func (SettingSortQueryStringForCacheEditParams) MarshalJSON 

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

type SettingSortQueryStringForCacheEditParamsValue 

type SettingSortQueryStringForCacheEditParamsValue string

Value of the zone setting. 

const (
	SettingSortQueryStringForCacheEditParamsValueOn  SettingSortQueryStringForCacheEditParamsValue = "on"
	SettingSortQueryStringForCacheEditParamsValueOff SettingSortQueryStringForCacheEditParamsValue = "off"
)

type SettingSortQueryStringForCacheEditResponseEnvelope 

type SettingSortQueryStringForCacheEditResponseEnvelope struct {
	Errors   []SettingSortQueryStringForCacheEditResponseEnvelopeErrors   `json:"errors,required"`
	Messages []SettingSortQueryStringForCacheEditResponseEnvelopeMessages `json:"messages,required"`
	// Whether the API call was successful
	Success bool `json:"success,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.
	Result ZonesSortQueryStringForCache                           `json:"result"`
	JSON   settingSortQueryStringForCacheEditResponseEnvelopeJSON `json:"-"`
}

func (*SettingSortQueryStringForCacheEditResponseEnvelope) UnmarshalJSON 

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

type SettingSortQueryStringForCacheEditResponseEnvelopeErrors 

type SettingSortQueryStringForCacheEditResponseEnvelopeErrors struct {
	Code    int64                                                        `json:"code,required"`
	Message string                                                       `json:"message,required"`
	JSON    settingSortQueryStringForCacheEditResponseEnvelopeErrorsJSON `json:"-"`
}

func (*SettingSortQueryStringForCacheEditResponseEnvelopeErrors) UnmarshalJSON 

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

type SettingSortQueryStringForCacheEditResponseEnvelopeMessages 

type SettingSortQueryStringForCacheEditResponseEnvelopeMessages struct {
	Code    int64                                                          `json:"code,required"`
	Message string                                                         `json:"message,required"`
	JSON    settingSortQueryStringForCacheEditResponseEnvelopeMessagesJSON `json:"-"`
}

func (*SettingSortQueryStringForCacheEditResponseEnvelopeMessages) UnmarshalJSON 

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

type SettingSortQueryStringForCacheGetParams 

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

type SettingSortQueryStringForCacheGetResponseEnvelope 

type SettingSortQueryStringForCacheGetResponseEnvelope struct {
	Errors   []SettingSortQueryStringForCacheGetResponseEnvelopeErrors   `json:"errors,required"`
	Messages []SettingSortQueryStringForCacheGetResponseEnvelopeMessages `json:"messages,required"`
	// Whether the API call was successful
	Success bool `json:"success,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.
	Result ZonesSortQueryStringForCache                          `json:"result"`
	JSON   settingSortQueryStringForCacheGetResponseEnvelopeJSON `json:"-"`
}

func (*SettingSortQueryStringForCacheGetResponseEnvelope) UnmarshalJSON 

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

type SettingSortQueryStringForCacheGetResponseEnvelopeErrors 

type SettingSortQueryStringForCacheGetResponseEnvelopeErrors struct {
	Code    int64                                                       `json:"code,required"`
	Message string                                                      `json:"message,required"`
	JSON    settingSortQueryStringForCacheGetResponseEnvelopeErrorsJSON `json:"-"`
}

func (*SettingSortQueryStringForCacheGetResponseEnvelopeErrors) UnmarshalJSON 

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

type SettingSortQueryStringForCacheGetResponseEnvelopeMessages 

type SettingSortQueryStringForCacheGetResponseEnvelopeMessages struct {
	Code    int64                                                         `json:"code,required"`
	Message string                                                        `json:"message,required"`
	JSON    settingSortQueryStringForCacheGetResponseEnvelopeMessagesJSON `json:"-"`
}

func (*SettingSortQueryStringForCacheGetResponseEnvelopeMessages) UnmarshalJSON 

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

type SettingSortQueryStringForCacheService 

type SettingSortQueryStringForCacheService struct {
	Options []option.RequestOption
}

SettingSortQueryStringForCacheService 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 NewSettingSortQueryStringForCacheService method instead.

func NewSettingSortQueryStringForCacheService 

func NewSettingSortQueryStringForCacheService(opts ...option.RequestOption) (r *SettingSortQueryStringForCacheService)

NewSettingSortQueryStringForCacheService 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 (*SettingSortQueryStringForCacheService) Edit 

func (r *SettingSortQueryStringForCacheService) Edit(ctx context.Context, params SettingSortQueryStringForCacheEditParams, opts ...option.RequestOption) (res *ZonesSortQueryStringForCache, err error)

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

func (r *SettingSortQueryStringForCacheService) Get(ctx context.Context, query SettingSortQueryStringForCacheGetParams, opts ...option.RequestOption) (res *ZonesSortQueryStringForCache, err error)

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.

type SettingTLS1_3EditParams 

type SettingTLS1_3EditParams struct {
	// Identifier
	ZoneID param.Field[string] `path:"zone_id,required"`
	// Value of the zone setting. Notes: Default value depends on the zone's plan
	// level.
	Value param.Field[SettingTls1_3EditParamsValue] `json:"value,required"`
}

func (SettingTLS1_3EditParams) MarshalJSON 

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

type SettingTLS1_3GetParams 

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

type SettingTLS1_3Service 

type SettingTLS1_3Service struct {
	Options []option.RequestOption
}

SettingTLS1_3Service 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 NewSettingTLS1_3Service method instead.

func NewSettingTLS1_3Service 

func NewSettingTLS1_3Service(opts ...option.RequestOption) (r *SettingTLS1_3Service)

NewSettingTLS1_3Service 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 (*SettingTLS1_3Service) Edit 

func (r *SettingTLS1_3Service) Edit(ctx context.Context, params SettingTLS1_3EditParams, opts ...option.RequestOption) (res *ZonesTLS1_3, err error)

Changes TLS 1.3 setting.

func (*SettingTLS1_3Service) Get 

func (r *SettingTLS1_3Service) Get(ctx context.Context, query SettingTLS1_3GetParams, opts ...option.RequestOption) (res *ZonesTLS1_3, err error)

Gets TLS 1.3 setting enabled for a zone.

type SettingTLSClientAuthEditParams 

type SettingTLSClientAuthEditParams struct {
	// Identifier
	ZoneID param.Field[string] `path:"zone_id,required"`
	// value of the zone setting.
	Value param.Field[SettingTLSClientAuthEditParamsValue] `json:"value,required"`
}

func (SettingTLSClientAuthEditParams) MarshalJSON 

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

type SettingTLSClientAuthEditParamsValue 

type SettingTLSClientAuthEditParamsValue string

value of the zone setting. 

const (
	SettingTLSClientAuthEditParamsValueOn  SettingTLSClientAuthEditParamsValue = "on"
	SettingTLSClientAuthEditParamsValueOff SettingTLSClientAuthEditParamsValue = "off"
)

type SettingTLSClientAuthEditResponseEnvelope 

type SettingTLSClientAuthEditResponseEnvelope struct {
	Errors   []SettingTLSClientAuthEditResponseEnvelopeErrors   `json:"errors,required"`
	Messages []SettingTLSClientAuthEditResponseEnvelopeMessages `json:"messages,required"`
	// Whether the API call was successful
	Success bool `json:"success,required"`
	// TLS Client Auth requires Cloudflare to connect to your origin server using a
	// client certificate (Enterprise Only).
	Result ZonesTLSClientAuth                           `json:"result"`
	JSON   settingTLSClientAuthEditResponseEnvelopeJSON `json:"-"`
}

func (*SettingTLSClientAuthEditResponseEnvelope) UnmarshalJSON 

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

type SettingTLSClientAuthEditResponseEnvelopeErrors 

type SettingTLSClientAuthEditResponseEnvelopeErrors struct {
	Code    int64                                              `json:"code,required"`
	Message string                                             `json:"message,required"`
	JSON    settingTLSClientAuthEditResponseEnvelopeErrorsJSON `json:"-"`
}

func (*SettingTLSClientAuthEditResponseEnvelopeErrors) UnmarshalJSON 

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

type SettingTLSClientAuthEditResponseEnvelopeMessages 

type SettingTLSClientAuthEditResponseEnvelopeMessages struct {
	Code    int64                                                `json:"code,required"`
	Message string                                               `json:"message,required"`
	JSON    settingTLSClientAuthEditResponseEnvelopeMessagesJSON `json:"-"`
}

func (*SettingTLSClientAuthEditResponseEnvelopeMessages) UnmarshalJSON 

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

type SettingTLSClientAuthGetParams 

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

type SettingTLSClientAuthGetResponseEnvelope 

type SettingTLSClientAuthGetResponseEnvelope struct {
	Errors   []SettingTLSClientAuthGetResponseEnvelopeErrors   `json:"errors,required"`
	Messages []SettingTLSClientAuthGetResponseEnvelopeMessages `json:"messages,required"`
	// Whether the API call was successful
	Success bool `json:"success,required"`
	// TLS Client Auth requires Cloudflare to connect to your origin server using a
	// client certificate (Enterprise Only).
	Result ZonesTLSClientAuth                          `json:"result"`
	JSON   settingTLSClientAuthGetResponseEnvelopeJSON `json:"-"`
}

func (*SettingTLSClientAuthGetResponseEnvelope) UnmarshalJSON 

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

type SettingTLSClientAuthGetResponseEnvelopeErrors 

type SettingTLSClientAuthGetResponseEnvelopeErrors struct {
	Code    int64                                             `json:"code,required"`
	Message string                                            `json:"message,required"`
	JSON    settingTLSClientAuthGetResponseEnvelopeErrorsJSON `json:"-"`
}

func (*SettingTLSClientAuthGetResponseEnvelopeErrors) UnmarshalJSON 

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

type SettingTLSClientAuthGetResponseEnvelopeMessages 

type SettingTLSClientAuthGetResponseEnvelopeMessages struct {
	Code    int64                                               `json:"code,required"`
	Message string                                              `json:"message,required"`
	JSON    settingTLSClientAuthGetResponseEnvelopeMessagesJSON `json:"-"`
}

func (*SettingTLSClientAuthGetResponseEnvelopeMessages) UnmarshalJSON 

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

type SettingTLSClientAuthService 

type SettingTLSClientAuthService struct {
	Options []option.RequestOption
}

SettingTLSClientAuthService 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 NewSettingTLSClientAuthService method instead.

func NewSettingTLSClientAuthService 

func NewSettingTLSClientAuthService(opts ...option.RequestOption) (r *SettingTLSClientAuthService)

NewSettingTLSClientAuthService 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 (*SettingTLSClientAuthService) Edit 

func (r *SettingTLSClientAuthService) Edit(ctx context.Context, params SettingTLSClientAuthEditParams, opts ...option.RequestOption) (res *ZonesTLSClientAuth, err error)

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

func (*SettingTLSClientAuthService) Get 

func (r *SettingTLSClientAuthService) Get(ctx context.Context, query SettingTLSClientAuthGetParams, opts ...option.RequestOption) (res *ZonesTLSClientAuth, err error)

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

type SettingTls1_3EditParamsValue 

type SettingTls1_3EditParamsValue string

Value of the zone setting. Notes: Default value depends on the zone's plan level. 

const (
	SettingTls1_3EditParamsValueOn  SettingTls1_3EditParamsValue = "on"
	SettingTls1_3EditParamsValueOff SettingTls1_3EditParamsValue = "off"
	SettingTls1_3EditParamsValueZrt SettingTls1_3EditParamsValue = "zrt"
)

type SettingTls1_3EditResponseEnvelope 

type SettingTls1_3EditResponseEnvelope struct {
	Errors   []SettingTls1_3EditResponseEnvelopeErrors   `json:"errors,required"`
	Messages []SettingTls1_3EditResponseEnvelopeMessages `json:"messages,required"`
	// Whether the API call was successful
	Success bool `json:"success,required"`
	// Enables Crypto TLS 1.3 feature for a zone.
	Result ZonesTLS1_3                           `json:"result"`
	JSON   settingTls1_3EditResponseEnvelopeJSON `json:"-"`
}

func (*SettingTls1_3EditResponseEnvelope) UnmarshalJSON 

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

type SettingTls1_3EditResponseEnvelopeErrors 

type SettingTls1_3EditResponseEnvelopeErrors struct {
	Code    int64                                       `json:"code,required"`
	Message string                                      `json:"message,required"`
	JSON    settingTls1_3EditResponseEnvelopeErrorsJSON `json:"-"`
}

func (*SettingTls1_3EditResponseEnvelopeErrors) UnmarshalJSON 

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

type SettingTls1_3EditResponseEnvelopeMessages 

type SettingTls1_3EditResponseEnvelopeMessages struct {
	Code    int64                                         `json:"code,required"`
	Message string                                        `json:"message,required"`
	JSON    settingTls1_3EditResponseEnvelopeMessagesJSON `json:"-"`
}

func (*SettingTls1_3EditResponseEnvelopeMessages) UnmarshalJSON 

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

type SettingTls1_3GetResponseEnvelope 

type SettingTls1_3GetResponseEnvelope struct {
	Errors   []SettingTls1_3GetResponseEnvelopeErrors   `json:"errors,required"`
	Messages []SettingTls1_3GetResponseEnvelopeMessages `json:"messages,required"`
	// Whether the API call was successful
	Success bool `json:"success,required"`
	// Enables Crypto TLS 1.3 feature for a zone.
	Result ZonesTLS1_3                          `json:"result"`
	JSON   settingTls1_3GetResponseEnvelopeJSON `json:"-"`
}

func (*SettingTls1_3GetResponseEnvelope) UnmarshalJSON 

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

type SettingTls1_3GetResponseEnvelopeErrors 

type SettingTls1_3GetResponseEnvelopeErrors struct {
	Code    int64                                      `json:"code,required"`
	Message string                                     `json:"message,required"`
	JSON    settingTls1_3GetResponseEnvelopeErrorsJSON `json:"-"`
}

func (*SettingTls1_3GetResponseEnvelopeErrors) UnmarshalJSON 

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

type SettingTls1_3GetResponseEnvelopeMessages 

type SettingTls1_3GetResponseEnvelopeMessages struct {
	Code    int64                                        `json:"code,required"`
	Message string                                       `json:"message,required"`
	JSON    settingTls1_3GetResponseEnvelopeMessagesJSON `json:"-"`
}

func (*SettingTls1_3GetResponseEnvelopeMessages) UnmarshalJSON 

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

type SettingTrueClientIPHeaderEditParams 

type SettingTrueClientIPHeaderEditParams struct {
	// Identifier
	ZoneID param.Field[string] `path:"zone_id,required"`
	// Value of the zone setting.
	Value param.Field[SettingTrueClientIPHeaderEditParamsValue] `json:"value,required"`
}

func (SettingTrueClientIPHeaderEditParams) MarshalJSON 

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

type SettingTrueClientIPHeaderEditParamsValue 

type SettingTrueClientIPHeaderEditParamsValue string

Value of the zone setting. 

const (
	SettingTrueClientIPHeaderEditParamsValueOn  SettingTrueClientIPHeaderEditParamsValue = "on"
	SettingTrueClientIPHeaderEditParamsValueOff SettingTrueClientIPHeaderEditParamsValue = "off"
)

type SettingTrueClientIPHeaderEditResponseEnvelope 

type SettingTrueClientIPHeaderEditResponseEnvelope struct {
	Errors   []SettingTrueClientIPHeaderEditResponseEnvelopeErrors   `json:"errors,required"`
	Messages []SettingTrueClientIPHeaderEditResponseEnvelopeMessages `json:"messages,required"`
	// Whether the API call was successful
	Success bool `json:"success,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.
	Result ZonesTrueClientIPHeader                           `json:"result"`
	JSON   settingTrueClientIPHeaderEditResponseEnvelopeJSON `json:"-"`
}

func (*SettingTrueClientIPHeaderEditResponseEnvelope) UnmarshalJSON 

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

type SettingTrueClientIPHeaderEditResponseEnvelopeErrors 

type SettingTrueClientIPHeaderEditResponseEnvelopeErrors struct {
	Code    int64                                                   `json:"code,required"`
	Message string                                                  `json:"message,required"`
	JSON    settingTrueClientIPHeaderEditResponseEnvelopeErrorsJSON `json:"-"`
}

func (*SettingTrueClientIPHeaderEditResponseEnvelopeErrors) UnmarshalJSON 

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

type SettingTrueClientIPHeaderEditResponseEnvelopeMessages 

type SettingTrueClientIPHeaderEditResponseEnvelopeMessages struct {
	Code    int64                                                     `json:"code,required"`
	Message string                                                    `json:"message,required"`
	JSON    settingTrueClientIPHeaderEditResponseEnvelopeMessagesJSON `json:"-"`
}

func (*SettingTrueClientIPHeaderEditResponseEnvelopeMessages) UnmarshalJSON 

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

type SettingTrueClientIPHeaderGetParams 

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

type SettingTrueClientIPHeaderGetResponseEnvelope 

type SettingTrueClientIPHeaderGetResponseEnvelope struct {
	Errors   []SettingTrueClientIPHeaderGetResponseEnvelopeErrors   `json:"errors,required"`
	Messages []SettingTrueClientIPHeaderGetResponseEnvelopeMessages `json:"messages,required"`
	// Whether the API call was successful
	Success bool `json:"success,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.
	Result ZonesTrueClientIPHeader                          `json:"result"`
	JSON   settingTrueClientIPHeaderGetResponseEnvelopeJSON `json:"-"`
}

func (*SettingTrueClientIPHeaderGetResponseEnvelope) UnmarshalJSON 

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

type SettingTrueClientIPHeaderGetResponseEnvelopeErrors 

type SettingTrueClientIPHeaderGetResponseEnvelopeErrors struct {
	Code    int64                                                  `json:"code,required"`
	Message string                                                 `json:"message,required"`
	JSON    settingTrueClientIPHeaderGetResponseEnvelopeErrorsJSON `json:"-"`
}

func (*SettingTrueClientIPHeaderGetResponseEnvelopeErrors) UnmarshalJSON 

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

type SettingTrueClientIPHeaderGetResponseEnvelopeMessages 

type SettingTrueClientIPHeaderGetResponseEnvelopeMessages struct {
	Code    int64                                                    `json:"code,required"`
	Message string                                                   `json:"message,required"`
	JSON    settingTrueClientIPHeaderGetResponseEnvelopeMessagesJSON `json:"-"`
}

func (*SettingTrueClientIPHeaderGetResponseEnvelopeMessages) UnmarshalJSON 

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

type SettingTrueClientIPHeaderService 

type SettingTrueClientIPHeaderService struct {
	Options []option.RequestOption
}

SettingTrueClientIPHeaderService 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 NewSettingTrueClientIPHeaderService method instead.

func NewSettingTrueClientIPHeaderService 

func NewSettingTrueClientIPHeaderService(opts ...option.RequestOption) (r *SettingTrueClientIPHeaderService)

NewSettingTrueClientIPHeaderService 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 (*SettingTrueClientIPHeaderService) Edit 

func (r *SettingTrueClientIPHeaderService) Edit(ctx context.Context, params SettingTrueClientIPHeaderEditParams, opts ...option.RequestOption) (res *ZonesTrueClientIPHeader, err error)

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

func (r *SettingTrueClientIPHeaderService) Get(ctx context.Context, query SettingTrueClientIPHeaderGetParams, opts ...option.RequestOption) (res *ZonesTrueClientIPHeader, err error)

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.

type SettingWAFEditParams 

type SettingWAFEditParams struct {
	// Identifier
	ZoneID param.Field[string] `path:"zone_id,required"`
	// Value of the zone setting.
	Value param.Field[SettingWAFEditParamsValue] `json:"value,required"`
}

func (SettingWAFEditParams) MarshalJSON 

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

type SettingWAFEditParamsValue 

type SettingWAFEditParamsValue string

Value of the zone setting. 

const (
	SettingWAFEditParamsValueOn  SettingWAFEditParamsValue = "on"
	SettingWAFEditParamsValueOff SettingWAFEditParamsValue = "off"
)

type SettingWAFEditResponseEnvelope 

type SettingWAFEditResponseEnvelope struct {
	Errors   []SettingWAFEditResponseEnvelopeErrors   `json:"errors,required"`
	Messages []SettingWAFEditResponseEnvelopeMessages `json:"messages,required"`
	// Whether the API call was successful
	Success bool `json:"success,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).
	Result ZonesWAF                           `json:"result"`
	JSON   settingWAFEditResponseEnvelopeJSON `json:"-"`
}

func (*SettingWAFEditResponseEnvelope) UnmarshalJSON 

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

type SettingWAFEditResponseEnvelopeErrors 

type SettingWAFEditResponseEnvelopeErrors struct {
	Code    int64                                    `json:"code,required"`
	Message string                                   `json:"message,required"`
	JSON    settingWAFEditResponseEnvelopeErrorsJSON `json:"-"`
}

func (*SettingWAFEditResponseEnvelopeErrors) UnmarshalJSON 

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

type SettingWAFEditResponseEnvelopeMessages 

type SettingWAFEditResponseEnvelopeMessages struct {
	Code    int64                                      `json:"code,required"`
	Message string                                     `json:"message,required"`
	JSON    settingWAFEditResponseEnvelopeMessagesJSON `json:"-"`
}

func (*SettingWAFEditResponseEnvelopeMessages) UnmarshalJSON 

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

type SettingWAFGetParams 

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

type SettingWAFGetResponseEnvelope 

type SettingWAFGetResponseEnvelope struct {
	Errors   []SettingWAFGetResponseEnvelopeErrors   `json:"errors,required"`
	Messages []SettingWAFGetResponseEnvelopeMessages `json:"messages,required"`
	// Whether the API call was successful
	Success bool `json:"success,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).
	Result ZonesWAF                          `json:"result"`
	JSON   settingWAFGetResponseEnvelopeJSON `json:"-"`
}

func (*SettingWAFGetResponseEnvelope) UnmarshalJSON 

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

type SettingWAFGetResponseEnvelopeErrors 

type SettingWAFGetResponseEnvelopeErrors struct {
	Code    int64                                   `json:"code,required"`
	Message string                                  `json:"message,required"`
	JSON    settingWAFGetResponseEnvelopeErrorsJSON `json:"-"`
}

func (*SettingWAFGetResponseEnvelopeErrors) UnmarshalJSON 

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

type SettingWAFGetResponseEnvelopeMessages 

type SettingWAFGetResponseEnvelopeMessages struct {
	Code    int64                                     `json:"code,required"`
	Message string                                    `json:"message,required"`
	JSON    settingWAFGetResponseEnvelopeMessagesJSON `json:"-"`
}

func (*SettingWAFGetResponseEnvelopeMessages) UnmarshalJSON 

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

type SettingWAFService 

type SettingWAFService struct {
	Options []option.RequestOption
}

SettingWAFService 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 NewSettingWAFService method instead.

func NewSettingWAFService 

func NewSettingWAFService(opts ...option.RequestOption) (r *SettingWAFService)

NewSettingWAFService 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 (*SettingWAFService) Edit 

func (r *SettingWAFService) Edit(ctx context.Context, params SettingWAFEditParams, opts ...option.RequestOption) (res *ZonesWAF, err error)

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

func (r *SettingWAFService) Get(ctx context.Context, query SettingWAFGetParams, opts ...option.RequestOption) (res *ZonesWAF, err error)

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

type SettingWebpEditParams 

type SettingWebpEditParams struct {
	// Identifier
	ZoneID param.Field[string] `path:"zone_id,required"`
	// Value of the zone setting.
	Value param.Field[SettingWebpEditParamsValue] `json:"value,required"`
}

func (SettingWebpEditParams) MarshalJSON 

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

type SettingWebpEditParamsValue 

type SettingWebpEditParamsValue string

Value of the zone setting. 

const (
	SettingWebpEditParamsValueOff SettingWebpEditParamsValue = "off"
	SettingWebpEditParamsValueOn  SettingWebpEditParamsValue = "on"
)

type SettingWebpEditResponseEnvelope 

type SettingWebpEditResponseEnvelope struct {
	Errors   []SettingWebpEditResponseEnvelopeErrors   `json:"errors,required"`
	Messages []SettingWebpEditResponseEnvelopeMessages `json:"messages,required"`
	// Whether the API call was successful
	Success bool `json:"success,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.
	Result ZonesWebp                           `json:"result"`
	JSON   settingWebpEditResponseEnvelopeJSON `json:"-"`
}

func (*SettingWebpEditResponseEnvelope) UnmarshalJSON 

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

type SettingWebpEditResponseEnvelopeErrors 

type SettingWebpEditResponseEnvelopeErrors struct {
	Code    int64                                     `json:"code,required"`
	Message string                                    `json:"message,required"`
	JSON    settingWebpEditResponseEnvelopeErrorsJSON `json:"-"`
}

func (*SettingWebpEditResponseEnvelopeErrors) UnmarshalJSON 

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

type SettingWebpEditResponseEnvelopeMessages 

type SettingWebpEditResponseEnvelopeMessages struct {
	Code    int64                                       `json:"code,required"`
	Message string                                      `json:"message,required"`
	JSON    settingWebpEditResponseEnvelopeMessagesJSON `json:"-"`
}

func (*SettingWebpEditResponseEnvelopeMessages) UnmarshalJSON 

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

type SettingWebpGetParams 

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

type SettingWebpGetResponseEnvelope 

type SettingWebpGetResponseEnvelope struct {
	Errors   []SettingWebpGetResponseEnvelopeErrors   `json:"errors,required"`
	Messages []SettingWebpGetResponseEnvelopeMessages `json:"messages,required"`
	// Whether the API call was successful
	Success bool `json:"success,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.
	Result ZonesWebp                          `json:"result"`
	JSON   settingWebpGetResponseEnvelopeJSON `json:"-"`
}

func (*SettingWebpGetResponseEnvelope) UnmarshalJSON 

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

type SettingWebpGetResponseEnvelopeErrors 

type SettingWebpGetResponseEnvelopeErrors struct {
	Code    int64                                    `json:"code,required"`
	Message string                                   `json:"message,required"`
	JSON    settingWebpGetResponseEnvelopeErrorsJSON `json:"-"`
}

func (*SettingWebpGetResponseEnvelopeErrors) UnmarshalJSON 

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

type SettingWebpGetResponseEnvelopeMessages 

type SettingWebpGetResponseEnvelopeMessages struct {
	Code    int64                                      `json:"code,required"`
	Message string                                     `json:"message,required"`
	JSON    settingWebpGetResponseEnvelopeMessagesJSON `json:"-"`
}

func (*SettingWebpGetResponseEnvelopeMessages) UnmarshalJSON 

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

type SettingWebpService 

type SettingWebpService struct {
	Options []option.RequestOption
}

SettingWebpService 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 NewSettingWebpService method instead.

func NewSettingWebpService 

func NewSettingWebpService(opts ...option.RequestOption) (r *SettingWebpService)

NewSettingWebpService 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 (*SettingWebpService) Edit 

func (r *SettingWebpService) Edit(ctx context.Context, params SettingWebpEditParams, opts ...option.RequestOption) (res *ZonesWebp, err error)

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

func (r *SettingWebpService) Get(ctx context.Context, query SettingWebpGetParams, opts ...option.RequestOption) (res *ZonesWebp, err error)

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.

type SettingWebsocketEditParams 

type SettingWebsocketEditParams struct {
	// Identifier
	ZoneID param.Field[string] `path:"zone_id,required"`
	// Value of the zone setting.
	Value param.Field[SettingWebsocketEditParamsValue] `json:"value,required"`
}

func (SettingWebsocketEditParams) MarshalJSON 

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

type SettingWebsocketEditParamsValue 

type SettingWebsocketEditParamsValue string

Value of the zone setting. 

const (
	SettingWebsocketEditParamsValueOff SettingWebsocketEditParamsValue = "off"
	SettingWebsocketEditParamsValueOn  SettingWebsocketEditParamsValue = "on"
)

type SettingWebsocketEditResponseEnvelope 

type SettingWebsocketEditResponseEnvelope struct {
	Errors   []SettingWebsocketEditResponseEnvelopeErrors   `json:"errors,required"`
	Messages []SettingWebsocketEditResponseEnvelopeMessages `json:"messages,required"`
	// Whether the API call was successful
	Success bool `json:"success,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-).
	Result ZonesWebsockets                          `json:"result"`
	JSON   settingWebsocketEditResponseEnvelopeJSON `json:"-"`
}

func (*SettingWebsocketEditResponseEnvelope) UnmarshalJSON 

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

type SettingWebsocketEditResponseEnvelopeErrors 

type SettingWebsocketEditResponseEnvelopeErrors struct {
	Code    int64                                          `json:"code,required"`
	Message string                                         `json:"message,required"`
	JSON    settingWebsocketEditResponseEnvelopeErrorsJSON `json:"-"`
}

func (*SettingWebsocketEditResponseEnvelopeErrors) UnmarshalJSON 

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

type SettingWebsocketEditResponseEnvelopeMessages 

type SettingWebsocketEditResponseEnvelopeMessages struct {
	Code    int64                                            `json:"code,required"`
	Message string                                           `json:"message,required"`
	JSON    settingWebsocketEditResponseEnvelopeMessagesJSON `json:"-"`
}

func (*SettingWebsocketEditResponseEnvelopeMessages) UnmarshalJSON 

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

type SettingWebsocketGetParams 

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

type SettingWebsocketGetResponseEnvelope 

type SettingWebsocketGetResponseEnvelope struct {
	Errors   []SettingWebsocketGetResponseEnvelopeErrors   `json:"errors,required"`
	Messages []SettingWebsocketGetResponseEnvelopeMessages `json:"messages,required"`
	// Whether the API call was successful
	Success bool `json:"success,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-).
	Result ZonesWebsockets                         `json:"result"`
	JSON   settingWebsocketGetResponseEnvelopeJSON `json:"-"`
}

func (*SettingWebsocketGetResponseEnvelope) UnmarshalJSON 

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

type SettingWebsocketGetResponseEnvelopeErrors 

type SettingWebsocketGetResponseEnvelopeErrors struct {
	Code    int64                                         `json:"code,required"`
	Message string                                        `json:"message,required"`
	JSON    settingWebsocketGetResponseEnvelopeErrorsJSON `json:"-"`
}

func (*SettingWebsocketGetResponseEnvelopeErrors) UnmarshalJSON 

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

type SettingWebsocketGetResponseEnvelopeMessages 

type SettingWebsocketGetResponseEnvelopeMessages struct {
	Code    int64                                           `json:"code,required"`
	Message string                                          `json:"message,required"`
	JSON    settingWebsocketGetResponseEnvelopeMessagesJSON `json:"-"`
}

func (*SettingWebsocketGetResponseEnvelopeMessages) UnmarshalJSON 

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

type SettingWebsocketService 

type SettingWebsocketService struct {
	Options []option.RequestOption
}

SettingWebsocketService 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 NewSettingWebsocketService method instead.

func NewSettingWebsocketService 

func NewSettingWebsocketService(opts ...option.RequestOption) (r *SettingWebsocketService)

NewSettingWebsocketService 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 (*SettingWebsocketService) Edit 

func (r *SettingWebsocketService) Edit(ctx context.Context, params SettingWebsocketEditParams, opts ...option.RequestOption) (res *ZonesWebsockets, err error)

Changes Websockets setting. For more information about Websockets, please refer to [Using Cloudflare with WebSockets](https://support.cloudflare.com/hc/en-us/articles/200169466-Using-Cloudflare-with-WebSockets).

func (*SettingWebsocketService) Get 

func (r *SettingWebsocketService) Get(ctx context.Context, query SettingWebsocketGetParams, opts ...option.RequestOption) (res *ZonesWebsockets, err error)

Gets Websockets setting. For more information about Websockets, please refer to [Using Cloudflare with WebSockets](https://support.cloudflare.com/hc/en-us/articles/200169466-Using-Cloudflare-with-WebSockets).

type SettingZeroRTTEditParams 

type SettingZeroRTTEditParams struct {
	// Identifier
	ZoneID param.Field[string] `path:"zone_id,required"`
	// Value of the 0-RTT setting.
	Value param.Field[SettingZeroRTTEditParamsValue] `json:"value,required"`
}

func (SettingZeroRTTEditParams) MarshalJSON 

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

type SettingZeroRTTEditParamsValue 

type SettingZeroRTTEditParamsValue string

Value of the 0-RTT setting. 

const (
	SettingZeroRTTEditParamsValueOn  SettingZeroRTTEditParamsValue = "on"
	SettingZeroRTTEditParamsValueOff SettingZeroRTTEditParamsValue = "off"
)

type SettingZeroRTTEditResponseEnvelope 

type SettingZeroRTTEditResponseEnvelope struct {
	Errors   []SettingZeroRTTEditResponseEnvelopeErrors   `json:"errors,required"`
	Messages []SettingZeroRTTEditResponseEnvelopeMessages `json:"messages,required"`
	// Whether the API call was successful
	Success bool `json:"success,required"`
	// 0-RTT session resumption enabled for this zone.
	Result Zones0rtt                              `json:"result"`
	JSON   settingZeroRTTEditResponseEnvelopeJSON `json:"-"`
}

func (*SettingZeroRTTEditResponseEnvelope) UnmarshalJSON 

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

type SettingZeroRTTEditResponseEnvelopeErrors 

type SettingZeroRTTEditResponseEnvelopeErrors struct {
	Code    int64                                        `json:"code,required"`
	Message string                                       `json:"message,required"`
	JSON    settingZeroRTTEditResponseEnvelopeErrorsJSON `json:"-"`
}

func (*SettingZeroRTTEditResponseEnvelopeErrors) UnmarshalJSON 

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

type SettingZeroRTTEditResponseEnvelopeMessages 

type SettingZeroRTTEditResponseEnvelopeMessages struct {
	Code    int64                                          `json:"code,required"`
	Message string                                         `json:"message,required"`
	JSON    settingZeroRTTEditResponseEnvelopeMessagesJSON `json:"-"`
}

func (*SettingZeroRTTEditResponseEnvelopeMessages) UnmarshalJSON 

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

type SettingZeroRTTGetParams 

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

type SettingZeroRTTGetResponseEnvelope 

type SettingZeroRTTGetResponseEnvelope struct {
	Errors   []SettingZeroRTTGetResponseEnvelopeErrors   `json:"errors,required"`
	Messages []SettingZeroRTTGetResponseEnvelopeMessages `json:"messages,required"`
	// Whether the API call was successful
	Success bool `json:"success,required"`
	// 0-RTT session resumption enabled for this zone.
	Result Zones0rtt                             `json:"result"`
	JSON   settingZeroRTTGetResponseEnvelopeJSON `json:"-"`
}

func (*SettingZeroRTTGetResponseEnvelope) UnmarshalJSON 

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

type SettingZeroRTTGetResponseEnvelopeErrors 

type SettingZeroRTTGetResponseEnvelopeErrors struct {
	Code    int64                                       `json:"code,required"`
	Message string                                      `json:"message,required"`
	JSON    settingZeroRTTGetResponseEnvelopeErrorsJSON `json:"-"`
}

func (*SettingZeroRTTGetResponseEnvelopeErrors) UnmarshalJSON 

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

type SettingZeroRTTGetResponseEnvelopeMessages 

type SettingZeroRTTGetResponseEnvelopeMessages struct {
	Code    int64                                         `json:"code,required"`
	Message string                                        `json:"message,required"`
	JSON    settingZeroRTTGetResponseEnvelopeMessagesJSON `json:"-"`
}

func (*SettingZeroRTTGetResponseEnvelopeMessages) UnmarshalJSON 

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

type SettingZeroRTTService 

type SettingZeroRTTService struct {
	Options []option.RequestOption
}

SettingZeroRTTService 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 NewSettingZeroRTTService method instead.

func NewSettingZeroRTTService 

func NewSettingZeroRTTService(opts ...option.RequestOption) (r *SettingZeroRTTService)

NewSettingZeroRTTService 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 (*SettingZeroRTTService) Edit 

func (r *SettingZeroRTTService) Edit(ctx context.Context, params SettingZeroRTTEditParams, opts ...option.RequestOption) (res *Zones0rtt, err error)

Changes the 0-RTT session resumption setting.

func (*SettingZeroRTTService) Get 

func (r *SettingZeroRTTService) Get(ctx context.Context, query SettingZeroRTTGetParams, opts ...option.RequestOption) (res *Zones0rtt, err error)

Gets 0-RTT session resumption setting.

type SpeedCloudflareFonts 

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

Enhance your website's font delivery with Cloudflare Fonts. Deliver Google Hosted fonts from your own domain, boost performance, and enhance user privacy. Refer to the Cloudflare Fonts documentation for more information.

func (*SpeedCloudflareFonts) UnmarshalJSON 

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

type SpeedCloudflareFontsEditable 

type SpeedCloudflareFontsEditable bool

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

const (
	SpeedCloudflareFontsEditableTrue  SpeedCloudflareFontsEditable = true
	SpeedCloudflareFontsEditableFalse SpeedCloudflareFontsEditable = false
)

type SpeedCloudflareFontsID 

type SpeedCloudflareFontsID string

ID of the zone setting. 

const (
	SpeedCloudflareFontsIDFonts SpeedCloudflareFontsID = "fonts"
)

type SpeedCloudflareFontsValue 

type SpeedCloudflareFontsValue string

Current value of the zone setting. 

const (
	SpeedCloudflareFontsValueOn  SpeedCloudflareFontsValue = "on"
	SpeedCloudflareFontsValueOff SpeedCloudflareFontsValue = "off"
)

type SubscriptionGetResponse 

type SubscriptionGetResponse interface {
	ImplementsZonesSubscriptionGetResponse()
}

Union satisfied by zones.SubscriptionGetResponseUnknown or shared.UnionString.

type SubscriptionGetResponseEnvelope 

type SubscriptionGetResponseEnvelope struct {
	Errors   []SubscriptionGetResponseEnvelopeErrors   `json:"errors,required"`
	Messages []SubscriptionGetResponseEnvelopeMessages `json:"messages,required"`
	Result   SubscriptionGetResponse                   `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 SubscriptionGetResponseEnvelopeErrors 

type SubscriptionGetResponseEnvelopeErrors struct {
	Code    int64                                     `json:"code,required"`
	Message string                                    `json:"message,required"`
	JSON    subscriptionGetResponseEnvelopeErrorsJSON `json:"-"`
}

func (*SubscriptionGetResponseEnvelopeErrors) UnmarshalJSON 

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

type SubscriptionGetResponseEnvelopeMessages 

type SubscriptionGetResponseEnvelopeMessages struct {
	Code    int64                                       `json:"code,required"`
	Message string                                      `json:"message,required"`
	JSON    subscriptionGetResponseEnvelopeMessagesJSON `json:"-"`
}

func (*SubscriptionGetResponseEnvelopeMessages) UnmarshalJSON 

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

type SubscriptionGetResponseEnvelopeSuccess 

type SubscriptionGetResponseEnvelopeSuccess bool

Whether the API call was successful 

const (
	SubscriptionGetResponseEnvelopeSuccessTrue SubscriptionGetResponseEnvelopeSuccess = true
)

type SubscriptionListResponse 

type SubscriptionListResponse struct {
	// Subscription identifier tag.
	ID  string                      `json:"id"`
	App SubscriptionListResponseApp `json:"app"`
	// The list of add-ons subscribed to.
	ComponentValues []SubscriptionListResponseComponentValue `json:"component_values"`
	// The monetary unit in which pricing information is displayed.
	Currency string `json:"currency"`
	// The end of the current period and also when the next billing is due.
	CurrentPeriodEnd time.Time `json:"current_period_end" format:"date-time"`
	// When the current billing period started. May match initial_period_start if this
	// is the first period.
	CurrentPeriodStart time.Time `json:"current_period_start" format:"date-time"`
	// How often the subscription is renewed automatically.
	Frequency SubscriptionListResponseFrequency `json:"frequency"`
	// The price of the subscription that will be billed, in US dollars.
	Price float64 `json:"price"`
	// The rate plan applied to the subscription.
	RatePlan SubscriptionListResponseRatePlan `json:"rate_plan"`
	// The state that the subscription is in.
	State SubscriptionListResponseState `json:"state"`
	// A simple zone object. May have null properties if not a zone subscription.
	Zone SubscriptionListResponseZone `json:"zone"`
	JSON subscriptionListResponseJSON `json:"-"`
}

func (*SubscriptionListResponse) UnmarshalJSON 

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

type SubscriptionListResponseApp 

type SubscriptionListResponseApp struct {
	// app install id.
	InstallID string                          `json:"install_id"`
	JSON      subscriptionListResponseAppJSON `json:"-"`
}

func (*SubscriptionListResponseApp) UnmarshalJSON 

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

type SubscriptionListResponseComponentValue 

type SubscriptionListResponseComponentValue struct {
	// The default amount assigned.
	Default float64 `json:"default"`
	// The name of the component value.
	Name string `json:"name"`
	// The unit price for the component value.
	Price float64 `json:"price"`
	// The amount of the component value assigned.
	Value float64                                    `json:"value"`
	JSON  subscriptionListResponseComponentValueJSON `json:"-"`
}

A component value for a subscription.

func (*SubscriptionListResponseComponentValue) UnmarshalJSON 

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

type SubscriptionListResponseEnvelope 

type SubscriptionListResponseEnvelope struct {
	Errors   []SubscriptionListResponseEnvelopeErrors   `json:"errors,required"`
	Messages []SubscriptionListResponseEnvelopeMessages `json:"messages,required"`
	Result   []SubscriptionListResponse                 `json:"result,required,nullable"`
	// Whether the API call was successful
	Success    SubscriptionListResponseEnvelopeSuccess    `json:"success,required"`
	ResultInfo SubscriptionListResponseEnvelopeResultInfo `json:"result_info"`
	JSON       subscriptionListResponseEnvelopeJSON       `json:"-"`
}

func (*SubscriptionListResponseEnvelope) UnmarshalJSON 

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

type SubscriptionListResponseEnvelopeErrors 

type SubscriptionListResponseEnvelopeErrors struct {
	Code    int64                                      `json:"code,required"`
	Message string                                     `json:"message,required"`
	JSON    subscriptionListResponseEnvelopeErrorsJSON `json:"-"`
}

func (*SubscriptionListResponseEnvelopeErrors) UnmarshalJSON 

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

type SubscriptionListResponseEnvelopeMessages 

type SubscriptionListResponseEnvelopeMessages struct {
	Code    int64                                        `json:"code,required"`
	Message string                                       `json:"message,required"`
	JSON    subscriptionListResponseEnvelopeMessagesJSON `json:"-"`
}

func (*SubscriptionListResponseEnvelopeMessages) UnmarshalJSON 

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

type SubscriptionListResponseEnvelopeResultInfo 

type SubscriptionListResponseEnvelopeResultInfo 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       subscriptionListResponseEnvelopeResultInfoJSON `json:"-"`
}

func (*SubscriptionListResponseEnvelopeResultInfo) UnmarshalJSON 

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

type SubscriptionListResponseEnvelopeSuccess 

type SubscriptionListResponseEnvelopeSuccess bool

Whether the API call was successful 

const (
	SubscriptionListResponseEnvelopeSuccessTrue SubscriptionListResponseEnvelopeSuccess = true
)

type SubscriptionListResponseFrequency 

type SubscriptionListResponseFrequency string

How often the subscription is renewed automatically. 

const (
	SubscriptionListResponseFrequencyWeekly    SubscriptionListResponseFrequency = "weekly"
	SubscriptionListResponseFrequencyMonthly   SubscriptionListResponseFrequency = "monthly"
	SubscriptionListResponseFrequencyQuarterly SubscriptionListResponseFrequency = "quarterly"
	SubscriptionListResponseFrequencyYearly    SubscriptionListResponseFrequency = "yearly"
)

type SubscriptionListResponseRatePlan 

type SubscriptionListResponseRatePlan struct {
	// The ID of the rate plan.
	ID interface{} `json:"id"`
	// The currency applied to the rate plan subscription.
	Currency string `json:"currency"`
	// Whether this rate plan is managed externally from Cloudflare.
	ExternallyManaged bool `json:"externally_managed"`
	// Whether a rate plan is enterprise-based (or newly adopted term contract).
	IsContract bool `json:"is_contract"`
	// The full name of the rate plan.
	PublicName string `json:"public_name"`
	// The scope that this rate plan applies to.
	Scope string `json:"scope"`
	// The list of sets this rate plan applies to.
	Sets []string                             `json:"sets"`
	JSON subscriptionListResponseRatePlanJSON `json:"-"`
}

The rate plan applied to the subscription.

func (*SubscriptionListResponseRatePlan) UnmarshalJSON 

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

type SubscriptionListResponseState 

type SubscriptionListResponseState string

The state that the subscription is in. 

const (
	SubscriptionListResponseStateTrial           SubscriptionListResponseState = "Trial"
	SubscriptionListResponseStateProvisioned     SubscriptionListResponseState = "Provisioned"
	SubscriptionListResponseStatePaid            SubscriptionListResponseState = "Paid"
	SubscriptionListResponseStateAwaitingPayment SubscriptionListResponseState = "AwaitingPayment"
	SubscriptionListResponseStateCancelled       SubscriptionListResponseState = "Cancelled"
	SubscriptionListResponseStateFailed          SubscriptionListResponseState = "Failed"
	SubscriptionListResponseStateExpired         SubscriptionListResponseState = "Expired"
)

type SubscriptionListResponseZone 

type SubscriptionListResponseZone struct {
	// Identifier
	ID string `json:"id"`
	// The domain name
	Name string                           `json:"name"`
	JSON subscriptionListResponseZoneJSON `json:"-"`
}

A simple zone object. May have null properties if not a zone subscription.

func (*SubscriptionListResponseZone) UnmarshalJSON 

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

type SubscriptionNewParams 

type SubscriptionNewParams struct {
	App param.Field[SubscriptionNewParamsApp] `json:"app"`
	// The list of add-ons subscribed to.
	ComponentValues param.Field[[]SubscriptionNewParamsComponentValue] `json:"component_values"`
	// How often the subscription is renewed automatically.
	Frequency param.Field[SubscriptionNewParamsFrequency] `json:"frequency"`
	// The rate plan applied to the subscription.
	RatePlan param.Field[SubscriptionNewParamsRatePlan] `json:"rate_plan"`
	// A simple zone object. May have null properties if not a zone subscription.
	Zone param.Field[SubscriptionNewParamsZone] `json:"zone"`
}

func (SubscriptionNewParams) MarshalJSON 

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

type SubscriptionNewParamsApp 

type SubscriptionNewParamsApp struct {
	// app install id.
	InstallID param.Field[string] `json:"install_id"`
}

func (SubscriptionNewParamsApp) MarshalJSON 

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

type SubscriptionNewParamsComponentValue 

type SubscriptionNewParamsComponentValue struct {
	// The default amount assigned.
	Default param.Field[float64] `json:"default"`
	// The name of the component value.
	Name param.Field[string] `json:"name"`
	// The unit price for the component value.
	Price param.Field[float64] `json:"price"`
	// The amount of the component value assigned.
	Value param.Field[float64] `json:"value"`
}

A component value for a subscription.

func (SubscriptionNewParamsComponentValue) MarshalJSON 

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

type SubscriptionNewParamsFrequency 

type SubscriptionNewParamsFrequency string

How often the subscription is renewed automatically. 

const (
	SubscriptionNewParamsFrequencyWeekly    SubscriptionNewParamsFrequency = "weekly"
	SubscriptionNewParamsFrequencyMonthly   SubscriptionNewParamsFrequency = "monthly"
	SubscriptionNewParamsFrequencyQuarterly SubscriptionNewParamsFrequency = "quarterly"
	SubscriptionNewParamsFrequencyYearly    SubscriptionNewParamsFrequency = "yearly"
)

type SubscriptionNewParamsRatePlan 

type SubscriptionNewParamsRatePlan struct {
	// The ID of the rate plan.
	ID param.Field[interface{}] `json:"id"`
	// The currency applied to the rate plan subscription.
	Currency param.Field[string] `json:"currency"`
	// Whether this rate plan is managed externally from Cloudflare.
	ExternallyManaged param.Field[bool] `json:"externally_managed"`
	// Whether a rate plan is enterprise-based (or newly adopted term contract).
	IsContract param.Field[bool] `json:"is_contract"`
	// The full name of the rate plan.
	PublicName param.Field[string] `json:"public_name"`
	// The scope that this rate plan applies to.
	Scope param.Field[string] `json:"scope"`
	// The list of sets this rate plan applies to.
	Sets param.Field[[]string] `json:"sets"`
}

The rate plan applied to the subscription.

func (SubscriptionNewParamsRatePlan) MarshalJSON 

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

type SubscriptionNewParamsZone 

type SubscriptionNewParamsZone struct {
}

A simple zone object. May have null properties if not a zone subscription.

func (SubscriptionNewParamsZone) MarshalJSON 

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

type SubscriptionNewResponse 

type SubscriptionNewResponse interface {
	ImplementsZonesSubscriptionNewResponse()
}

Union satisfied by zones.SubscriptionNewResponseUnknown or shared.UnionString.

type SubscriptionNewResponseEnvelope 

type SubscriptionNewResponseEnvelope struct {
	Errors   []SubscriptionNewResponseEnvelopeErrors   `json:"errors,required"`
	Messages []SubscriptionNewResponseEnvelopeMessages `json:"messages,required"`
	Result   SubscriptionNewResponse                   `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 SubscriptionNewResponseEnvelopeErrors 

type SubscriptionNewResponseEnvelopeErrors struct {
	Code    int64                                     `json:"code,required"`
	Message string                                    `json:"message,required"`
	JSON    subscriptionNewResponseEnvelopeErrorsJSON `json:"-"`
}

func (*SubscriptionNewResponseEnvelopeErrors) UnmarshalJSON 

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

type SubscriptionNewResponseEnvelopeMessages 

type SubscriptionNewResponseEnvelopeMessages struct {
	Code    int64                                       `json:"code,required"`
	Message string                                      `json:"message,required"`
	JSON    subscriptionNewResponseEnvelopeMessagesJSON `json:"-"`
}

func (*SubscriptionNewResponseEnvelopeMessages) UnmarshalJSON 

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

type SubscriptionNewResponseEnvelopeSuccess 

type SubscriptionNewResponseEnvelopeSuccess bool

Whether the API call was successful 

const (
	SubscriptionNewResponseEnvelopeSuccessTrue SubscriptionNewResponseEnvelopeSuccess = true
)

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 *SubscriptionGetResponse, err error)

Lists zone subscription details.

func (*SubscriptionService) List 

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

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 *SubscriptionNewResponse, err error)

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

type WorkerScriptDeleteParams 

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

type WorkerScriptGetParams 

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

type WorkerScriptService 

type WorkerScriptService struct {
	Options []option.RequestOption
}

WorkerScriptService 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 NewWorkerScriptService method instead.

func NewWorkerScriptService 

func NewWorkerScriptService(opts ...option.RequestOption) (r *WorkerScriptService)

NewWorkerScriptService 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 (*WorkerScriptService) Delete 

func (r *WorkerScriptService) Delete(ctx context.Context, body WorkerScriptDeleteParams, opts ...option.RequestOption) (err error)

Delete your Worker. This call has no response body on a successful delete.

func (*WorkerScriptService) Get 

func (r *WorkerScriptService) Get(ctx context.Context, query WorkerScriptGetParams, opts ...option.RequestOption) (res *http.Response, err error)

Fetch raw script content for your worker. Note this is the original script content, not JSON encoded.

func (*WorkerScriptService) Update 

func (r *WorkerScriptService) Update(ctx context.Context, body WorkerScriptUpdateParams, opts ...option.RequestOption) (res *WorkerScriptUpdateResponse, err error)

Upload a worker, or a new version of a worker.

type WorkerScriptUpdateParams 

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

type WorkerScriptUpdateResponse 

type WorkerScriptUpdateResponse interface {
	ImplementsZonesWorkerScriptUpdateResponse()
}

Union satisfied by zones.WorkerScriptUpdateResponseUnknown or shared.UnionString.

type WorkerScriptUpdateResponseEnvelope 

type WorkerScriptUpdateResponseEnvelope struct {
	Errors   []WorkerScriptUpdateResponseEnvelopeErrors   `json:"errors,required"`
	Messages []WorkerScriptUpdateResponseEnvelopeMessages `json:"messages,required"`
	Result   WorkerScriptUpdateResponse                   `json:"result,required"`
	// Whether the API call was successful
	Success WorkerScriptUpdateResponseEnvelopeSuccess `json:"success,required"`
	JSON    workerScriptUpdateResponseEnvelopeJSON    `json:"-"`
}

func (*WorkerScriptUpdateResponseEnvelope) UnmarshalJSON 

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

type WorkerScriptUpdateResponseEnvelopeErrors 

type WorkerScriptUpdateResponseEnvelopeErrors struct {
	Code    int64                                        `json:"code,required"`
	Message string                                       `json:"message,required"`
	JSON    workerScriptUpdateResponseEnvelopeErrorsJSON `json:"-"`
}

func (*WorkerScriptUpdateResponseEnvelopeErrors) UnmarshalJSON 

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

type WorkerScriptUpdateResponseEnvelopeMessages 

type WorkerScriptUpdateResponseEnvelopeMessages struct {
	Code    int64                                          `json:"code,required"`
	Message string                                         `json:"message,required"`
	JSON    workerScriptUpdateResponseEnvelopeMessagesJSON `json:"-"`
}

func (*WorkerScriptUpdateResponseEnvelopeMessages) UnmarshalJSON 

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

type WorkerScriptUpdateResponseEnvelopeSuccess 

type WorkerScriptUpdateResponseEnvelopeSuccess bool

Whether the API call was successful 

const (
	WorkerScriptUpdateResponseEnvelopeSuccessTrue WorkerScriptUpdateResponseEnvelopeSuccess = true
)

type WorkerService 

type WorkerService struct {
	Options []option.RequestOption
	Script  *WorkerScriptService
}

WorkerService 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 NewWorkerService method instead.

func NewWorkerService 

func NewWorkerService(opts ...option.RequestOption) (r *WorkerService)

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

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

type ZoneDeleteResponseEnvelopeErrors struct {
	Code    int64                                `json:"code,required"`
	Message string                               `json:"message,required"`
	JSON    zoneDeleteResponseEnvelopeErrorsJSON `json:"-"`
}

func (*ZoneDeleteResponseEnvelopeErrors) UnmarshalJSON 

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

type ZoneDeleteResponseEnvelopeMessages 

type ZoneDeleteResponseEnvelopeMessages struct {
	Code    int64                                  `json:"code,required"`
	Message string                                 `json:"message,required"`
	JSON    zoneDeleteResponseEnvelopeMessagesJSON `json:"-"`
}

func (*ZoneDeleteResponseEnvelopeMessages) UnmarshalJSON 

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

type ZoneEditResponse 

type ZoneEditResponse struct {
	// Identifier
	ID string `json:"id,required"`
	// The account the zone belongs to
	Account ZoneEditResponseAccount `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 ZoneEditResponseMeta `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"`
	// DNS host at the time of switching to Cloudflare
	OriginalDnshost string `json:"original_dnshost,required,nullable"`
	// Original name servers before moving to Cloudflare Notes: Is this only available
	// for full zones?
	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 ZoneEditResponseOwner `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              zoneEditResponseJSON `json:"-"`
}

func (*ZoneEditResponse) UnmarshalJSON 

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

type ZoneEditResponseAccount 

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

The account the zone belongs to

func (*ZoneEditResponseAccount) UnmarshalJSON 

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

type ZoneEditResponseEnvelope 

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

func (*ZoneEditResponseEnvelope) UnmarshalJSON 

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

type ZoneEditResponseEnvelopeErrors 

type ZoneEditResponseEnvelopeErrors struct {
	Code    int64                              `json:"code,required"`
	Message string                             `json:"message,required"`
	JSON    zoneEditResponseEnvelopeErrorsJSON `json:"-"`
}

func (*ZoneEditResponseEnvelopeErrors) UnmarshalJSON 

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

type ZoneEditResponseEnvelopeMessages 

type ZoneEditResponseEnvelopeMessages struct {
	Code    int64                                `json:"code,required"`
	Message string                               `json:"message,required"`
	JSON    zoneEditResponseEnvelopeMessagesJSON `json:"-"`
}

func (*ZoneEditResponseEnvelopeMessages) UnmarshalJSON 

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

type ZoneEditResponseMeta 

type ZoneEditResponseMeta 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             zoneEditResponseMetaJSON `json:"-"`
}

Metadata about the zone

func (*ZoneEditResponseMeta) UnmarshalJSON 

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

type ZoneEditResponseOwner 

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

The owner of the zone

func (*ZoneEditResponseOwner) UnmarshalJSON 

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

type ZoneGetParams 

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

type ZoneGetResponse 

type ZoneGetResponse struct {
	// Identifier
	ID string `json:"id,required"`
	// The account the zone belongs to
	Account ZoneGetResponseAccount `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 ZoneGetResponseMeta `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"`
	// DNS host at the time of switching to Cloudflare
	OriginalDnshost string `json:"original_dnshost,required,nullable"`
	// Original name servers before moving to Cloudflare Notes: Is this only available
	// for full zones?
	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 ZoneGetResponseOwner `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              zoneGetResponseJSON `json:"-"`
}

func (*ZoneGetResponse) UnmarshalJSON 

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

type ZoneGetResponseAccount 

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

The account the zone belongs to

func (*ZoneGetResponseAccount) UnmarshalJSON 

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

type ZoneGetResponseEnvelope 

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

func (*ZoneGetResponseEnvelope) UnmarshalJSON 

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

type ZoneGetResponseEnvelopeErrors 

type ZoneGetResponseEnvelopeErrors struct {
	Code    int64                             `json:"code,required"`
	Message string                            `json:"message,required"`
	JSON    zoneGetResponseEnvelopeErrorsJSON `json:"-"`
}

func (*ZoneGetResponseEnvelopeErrors) UnmarshalJSON 

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

type ZoneGetResponseEnvelopeMessages 

type ZoneGetResponseEnvelopeMessages struct {
	Code    int64                               `json:"code,required"`
	Message string                              `json:"message,required"`
	JSON    zoneGetResponseEnvelopeMessagesJSON `json:"-"`
}

func (*ZoneGetResponseEnvelopeMessages) UnmarshalJSON 

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

type ZoneGetResponseMeta 

type ZoneGetResponseMeta 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             zoneGetResponseMetaJSON `json:"-"`
}

Metadata about the zone

func (*ZoneGetResponseMeta) UnmarshalJSON 

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

type ZoneGetResponseOwner 

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

The owner of the zone

func (*ZoneGetResponseOwner) UnmarshalJSON 

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

type ZoneListParamsMatch 

type ZoneListParamsMatch string

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

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

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

type ZoneListParamsStatus 

type ZoneListParamsStatus string

A zone status 

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

type ZoneListResponse 

type ZoneListResponse struct {
	// Identifier
	ID string `json:"id,required"`
	// The account the zone belongs to
	Account ZoneListResponseAccount `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 ZoneListResponseMeta `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"`
	// DNS host at the time of switching to Cloudflare
	OriginalDnshost string `json:"original_dnshost,required,nullable"`
	// Original name servers before moving to Cloudflare Notes: Is this only available
	// for full zones?
	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 ZoneListResponseOwner `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              zoneListResponseJSON `json:"-"`
}

func (*ZoneListResponse) UnmarshalJSON 

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

type ZoneListResponseAccount 

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

The account the zone belongs to

func (*ZoneListResponseAccount) UnmarshalJSON 

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

type ZoneListResponseMeta 

type ZoneListResponseMeta 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             zoneListResponseMetaJSON `json:"-"`
}

Metadata about the zone

func (*ZoneListResponseMeta) UnmarshalJSON 

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

type ZoneListResponseOwner 

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

The owner of the zone

func (*ZoneListResponseOwner) UnmarshalJSON 

func (r *ZoneListResponseOwner) 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[ZoneNewParamsType] `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 ZoneNewParamsType 

type ZoneNewParamsType 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 (
	ZoneNewParamsTypeFull      ZoneNewParamsType = "full"
	ZoneNewParamsTypePartial   ZoneNewParamsType = "partial"
	ZoneNewParamsTypeSecondary ZoneNewParamsType = "secondary"
)

type ZoneNewResponse 

type ZoneNewResponse struct {
	// Identifier
	ID string `json:"id,required"`
	// The account the zone belongs to
	Account ZoneNewResponseAccount `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 ZoneNewResponseMeta `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"`
	// DNS host at the time of switching to Cloudflare
	OriginalDnshost string `json:"original_dnshost,required,nullable"`
	// Original name servers before moving to Cloudflare Notes: Is this only available
	// for full zones?
	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 ZoneNewResponseOwner `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              zoneNewResponseJSON `json:"-"`
}

func (*ZoneNewResponse) UnmarshalJSON 

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

type ZoneNewResponseAccount 

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

The account the zone belongs to

func (*ZoneNewResponseAccount) UnmarshalJSON 

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

type ZoneNewResponseEnvelope 

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

func (*ZoneNewResponseEnvelope) UnmarshalJSON 

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

type ZoneNewResponseEnvelopeErrors 

type ZoneNewResponseEnvelopeErrors struct {
	Code    int64                             `json:"code,required"`
	Message string                            `json:"message,required"`
	JSON    zoneNewResponseEnvelopeErrorsJSON `json:"-"`
}

func (*ZoneNewResponseEnvelopeErrors) UnmarshalJSON 

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

type ZoneNewResponseEnvelopeMessages 

type ZoneNewResponseEnvelopeMessages struct {
	Code    int64                               `json:"code,required"`
	Message string                              `json:"message,required"`
	JSON    zoneNewResponseEnvelopeMessagesJSON `json:"-"`
}

func (*ZoneNewResponseEnvelopeMessages) UnmarshalJSON 

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

type ZoneNewResponseMeta 

type ZoneNewResponseMeta 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             zoneNewResponseMetaJSON `json:"-"`
}

Metadata about the zone

func (*ZoneNewResponseMeta) UnmarshalJSON 

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

type ZoneNewResponseOwner 

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

The owner of the zone

func (*ZoneNewResponseOwner) UnmarshalJSON 

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

type ZoneService 

type ZoneService struct {
	Options           []option.RequestOption
	ActivationCheck   *ActivationCheckService
	Settings          *SettingService
	CustomNameservers *CustomNameserverService
	Holds             *HoldService
	Workers           *WorkerService
	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 *ZoneEditResponse, 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 *ZoneGetResponse, err error)

Zone Details

func (*ZoneService) List 

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

Lists, searches, sorts, and filters your zones.

func (*ZoneService) ListAutoPaging 

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

Lists, searches, sorts, and filters your zones.

func (*ZoneService) New 

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

Create Zone

type Zones0rtt 

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

0-RTT session resumption enabled for this zone.

func (*Zones0rtt) UnmarshalJSON 

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

type Zones0rttEditable 

type Zones0rttEditable bool

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

const (
	Zones0rttEditableTrue  Zones0rttEditable = true
	Zones0rttEditableFalse Zones0rttEditable = false
)

type Zones0rttID 

type Zones0rttID string

ID of the zone setting. 

const (
	Zones0rttID0rtt Zones0rttID = "0rtt"
)

type Zones0rttParam 

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

0-RTT session resumption enabled for this zone.

func (Zones0rttParam) MarshalJSON 

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

type Zones0rttValue 

type Zones0rttValue string

Current value of the zone setting. 

const (
	Zones0rttValueOn  Zones0rttValue = "on"
	Zones0rttValueOff Zones0rttValue = "off"
)

type ZonesAdvancedDDOS 

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

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

type ZonesAdvancedDDOSEditable 

type ZonesAdvancedDDOSEditable bool

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

const (
	ZonesAdvancedDDOSEditableTrue  ZonesAdvancedDDOSEditable = true
	ZonesAdvancedDDOSEditableFalse ZonesAdvancedDDOSEditable = false
)

type ZonesAdvancedDDOSID 

type ZonesAdvancedDDOSID string

ID of the zone setting. 

const (
	ZonesAdvancedDDOSIDAdvancedDDOS ZonesAdvancedDDOSID = "advanced_ddos"
)

type ZonesAdvancedDDOSParam 

type ZonesAdvancedDDOSParam struct {
	// ID of the zone setting.
	ID param.Field[ZonesAdvancedDDOSID] `json:"id,required"`
	// Current value of the zone setting.
	Value param.Field[ZonesAdvancedDDOSValue] `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 (ZonesAdvancedDDOSParam) MarshalJSON 

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

type ZonesAdvancedDDOSValue 

type ZonesAdvancedDDOSValue string

Current value of the zone setting. 

const (
	ZonesAdvancedDDOSValueOn  ZonesAdvancedDDOSValue = "on"
	ZonesAdvancedDDOSValueOff ZonesAdvancedDDOSValue = "off"
)

type ZonesAlwaysOnline 

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

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

type ZonesAlwaysOnlineEditable 

type ZonesAlwaysOnlineEditable bool

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

const (
	ZonesAlwaysOnlineEditableTrue  ZonesAlwaysOnlineEditable = true
	ZonesAlwaysOnlineEditableFalse ZonesAlwaysOnlineEditable = false
)

type ZonesAlwaysOnlineID 

type ZonesAlwaysOnlineID string

ID of the zone setting. 

const (
	ZonesAlwaysOnlineIDAlwaysOnline ZonesAlwaysOnlineID = "always_online"
)

type ZonesAlwaysOnlineParam 

type ZonesAlwaysOnlineParam struct {
	// ID of the zone setting.
	ID param.Field[ZonesAlwaysOnlineID] `json:"id,required"`
	// Current value of the zone setting.
	Value param.Field[ZonesAlwaysOnlineValue] `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 (ZonesAlwaysOnlineParam) MarshalJSON 

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

type ZonesAlwaysOnlineValue 

type ZonesAlwaysOnlineValue string

Current value of the zone setting. 

const (
	ZonesAlwaysOnlineValueOn  ZonesAlwaysOnlineValue = "on"
	ZonesAlwaysOnlineValueOff ZonesAlwaysOnlineValue = "off"
)

type ZonesAlwaysUseHTTPS 

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

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

type ZonesAlwaysUseHTTPSEditable 

type ZonesAlwaysUseHTTPSEditable bool

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

const (
	ZonesAlwaysUseHTTPSEditableTrue  ZonesAlwaysUseHTTPSEditable = true
	ZonesAlwaysUseHTTPSEditableFalse ZonesAlwaysUseHTTPSEditable = false
)

type ZonesAlwaysUseHTTPSID 

type ZonesAlwaysUseHTTPSID string

ID of the zone setting. 

const (
	ZonesAlwaysUseHTTPSIDAlwaysUseHTTPS ZonesAlwaysUseHTTPSID = "always_use_https"
)

type ZonesAlwaysUseHTTPSParam 

type ZonesAlwaysUseHTTPSParam struct {
	// ID of the zone setting.
	ID param.Field[ZonesAlwaysUseHTTPSID] `json:"id,required"`
	// Current value of the zone setting.
	Value param.Field[ZonesAlwaysUseHTTPSValue] `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 (ZonesAlwaysUseHTTPSParam) MarshalJSON 

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

type ZonesAlwaysUseHTTPSValue 

type ZonesAlwaysUseHTTPSValue string

Current value of the zone setting. 

const (
	ZonesAlwaysUseHTTPSValueOn  ZonesAlwaysUseHTTPSValue = "on"
	ZonesAlwaysUseHTTPSValueOff ZonesAlwaysUseHTTPSValue = "off"
)

type ZonesAutomaticHTTPSRewrites 

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

Enable the Automatic HTTPS Rewrites feature for this zone.

func (*ZonesAutomaticHTTPSRewrites) UnmarshalJSON 

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

type ZonesAutomaticHTTPSRewritesEditable 

type ZonesAutomaticHTTPSRewritesEditable bool

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

const (
	ZonesAutomaticHTTPSRewritesEditableTrue  ZonesAutomaticHTTPSRewritesEditable = true
	ZonesAutomaticHTTPSRewritesEditableFalse ZonesAutomaticHTTPSRewritesEditable = false
)

type ZonesAutomaticHTTPSRewritesID 

type ZonesAutomaticHTTPSRewritesID string

ID of the zone setting. 

const (
	ZonesAutomaticHTTPSRewritesIDAutomaticHTTPSRewrites ZonesAutomaticHTTPSRewritesID = "automatic_https_rewrites"
)

type ZonesAutomaticHTTPSRewritesParam 

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

Enable the Automatic HTTPS Rewrites feature for this zone.

func (ZonesAutomaticHTTPSRewritesParam) MarshalJSON 

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

type ZonesAutomaticHTTPSRewritesValue 

type ZonesAutomaticHTTPSRewritesValue string

Current value of the zone setting. 

const (
	ZonesAutomaticHTTPSRewritesValueOn  ZonesAutomaticHTTPSRewritesValue = "on"
	ZonesAutomaticHTTPSRewritesValueOff ZonesAutomaticHTTPSRewritesValue = "off"
)

type ZonesAutomaticPlatformOptimization 

type ZonesAutomaticPlatformOptimization 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     zonesAutomaticPlatformOptimizationJSON `json:"-"`
}

func (*ZonesAutomaticPlatformOptimization) UnmarshalJSON 

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

type ZonesAutomaticPlatformOptimizationParam 

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

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

type ZonesBrotli 

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

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

func (*ZonesBrotli) UnmarshalJSON 

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

type ZonesBrotliEditable 

type ZonesBrotliEditable bool

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

const (
	ZonesBrotliEditableTrue  ZonesBrotliEditable = true
	ZonesBrotliEditableFalse ZonesBrotliEditable = false
)

type ZonesBrotliID 

type ZonesBrotliID string

ID of the zone setting. 

const (
	ZonesBrotliIDBrotli ZonesBrotliID = "brotli"
)

type ZonesBrotliParam 

type ZonesBrotliParam struct {
	// ID of the zone setting.
	ID param.Field[ZonesBrotliID] `json:"id,required"`
	// Current value of the zone setting.
	Value param.Field[ZonesBrotliValue] `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 (ZonesBrotliParam) MarshalJSON 

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

type ZonesBrotliValue 

type ZonesBrotliValue string

Current value of the zone setting. 

const (
	ZonesBrotliValueOff ZonesBrotliValue = "off"
	ZonesBrotliValueOn  ZonesBrotliValue = "on"
)

type ZonesBrowserCacheTTL 

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

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

type ZonesBrowserCacheTTLEditable 

type ZonesBrowserCacheTTLEditable bool

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

const (
	ZonesBrowserCacheTTLEditableTrue  ZonesBrowserCacheTTLEditable = true
	ZonesBrowserCacheTTLEditableFalse ZonesBrowserCacheTTLEditable = false
)

type ZonesBrowserCacheTTLID 

type ZonesBrowserCacheTTLID string

ID of the zone setting. 

const (
	ZonesBrowserCacheTTLIDBrowserCacheTTL ZonesBrowserCacheTTLID = "browser_cache_ttl"
)

type ZonesBrowserCacheTTLParam 

type ZonesBrowserCacheTTLParam struct {
	// ID of the zone setting.
	ID param.Field[ZonesBrowserCacheTTLID] `json:"id,required"`
	// Current value of the zone setting.
	Value param.Field[ZonesBrowserCacheTTLValue] `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 (ZonesBrowserCacheTTLParam) MarshalJSON 

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

type ZonesBrowserCacheTTLValue 

type ZonesBrowserCacheTTLValue float64

Current value of the zone setting. 

const (
	ZonesBrowserCacheTTLValue0        ZonesBrowserCacheTTLValue = 0
	ZonesBrowserCacheTTLValue30       ZonesBrowserCacheTTLValue = 30
	ZonesBrowserCacheTTLValue60       ZonesBrowserCacheTTLValue = 60
	ZonesBrowserCacheTTLValue120      ZonesBrowserCacheTTLValue = 120
	ZonesBrowserCacheTTLValue300      ZonesBrowserCacheTTLValue = 300
	ZonesBrowserCacheTTLValue1200     ZonesBrowserCacheTTLValue = 1200
	ZonesBrowserCacheTTLValue1800     ZonesBrowserCacheTTLValue = 1800
	ZonesBrowserCacheTTLValue3600     ZonesBrowserCacheTTLValue = 3600
	ZonesBrowserCacheTTLValue7200     ZonesBrowserCacheTTLValue = 7200
	ZonesBrowserCacheTTLValue10800    ZonesBrowserCacheTTLValue = 10800
	ZonesBrowserCacheTTLValue14400    ZonesBrowserCacheTTLValue = 14400
	ZonesBrowserCacheTTLValue18000    ZonesBrowserCacheTTLValue = 18000
	ZonesBrowserCacheTTLValue28800    ZonesBrowserCacheTTLValue = 28800
	ZonesBrowserCacheTTLValue43200    ZonesBrowserCacheTTLValue = 43200
	ZonesBrowserCacheTTLValue57600    ZonesBrowserCacheTTLValue = 57600
	ZonesBrowserCacheTTLValue72000    ZonesBrowserCacheTTLValue = 72000
	ZonesBrowserCacheTTLValue86400    ZonesBrowserCacheTTLValue = 86400
	ZonesBrowserCacheTTLValue172800   ZonesBrowserCacheTTLValue = 172800
	ZonesBrowserCacheTTLValue259200   ZonesBrowserCacheTTLValue = 259200
	ZonesBrowserCacheTTLValue345600   ZonesBrowserCacheTTLValue = 345600
	ZonesBrowserCacheTTLValue432000   ZonesBrowserCacheTTLValue = 432000
	ZonesBrowserCacheTTLValue691200   ZonesBrowserCacheTTLValue = 691200
	ZonesBrowserCacheTTLValue1382400  ZonesBrowserCacheTTLValue = 1382400
	ZonesBrowserCacheTTLValue2073600  ZonesBrowserCacheTTLValue = 2073600
	ZonesBrowserCacheTTLValue2678400  ZonesBrowserCacheTTLValue = 2678400
	ZonesBrowserCacheTTLValue5356800  ZonesBrowserCacheTTLValue = 5356800
	ZonesBrowserCacheTTLValue16070400 ZonesBrowserCacheTTLValue = 16070400
	ZonesBrowserCacheTTLValue31536000 ZonesBrowserCacheTTLValue = 31536000
)

type ZonesBrowserCheck 

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

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

type ZonesBrowserCheckEditable 

type ZonesBrowserCheckEditable bool

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

const (
	ZonesBrowserCheckEditableTrue  ZonesBrowserCheckEditable = true
	ZonesBrowserCheckEditableFalse ZonesBrowserCheckEditable = false
)

type ZonesBrowserCheckID 

type ZonesBrowserCheckID string

ID of the zone setting. 

const (
	ZonesBrowserCheckIDBrowserCheck ZonesBrowserCheckID = "browser_check"
)

type ZonesBrowserCheckParam 

type ZonesBrowserCheckParam struct {
	// ID of the zone setting.
	ID param.Field[ZonesBrowserCheckID] `json:"id,required"`
	// Current value of the zone setting.
	Value param.Field[ZonesBrowserCheckValue] `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 (ZonesBrowserCheckParam) MarshalJSON 

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

type ZonesBrowserCheckValue 

type ZonesBrowserCheckValue string

Current value of the zone setting. 

const (
	ZonesBrowserCheckValueOn  ZonesBrowserCheckValue = "on"
	ZonesBrowserCheckValueOff ZonesBrowserCheckValue = "off"
)

type ZonesBuffering 

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

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

type ZonesBufferingEditable 

type ZonesBufferingEditable bool

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

const (
	ZonesBufferingEditableTrue  ZonesBufferingEditable = true
	ZonesBufferingEditableFalse ZonesBufferingEditable = false
)

type ZonesBufferingID 

type ZonesBufferingID string

ID of the zone setting. 

const (
	ZonesBufferingIDResponseBuffering ZonesBufferingID = "response_buffering"
)

type ZonesBufferingParam 

type ZonesBufferingParam struct {
	// ID of the zone setting.
	ID param.Field[ZonesBufferingID] `json:"id,required"`
	// Current value of the zone setting.
	Value param.Field[ZonesBufferingValue] `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 (ZonesBufferingParam) MarshalJSON 

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

type ZonesBufferingValue 

type ZonesBufferingValue string

Current value of the zone setting. 

const (
	ZonesBufferingValueOn  ZonesBufferingValue = "on"
	ZonesBufferingValueOff ZonesBufferingValue = "off"
)

type ZonesCacheLevel 

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

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

type ZonesCacheLevelEditable 

type ZonesCacheLevelEditable bool

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

const (
	ZonesCacheLevelEditableTrue  ZonesCacheLevelEditable = true
	ZonesCacheLevelEditableFalse ZonesCacheLevelEditable = false
)

type ZonesCacheLevelID 

type ZonesCacheLevelID string

ID of the zone setting. 

const (
	ZonesCacheLevelIDCacheLevel ZonesCacheLevelID = "cache_level"
)

type ZonesCacheLevelParam 

type ZonesCacheLevelParam struct {
	// ID of the zone setting.
	ID param.Field[ZonesCacheLevelID] `json:"id,required"`
	// Current value of the zone setting.
	Value param.Field[ZonesCacheLevelValue] `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 (ZonesCacheLevelParam) MarshalJSON 

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

type ZonesCacheLevelValue 

type ZonesCacheLevelValue string

Current value of the zone setting. 

const (
	ZonesCacheLevelValueAggressive ZonesCacheLevelValue = "aggressive"
	ZonesCacheLevelValueBasic      ZonesCacheLevelValue = "basic"
	ZonesCacheLevelValueSimplified ZonesCacheLevelValue = "simplified"
)

type ZonesChallengeTTL 

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

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

type ZonesChallengeTTLEditable 

type ZonesChallengeTTLEditable bool

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

const (
	ZonesChallengeTTLEditableTrue  ZonesChallengeTTLEditable = true
	ZonesChallengeTTLEditableFalse ZonesChallengeTTLEditable = false
)

type ZonesChallengeTTLID 

type ZonesChallengeTTLID string

ID of the zone setting. 

const (
	ZonesChallengeTTLIDChallengeTTL ZonesChallengeTTLID = "challenge_ttl"
)

type ZonesChallengeTTLParam 

type ZonesChallengeTTLParam struct {
	// ID of the zone setting.
	ID param.Field[ZonesChallengeTTLID] `json:"id,required"`
	// Current value of the zone setting.
	Value param.Field[ZonesChallengeTTLValue] `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 (ZonesChallengeTTLParam) MarshalJSON 

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

type ZonesChallengeTTLValue 

type ZonesChallengeTTLValue float64

Current value of the zone setting. 

const (
	ZonesChallengeTTLValue300      ZonesChallengeTTLValue = 300
	ZonesChallengeTTLValue900      ZonesChallengeTTLValue = 900
	ZonesChallengeTTLValue1800     ZonesChallengeTTLValue = 1800
	ZonesChallengeTTLValue2700     ZonesChallengeTTLValue = 2700
	ZonesChallengeTTLValue3600     ZonesChallengeTTLValue = 3600
	ZonesChallengeTTLValue7200     ZonesChallengeTTLValue = 7200
	ZonesChallengeTTLValue10800    ZonesChallengeTTLValue = 10800
	ZonesChallengeTTLValue14400    ZonesChallengeTTLValue = 14400
	ZonesChallengeTTLValue28800    ZonesChallengeTTLValue = 28800
	ZonesChallengeTTLValue57600    ZonesChallengeTTLValue = 57600
	ZonesChallengeTTLValue86400    ZonesChallengeTTLValue = 86400
	ZonesChallengeTTLValue604800   ZonesChallengeTTLValue = 604800
	ZonesChallengeTTLValue2592000  ZonesChallengeTTLValue = 2592000
	ZonesChallengeTTLValue31536000 ZonesChallengeTTLValue = 31536000
)

type ZonesCiphers 

type ZonesCiphers struct {
	// ID of the zone setting.
	ID ZonesCiphersID `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 ZonesCiphersEditable `json:"editable"`
	// last time this setting was modified.
	ModifiedOn time.Time        `json:"modified_on,nullable" format:"date-time"`
	JSON       zonesCiphersJSON `json:"-"`
}

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

func (*ZonesCiphers) UnmarshalJSON 

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

type ZonesCiphersEditable 

type ZonesCiphersEditable bool

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

const (
	ZonesCiphersEditableTrue  ZonesCiphersEditable = true
	ZonesCiphersEditableFalse ZonesCiphersEditable = false
)

type ZonesCiphersID 

type ZonesCiphersID string

ID of the zone setting. 

const (
	ZonesCiphersIDCiphers ZonesCiphersID = "ciphers"
)

type ZonesCiphersParam 

type ZonesCiphersParam struct {
	// ID of the zone setting.
	ID param.Field[ZonesCiphersID] `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 (ZonesCiphersParam) MarshalJSON 

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

type ZonesDevelopmentMode 

type ZonesDevelopmentMode struct {
	// ID of the zone setting.
	ID ZonesDevelopmentModeID `json:"id,required"`
	// Current value of the zone setting.
	Value ZonesDevelopmentModeValue `json:"value,required"`
	// Whether or not this setting can be modified for this zone (based on your
	// Cloudflare plan level).
	Editable ZonesDevelopmentModeEditable `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          zonesDevelopmentModeJSON `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 (*ZonesDevelopmentMode) UnmarshalJSON 

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

type ZonesDevelopmentModeEditable 

type ZonesDevelopmentModeEditable bool

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

const (
	ZonesDevelopmentModeEditableTrue  ZonesDevelopmentModeEditable = true
	ZonesDevelopmentModeEditableFalse ZonesDevelopmentModeEditable = false
)

type ZonesDevelopmentModeID 

type ZonesDevelopmentModeID string

ID of the zone setting. 

const (
	ZonesDevelopmentModeIDDevelopmentMode ZonesDevelopmentModeID = "development_mode"
)

type ZonesDevelopmentModeParam 

type ZonesDevelopmentModeParam struct {
	// ID of the zone setting.
	ID param.Field[ZonesDevelopmentModeID] `json:"id,required"`
	// Current value of the zone setting.
	Value param.Field[ZonesDevelopmentModeValue] `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 (ZonesDevelopmentModeParam) MarshalJSON 

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

type ZonesDevelopmentModeValue 

type ZonesDevelopmentModeValue string

Current value of the zone setting. 

const (
	ZonesDevelopmentModeValueOn  ZonesDevelopmentModeValue = "on"
	ZonesDevelopmentModeValueOff ZonesDevelopmentModeValue = "off"
)

type ZonesEarlyHints 

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

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

type ZonesEarlyHintsEditable 

type ZonesEarlyHintsEditable bool

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

const (
	ZonesEarlyHintsEditableTrue  ZonesEarlyHintsEditable = true
	ZonesEarlyHintsEditableFalse ZonesEarlyHintsEditable = false
)

type ZonesEarlyHintsID 

type ZonesEarlyHintsID string

ID of the zone setting. 

const (
	ZonesEarlyHintsIDEarlyHints ZonesEarlyHintsID = "early_hints"
)

type ZonesEarlyHintsParam 

type ZonesEarlyHintsParam struct {
	// ID of the zone setting.
	ID param.Field[ZonesEarlyHintsID] `json:"id,required"`
	// Current value of the zone setting.
	Value param.Field[ZonesEarlyHintsValue] `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 (ZonesEarlyHintsParam) MarshalJSON 

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

type ZonesEarlyHintsValue 

type ZonesEarlyHintsValue string

Current value of the zone setting. 

const (
	ZonesEarlyHintsValueOn  ZonesEarlyHintsValue = "on"
	ZonesEarlyHintsValueOff ZonesEarlyHintsValue = "off"
)

type ZonesEmailObfuscation 

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

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

type ZonesEmailObfuscationEditable 

type ZonesEmailObfuscationEditable bool

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

const (
	ZonesEmailObfuscationEditableTrue  ZonesEmailObfuscationEditable = true
	ZonesEmailObfuscationEditableFalse ZonesEmailObfuscationEditable = false
)

type ZonesEmailObfuscationID 

type ZonesEmailObfuscationID string

ID of the zone setting. 

const (
	ZonesEmailObfuscationIDEmailObfuscation ZonesEmailObfuscationID = "email_obfuscation"
)

type ZonesEmailObfuscationParam 

type ZonesEmailObfuscationParam struct {
	// ID of the zone setting.
	ID param.Field[ZonesEmailObfuscationID] `json:"id,required"`
	// Current value of the zone setting.
	Value param.Field[ZonesEmailObfuscationValue] `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 (ZonesEmailObfuscationParam) MarshalJSON 

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

type ZonesEmailObfuscationValue 

type ZonesEmailObfuscationValue string

Current value of the zone setting. 

const (
	ZonesEmailObfuscationValueOn  ZonesEmailObfuscationValue = "on"
	ZonesEmailObfuscationValueOff ZonesEmailObfuscationValue = "off"
)

type ZonesH2Prioritization 

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

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

type ZonesH2PrioritizationEditable 

type ZonesH2PrioritizationEditable bool

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

const (
	ZonesH2PrioritizationEditableTrue  ZonesH2PrioritizationEditable = true
	ZonesH2PrioritizationEditableFalse ZonesH2PrioritizationEditable = false
)

type ZonesH2PrioritizationID 

type ZonesH2PrioritizationID string

ID of the zone setting. 

const (
	ZonesH2PrioritizationIDH2Prioritization ZonesH2PrioritizationID = "h2_prioritization"
)

type ZonesH2PrioritizationParam 

type ZonesH2PrioritizationParam struct {
	// ID of the zone setting.
	ID param.Field[ZonesH2PrioritizationID] `json:"id,required"`
	// Current value of the zone setting.
	Value param.Field[ZonesH2PrioritizationValue] `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 (ZonesH2PrioritizationParam) MarshalJSON 

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

type ZonesH2PrioritizationValue 

type ZonesH2PrioritizationValue string

Current value of the zone setting. 

const (
	ZonesH2PrioritizationValueOn     ZonesH2PrioritizationValue = "on"
	ZonesH2PrioritizationValueOff    ZonesH2PrioritizationValue = "off"
	ZonesH2PrioritizationValueCustom ZonesH2PrioritizationValue = "custom"
)

type ZonesHTTP2 

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

HTTP2 enabled for this zone.

func (*ZonesHTTP2) UnmarshalJSON 

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

type ZonesHTTP2Editable 

type ZonesHTTP2Editable bool

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

const (
	ZonesHTTP2EditableTrue  ZonesHTTP2Editable = true
	ZonesHTTP2EditableFalse ZonesHTTP2Editable = false
)

type ZonesHTTP2ID 

type ZonesHTTP2ID string

ID of the zone setting. 

const (
	ZonesHTTP2IDHTTP2 ZonesHTTP2ID = "http2"
)

type ZonesHTTP2Param 

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

HTTP2 enabled for this zone.

func (ZonesHTTP2Param) MarshalJSON 

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

type ZonesHTTP2Value 

type ZonesHTTP2Value string

Current value of the zone setting. 

const (
	ZonesHTTP2ValueOn  ZonesHTTP2Value = "on"
	ZonesHTTP2ValueOff ZonesHTTP2Value = "off"
)

type ZonesHTTP3 

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

HTTP3 enabled for this zone.

func (*ZonesHTTP3) UnmarshalJSON 

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

type ZonesHTTP3Editable 

type ZonesHTTP3Editable bool

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

const (
	ZonesHTTP3EditableTrue  ZonesHTTP3Editable = true
	ZonesHTTP3EditableFalse ZonesHTTP3Editable = false
)

type ZonesHTTP3ID 

type ZonesHTTP3ID string

ID of the zone setting. 

const (
	ZonesHTTP3IDHTTP3 ZonesHTTP3ID = "http3"
)

type ZonesHTTP3Param 

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

HTTP3 enabled for this zone.

func (ZonesHTTP3Param) MarshalJSON 

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

type ZonesHTTP3Value 

type ZonesHTTP3Value string

Current value of the zone setting. 

const (
	ZonesHTTP3ValueOn  ZonesHTTP3Value = "on"
	ZonesHTTP3ValueOff ZonesHTTP3Value = "off"
)

type ZonesHotlinkProtection 

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

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

type ZonesHotlinkProtectionEditable 

type ZonesHotlinkProtectionEditable bool

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

const (
	ZonesHotlinkProtectionEditableTrue  ZonesHotlinkProtectionEditable = true
	ZonesHotlinkProtectionEditableFalse ZonesHotlinkProtectionEditable = false
)

type ZonesHotlinkProtectionID 

type ZonesHotlinkProtectionID string

ID of the zone setting. 

const (
	ZonesHotlinkProtectionIDHotlinkProtection ZonesHotlinkProtectionID = "hotlink_protection"
)

type ZonesHotlinkProtectionParam 

type ZonesHotlinkProtectionParam struct {
	// ID of the zone setting.
	ID param.Field[ZonesHotlinkProtectionID] `json:"id,required"`
	// Current value of the zone setting.
	Value param.Field[ZonesHotlinkProtectionValue] `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 (ZonesHotlinkProtectionParam) MarshalJSON 

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

type ZonesHotlinkProtectionValue 

type ZonesHotlinkProtectionValue string

Current value of the zone setting. 

const (
	ZonesHotlinkProtectionValueOn  ZonesHotlinkProtectionValue = "on"
	ZonesHotlinkProtectionValueOff ZonesHotlinkProtectionValue = "off"
)

type ZonesIPGeolocation 

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

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

type ZonesIPGeolocationEditable 

type ZonesIPGeolocationEditable bool

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

const (
	ZonesIPGeolocationEditableTrue  ZonesIPGeolocationEditable = true
	ZonesIPGeolocationEditableFalse ZonesIPGeolocationEditable = false
)

type ZonesIPGeolocationID 

type ZonesIPGeolocationID string

ID of the zone setting. 

const (
	ZonesIPGeolocationIDIPGeolocation ZonesIPGeolocationID = "ip_geolocation"
)

type ZonesIPGeolocationParam 

type ZonesIPGeolocationParam struct {
	// ID of the zone setting.
	ID param.Field[ZonesIPGeolocationID] `json:"id,required"`
	// Current value of the zone setting.
	Value param.Field[ZonesIPGeolocationValue] `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 (ZonesIPGeolocationParam) MarshalJSON 

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

type ZonesIPGeolocationValue 

type ZonesIPGeolocationValue string

Current value of the zone setting. 

const (
	ZonesIPGeolocationValueOn  ZonesIPGeolocationValue = "on"
	ZonesIPGeolocationValueOff ZonesIPGeolocationValue = "off"
)

type ZonesIPV6 

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

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

func (*ZonesIPV6) UnmarshalJSON 

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

type ZonesIPV6Editable 

type ZonesIPV6Editable bool

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

const (
	ZonesIPV6EditableTrue  ZonesIPV6Editable = true
	ZonesIPV6EditableFalse ZonesIPV6Editable = false
)

type ZonesIPV6ID 

type ZonesIPV6ID string

ID of the zone setting. 

const (
	ZonesIPV6IDIPV6 ZonesIPV6ID = "ipv6"
)

type ZonesIPV6Param 

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

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

func (ZonesIPV6Param) MarshalJSON 

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

type ZonesIPV6Value 

type ZonesIPV6Value string

Current value of the zone setting. 

const (
	ZonesIPV6ValueOff ZonesIPV6Value = "off"
	ZonesIPV6ValueOn  ZonesIPV6Value = "on"
)

type ZonesImageResizing 

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

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

type ZonesImageResizingEditable 

type ZonesImageResizingEditable bool

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

const (
	ZonesImageResizingEditableTrue  ZonesImageResizingEditable = true
	ZonesImageResizingEditableFalse ZonesImageResizingEditable = false
)

type ZonesImageResizingID 

type ZonesImageResizingID string

ID of the zone setting. 

const (
	ZonesImageResizingIDImageResizing ZonesImageResizingID = "image_resizing"
)

type ZonesImageResizingParam 

type ZonesImageResizingParam struct {
	// ID of the zone setting.
	ID param.Field[ZonesImageResizingID] `json:"id,required"`
	// Current value of the zone setting.
	Value param.Field[ZonesImageResizingValue] `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 (ZonesImageResizingParam) MarshalJSON 

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

type ZonesImageResizingValue 

type ZonesImageResizingValue string

Current value of the zone setting. 

const (
	ZonesImageResizingValueOn   ZonesImageResizingValue = "on"
	ZonesImageResizingValueOff  ZonesImageResizingValue = "off"
	ZonesImageResizingValueOpen ZonesImageResizingValue = "open"
)

type ZonesMinTLSVersion 

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

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

type ZonesMinTLSVersionEditable 

type ZonesMinTLSVersionEditable bool

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

const (
	ZonesMinTLSVersionEditableTrue  ZonesMinTLSVersionEditable = true
	ZonesMinTLSVersionEditableFalse ZonesMinTLSVersionEditable = false
)

type ZonesMinTLSVersionID 

type ZonesMinTLSVersionID string

ID of the zone setting. 

const (
	ZonesMinTLSVersionIDMinTLSVersion ZonesMinTLSVersionID = "min_tls_version"
)

type ZonesMinTLSVersionParam 

type ZonesMinTLSVersionParam struct {
	// ID of the zone setting.
	ID param.Field[ZonesMinTLSVersionID] `json:"id,required"`
	// Current value of the zone setting.
	Value param.Field[ZonesMinTLSVersionValue] `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 (ZonesMinTLSVersionParam) MarshalJSON 

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

type ZonesMinTLSVersionValue 

type ZonesMinTLSVersionValue string

Current value of the zone setting. 

const (
	ZonesMinTLSVersionValue1_0 ZonesMinTLSVersionValue = "1.0"
	ZonesMinTLSVersionValue1_1 ZonesMinTLSVersionValue = "1.1"
	ZonesMinTLSVersionValue1_2 ZonesMinTLSVersionValue = "1.2"
	ZonesMinTLSVersionValue1_3 ZonesMinTLSVersionValue = "1.3"
)

type ZonesMinify 

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

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

type ZonesMinifyEditable 

type ZonesMinifyEditable bool

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

const (
	ZonesMinifyEditableTrue  ZonesMinifyEditable = true
	ZonesMinifyEditableFalse ZonesMinifyEditable = false
)

type ZonesMinifyID 

type ZonesMinifyID string

Zone setting identifier. 

const (
	ZonesMinifyIDMinify ZonesMinifyID = "minify"
)

type ZonesMinifyParam 

type ZonesMinifyParam struct {
	// Zone setting identifier.
	ID param.Field[ZonesMinifyID] `json:"id,required"`
	// Current value of the zone setting.
	Value param.Field[ZonesMinifyValueParam] `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 (ZonesMinifyParam) MarshalJSON 

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

type ZonesMinifyValue 

type ZonesMinifyValue struct {
	// Automatically minify all CSS files for your website.
	Css ZonesMinifyValueCss `json:"css"`
	// Automatically minify all HTML files for your website.
	HTML ZonesMinifyValueHTML `json:"html"`
	// Automatically minify all JavaScript files for your website.
	Js   ZonesMinifyValueJs   `json:"js"`
	JSON zonesMinifyValueJSON `json:"-"`
}

Current value of the zone setting.

func (*ZonesMinifyValue) UnmarshalJSON 

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

type ZonesMinifyValueCss 

type ZonesMinifyValueCss string

Automatically minify all CSS files for your website. 

const (
	ZonesMinifyValueCssOn  ZonesMinifyValueCss = "on"
	ZonesMinifyValueCssOff ZonesMinifyValueCss = "off"
)

type ZonesMinifyValueHTML 

type ZonesMinifyValueHTML string

Automatically minify all HTML files for your website. 

const (
	ZonesMinifyValueHTMLOn  ZonesMinifyValueHTML = "on"
	ZonesMinifyValueHTMLOff ZonesMinifyValueHTML = "off"
)

type ZonesMinifyValueJs 

type ZonesMinifyValueJs string

Automatically minify all JavaScript files for your website. 

const (
	ZonesMinifyValueJsOn  ZonesMinifyValueJs = "on"
	ZonesMinifyValueJsOff ZonesMinifyValueJs = "off"
)

type ZonesMinifyValueParam 

type ZonesMinifyValueParam struct {
	// Automatically minify all CSS files for your website.
	Css param.Field[ZonesMinifyValueCss] `json:"css"`
	// Automatically minify all HTML files for your website.
	HTML param.Field[ZonesMinifyValueHTML] `json:"html"`
	// Automatically minify all JavaScript files for your website.
	Js param.Field[ZonesMinifyValueJs] `json:"js"`
}

Current value of the zone setting.

func (ZonesMinifyValueParam) MarshalJSON 

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

type ZonesMirage 

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

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

type ZonesMirageEditable 

type ZonesMirageEditable bool

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

const (
	ZonesMirageEditableTrue  ZonesMirageEditable = true
	ZonesMirageEditableFalse ZonesMirageEditable = false
)

type ZonesMirageID 

type ZonesMirageID string

ID of the zone setting. 

const (
	ZonesMirageIDMirage ZonesMirageID = "mirage"
)

type ZonesMirageParam 

type ZonesMirageParam struct {
	// ID of the zone setting.
	ID param.Field[ZonesMirageID] `json:"id,required"`
	// Current value of the zone setting.
	Value param.Field[ZonesMirageValue] `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 (ZonesMirageParam) MarshalJSON 

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

type ZonesMirageValue 

type ZonesMirageValue string

Current value of the zone setting. 

const (
	ZonesMirageValueOn  ZonesMirageValue = "on"
	ZonesMirageValueOff ZonesMirageValue = "off"
)

type ZonesMobileRedirect 

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

Automatically redirect visitors on mobile devices to a mobile-optimized subdomain. Refer to [Understanding Cloudflare Mobile Redirect](https://support.cloudflare.com/hc/articles/200168336) for more information.

func (*ZonesMobileRedirect) UnmarshalJSON 

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

type ZonesMobileRedirectEditable 

type ZonesMobileRedirectEditable bool

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

const (
	ZonesMobileRedirectEditableTrue  ZonesMobileRedirectEditable = true
	ZonesMobileRedirectEditableFalse ZonesMobileRedirectEditable = false
)

type ZonesMobileRedirectID 

type ZonesMobileRedirectID string

Identifier of the zone setting. 

const (
	ZonesMobileRedirectIDMobileRedirect ZonesMobileRedirectID = "mobile_redirect"
)

type ZonesMobileRedirectParam 

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

Automatically redirect visitors on mobile devices to a mobile-optimized subdomain. Refer to [Understanding Cloudflare Mobile Redirect](https://support.cloudflare.com/hc/articles/200168336) for more information.

func (ZonesMobileRedirectParam) MarshalJSON 

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

type ZonesMobileRedirectValue 

type ZonesMobileRedirectValue struct {
	// Which subdomain prefix you wish to redirect visitors on mobile devices to
	// (subdomain must already exist).
	MobileSubdomain string `json:"mobile_subdomain,nullable"`
	// Whether or not mobile redirect is enabled.
	Status ZonesMobileRedirectValueStatus `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     zonesMobileRedirectValueJSON `json:"-"`
}

Current value of the zone setting.

func (*ZonesMobileRedirectValue) UnmarshalJSON 

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

type ZonesMobileRedirectValueParam 

type ZonesMobileRedirectValueParam struct {
	// Which subdomain prefix you wish to redirect visitors on mobile devices to
	// (subdomain must already exist).
	MobileSubdomain param.Field[string] `json:"mobile_subdomain"`
	// Whether or not mobile redirect is enabled.
	Status param.Field[ZonesMobileRedirectValueStatus] `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 (ZonesMobileRedirectValueParam) MarshalJSON 

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

type ZonesMobileRedirectValueStatus 

type ZonesMobileRedirectValueStatus string

Whether or not mobile redirect is enabled. 

const (
	ZonesMobileRedirectValueStatusOn  ZonesMobileRedirectValueStatus = "on"
	ZonesMobileRedirectValueStatusOff ZonesMobileRedirectValueStatus = "off"
)

type ZonesNEL 

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

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

func (*ZonesNEL) UnmarshalJSON 

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

type ZonesNELEditable 

type ZonesNELEditable bool

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

const (
	ZonesNELEditableTrue  ZonesNELEditable = true
	ZonesNELEditableFalse ZonesNELEditable = false
)

type ZonesNELID 

type ZonesNELID string

Zone setting identifier. 

const (
	ZonesNELIDNEL ZonesNELID = "nel"
)

type ZonesNELParam 

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

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

func (ZonesNELParam) MarshalJSON 

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

type ZonesNELValue 

type ZonesNELValue struct {
	Enabled bool              `json:"enabled"`
	JSON    zonesNELValueJSON `json:"-"`
}

Current value of the zone setting.

func (*ZonesNELValue) UnmarshalJSON 

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

type ZonesNELValueParam 

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

Current value of the zone setting.

func (ZonesNELValueParam) MarshalJSON 

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

type ZonesOpportunisticEncryption 

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

Enables the Opportunistic Encryption feature for a zone.

func (*ZonesOpportunisticEncryption) UnmarshalJSON 

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

type ZonesOpportunisticEncryptionEditable 

type ZonesOpportunisticEncryptionEditable bool

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

const (
	ZonesOpportunisticEncryptionEditableTrue  ZonesOpportunisticEncryptionEditable = true
	ZonesOpportunisticEncryptionEditableFalse ZonesOpportunisticEncryptionEditable = false
)

type ZonesOpportunisticEncryptionID 

type ZonesOpportunisticEncryptionID string

ID of the zone setting. 

const (
	ZonesOpportunisticEncryptionIDOpportunisticEncryption ZonesOpportunisticEncryptionID = "opportunistic_encryption"
)

type ZonesOpportunisticEncryptionParam 

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

Enables the Opportunistic Encryption feature for a zone.

func (ZonesOpportunisticEncryptionParam) MarshalJSON 

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

type ZonesOpportunisticEncryptionValue 

type ZonesOpportunisticEncryptionValue string

Current value of the zone setting. 

const (
	ZonesOpportunisticEncryptionValueOn  ZonesOpportunisticEncryptionValue = "on"
	ZonesOpportunisticEncryptionValueOff ZonesOpportunisticEncryptionValue = "off"
)

type ZonesOpportunisticOnion 

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

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

type ZonesOpportunisticOnionEditable 

type ZonesOpportunisticOnionEditable bool

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

const (
	ZonesOpportunisticOnionEditableTrue  ZonesOpportunisticOnionEditable = true
	ZonesOpportunisticOnionEditableFalse ZonesOpportunisticOnionEditable = false
)

type ZonesOpportunisticOnionID 

type ZonesOpportunisticOnionID string

ID of the zone setting. 

const (
	ZonesOpportunisticOnionIDOpportunisticOnion ZonesOpportunisticOnionID = "opportunistic_onion"
)

type ZonesOpportunisticOnionParam 

type ZonesOpportunisticOnionParam struct {
	// ID of the zone setting.
	ID param.Field[ZonesOpportunisticOnionID] `json:"id,required"`
	// Current value of the zone setting.
	Value param.Field[ZonesOpportunisticOnionValue] `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 (ZonesOpportunisticOnionParam) MarshalJSON 

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

type ZonesOpportunisticOnionValue 

type ZonesOpportunisticOnionValue string

Current value of the zone setting. 

const (
	ZonesOpportunisticOnionValueOn  ZonesOpportunisticOnionValue = "on"
	ZonesOpportunisticOnionValueOff ZonesOpportunisticOnionValue = "off"
)

type ZonesOrangeToOrange 

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

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

func (*ZonesOrangeToOrange) UnmarshalJSON 

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

type ZonesOrangeToOrangeEditable 

type ZonesOrangeToOrangeEditable bool

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

const (
	ZonesOrangeToOrangeEditableTrue  ZonesOrangeToOrangeEditable = true
	ZonesOrangeToOrangeEditableFalse ZonesOrangeToOrangeEditable = false
)

type ZonesOrangeToOrangeID 

type ZonesOrangeToOrangeID string

ID of the zone setting. 

const (
	ZonesOrangeToOrangeIDOrangeToOrange ZonesOrangeToOrangeID = "orange_to_orange"
)

type ZonesOrangeToOrangeParam 

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

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

func (ZonesOrangeToOrangeParam) MarshalJSON 

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

type ZonesOrangeToOrangeValue 

type ZonesOrangeToOrangeValue string

Current value of the zone setting. 

const (
	ZonesOrangeToOrangeValueOn  ZonesOrangeToOrangeValue = "on"
	ZonesOrangeToOrangeValueOff ZonesOrangeToOrangeValue = "off"
)

type ZonesOriginErrorPagePassThru 

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

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

type ZonesOriginErrorPagePassThruEditable 

type ZonesOriginErrorPagePassThruEditable bool

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

const (
	ZonesOriginErrorPagePassThruEditableTrue  ZonesOriginErrorPagePassThruEditable = true
	ZonesOriginErrorPagePassThruEditableFalse ZonesOriginErrorPagePassThruEditable = false
)

type ZonesOriginErrorPagePassThruID 

type ZonesOriginErrorPagePassThruID string

ID of the zone setting. 

const (
	ZonesOriginErrorPagePassThruIDOriginErrorPagePassThru ZonesOriginErrorPagePassThruID = "origin_error_page_pass_thru"
)

type ZonesOriginErrorPagePassThruParam 

type ZonesOriginErrorPagePassThruParam struct {
	// ID of the zone setting.
	ID param.Field[ZonesOriginErrorPagePassThruID] `json:"id,required"`
	// Current value of the zone setting.
	Value param.Field[ZonesOriginErrorPagePassThruValue] `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 (ZonesOriginErrorPagePassThruParam) MarshalJSON 

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

type ZonesOriginErrorPagePassThruValue 

type ZonesOriginErrorPagePassThruValue string

Current value of the zone setting. 

const (
	ZonesOriginErrorPagePassThruValueOn  ZonesOriginErrorPagePassThruValue = "on"
	ZonesOriginErrorPagePassThruValueOff ZonesOriginErrorPagePassThruValue = "off"
)

type ZonesPolish 

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

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

type ZonesPolishEditable 

type ZonesPolishEditable bool

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

const (
	ZonesPolishEditableTrue  ZonesPolishEditable = true
	ZonesPolishEditableFalse ZonesPolishEditable = false
)

type ZonesPolishID 

type ZonesPolishID string

ID of the zone setting. 

const (
	ZonesPolishIDPolish ZonesPolishID = "polish"
)

type ZonesPolishParam 

type ZonesPolishParam struct {
	// ID of the zone setting.
	ID param.Field[ZonesPolishID] `json:"id,required"`
	// Current value of the zone setting.
	Value param.Field[ZonesPolishValue] `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 (ZonesPolishParam) MarshalJSON 

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

type ZonesPolishValue 

type ZonesPolishValue string

Current value of the zone setting. 

const (
	ZonesPolishValueOff      ZonesPolishValue = "off"
	ZonesPolishValueLossless ZonesPolishValue = "lossless"
	ZonesPolishValueLossy    ZonesPolishValue = "lossy"
)

type ZonesPrefetchPreload 

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

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

func (*ZonesPrefetchPreload) UnmarshalJSON 

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

type ZonesPrefetchPreloadEditable 

type ZonesPrefetchPreloadEditable bool

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

const (
	ZonesPrefetchPreloadEditableTrue  ZonesPrefetchPreloadEditable = true
	ZonesPrefetchPreloadEditableFalse ZonesPrefetchPreloadEditable = false
)

type ZonesPrefetchPreloadID 

type ZonesPrefetchPreloadID string

ID of the zone setting. 

const (
	ZonesPrefetchPreloadIDPrefetchPreload ZonesPrefetchPreloadID = "prefetch_preload"
)

type ZonesPrefetchPreloadParam 

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

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

func (ZonesPrefetchPreloadParam) MarshalJSON 

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

type ZonesPrefetchPreloadValue 

type ZonesPrefetchPreloadValue string

Current value of the zone setting. 

const (
	ZonesPrefetchPreloadValueOn  ZonesPrefetchPreloadValue = "on"
	ZonesPrefetchPreloadValueOff ZonesPrefetchPreloadValue = "off"
)

type ZonesProxyReadTimeout 

type ZonesProxyReadTimeout struct {
	// ID of the zone setting.
	ID ZonesProxyReadTimeoutID `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 ZonesProxyReadTimeoutEditable `json:"editable"`
	// last time this setting was modified.
	ModifiedOn time.Time                 `json:"modified_on,nullable" format:"date-time"`
	JSON       zonesProxyReadTimeoutJSON `json:"-"`
}

Maximum time between two read operations from origin.

func (*ZonesProxyReadTimeout) UnmarshalJSON 

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

type ZonesProxyReadTimeoutEditable 

type ZonesProxyReadTimeoutEditable bool

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

const (
	ZonesProxyReadTimeoutEditableTrue  ZonesProxyReadTimeoutEditable = true
	ZonesProxyReadTimeoutEditableFalse ZonesProxyReadTimeoutEditable = false
)

type ZonesProxyReadTimeoutID 

type ZonesProxyReadTimeoutID string

ID of the zone setting. 

const (
	ZonesProxyReadTimeoutIDProxyReadTimeout ZonesProxyReadTimeoutID = "proxy_read_timeout"
)

type ZonesProxyReadTimeoutParam 

type ZonesProxyReadTimeoutParam struct {
	// ID of the zone setting.
	ID param.Field[ZonesProxyReadTimeoutID] `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 (ZonesProxyReadTimeoutParam) MarshalJSON 

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

type ZonesPseudoIPV4 

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

The value set for the Pseudo IPv4 setting.

func (*ZonesPseudoIPV4) UnmarshalJSON 

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

type ZonesPseudoIPV4Editable 

type ZonesPseudoIPV4Editable bool

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

const (
	ZonesPseudoIPV4EditableTrue  ZonesPseudoIPV4Editable = true
	ZonesPseudoIPV4EditableFalse ZonesPseudoIPV4Editable = false
)

type ZonesPseudoIPV4ID 

type ZonesPseudoIPV4ID string

Value of the Pseudo IPv4 setting. 

const (
	ZonesPseudoIPV4IDPseudoIPV4 ZonesPseudoIPV4ID = "pseudo_ipv4"
)

type ZonesPseudoIPV4Param 

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

The value set for the Pseudo IPv4 setting.

func (ZonesPseudoIPV4Param) MarshalJSON 

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

type ZonesPseudoIPV4Value 

type ZonesPseudoIPV4Value string

Current value of the zone setting. 

const (
	ZonesPseudoIPV4ValueOff             ZonesPseudoIPV4Value = "off"
	ZonesPseudoIPV4ValueAddHeader       ZonesPseudoIPV4Value = "add_header"
	ZonesPseudoIPV4ValueOverwriteHeader ZonesPseudoIPV4Value = "overwrite_header"
)

type ZonesRocketLoader 

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

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

type ZonesRocketLoaderEditable 

type ZonesRocketLoaderEditable bool

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

const (
	ZonesRocketLoaderEditableTrue  ZonesRocketLoaderEditable = true
	ZonesRocketLoaderEditableFalse ZonesRocketLoaderEditable = false
)

type ZonesRocketLoaderID 

type ZonesRocketLoaderID string

ID of the zone setting. 

const (
	ZonesRocketLoaderIDRocketLoader ZonesRocketLoaderID = "rocket_loader"
)

type ZonesRocketLoaderParam 

type ZonesRocketLoaderParam struct {
	// ID of the zone setting.
	ID param.Field[ZonesRocketLoaderID] `json:"id,required"`
	// Current value of the zone setting.
	Value param.Field[ZonesRocketLoaderValue] `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 (ZonesRocketLoaderParam) MarshalJSON 

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

type ZonesRocketLoaderValue 

type ZonesRocketLoaderValue string

Current value of the zone setting. 

const (
	ZonesRocketLoaderValueOn  ZonesRocketLoaderValue = "on"
	ZonesRocketLoaderValueOff ZonesRocketLoaderValue = "off"
)

type ZonesSSL 

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

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

type ZonesSSLEditable 

type ZonesSSLEditable bool

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

const (
	ZonesSSLEditableTrue  ZonesSSLEditable = true
	ZonesSSLEditableFalse ZonesSSLEditable = false
)

type ZonesSSLID 

type ZonesSSLID string

ID of the zone setting. 

const (
	ZonesSSLIDSSL ZonesSSLID = "ssl"
)

type ZonesSSLParam 

type ZonesSSLParam struct {
	// ID of the zone setting.
	ID param.Field[ZonesSSLID] `json:"id,required"`
	// Current value of the zone setting.
	Value param.Field[ZonesSSLValue] `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 (ZonesSSLParam) MarshalJSON 

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

type ZonesSSLRecommender 

type ZonesSSLRecommender struct {
	// Enrollment value for SSL/TLS Recommender.
	ID ZonesSSLRecommenderID `json:"id"`
	// ssl-recommender enrollment setting.
	Enabled bool                    `json:"enabled"`
	JSON    zonesSSLRecommenderJSON `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 (*ZonesSSLRecommender) UnmarshalJSON 

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

type ZonesSSLRecommenderID 

type ZonesSSLRecommenderID string

Enrollment value for SSL/TLS Recommender. 

const (
	ZonesSSLRecommenderIDSSLRecommender ZonesSSLRecommenderID = "ssl_recommender"
)

type ZonesSSLRecommenderParam 

type ZonesSSLRecommenderParam struct {
	// Enrollment value for SSL/TLS Recommender.
	ID param.Field[ZonesSSLRecommenderID] `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 (ZonesSSLRecommenderParam) MarshalJSON 

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

type ZonesSSLValue 

type ZonesSSLValue string

Current value of the zone setting. 

const (
	ZonesSSLValueOff      ZonesSSLValue = "off"
	ZonesSSLValueFlexible ZonesSSLValue = "flexible"
	ZonesSSLValueFull     ZonesSSLValue = "full"
	ZonesSSLValueStrict   ZonesSSLValue = "strict"
)

type ZonesSecurityHeader 

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

Cloudflare security header for a zone.

func (*ZonesSecurityHeader) UnmarshalJSON 

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

type ZonesSecurityHeaderEditable 

type ZonesSecurityHeaderEditable bool

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

const (
	ZonesSecurityHeaderEditableTrue  ZonesSecurityHeaderEditable = true
	ZonesSecurityHeaderEditableFalse ZonesSecurityHeaderEditable = false
)

type ZonesSecurityHeaderID 

type ZonesSecurityHeaderID string

ID of the zone's security header. 

const (
	ZonesSecurityHeaderIDSecurityHeader ZonesSecurityHeaderID = "security_header"
)

type ZonesSecurityHeaderParam 

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

Cloudflare security header for a zone.

func (ZonesSecurityHeaderParam) MarshalJSON 

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

type ZonesSecurityHeaderValue 

type ZonesSecurityHeaderValue struct {
	// Strict Transport Security.
	StrictTransportSecurity ZonesSecurityHeaderValueStrictTransportSecurity `json:"strict_transport_security"`
	JSON                    zonesSecurityHeaderValueJSON                    `json:"-"`
}

Current value of the zone setting.

func (*ZonesSecurityHeaderValue) UnmarshalJSON 

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

type ZonesSecurityHeaderValueParam 

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

Current value of the zone setting.

func (ZonesSecurityHeaderValueParam) MarshalJSON 

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

type ZonesSecurityHeaderValueStrictTransportSecurity 

type ZonesSecurityHeaderValueStrictTransportSecurity 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"`
	JSON    zonesSecurityHeaderValueStrictTransportSecurityJSON `json:"-"`
}

Strict Transport Security.

func (*ZonesSecurityHeaderValueStrictTransportSecurity) UnmarshalJSON 

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

type ZonesSecurityHeaderValueStrictTransportSecurityParam 

type ZonesSecurityHeaderValueStrictTransportSecurityParam 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"`
}

Strict Transport Security.

func (ZonesSecurityHeaderValueStrictTransportSecurityParam) MarshalJSON 

func (r ZonesSecurityHeaderValueStrictTransportSecurityParam) MarshalJSON() (data []byte, err error)

type ZonesSecurityLevel 

type ZonesSecurityLevel struct {
	// ID of the zone setting.
	ID ZonesSecurityLevelID `json:"id,required"`
	// Current value of the zone setting.
	Value ZonesSecurityLevelValue `json:"value,required"`
	// Whether or not this setting can be modified for this zone (based on your
	// Cloudflare plan level).
	Editable ZonesSecurityLevelEditable `json:"editable"`
	// last time this setting was modified.
	ModifiedOn time.Time              `json:"modified_on,nullable" format:"date-time"`
	JSON       zonesSecurityLevelJSON `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 (*ZonesSecurityLevel) UnmarshalJSON 

func (r *ZonesSecurityLevel) UnmarshalJSON(data []byte) (err error)

type ZonesSecurityLevelEditable 

type ZonesSecurityLevelEditable bool

Whether or not this setting can be modified for this zone (based on your Cloudflare plan level). 

const (
	ZonesSecurityLevelEditableTrue  ZonesSecurityLevelEditable = true
	ZonesSecurityLevelEditableFalse ZonesSecurityLevelEditable = false
)

type ZonesSecurityLevelID 

type ZonesSecurityLevelID string

ID of the zone setting. 

const (
	ZonesSecurityLevelIDSecurityLevel ZonesSecurityLevelID = "security_level"
)

type ZonesSecurityLevelParam 

type ZonesSecurityLevelParam struct {
	// ID of the zone setting.
	ID param.Field[ZonesSecurityLevelID] `json:"id,required"`
	// Current value of the zone setting.
	Value param.Field[ZonesSecurityLevelValue] `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 (ZonesSecurityLevelParam) MarshalJSON 

func (r ZonesSecurityLevelParam) MarshalJSON() (data []byte, err error)

type ZonesSecurityLevelValue 

type ZonesSecurityLevelValue string

Current value of the zone setting. 

const (
	ZonesSecurityLevelValueOff            ZonesSecurityLevelValue = "off"
	ZonesSecurityLevelValueEssentiallyOff ZonesSecurityLevelValue = "essentially_off"
	ZonesSecurityLevelValueLow            ZonesSecurityLevelValue = "low"
	ZonesSecurityLevelValueMedium         ZonesSecurityLevelValue = "medium"
	ZonesSecurityLevelValueHigh           ZonesSecurityLevelValue = "high"
	ZonesSecurityLevelValueUnderAttack    ZonesSecurityLevelValue = "under_attack"
)

type ZonesServerSideExclude 

type ZonesServerSideExclude struct {
	// ID of the zone setting.
	ID ZonesServerSideExcludeID `json:"id,required"`
	// Current value of the zone setting.
	Value ZonesServerSideExcludeValue `json:"value,required"`
	// Whether or not this setting can be modified for this zone (based on your
	// Cloudflare plan level).
	Editable ZonesServerSideExcludeEditable `json:"editable"`
	// last time this setting was modified.
	ModifiedOn time.Time                  `json:"modified_on,nullable" format:"date-time"`
	JSON       zonesServerSideExcludeJSON `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 (*ZonesServerSideExclude) UnmarshalJSON 

func (r *ZonesServerSideExclude) UnmarshalJSON(data []byte) (err error)

type ZonesServerSideExcludeEditable 

type ZonesServerSideExcludeEditable bool

Whether or not this setting can be modified for this zone (based on your Cloudflare plan level). 

const (
	ZonesServerSideExcludeEditableTrue  ZonesServerSideExcludeEditable = true
	ZonesServerSideExcludeEditableFalse ZonesServerSideExcludeEditable = false
)

type ZonesServerSideExcludeID 

type ZonesServerSideExcludeID string

ID of the zone setting. 

const (
	ZonesServerSideExcludeIDServerSideExclude ZonesServerSideExcludeID = "server_side_exclude"
)

type ZonesServerSideExcludeParam 

type ZonesServerSideExcludeParam struct {
	// ID of the zone setting.
	ID param.Field[ZonesServerSideExcludeID] `json:"id,required"`
	// Current value of the zone setting.
	Value param.Field[ZonesServerSideExcludeValue] `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 (ZonesServerSideExcludeParam) MarshalJSON 

func (r ZonesServerSideExcludeParam) MarshalJSON() (data []byte, err error)

type ZonesServerSideExcludeValue 

type ZonesServerSideExcludeValue string

Current value of the zone setting. 

const (
	ZonesServerSideExcludeValueOn  ZonesServerSideExcludeValue = "on"
	ZonesServerSideExcludeValueOff ZonesServerSideExcludeValue = "off"
)

type ZonesSortQueryStringForCache 

type ZonesSortQueryStringForCache struct {
	// ID of the zone setting.
	ID ZonesSortQueryStringForCacheID `json:"id,required"`
	// Current value of the zone setting.
	Value ZonesSortQueryStringForCacheValue `json:"value,required"`
	// Whether or not this setting can be modified for this zone (based on your
	// Cloudflare plan level).
	Editable ZonesSortQueryStringForCacheEditable `json:"editable"`
	// last time this setting was modified.
	ModifiedOn time.Time                        `json:"modified_on,nullable" format:"date-time"`
	JSON       zonesSortQueryStringForCacheJSON `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 (*ZonesSortQueryStringForCache) UnmarshalJSON 

func (r *ZonesSortQueryStringForCache) UnmarshalJSON(data []byte) (err error)

type ZonesSortQueryStringForCacheEditable 

type ZonesSortQueryStringForCacheEditable bool

Whether or not this setting can be modified for this zone (based on your Cloudflare plan level). 

const (
	ZonesSortQueryStringForCacheEditableTrue  ZonesSortQueryStringForCacheEditable = true
	ZonesSortQueryStringForCacheEditableFalse ZonesSortQueryStringForCacheEditable = false
)

type ZonesSortQueryStringForCacheID 

type ZonesSortQueryStringForCacheID string

ID of the zone setting. 

const (
	ZonesSortQueryStringForCacheIDSortQueryStringForCache ZonesSortQueryStringForCacheID = "sort_query_string_for_cache"
)

type ZonesSortQueryStringForCacheParam 

type ZonesSortQueryStringForCacheParam struct {
	// ID of the zone setting.
	ID param.Field[ZonesSortQueryStringForCacheID] `json:"id,required"`
	// Current value of the zone setting.
	Value param.Field[ZonesSortQueryStringForCacheValue] `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 (ZonesSortQueryStringForCacheParam) MarshalJSON 

func (r ZonesSortQueryStringForCacheParam) MarshalJSON() (data []byte, err error)

type ZonesSortQueryStringForCacheValue 

type ZonesSortQueryStringForCacheValue string

Current value of the zone setting. 

const (
	ZonesSortQueryStringForCacheValueOn  ZonesSortQueryStringForCacheValue = "on"
	ZonesSortQueryStringForCacheValueOff ZonesSortQueryStringForCacheValue = "off"
)

type ZonesTLS1_3 

type ZonesTLS1_3 struct {
	// ID of the zone setting.
	ID ZonesTLS1_3ID `json:"id,required"`
	// Current value of the zone setting.
	Value ZonesTLS1_3Value `json:"value,required"`
	// Whether or not this setting can be modified for this zone (based on your
	// Cloudflare plan level).
	Editable ZonesTLS1_3Editable `json:"editable"`
	// last time this setting was modified.
	ModifiedOn time.Time       `json:"modified_on,nullable" format:"date-time"`
	JSON       zonesTls1_3JSON `json:"-"`
}

Enables Crypto TLS 1.3 feature for a zone.

func (*ZonesTLS1_3) UnmarshalJSON 

func (r *ZonesTLS1_3) UnmarshalJSON(data []byte) (err error)

type ZonesTLS1_3Editable 

type ZonesTLS1_3Editable bool

Whether or not this setting can be modified for this zone (based on your Cloudflare plan level). 

const (
	ZonesTLS1_3EditableTrue  ZonesTLS1_3Editable = true
	ZonesTLS1_3EditableFalse ZonesTLS1_3Editable = false
)

type ZonesTLS1_3ID 

type ZonesTLS1_3ID string

ID of the zone setting. 

const (
	ZonesTLS1_3IDTLS1_3 ZonesTLS1_3ID = "tls_1_3"
)

type ZonesTLS1_3Param 

type ZonesTLS1_3Param struct {
	// ID of the zone setting.
	ID param.Field[ZonesTLS1_3ID] `json:"id,required"`
	// Current value of the zone setting.
	Value param.Field[ZonesTLS1_3Value] `json:"value,required"`
}

Enables Crypto TLS 1.3 feature for a zone.

func (ZonesTLS1_3Param) MarshalJSON 

func (r ZonesTLS1_3Param) MarshalJSON() (data []byte, err error)

type ZonesTLS1_3Value 

type ZonesTLS1_3Value string

Current value of the zone setting. 

const (
	ZonesTLS1_3ValueOn  ZonesTLS1_3Value = "on"
	ZonesTLS1_3ValueOff ZonesTLS1_3Value = "off"
	ZonesTLS1_3ValueZrt ZonesTLS1_3Value = "zrt"
)

type ZonesTLSClientAuth 

type ZonesTLSClientAuth struct {
	// ID of the zone setting.
	ID ZonesTLSClientAuthID `json:"id,required"`
	// Current value of the zone setting.
	Value ZonesTLSClientAuthValue `json:"value,required"`
	// Whether or not this setting can be modified for this zone (based on your
	// Cloudflare plan level).
	Editable ZonesTLSClientAuthEditable `json:"editable"`
	// last time this setting was modified.
	ModifiedOn time.Time              `json:"modified_on,nullable" format:"date-time"`
	JSON       zonesTLSClientAuthJSON `json:"-"`
}

TLS Client Auth requires Cloudflare to connect to your origin server using a client certificate (Enterprise Only).

func (*ZonesTLSClientAuth) UnmarshalJSON 

func (r *ZonesTLSClientAuth) UnmarshalJSON(data []byte) (err error)

type ZonesTLSClientAuthEditable 

type ZonesTLSClientAuthEditable bool

Whether or not this setting can be modified for this zone (based on your Cloudflare plan level). 

const (
	ZonesTLSClientAuthEditableTrue  ZonesTLSClientAuthEditable = true
	ZonesTLSClientAuthEditableFalse ZonesTLSClientAuthEditable = false
)

type ZonesTLSClientAuthID 

type ZonesTLSClientAuthID string

ID of the zone setting. 

const (
	ZonesTLSClientAuthIDTLSClientAuth ZonesTLSClientAuthID = "tls_client_auth"
)

type ZonesTLSClientAuthParam 

type ZonesTLSClientAuthParam struct {
	// ID of the zone setting.
	ID param.Field[ZonesTLSClientAuthID] `json:"id,required"`
	// Current value of the zone setting.
	Value param.Field[ZonesTLSClientAuthValue] `json:"value,required"`
}

TLS Client Auth requires Cloudflare to connect to your origin server using a client certificate (Enterprise Only).

func (ZonesTLSClientAuthParam) MarshalJSON 

func (r ZonesTLSClientAuthParam) MarshalJSON() (data []byte, err error)

type ZonesTLSClientAuthValue 

type ZonesTLSClientAuthValue string

Current value of the zone setting. 

const (
	ZonesTLSClientAuthValueOn  ZonesTLSClientAuthValue = "on"
	ZonesTLSClientAuthValueOff ZonesTLSClientAuthValue = "off"
)

type ZonesTrueClientIPHeader 

type ZonesTrueClientIPHeader struct {
	// ID of the zone setting.
	ID ZonesTrueClientIPHeaderID `json:"id,required"`
	// Current value of the zone setting.
	Value ZonesTrueClientIPHeaderValue `json:"value,required"`
	// Whether or not this setting can be modified for this zone (based on your
	// Cloudflare plan level).
	Editable ZonesTrueClientIPHeaderEditable `json:"editable"`
	// last time this setting was modified.
	ModifiedOn time.Time                   `json:"modified_on,nullable" format:"date-time"`
	JSON       zonesTrueClientIPHeaderJSON `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 (*ZonesTrueClientIPHeader) UnmarshalJSON 

func (r *ZonesTrueClientIPHeader) UnmarshalJSON(data []byte) (err error)

type ZonesTrueClientIPHeaderEditable 

type ZonesTrueClientIPHeaderEditable bool

Whether or not this setting can be modified for this zone (based on your Cloudflare plan level). 

const (
	ZonesTrueClientIPHeaderEditableTrue  ZonesTrueClientIPHeaderEditable = true
	ZonesTrueClientIPHeaderEditableFalse ZonesTrueClientIPHeaderEditable = false
)

type ZonesTrueClientIPHeaderID 

type ZonesTrueClientIPHeaderID string

ID of the zone setting. 

const (
	ZonesTrueClientIPHeaderIDTrueClientIPHeader ZonesTrueClientIPHeaderID = "true_client_ip_header"
)

type ZonesTrueClientIPHeaderParam 

type ZonesTrueClientIPHeaderParam struct {
	// ID of the zone setting.
	ID param.Field[ZonesTrueClientIPHeaderID] `json:"id,required"`
	// Current value of the zone setting.
	Value param.Field[ZonesTrueClientIPHeaderValue] `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 (ZonesTrueClientIPHeaderParam) MarshalJSON 

func (r ZonesTrueClientIPHeaderParam) MarshalJSON() (data []byte, err error)

type ZonesTrueClientIPHeaderValue 

type ZonesTrueClientIPHeaderValue string

Current value of the zone setting. 

const (
	ZonesTrueClientIPHeaderValueOn  ZonesTrueClientIPHeaderValue = "on"
	ZonesTrueClientIPHeaderValueOff ZonesTrueClientIPHeaderValue = "off"
)

type ZonesWAF 

type ZonesWAF struct {
	// ID of the zone setting.
	ID ZonesWAFID `json:"id,required"`
	// Current value of the zone setting.
	Value ZonesWAFValue `json:"value,required"`
	// Whether or not this setting can be modified for this zone (based on your
	// Cloudflare plan level).
	Editable ZonesWAFEditable `json:"editable"`
	// last time this setting was modified.
	ModifiedOn time.Time    `json:"modified_on,nullable" format:"date-time"`
	JSON       zonesWAFJSON `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 (*ZonesWAF) UnmarshalJSON 

func (r *ZonesWAF) UnmarshalJSON(data []byte) (err error)

type ZonesWAFEditable 

type ZonesWAFEditable bool

Whether or not this setting can be modified for this zone (based on your Cloudflare plan level). 

const (
	ZonesWAFEditableTrue  ZonesWAFEditable = true
	ZonesWAFEditableFalse ZonesWAFEditable = false
)

type ZonesWAFID 

type ZonesWAFID string

ID of the zone setting. 

const (
	ZonesWAFIDWAF ZonesWAFID = "waf"
)

type ZonesWAFParam 

type ZonesWAFParam struct {
	// ID of the zone setting.
	ID param.Field[ZonesWAFID] `json:"id,required"`
	// Current value of the zone setting.
	Value param.Field[ZonesWAFValue] `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 (ZonesWAFParam) MarshalJSON 

func (r ZonesWAFParam) MarshalJSON() (data []byte, err error)

type ZonesWAFValue 

type ZonesWAFValue string

Current value of the zone setting. 

const (
	ZonesWAFValueOn  ZonesWAFValue = "on"
	ZonesWAFValueOff ZonesWAFValue = "off"
)

type ZonesWebp 

type ZonesWebp struct {
	// ID of the zone setting.
	ID ZonesWebpID `json:"id,required"`
	// Current value of the zone setting.
	Value ZonesWebpValue `json:"value,required"`
	// Whether or not this setting can be modified for this zone (based on your
	// Cloudflare plan level).
	Editable ZonesWebpEditable `json:"editable"`
	// last time this setting was modified.
	ModifiedOn time.Time     `json:"modified_on,nullable" format:"date-time"`
	JSON       zonesWebpJSON `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 (*ZonesWebp) UnmarshalJSON 

func (r *ZonesWebp) UnmarshalJSON(data []byte) (err error)

type ZonesWebpEditable 

type ZonesWebpEditable bool

Whether or not this setting can be modified for this zone (based on your Cloudflare plan level). 

const (
	ZonesWebpEditableTrue  ZonesWebpEditable = true
	ZonesWebpEditableFalse ZonesWebpEditable = false
)

type ZonesWebpID 

type ZonesWebpID string

ID of the zone setting. 

const (
	ZonesWebpIDWebp ZonesWebpID = "webp"
)

type ZonesWebpParam 

type ZonesWebpParam struct {
	// ID of the zone setting.
	ID param.Field[ZonesWebpID] `json:"id,required"`
	// Current value of the zone setting.
	Value param.Field[ZonesWebpValue] `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 (ZonesWebpParam) MarshalJSON 

func (r ZonesWebpParam) MarshalJSON() (data []byte, err error)

type ZonesWebpValue 

type ZonesWebpValue string

Current value of the zone setting. 

const (
	ZonesWebpValueOff ZonesWebpValue = "off"
	ZonesWebpValueOn  ZonesWebpValue = "on"
)

type ZonesWebsockets 

type ZonesWebsockets struct {
	// ID of the zone setting.
	ID ZonesWebsocketsID `json:"id,required"`
	// Current value of the zone setting.
	Value ZonesWebsocketsValue `json:"value,required"`
	// Whether or not this setting can be modified for this zone (based on your
	// Cloudflare plan level).
	Editable ZonesWebsocketsEditable `json:"editable"`
	// last time this setting was modified.
	ModifiedOn time.Time           `json:"modified_on,nullable" format:"date-time"`
	JSON       zonesWebsocketsJSON `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 (*ZonesWebsockets) UnmarshalJSON 

func (r *ZonesWebsockets) UnmarshalJSON(data []byte) (err error)

type ZonesWebsocketsEditable 

type ZonesWebsocketsEditable bool

Whether or not this setting can be modified for this zone (based on your Cloudflare plan level). 

const (
	ZonesWebsocketsEditableTrue  ZonesWebsocketsEditable = true
	ZonesWebsocketsEditableFalse ZonesWebsocketsEditable = false
)

type ZonesWebsocketsID 

type ZonesWebsocketsID string

ID of the zone setting. 

const (
	ZonesWebsocketsIDWebsockets ZonesWebsocketsID = "websockets"
)

type ZonesWebsocketsParam 

type ZonesWebsocketsParam struct {
	// ID of the zone setting.
	ID param.Field[ZonesWebsocketsID] `json:"id,required"`
	// Current value of the zone setting.
	Value param.Field[ZonesWebsocketsValue] `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 (ZonesWebsocketsParam) MarshalJSON 

func (r ZonesWebsocketsParam) MarshalJSON() (data []byte, err error)

type ZonesWebsocketsValue 

type ZonesWebsocketsValue string

Current value of the zone setting. 

const (
	ZonesWebsocketsValueOff ZonesWebsocketsValue = "off"
	ZonesWebsocketsValueOn  ZonesWebsocketsValue = "on"
)

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.