Skip to content
Cloudflare API
Start here
API Reference

Custom Hostnames

List Custom Hostnames
custom_hostnames.list(CustomHostnameListParams**kwargs) -> SyncV4PagePaginationArray[CustomHostnameListResponse]
GET/zones/{zone_id}/custom_hostnames
Custom Hostname Details
custom_hostnames.get(strcustom_hostname_id, CustomHostnameGetParams**kwargs) -> CustomHostnameGetResponse
GET/zones/{zone_id}/custom_hostnames/{custom_hostname_id}
Create Custom Hostname
custom_hostnames.create(CustomHostnameCreateParams**kwargs) -> CustomHostnameCreateResponse
POST/zones/{zone_id}/custom_hostnames
Edit Custom Hostname
custom_hostnames.edit(strcustom_hostname_id, CustomHostnameEditParams**kwargs) -> CustomHostnameEditResponse
PATCH/zones/{zone_id}/custom_hostnames/{custom_hostname_id}
Delete Custom Hostname (and any issued SSL certificates)
custom_hostnames.delete(strcustom_hostname_id, CustomHostnameDeleteParams**kwargs) -> CustomHostnameDeleteResponse
DELETE/zones/{zone_id}/custom_hostnames/{custom_hostname_id}
ModelsExpand Collapse
Literal["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"
class CustomHostname: …
id: str

Identifier.

maxLength32
hostname: str

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

maxLength255
created_at: Optional[datetime]

This is the time the hostname was created.

formatdate-time
custom_metadata: Optional[Dict[str, str]]

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

custom_origin_server: Optional[str]

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

custom_origin_sni: Optional[str]

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: Optional[OwnershipVerification]

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

name: Optional[str]

DNS Name for record.

type: Optional[Literal["txt"]]

DNS Record type.

value: Optional[str]

Content for the record.

ownership_verification_http: Optional[OwnershipVerificationHTTP]

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

http_body: Optional[str]

Token to be served.

http_url: Optional[str]

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

ssl: Optional[SSL]
id: Optional[str]

Custom hostname SSL identifier tag.

maxLength36
minLength36
bundle_method: Optional[BundleMethod]

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.

certificate_authority: Optional[CertificateCA]

The Certificate Authority that will issue the certificate

custom_certificate: Optional[str]

If a custom uploaded certificate is used.

custom_csr_id: Optional[str]

The identifier for the Custom CSR that was used.

custom_key: Optional[str]

The key for a custom uploaded certificate.

dcv_delegation_records: Optional[List[SsldcvDelegationRecord]]

DCV Delegation records for domain validation.

cname: Optional[str]

The CNAME record hostname for DCV delegation.

cname_target: Optional[str]

The CNAME record target value for DCV delegation.

emails: Optional[List[str]]

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

http_body: Optional[str]

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

http_url: Optional[str]

The url that will be checked during domain validation.

status: Optional[str]

Status of the validation record.

txt_name: Optional[str]

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

txt_value: Optional[str]

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

expires_on: Optional[datetime]

The time the custom certificate expires on.

formatdate-time
hosts: Optional[List[str]]

A list of Hostnames on a custom uploaded certificate.

issuer: Optional[str]

The issuer on a custom uploaded certificate.

method: Optional[DCVMethod]

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

serial_number: Optional[str]

The serial number on a custom uploaded certificate.

settings: Optional[SSLSettings]
ciphers: Optional[List[str]]

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

early_hints: Optional[Literal["on", "off"]]

Whether or not Early Hints is enabled.

One of the following:
"on"
"off"
http2: Optional[Literal["on", "off"]]

Whether or not HTTP2 is enabled.

One of the following:
"on"
"off"
min_tls_version: Optional[Literal["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: Optional[Literal["on", "off"]]

Whether or not TLS 1.3 is enabled.

One of the following:
"on"
"off"
signature: Optional[str]

The signature on a custom uploaded certificate.

status: Optional[Literal["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: Optional[DomainValidationType]

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

uploaded_on: Optional[datetime]

The time the custom certificate was uploaded.

formatdate-time
validation_errors: Optional[List[SSLValidationError]]

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

message: Optional[str]

A domain validation error.

validation_records: Optional[List[SSLValidationRecord]]
cname: Optional[str]

The CNAME record hostname for DCV delegation.

cname_target: Optional[str]

The CNAME record target value for DCV delegation.

emails: Optional[List[str]]

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

http_body: Optional[str]

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

http_url: Optional[str]

The url that will be checked during domain validation.

status: Optional[str]

Status of the validation record.

txt_name: Optional[str]

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

txt_value: Optional[str]

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

wildcard: Optional[bool]

Indicates whether the certificate covers a wildcard.

status: Optional[Literal["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: Optional[List[str]]

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

Literal["http", "txt", "email"]

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

One of the following:
"http"
"txt"
"email"
Literal["dv"]

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

class CustomHostnameListResponse: …
id: str

Identifier.

maxLength32
hostname: str

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

maxLength255
created_at: Optional[datetime]

This is the time the hostname was created.

formatdate-time
custom_metadata: Optional[Dict[str, str]]

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

custom_origin_server: Optional[str]

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

custom_origin_sni: Optional[str]

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: Optional[OwnershipVerification]

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

name: Optional[str]

DNS Name for record.

type: Optional[Literal["txt"]]

DNS Record type.

value: Optional[str]

Content for the record.

ownership_verification_http: Optional[OwnershipVerificationHTTP]

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

http_body: Optional[str]

Token to be served.

http_url: Optional[str]

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

ssl: Optional[SSL]
id: Optional[str]

Custom hostname SSL identifier tag.

maxLength36
minLength36
bundle_method: Optional[BundleMethod]

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.

certificate_authority: Optional[CertificateCA]

The Certificate Authority that will issue the certificate

custom_certificate: Optional[str]

If a custom uploaded certificate is used.

custom_csr_id: Optional[str]

The identifier for the Custom CSR that was used.

custom_key: Optional[str]

The key for a custom uploaded certificate.

dcv_delegation_records: Optional[List[SsldcvDelegationRecord]]

DCV Delegation records for domain validation.

cname: Optional[str]

The CNAME record hostname for DCV delegation.

cname_target: Optional[str]

The CNAME record target value for DCV delegation.

emails: Optional[List[str]]

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

http_body: Optional[str]

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

http_url: Optional[str]

The url that will be checked during domain validation.

status: Optional[str]

Status of the validation record.

txt_name: Optional[str]

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

txt_value: Optional[str]

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

expires_on: Optional[datetime]

The time the custom certificate expires on.

formatdate-time
hosts: Optional[List[str]]

A list of Hostnames on a custom uploaded certificate.

issuer: Optional[str]

The issuer on a custom uploaded certificate.

method: Optional[DCVMethod]

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

serial_number: Optional[str]

The serial number on a custom uploaded certificate.

settings: Optional[SSLSettings]
ciphers: Optional[List[str]]

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

early_hints: Optional[Literal["on", "off"]]

Whether or not Early Hints is enabled.

One of the following:
"on"
"off"
http2: Optional[Literal["on", "off"]]

Whether or not HTTP2 is enabled.

One of the following:
"on"
"off"
min_tls_version: Optional[Literal["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: Optional[Literal["on", "off"]]

Whether or not TLS 1.3 is enabled.

One of the following:
"on"
"off"
signature: Optional[str]

The signature on a custom uploaded certificate.

status: Optional[Literal["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: Optional[DomainValidationType]

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

uploaded_on: Optional[datetime]

The time the custom certificate was uploaded.

formatdate-time
validation_errors: Optional[List[SSLValidationError]]

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

message: Optional[str]

A domain validation error.

validation_records: Optional[List[SSLValidationRecord]]
cname: Optional[str]

The CNAME record hostname for DCV delegation.

cname_target: Optional[str]

The CNAME record target value for DCV delegation.

emails: Optional[List[str]]

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

http_body: Optional[str]

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

http_url: Optional[str]

The url that will be checked during domain validation.

status: Optional[str]

Status of the validation record.

txt_name: Optional[str]

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

txt_value: Optional[str]

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

wildcard: Optional[bool]

Indicates whether the certificate covers a wildcard.

status: Optional[Literal["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: Optional[List[str]]

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

class CustomHostnameGetResponse: …
id: str

Identifier.

maxLength32
hostname: str

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

maxLength255
created_at: Optional[datetime]

This is the time the hostname was created.

formatdate-time
custom_metadata: Optional[Dict[str, str]]

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

custom_origin_server: Optional[str]

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

custom_origin_sni: Optional[str]

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: Optional[OwnershipVerification]

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

name: Optional[str]

DNS Name for record.

type: Optional[Literal["txt"]]

DNS Record type.

value: Optional[str]

Content for the record.

ownership_verification_http: Optional[OwnershipVerificationHTTP]

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

http_body: Optional[str]

Token to be served.

http_url: Optional[str]

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

ssl: Optional[SSL]
id: Optional[str]

Custom hostname SSL identifier tag.

maxLength36
minLength36
bundle_method: Optional[BundleMethod]

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.

certificate_authority: Optional[CertificateCA]

The Certificate Authority that will issue the certificate

custom_certificate: Optional[str]

If a custom uploaded certificate is used.

custom_csr_id: Optional[str]

The identifier for the Custom CSR that was used.

custom_key: Optional[str]

The key for a custom uploaded certificate.

dcv_delegation_records: Optional[List[SsldcvDelegationRecord]]

DCV Delegation records for domain validation.

cname: Optional[str]

The CNAME record hostname for DCV delegation.

cname_target: Optional[str]

The CNAME record target value for DCV delegation.

emails: Optional[List[str]]

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

http_body: Optional[str]

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

http_url: Optional[str]

The url that will be checked during domain validation.

status: Optional[str]

Status of the validation record.

txt_name: Optional[str]

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

txt_value: Optional[str]

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

expires_on: Optional[datetime]

The time the custom certificate expires on.

formatdate-time
hosts: Optional[List[str]]

A list of Hostnames on a custom uploaded certificate.

issuer: Optional[str]

The issuer on a custom uploaded certificate.

method: Optional[DCVMethod]

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

serial_number: Optional[str]

The serial number on a custom uploaded certificate.

settings: Optional[SSLSettings]
ciphers: Optional[List[str]]

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

early_hints: Optional[Literal["on", "off"]]

Whether or not Early Hints is enabled.

One of the following:
"on"
"off"
http2: Optional[Literal["on", "off"]]

Whether or not HTTP2 is enabled.

One of the following:
"on"
"off"
min_tls_version: Optional[Literal["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: Optional[Literal["on", "off"]]

Whether or not TLS 1.3 is enabled.

One of the following:
"on"
"off"
signature: Optional[str]

The signature on a custom uploaded certificate.

status: Optional[Literal["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: Optional[DomainValidationType]

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

uploaded_on: Optional[datetime]

The time the custom certificate was uploaded.

formatdate-time
validation_errors: Optional[List[SSLValidationError]]

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

message: Optional[str]

A domain validation error.

validation_records: Optional[List[SSLValidationRecord]]
cname: Optional[str]

The CNAME record hostname for DCV delegation.

cname_target: Optional[str]

The CNAME record target value for DCV delegation.

emails: Optional[List[str]]

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

http_body: Optional[str]

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

http_url: Optional[str]

The url that will be checked during domain validation.

status: Optional[str]

Status of the validation record.

txt_name: Optional[str]

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

txt_value: Optional[str]

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

wildcard: Optional[bool]

Indicates whether the certificate covers a wildcard.

status: Optional[Literal["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: Optional[List[str]]

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

class CustomHostnameCreateResponse: …
id: str

Identifier.

maxLength32
hostname: str

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

maxLength255
created_at: Optional[datetime]

This is the time the hostname was created.

formatdate-time
custom_metadata: Optional[Dict[str, str]]

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

custom_origin_server: Optional[str]

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

custom_origin_sni: Optional[str]

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: Optional[OwnershipVerification]

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

name: Optional[str]

DNS Name for record.

type: Optional[Literal["txt"]]

DNS Record type.

value: Optional[str]

Content for the record.

ownership_verification_http: Optional[OwnershipVerificationHTTP]

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

http_body: Optional[str]

Token to be served.

http_url: Optional[str]

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

ssl: Optional[SSL]
id: Optional[str]

Custom hostname SSL identifier tag.

maxLength36
minLength36
bundle_method: Optional[BundleMethod]

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.

certificate_authority: Optional[CertificateCA]

The Certificate Authority that will issue the certificate

custom_certificate: Optional[str]

If a custom uploaded certificate is used.

custom_csr_id: Optional[str]

The identifier for the Custom CSR that was used.

custom_key: Optional[str]

The key for a custom uploaded certificate.

dcv_delegation_records: Optional[List[SsldcvDelegationRecord]]

DCV Delegation records for domain validation.

cname: Optional[str]

The CNAME record hostname for DCV delegation.

cname_target: Optional[str]

The CNAME record target value for DCV delegation.

emails: Optional[List[str]]

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

http_body: Optional[str]

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

http_url: Optional[str]

The url that will be checked during domain validation.

status: Optional[str]

Status of the validation record.

txt_name: Optional[str]

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

txt_value: Optional[str]

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

expires_on: Optional[datetime]

The time the custom certificate expires on.

formatdate-time
hosts: Optional[List[str]]

A list of Hostnames on a custom uploaded certificate.

issuer: Optional[str]

The issuer on a custom uploaded certificate.

method: Optional[DCVMethod]

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

serial_number: Optional[str]

The serial number on a custom uploaded certificate.

settings: Optional[SSLSettings]
ciphers: Optional[List[str]]

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

early_hints: Optional[Literal["on", "off"]]

Whether or not Early Hints is enabled.

One of the following:
"on"
"off"
http2: Optional[Literal["on", "off"]]

Whether or not HTTP2 is enabled.

One of the following:
"on"
"off"
min_tls_version: Optional[Literal["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: Optional[Literal["on", "off"]]

Whether or not TLS 1.3 is enabled.

One of the following:
"on"
"off"
signature: Optional[str]

The signature on a custom uploaded certificate.

status: Optional[Literal["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: Optional[DomainValidationType]

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

uploaded_on: Optional[datetime]

The time the custom certificate was uploaded.

formatdate-time
validation_errors: Optional[List[SSLValidationError]]

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

message: Optional[str]

A domain validation error.

validation_records: Optional[List[SSLValidationRecord]]
cname: Optional[str]

The CNAME record hostname for DCV delegation.

cname_target: Optional[str]

The CNAME record target value for DCV delegation.

emails: Optional[List[str]]

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

http_body: Optional[str]

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

http_url: Optional[str]

The url that will be checked during domain validation.

status: Optional[str]

Status of the validation record.

txt_name: Optional[str]

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

txt_value: Optional[str]

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

wildcard: Optional[bool]

Indicates whether the certificate covers a wildcard.

status: Optional[Literal["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: Optional[List[str]]

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

class CustomHostnameEditResponse: …
id: str

Identifier.

maxLength32
hostname: str

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

maxLength255
created_at: Optional[datetime]

This is the time the hostname was created.

formatdate-time
custom_metadata: Optional[Dict[str, str]]

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

custom_origin_server: Optional[str]

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

custom_origin_sni: Optional[str]

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: Optional[OwnershipVerification]

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

name: Optional[str]

DNS Name for record.

type: Optional[Literal["txt"]]

DNS Record type.

value: Optional[str]

Content for the record.

ownership_verification_http: Optional[OwnershipVerificationHTTP]

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

http_body: Optional[str]

Token to be served.

http_url: Optional[str]

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

ssl: Optional[SSL]
id: Optional[str]

Custom hostname SSL identifier tag.

maxLength36
minLength36
bundle_method: Optional[BundleMethod]

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.

certificate_authority: Optional[CertificateCA]

The Certificate Authority that will issue the certificate

custom_certificate: Optional[str]

If a custom uploaded certificate is used.

custom_csr_id: Optional[str]

The identifier for the Custom CSR that was used.

custom_key: Optional[str]

The key for a custom uploaded certificate.

dcv_delegation_records: Optional[List[SsldcvDelegationRecord]]

DCV Delegation records for domain validation.

cname: Optional[str]

The CNAME record hostname for DCV delegation.

cname_target: Optional[str]

The CNAME record target value for DCV delegation.

emails: Optional[List[str]]

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

http_body: Optional[str]

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

http_url: Optional[str]

The url that will be checked during domain validation.

status: Optional[str]

Status of the validation record.

txt_name: Optional[str]

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

txt_value: Optional[str]

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

expires_on: Optional[datetime]

The time the custom certificate expires on.

formatdate-time
hosts: Optional[List[str]]

A list of Hostnames on a custom uploaded certificate.

issuer: Optional[str]

The issuer on a custom uploaded certificate.

method: Optional[DCVMethod]

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

serial_number: Optional[str]

The serial number on a custom uploaded certificate.

settings: Optional[SSLSettings]
ciphers: Optional[List[str]]

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

early_hints: Optional[Literal["on", "off"]]

Whether or not Early Hints is enabled.

One of the following:
"on"
"off"
http2: Optional[Literal["on", "off"]]

Whether or not HTTP2 is enabled.

One of the following:
"on"
"off"
min_tls_version: Optional[Literal["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: Optional[Literal["on", "off"]]

Whether or not TLS 1.3 is enabled.

One of the following:
"on"
"off"
signature: Optional[str]

The signature on a custom uploaded certificate.

status: Optional[Literal["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: Optional[DomainValidationType]

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

uploaded_on: Optional[datetime]

The time the custom certificate was uploaded.

formatdate-time
validation_errors: Optional[List[SSLValidationError]]

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

message: Optional[str]

A domain validation error.

validation_records: Optional[List[SSLValidationRecord]]
cname: Optional[str]

The CNAME record hostname for DCV delegation.

cname_target: Optional[str]

The CNAME record target value for DCV delegation.

emails: Optional[List[str]]

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

http_body: Optional[str]

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

http_url: Optional[str]

The url that will be checked during domain validation.

status: Optional[str]

Status of the validation record.

txt_name: Optional[str]

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

txt_value: Optional[str]

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

wildcard: Optional[bool]

Indicates whether the certificate covers a wildcard.

status: Optional[Literal["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: Optional[List[str]]

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

class CustomHostnameDeleteResponse: …
id: Optional[str]

Identifier.

maxLength32

Custom HostnamesFallback Origin

Get Fallback Origin for Custom Hostnames
custom_hostnames.fallback_origin.get(FallbackOriginGetParams**kwargs) -> FallbackOriginGetResponse
GET/zones/{zone_id}/custom_hostnames/fallback_origin
Update Fallback Origin for Custom Hostnames
custom_hostnames.fallback_origin.update(FallbackOriginUpdateParams**kwargs) -> FallbackOriginUpdateResponse
PUT/zones/{zone_id}/custom_hostnames/fallback_origin
Delete Fallback Origin for Custom Hostnames
custom_hostnames.fallback_origin.delete(FallbackOriginDeleteParams**kwargs) -> FallbackOriginDeleteResponse
DELETE/zones/{zone_id}/custom_hostnames/fallback_origin
ModelsExpand Collapse
class FallbackOriginGetResponse: …
created_at: Optional[datetime]

This is the time the fallback origin was created.

formatdate-time
errors: Optional[List[str]]

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

origin: Optional[str]

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

maxLength255
status: Optional[Literal["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: Optional[datetime]

This is the time the fallback origin was updated.

formatdate-time
class FallbackOriginUpdateResponse: …
created_at: Optional[datetime]

This is the time the fallback origin was created.

formatdate-time
errors: Optional[List[str]]

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

origin: Optional[str]

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

maxLength255
status: Optional[Literal["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: Optional[datetime]

This is the time the fallback origin was updated.

formatdate-time
class FallbackOriginDeleteResponse: …
created_at: Optional[datetime]

This is the time the fallback origin was created.

formatdate-time
errors: Optional[List[str]]

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

origin: Optional[str]

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

maxLength255
status: Optional[Literal["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: Optional[datetime]

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
custom_hostnames.certificate_pack.certificates.update(strcertificate_id, CertificateUpdateParams**kwargs) -> CertificateUpdateResponse
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
custom_hostnames.certificate_pack.certificates.delete(strcertificate_id, CertificateDeleteParams**kwargs) -> CertificateDeleteResponse
DELETE/zones/{zone_id}/custom_hostnames/{custom_hostname_id}/certificate_pack/{certificate_pack_id}/certificates/{certificate_id}
ModelsExpand Collapse
class CertificateUpdateResponse: …
id: str

Identifier.

maxLength32
hostname: str

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

maxLength255
created_at: Optional[datetime]

This is the time the hostname was created.

formatdate-time
custom_metadata: Optional[Dict[str, str]]

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

custom_origin_server: Optional[str]

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

custom_origin_sni: Optional[str]

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: Optional[OwnershipVerification]

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

name: Optional[str]

DNS Name for record.

type: Optional[Literal["txt"]]

DNS Record type.

value: Optional[str]

Content for the record.

ownership_verification_http: Optional[OwnershipVerificationHTTP]

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

http_body: Optional[str]

Token to be served.

http_url: Optional[str]

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

ssl: Optional[SSL]
id: Optional[str]

Custom hostname SSL identifier tag.

maxLength36
minLength36
bundle_method: Optional[BundleMethod]

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.

certificate_authority: Optional[CertificateCA]

The Certificate Authority that will issue the certificate

custom_certificate: Optional[str]

If a custom uploaded certificate is used.

custom_csr_id: Optional[str]

The identifier for the Custom CSR that was used.

custom_key: Optional[str]

The key for a custom uploaded certificate.

dcv_delegation_records: Optional[List[SsldcvDelegationRecord]]

DCV Delegation records for domain validation.

cname: Optional[str]

The CNAME record hostname for DCV delegation.

cname_target: Optional[str]

The CNAME record target value for DCV delegation.

emails: Optional[List[str]]

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

http_body: Optional[str]

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

http_url: Optional[str]

The url that will be checked during domain validation.

status: Optional[str]

Status of the validation record.

txt_name: Optional[str]

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

txt_value: Optional[str]

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

expires_on: Optional[datetime]

The time the custom certificate expires on.

formatdate-time
hosts: Optional[List[str]]

A list of Hostnames on a custom uploaded certificate.

issuer: Optional[str]

The issuer on a custom uploaded certificate.

method: Optional[DCVMethod]

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

serial_number: Optional[str]

The serial number on a custom uploaded certificate.

settings: Optional[SSLSettings]
ciphers: Optional[List[str]]

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

early_hints: Optional[Literal["on", "off"]]

Whether or not Early Hints is enabled.

One of the following:
"on"
"off"
http2: Optional[Literal["on", "off"]]

Whether or not HTTP2 is enabled.

One of the following:
"on"
"off"
min_tls_version: Optional[Literal["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: Optional[Literal["on", "off"]]

Whether or not TLS 1.3 is enabled.

One of the following:
"on"
"off"
signature: Optional[str]

The signature on a custom uploaded certificate.

status: Optional[Literal["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: Optional[DomainValidationType]

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

uploaded_on: Optional[datetime]

The time the custom certificate was uploaded.

formatdate-time
validation_errors: Optional[List[SSLValidationError]]

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

message: Optional[str]

A domain validation error.

validation_records: Optional[List[SSLValidationRecord]]
cname: Optional[str]

The CNAME record hostname for DCV delegation.

cname_target: Optional[str]

The CNAME record target value for DCV delegation.

emails: Optional[List[str]]

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

http_body: Optional[str]

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

http_url: Optional[str]

The url that will be checked during domain validation.

status: Optional[str]

Status of the validation record.

txt_name: Optional[str]

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

txt_value: Optional[str]

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

wildcard: Optional[bool]

Indicates whether the certificate covers a wildcard.

status: Optional[Literal["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: Optional[List[str]]

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

class CertificateDeleteResponse: …
id: Optional[str]

Identifier.

maxLength32