custom_hostnames

package
v4.2.0 Latest Latest
Warning

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

 Go to latest Published: Mar 18, 2025 License: Apache-2.0 Imports: 14 Imported by: 4

Documentation

Index

Constants

View Source 
const AuditLogActorTypeAdmin = shared.AuditLogActorTypeAdmin

This is an alias to an internal value.

View Source 
const AuditLogActorTypeCloudflare = shared.AuditLogActorTypeCloudflare

This is an alias to an internal value.

View Source 
const AuditLogActorTypeUser = shared.AuditLogActorTypeUser

This is an alias to an internal value.

View Source 
const CertificateCADigicert = shared.CertificateCADigicert

This is an alias to an internal value.

View Source 
const CertificateCAGoogle = shared.CertificateCAGoogle

This is an alias to an internal value.

View Source 
const CertificateCALetsEncrypt = shared.CertificateCALetsEncrypt

This is an alias to an internal value.

View Source 
const CertificateCASSLCom = shared.CertificateCASSLCom

This is an alias to an internal value.

View Source 
const CertificateRequestTypeKeylessCertificate = shared.CertificateRequestTypeKeylessCertificate

This is an alias to an internal value.

View Source 
const CertificateRequestTypeOriginECC = shared.CertificateRequestTypeOriginECC

This is an alias to an internal value.

View Source 
const CertificateRequestTypeOriginRSA = shared.CertificateRequestTypeOriginRSA

This is an alias to an internal value.

View Source 
const CloudflareTunnelStatusDegraded = shared.CloudflareTunnelStatusDegraded

This is an alias to an internal value.

View Source 
const CloudflareTunnelStatusDown = shared.CloudflareTunnelStatusDown

This is an alias to an internal value.

View Source 
const CloudflareTunnelStatusHealthy = shared.CloudflareTunnelStatusHealthy

This is an alias to an internal value.

View Source 
const CloudflareTunnelStatusInactive = shared.CloudflareTunnelStatusInactive

This is an alias to an internal value.

View Source 
const CloudflareTunnelTunTypeCNI = shared.CloudflareTunnelTunTypeCNI

This is an alias to an internal value.

View Source 
const CloudflareTunnelTunTypeCfdTunnel = shared.CloudflareTunnelTunTypeCfdTunnel

This is an alias to an internal value.

View Source 
const CloudflareTunnelTunTypeGRE = shared.CloudflareTunnelTunTypeGRE

This is an alias to an internal value.

View Source 
const CloudflareTunnelTunTypeIPSec = shared.CloudflareTunnelTunTypeIPSec

This is an alias to an internal value.

View Source 
const CloudflareTunnelTunTypeMagic = shared.CloudflareTunnelTunTypeMagic

This is an alias to an internal value.

View Source 
const CloudflareTunnelTunTypeWARP = shared.CloudflareTunnelTunTypeWARP

This is an alias to an internal value.

View Source 
const CloudflareTunnelTunTypeWARPConnector = shared.CloudflareTunnelTunTypeWARPConnector

This is an alias to an internal value.

View Source 
const MemberPoliciesAccessAllow = shared.MemberPoliciesAccessAllow

This is an alias to an internal value.

View Source 
const MemberPoliciesAccessDeny = shared.MemberPoliciesAccessDeny

This is an alias to an internal value.

View Source 
const MemberStatusAccepted = shared.MemberStatusAccepted

This is an alias to an internal value.

View Source 
const MemberStatusPending = shared.MemberStatusPending

This is an alias to an internal value.

View Source 
const RatePlanIDBusiness = shared.RatePlanIDBusiness

This is an alias to an internal value.

View Source 
const RatePlanIDEnterprise = shared.RatePlanIDEnterprise

This is an alias to an internal value.

View Source 
const RatePlanIDFree = shared.RatePlanIDFree

This is an alias to an internal value.

View Source 
const RatePlanIDLite = shared.RatePlanIDLite

This is an alias to an internal value.

View Source 
const RatePlanIDPartnersBusiness = shared.RatePlanIDPartnersBusiness

This is an alias to an internal value.

View Source 
const RatePlanIDPartnersEnterprise = shared.RatePlanIDPartnersEnterprise

This is an alias to an internal value.

View Source 
const RatePlanIDPartnersFree = shared.RatePlanIDPartnersFree

This is an alias to an internal value.

View Source 
const RatePlanIDPartnersPro = shared.RatePlanIDPartnersPro

This is an alias to an internal value.

View Source 
const RatePlanIDPro = shared.RatePlanIDPro

This is an alias to an internal value.

View Source 
const RatePlanIDProPlus = shared.RatePlanIDProPlus

This is an alias to an internal value.

View Source 
const SortDirectionAsc = shared.SortDirectionAsc

This is an alias to an internal value.

View Source 
const SortDirectionDesc = shared.SortDirectionDesc

This is an alias to an internal value.

View Source 
const SubscriptionFrequencyMonthly = shared.SubscriptionFrequencyMonthly

This is an alias to an internal value.

View Source 
const SubscriptionFrequencyQuarterly = shared.SubscriptionFrequencyQuarterly

This is an alias to an internal value.

View Source 
const SubscriptionFrequencyWeekly = shared.SubscriptionFrequencyWeekly

This is an alias to an internal value.

View Source 
const SubscriptionFrequencyYearly = shared.SubscriptionFrequencyYearly

This is an alias to an internal value.

View Source 
const SubscriptionStateAwaitingPayment = shared.SubscriptionStateAwaitingPayment

This is an alias to an internal value.

View Source 
const SubscriptionStateCancelled = shared.SubscriptionStateCancelled

This is an alias to an internal value.

View Source 
const SubscriptionStateExpired = shared.SubscriptionStateExpired

This is an alias to an internal value.

View Source 
const SubscriptionStateFailed = shared.SubscriptionStateFailed

This is an alias to an internal value.

View Source 
const SubscriptionStatePaid = shared.SubscriptionStatePaid

This is an alias to an internal value.

View Source 
const SubscriptionStateProvisioned = shared.SubscriptionStateProvisioned

This is an alias to an internal value.

View Source 
const SubscriptionStateTrial = shared.SubscriptionStateTrial

This is an alias to an internal value.

View Source 
const TokenPolicyEffectAllow = shared.TokenPolicyEffectAllow

This is an alias to an internal value.

View Source 
const TokenPolicyEffectDeny = shared.TokenPolicyEffectDeny

This is an alias to an internal value.

View Source 
const TokenStatusActive = shared.TokenStatusActive

This is an alias to an internal value.

View Source 
const TokenStatusDisabled = shared.TokenStatusDisabled

This is an alias to an internal value.

View Source 
const TokenStatusExpired = shared.TokenStatusExpired

This is an alias to an internal value.

Variables

This section is empty.

Functions

This section is empty.

Types

type ASN 

type ASN = shared.ASN

This is an alias to an internal type.

type ASNParam 

type ASNParam = shared.ASNParam

This is an alias to an internal type.

type AuditLog 

type AuditLog = shared.AuditLog

This is an alias to an internal type.

type AuditLogAction 

type AuditLogAction = shared.AuditLogAction

This is an alias to an internal type.

type AuditLogActor 

type AuditLogActor = shared.AuditLogActor

This is an alias to an internal type.

type AuditLogActorType 

type AuditLogActorType = shared.AuditLogActorType

The type of actor, whether a User, Cloudflare Admin, or an Automated System.

This is an alias to an internal type.

type AuditLogOwner 

type AuditLogOwner = shared.AuditLogOwner

This is an alias to an internal type.

type AuditLogResource 

type AuditLogResource = shared.AuditLogResource

This is an alias to an internal type.

type BundleMethod 

type BundleMethod string

A ubiquitous bundle has the highest probability of being verified everywhere, even by clients using outdated or unusual trust stores. An optimal bundle uses the shortest chain and newest intermediates. And the force bundle verifies the chain, but does not otherwise modify it. 

const (
	BundleMethodUbiquitous BundleMethod = "ubiquitous"
	BundleMethodOptimal    BundleMethod = "optimal"
	BundleMethodForce      BundleMethod = "force"
)

func (BundleMethod) IsKnown 

func (r BundleMethod) IsKnown() bool

type CertificateCA 

type CertificateCA = shared.CertificateCA

The Certificate Authority that will issue the certificate

This is an alias to an internal type.

type CertificatePackCertificateDeleteParams added in v4.1.0 

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

type CertificatePackCertificateDeleteResponse added in v4.1.0 

type CertificatePackCertificateDeleteResponse struct {
	// Identifier
	ID   string                                       `json:"id"`
	JSON certificatePackCertificateDeleteResponseJSON `json:"-"`
}

func (*CertificatePackCertificateDeleteResponse) UnmarshalJSON added in v4.1.0 

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

type CertificatePackCertificateService added in v4.1.0 

type CertificatePackCertificateService struct {
	Options []option.RequestOption
}

CertificatePackCertificateService 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 NewCertificatePackCertificateService method instead.

func NewCertificatePackCertificateService added in v4.1.0 

func NewCertificatePackCertificateService(opts ...option.RequestOption) (r *CertificatePackCertificateService)

NewCertificatePackCertificateService 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 (*CertificatePackCertificateService) Delete added in v4.1.0 

func (r *CertificatePackCertificateService) Delete(ctx context.Context, customHostnameID string, certificatePackID string, certificateID string, body CertificatePackCertificateDeleteParams, opts ...option.RequestOption) (res *CertificatePackCertificateDeleteResponse, err error)

Delete a single custom certificate from a certificate pack that contains two bundled certificates. Deletion is subject to the following constraints. You cannot delete a certificate if it is the only remaining certificate in the pack. At least one certificate must remain in the pack.

func (*CertificatePackCertificateService) Update added in v4.1.0 

func (r *CertificatePackCertificateService) Update(ctx context.Context, customHostnameID string, certificatePackID string, certificateID string, params CertificatePackCertificateUpdateParams, opts ...option.RequestOption) (res *CertificatePackCertificateUpdateResponse, err error)

Replace a single custom certificate within a certificate pack that contains two bundled certificates. The replacement must adhere to the following constraints. You can only replace an RSA certificate with another RSA certificate or an ECDSA certificate with another ECDSA certificate.

type CertificatePackCertificateUpdateParams added in v4.1.0 

type CertificatePackCertificateUpdateParams struct {
	// Identifier
	ZoneID param.Field[string] `path:"zone_id,required"`
	// If a custom uploaded certificate is used.
	CustomCertificate param.Field[string] `json:"custom_certificate,required"`
	// The key for a custom uploaded certificate.
	CustomKey param.Field[string] `json:"custom_key,required"`
}

func (CertificatePackCertificateUpdateParams) MarshalJSON added in v4.1.0 

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

type CertificatePackCertificateUpdateResponse added in v4.1.0 

type CertificatePackCertificateUpdateResponse struct {
	// Identifier
	ID string `json:"id,required"`
	// The custom hostname that will point to your hostname via CNAME.
	Hostname string                                      `json:"hostname,required"`
	SSL      CertificatePackCertificateUpdateResponseSSL `json:"ssl,required"`
	// This is the time the hostname was created.
	CreatedAt time.Time `json:"created_at" format:"date-time"`
	// Unique key/value metadata for this hostname. These are per-hostname (customer)
	// settings.
	CustomMetadata map[string]string `json:"custom_metadata"`
	// a valid hostname that’s been added to your DNS zone as an A, AAAA, or CNAME
	// record.
	CustomOriginServer string `json:"custom_origin_server"`
	// A hostname that will be sent to your custom origin server as SNI for TLS
	// handshake. This can be a valid subdomain of the zone or custom origin server
	// name or the string ':request_host_header:' which will cause the host header in
	// the request to be used as SNI. Not configurable with default/fallback origin
	// server.
	CustomOriginSNI string `json:"custom_origin_sni"`
	// This is a record which can be placed to activate a hostname.
	OwnershipVerification CertificatePackCertificateUpdateResponseOwnershipVerification `json:"ownership_verification"`
	// This presents the token to be served by the given http url to activate a
	// hostname.
	OwnershipVerificationHTTP CertificatePackCertificateUpdateResponseOwnershipVerificationHTTP `json:"ownership_verification_http"`
	// Status of the hostname's activation.
	Status CertificatePackCertificateUpdateResponseStatus `json:"status"`
	// These are errors that were encountered while trying to activate a hostname.
	VerificationErrors []string                                     `json:"verification_errors"`
	JSON               certificatePackCertificateUpdateResponseJSON `json:"-"`
}

func (*CertificatePackCertificateUpdateResponse) UnmarshalJSON added in v4.1.0 

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

type CertificatePackCertificateUpdateResponseEnvelope added in v4.1.0 

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

func (*CertificatePackCertificateUpdateResponseEnvelope) UnmarshalJSON added in v4.1.0 

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

type CertificatePackCertificateUpdateResponseEnvelopeSuccess added in v4.1.0 

type CertificatePackCertificateUpdateResponseEnvelopeSuccess bool

Whether the API call was successful 

const (
	CertificatePackCertificateUpdateResponseEnvelopeSuccessTrue CertificatePackCertificateUpdateResponseEnvelopeSuccess = true
)

func (CertificatePackCertificateUpdateResponseEnvelopeSuccess) IsKnown added in v4.1.0 

func (r CertificatePackCertificateUpdateResponseEnvelopeSuccess) IsKnown() bool

type CertificatePackCertificateUpdateResponseOwnershipVerification added in v4.1.0 

type CertificatePackCertificateUpdateResponseOwnershipVerification struct {
	// DNS Name for record.
	Name string `json:"name"`
	// DNS Record type.
	Type CertificatePackCertificateUpdateResponseOwnershipVerificationType `json:"type"`
	// Content for the record.
	Value string                                                            `json:"value"`
	JSON  certificatePackCertificateUpdateResponseOwnershipVerificationJSON `json:"-"`
}

This is a record which can be placed to activate a hostname.

func (*CertificatePackCertificateUpdateResponseOwnershipVerification) UnmarshalJSON added in v4.1.0 

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

type CertificatePackCertificateUpdateResponseOwnershipVerificationHTTP added in v4.1.0 

type CertificatePackCertificateUpdateResponseOwnershipVerificationHTTP struct {
	// Token to be served.
	HTTPBody string `json:"http_body"`
	// The HTTP URL that will be checked during custom hostname verification and where
	// the customer should host the token.
	HTTPURL string                                                                `json:"http_url"`
	JSON    certificatePackCertificateUpdateResponseOwnershipVerificationHTTPJSON `json:"-"`
}

This presents the token to be served by the given http url to activate a hostname.

func (*CertificatePackCertificateUpdateResponseOwnershipVerificationHTTP) UnmarshalJSON added in v4.1.0 

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

type CertificatePackCertificateUpdateResponseOwnershipVerificationType added in v4.1.0 

type CertificatePackCertificateUpdateResponseOwnershipVerificationType string

DNS Record type. 

const (
	CertificatePackCertificateUpdateResponseOwnershipVerificationTypeTXT CertificatePackCertificateUpdateResponseOwnershipVerificationType = "txt"
)

func (CertificatePackCertificateUpdateResponseOwnershipVerificationType) IsKnown added in v4.1.0 

func (r CertificatePackCertificateUpdateResponseOwnershipVerificationType) IsKnown() bool

type CertificatePackCertificateUpdateResponseSSL added in v4.1.0 

type CertificatePackCertificateUpdateResponseSSL struct {
	// Custom hostname SSL identifier tag.
	ID string `json:"id"`
	// A ubiquitous bundle has the highest probability of being verified everywhere,
	// even by clients using outdated or unusual trust stores. An optimal bundle uses
	// the shortest chain and newest intermediates. And the force bundle verifies the
	// chain, but does not otherwise modify it.
	BundleMethod BundleMethod `json:"bundle_method"`
	// The Certificate Authority that will issue the certificate
	CertificateAuthority shared.CertificateCA `json:"certificate_authority"`
	// If a custom uploaded certificate is used.
	CustomCertificate string `json:"custom_certificate"`
	// The identifier for the Custom CSR that was used.
	CustomCsrID string `json:"custom_csr_id"`
	// The key for a custom uploaded certificate.
	CustomKey string `json:"custom_key"`
	// The time the custom certificate expires on.
	ExpiresOn time.Time `json:"expires_on" format:"date-time"`
	// A list of Hostnames on a custom uploaded certificate.
	Hosts []string `json:"hosts"`
	// The issuer on a custom uploaded certificate.
	Issuer string `json:"issuer"`
	// Domain control validation (DCV) method used for this hostname.
	Method DCVMethod `json:"method"`
	// The serial number on a custom uploaded certificate.
	SerialNumber string                                              `json:"serial_number"`
	Settings     CertificatePackCertificateUpdateResponseSSLSettings `json:"settings"`
	// The signature on a custom uploaded certificate.
	Signature string `json:"signature"`
	// Status of the hostname's SSL certificates.
	Status CertificatePackCertificateUpdateResponseSSLStatus `json:"status"`
	// Level of validation to be used for this hostname. Domain validation (dv) must be
	// used.
	Type DomainValidationType `json:"type"`
	// The time the custom certificate was uploaded.
	UploadedOn time.Time `json:"uploaded_on" format:"date-time"`
	// Domain validation errors that have been received by the certificate authority
	// (CA).
	ValidationErrors  []CertificatePackCertificateUpdateResponseSSLValidationError  `json:"validation_errors"`
	ValidationRecords []CertificatePackCertificateUpdateResponseSSLValidationRecord `json:"validation_records"`
	// Indicates whether the certificate covers a wildcard.
	Wildcard bool                                            `json:"wildcard"`
	JSON     certificatePackCertificateUpdateResponseSSLJSON `json:"-"`
}

func (*CertificatePackCertificateUpdateResponseSSL) UnmarshalJSON added in v4.1.0 

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

type CertificatePackCertificateUpdateResponseSSLSettings added in v4.1.0 

type CertificatePackCertificateUpdateResponseSSLSettings struct {
	// An allowlist of ciphers for TLS termination. These ciphers must be in the
	// BoringSSL format.
	Ciphers []string `json:"ciphers"`
	// Whether or not Early Hints is enabled.
	EarlyHints CertificatePackCertificateUpdateResponseSSLSettingsEarlyHints `json:"early_hints"`
	// Whether or not HTTP2 is enabled.
	HTTP2 CertificatePackCertificateUpdateResponseSSLSettingsHTTP2 `json:"http2"`
	// The minimum TLS version supported.
	MinTLSVersion CertificatePackCertificateUpdateResponseSSLSettingsMinTLSVersion `json:"min_tls_version"`
	// Whether or not TLS 1.3 is enabled.
	TLS1_3 CertificatePackCertificateUpdateResponseSSLSettingsTLS1_3 `json:"tls_1_3"`
	JSON   certificatePackCertificateUpdateResponseSSLSettingsJSON   `json:"-"`
}

func (*CertificatePackCertificateUpdateResponseSSLSettings) UnmarshalJSON added in v4.1.0 

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

type CertificatePackCertificateUpdateResponseSSLSettingsEarlyHints added in v4.1.0 

type CertificatePackCertificateUpdateResponseSSLSettingsEarlyHints string

Whether or not Early Hints is enabled. 

const (
	CertificatePackCertificateUpdateResponseSSLSettingsEarlyHintsOn  CertificatePackCertificateUpdateResponseSSLSettingsEarlyHints = "on"
	CertificatePackCertificateUpdateResponseSSLSettingsEarlyHintsOff CertificatePackCertificateUpdateResponseSSLSettingsEarlyHints = "off"
)

func (CertificatePackCertificateUpdateResponseSSLSettingsEarlyHints) IsKnown added in v4.1.0 

func (r CertificatePackCertificateUpdateResponseSSLSettingsEarlyHints) IsKnown() bool

type CertificatePackCertificateUpdateResponseSSLSettingsHTTP2 added in v4.1.0 

type CertificatePackCertificateUpdateResponseSSLSettingsHTTP2 string

Whether or not HTTP2 is enabled. 

const (
	CertificatePackCertificateUpdateResponseSSLSettingsHTTP2On  CertificatePackCertificateUpdateResponseSSLSettingsHTTP2 = "on"
	CertificatePackCertificateUpdateResponseSSLSettingsHTTP2Off CertificatePackCertificateUpdateResponseSSLSettingsHTTP2 = "off"
)

func (CertificatePackCertificateUpdateResponseSSLSettingsHTTP2) IsKnown added in v4.1.0 

func (r CertificatePackCertificateUpdateResponseSSLSettingsHTTP2) IsKnown() bool

type CertificatePackCertificateUpdateResponseSSLSettingsMinTLSVersion added in v4.1.0 

type CertificatePackCertificateUpdateResponseSSLSettingsMinTLSVersion string

The minimum TLS version supported. 

const (
	CertificatePackCertificateUpdateResponseSSLSettingsMinTLSVersion1_0 CertificatePackCertificateUpdateResponseSSLSettingsMinTLSVersion = "1.0"
	CertificatePackCertificateUpdateResponseSSLSettingsMinTLSVersion1_1 CertificatePackCertificateUpdateResponseSSLSettingsMinTLSVersion = "1.1"
	CertificatePackCertificateUpdateResponseSSLSettingsMinTLSVersion1_2 CertificatePackCertificateUpdateResponseSSLSettingsMinTLSVersion = "1.2"
	CertificatePackCertificateUpdateResponseSSLSettingsMinTLSVersion1_3 CertificatePackCertificateUpdateResponseSSLSettingsMinTLSVersion = "1.3"
)

func (CertificatePackCertificateUpdateResponseSSLSettingsMinTLSVersion) IsKnown added in v4.1.0 

func (r CertificatePackCertificateUpdateResponseSSLSettingsMinTLSVersion) IsKnown() bool

type CertificatePackCertificateUpdateResponseSSLSettingsTLS1_3 added in v4.1.0 

type CertificatePackCertificateUpdateResponseSSLSettingsTLS1_3 string

Whether or not TLS 1.3 is enabled. 

const (
	CertificatePackCertificateUpdateResponseSSLSettingsTLS1_3On  CertificatePackCertificateUpdateResponseSSLSettingsTLS1_3 = "on"
	CertificatePackCertificateUpdateResponseSSLSettingsTLS1_3Off CertificatePackCertificateUpdateResponseSSLSettingsTLS1_3 = "off"
)

func (CertificatePackCertificateUpdateResponseSSLSettingsTLS1_3) IsKnown added in v4.1.0 

func (r CertificatePackCertificateUpdateResponseSSLSettingsTLS1_3) IsKnown() bool

type CertificatePackCertificateUpdateResponseSSLStatus added in v4.1.0 

type CertificatePackCertificateUpdateResponseSSLStatus string

Status of the hostname's SSL certificates. 

const (
	CertificatePackCertificateUpdateResponseSSLStatusInitializing         CertificatePackCertificateUpdateResponseSSLStatus = "initializing"
	CertificatePackCertificateUpdateResponseSSLStatusPendingValidation    CertificatePackCertificateUpdateResponseSSLStatus = "pending_validation"
	CertificatePackCertificateUpdateResponseSSLStatusDeleted              CertificatePackCertificateUpdateResponseSSLStatus = "deleted"
	CertificatePackCertificateUpdateResponseSSLStatusPendingIssuance      CertificatePackCertificateUpdateResponseSSLStatus = "pending_issuance"
	CertificatePackCertificateUpdateResponseSSLStatusPendingDeployment    CertificatePackCertificateUpdateResponseSSLStatus = "pending_deployment"
	CertificatePackCertificateUpdateResponseSSLStatusPendingDeletion      CertificatePackCertificateUpdateResponseSSLStatus = "pending_deletion"
	CertificatePackCertificateUpdateResponseSSLStatusPendingExpiration    CertificatePackCertificateUpdateResponseSSLStatus = "pending_expiration"
	CertificatePackCertificateUpdateResponseSSLStatusExpired              CertificatePackCertificateUpdateResponseSSLStatus = "expired"
	CertificatePackCertificateUpdateResponseSSLStatusActive               CertificatePackCertificateUpdateResponseSSLStatus = "active"
	CertificatePackCertificateUpdateResponseSSLStatusInitializingTimedOut CertificatePackCertificateUpdateResponseSSLStatus = "initializing_timed_out"
	CertificatePackCertificateUpdateResponseSSLStatusValidationTimedOut   CertificatePackCertificateUpdateResponseSSLStatus = "validation_timed_out"
	CertificatePackCertificateUpdateResponseSSLStatusIssuanceTimedOut     CertificatePackCertificateUpdateResponseSSLStatus = "issuance_timed_out"
	CertificatePackCertificateUpdateResponseSSLStatusDeploymentTimedOut   CertificatePackCertificateUpdateResponseSSLStatus = "deployment_timed_out"
	CertificatePackCertificateUpdateResponseSSLStatusDeletionTimedOut     CertificatePackCertificateUpdateResponseSSLStatus = "deletion_timed_out"
	CertificatePackCertificateUpdateResponseSSLStatusPendingCleanup       CertificatePackCertificateUpdateResponseSSLStatus = "pending_cleanup"
	CertificatePackCertificateUpdateResponseSSLStatusStagingDeployment    CertificatePackCertificateUpdateResponseSSLStatus = "staging_deployment"
	CertificatePackCertificateUpdateResponseSSLStatusStagingActive        CertificatePackCertificateUpdateResponseSSLStatus = "staging_active"
	CertificatePackCertificateUpdateResponseSSLStatusDeactivating         CertificatePackCertificateUpdateResponseSSLStatus = "deactivating"
	CertificatePackCertificateUpdateResponseSSLStatusInactive             CertificatePackCertificateUpdateResponseSSLStatus = "inactive"
	CertificatePackCertificateUpdateResponseSSLStatusBackupIssued         CertificatePackCertificateUpdateResponseSSLStatus = "backup_issued"
	CertificatePackCertificateUpdateResponseSSLStatusHoldingDeployment    CertificatePackCertificateUpdateResponseSSLStatus = "holding_deployment"
)

func (CertificatePackCertificateUpdateResponseSSLStatus) IsKnown added in v4.1.0 

func (r CertificatePackCertificateUpdateResponseSSLStatus) IsKnown() bool

type CertificatePackCertificateUpdateResponseSSLValidationError added in v4.1.0 

type CertificatePackCertificateUpdateResponseSSLValidationError struct {
	// A domain validation error.
	Message string                                                         `json:"message"`
	JSON    certificatePackCertificateUpdateResponseSSLValidationErrorJSON `json:"-"`
}

func (*CertificatePackCertificateUpdateResponseSSLValidationError) UnmarshalJSON added in v4.1.0 

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

type CertificatePackCertificateUpdateResponseSSLValidationRecord added in v4.1.0 

type CertificatePackCertificateUpdateResponseSSLValidationRecord struct {
	// The set of email addresses that the certificate authority (CA) will use to
	// complete domain validation.
	Emails []string `json:"emails"`
	// The content that the certificate authority (CA) will expect to find at the
	// http_url during the domain validation.
	HTTPBody string `json:"http_body"`
	// The url that will be checked during domain validation.
	HTTPURL string `json:"http_url"`
	// The hostname that the certificate authority (CA) will check for a TXT record
	// during domain validation .
	TXTName string `json:"txt_name"`
	// The TXT record that the certificate authority (CA) will check during domain
	// validation.
	TXTValue string                                                          `json:"txt_value"`
	JSON     certificatePackCertificateUpdateResponseSSLValidationRecordJSON `json:"-"`
}

func (*CertificatePackCertificateUpdateResponseSSLValidationRecord) UnmarshalJSON added in v4.1.0 

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

type CertificatePackCertificateUpdateResponseStatus added in v4.1.0 

type CertificatePackCertificateUpdateResponseStatus string

Status of the hostname's activation. 

const (
	CertificatePackCertificateUpdateResponseStatusActive             CertificatePackCertificateUpdateResponseStatus = "active"
	CertificatePackCertificateUpdateResponseStatusPending            CertificatePackCertificateUpdateResponseStatus = "pending"
	CertificatePackCertificateUpdateResponseStatusActiveRedeploying  CertificatePackCertificateUpdateResponseStatus = "active_redeploying"
	CertificatePackCertificateUpdateResponseStatusMoved              CertificatePackCertificateUpdateResponseStatus = "moved"
	CertificatePackCertificateUpdateResponseStatusPendingDeletion    CertificatePackCertificateUpdateResponseStatus = "pending_deletion"
	CertificatePackCertificateUpdateResponseStatusDeleted            CertificatePackCertificateUpdateResponseStatus = "deleted"
	CertificatePackCertificateUpdateResponseStatusPendingBlocked     CertificatePackCertificateUpdateResponseStatus = "pending_blocked"
	CertificatePackCertificateUpdateResponseStatusPendingMigration   CertificatePackCertificateUpdateResponseStatus = "pending_migration"
	CertificatePackCertificateUpdateResponseStatusPendingProvisioned CertificatePackCertificateUpdateResponseStatus = "pending_provisioned"
	CertificatePackCertificateUpdateResponseStatusTestPending        CertificatePackCertificateUpdateResponseStatus = "test_pending"
	CertificatePackCertificateUpdateResponseStatusTestActive         CertificatePackCertificateUpdateResponseStatus = "test_active"
	CertificatePackCertificateUpdateResponseStatusTestActiveApex     CertificatePackCertificateUpdateResponseStatus = "test_active_apex"
	CertificatePackCertificateUpdateResponseStatusTestBlocked        CertificatePackCertificateUpdateResponseStatus = "test_blocked"
	CertificatePackCertificateUpdateResponseStatusTestFailed         CertificatePackCertificateUpdateResponseStatus = "test_failed"
	CertificatePackCertificateUpdateResponseStatusProvisioned        CertificatePackCertificateUpdateResponseStatus = "provisioned"
	CertificatePackCertificateUpdateResponseStatusBlocked            CertificatePackCertificateUpdateResponseStatus = "blocked"
)

func (CertificatePackCertificateUpdateResponseStatus) IsKnown added in v4.1.0 

func (r CertificatePackCertificateUpdateResponseStatus) IsKnown() bool

type CertificatePackService added in v4.1.0 

type CertificatePackService struct {
	Options      []option.RequestOption
	Certificates *CertificatePackCertificateService
}

CertificatePackService 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 NewCertificatePackService method instead.

func NewCertificatePackService added in v4.1.0 

func NewCertificatePackService(opts ...option.RequestOption) (r *CertificatePackService)

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

type CertificateRequestType = shared.CertificateRequestType

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

This is an alias to an internal type.

type CloudflareTunnel 

type CloudflareTunnel = shared.CloudflareTunnel

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

This is an alias to an internal type.

type CloudflareTunnelConnection 

type CloudflareTunnelConnection = shared.CloudflareTunnelConnection

This is an alias to an internal type.

type CloudflareTunnelStatus 

type CloudflareTunnelStatus = shared.CloudflareTunnelStatus

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

This is an alias to an internal type.

type CloudflareTunnelTunType 

type CloudflareTunnelTunType = shared.CloudflareTunnelTunType

The type of tunnel.

This is an alias to an internal type.

type CustomHostnameDeleteParams 

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

type CustomHostnameDeleteResponse 

type CustomHostnameDeleteResponse struct {
	// Identifier
	ID   string                           `json:"id"`
	JSON customHostnameDeleteResponseJSON `json:"-"`
}

func (*CustomHostnameDeleteResponse) UnmarshalJSON 

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

type CustomHostnameEditParams 

type CustomHostnameEditParams struct {
	// Identifier
	ZoneID param.Field[string] `path:"zone_id,required"`
	// Unique key/value metadata for this hostname. These are per-hostname (customer)
	// settings.
	CustomMetadata param.Field[map[string]string] `json:"custom_metadata"`
	// a valid hostname that’s been added to your DNS zone as an A, AAAA, or CNAME
	// record.
	CustomOriginServer param.Field[string] `json:"custom_origin_server"`
	// A hostname that will be sent to your custom origin server as SNI for TLS
	// handshake. This can be a valid subdomain of the zone or custom origin server
	// name or the string ':request_host_header:' which will cause the host header in
	// the request to be used as SNI. Not configurable with default/fallback origin
	// server.
	CustomOriginSNI param.Field[string] `json:"custom_origin_sni"`
	// SSL properties used when creating the custom hostname.
	SSL param.Field[CustomHostnameEditParamsSSL] `json:"ssl"`
}

func (CustomHostnameEditParams) MarshalJSON 

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

type CustomHostnameEditParamsSSL 

type CustomHostnameEditParamsSSL struct {
	// A ubiquitous bundle has the highest probability of being verified everywhere,
	// even by clients using outdated or unusual trust stores. An optimal bundle uses
	// the shortest chain and newest intermediates. And the force bundle verifies the
	// chain, but does not otherwise modify it.
	BundleMethod param.Field[BundleMethod] `json:"bundle_method"`
	// The Certificate Authority that will issue the certificate
	CertificateAuthority param.Field[shared.CertificateCA] `json:"certificate_authority"`
	// Whether or not to add Cloudflare Branding for the order. This will add a
	// subdomain of sni.cloudflaressl.com as the Common Name if set to true
	CloudflareBranding param.Field[bool] `json:"cloudflare_branding"`
	// Array of custom certificate and key pairs (1 or 2 pairs allowed)
	CustomCERTBundle param.Field[[]CustomHostnameEditParamsSSLCustomCERTBundle] `json:"custom_cert_bundle"`
	// If a custom uploaded certificate is used.
	CustomCertificate param.Field[string] `json:"custom_certificate"`
	// The key for a custom uploaded certificate.
	CustomKey param.Field[string] `json:"custom_key"`
	// Domain control validation (DCV) method used for this hostname.
	Method param.Field[DCVMethod] `json:"method"`
	// SSL specific settings.
	Settings param.Field[CustomHostnameEditParamsSSLSettings] `json:"settings"`
	// Level of validation to be used for this hostname. Domain validation (dv) must be
	// used.
	Type param.Field[DomainValidationType] `json:"type"`
	// Indicates whether the certificate covers a wildcard.
	Wildcard param.Field[bool] `json:"wildcard"`
}

SSL properties used when creating the custom hostname.

func (CustomHostnameEditParamsSSL) MarshalJSON 

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

type CustomHostnameEditParamsSSLCustomCERTBundle added in v4.1.0 

type CustomHostnameEditParamsSSLCustomCERTBundle struct {
	// If a custom uploaded certificate is used.
	CustomCertificate param.Field[string] `json:"custom_certificate,required"`
	// The key for a custom uploaded certificate.
	CustomKey param.Field[string] `json:"custom_key,required"`
}

func (CustomHostnameEditParamsSSLCustomCERTBundle) MarshalJSON added in v4.1.0 

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

type CustomHostnameEditParamsSSLSettings 

type CustomHostnameEditParamsSSLSettings struct {
	// An allowlist of ciphers for TLS termination. These ciphers must be in the
	// BoringSSL format.
	Ciphers param.Field[[]string] `json:"ciphers"`
	// Whether or not Early Hints is enabled.
	EarlyHints param.Field[CustomHostnameEditParamsSSLSettingsEarlyHints] `json:"early_hints"`
	// Whether or not HTTP2 is enabled.
	HTTP2 param.Field[CustomHostnameEditParamsSSLSettingsHTTP2] `json:"http2"`
	// The minimum TLS version supported.
	MinTLSVersion param.Field[CustomHostnameEditParamsSSLSettingsMinTLSVersion] `json:"min_tls_version"`
	// Whether or not TLS 1.3 is enabled.
	TLS1_3 param.Field[CustomHostnameEditParamsSSLSettingsTLS1_3] `json:"tls_1_3"`
}

SSL specific settings.

func (CustomHostnameEditParamsSSLSettings) MarshalJSON 

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

type CustomHostnameEditParamsSSLSettingsEarlyHints 

type CustomHostnameEditParamsSSLSettingsEarlyHints string

Whether or not Early Hints is enabled. 

const (
	CustomHostnameEditParamsSSLSettingsEarlyHintsOn  CustomHostnameEditParamsSSLSettingsEarlyHints = "on"
	CustomHostnameEditParamsSSLSettingsEarlyHintsOff CustomHostnameEditParamsSSLSettingsEarlyHints = "off"
)

func (CustomHostnameEditParamsSSLSettingsEarlyHints) IsKnown 

func (r CustomHostnameEditParamsSSLSettingsEarlyHints) IsKnown() bool

type CustomHostnameEditParamsSSLSettingsHTTP2 

type CustomHostnameEditParamsSSLSettingsHTTP2 string

Whether or not HTTP2 is enabled. 

const (
	CustomHostnameEditParamsSSLSettingsHTTP2On  CustomHostnameEditParamsSSLSettingsHTTP2 = "on"
	CustomHostnameEditParamsSSLSettingsHTTP2Off CustomHostnameEditParamsSSLSettingsHTTP2 = "off"
)

func (CustomHostnameEditParamsSSLSettingsHTTP2) IsKnown 

func (r CustomHostnameEditParamsSSLSettingsHTTP2) IsKnown() bool

type CustomHostnameEditParamsSSLSettingsMinTLSVersion 

type CustomHostnameEditParamsSSLSettingsMinTLSVersion string

The minimum TLS version supported. 

const (
	CustomHostnameEditParamsSSLSettingsMinTLSVersion1_0 CustomHostnameEditParamsSSLSettingsMinTLSVersion = "1.0"
	CustomHostnameEditParamsSSLSettingsMinTLSVersion1_1 CustomHostnameEditParamsSSLSettingsMinTLSVersion = "1.1"
	CustomHostnameEditParamsSSLSettingsMinTLSVersion1_2 CustomHostnameEditParamsSSLSettingsMinTLSVersion = "1.2"
	CustomHostnameEditParamsSSLSettingsMinTLSVersion1_3 CustomHostnameEditParamsSSLSettingsMinTLSVersion = "1.3"
)

func (CustomHostnameEditParamsSSLSettingsMinTLSVersion) IsKnown 

func (r CustomHostnameEditParamsSSLSettingsMinTLSVersion) IsKnown() bool

type CustomHostnameEditParamsSSLSettingsTLS1_3 

type CustomHostnameEditParamsSSLSettingsTLS1_3 string

Whether or not TLS 1.3 is enabled. 

const (
	CustomHostnameEditParamsSSLSettingsTLS1_3On  CustomHostnameEditParamsSSLSettingsTLS1_3 = "on"
	CustomHostnameEditParamsSSLSettingsTLS1_3Off CustomHostnameEditParamsSSLSettingsTLS1_3 = "off"
)

func (CustomHostnameEditParamsSSLSettingsTLS1_3) IsKnown 

func (r CustomHostnameEditParamsSSLSettingsTLS1_3) IsKnown() bool

type CustomHostnameEditResponse 

type CustomHostnameEditResponse struct {
	// Identifier
	ID string `json:"id,required"`
	// The custom hostname that will point to your hostname via CNAME.
	Hostname string                        `json:"hostname,required"`
	SSL      CustomHostnameEditResponseSSL `json:"ssl,required"`
	// This is the time the hostname was created.
	CreatedAt time.Time `json:"created_at" format:"date-time"`
	// Unique key/value metadata for this hostname. These are per-hostname (customer)
	// settings.
	CustomMetadata map[string]string `json:"custom_metadata"`
	// a valid hostname that’s been added to your DNS zone as an A, AAAA, or CNAME
	// record.
	CustomOriginServer string `json:"custom_origin_server"`
	// A hostname that will be sent to your custom origin server as SNI for TLS
	// handshake. This can be a valid subdomain of the zone or custom origin server
	// name or the string ':request_host_header:' which will cause the host header in
	// the request to be used as SNI. Not configurable with default/fallback origin
	// server.
	CustomOriginSNI string `json:"custom_origin_sni"`
	// This is a record which can be placed to activate a hostname.
	OwnershipVerification CustomHostnameEditResponseOwnershipVerification `json:"ownership_verification"`
	// This presents the token to be served by the given http url to activate a
	// hostname.
	OwnershipVerificationHTTP CustomHostnameEditResponseOwnershipVerificationHTTP `json:"ownership_verification_http"`
	// Status of the hostname's activation.
	Status CustomHostnameEditResponseStatus `json:"status"`
	// These are errors that were encountered while trying to activate a hostname.
	VerificationErrors []string                       `json:"verification_errors"`
	JSON               customHostnameEditResponseJSON `json:"-"`
}

func (*CustomHostnameEditResponse) UnmarshalJSON 

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

type CustomHostnameEditResponseEnvelope 

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

func (*CustomHostnameEditResponseEnvelope) UnmarshalJSON 

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

type CustomHostnameEditResponseEnvelopeSuccess 

type CustomHostnameEditResponseEnvelopeSuccess bool

Whether the API call was successful 

const (
	CustomHostnameEditResponseEnvelopeSuccessTrue CustomHostnameEditResponseEnvelopeSuccess = true
)

func (CustomHostnameEditResponseEnvelopeSuccess) IsKnown 

func (r CustomHostnameEditResponseEnvelopeSuccess) IsKnown() bool

type CustomHostnameEditResponseOwnershipVerification 

type CustomHostnameEditResponseOwnershipVerification struct {
	// DNS Name for record.
	Name string `json:"name"`
	// DNS Record type.
	Type CustomHostnameEditResponseOwnershipVerificationType `json:"type"`
	// Content for the record.
	Value string                                              `json:"value"`
	JSON  customHostnameEditResponseOwnershipVerificationJSON `json:"-"`
}

This is a record which can be placed to activate a hostname.

func (*CustomHostnameEditResponseOwnershipVerification) UnmarshalJSON 

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

type CustomHostnameEditResponseOwnershipVerificationHTTP 

type CustomHostnameEditResponseOwnershipVerificationHTTP struct {
	// Token to be served.
	HTTPBody string `json:"http_body"`
	// The HTTP URL that will be checked during custom hostname verification and where
	// the customer should host the token.
	HTTPURL string                                                  `json:"http_url"`
	JSON    customHostnameEditResponseOwnershipVerificationHTTPJSON `json:"-"`
}

This presents the token to be served by the given http url to activate a hostname.

func (*CustomHostnameEditResponseOwnershipVerificationHTTP) UnmarshalJSON 

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

type CustomHostnameEditResponseOwnershipVerificationType 

type CustomHostnameEditResponseOwnershipVerificationType string

DNS Record type. 

const (
	CustomHostnameEditResponseOwnershipVerificationTypeTXT CustomHostnameEditResponseOwnershipVerificationType = "txt"
)

func (CustomHostnameEditResponseOwnershipVerificationType) IsKnown 

func (r CustomHostnameEditResponseOwnershipVerificationType) IsKnown() bool

type CustomHostnameEditResponseSSL 

type CustomHostnameEditResponseSSL struct {
	// Custom hostname SSL identifier tag.
	ID string `json:"id"`
	// A ubiquitous bundle has the highest probability of being verified everywhere,
	// even by clients using outdated or unusual trust stores. An optimal bundle uses
	// the shortest chain and newest intermediates. And the force bundle verifies the
	// chain, but does not otherwise modify it.
	BundleMethod BundleMethod `json:"bundle_method"`
	// The Certificate Authority that will issue the certificate
	CertificateAuthority shared.CertificateCA `json:"certificate_authority"`
	// If a custom uploaded certificate is used.
	CustomCertificate string `json:"custom_certificate"`
	// The identifier for the Custom CSR that was used.
	CustomCsrID string `json:"custom_csr_id"`
	// The key for a custom uploaded certificate.
	CustomKey string `json:"custom_key"`
	// The time the custom certificate expires on.
	ExpiresOn time.Time `json:"expires_on" format:"date-time"`
	// A list of Hostnames on a custom uploaded certificate.
	Hosts []string `json:"hosts"`
	// The issuer on a custom uploaded certificate.
	Issuer string `json:"issuer"`
	// Domain control validation (DCV) method used for this hostname.
	Method DCVMethod `json:"method"`
	// The serial number on a custom uploaded certificate.
	SerialNumber string                                `json:"serial_number"`
	Settings     CustomHostnameEditResponseSSLSettings `json:"settings"`
	// The signature on a custom uploaded certificate.
	Signature string `json:"signature"`
	// Status of the hostname's SSL certificates.
	Status CustomHostnameEditResponseSSLStatus `json:"status"`
	// Level of validation to be used for this hostname. Domain validation (dv) must be
	// used.
	Type DomainValidationType `json:"type"`
	// The time the custom certificate was uploaded.
	UploadedOn time.Time `json:"uploaded_on" format:"date-time"`
	// Domain validation errors that have been received by the certificate authority
	// (CA).
	ValidationErrors  []CustomHostnameEditResponseSSLValidationError  `json:"validation_errors"`
	ValidationRecords []CustomHostnameEditResponseSSLValidationRecord `json:"validation_records"`
	// Indicates whether the certificate covers a wildcard.
	Wildcard bool                              `json:"wildcard"`
	JSON     customHostnameEditResponseSSLJSON `json:"-"`
}

func (*CustomHostnameEditResponseSSL) UnmarshalJSON 

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

type CustomHostnameEditResponseSSLSettings 

type CustomHostnameEditResponseSSLSettings struct {
	// An allowlist of ciphers for TLS termination. These ciphers must be in the
	// BoringSSL format.
	Ciphers []string `json:"ciphers"`
	// Whether or not Early Hints is enabled.
	EarlyHints CustomHostnameEditResponseSSLSettingsEarlyHints `json:"early_hints"`
	// Whether or not HTTP2 is enabled.
	HTTP2 CustomHostnameEditResponseSSLSettingsHTTP2 `json:"http2"`
	// The minimum TLS version supported.
	MinTLSVersion CustomHostnameEditResponseSSLSettingsMinTLSVersion `json:"min_tls_version"`
	// Whether or not TLS 1.3 is enabled.
	TLS1_3 CustomHostnameEditResponseSSLSettingsTLS1_3 `json:"tls_1_3"`
	JSON   customHostnameEditResponseSSLSettingsJSON   `json:"-"`
}

func (*CustomHostnameEditResponseSSLSettings) UnmarshalJSON 

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

type CustomHostnameEditResponseSSLSettingsEarlyHints 

type CustomHostnameEditResponseSSLSettingsEarlyHints string

Whether or not Early Hints is enabled. 

const (
	CustomHostnameEditResponseSSLSettingsEarlyHintsOn  CustomHostnameEditResponseSSLSettingsEarlyHints = "on"
	CustomHostnameEditResponseSSLSettingsEarlyHintsOff CustomHostnameEditResponseSSLSettingsEarlyHints = "off"
)

func (CustomHostnameEditResponseSSLSettingsEarlyHints) IsKnown 

func (r CustomHostnameEditResponseSSLSettingsEarlyHints) IsKnown() bool

type CustomHostnameEditResponseSSLSettingsHTTP2 

type CustomHostnameEditResponseSSLSettingsHTTP2 string

Whether or not HTTP2 is enabled. 

const (
	CustomHostnameEditResponseSSLSettingsHTTP2On  CustomHostnameEditResponseSSLSettingsHTTP2 = "on"
	CustomHostnameEditResponseSSLSettingsHTTP2Off CustomHostnameEditResponseSSLSettingsHTTP2 = "off"
)

func (CustomHostnameEditResponseSSLSettingsHTTP2) IsKnown 

func (r CustomHostnameEditResponseSSLSettingsHTTP2) IsKnown() bool

type CustomHostnameEditResponseSSLSettingsMinTLSVersion 

type CustomHostnameEditResponseSSLSettingsMinTLSVersion string

The minimum TLS version supported. 

const (
	CustomHostnameEditResponseSSLSettingsMinTLSVersion1_0 CustomHostnameEditResponseSSLSettingsMinTLSVersion = "1.0"
	CustomHostnameEditResponseSSLSettingsMinTLSVersion1_1 CustomHostnameEditResponseSSLSettingsMinTLSVersion = "1.1"
	CustomHostnameEditResponseSSLSettingsMinTLSVersion1_2 CustomHostnameEditResponseSSLSettingsMinTLSVersion = "1.2"
	CustomHostnameEditResponseSSLSettingsMinTLSVersion1_3 CustomHostnameEditResponseSSLSettingsMinTLSVersion = "1.3"
)

func (CustomHostnameEditResponseSSLSettingsMinTLSVersion) IsKnown 

func (r CustomHostnameEditResponseSSLSettingsMinTLSVersion) IsKnown() bool

type CustomHostnameEditResponseSSLSettingsTLS1_3 

type CustomHostnameEditResponseSSLSettingsTLS1_3 string

Whether or not TLS 1.3 is enabled. 

const (
	CustomHostnameEditResponseSSLSettingsTLS1_3On  CustomHostnameEditResponseSSLSettingsTLS1_3 = "on"
	CustomHostnameEditResponseSSLSettingsTLS1_3Off CustomHostnameEditResponseSSLSettingsTLS1_3 = "off"
)

func (CustomHostnameEditResponseSSLSettingsTLS1_3) IsKnown 

func (r CustomHostnameEditResponseSSLSettingsTLS1_3) IsKnown() bool

type CustomHostnameEditResponseSSLStatus 

type CustomHostnameEditResponseSSLStatus string

Status of the hostname's SSL certificates. 

const (
	CustomHostnameEditResponseSSLStatusInitializing         CustomHostnameEditResponseSSLStatus = "initializing"
	CustomHostnameEditResponseSSLStatusPendingValidation    CustomHostnameEditResponseSSLStatus = "pending_validation"
	CustomHostnameEditResponseSSLStatusDeleted              CustomHostnameEditResponseSSLStatus = "deleted"
	CustomHostnameEditResponseSSLStatusPendingIssuance      CustomHostnameEditResponseSSLStatus = "pending_issuance"
	CustomHostnameEditResponseSSLStatusPendingDeployment    CustomHostnameEditResponseSSLStatus = "pending_deployment"
	CustomHostnameEditResponseSSLStatusPendingDeletion      CustomHostnameEditResponseSSLStatus = "pending_deletion"
	CustomHostnameEditResponseSSLStatusPendingExpiration    CustomHostnameEditResponseSSLStatus = "pending_expiration"
	CustomHostnameEditResponseSSLStatusExpired              CustomHostnameEditResponseSSLStatus = "expired"
	CustomHostnameEditResponseSSLStatusActive               CustomHostnameEditResponseSSLStatus = "active"
	CustomHostnameEditResponseSSLStatusInitializingTimedOut CustomHostnameEditResponseSSLStatus = "initializing_timed_out"
	CustomHostnameEditResponseSSLStatusValidationTimedOut   CustomHostnameEditResponseSSLStatus = "validation_timed_out"
	CustomHostnameEditResponseSSLStatusIssuanceTimedOut     CustomHostnameEditResponseSSLStatus = "issuance_timed_out"
	CustomHostnameEditResponseSSLStatusDeploymentTimedOut   CustomHostnameEditResponseSSLStatus = "deployment_timed_out"
	CustomHostnameEditResponseSSLStatusDeletionTimedOut     CustomHostnameEditResponseSSLStatus = "deletion_timed_out"
	CustomHostnameEditResponseSSLStatusPendingCleanup       CustomHostnameEditResponseSSLStatus = "pending_cleanup"
	CustomHostnameEditResponseSSLStatusStagingDeployment    CustomHostnameEditResponseSSLStatus = "staging_deployment"
	CustomHostnameEditResponseSSLStatusStagingActive        CustomHostnameEditResponseSSLStatus = "staging_active"
	CustomHostnameEditResponseSSLStatusDeactivating         CustomHostnameEditResponseSSLStatus = "deactivating"
	CustomHostnameEditResponseSSLStatusInactive             CustomHostnameEditResponseSSLStatus = "inactive"
	CustomHostnameEditResponseSSLStatusBackupIssued         CustomHostnameEditResponseSSLStatus = "backup_issued"
	CustomHostnameEditResponseSSLStatusHoldingDeployment    CustomHostnameEditResponseSSLStatus = "holding_deployment"
)

func (CustomHostnameEditResponseSSLStatus) IsKnown 

func (r CustomHostnameEditResponseSSLStatus) IsKnown() bool

type CustomHostnameEditResponseSSLValidationError 

type CustomHostnameEditResponseSSLValidationError struct {
	// A domain validation error.
	Message string                                           `json:"message"`
	JSON    customHostnameEditResponseSSLValidationErrorJSON `json:"-"`
}

func (*CustomHostnameEditResponseSSLValidationError) UnmarshalJSON 

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

type CustomHostnameEditResponseSSLValidationRecord 

type CustomHostnameEditResponseSSLValidationRecord struct {
	// The set of email addresses that the certificate authority (CA) will use to
	// complete domain validation.
	Emails []string `json:"emails"`
	// The content that the certificate authority (CA) will expect to find at the
	// http_url during the domain validation.
	HTTPBody string `json:"http_body"`
	// The url that will be checked during domain validation.
	HTTPURL string `json:"http_url"`
	// The hostname that the certificate authority (CA) will check for a TXT record
	// during domain validation .
	TXTName string `json:"txt_name"`
	// The TXT record that the certificate authority (CA) will check during domain
	// validation.
	TXTValue string                                            `json:"txt_value"`
	JSON     customHostnameEditResponseSSLValidationRecordJSON `json:"-"`
}

func (*CustomHostnameEditResponseSSLValidationRecord) UnmarshalJSON 

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

type CustomHostnameEditResponseStatus 

type CustomHostnameEditResponseStatus string

Status of the hostname's activation. 

const (
	CustomHostnameEditResponseStatusActive             CustomHostnameEditResponseStatus = "active"
	CustomHostnameEditResponseStatusPending            CustomHostnameEditResponseStatus = "pending"
	CustomHostnameEditResponseStatusActiveRedeploying  CustomHostnameEditResponseStatus = "active_redeploying"
	CustomHostnameEditResponseStatusMoved              CustomHostnameEditResponseStatus = "moved"
	CustomHostnameEditResponseStatusPendingDeletion    CustomHostnameEditResponseStatus = "pending_deletion"
	CustomHostnameEditResponseStatusDeleted            CustomHostnameEditResponseStatus = "deleted"
	CustomHostnameEditResponseStatusPendingBlocked     CustomHostnameEditResponseStatus = "pending_blocked"
	CustomHostnameEditResponseStatusPendingMigration   CustomHostnameEditResponseStatus = "pending_migration"
	CustomHostnameEditResponseStatusPendingProvisioned CustomHostnameEditResponseStatus = "pending_provisioned"
	CustomHostnameEditResponseStatusTestPending        CustomHostnameEditResponseStatus = "test_pending"
	CustomHostnameEditResponseStatusTestActive         CustomHostnameEditResponseStatus = "test_active"
	CustomHostnameEditResponseStatusTestActiveApex     CustomHostnameEditResponseStatus = "test_active_apex"
	CustomHostnameEditResponseStatusTestBlocked        CustomHostnameEditResponseStatus = "test_blocked"
	CustomHostnameEditResponseStatusTestFailed         CustomHostnameEditResponseStatus = "test_failed"
	CustomHostnameEditResponseStatusProvisioned        CustomHostnameEditResponseStatus = "provisioned"
	CustomHostnameEditResponseStatusBlocked            CustomHostnameEditResponseStatus = "blocked"
)

func (CustomHostnameEditResponseStatus) IsKnown 

func (r CustomHostnameEditResponseStatus) IsKnown() bool

type CustomHostnameGetParams 

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

type CustomHostnameGetResponse 

type CustomHostnameGetResponse struct {
	// Identifier
	ID string `json:"id,required"`
	// The custom hostname that will point to your hostname via CNAME.
	Hostname string                       `json:"hostname,required"`
	SSL      CustomHostnameGetResponseSSL `json:"ssl,required"`
	// This is the time the hostname was created.
	CreatedAt time.Time `json:"created_at" format:"date-time"`
	// Unique key/value metadata for this hostname. These are per-hostname (customer)
	// settings.
	CustomMetadata map[string]string `json:"custom_metadata"`
	// a valid hostname that’s been added to your DNS zone as an A, AAAA, or CNAME
	// record.
	CustomOriginServer string `json:"custom_origin_server"`
	// A hostname that will be sent to your custom origin server as SNI for TLS
	// handshake. This can be a valid subdomain of the zone or custom origin server
	// name or the string ':request_host_header:' which will cause the host header in
	// the request to be used as SNI. Not configurable with default/fallback origin
	// server.
	CustomOriginSNI string `json:"custom_origin_sni"`
	// This is a record which can be placed to activate a hostname.
	OwnershipVerification CustomHostnameGetResponseOwnershipVerification `json:"ownership_verification"`
	// This presents the token to be served by the given http url to activate a
	// hostname.
	OwnershipVerificationHTTP CustomHostnameGetResponseOwnershipVerificationHTTP `json:"ownership_verification_http"`
	// Status of the hostname's activation.
	Status CustomHostnameGetResponseStatus `json:"status"`
	// These are errors that were encountered while trying to activate a hostname.
	VerificationErrors []string                      `json:"verification_errors"`
	JSON               customHostnameGetResponseJSON `json:"-"`
}

func (*CustomHostnameGetResponse) UnmarshalJSON 

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

type CustomHostnameGetResponseEnvelope 

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

func (*CustomHostnameGetResponseEnvelope) UnmarshalJSON 

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

type CustomHostnameGetResponseEnvelopeSuccess 

type CustomHostnameGetResponseEnvelopeSuccess bool

Whether the API call was successful 

const (
	CustomHostnameGetResponseEnvelopeSuccessTrue CustomHostnameGetResponseEnvelopeSuccess = true
)

func (CustomHostnameGetResponseEnvelopeSuccess) IsKnown 

func (r CustomHostnameGetResponseEnvelopeSuccess) IsKnown() bool

type CustomHostnameGetResponseOwnershipVerification 

type CustomHostnameGetResponseOwnershipVerification struct {
	// DNS Name for record.
	Name string `json:"name"`
	// DNS Record type.
	Type CustomHostnameGetResponseOwnershipVerificationType `json:"type"`
	// Content for the record.
	Value string                                             `json:"value"`
	JSON  customHostnameGetResponseOwnershipVerificationJSON `json:"-"`
}

This is a record which can be placed to activate a hostname.

func (*CustomHostnameGetResponseOwnershipVerification) UnmarshalJSON 

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

type CustomHostnameGetResponseOwnershipVerificationHTTP 

type CustomHostnameGetResponseOwnershipVerificationHTTP struct {
	// Token to be served.
	HTTPBody string `json:"http_body"`
	// The HTTP URL that will be checked during custom hostname verification and where
	// the customer should host the token.
	HTTPURL string                                                 `json:"http_url"`
	JSON    customHostnameGetResponseOwnershipVerificationHTTPJSON `json:"-"`
}

This presents the token to be served by the given http url to activate a hostname.

func (*CustomHostnameGetResponseOwnershipVerificationHTTP) UnmarshalJSON 

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

type CustomHostnameGetResponseOwnershipVerificationType 

type CustomHostnameGetResponseOwnershipVerificationType string

DNS Record type. 

const (
	CustomHostnameGetResponseOwnershipVerificationTypeTXT CustomHostnameGetResponseOwnershipVerificationType = "txt"
)

func (CustomHostnameGetResponseOwnershipVerificationType) IsKnown 

func (r CustomHostnameGetResponseOwnershipVerificationType) IsKnown() bool

type CustomHostnameGetResponseSSL 

type CustomHostnameGetResponseSSL struct {
	// Custom hostname SSL identifier tag.
	ID string `json:"id"`
	// A ubiquitous bundle has the highest probability of being verified everywhere,
	// even by clients using outdated or unusual trust stores. An optimal bundle uses
	// the shortest chain and newest intermediates. And the force bundle verifies the
	// chain, but does not otherwise modify it.
	BundleMethod BundleMethod `json:"bundle_method"`
	// The Certificate Authority that will issue the certificate
	CertificateAuthority shared.CertificateCA `json:"certificate_authority"`
	// If a custom uploaded certificate is used.
	CustomCertificate string `json:"custom_certificate"`
	// The identifier for the Custom CSR that was used.
	CustomCsrID string `json:"custom_csr_id"`
	// The key for a custom uploaded certificate.
	CustomKey string `json:"custom_key"`
	// The time the custom certificate expires on.
	ExpiresOn time.Time `json:"expires_on" format:"date-time"`
	// A list of Hostnames on a custom uploaded certificate.
	Hosts []string `json:"hosts"`
	// The issuer on a custom uploaded certificate.
	Issuer string `json:"issuer"`
	// Domain control validation (DCV) method used for this hostname.
	Method DCVMethod `json:"method"`
	// The serial number on a custom uploaded certificate.
	SerialNumber string                               `json:"serial_number"`
	Settings     CustomHostnameGetResponseSSLSettings `json:"settings"`
	// The signature on a custom uploaded certificate.
	Signature string `json:"signature"`
	// Status of the hostname's SSL certificates.
	Status CustomHostnameGetResponseSSLStatus `json:"status"`
	// Level of validation to be used for this hostname. Domain validation (dv) must be
	// used.
	Type DomainValidationType `json:"type"`
	// The time the custom certificate was uploaded.
	UploadedOn time.Time `json:"uploaded_on" format:"date-time"`
	// Domain validation errors that have been received by the certificate authority
	// (CA).
	ValidationErrors  []CustomHostnameGetResponseSSLValidationError  `json:"validation_errors"`
	ValidationRecords []CustomHostnameGetResponseSSLValidationRecord `json:"validation_records"`
	// Indicates whether the certificate covers a wildcard.
	Wildcard bool                             `json:"wildcard"`
	JSON     customHostnameGetResponseSSLJSON `json:"-"`
}

func (*CustomHostnameGetResponseSSL) UnmarshalJSON 

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

type CustomHostnameGetResponseSSLSettings 

type CustomHostnameGetResponseSSLSettings struct {
	// An allowlist of ciphers for TLS termination. These ciphers must be in the
	// BoringSSL format.
	Ciphers []string `json:"ciphers"`
	// Whether or not Early Hints is enabled.
	EarlyHints CustomHostnameGetResponseSSLSettingsEarlyHints `json:"early_hints"`
	// Whether or not HTTP2 is enabled.
	HTTP2 CustomHostnameGetResponseSSLSettingsHTTP2 `json:"http2"`
	// The minimum TLS version supported.
	MinTLSVersion CustomHostnameGetResponseSSLSettingsMinTLSVersion `json:"min_tls_version"`
	// Whether or not TLS 1.3 is enabled.
	TLS1_3 CustomHostnameGetResponseSSLSettingsTLS1_3 `json:"tls_1_3"`
	JSON   customHostnameGetResponseSSLSettingsJSON   `json:"-"`
}

func (*CustomHostnameGetResponseSSLSettings) UnmarshalJSON 

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

type CustomHostnameGetResponseSSLSettingsEarlyHints 

type CustomHostnameGetResponseSSLSettingsEarlyHints string

Whether or not Early Hints is enabled. 

const (
	CustomHostnameGetResponseSSLSettingsEarlyHintsOn  CustomHostnameGetResponseSSLSettingsEarlyHints = "on"
	CustomHostnameGetResponseSSLSettingsEarlyHintsOff CustomHostnameGetResponseSSLSettingsEarlyHints = "off"
)

func (CustomHostnameGetResponseSSLSettingsEarlyHints) IsKnown 

func (r CustomHostnameGetResponseSSLSettingsEarlyHints) IsKnown() bool

type CustomHostnameGetResponseSSLSettingsHTTP2 

type CustomHostnameGetResponseSSLSettingsHTTP2 string

Whether or not HTTP2 is enabled. 

const (
	CustomHostnameGetResponseSSLSettingsHTTP2On  CustomHostnameGetResponseSSLSettingsHTTP2 = "on"
	CustomHostnameGetResponseSSLSettingsHTTP2Off CustomHostnameGetResponseSSLSettingsHTTP2 = "off"
)

func (CustomHostnameGetResponseSSLSettingsHTTP2) IsKnown 

func (r CustomHostnameGetResponseSSLSettingsHTTP2) IsKnown() bool

type CustomHostnameGetResponseSSLSettingsMinTLSVersion 

type CustomHostnameGetResponseSSLSettingsMinTLSVersion string

The minimum TLS version supported. 

const (
	CustomHostnameGetResponseSSLSettingsMinTLSVersion1_0 CustomHostnameGetResponseSSLSettingsMinTLSVersion = "1.0"
	CustomHostnameGetResponseSSLSettingsMinTLSVersion1_1 CustomHostnameGetResponseSSLSettingsMinTLSVersion = "1.1"
	CustomHostnameGetResponseSSLSettingsMinTLSVersion1_2 CustomHostnameGetResponseSSLSettingsMinTLSVersion = "1.2"
	CustomHostnameGetResponseSSLSettingsMinTLSVersion1_3 CustomHostnameGetResponseSSLSettingsMinTLSVersion = "1.3"
)

func (CustomHostnameGetResponseSSLSettingsMinTLSVersion) IsKnown 

func (r CustomHostnameGetResponseSSLSettingsMinTLSVersion) IsKnown() bool

type CustomHostnameGetResponseSSLSettingsTLS1_3 

type CustomHostnameGetResponseSSLSettingsTLS1_3 string

Whether or not TLS 1.3 is enabled. 

const (
	CustomHostnameGetResponseSSLSettingsTLS1_3On  CustomHostnameGetResponseSSLSettingsTLS1_3 = "on"
	CustomHostnameGetResponseSSLSettingsTLS1_3Off CustomHostnameGetResponseSSLSettingsTLS1_3 = "off"
)

func (CustomHostnameGetResponseSSLSettingsTLS1_3) IsKnown 

func (r CustomHostnameGetResponseSSLSettingsTLS1_3) IsKnown() bool

type CustomHostnameGetResponseSSLStatus 

type CustomHostnameGetResponseSSLStatus string

Status of the hostname's SSL certificates. 

const (
	CustomHostnameGetResponseSSLStatusInitializing         CustomHostnameGetResponseSSLStatus = "initializing"
	CustomHostnameGetResponseSSLStatusPendingValidation    CustomHostnameGetResponseSSLStatus = "pending_validation"
	CustomHostnameGetResponseSSLStatusDeleted              CustomHostnameGetResponseSSLStatus = "deleted"
	CustomHostnameGetResponseSSLStatusPendingIssuance      CustomHostnameGetResponseSSLStatus = "pending_issuance"
	CustomHostnameGetResponseSSLStatusPendingDeployment    CustomHostnameGetResponseSSLStatus = "pending_deployment"
	CustomHostnameGetResponseSSLStatusPendingDeletion      CustomHostnameGetResponseSSLStatus = "pending_deletion"
	CustomHostnameGetResponseSSLStatusPendingExpiration    CustomHostnameGetResponseSSLStatus = "pending_expiration"
	CustomHostnameGetResponseSSLStatusExpired              CustomHostnameGetResponseSSLStatus = "expired"
	CustomHostnameGetResponseSSLStatusActive               CustomHostnameGetResponseSSLStatus = "active"
	CustomHostnameGetResponseSSLStatusInitializingTimedOut CustomHostnameGetResponseSSLStatus = "initializing_timed_out"
	CustomHostnameGetResponseSSLStatusValidationTimedOut   CustomHostnameGetResponseSSLStatus = "validation_timed_out"
	CustomHostnameGetResponseSSLStatusIssuanceTimedOut     CustomHostnameGetResponseSSLStatus = "issuance_timed_out"
	CustomHostnameGetResponseSSLStatusDeploymentTimedOut   CustomHostnameGetResponseSSLStatus = "deployment_timed_out"
	CustomHostnameGetResponseSSLStatusDeletionTimedOut     CustomHostnameGetResponseSSLStatus = "deletion_timed_out"
	CustomHostnameGetResponseSSLStatusPendingCleanup       CustomHostnameGetResponseSSLStatus = "pending_cleanup"
	CustomHostnameGetResponseSSLStatusStagingDeployment    CustomHostnameGetResponseSSLStatus = "staging_deployment"
	CustomHostnameGetResponseSSLStatusStagingActive        CustomHostnameGetResponseSSLStatus = "staging_active"
	CustomHostnameGetResponseSSLStatusDeactivating         CustomHostnameGetResponseSSLStatus = "deactivating"
	CustomHostnameGetResponseSSLStatusInactive             CustomHostnameGetResponseSSLStatus = "inactive"
	CustomHostnameGetResponseSSLStatusBackupIssued         CustomHostnameGetResponseSSLStatus = "backup_issued"
	CustomHostnameGetResponseSSLStatusHoldingDeployment    CustomHostnameGetResponseSSLStatus = "holding_deployment"
)

func (CustomHostnameGetResponseSSLStatus) IsKnown 

func (r CustomHostnameGetResponseSSLStatus) IsKnown() bool

type CustomHostnameGetResponseSSLValidationError 

type CustomHostnameGetResponseSSLValidationError struct {
	// A domain validation error.
	Message string                                          `json:"message"`
	JSON    customHostnameGetResponseSSLValidationErrorJSON `json:"-"`
}

func (*CustomHostnameGetResponseSSLValidationError) UnmarshalJSON 

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

type CustomHostnameGetResponseSSLValidationRecord 

type CustomHostnameGetResponseSSLValidationRecord struct {
	// The set of email addresses that the certificate authority (CA) will use to
	// complete domain validation.
	Emails []string `json:"emails"`
	// The content that the certificate authority (CA) will expect to find at the
	// http_url during the domain validation.
	HTTPBody string `json:"http_body"`
	// The url that will be checked during domain validation.
	HTTPURL string `json:"http_url"`
	// The hostname that the certificate authority (CA) will check for a TXT record
	// during domain validation .
	TXTName string `json:"txt_name"`
	// The TXT record that the certificate authority (CA) will check during domain
	// validation.
	TXTValue string                                           `json:"txt_value"`
	JSON     customHostnameGetResponseSSLValidationRecordJSON `json:"-"`
}

func (*CustomHostnameGetResponseSSLValidationRecord) UnmarshalJSON 

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

type CustomHostnameGetResponseStatus 

type CustomHostnameGetResponseStatus string

Status of the hostname's activation. 

const (
	CustomHostnameGetResponseStatusActive             CustomHostnameGetResponseStatus = "active"
	CustomHostnameGetResponseStatusPending            CustomHostnameGetResponseStatus = "pending"
	CustomHostnameGetResponseStatusActiveRedeploying  CustomHostnameGetResponseStatus = "active_redeploying"
	CustomHostnameGetResponseStatusMoved              CustomHostnameGetResponseStatus = "moved"
	CustomHostnameGetResponseStatusPendingDeletion    CustomHostnameGetResponseStatus = "pending_deletion"
	CustomHostnameGetResponseStatusDeleted            CustomHostnameGetResponseStatus = "deleted"
	CustomHostnameGetResponseStatusPendingBlocked     CustomHostnameGetResponseStatus = "pending_blocked"
	CustomHostnameGetResponseStatusPendingMigration   CustomHostnameGetResponseStatus = "pending_migration"
	CustomHostnameGetResponseStatusPendingProvisioned CustomHostnameGetResponseStatus = "pending_provisioned"
	CustomHostnameGetResponseStatusTestPending        CustomHostnameGetResponseStatus = "test_pending"
	CustomHostnameGetResponseStatusTestActive         CustomHostnameGetResponseStatus = "test_active"
	CustomHostnameGetResponseStatusTestActiveApex     CustomHostnameGetResponseStatus = "test_active_apex"
	CustomHostnameGetResponseStatusTestBlocked        CustomHostnameGetResponseStatus = "test_blocked"
	CustomHostnameGetResponseStatusTestFailed         CustomHostnameGetResponseStatus = "test_failed"
	CustomHostnameGetResponseStatusProvisioned        CustomHostnameGetResponseStatus = "provisioned"
	CustomHostnameGetResponseStatusBlocked            CustomHostnameGetResponseStatus = "blocked"
)

func (CustomHostnameGetResponseStatus) IsKnown 

func (r CustomHostnameGetResponseStatus) IsKnown() bool

type CustomHostnameListParams 

type CustomHostnameListParams struct {
	// Identifier
	ZoneID param.Field[string] `path:"zone_id,required"`
	// Hostname ID to match against. This ID was generated and returned during the
	// initial custom_hostname creation. This parameter cannot be used with the
	// 'hostname' parameter.
	ID param.Field[string] `query:"id"`
	// Direction to order hostnames.
	Direction param.Field[CustomHostnameListParamsDirection] `query:"direction"`
	// Fully qualified domain name to match against. This parameter cannot be used with
	// the 'id' parameter.
	Hostname param.Field[string] `query:"hostname"`
	// Field to order hostnames by.
	Order param.Field[CustomHostnameListParamsOrder] `query:"order"`
	// Page number of paginated results.
	Page param.Field[float64] `query:"page"`
	// Number of hostnames per page.
	PerPage param.Field[float64] `query:"per_page"`
	// Whether to filter hostnames based on if they have SSL enabled.
	SSL param.Field[CustomHostnameListParamsSSL] `query:"ssl"`
}

func (CustomHostnameListParams) URLQuery 

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

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

type CustomHostnameListParamsDirection 

type CustomHostnameListParamsDirection string

Direction to order hostnames. 

const (
	CustomHostnameListParamsDirectionAsc  CustomHostnameListParamsDirection = "asc"
	CustomHostnameListParamsDirectionDesc CustomHostnameListParamsDirection = "desc"
)

func (CustomHostnameListParamsDirection) IsKnown 

func (r CustomHostnameListParamsDirection) IsKnown() bool

type CustomHostnameListParamsOrder 

type CustomHostnameListParamsOrder string

Field to order hostnames by. 

const (
	CustomHostnameListParamsOrderSSL       CustomHostnameListParamsOrder = "ssl"
	CustomHostnameListParamsOrderSSLStatus CustomHostnameListParamsOrder = "ssl_status"
)

func (CustomHostnameListParamsOrder) IsKnown 

func (r CustomHostnameListParamsOrder) IsKnown() bool

type CustomHostnameListParamsSSL 

type CustomHostnameListParamsSSL float64

Whether to filter hostnames based on if they have SSL enabled. 

const (
	CustomHostnameListParamsSSL0 CustomHostnameListParamsSSL = 0
	CustomHostnameListParamsSSL1 CustomHostnameListParamsSSL = 1
)

func (CustomHostnameListParamsSSL) IsKnown 

func (r CustomHostnameListParamsSSL) IsKnown() bool

type CustomHostnameListResponse 

type CustomHostnameListResponse struct {
	// Identifier
	ID string `json:"id,required"`
	// The custom hostname that will point to your hostname via CNAME.
	Hostname string                        `json:"hostname,required"`
	SSL      CustomHostnameListResponseSSL `json:"ssl,required"`
	// This is the time the hostname was created.
	CreatedAt time.Time `json:"created_at" format:"date-time"`
	// Unique key/value metadata for this hostname. These are per-hostname (customer)
	// settings.
	CustomMetadata map[string]string `json:"custom_metadata"`
	// a valid hostname that’s been added to your DNS zone as an A, AAAA, or CNAME
	// record.
	CustomOriginServer string `json:"custom_origin_server"`
	// A hostname that will be sent to your custom origin server as SNI for TLS
	// handshake. This can be a valid subdomain of the zone or custom origin server
	// name or the string ':request_host_header:' which will cause the host header in
	// the request to be used as SNI. Not configurable with default/fallback origin
	// server.
	CustomOriginSNI string `json:"custom_origin_sni"`
	// This is a record which can be placed to activate a hostname.
	OwnershipVerification CustomHostnameListResponseOwnershipVerification `json:"ownership_verification"`
	// This presents the token to be served by the given http url to activate a
	// hostname.
	OwnershipVerificationHTTP CustomHostnameListResponseOwnershipVerificationHTTP `json:"ownership_verification_http"`
	// Status of the hostname's activation.
	Status CustomHostnameListResponseStatus `json:"status"`
	// These are errors that were encountered while trying to activate a hostname.
	VerificationErrors []string                       `json:"verification_errors"`
	JSON               customHostnameListResponseJSON `json:"-"`
}

func (*CustomHostnameListResponse) UnmarshalJSON 

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

type CustomHostnameListResponseOwnershipVerification 

type CustomHostnameListResponseOwnershipVerification struct {
	// DNS Name for record.
	Name string `json:"name"`
	// DNS Record type.
	Type CustomHostnameListResponseOwnershipVerificationType `json:"type"`
	// Content for the record.
	Value string                                              `json:"value"`
	JSON  customHostnameListResponseOwnershipVerificationJSON `json:"-"`
}

This is a record which can be placed to activate a hostname.

func (*CustomHostnameListResponseOwnershipVerification) UnmarshalJSON 

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

type CustomHostnameListResponseOwnershipVerificationHTTP 

type CustomHostnameListResponseOwnershipVerificationHTTP struct {
	// Token to be served.
	HTTPBody string `json:"http_body"`
	// The HTTP URL that will be checked during custom hostname verification and where
	// the customer should host the token.
	HTTPURL string                                                  `json:"http_url"`
	JSON    customHostnameListResponseOwnershipVerificationHTTPJSON `json:"-"`
}

This presents the token to be served by the given http url to activate a hostname.

func (*CustomHostnameListResponseOwnershipVerificationHTTP) UnmarshalJSON 

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

type CustomHostnameListResponseOwnershipVerificationType 

type CustomHostnameListResponseOwnershipVerificationType string

DNS Record type. 

const (
	CustomHostnameListResponseOwnershipVerificationTypeTXT CustomHostnameListResponseOwnershipVerificationType = "txt"
)

func (CustomHostnameListResponseOwnershipVerificationType) IsKnown 

func (r CustomHostnameListResponseOwnershipVerificationType) IsKnown() bool

type CustomHostnameListResponseSSL 

type CustomHostnameListResponseSSL struct {
	// Custom hostname SSL identifier tag.
	ID string `json:"id"`
	// A ubiquitous bundle has the highest probability of being verified everywhere,
	// even by clients using outdated or unusual trust stores. An optimal bundle uses
	// the shortest chain and newest intermediates. And the force bundle verifies the
	// chain, but does not otherwise modify it.
	BundleMethod BundleMethod `json:"bundle_method"`
	// The Certificate Authority that will issue the certificate
	CertificateAuthority shared.CertificateCA `json:"certificate_authority"`
	// If a custom uploaded certificate is used.
	CustomCertificate string `json:"custom_certificate"`
	// The identifier for the Custom CSR that was used.
	CustomCsrID string `json:"custom_csr_id"`
	// The key for a custom uploaded certificate.
	CustomKey string `json:"custom_key"`
	// The time the custom certificate expires on.
	ExpiresOn time.Time `json:"expires_on" format:"date-time"`
	// A list of Hostnames on a custom uploaded certificate.
	Hosts []string `json:"hosts"`
	// The issuer on a custom uploaded certificate.
	Issuer string `json:"issuer"`
	// Domain control validation (DCV) method used for this hostname.
	Method DCVMethod `json:"method"`
	// The serial number on a custom uploaded certificate.
	SerialNumber string                                `json:"serial_number"`
	Settings     CustomHostnameListResponseSSLSettings `json:"settings"`
	// The signature on a custom uploaded certificate.
	Signature string `json:"signature"`
	// Status of the hostname's SSL certificates.
	Status CustomHostnameListResponseSSLStatus `json:"status"`
	// Level of validation to be used for this hostname. Domain validation (dv) must be
	// used.
	Type DomainValidationType `json:"type"`
	// The time the custom certificate was uploaded.
	UploadedOn time.Time `json:"uploaded_on" format:"date-time"`
	// Domain validation errors that have been received by the certificate authority
	// (CA).
	ValidationErrors  []CustomHostnameListResponseSSLValidationError  `json:"validation_errors"`
	ValidationRecords []CustomHostnameListResponseSSLValidationRecord `json:"validation_records"`
	// Indicates whether the certificate covers a wildcard.
	Wildcard bool                              `json:"wildcard"`
	JSON     customHostnameListResponseSSLJSON `json:"-"`
}

func (*CustomHostnameListResponseSSL) UnmarshalJSON 

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

type CustomHostnameListResponseSSLSettings 

type CustomHostnameListResponseSSLSettings struct {
	// An allowlist of ciphers for TLS termination. These ciphers must be in the
	// BoringSSL format.
	Ciphers []string `json:"ciphers"`
	// Whether or not Early Hints is enabled.
	EarlyHints CustomHostnameListResponseSSLSettingsEarlyHints `json:"early_hints"`
	// Whether or not HTTP2 is enabled.
	HTTP2 CustomHostnameListResponseSSLSettingsHTTP2 `json:"http2"`
	// The minimum TLS version supported.
	MinTLSVersion CustomHostnameListResponseSSLSettingsMinTLSVersion `json:"min_tls_version"`
	// Whether or not TLS 1.3 is enabled.
	TLS1_3 CustomHostnameListResponseSSLSettingsTLS1_3 `json:"tls_1_3"`
	JSON   customHostnameListResponseSSLSettingsJSON   `json:"-"`
}

func (*CustomHostnameListResponseSSLSettings) UnmarshalJSON 

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

type CustomHostnameListResponseSSLSettingsEarlyHints 

type CustomHostnameListResponseSSLSettingsEarlyHints string

Whether or not Early Hints is enabled. 

const (
	CustomHostnameListResponseSSLSettingsEarlyHintsOn  CustomHostnameListResponseSSLSettingsEarlyHints = "on"
	CustomHostnameListResponseSSLSettingsEarlyHintsOff CustomHostnameListResponseSSLSettingsEarlyHints = "off"
)

func (CustomHostnameListResponseSSLSettingsEarlyHints) IsKnown 

func (r CustomHostnameListResponseSSLSettingsEarlyHints) IsKnown() bool

type CustomHostnameListResponseSSLSettingsHTTP2 

type CustomHostnameListResponseSSLSettingsHTTP2 string

Whether or not HTTP2 is enabled. 

const (
	CustomHostnameListResponseSSLSettingsHTTP2On  CustomHostnameListResponseSSLSettingsHTTP2 = "on"
	CustomHostnameListResponseSSLSettingsHTTP2Off CustomHostnameListResponseSSLSettingsHTTP2 = "off"
)

func (CustomHostnameListResponseSSLSettingsHTTP2) IsKnown 

func (r CustomHostnameListResponseSSLSettingsHTTP2) IsKnown() bool

type CustomHostnameListResponseSSLSettingsMinTLSVersion 

type CustomHostnameListResponseSSLSettingsMinTLSVersion string

The minimum TLS version supported. 

const (
	CustomHostnameListResponseSSLSettingsMinTLSVersion1_0 CustomHostnameListResponseSSLSettingsMinTLSVersion = "1.0"
	CustomHostnameListResponseSSLSettingsMinTLSVersion1_1 CustomHostnameListResponseSSLSettingsMinTLSVersion = "1.1"
	CustomHostnameListResponseSSLSettingsMinTLSVersion1_2 CustomHostnameListResponseSSLSettingsMinTLSVersion = "1.2"
	CustomHostnameListResponseSSLSettingsMinTLSVersion1_3 CustomHostnameListResponseSSLSettingsMinTLSVersion = "1.3"
)

func (CustomHostnameListResponseSSLSettingsMinTLSVersion) IsKnown 

func (r CustomHostnameListResponseSSLSettingsMinTLSVersion) IsKnown() bool

type CustomHostnameListResponseSSLSettingsTLS1_3 

type CustomHostnameListResponseSSLSettingsTLS1_3 string

Whether or not TLS 1.3 is enabled. 

const (
	CustomHostnameListResponseSSLSettingsTLS1_3On  CustomHostnameListResponseSSLSettingsTLS1_3 = "on"
	CustomHostnameListResponseSSLSettingsTLS1_3Off CustomHostnameListResponseSSLSettingsTLS1_3 = "off"
)

func (CustomHostnameListResponseSSLSettingsTLS1_3) IsKnown 

func (r CustomHostnameListResponseSSLSettingsTLS1_3) IsKnown() bool

type CustomHostnameListResponseSSLStatus 

type CustomHostnameListResponseSSLStatus string

Status of the hostname's SSL certificates. 

const (
	CustomHostnameListResponseSSLStatusInitializing         CustomHostnameListResponseSSLStatus = "initializing"
	CustomHostnameListResponseSSLStatusPendingValidation    CustomHostnameListResponseSSLStatus = "pending_validation"
	CustomHostnameListResponseSSLStatusDeleted              CustomHostnameListResponseSSLStatus = "deleted"
	CustomHostnameListResponseSSLStatusPendingIssuance      CustomHostnameListResponseSSLStatus = "pending_issuance"
	CustomHostnameListResponseSSLStatusPendingDeployment    CustomHostnameListResponseSSLStatus = "pending_deployment"
	CustomHostnameListResponseSSLStatusPendingDeletion      CustomHostnameListResponseSSLStatus = "pending_deletion"
	CustomHostnameListResponseSSLStatusPendingExpiration    CustomHostnameListResponseSSLStatus = "pending_expiration"
	CustomHostnameListResponseSSLStatusExpired              CustomHostnameListResponseSSLStatus = "expired"
	CustomHostnameListResponseSSLStatusActive               CustomHostnameListResponseSSLStatus = "active"
	CustomHostnameListResponseSSLStatusInitializingTimedOut CustomHostnameListResponseSSLStatus = "initializing_timed_out"
	CustomHostnameListResponseSSLStatusValidationTimedOut   CustomHostnameListResponseSSLStatus = "validation_timed_out"
	CustomHostnameListResponseSSLStatusIssuanceTimedOut     CustomHostnameListResponseSSLStatus = "issuance_timed_out"
	CustomHostnameListResponseSSLStatusDeploymentTimedOut   CustomHostnameListResponseSSLStatus = "deployment_timed_out"
	CustomHostnameListResponseSSLStatusDeletionTimedOut     CustomHostnameListResponseSSLStatus = "deletion_timed_out"
	CustomHostnameListResponseSSLStatusPendingCleanup       CustomHostnameListResponseSSLStatus = "pending_cleanup"
	CustomHostnameListResponseSSLStatusStagingDeployment    CustomHostnameListResponseSSLStatus = "staging_deployment"
	CustomHostnameListResponseSSLStatusStagingActive        CustomHostnameListResponseSSLStatus = "staging_active"
	CustomHostnameListResponseSSLStatusDeactivating         CustomHostnameListResponseSSLStatus = "deactivating"
	CustomHostnameListResponseSSLStatusInactive             CustomHostnameListResponseSSLStatus = "inactive"
	CustomHostnameListResponseSSLStatusBackupIssued         CustomHostnameListResponseSSLStatus = "backup_issued"
	CustomHostnameListResponseSSLStatusHoldingDeployment    CustomHostnameListResponseSSLStatus = "holding_deployment"
)

func (CustomHostnameListResponseSSLStatus) IsKnown 

func (r CustomHostnameListResponseSSLStatus) IsKnown() bool

type CustomHostnameListResponseSSLValidationError 

type CustomHostnameListResponseSSLValidationError struct {
	// A domain validation error.
	Message string                                           `json:"message"`
	JSON    customHostnameListResponseSSLValidationErrorJSON `json:"-"`
}

func (*CustomHostnameListResponseSSLValidationError) UnmarshalJSON 

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

type CustomHostnameListResponseSSLValidationRecord 

type CustomHostnameListResponseSSLValidationRecord struct {
	// The set of email addresses that the certificate authority (CA) will use to
	// complete domain validation.
	Emails []string `json:"emails"`
	// The content that the certificate authority (CA) will expect to find at the
	// http_url during the domain validation.
	HTTPBody string `json:"http_body"`
	// The url that will be checked during domain validation.
	HTTPURL string `json:"http_url"`
	// The hostname that the certificate authority (CA) will check for a TXT record
	// during domain validation .
	TXTName string `json:"txt_name"`
	// The TXT record that the certificate authority (CA) will check during domain
	// validation.
	TXTValue string                                            `json:"txt_value"`
	JSON     customHostnameListResponseSSLValidationRecordJSON `json:"-"`
}

func (*CustomHostnameListResponseSSLValidationRecord) UnmarshalJSON 

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

type CustomHostnameListResponseStatus 

type CustomHostnameListResponseStatus string

Status of the hostname's activation. 

const (
	CustomHostnameListResponseStatusActive             CustomHostnameListResponseStatus = "active"
	CustomHostnameListResponseStatusPending            CustomHostnameListResponseStatus = "pending"
	CustomHostnameListResponseStatusActiveRedeploying  CustomHostnameListResponseStatus = "active_redeploying"
	CustomHostnameListResponseStatusMoved              CustomHostnameListResponseStatus = "moved"
	CustomHostnameListResponseStatusPendingDeletion    CustomHostnameListResponseStatus = "pending_deletion"
	CustomHostnameListResponseStatusDeleted            CustomHostnameListResponseStatus = "deleted"
	CustomHostnameListResponseStatusPendingBlocked     CustomHostnameListResponseStatus = "pending_blocked"
	CustomHostnameListResponseStatusPendingMigration   CustomHostnameListResponseStatus = "pending_migration"
	CustomHostnameListResponseStatusPendingProvisioned CustomHostnameListResponseStatus = "pending_provisioned"
	CustomHostnameListResponseStatusTestPending        CustomHostnameListResponseStatus = "test_pending"
	CustomHostnameListResponseStatusTestActive         CustomHostnameListResponseStatus = "test_active"
	CustomHostnameListResponseStatusTestActiveApex     CustomHostnameListResponseStatus = "test_active_apex"
	CustomHostnameListResponseStatusTestBlocked        CustomHostnameListResponseStatus = "test_blocked"
	CustomHostnameListResponseStatusTestFailed         CustomHostnameListResponseStatus = "test_failed"
	CustomHostnameListResponseStatusProvisioned        CustomHostnameListResponseStatus = "provisioned"
	CustomHostnameListResponseStatusBlocked            CustomHostnameListResponseStatus = "blocked"
)

func (CustomHostnameListResponseStatus) IsKnown 

func (r CustomHostnameListResponseStatus) IsKnown() bool

type CustomHostnameNewParams 

type CustomHostnameNewParams struct {
	// Identifier
	ZoneID param.Field[string] `path:"zone_id,required"`
	// The custom hostname that will point to your hostname via CNAME.
	Hostname param.Field[string] `json:"hostname,required"`
	// SSL properties used when creating the custom hostname.
	SSL param.Field[CustomHostnameNewParamsSSL] `json:"ssl,required"`
	// Unique key/value metadata for this hostname. These are per-hostname (customer)
	// settings.
	CustomMetadata param.Field[map[string]string] `json:"custom_metadata"`
}

func (CustomHostnameNewParams) MarshalJSON 

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

type CustomHostnameNewParamsSSL 

type CustomHostnameNewParamsSSL struct {
	// A ubiquitous bundle has the highest probability of being verified everywhere,
	// even by clients using outdated or unusual trust stores. An optimal bundle uses
	// the shortest chain and newest intermediates. And the force bundle verifies the
	// chain, but does not otherwise modify it.
	BundleMethod param.Field[BundleMethod] `json:"bundle_method"`
	// The Certificate Authority that will issue the certificate
	CertificateAuthority param.Field[shared.CertificateCA] `json:"certificate_authority"`
	// Whether or not to add Cloudflare Branding for the order. This will add a
	// subdomain of sni.cloudflaressl.com as the Common Name if set to true
	CloudflareBranding param.Field[bool] `json:"cloudflare_branding"`
	// Array of custom certificate and key pairs (1 or 2 pairs allowed)
	CustomCERTBundle param.Field[[]CustomHostnameNewParamsSSLCustomCERTBundle] `json:"custom_cert_bundle"`
	// If a custom uploaded certificate is used.
	CustomCertificate param.Field[string] `json:"custom_certificate"`
	// The key for a custom uploaded certificate.
	CustomKey param.Field[string] `json:"custom_key"`
	// Domain control validation (DCV) method used for this hostname.
	Method param.Field[DCVMethod] `json:"method"`
	// SSL specific settings.
	Settings param.Field[CustomHostnameNewParamsSSLSettings] `json:"settings"`
	// Level of validation to be used for this hostname. Domain validation (dv) must be
	// used.
	Type param.Field[DomainValidationType] `json:"type"`
	// Indicates whether the certificate covers a wildcard.
	Wildcard param.Field[bool] `json:"wildcard"`
}

SSL properties used when creating the custom hostname.

func (CustomHostnameNewParamsSSL) MarshalJSON 

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

type CustomHostnameNewParamsSSLCustomCERTBundle added in v4.1.0 

type CustomHostnameNewParamsSSLCustomCERTBundle struct {
	// If a custom uploaded certificate is used.
	CustomCertificate param.Field[string] `json:"custom_certificate,required"`
	// The key for a custom uploaded certificate.
	CustomKey param.Field[string] `json:"custom_key,required"`
}

func (CustomHostnameNewParamsSSLCustomCERTBundle) MarshalJSON added in v4.1.0 

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

type CustomHostnameNewParamsSSLSettings 

type CustomHostnameNewParamsSSLSettings struct {
	// An allowlist of ciphers for TLS termination. These ciphers must be in the
	// BoringSSL format.
	Ciphers param.Field[[]string] `json:"ciphers"`
	// Whether or not Early Hints is enabled.
	EarlyHints param.Field[CustomHostnameNewParamsSSLSettingsEarlyHints] `json:"early_hints"`
	// Whether or not HTTP2 is enabled.
	HTTP2 param.Field[CustomHostnameNewParamsSSLSettingsHTTP2] `json:"http2"`
	// The minimum TLS version supported.
	MinTLSVersion param.Field[CustomHostnameNewParamsSSLSettingsMinTLSVersion] `json:"min_tls_version"`
	// Whether or not TLS 1.3 is enabled.
	TLS1_3 param.Field[CustomHostnameNewParamsSSLSettingsTLS1_3] `json:"tls_1_3"`
}

SSL specific settings.

func (CustomHostnameNewParamsSSLSettings) MarshalJSON 

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

type CustomHostnameNewParamsSSLSettingsEarlyHints 

type CustomHostnameNewParamsSSLSettingsEarlyHints string

Whether or not Early Hints is enabled. 

const (
	CustomHostnameNewParamsSSLSettingsEarlyHintsOn  CustomHostnameNewParamsSSLSettingsEarlyHints = "on"
	CustomHostnameNewParamsSSLSettingsEarlyHintsOff CustomHostnameNewParamsSSLSettingsEarlyHints = "off"
)

func (CustomHostnameNewParamsSSLSettingsEarlyHints) IsKnown 

func (r CustomHostnameNewParamsSSLSettingsEarlyHints) IsKnown() bool

type CustomHostnameNewParamsSSLSettingsHTTP2 

type CustomHostnameNewParamsSSLSettingsHTTP2 string

Whether or not HTTP2 is enabled. 

const (
	CustomHostnameNewParamsSSLSettingsHTTP2On  CustomHostnameNewParamsSSLSettingsHTTP2 = "on"
	CustomHostnameNewParamsSSLSettingsHTTP2Off CustomHostnameNewParamsSSLSettingsHTTP2 = "off"
)

func (CustomHostnameNewParamsSSLSettingsHTTP2) IsKnown 

func (r CustomHostnameNewParamsSSLSettingsHTTP2) IsKnown() bool

type CustomHostnameNewParamsSSLSettingsMinTLSVersion 

type CustomHostnameNewParamsSSLSettingsMinTLSVersion string

The minimum TLS version supported. 

const (
	CustomHostnameNewParamsSSLSettingsMinTLSVersion1_0 CustomHostnameNewParamsSSLSettingsMinTLSVersion = "1.0"
	CustomHostnameNewParamsSSLSettingsMinTLSVersion1_1 CustomHostnameNewParamsSSLSettingsMinTLSVersion = "1.1"
	CustomHostnameNewParamsSSLSettingsMinTLSVersion1_2 CustomHostnameNewParamsSSLSettingsMinTLSVersion = "1.2"
	CustomHostnameNewParamsSSLSettingsMinTLSVersion1_3 CustomHostnameNewParamsSSLSettingsMinTLSVersion = "1.3"
)

func (CustomHostnameNewParamsSSLSettingsMinTLSVersion) IsKnown 

func (r CustomHostnameNewParamsSSLSettingsMinTLSVersion) IsKnown() bool

type CustomHostnameNewParamsSSLSettingsTLS1_3 

type CustomHostnameNewParamsSSLSettingsTLS1_3 string

Whether or not TLS 1.3 is enabled. 

const (
	CustomHostnameNewParamsSSLSettingsTLS1_3On  CustomHostnameNewParamsSSLSettingsTLS1_3 = "on"
	CustomHostnameNewParamsSSLSettingsTLS1_3Off CustomHostnameNewParamsSSLSettingsTLS1_3 = "off"
)

func (CustomHostnameNewParamsSSLSettingsTLS1_3) IsKnown 

func (r CustomHostnameNewParamsSSLSettingsTLS1_3) IsKnown() bool

type CustomHostnameNewResponse 

type CustomHostnameNewResponse struct {
	// Identifier
	ID string `json:"id,required"`
	// The custom hostname that will point to your hostname via CNAME.
	Hostname string                       `json:"hostname,required"`
	SSL      CustomHostnameNewResponseSSL `json:"ssl,required"`
	// This is the time the hostname was created.
	CreatedAt time.Time `json:"created_at" format:"date-time"`
	// Unique key/value metadata for this hostname. These are per-hostname (customer)
	// settings.
	CustomMetadata map[string]string `json:"custom_metadata"`
	// a valid hostname that’s been added to your DNS zone as an A, AAAA, or CNAME
	// record.
	CustomOriginServer string `json:"custom_origin_server"`
	// A hostname that will be sent to your custom origin server as SNI for TLS
	// handshake. This can be a valid subdomain of the zone or custom origin server
	// name or the string ':request_host_header:' which will cause the host header in
	// the request to be used as SNI. Not configurable with default/fallback origin
	// server.
	CustomOriginSNI string `json:"custom_origin_sni"`
	// This is a record which can be placed to activate a hostname.
	OwnershipVerification CustomHostnameNewResponseOwnershipVerification `json:"ownership_verification"`
	// This presents the token to be served by the given http url to activate a
	// hostname.
	OwnershipVerificationHTTP CustomHostnameNewResponseOwnershipVerificationHTTP `json:"ownership_verification_http"`
	// Status of the hostname's activation.
	Status CustomHostnameNewResponseStatus `json:"status"`
	// These are errors that were encountered while trying to activate a hostname.
	VerificationErrors []string                      `json:"verification_errors"`
	JSON               customHostnameNewResponseJSON `json:"-"`
}

func (*CustomHostnameNewResponse) UnmarshalJSON 

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

type CustomHostnameNewResponseEnvelope 

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

func (*CustomHostnameNewResponseEnvelope) UnmarshalJSON 

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

type CustomHostnameNewResponseEnvelopeSuccess 

type CustomHostnameNewResponseEnvelopeSuccess bool

Whether the API call was successful 

const (
	CustomHostnameNewResponseEnvelopeSuccessTrue CustomHostnameNewResponseEnvelopeSuccess = true
)

func (CustomHostnameNewResponseEnvelopeSuccess) IsKnown 

func (r CustomHostnameNewResponseEnvelopeSuccess) IsKnown() bool

type CustomHostnameNewResponseOwnershipVerification 

type CustomHostnameNewResponseOwnershipVerification struct {
	// DNS Name for record.
	Name string `json:"name"`
	// DNS Record type.
	Type CustomHostnameNewResponseOwnershipVerificationType `json:"type"`
	// Content for the record.
	Value string                                             `json:"value"`
	JSON  customHostnameNewResponseOwnershipVerificationJSON `json:"-"`
}

This is a record which can be placed to activate a hostname.

func (*CustomHostnameNewResponseOwnershipVerification) UnmarshalJSON 

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

type CustomHostnameNewResponseOwnershipVerificationHTTP 

type CustomHostnameNewResponseOwnershipVerificationHTTP struct {
	// Token to be served.
	HTTPBody string `json:"http_body"`
	// The HTTP URL that will be checked during custom hostname verification and where
	// the customer should host the token.
	HTTPURL string                                                 `json:"http_url"`
	JSON    customHostnameNewResponseOwnershipVerificationHTTPJSON `json:"-"`
}

This presents the token to be served by the given http url to activate a hostname.

func (*CustomHostnameNewResponseOwnershipVerificationHTTP) UnmarshalJSON 

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

type CustomHostnameNewResponseOwnershipVerificationType 

type CustomHostnameNewResponseOwnershipVerificationType string

DNS Record type. 

const (
	CustomHostnameNewResponseOwnershipVerificationTypeTXT CustomHostnameNewResponseOwnershipVerificationType = "txt"
)

func (CustomHostnameNewResponseOwnershipVerificationType) IsKnown 

func (r CustomHostnameNewResponseOwnershipVerificationType) IsKnown() bool

type CustomHostnameNewResponseSSL 

type CustomHostnameNewResponseSSL struct {
	// Custom hostname SSL identifier tag.
	ID string `json:"id"`
	// A ubiquitous bundle has the highest probability of being verified everywhere,
	// even by clients using outdated or unusual trust stores. An optimal bundle uses
	// the shortest chain and newest intermediates. And the force bundle verifies the
	// chain, but does not otherwise modify it.
	BundleMethod BundleMethod `json:"bundle_method"`
	// The Certificate Authority that will issue the certificate
	CertificateAuthority shared.CertificateCA `json:"certificate_authority"`
	// If a custom uploaded certificate is used.
	CustomCertificate string `json:"custom_certificate"`
	// The identifier for the Custom CSR that was used.
	CustomCsrID string `json:"custom_csr_id"`
	// The key for a custom uploaded certificate.
	CustomKey string `json:"custom_key"`
	// The time the custom certificate expires on.
	ExpiresOn time.Time `json:"expires_on" format:"date-time"`
	// A list of Hostnames on a custom uploaded certificate.
	Hosts []string `json:"hosts"`
	// The issuer on a custom uploaded certificate.
	Issuer string `json:"issuer"`
	// Domain control validation (DCV) method used for this hostname.
	Method DCVMethod `json:"method"`
	// The serial number on a custom uploaded certificate.
	SerialNumber string                               `json:"serial_number"`
	Settings     CustomHostnameNewResponseSSLSettings `json:"settings"`
	// The signature on a custom uploaded certificate.
	Signature string `json:"signature"`
	// Status of the hostname's SSL certificates.
	Status CustomHostnameNewResponseSSLStatus `json:"status"`
	// Level of validation to be used for this hostname. Domain validation (dv) must be
	// used.
	Type DomainValidationType `json:"type"`
	// The time the custom certificate was uploaded.
	UploadedOn time.Time `json:"uploaded_on" format:"date-time"`
	// Domain validation errors that have been received by the certificate authority
	// (CA).
	ValidationErrors  []CustomHostnameNewResponseSSLValidationError  `json:"validation_errors"`
	ValidationRecords []CustomHostnameNewResponseSSLValidationRecord `json:"validation_records"`
	// Indicates whether the certificate covers a wildcard.
	Wildcard bool                             `json:"wildcard"`
	JSON     customHostnameNewResponseSSLJSON `json:"-"`
}

func (*CustomHostnameNewResponseSSL) UnmarshalJSON 

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

type CustomHostnameNewResponseSSLSettings 

type CustomHostnameNewResponseSSLSettings struct {
	// An allowlist of ciphers for TLS termination. These ciphers must be in the
	// BoringSSL format.
	Ciphers []string `json:"ciphers"`
	// Whether or not Early Hints is enabled.
	EarlyHints CustomHostnameNewResponseSSLSettingsEarlyHints `json:"early_hints"`
	// Whether or not HTTP2 is enabled.
	HTTP2 CustomHostnameNewResponseSSLSettingsHTTP2 `json:"http2"`
	// The minimum TLS version supported.
	MinTLSVersion CustomHostnameNewResponseSSLSettingsMinTLSVersion `json:"min_tls_version"`
	// Whether or not TLS 1.3 is enabled.
	TLS1_3 CustomHostnameNewResponseSSLSettingsTLS1_3 `json:"tls_1_3"`
	JSON   customHostnameNewResponseSSLSettingsJSON   `json:"-"`
}

func (*CustomHostnameNewResponseSSLSettings) UnmarshalJSON 

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

type CustomHostnameNewResponseSSLSettingsEarlyHints 

type CustomHostnameNewResponseSSLSettingsEarlyHints string

Whether or not Early Hints is enabled. 

const (
	CustomHostnameNewResponseSSLSettingsEarlyHintsOn  CustomHostnameNewResponseSSLSettingsEarlyHints = "on"
	CustomHostnameNewResponseSSLSettingsEarlyHintsOff CustomHostnameNewResponseSSLSettingsEarlyHints = "off"
)

func (CustomHostnameNewResponseSSLSettingsEarlyHints) IsKnown 

func (r CustomHostnameNewResponseSSLSettingsEarlyHints) IsKnown() bool

type CustomHostnameNewResponseSSLSettingsHTTP2 

type CustomHostnameNewResponseSSLSettingsHTTP2 string

Whether or not HTTP2 is enabled. 

const (
	CustomHostnameNewResponseSSLSettingsHTTP2On  CustomHostnameNewResponseSSLSettingsHTTP2 = "on"
	CustomHostnameNewResponseSSLSettingsHTTP2Off CustomHostnameNewResponseSSLSettingsHTTP2 = "off"
)

func (CustomHostnameNewResponseSSLSettingsHTTP2) IsKnown 

func (r CustomHostnameNewResponseSSLSettingsHTTP2) IsKnown() bool

type CustomHostnameNewResponseSSLSettingsMinTLSVersion 

type CustomHostnameNewResponseSSLSettingsMinTLSVersion string

The minimum TLS version supported. 

const (
	CustomHostnameNewResponseSSLSettingsMinTLSVersion1_0 CustomHostnameNewResponseSSLSettingsMinTLSVersion = "1.0"
	CustomHostnameNewResponseSSLSettingsMinTLSVersion1_1 CustomHostnameNewResponseSSLSettingsMinTLSVersion = "1.1"
	CustomHostnameNewResponseSSLSettingsMinTLSVersion1_2 CustomHostnameNewResponseSSLSettingsMinTLSVersion = "1.2"
	CustomHostnameNewResponseSSLSettingsMinTLSVersion1_3 CustomHostnameNewResponseSSLSettingsMinTLSVersion = "1.3"
)

func (CustomHostnameNewResponseSSLSettingsMinTLSVersion) IsKnown 

func (r CustomHostnameNewResponseSSLSettingsMinTLSVersion) IsKnown() bool

type CustomHostnameNewResponseSSLSettingsTLS1_3 

type CustomHostnameNewResponseSSLSettingsTLS1_3 string

Whether or not TLS 1.3 is enabled. 

const (
	CustomHostnameNewResponseSSLSettingsTLS1_3On  CustomHostnameNewResponseSSLSettingsTLS1_3 = "on"
	CustomHostnameNewResponseSSLSettingsTLS1_3Off CustomHostnameNewResponseSSLSettingsTLS1_3 = "off"
)

func (CustomHostnameNewResponseSSLSettingsTLS1_3) IsKnown 

func (r CustomHostnameNewResponseSSLSettingsTLS1_3) IsKnown() bool

type CustomHostnameNewResponseSSLStatus 

type CustomHostnameNewResponseSSLStatus string

Status of the hostname's SSL certificates. 

const (
	CustomHostnameNewResponseSSLStatusInitializing         CustomHostnameNewResponseSSLStatus = "initializing"
	CustomHostnameNewResponseSSLStatusPendingValidation    CustomHostnameNewResponseSSLStatus = "pending_validation"
	CustomHostnameNewResponseSSLStatusDeleted              CustomHostnameNewResponseSSLStatus = "deleted"
	CustomHostnameNewResponseSSLStatusPendingIssuance      CustomHostnameNewResponseSSLStatus = "pending_issuance"
	CustomHostnameNewResponseSSLStatusPendingDeployment    CustomHostnameNewResponseSSLStatus = "pending_deployment"
	CustomHostnameNewResponseSSLStatusPendingDeletion      CustomHostnameNewResponseSSLStatus = "pending_deletion"
	CustomHostnameNewResponseSSLStatusPendingExpiration    CustomHostnameNewResponseSSLStatus = "pending_expiration"
	CustomHostnameNewResponseSSLStatusExpired              CustomHostnameNewResponseSSLStatus = "expired"
	CustomHostnameNewResponseSSLStatusActive               CustomHostnameNewResponseSSLStatus = "active"
	CustomHostnameNewResponseSSLStatusInitializingTimedOut CustomHostnameNewResponseSSLStatus = "initializing_timed_out"
	CustomHostnameNewResponseSSLStatusValidationTimedOut   CustomHostnameNewResponseSSLStatus = "validation_timed_out"
	CustomHostnameNewResponseSSLStatusIssuanceTimedOut     CustomHostnameNewResponseSSLStatus = "issuance_timed_out"
	CustomHostnameNewResponseSSLStatusDeploymentTimedOut   CustomHostnameNewResponseSSLStatus = "deployment_timed_out"
	CustomHostnameNewResponseSSLStatusDeletionTimedOut     CustomHostnameNewResponseSSLStatus = "deletion_timed_out"
	CustomHostnameNewResponseSSLStatusPendingCleanup       CustomHostnameNewResponseSSLStatus = "pending_cleanup"
	CustomHostnameNewResponseSSLStatusStagingDeployment    CustomHostnameNewResponseSSLStatus = "staging_deployment"
	CustomHostnameNewResponseSSLStatusStagingActive        CustomHostnameNewResponseSSLStatus = "staging_active"
	CustomHostnameNewResponseSSLStatusDeactivating         CustomHostnameNewResponseSSLStatus = "deactivating"
	CustomHostnameNewResponseSSLStatusInactive             CustomHostnameNewResponseSSLStatus = "inactive"
	CustomHostnameNewResponseSSLStatusBackupIssued         CustomHostnameNewResponseSSLStatus = "backup_issued"
	CustomHostnameNewResponseSSLStatusHoldingDeployment    CustomHostnameNewResponseSSLStatus = "holding_deployment"
)

func (CustomHostnameNewResponseSSLStatus) IsKnown 

func (r CustomHostnameNewResponseSSLStatus) IsKnown() bool

type CustomHostnameNewResponseSSLValidationError 

type CustomHostnameNewResponseSSLValidationError struct {
	// A domain validation error.
	Message string                                          `json:"message"`
	JSON    customHostnameNewResponseSSLValidationErrorJSON `json:"-"`
}

func (*CustomHostnameNewResponseSSLValidationError) UnmarshalJSON 

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

type CustomHostnameNewResponseSSLValidationRecord 

type CustomHostnameNewResponseSSLValidationRecord struct {
	// The set of email addresses that the certificate authority (CA) will use to
	// complete domain validation.
	Emails []string `json:"emails"`
	// The content that the certificate authority (CA) will expect to find at the
	// http_url during the domain validation.
	HTTPBody string `json:"http_body"`
	// The url that will be checked during domain validation.
	HTTPURL string `json:"http_url"`
	// The hostname that the certificate authority (CA) will check for a TXT record
	// during domain validation .
	TXTName string `json:"txt_name"`
	// The TXT record that the certificate authority (CA) will check during domain
	// validation.
	TXTValue string                                           `json:"txt_value"`
	JSON     customHostnameNewResponseSSLValidationRecordJSON `json:"-"`
}

func (*CustomHostnameNewResponseSSLValidationRecord) UnmarshalJSON 

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

type CustomHostnameNewResponseStatus 

type CustomHostnameNewResponseStatus string

Status of the hostname's activation. 

const (
	CustomHostnameNewResponseStatusActive             CustomHostnameNewResponseStatus = "active"
	CustomHostnameNewResponseStatusPending            CustomHostnameNewResponseStatus = "pending"
	CustomHostnameNewResponseStatusActiveRedeploying  CustomHostnameNewResponseStatus = "active_redeploying"
	CustomHostnameNewResponseStatusMoved              CustomHostnameNewResponseStatus = "moved"
	CustomHostnameNewResponseStatusPendingDeletion    CustomHostnameNewResponseStatus = "pending_deletion"
	CustomHostnameNewResponseStatusDeleted            CustomHostnameNewResponseStatus = "deleted"
	CustomHostnameNewResponseStatusPendingBlocked     CustomHostnameNewResponseStatus = "pending_blocked"
	CustomHostnameNewResponseStatusPendingMigration   CustomHostnameNewResponseStatus = "pending_migration"
	CustomHostnameNewResponseStatusPendingProvisioned CustomHostnameNewResponseStatus = "pending_provisioned"
	CustomHostnameNewResponseStatusTestPending        CustomHostnameNewResponseStatus = "test_pending"
	CustomHostnameNewResponseStatusTestActive         CustomHostnameNewResponseStatus = "test_active"
	CustomHostnameNewResponseStatusTestActiveApex     CustomHostnameNewResponseStatus = "test_active_apex"
	CustomHostnameNewResponseStatusTestBlocked        CustomHostnameNewResponseStatus = "test_blocked"
	CustomHostnameNewResponseStatusTestFailed         CustomHostnameNewResponseStatus = "test_failed"
	CustomHostnameNewResponseStatusProvisioned        CustomHostnameNewResponseStatus = "provisioned"
	CustomHostnameNewResponseStatusBlocked            CustomHostnameNewResponseStatus = "blocked"
)

func (CustomHostnameNewResponseStatus) IsKnown 

func (r CustomHostnameNewResponseStatus) IsKnown() bool

type CustomHostnameService 

type CustomHostnameService struct {
	Options         []option.RequestOption
	FallbackOrigin  *FallbackOriginService
	CertificatePack *CertificatePackService
}

CustomHostnameService 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 NewCustomHostnameService method instead.

func NewCustomHostnameService 

func NewCustomHostnameService(opts ...option.RequestOption) (r *CustomHostnameService)

NewCustomHostnameService 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 (*CustomHostnameService) Delete 

func (r *CustomHostnameService) Delete(ctx context.Context, customHostnameID string, body CustomHostnameDeleteParams, opts ...option.RequestOption) (res *CustomHostnameDeleteResponse, err error)

Delete Custom Hostname (and any issued SSL certificates)

func (*CustomHostnameService) Edit 

func (r *CustomHostnameService) Edit(ctx context.Context, customHostnameID string, params CustomHostnameEditParams, opts ...option.RequestOption) (res *CustomHostnameEditResponse, err error)

Modify SSL configuration for a custom hostname. When sent with SSL config that matches existing config, used to indicate that hostname should pass domain control validation (DCV). Can also be used to change validation type, e.g., from 'http' to 'email'. Bundle an existing certificate with another certificate by using the "custom_cert_bundle" field. The bundling process supports combining certificates as long as the following condition is met. One certificate must use the RSA algorithm, and the other must use the ECDSA algorithm.

func (*CustomHostnameService) Get 

func (r *CustomHostnameService) Get(ctx context.Context, customHostnameID string, query CustomHostnameGetParams, opts ...option.RequestOption) (res *CustomHostnameGetResponse, err error)

Custom Hostname Details

func (*CustomHostnameService) List 

func (r *CustomHostnameService) List(ctx context.Context, params CustomHostnameListParams, opts ...option.RequestOption) (res *pagination.V4PagePaginationArray[CustomHostnameListResponse], err error)

List, search, sort, and filter all of your custom hostnames.

func (*CustomHostnameService) ListAutoPaging 

func (r *CustomHostnameService) ListAutoPaging(ctx context.Context, params CustomHostnameListParams, opts ...option.RequestOption) *pagination.V4PagePaginationArrayAutoPager[CustomHostnameListResponse]

List, search, sort, and filter all of your custom hostnames.

func (*CustomHostnameService) New 

func (r *CustomHostnameService) New(ctx context.Context, params CustomHostnameNewParams, opts ...option.RequestOption) (res *CustomHostnameNewResponse, err error)

Add a new custom hostname and request that an SSL certificate be issued for it. One of three validation methods—http, txt, email—should be used, with 'http' recommended if the CNAME is already in place (or will be soon). Specifying 'email' will send an email to the WHOIS contacts on file for the base domain plus hostmaster, postmaster, webmaster, admin, administrator. If http is used and the domain is not already pointing to the Managed CNAME host, the PATCH method must be used once it is (to complete validation). Enable bundling of certificates using the custom_cert_bundle field. The bundling process requires the following condition One certificate in the bundle must use an RSA, and the other must use an ECDSA.

type DCVMethod 

type DCVMethod string

Domain control validation (DCV) method used for this hostname. 

const (
	DCVMethodHTTP  DCVMethod = "http"
	DCVMethodTXT   DCVMethod = "txt"
	DCVMethodEmail DCVMethod = "email"
)

func (DCVMethod) IsKnown 

func (r DCVMethod) IsKnown() bool

type DomainValidationType 

type DomainValidationType string

Level of validation to be used for this hostname. Domain validation (dv) must be used. 

const (
	DomainValidationTypeDv DomainValidationType = "dv"
)

func (DomainValidationType) IsKnown 

func (r DomainValidationType) IsKnown() bool

type Error 

type Error = apierror.Error

type ErrorData 

type ErrorData = shared.ErrorData

This is an alias to an internal type.

type ErrorDataSource added in v4.2.0 

type ErrorDataSource = shared.ErrorDataSource

This is an alias to an internal type.

type FallbackOriginDeleteParams 

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

type FallbackOriginDeleteResponse 

type FallbackOriginDeleteResponse struct {
	// This is the time the fallback origin was created.
	CreatedAt time.Time `json:"created_at" format:"date-time"`
	// These are errors that were encountered while trying to activate a fallback
	// origin.
	Errors []string `json:"errors"`
	// Your origin hostname that requests to your custom hostnames will be sent to.
	Origin string `json:"origin"`
	// Status of the fallback origin's activation.
	Status FallbackOriginDeleteResponseStatus `json:"status"`
	// This is the time the fallback origin was updated.
	UpdatedAt time.Time                        `json:"updated_at" format:"date-time"`
	JSON      fallbackOriginDeleteResponseJSON `json:"-"`
}

func (*FallbackOriginDeleteResponse) UnmarshalJSON 

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

type FallbackOriginDeleteResponseEnvelope 

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

func (*FallbackOriginDeleteResponseEnvelope) UnmarshalJSON 

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

type FallbackOriginDeleteResponseEnvelopeSuccess 

type FallbackOriginDeleteResponseEnvelopeSuccess bool

Whether the API call was successful 

const (
	FallbackOriginDeleteResponseEnvelopeSuccessTrue FallbackOriginDeleteResponseEnvelopeSuccess = true
)

func (FallbackOriginDeleteResponseEnvelopeSuccess) IsKnown 

func (r FallbackOriginDeleteResponseEnvelopeSuccess) IsKnown() bool

type FallbackOriginDeleteResponseStatus 

type FallbackOriginDeleteResponseStatus string

Status of the fallback origin's activation. 

const (
	FallbackOriginDeleteResponseStatusInitializing       FallbackOriginDeleteResponseStatus = "initializing"
	FallbackOriginDeleteResponseStatusPendingDeployment  FallbackOriginDeleteResponseStatus = "pending_deployment"
	FallbackOriginDeleteResponseStatusPendingDeletion    FallbackOriginDeleteResponseStatus = "pending_deletion"
	FallbackOriginDeleteResponseStatusActive             FallbackOriginDeleteResponseStatus = "active"
	FallbackOriginDeleteResponseStatusDeploymentTimedOut FallbackOriginDeleteResponseStatus = "deployment_timed_out"
	FallbackOriginDeleteResponseStatusDeletionTimedOut   FallbackOriginDeleteResponseStatus = "deletion_timed_out"
)

func (FallbackOriginDeleteResponseStatus) IsKnown 

func (r FallbackOriginDeleteResponseStatus) IsKnown() bool

type FallbackOriginGetParams 

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

type FallbackOriginGetResponse 

type FallbackOriginGetResponse struct {
	// This is the time the fallback origin was created.
	CreatedAt time.Time `json:"created_at" format:"date-time"`
	// These are errors that were encountered while trying to activate a fallback
	// origin.
	Errors []string `json:"errors"`
	// Your origin hostname that requests to your custom hostnames will be sent to.
	Origin string `json:"origin"`
	// Status of the fallback origin's activation.
	Status FallbackOriginGetResponseStatus `json:"status"`
	// This is the time the fallback origin was updated.
	UpdatedAt time.Time                     `json:"updated_at" format:"date-time"`
	JSON      fallbackOriginGetResponseJSON `json:"-"`
}

func (*FallbackOriginGetResponse) UnmarshalJSON 

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

type FallbackOriginGetResponseEnvelope 

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

func (*FallbackOriginGetResponseEnvelope) UnmarshalJSON 

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

type FallbackOriginGetResponseEnvelopeSuccess 

type FallbackOriginGetResponseEnvelopeSuccess bool

Whether the API call was successful 

const (
	FallbackOriginGetResponseEnvelopeSuccessTrue FallbackOriginGetResponseEnvelopeSuccess = true
)

func (FallbackOriginGetResponseEnvelopeSuccess) IsKnown 

func (r FallbackOriginGetResponseEnvelopeSuccess) IsKnown() bool

type FallbackOriginGetResponseStatus 

type FallbackOriginGetResponseStatus string

Status of the fallback origin's activation. 

const (
	FallbackOriginGetResponseStatusInitializing       FallbackOriginGetResponseStatus = "initializing"
	FallbackOriginGetResponseStatusPendingDeployment  FallbackOriginGetResponseStatus = "pending_deployment"
	FallbackOriginGetResponseStatusPendingDeletion    FallbackOriginGetResponseStatus = "pending_deletion"
	FallbackOriginGetResponseStatusActive             FallbackOriginGetResponseStatus = "active"
	FallbackOriginGetResponseStatusDeploymentTimedOut FallbackOriginGetResponseStatus = "deployment_timed_out"
	FallbackOriginGetResponseStatusDeletionTimedOut   FallbackOriginGetResponseStatus = "deletion_timed_out"
)

func (FallbackOriginGetResponseStatus) IsKnown 

func (r FallbackOriginGetResponseStatus) IsKnown() bool

type FallbackOriginService 

type FallbackOriginService struct {
	Options []option.RequestOption
}

FallbackOriginService 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 NewFallbackOriginService method instead.

func NewFallbackOriginService 

func NewFallbackOriginService(opts ...option.RequestOption) (r *FallbackOriginService)

NewFallbackOriginService 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 (*FallbackOriginService) Delete 

func (r *FallbackOriginService) Delete(ctx context.Context, body FallbackOriginDeleteParams, opts ...option.RequestOption) (res *FallbackOriginDeleteResponse, err error)

Delete Fallback Origin for Custom Hostnames

func (*FallbackOriginService) Get 

func (r *FallbackOriginService) Get(ctx context.Context, query FallbackOriginGetParams, opts ...option.RequestOption) (res *FallbackOriginGetResponse, err error)

Get Fallback Origin for Custom Hostnames

func (*FallbackOriginService) Update 

func (r *FallbackOriginService) Update(ctx context.Context, params FallbackOriginUpdateParams, opts ...option.RequestOption) (res *FallbackOriginUpdateResponse, err error)

Update Fallback Origin for Custom Hostnames

type FallbackOriginUpdateParams 

type FallbackOriginUpdateParams struct {
	// Identifier
	ZoneID param.Field[string] `path:"zone_id,required"`
	// Your origin hostname that requests to your custom hostnames will be sent to.
	Origin param.Field[string] `json:"origin,required"`
}

func (FallbackOriginUpdateParams) MarshalJSON 

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

type FallbackOriginUpdateResponse 

type FallbackOriginUpdateResponse struct {
	// This is the time the fallback origin was created.
	CreatedAt time.Time `json:"created_at" format:"date-time"`
	// These are errors that were encountered while trying to activate a fallback
	// origin.
	Errors []string `json:"errors"`
	// Your origin hostname that requests to your custom hostnames will be sent to.
	Origin string `json:"origin"`
	// Status of the fallback origin's activation.
	Status FallbackOriginUpdateResponseStatus `json:"status"`
	// This is the time the fallback origin was updated.
	UpdatedAt time.Time                        `json:"updated_at" format:"date-time"`
	JSON      fallbackOriginUpdateResponseJSON `json:"-"`
}

func (*FallbackOriginUpdateResponse) UnmarshalJSON 

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

type FallbackOriginUpdateResponseEnvelope 

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

func (*FallbackOriginUpdateResponseEnvelope) UnmarshalJSON 

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

type FallbackOriginUpdateResponseEnvelopeSuccess 

type FallbackOriginUpdateResponseEnvelopeSuccess bool

Whether the API call was successful 

const (
	FallbackOriginUpdateResponseEnvelopeSuccessTrue FallbackOriginUpdateResponseEnvelopeSuccess = true
)

func (FallbackOriginUpdateResponseEnvelopeSuccess) IsKnown 

func (r FallbackOriginUpdateResponseEnvelopeSuccess) IsKnown() bool

type FallbackOriginUpdateResponseStatus 

type FallbackOriginUpdateResponseStatus string

Status of the fallback origin's activation. 

const (
	FallbackOriginUpdateResponseStatusInitializing       FallbackOriginUpdateResponseStatus = "initializing"
	FallbackOriginUpdateResponseStatusPendingDeployment  FallbackOriginUpdateResponseStatus = "pending_deployment"
	FallbackOriginUpdateResponseStatusPendingDeletion    FallbackOriginUpdateResponseStatus = "pending_deletion"
	FallbackOriginUpdateResponseStatusActive             FallbackOriginUpdateResponseStatus = "active"
	FallbackOriginUpdateResponseStatusDeploymentTimedOut FallbackOriginUpdateResponseStatus = "deployment_timed_out"
	FallbackOriginUpdateResponseStatusDeletionTimedOut   FallbackOriginUpdateResponseStatus = "deletion_timed_out"
)

func (FallbackOriginUpdateResponseStatus) IsKnown 

func (r FallbackOriginUpdateResponseStatus) IsKnown() bool

type Member 

type Member = shared.Member

This is an alias to an internal type.

type MemberPoliciesAccess 

type MemberPoliciesAccess = shared.MemberPoliciesAccess

Allow or deny operations against the resources.

This is an alias to an internal type.

type MemberPoliciesPermissionGroup 

type MemberPoliciesPermissionGroup = shared.MemberPoliciesPermissionGroup

A named group of permissions that map to a group of operations against resources.

This is an alias to an internal type.

type MemberPoliciesPermissionGroupsMeta 

type MemberPoliciesPermissionGroupsMeta = shared.MemberPoliciesPermissionGroupsMeta

Attributes associated to the permission group.

This is an alias to an internal type.

type MemberPoliciesResourceGroup 

type MemberPoliciesResourceGroup = shared.MemberPoliciesResourceGroup

A group of scoped resources.

This is an alias to an internal type.

type MemberPoliciesResourceGroupsMeta 

type MemberPoliciesResourceGroupsMeta = shared.MemberPoliciesResourceGroupsMeta

Attributes associated to the resource group.

This is an alias to an internal type.

type MemberPoliciesResourceGroupsScope 

type MemberPoliciesResourceGroupsScope = shared.MemberPoliciesResourceGroupsScope

A scope is a combination of scope objects which provides additional context.

This is an alias to an internal type.

type MemberPoliciesResourceGroupsScopeObject 

type MemberPoliciesResourceGroupsScopeObject = shared.MemberPoliciesResourceGroupsScopeObject

A scope object represents any resource that can have actions applied against invite.

This is an alias to an internal type.

type MemberPolicy 

type MemberPolicy = shared.MemberPolicy

This is an alias to an internal type.

type MemberStatus 

type MemberStatus = shared.MemberStatus

A member's status in the account.

This is an alias to an internal type.

type MemberUser 

type MemberUser = shared.MemberUser

Details of the user associated to the membership.

This is an alias to an internal type.

type Permission 

type Permission = shared.Permission

This is an alias to an internal type.

type PermissionGrant 

type PermissionGrant = shared.PermissionGrant

This is an alias to an internal type.

type PermissionGrantParam 

type PermissionGrantParam = shared.PermissionGrantParam

This is an alias to an internal type.

type RatePlan 

type RatePlan = shared.RatePlan

The rate plan applied to the subscription.

This is an alias to an internal type.

type RatePlanID added in v4.1.0 

type RatePlanID = shared.RatePlanID

The ID of the rate plan.

This is an alias to an internal type.

type RatePlanParam 

type RatePlanParam = shared.RatePlanParam

The rate plan applied to the subscription.

This is an alias to an internal type.

type ResponseInfo 

type ResponseInfo = shared.ResponseInfo

This is an alias to an internal type.

type Role 

type Role = shared.Role

This is an alias to an internal type.

type RoleParam 

type RoleParam = shared.RoleParam

This is an alias to an internal type.

type RolePermissions 

type RolePermissions = shared.RolePermissions

This is an alias to an internal type.

type RolePermissionsParam 

type RolePermissionsParam = shared.RolePermissionsParam

This is an alias to an internal type.

type SortDirection 

type SortDirection = shared.SortDirection

Direction to order DNS records in.

This is an alias to an internal type.

type Subscription 

type Subscription = shared.Subscription

This is an alias to an internal type.

type SubscriptionFrequency 

type SubscriptionFrequency = shared.SubscriptionFrequency

How often the subscription is renewed automatically.

This is an alias to an internal type.

type SubscriptionParam 

type SubscriptionParam = shared.SubscriptionParam

This is an alias to an internal type.

type SubscriptionState 

type SubscriptionState = shared.SubscriptionState

The state that the subscription is in.

This is an alias to an internal type.

type Token 

type Token = shared.Token

This is an alias to an internal type.

type TokenCondition 

type TokenCondition = shared.TokenCondition

This is an alias to an internal type.

type TokenConditionCIDRList 

type TokenConditionCIDRList = shared.TokenConditionCIDRList

IPv4/IPv6 CIDR.

This is an alias to an internal type.

type TokenConditionCIDRListParam 

type TokenConditionCIDRListParam = shared.TokenConditionCIDRListParam

IPv4/IPv6 CIDR.

This is an alias to an internal type.

type TokenConditionParam 

type TokenConditionParam = shared.TokenConditionParam

This is an alias to an internal type.

type TokenConditionRequestIP 

type TokenConditionRequestIP = shared.TokenConditionRequestIP

Client IP restrictions.

This is an alias to an internal type.

type TokenConditionRequestIPParam 

type TokenConditionRequestIPParam = shared.TokenConditionRequestIPParam

Client IP restrictions.

This is an alias to an internal type.

type TokenParam 

type TokenParam = shared.TokenParam

This is an alias to an internal type.

type TokenPolicy 

type TokenPolicy = shared.TokenPolicy

This is an alias to an internal type.

type TokenPolicyEffect 

type TokenPolicyEffect = shared.TokenPolicyEffect

Allow or deny operations against the resources.

This is an alias to an internal type.

type TokenPolicyParam 

type TokenPolicyParam = shared.TokenPolicyParam

This is an alias to an internal type.

type TokenPolicyPermissionGroup 

type TokenPolicyPermissionGroup = shared.TokenPolicyPermissionGroup

A named group of permissions that map to a group of operations against resources.

This is an alias to an internal type.

type TokenPolicyPermissionGroupParam 

type TokenPolicyPermissionGroupParam = shared.TokenPolicyPermissionGroupParam

A named group of permissions that map to a group of operations against resources.

This is an alias to an internal type.

type TokenPolicyPermissionGroupsMeta 

type TokenPolicyPermissionGroupsMeta = shared.TokenPolicyPermissionGroupsMeta

Attributes associated to the permission group.

This is an alias to an internal type.

type TokenPolicyPermissionGroupsMetaParam 

type TokenPolicyPermissionGroupsMetaParam = shared.TokenPolicyPermissionGroupsMetaParam

Attributes associated to the permission group.

This is an alias to an internal type.

type TokenStatus 

type TokenStatus = shared.TokenStatus

Status of the token.

This is an alias to an internal type.

type TokenValue 

type TokenValue = shared.TokenValue

The token value.

This is an alias to an internal type.

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.