custom_hostnames

package
v2.0.0-beta.9 Latest Latest
Warning

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

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

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

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"`
	// These are per-hostname (customer) settings.
	CustomMetadata param.Field[CustomHostnameEditParamsCustomMetadata] `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 CustomHostnameEditParamsCustomMetadata

type CustomHostnameEditParamsCustomMetadata struct {
	// Unique metadata for this hostname.
	Key param.Field[string] `json:"key"`
}

These are per-hostname (customer) settings.

func (CustomHostnameEditParamsCustomMetadata) MarshalJSON

func (r CustomHostnameEditParamsCustomMetadata) 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[CustomHostnameEditParamsSSLBundleMethod] `json:"bundle_method"`
	// The Certificate Authority that will issue the certificate
	CertificateAuthority param.Field[CustomHostnameEditParamsSSLCertificateAuthority] `json:"certificate_authority"`
	// 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[CustomHostnameEditParamsSSLMethod] `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[CustomHostnameEditParamsSSLType] `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 CustomHostnameEditParamsSSLBundleMethod

type CustomHostnameEditParamsSSLBundleMethod 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 (
	CustomHostnameEditParamsSSLBundleMethodUbiquitous CustomHostnameEditParamsSSLBundleMethod = "ubiquitous"
	CustomHostnameEditParamsSSLBundleMethodOptimal    CustomHostnameEditParamsSSLBundleMethod = "optimal"
	CustomHostnameEditParamsSSLBundleMethodForce      CustomHostnameEditParamsSSLBundleMethod = "force"
)

type CustomHostnameEditParamsSSLCertificateAuthority

type CustomHostnameEditParamsSSLCertificateAuthority string

The Certificate Authority that will issue the certificate

const (
	CustomHostnameEditParamsSSLCertificateAuthorityDigicert    CustomHostnameEditParamsSSLCertificateAuthority = "digicert"
	CustomHostnameEditParamsSSLCertificateAuthorityGoogle      CustomHostnameEditParamsSSLCertificateAuthority = "google"
	CustomHostnameEditParamsSSLCertificateAuthorityLetsEncrypt CustomHostnameEditParamsSSLCertificateAuthority = "lets_encrypt"
)

type CustomHostnameEditParamsSSLMethod

type CustomHostnameEditParamsSSLMethod string

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

const (
	CustomHostnameEditParamsSSLMethodHTTP  CustomHostnameEditParamsSSLMethod = "http"
	CustomHostnameEditParamsSSLMethodTXT   CustomHostnameEditParamsSSLMethod = "txt"
	CustomHostnameEditParamsSSLMethodEmail CustomHostnameEditParamsSSLMethod = "email"
)

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

type CustomHostnameEditParamsSSLSettingsHTTP2

type CustomHostnameEditParamsSSLSettingsHTTP2 string

Whether or not HTTP2 is enabled.

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

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

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

type CustomHostnameEditParamsSSLType

type CustomHostnameEditParamsSSLType string

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

const (
	CustomHostnameEditParamsSSLTypeDv CustomHostnameEditParamsSSLType = "dv"
)

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 properties for the custom hostname.
	SSL  CustomHostnameEditResponseSSL  `json:"ssl,required"`
	JSON customHostnameEditResponseJSON `json:"-"`
}

func (*CustomHostnameEditResponse) UnmarshalJSON

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

type CustomHostnameEditResponseEnvelope

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

func (*CustomHostnameEditResponseEnvelope) UnmarshalJSON

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

type CustomHostnameEditResponseEnvelopeErrors

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

func (*CustomHostnameEditResponseEnvelopeErrors) UnmarshalJSON

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

type CustomHostnameEditResponseEnvelopeMessages

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

func (*CustomHostnameEditResponseEnvelopeMessages) UnmarshalJSON

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

type CustomHostnameEditResponseEnvelopeSuccess

type CustomHostnameEditResponseEnvelopeSuccess bool

Whether the API call was successful

const (
	CustomHostnameEditResponseEnvelopeSuccessTrue CustomHostnameEditResponseEnvelopeSuccess = true
)

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 CustomHostnameEditResponseSSLBundleMethod `json:"bundle_method"`
	// The Certificate Authority that will issue the certificate
	CertificateAuthority CustomHostnameEditResponseSSLCertificateAuthority `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 []interface{} `json:"hosts"`
	// The issuer on a custom uploaded certificate.
	Issuer string `json:"issuer"`
	// Domain control validation (DCV) method used for this hostname.
	Method CustomHostnameEditResponseSSLMethod `json:"method"`
	// The serial number on a custom uploaded certificate.
	SerialNumber string `json:"serial_number"`
	// SSL specific settings.
	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 CustomHostnameEditResponseSSLType `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:"-"`
}

SSL properties for the custom hostname.

func (*CustomHostnameEditResponseSSL) UnmarshalJSON

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

type CustomHostnameEditResponseSSLBundleMethod

type CustomHostnameEditResponseSSLBundleMethod 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 (
	CustomHostnameEditResponseSSLBundleMethodUbiquitous CustomHostnameEditResponseSSLBundleMethod = "ubiquitous"
	CustomHostnameEditResponseSSLBundleMethodOptimal    CustomHostnameEditResponseSSLBundleMethod = "optimal"
	CustomHostnameEditResponseSSLBundleMethodForce      CustomHostnameEditResponseSSLBundleMethod = "force"
)

type CustomHostnameEditResponseSSLCertificateAuthority

type CustomHostnameEditResponseSSLCertificateAuthority string

The Certificate Authority that will issue the certificate

const (
	CustomHostnameEditResponseSSLCertificateAuthorityDigicert    CustomHostnameEditResponseSSLCertificateAuthority = "digicert"
	CustomHostnameEditResponseSSLCertificateAuthorityGoogle      CustomHostnameEditResponseSSLCertificateAuthority = "google"
	CustomHostnameEditResponseSSLCertificateAuthorityLetsEncrypt CustomHostnameEditResponseSSLCertificateAuthority = "lets_encrypt"
)

type CustomHostnameEditResponseSSLMethod

type CustomHostnameEditResponseSSLMethod string

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

const (
	CustomHostnameEditResponseSSLMethodHTTP  CustomHostnameEditResponseSSLMethod = "http"
	CustomHostnameEditResponseSSLMethodTXT   CustomHostnameEditResponseSSLMethod = "txt"
	CustomHostnameEditResponseSSLMethodEmail CustomHostnameEditResponseSSLMethod = "email"
)

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:"-"`
}

SSL specific settings.

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

type CustomHostnameEditResponseSSLSettingsHTTP2

type CustomHostnameEditResponseSSLSettingsHTTP2 string

Whether or not HTTP2 is enabled.

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

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

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

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

type CustomHostnameEditResponseSSLType

type CustomHostnameEditResponseSSLType string

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

const (
	CustomHostnameEditResponseSSLTypeDv CustomHostnameEditResponseSSLType = "dv"
)

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 []interface{} `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:"-"`
}

Certificate's required validation record.

func (*CustomHostnameEditResponseSSLValidationRecord) UnmarshalJSON

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

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 properties for the custom hostname.
	SSL  CustomHostnameGetResponseSSL  `json:"ssl,required"`
	JSON customHostnameGetResponseJSON `json:"-"`
}

func (*CustomHostnameGetResponse) UnmarshalJSON

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

type CustomHostnameGetResponseEnvelope

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

func (*CustomHostnameGetResponseEnvelope) UnmarshalJSON

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

type CustomHostnameGetResponseEnvelopeErrors

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

func (*CustomHostnameGetResponseEnvelopeErrors) UnmarshalJSON

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

type CustomHostnameGetResponseEnvelopeMessages

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

func (*CustomHostnameGetResponseEnvelopeMessages) UnmarshalJSON

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

type CustomHostnameGetResponseEnvelopeSuccess

type CustomHostnameGetResponseEnvelopeSuccess bool

Whether the API call was successful

const (
	CustomHostnameGetResponseEnvelopeSuccessTrue CustomHostnameGetResponseEnvelopeSuccess = true
)

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 CustomHostnameGetResponseSSLBundleMethod `json:"bundle_method"`
	// The Certificate Authority that will issue the certificate
	CertificateAuthority CustomHostnameGetResponseSSLCertificateAuthority `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 []interface{} `json:"hosts"`
	// The issuer on a custom uploaded certificate.
	Issuer string `json:"issuer"`
	// Domain control validation (DCV) method used for this hostname.
	Method CustomHostnameGetResponseSSLMethod `json:"method"`
	// The serial number on a custom uploaded certificate.
	SerialNumber string `json:"serial_number"`
	// SSL specific settings.
	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 CustomHostnameGetResponseSSLType `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:"-"`
}

SSL properties for the custom hostname.

func (*CustomHostnameGetResponseSSL) UnmarshalJSON

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

type CustomHostnameGetResponseSSLBundleMethod

type CustomHostnameGetResponseSSLBundleMethod 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 (
	CustomHostnameGetResponseSSLBundleMethodUbiquitous CustomHostnameGetResponseSSLBundleMethod = "ubiquitous"
	CustomHostnameGetResponseSSLBundleMethodOptimal    CustomHostnameGetResponseSSLBundleMethod = "optimal"
	CustomHostnameGetResponseSSLBundleMethodForce      CustomHostnameGetResponseSSLBundleMethod = "force"
)

type CustomHostnameGetResponseSSLCertificateAuthority

type CustomHostnameGetResponseSSLCertificateAuthority string

The Certificate Authority that will issue the certificate

const (
	CustomHostnameGetResponseSSLCertificateAuthorityDigicert    CustomHostnameGetResponseSSLCertificateAuthority = "digicert"
	CustomHostnameGetResponseSSLCertificateAuthorityGoogle      CustomHostnameGetResponseSSLCertificateAuthority = "google"
	CustomHostnameGetResponseSSLCertificateAuthorityLetsEncrypt CustomHostnameGetResponseSSLCertificateAuthority = "lets_encrypt"
)

type CustomHostnameGetResponseSSLMethod

type CustomHostnameGetResponseSSLMethod string

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

const (
	CustomHostnameGetResponseSSLMethodHTTP  CustomHostnameGetResponseSSLMethod = "http"
	CustomHostnameGetResponseSSLMethodTXT   CustomHostnameGetResponseSSLMethod = "txt"
	CustomHostnameGetResponseSSLMethodEmail CustomHostnameGetResponseSSLMethod = "email"
)

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:"-"`
}

SSL specific settings.

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

type CustomHostnameGetResponseSSLSettingsHTTP2

type CustomHostnameGetResponseSSLSettingsHTTP2 string

Whether or not HTTP2 is enabled.

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

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

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

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

type CustomHostnameGetResponseSSLType

type CustomHostnameGetResponseSSLType string

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

const (
	CustomHostnameGetResponseSSLTypeDv CustomHostnameGetResponseSSLType = "dv"
)

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 []interface{} `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:"-"`
}

Certificate's required validation record.

func (*CustomHostnameGetResponseSSLValidationRecord) UnmarshalJSON

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

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

type CustomHostnameListParamsOrder

type CustomHostnameListParamsOrder string

Field to order hostnames by.

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

type CustomHostnameListParamsSSL

type CustomHostnameListParamsSSL float64

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

const (
	CustomHostnameListParamsSSL0 CustomHostnameListParamsSSL = 0
	CustomHostnameListParamsSSL1 CustomHostnameListParamsSSL = 1
)

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 properties for the custom hostname.
	SSL  CustomHostnameListResponseSSL  `json:"ssl,required"`
	JSON customHostnameListResponseJSON `json:"-"`
}

func (*CustomHostnameListResponse) UnmarshalJSON

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

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 CustomHostnameListResponseSSLBundleMethod `json:"bundle_method"`
	// The Certificate Authority that will issue the certificate
	CertificateAuthority CustomHostnameListResponseSSLCertificateAuthority `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 []interface{} `json:"hosts"`
	// The issuer on a custom uploaded certificate.
	Issuer string `json:"issuer"`
	// Domain control validation (DCV) method used for this hostname.
	Method CustomHostnameListResponseSSLMethod `json:"method"`
	// The serial number on a custom uploaded certificate.
	SerialNumber string `json:"serial_number"`
	// SSL specific settings.
	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 CustomHostnameListResponseSSLType `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:"-"`
}

SSL properties for the custom hostname.

func (*CustomHostnameListResponseSSL) UnmarshalJSON

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

type CustomHostnameListResponseSSLBundleMethod

type CustomHostnameListResponseSSLBundleMethod 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 (
	CustomHostnameListResponseSSLBundleMethodUbiquitous CustomHostnameListResponseSSLBundleMethod = "ubiquitous"
	CustomHostnameListResponseSSLBundleMethodOptimal    CustomHostnameListResponseSSLBundleMethod = "optimal"
	CustomHostnameListResponseSSLBundleMethodForce      CustomHostnameListResponseSSLBundleMethod = "force"
)

type CustomHostnameListResponseSSLCertificateAuthority

type CustomHostnameListResponseSSLCertificateAuthority string

The Certificate Authority that will issue the certificate

const (
	CustomHostnameListResponseSSLCertificateAuthorityDigicert    CustomHostnameListResponseSSLCertificateAuthority = "digicert"
	CustomHostnameListResponseSSLCertificateAuthorityGoogle      CustomHostnameListResponseSSLCertificateAuthority = "google"
	CustomHostnameListResponseSSLCertificateAuthorityLetsEncrypt CustomHostnameListResponseSSLCertificateAuthority = "lets_encrypt"
)

type CustomHostnameListResponseSSLMethod

type CustomHostnameListResponseSSLMethod string

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

const (
	CustomHostnameListResponseSSLMethodHTTP  CustomHostnameListResponseSSLMethod = "http"
	CustomHostnameListResponseSSLMethodTXT   CustomHostnameListResponseSSLMethod = "txt"
	CustomHostnameListResponseSSLMethodEmail CustomHostnameListResponseSSLMethod = "email"
)

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:"-"`
}

SSL specific settings.

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

type CustomHostnameListResponseSSLSettingsHTTP2

type CustomHostnameListResponseSSLSettingsHTTP2 string

Whether or not HTTP2 is enabled.

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

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

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

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

type CustomHostnameListResponseSSLType

type CustomHostnameListResponseSSLType string

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

const (
	CustomHostnameListResponseSSLTypeDv CustomHostnameListResponseSSLType = "dv"
)

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 []interface{} `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:"-"`
}

Certificate's required validation record.

func (*CustomHostnameListResponseSSLValidationRecord) UnmarshalJSON

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

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"`
	// These are per-hostname (customer) settings.
	CustomMetadata param.Field[CustomHostnameNewParamsCustomMetadata] `json:"custom_metadata"`
}

func (CustomHostnameNewParams) MarshalJSON

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

type CustomHostnameNewParamsCustomMetadata

type CustomHostnameNewParamsCustomMetadata struct {
	// Unique metadata for this hostname.
	Key param.Field[string] `json:"key"`
}

These are per-hostname (customer) settings.

func (CustomHostnameNewParamsCustomMetadata) MarshalJSON

func (r CustomHostnameNewParamsCustomMetadata) 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[CustomHostnameNewParamsSSLBundleMethod] `json:"bundle_method"`
	// The Certificate Authority that will issue the certificate
	CertificateAuthority param.Field[CustomHostnameNewParamsSSLCertificateAuthority] `json:"certificate_authority"`
	// 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[CustomHostnameNewParamsSSLMethod] `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[CustomHostnameNewParamsSSLType] `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 CustomHostnameNewParamsSSLBundleMethod

type CustomHostnameNewParamsSSLBundleMethod 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 (
	CustomHostnameNewParamsSSLBundleMethodUbiquitous CustomHostnameNewParamsSSLBundleMethod = "ubiquitous"
	CustomHostnameNewParamsSSLBundleMethodOptimal    CustomHostnameNewParamsSSLBundleMethod = "optimal"
	CustomHostnameNewParamsSSLBundleMethodForce      CustomHostnameNewParamsSSLBundleMethod = "force"
)

type CustomHostnameNewParamsSSLCertificateAuthority

type CustomHostnameNewParamsSSLCertificateAuthority string

The Certificate Authority that will issue the certificate

const (
	CustomHostnameNewParamsSSLCertificateAuthorityDigicert    CustomHostnameNewParamsSSLCertificateAuthority = "digicert"
	CustomHostnameNewParamsSSLCertificateAuthorityGoogle      CustomHostnameNewParamsSSLCertificateAuthority = "google"
	CustomHostnameNewParamsSSLCertificateAuthorityLetsEncrypt CustomHostnameNewParamsSSLCertificateAuthority = "lets_encrypt"
)

type CustomHostnameNewParamsSSLMethod

type CustomHostnameNewParamsSSLMethod string

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

const (
	CustomHostnameNewParamsSSLMethodHTTP  CustomHostnameNewParamsSSLMethod = "http"
	CustomHostnameNewParamsSSLMethodTXT   CustomHostnameNewParamsSSLMethod = "txt"
	CustomHostnameNewParamsSSLMethodEmail CustomHostnameNewParamsSSLMethod = "email"
)

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

type CustomHostnameNewParamsSSLSettingsHTTP2

type CustomHostnameNewParamsSSLSettingsHTTP2 string

Whether or not HTTP2 is enabled.

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

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

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

type CustomHostnameNewParamsSSLType

type CustomHostnameNewParamsSSLType string

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

const (
	CustomHostnameNewParamsSSLTypeDv CustomHostnameNewParamsSSLType = "dv"
)

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 properties for the custom hostname.
	SSL  CustomHostnameNewResponseSSL  `json:"ssl,required"`
	JSON customHostnameNewResponseJSON `json:"-"`
}

func (*CustomHostnameNewResponse) UnmarshalJSON

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

type CustomHostnameNewResponseEnvelope

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

func (*CustomHostnameNewResponseEnvelope) UnmarshalJSON

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

type CustomHostnameNewResponseEnvelopeErrors

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

func (*CustomHostnameNewResponseEnvelopeErrors) UnmarshalJSON

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

type CustomHostnameNewResponseEnvelopeMessages

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

func (*CustomHostnameNewResponseEnvelopeMessages) UnmarshalJSON

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

type CustomHostnameNewResponseEnvelopeSuccess

type CustomHostnameNewResponseEnvelopeSuccess bool

Whether the API call was successful

const (
	CustomHostnameNewResponseEnvelopeSuccessTrue CustomHostnameNewResponseEnvelopeSuccess = true
)

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 CustomHostnameNewResponseSSLBundleMethod `json:"bundle_method"`
	// The Certificate Authority that will issue the certificate
	CertificateAuthority CustomHostnameNewResponseSSLCertificateAuthority `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 []interface{} `json:"hosts"`
	// The issuer on a custom uploaded certificate.
	Issuer string `json:"issuer"`
	// Domain control validation (DCV) method used for this hostname.
	Method CustomHostnameNewResponseSSLMethod `json:"method"`
	// The serial number on a custom uploaded certificate.
	SerialNumber string `json:"serial_number"`
	// SSL specific settings.
	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 CustomHostnameNewResponseSSLType `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:"-"`
}

SSL properties for the custom hostname.

func (*CustomHostnameNewResponseSSL) UnmarshalJSON

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

type CustomHostnameNewResponseSSLBundleMethod

type CustomHostnameNewResponseSSLBundleMethod 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 (
	CustomHostnameNewResponseSSLBundleMethodUbiquitous CustomHostnameNewResponseSSLBundleMethod = "ubiquitous"
	CustomHostnameNewResponseSSLBundleMethodOptimal    CustomHostnameNewResponseSSLBundleMethod = "optimal"
	CustomHostnameNewResponseSSLBundleMethodForce      CustomHostnameNewResponseSSLBundleMethod = "force"
)

type CustomHostnameNewResponseSSLCertificateAuthority

type CustomHostnameNewResponseSSLCertificateAuthority string

The Certificate Authority that will issue the certificate

const (
	CustomHostnameNewResponseSSLCertificateAuthorityDigicert    CustomHostnameNewResponseSSLCertificateAuthority = "digicert"
	CustomHostnameNewResponseSSLCertificateAuthorityGoogle      CustomHostnameNewResponseSSLCertificateAuthority = "google"
	CustomHostnameNewResponseSSLCertificateAuthorityLetsEncrypt CustomHostnameNewResponseSSLCertificateAuthority = "lets_encrypt"
)

type CustomHostnameNewResponseSSLMethod

type CustomHostnameNewResponseSSLMethod string

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

const (
	CustomHostnameNewResponseSSLMethodHTTP  CustomHostnameNewResponseSSLMethod = "http"
	CustomHostnameNewResponseSSLMethodTXT   CustomHostnameNewResponseSSLMethod = "txt"
	CustomHostnameNewResponseSSLMethodEmail CustomHostnameNewResponseSSLMethod = "email"
)

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:"-"`
}

SSL specific settings.

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

type CustomHostnameNewResponseSSLSettingsHTTP2

type CustomHostnameNewResponseSSLSettingsHTTP2 string

Whether or not HTTP2 is enabled.

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

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

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

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

type CustomHostnameNewResponseSSLType

type CustomHostnameNewResponseSSLType string

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

const (
	CustomHostnameNewResponseSSLTypeDv CustomHostnameNewResponseSSLType = "dv"
)

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 []interface{} `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:"-"`
}

Certificate's required validation record.

func (*CustomHostnameNewResponseSSLValidationRecord) UnmarshalJSON

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

type CustomHostnameService

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

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

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

func (*CustomHostnameService) Get

Custom Hostname Details

func (*CustomHostnameService) List

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

func (*CustomHostnameService) ListAutoPaging

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

func (*CustomHostnameService) New

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

type Error

type Error = apierror.Error

type FallbackOriginDeleteParams

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

type FallbackOriginDeleteResponse

type FallbackOriginDeleteResponse interface {
	ImplementsCustomHostnamesFallbackOriginDeleteResponse()
}

Union satisfied by custom_hostnames.FallbackOriginDeleteResponseUnknown or shared.UnionString.

type FallbackOriginDeleteResponseEnvelope

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

func (*FallbackOriginDeleteResponseEnvelope) UnmarshalJSON

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

type FallbackOriginDeleteResponseEnvelopeErrors

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

func (*FallbackOriginDeleteResponseEnvelopeErrors) UnmarshalJSON

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

type FallbackOriginDeleteResponseEnvelopeMessages

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

func (*FallbackOriginDeleteResponseEnvelopeMessages) UnmarshalJSON

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

type FallbackOriginDeleteResponseEnvelopeSuccess

type FallbackOriginDeleteResponseEnvelopeSuccess bool

Whether the API call was successful

const (
	FallbackOriginDeleteResponseEnvelopeSuccessTrue FallbackOriginDeleteResponseEnvelopeSuccess = true
)

type FallbackOriginGetParams

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

type FallbackOriginGetResponse

type FallbackOriginGetResponse interface {
	ImplementsCustomHostnamesFallbackOriginGetResponse()
}

Union satisfied by custom_hostnames.FallbackOriginGetResponseUnknown or shared.UnionString.

type FallbackOriginGetResponseEnvelope

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

func (*FallbackOriginGetResponseEnvelope) UnmarshalJSON

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

type FallbackOriginGetResponseEnvelopeErrors

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

func (*FallbackOriginGetResponseEnvelopeErrors) UnmarshalJSON

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

type FallbackOriginGetResponseEnvelopeMessages

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

func (*FallbackOriginGetResponseEnvelopeMessages) UnmarshalJSON

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

type FallbackOriginGetResponseEnvelopeSuccess

type FallbackOriginGetResponseEnvelopeSuccess bool

Whether the API call was successful

const (
	FallbackOriginGetResponseEnvelopeSuccessTrue FallbackOriginGetResponseEnvelopeSuccess = true
)

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

Delete Fallback Origin for Custom Hostnames

func (*FallbackOriginService) Get

Get Fallback Origin for Custom Hostnames

func (*FallbackOriginService) Update

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

Union satisfied by custom_hostnames.FallbackOriginUpdateResponseUnknown or shared.UnionString.

type FallbackOriginUpdateResponseEnvelope

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

func (*FallbackOriginUpdateResponseEnvelope) UnmarshalJSON

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

type FallbackOriginUpdateResponseEnvelopeErrors

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

func (*FallbackOriginUpdateResponseEnvelopeErrors) UnmarshalJSON

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

type FallbackOriginUpdateResponseEnvelopeMessages

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

func (*FallbackOriginUpdateResponseEnvelopeMessages) UnmarshalJSON

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

type FallbackOriginUpdateResponseEnvelopeSuccess

type FallbackOriginUpdateResponseEnvelopeSuccess bool

Whether the API call was successful

const (
	FallbackOriginUpdateResponseEnvelopeSuccessTrue FallbackOriginUpdateResponseEnvelopeSuccess = true
)

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL