Custom Hostnames

List Custom Hostnames

client.customHostnames.list(, ?): V4PagePaginationArray<CustomHostnameListResponse { id, hostname, created_at, 8 more } >

GET/zones/{zone_id}/custom_hostnames

Custom Hostname Details

client.customHostnames.get(, , ?): CustomHostnameGetResponse { id, hostname, created_at, 8 more }

GET/zones/{zone_id}/custom_hostnames/{custom_hostname_id}

Create Custom Hostname

client.customHostnames.create(, ?): CustomHostnameCreateResponse { id, hostname, created_at, 8 more }

POST/zones/{zone_id}/custom_hostnames

Edit Custom Hostname

client.customHostnames.edit(, , ?): CustomHostnameEditResponse { id, hostname, created_at, 8 more }

PATCH/zones/{zone_id}/custom_hostnames/{custom_hostname_id}

Delete Custom Hostname (and any issued SSL certificates)

client.customHostnames.delete(, , ?): CustomHostnameDeleteResponse { id }

DELETE/zones/{zone_id}/custom_hostnames/{custom_hostname_id}

ModelsExpand Collapse

BundleMethod = "ubiquitous" | "optimal" | "force"

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.

One of the following:

"ubiquitous"

"optimal"

"force"

CustomHostname { id, hostname, created_at, 8 more }

id: string

Identifier.

maxLength32

hostname: string

The custom hostname that will point to your hostname via CNAME.

maxLength255

created_at?: string

This is the time the hostname was created.

formatdate-time

custom_metadata?: Record<string, string>

Unique key/value metadata for this hostname. These are per-hostname (customer) settings.

custom_origin_server?: string

a valid hostname that’s been added to your DNS zone as an A, AAAA, or CNAME record.

custom_origin_sni?: string

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.

ownership_verification?: OwnershipVerification { name, type, value }

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

name?: string

DNS Name for record.

type?: "txt"

DNS Record type.

value?: string

Content for the record.

ownership_verification_http?: OwnershipVerificationHTTP { http_body, http_url }

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

http_body?: string

Token to be served.

http_url?: string

The HTTP URL that will be checked during custom hostname verification and where the customer should host the token.

ssl?: SSL { id, bundle_method, certificate_authority, 17 more }

id?: string

Custom hostname SSL identifier tag.

maxLength36

minLength36

bundle_method?: BundleMethod

certificate_authority?: CertificateCA

The Certificate Authority that will issue the certificate

custom_certificate?: string

If a custom uploaded certificate is used.

custom_csr_id?: string

The identifier for the Custom CSR that was used.

custom_key?: string

The key for a custom uploaded certificate.

dcv_delegation_records?: Array<DCVDelegationRecord>

DCV Delegation records for domain validation.

cname?: string

The CNAME record hostname for DCV delegation.

cname_target?: string

The CNAME record target value for DCV delegation.

emails?: Array<string>

The set of email addresses that the certificate authority (CA) will use to complete domain validation.

http_body?: string

The content that the certificate authority (CA) will expect to find at the http_url during the domain validation.

http_url?: string

The url that will be checked during domain validation.

status?: string

Status of the validation record.

txt_name?: string

The hostname that the certificate authority (CA) will check for a TXT record during domain validation .

txt_value?: string

The TXT record that the certificate authority (CA) will check during domain validation.

expires_on?: string

The time the custom certificate expires on.

formatdate-time

hosts?: Array<string>

A list of Hostnames on a custom uploaded certificate.

issuer?: string

The issuer on a custom uploaded certificate.

method?: DCVMethod

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

serial_number?: string

The serial number on a custom uploaded certificate.

settings?: Settings { ciphers, early_hints, http2, 2 more }

ciphers?: Array<string>

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

early_hints?: "on" | "off"

Whether or not Early Hints is enabled.

One of the following:

"on"

"off"

http2?: "on" | "off"

Whether or not HTTP2 is enabled.

One of the following:

"on"

"off"

min_tls_version?: "1.0" | "1.1" | "1.2" | "1.3"

The minimum TLS version supported.

One of the following:

"1.0"

"1.1"

"1.2"

"1.3"

tls_1_3?: "on" | "off"

Whether or not TLS 1.3 is enabled.

One of the following:

"on"

"off"

signature?: string

The signature on a custom uploaded certificate.

status?: "initializing" | "pending_validation" | "deleted" | 18 more

Status of the hostname's SSL certificates.

One of the following:

"initializing"

"pending_validation"

"deleted"

"pending_issuance"

"pending_deployment"

"pending_deletion"

"pending_expiration"

"expired"

"active"

"initializing_timed_out"

"validation_timed_out"

"issuance_timed_out"

"deployment_timed_out"

"deletion_timed_out"

"pending_cleanup"

"staging_deployment"

"staging_active"

"deactivating"

"inactive"

"backup_issued"

"holding_deployment"

type?: DomainValidationType { }

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

uploaded_on?: string

The time the custom certificate was uploaded.

formatdate-time

validation_errors?: Array<ValidationError>

Domain validation errors that have been received by the certificate authority (CA).

message?: string

A domain validation error.

validation_records?: Array<ValidationRecord>

cname?: string

The CNAME record hostname for DCV delegation.

cname_target?: string

The CNAME record target value for DCV delegation.

emails?: Array<string>

The set of email addresses that the certificate authority (CA) will use to complete domain validation.

http_body?: string

The content that the certificate authority (CA) will expect to find at the http_url during the domain validation.

http_url?: string

The url that will be checked during domain validation.

status?: string

Status of the validation record.

txt_name?: string

The hostname that the certificate authority (CA) will check for a TXT record during domain validation .

txt_value?: string

The TXT record that the certificate authority (CA) will check during domain validation.

wildcard?: boolean

Indicates whether the certificate covers a wildcard.

status?: "active" | "pending" | "active_redeploying" | 13 more

Status of the hostname's activation.

One of the following:

"active"

"pending"

"active_redeploying"

"moved"

"pending_deletion"

"deleted"

"pending_blocked"

"pending_migration"

"pending_provisioned"

"test_pending"

"test_active"

"test_active_apex"

"test_blocked"

"test_failed"

"provisioned"

"blocked"

verification_errors?: Array<string>

These are errors that were encountered while trying to activate a hostname.

DCVMethod = "http" | "txt" | "email"

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

One of the following:

"http"

"txt"

"email"

DomainValidationType = "dv"

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

CustomHostnameListResponse { id, hostname, created_at, 8 more }

id: string

Identifier.

maxLength32

hostname: string

The custom hostname that will point to your hostname via CNAME.

maxLength255

created_at?: string

This is the time the hostname was created.

formatdate-time

custom_metadata?: Record<string, string>

Unique key/value metadata for this hostname. These are per-hostname (customer) settings.

custom_origin_server?: string

a valid hostname that’s been added to your DNS zone as an A, AAAA, or CNAME record.

custom_origin_sni?: string

ownership_verification?: OwnershipVerification { name, type, value }

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

name?: string

DNS Name for record.

type?: "txt"

DNS Record type.

value?: string

Content for the record.

ownership_verification_http?: OwnershipVerificationHTTP { http_body, http_url }

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

http_body?: string

Token to be served.

http_url?: string

The HTTP URL that will be checked during custom hostname verification and where the customer should host the token.

ssl?: SSL { id, bundle_method, certificate_authority, 17 more }

id?: string

Custom hostname SSL identifier tag.

maxLength36

minLength36

bundle_method?: BundleMethod

certificate_authority?: CertificateCA

The Certificate Authority that will issue the certificate

custom_certificate?: string

If a custom uploaded certificate is used.

custom_csr_id?: string

The identifier for the Custom CSR that was used.

custom_key?: string

The key for a custom uploaded certificate.

dcv_delegation_records?: Array<DCVDelegationRecord>

DCV Delegation records for domain validation.

cname?: string

The CNAME record hostname for DCV delegation.

cname_target?: string

The CNAME record target value for DCV delegation.

emails?: Array<string>

The set of email addresses that the certificate authority (CA) will use to complete domain validation.

http_body?: string

The content that the certificate authority (CA) will expect to find at the http_url during the domain validation.

http_url?: string

The url that will be checked during domain validation.

status?: string

Status of the validation record.

txt_name?: string

The hostname that the certificate authority (CA) will check for a TXT record during domain validation .

txt_value?: string

The TXT record that the certificate authority (CA) will check during domain validation.

expires_on?: string

The time the custom certificate expires on.

formatdate-time

hosts?: Array<string>

A list of Hostnames on a custom uploaded certificate.

issuer?: string

The issuer on a custom uploaded certificate.

method?: DCVMethod

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

serial_number?: string

The serial number on a custom uploaded certificate.

settings?: Settings { ciphers, early_hints, http2, 2 more }

ciphers?: Array<string>

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

early_hints?: "on" | "off"

Whether or not Early Hints is enabled.

One of the following:

"on"

"off"

http2?: "on" | "off"

Whether or not HTTP2 is enabled.

One of the following:

"on"

"off"

min_tls_version?: "1.0" | "1.1" | "1.2" | "1.3"

The minimum TLS version supported.

One of the following:

"1.0"

"1.1"

"1.2"

"1.3"

tls_1_3?: "on" | "off"

Whether or not TLS 1.3 is enabled.

One of the following:

"on"

"off"

signature?: string

The signature on a custom uploaded certificate.

status?: "initializing" | "pending_validation" | "deleted" | 18 more

Status of the hostname's SSL certificates.

One of the following:

"initializing"

"pending_validation"

"deleted"

"pending_issuance"

"pending_deployment"

"pending_deletion"

"pending_expiration"

"expired"

"active"

"initializing_timed_out"

"validation_timed_out"

"issuance_timed_out"

"deployment_timed_out"

"deletion_timed_out"

"pending_cleanup"

"staging_deployment"

"staging_active"

"deactivating"

"inactive"

"backup_issued"

"holding_deployment"

type?: DomainValidationType { }

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

uploaded_on?: string

The time the custom certificate was uploaded.

formatdate-time

validation_errors?: Array<ValidationError>

Domain validation errors that have been received by the certificate authority (CA).

message?: string

A domain validation error.

validation_records?: Array<ValidationRecord>

cname?: string

The CNAME record hostname for DCV delegation.

cname_target?: string

The CNAME record target value for DCV delegation.

emails?: Array<string>

The set of email addresses that the certificate authority (CA) will use to complete domain validation.

http_body?: string

The content that the certificate authority (CA) will expect to find at the http_url during the domain validation.

http_url?: string

The url that will be checked during domain validation.

status?: string

Status of the validation record.

txt_name?: string

The hostname that the certificate authority (CA) will check for a TXT record during domain validation .

txt_value?: string

The TXT record that the certificate authority (CA) will check during domain validation.

wildcard?: boolean

Indicates whether the certificate covers a wildcard.

status?: "active" | "pending" | "active_redeploying" | 13 more

Status of the hostname's activation.

One of the following:

"active"

"pending"

"active_redeploying"

"moved"

"pending_deletion"

"deleted"

"pending_blocked"

"pending_migration"

"pending_provisioned"

"test_pending"

"test_active"

"test_active_apex"

"test_blocked"

"test_failed"

"provisioned"

"blocked"

verification_errors?: Array<string>

These are errors that were encountered while trying to activate a hostname.

CustomHostnameGetResponse { id, hostname, created_at, 8 more }

id: string

Identifier.

maxLength32

hostname: string

The custom hostname that will point to your hostname via CNAME.

maxLength255

created_at?: string

This is the time the hostname was created.

formatdate-time

custom_metadata?: Record<string, string>

Unique key/value metadata for this hostname. These are per-hostname (customer) settings.

custom_origin_server?: string

a valid hostname that’s been added to your DNS zone as an A, AAAA, or CNAME record.

custom_origin_sni?: string

ownership_verification?: OwnershipVerification { name, type, value }

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

name?: string

DNS Name for record.

type?: "txt"

DNS Record type.

value?: string

Content for the record.

ownership_verification_http?: OwnershipVerificationHTTP { http_body, http_url }

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

http_body?: string

Token to be served.

http_url?: string

The HTTP URL that will be checked during custom hostname verification and where the customer should host the token.

ssl?: SSL { id, bundle_method, certificate_authority, 17 more }

id?: string

Custom hostname SSL identifier tag.

maxLength36

minLength36

bundle_method?: BundleMethod

certificate_authority?: CertificateCA

The Certificate Authority that will issue the certificate

custom_certificate?: string

If a custom uploaded certificate is used.

custom_csr_id?: string

The identifier for the Custom CSR that was used.

custom_key?: string

The key for a custom uploaded certificate.

dcv_delegation_records?: Array<DCVDelegationRecord>

DCV Delegation records for domain validation.

cname?: string

The CNAME record hostname for DCV delegation.

cname_target?: string

The CNAME record target value for DCV delegation.

emails?: Array<string>

The set of email addresses that the certificate authority (CA) will use to complete domain validation.

http_body?: string

The content that the certificate authority (CA) will expect to find at the http_url during the domain validation.

http_url?: string

The url that will be checked during domain validation.

status?: string

Status of the validation record.

txt_name?: string

The hostname that the certificate authority (CA) will check for a TXT record during domain validation .

txt_value?: string

The TXT record that the certificate authority (CA) will check during domain validation.

expires_on?: string

The time the custom certificate expires on.

formatdate-time

hosts?: Array<string>

A list of Hostnames on a custom uploaded certificate.

issuer?: string

The issuer on a custom uploaded certificate.

method?: DCVMethod

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

serial_number?: string

The serial number on a custom uploaded certificate.

settings?: Settings { ciphers, early_hints, http2, 2 more }

ciphers?: Array<string>

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

early_hints?: "on" | "off"

Whether or not Early Hints is enabled.

One of the following:

"on"

"off"

http2?: "on" | "off"

Whether or not HTTP2 is enabled.

One of the following:

"on"

"off"

min_tls_version?: "1.0" | "1.1" | "1.2" | "1.3"

The minimum TLS version supported.

One of the following:

"1.0"

"1.1"

"1.2"

"1.3"

tls_1_3?: "on" | "off"

Whether or not TLS 1.3 is enabled.

One of the following:

"on"

"off"

signature?: string

The signature on a custom uploaded certificate.

status?: "initializing" | "pending_validation" | "deleted" | 18 more

Status of the hostname's SSL certificates.

One of the following:

"initializing"

"pending_validation"

"deleted"

"pending_issuance"

"pending_deployment"

"pending_deletion"

"pending_expiration"

"expired"

"active"

"initializing_timed_out"

"validation_timed_out"

"issuance_timed_out"

"deployment_timed_out"

"deletion_timed_out"

"pending_cleanup"

"staging_deployment"

"staging_active"

"deactivating"

"inactive"

"backup_issued"

"holding_deployment"

type?: DomainValidationType { }

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

uploaded_on?: string

The time the custom certificate was uploaded.

formatdate-time

validation_errors?: Array<ValidationError>

Domain validation errors that have been received by the certificate authority (CA).

message?: string

A domain validation error.

validation_records?: Array<ValidationRecord>

cname?: string

The CNAME record hostname for DCV delegation.

cname_target?: string

The CNAME record target value for DCV delegation.

emails?: Array<string>

The set of email addresses that the certificate authority (CA) will use to complete domain validation.

http_body?: string

The content that the certificate authority (CA) will expect to find at the http_url during the domain validation.

http_url?: string

The url that will be checked during domain validation.

status?: string

Status of the validation record.

txt_name?: string

The hostname that the certificate authority (CA) will check for a TXT record during domain validation .

txt_value?: string

The TXT record that the certificate authority (CA) will check during domain validation.

wildcard?: boolean

Indicates whether the certificate covers a wildcard.

status?: "active" | "pending" | "active_redeploying" | 13 more

Status of the hostname's activation.

One of the following:

"active"

"pending"

"active_redeploying"

"moved"

"pending_deletion"

"deleted"

"pending_blocked"

"pending_migration"

"pending_provisioned"

"test_pending"

"test_active"

"test_active_apex"

"test_blocked"

"test_failed"

"provisioned"

"blocked"

verification_errors?: Array<string>

These are errors that were encountered while trying to activate a hostname.

CustomHostnameCreateResponse { id, hostname, created_at, 8 more }

id: string

Identifier.

maxLength32

hostname: string

The custom hostname that will point to your hostname via CNAME.

maxLength255

created_at?: string

This is the time the hostname was created.

formatdate-time

custom_metadata?: Record<string, string>

Unique key/value metadata for this hostname. These are per-hostname (customer) settings.

custom_origin_server?: string

a valid hostname that’s been added to your DNS zone as an A, AAAA, or CNAME record.

custom_origin_sni?: string

ownership_verification?: OwnershipVerification { name, type, value }

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

name?: string

DNS Name for record.

type?: "txt"

DNS Record type.

value?: string

Content for the record.

ownership_verification_http?: OwnershipVerificationHTTP { http_body, http_url }

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

http_body?: string

Token to be served.

http_url?: string

The HTTP URL that will be checked during custom hostname verification and where the customer should host the token.

ssl?: SSL { id, bundle_method, certificate_authority, 17 more }

id?: string

Custom hostname SSL identifier tag.

maxLength36

minLength36

bundle_method?: BundleMethod

certificate_authority?: CertificateCA

The Certificate Authority that will issue the certificate

custom_certificate?: string

If a custom uploaded certificate is used.

custom_csr_id?: string

The identifier for the Custom CSR that was used.

custom_key?: string

The key for a custom uploaded certificate.

dcv_delegation_records?: Array<DCVDelegationRecord>

DCV Delegation records for domain validation.

cname?: string

The CNAME record hostname for DCV delegation.

cname_target?: string

The CNAME record target value for DCV delegation.

emails?: Array<string>

The set of email addresses that the certificate authority (CA) will use to complete domain validation.

http_body?: string

The content that the certificate authority (CA) will expect to find at the http_url during the domain validation.

http_url?: string

The url that will be checked during domain validation.

status?: string

Status of the validation record.

txt_name?: string

The hostname that the certificate authority (CA) will check for a TXT record during domain validation .

txt_value?: string

The TXT record that the certificate authority (CA) will check during domain validation.

expires_on?: string

The time the custom certificate expires on.

formatdate-time

hosts?: Array<string>

A list of Hostnames on a custom uploaded certificate.

issuer?: string

The issuer on a custom uploaded certificate.

method?: DCVMethod

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

serial_number?: string

The serial number on a custom uploaded certificate.

settings?: Settings { ciphers, early_hints, http2, 2 more }

ciphers?: Array<string>

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

early_hints?: "on" | "off"

Whether or not Early Hints is enabled.

One of the following:

"on"

"off"

http2?: "on" | "off"

Whether or not HTTP2 is enabled.

One of the following:

"on"

"off"

min_tls_version?: "1.0" | "1.1" | "1.2" | "1.3"

The minimum TLS version supported.

One of the following:

"1.0"

"1.1"

"1.2"

"1.3"

tls_1_3?: "on" | "off"

Whether or not TLS 1.3 is enabled.

One of the following:

"on"

"off"

signature?: string

The signature on a custom uploaded certificate.

status?: "initializing" | "pending_validation" | "deleted" | 18 more

Status of the hostname's SSL certificates.

One of the following:

"initializing"

"pending_validation"

"deleted"

"pending_issuance"

"pending_deployment"

"pending_deletion"

"pending_expiration"

"expired"

"active"

"initializing_timed_out"

"validation_timed_out"

"issuance_timed_out"

"deployment_timed_out"

"deletion_timed_out"

"pending_cleanup"

"staging_deployment"

"staging_active"

"deactivating"

"inactive"

"backup_issued"

"holding_deployment"

type?: DomainValidationType { }

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

uploaded_on?: string

The time the custom certificate was uploaded.

formatdate-time

validation_errors?: Array<ValidationError>

Domain validation errors that have been received by the certificate authority (CA).

message?: string

A domain validation error.

validation_records?: Array<ValidationRecord>

cname?: string

The CNAME record hostname for DCV delegation.

cname_target?: string

The CNAME record target value for DCV delegation.

emails?: Array<string>

The set of email addresses that the certificate authority (CA) will use to complete domain validation.

http_body?: string

The content that the certificate authority (CA) will expect to find at the http_url during the domain validation.

http_url?: string

The url that will be checked during domain validation.

status?: string

Status of the validation record.

txt_name?: string

The hostname that the certificate authority (CA) will check for a TXT record during domain validation .

txt_value?: string

The TXT record that the certificate authority (CA) will check during domain validation.

wildcard?: boolean

Indicates whether the certificate covers a wildcard.

status?: "active" | "pending" | "active_redeploying" | 13 more

Status of the hostname's activation.

One of the following:

"active"

"pending"

"active_redeploying"

"moved"

"pending_deletion"

"deleted"

"pending_blocked"

"pending_migration"

"pending_provisioned"

"test_pending"

"test_active"

"test_active_apex"

"test_blocked"

"test_failed"

"provisioned"

"blocked"

verification_errors?: Array<string>

These are errors that were encountered while trying to activate a hostname.

CustomHostnameEditResponse { id, hostname, created_at, 8 more }

id: string

Identifier.

maxLength32

hostname: string

The custom hostname that will point to your hostname via CNAME.

maxLength255

created_at?: string

This is the time the hostname was created.

formatdate-time

custom_metadata?: Record<string, string>

Unique key/value metadata for this hostname. These are per-hostname (customer) settings.

custom_origin_server?: string

a valid hostname that’s been added to your DNS zone as an A, AAAA, or CNAME record.

custom_origin_sni?: string

ownership_verification?: OwnershipVerification { name, type, value }

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

name?: string

DNS Name for record.

type?: "txt"

DNS Record type.

value?: string

Content for the record.

ownership_verification_http?: OwnershipVerificationHTTP { http_body, http_url }

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

http_body?: string

Token to be served.

http_url?: string

The HTTP URL that will be checked during custom hostname verification and where the customer should host the token.

ssl?: SSL { id, bundle_method, certificate_authority, 17 more }

id?: string

Custom hostname SSL identifier tag.

maxLength36

minLength36

bundle_method?: BundleMethod

certificate_authority?: CertificateCA

The Certificate Authority that will issue the certificate

custom_certificate?: string

If a custom uploaded certificate is used.

custom_csr_id?: string

The identifier for the Custom CSR that was used.

custom_key?: string

The key for a custom uploaded certificate.

dcv_delegation_records?: Array<DCVDelegationRecord>

DCV Delegation records for domain validation.

cname?: string

The CNAME record hostname for DCV delegation.

cname_target?: string

The CNAME record target value for DCV delegation.

emails?: Array<string>

The set of email addresses that the certificate authority (CA) will use to complete domain validation.

http_body?: string

The content that the certificate authority (CA) will expect to find at the http_url during the domain validation.

http_url?: string

The url that will be checked during domain validation.

status?: string

Status of the validation record.

txt_name?: string

The hostname that the certificate authority (CA) will check for a TXT record during domain validation .

txt_value?: string

The TXT record that the certificate authority (CA) will check during domain validation.

expires_on?: string

The time the custom certificate expires on.

formatdate-time

hosts?: Array<string>

A list of Hostnames on a custom uploaded certificate.

issuer?: string

The issuer on a custom uploaded certificate.

method?: DCVMethod

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

serial_number?: string

The serial number on a custom uploaded certificate.

settings?: Settings { ciphers, early_hints, http2, 2 more }

ciphers?: Array<string>

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

early_hints?: "on" | "off"

Whether or not Early Hints is enabled.

One of the following:

"on"

"off"

http2?: "on" | "off"

Whether or not HTTP2 is enabled.

One of the following:

"on"

"off"

min_tls_version?: "1.0" | "1.1" | "1.2" | "1.3"

The minimum TLS version supported.

One of the following:

"1.0"

"1.1"

"1.2"

"1.3"

tls_1_3?: "on" | "off"

Whether or not TLS 1.3 is enabled.

One of the following:

"on"

"off"

signature?: string

The signature on a custom uploaded certificate.

status?: "initializing" | "pending_validation" | "deleted" | 18 more

Status of the hostname's SSL certificates.

One of the following:

"initializing"

"pending_validation"

"deleted"

"pending_issuance"

"pending_deployment"

"pending_deletion"

"pending_expiration"

"expired"

"active"

"initializing_timed_out"

"validation_timed_out"

"issuance_timed_out"

"deployment_timed_out"

"deletion_timed_out"

"pending_cleanup"

"staging_deployment"

"staging_active"

"deactivating"

"inactive"

"backup_issued"

"holding_deployment"

type?: DomainValidationType { }

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

uploaded_on?: string

The time the custom certificate was uploaded.

formatdate-time

validation_errors?: Array<ValidationError>

Domain validation errors that have been received by the certificate authority (CA).

message?: string

A domain validation error.

validation_records?: Array<ValidationRecord>

cname?: string

The CNAME record hostname for DCV delegation.

cname_target?: string

The CNAME record target value for DCV delegation.

emails?: Array<string>

The set of email addresses that the certificate authority (CA) will use to complete domain validation.

http_body?: string

The content that the certificate authority (CA) will expect to find at the http_url during the domain validation.

http_url?: string

The url that will be checked during domain validation.

status?: string

Status of the validation record.

txt_name?: string

The hostname that the certificate authority (CA) will check for a TXT record during domain validation .

txt_value?: string

The TXT record that the certificate authority (CA) will check during domain validation.

wildcard?: boolean

Indicates whether the certificate covers a wildcard.

status?: "active" | "pending" | "active_redeploying" | 13 more

Status of the hostname's activation.

One of the following:

"active"

"pending"

"active_redeploying"

"moved"

"pending_deletion"

"deleted"

"pending_blocked"

"pending_migration"

"pending_provisioned"

"test_pending"

"test_active"

"test_active_apex"

"test_blocked"

"test_failed"

"provisioned"

"blocked"

verification_errors?: Array<string>

These are errors that were encountered while trying to activate a hostname.

CustomHostnameDeleteResponse { id }

id?: string

Identifier.

maxLength32

Custom HostnamesFallback Origin

Get Fallback Origin for Custom Hostnames

client.customHostnames.fallbackOrigin.get(, ?): FallbackOriginGetResponse { created_at, errors, origin, 2 more }

GET/zones/{zone_id}/custom_hostnames/fallback_origin

Update Fallback Origin for Custom Hostnames

client.customHostnames.fallbackOrigin.update(, ?): FallbackOriginUpdateResponse { created_at, errors, origin, 2 more }

PUT/zones/{zone_id}/custom_hostnames/fallback_origin

Delete Fallback Origin for Custom Hostnames

client.customHostnames.fallbackOrigin.delete(, ?): FallbackOriginDeleteResponse { created_at, errors, origin, 2 more }

DELETE/zones/{zone_id}/custom_hostnames/fallback_origin

ModelsExpand Collapse

FallbackOriginGetResponse { created_at, errors, origin, 2 more }

created_at?: string

This is the time the fallback origin was created.

formatdate-time

errors?: Array<string>

These are errors that were encountered while trying to activate a fallback origin.

origin?: string

Your origin hostname that requests to your custom hostnames will be sent to.

maxLength255

status?: "initializing" | "pending_deployment" | "pending_deletion" | 3 more

Status of the fallback origin's activation.

One of the following:

"initializing"

"pending_deployment"

"pending_deletion"

"active"

"deployment_timed_out"

"deletion_timed_out"

updated_at?: string

This is the time the fallback origin was updated.

formatdate-time

FallbackOriginUpdateResponse { created_at, errors, origin, 2 more }

created_at?: string

This is the time the fallback origin was created.

formatdate-time

errors?: Array<string>

These are errors that were encountered while trying to activate a fallback origin.

origin?: string

Your origin hostname that requests to your custom hostnames will be sent to.

maxLength255

status?: "initializing" | "pending_deployment" | "pending_deletion" | 3 more

Status of the fallback origin's activation.

One of the following:

"initializing"

"pending_deployment"

"pending_deletion"

"active"

"deployment_timed_out"

"deletion_timed_out"

updated_at?: string

This is the time the fallback origin was updated.

formatdate-time

FallbackOriginDeleteResponse { created_at, errors, origin, 2 more }

created_at?: string

This is the time the fallback origin was created.

formatdate-time

errors?: Array<string>

These are errors that were encountered while trying to activate a fallback origin.

origin?: string

Your origin hostname that requests to your custom hostnames will be sent to.

maxLength255

status?: "initializing" | "pending_deployment" | "pending_deletion" | 3 more

Status of the fallback origin's activation.

One of the following:

"initializing"

"pending_deployment"

"pending_deletion"

"active"

"deployment_timed_out"

"deletion_timed_out"

updated_at?: string

This is the time the fallback origin was updated.

formatdate-time

Custom HostnamesCertificate Pack

Custom HostnamesCertificate PackCertificates

Replace Custom Certificate and Custom Key In Custom Hostname

client.customHostnames.certificatePack.certificates.update(, , , , ?): CertificateUpdateResponse { id, hostname, created_at, 8 more }

PUT/zones/{zone_id}/custom_hostnames/{custom_hostname_id}/certificate_pack/{certificate_pack_id}/certificates/{certificate_id}

Delete Single Certificate And Key For Custom Hostname

client.customHostnames.certificatePack.certificates.delete(, , , , ?): CertificateDeleteResponse { id }

DELETE/zones/{zone_id}/custom_hostnames/{custom_hostname_id}/certificate_pack/{certificate_pack_id}/certificates/{certificate_id}

ModelsExpand Collapse

CertificateUpdateResponse { id, hostname, created_at, 8 more }

id: string

Identifier.

maxLength32

hostname: string

The custom hostname that will point to your hostname via CNAME.

maxLength255

created_at?: string

This is the time the hostname was created.

formatdate-time

custom_metadata?: Record<string, string>

Unique key/value metadata for this hostname. These are per-hostname (customer) settings.

custom_origin_server?: string

a valid hostname that’s been added to your DNS zone as an A, AAAA, or CNAME record.

custom_origin_sni?: string

ownership_verification?: OwnershipVerification { name, type, value }

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

name?: string

DNS Name for record.

type?: "txt"

DNS Record type.

value?: string

Content for the record.

ownership_verification_http?: OwnershipVerificationHTTP { http_body, http_url }

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

http_body?: string

Token to be served.

http_url?: string

The HTTP URL that will be checked during custom hostname verification and where the customer should host the token.

ssl?: SSL { id, bundle_method, certificate_authority, 17 more }

id?: string

Custom hostname SSL identifier tag.

maxLength36

minLength36

bundle_method?: BundleMethod

certificate_authority?: CertificateCA

The Certificate Authority that will issue the certificate

custom_certificate?: string

If a custom uploaded certificate is used.

custom_csr_id?: string

The identifier for the Custom CSR that was used.

custom_key?: string

The key for a custom uploaded certificate.

dcv_delegation_records?: Array<DCVDelegationRecord>

DCV Delegation records for domain validation.

cname?: string

The CNAME record hostname for DCV delegation.

cname_target?: string

The CNAME record target value for DCV delegation.

emails?: Array<string>

The set of email addresses that the certificate authority (CA) will use to complete domain validation.

http_body?: string

The content that the certificate authority (CA) will expect to find at the http_url during the domain validation.

http_url?: string

The url that will be checked during domain validation.

status?: string

Status of the validation record.

txt_name?: string

The hostname that the certificate authority (CA) will check for a TXT record during domain validation .

txt_value?: string

The TXT record that the certificate authority (CA) will check during domain validation.

expires_on?: string

The time the custom certificate expires on.

formatdate-time

hosts?: Array<string>

A list of Hostnames on a custom uploaded certificate.

issuer?: string

The issuer on a custom uploaded certificate.

method?: DCVMethod

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

serial_number?: string

The serial number on a custom uploaded certificate.

settings?: Settings { ciphers, early_hints, http2, 2 more }

ciphers?: Array<string>

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

early_hints?: "on" | "off"

Whether or not Early Hints is enabled.

One of the following:

"on"

"off"

http2?: "on" | "off"

Whether or not HTTP2 is enabled.

One of the following:

"on"

"off"

min_tls_version?: "1.0" | "1.1" | "1.2" | "1.3"

The minimum TLS version supported.

One of the following:

"1.0"

"1.1"

"1.2"

"1.3"

tls_1_3?: "on" | "off"

Whether or not TLS 1.3 is enabled.

One of the following:

"on"

"off"

signature?: string

The signature on a custom uploaded certificate.

status?: "initializing" | "pending_validation" | "deleted" | 18 more

Status of the hostname's SSL certificates.

One of the following:

"initializing"

"pending_validation"

"deleted"

"pending_issuance"

"pending_deployment"

"pending_deletion"

"pending_expiration"

"expired"

"active"

"initializing_timed_out"

"validation_timed_out"

"issuance_timed_out"

"deployment_timed_out"

"deletion_timed_out"

"pending_cleanup"

"staging_deployment"

"staging_active"

"deactivating"

"inactive"

"backup_issued"

"holding_deployment"

type?: DomainValidationType { }

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

uploaded_on?: string

The time the custom certificate was uploaded.

formatdate-time

validation_errors?: Array<ValidationError>

Domain validation errors that have been received by the certificate authority (CA).

message?: string

A domain validation error.

validation_records?: Array<ValidationRecord>

cname?: string

The CNAME record hostname for DCV delegation.

cname_target?: string

The CNAME record target value for DCV delegation.

emails?: Array<string>

The set of email addresses that the certificate authority (CA) will use to complete domain validation.

http_body?: string

The content that the certificate authority (CA) will expect to find at the http_url during the domain validation.

http_url?: string

The url that will be checked during domain validation.

status?: string

Status of the validation record.

txt_name?: string

The hostname that the certificate authority (CA) will check for a TXT record during domain validation .

txt_value?: string

The TXT record that the certificate authority (CA) will check during domain validation.

wildcard?: boolean

Indicates whether the certificate covers a wildcard.

status?: "active" | "pending" | "active_redeploying" | 13 more

Status of the hostname's activation.

One of the following:

"active"

"pending"

"active_redeploying"

"moved"

"pending_deletion"

"deleted"

"pending_blocked"

"pending_migration"

"pending_provisioned"

"test_pending"

"test_active"

"test_active_apex"

"test_blocked"

"test_failed"

"provisioned"

"blocked"

verification_errors?: Array<string>

These are errors that were encountered while trying to activate a hostname.

CertificateDeleteResponse { id }

id?: string

Identifier.

maxLength32