Custom Hostnames
List Custom Hostnames
Custom Hostname Details
Create Custom Hostname
Edit Custom Hostname
Delete Custom Hostname (and any issued SSL certificates)
ModelsExpand Collapse
BundleMethod = "ubiquitous" or "optimal" or "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.
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.
CustomHostname { id, hostname, created_at, 8 more }
Unique key/value metadata for this hostname. These are per-hostname (customer) settings.
a valid hostname that’s been added to your DNS zone as an A, AAAA, or CNAME record.
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 { name, type, value } This is a record which can be placed to activate a hostname.
This is a record which can be placed to activate a hostname.
ownership_verification_http: optional { http_body, http_url } This presents the token to be served by the given http url to activate a hostname.
This presents the token to be served by the given http url to activate a hostname.
ssl: optional { id, bundle_method, certificate_authority, 17 more }
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.
dcv_delegation_records: optional array of { cname, cname_target, emails, 5 more } DCV Delegation records for domain validation.
DCV Delegation records for domain validation.
The set of email addresses that the certificate authority (CA) will use to complete domain validation.
The content that the certificate authority (CA) will expect to find at the http_url during the domain validation.
settings: optional { ciphers, early_hints, http2, 2 more }
status: optional "initializing" or "pending_validation" or "deleted" or 18 moreStatus of the hostname’s SSL certificates.
Status of the hostname’s SSL certificates.
validation_errors: optional array of { message } Domain validation errors that have been received by the certificate authority (CA).
Domain validation errors that have been received by the certificate authority (CA).
validation_records: optional array of { cname, cname_target, emails, 5 more }
The set of email addresses that the certificate authority (CA) will use to complete domain validation.
The content that the certificate authority (CA) will expect to find at the http_url during the domain validation.
CustomHostnameListResponse { id, hostname, created_at, 8 more }
Unique key/value metadata for this hostname. These are per-hostname (customer) settings.
a valid hostname that’s been added to your DNS zone as an A, AAAA, or CNAME record.
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 { name, type, value } This is a record which can be placed to activate a hostname.
This is a record which can be placed to activate a hostname.
ownership_verification_http: optional { http_body, http_url } This presents the token to be served by the given http url to activate a hostname.
This presents the token to be served by the given http url to activate a hostname.
ssl: optional { id, bundle_method, certificate_authority, 17 more }
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.
dcv_delegation_records: optional array of { cname, cname_target, emails, 5 more } DCV Delegation records for domain validation.
DCV Delegation records for domain validation.
The set of email addresses that the certificate authority (CA) will use to complete domain validation.
The content that the certificate authority (CA) will expect to find at the http_url during the domain validation.
settings: optional { ciphers, early_hints, http2, 2 more }
status: optional "initializing" or "pending_validation" or "deleted" or 18 moreStatus of the hostname’s SSL certificates.
Status of the hostname’s SSL certificates.
validation_errors: optional array of { message } Domain validation errors that have been received by the certificate authority (CA).
Domain validation errors that have been received by the certificate authority (CA).
validation_records: optional array of { cname, cname_target, emails, 5 more }
The set of email addresses that the certificate authority (CA) will use to complete domain validation.
The content that the certificate authority (CA) will expect to find at the http_url during the domain validation.
CustomHostnameGetResponse { id, hostname, created_at, 8 more }
Unique key/value metadata for this hostname. These are per-hostname (customer) settings.
a valid hostname that’s been added to your DNS zone as an A, AAAA, or CNAME record.
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 { name, type, value } This is a record which can be placed to activate a hostname.
This is a record which can be placed to activate a hostname.
ownership_verification_http: optional { http_body, http_url } This presents the token to be served by the given http url to activate a hostname.
This presents the token to be served by the given http url to activate a hostname.
ssl: optional { id, bundle_method, certificate_authority, 17 more }
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.
dcv_delegation_records: optional array of { cname, cname_target, emails, 5 more } DCV Delegation records for domain validation.
DCV Delegation records for domain validation.
The set of email addresses that the certificate authority (CA) will use to complete domain validation.
The content that the certificate authority (CA) will expect to find at the http_url during the domain validation.
settings: optional { ciphers, early_hints, http2, 2 more }
status: optional "initializing" or "pending_validation" or "deleted" or 18 moreStatus of the hostname’s SSL certificates.
Status of the hostname’s SSL certificates.
validation_errors: optional array of { message } Domain validation errors that have been received by the certificate authority (CA).
Domain validation errors that have been received by the certificate authority (CA).
validation_records: optional array of { cname, cname_target, emails, 5 more }
The set of email addresses that the certificate authority (CA) will use to complete domain validation.
The content that the certificate authority (CA) will expect to find at the http_url during the domain validation.
CustomHostnameCreateResponse { id, hostname, created_at, 8 more }
Unique key/value metadata for this hostname. These are per-hostname (customer) settings.
a valid hostname that’s been added to your DNS zone as an A, AAAA, or CNAME record.
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 { name, type, value } This is a record which can be placed to activate a hostname.
This is a record which can be placed to activate a hostname.
ownership_verification_http: optional { http_body, http_url } This presents the token to be served by the given http url to activate a hostname.
This presents the token to be served by the given http url to activate a hostname.
ssl: optional { id, bundle_method, certificate_authority, 17 more }
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.
dcv_delegation_records: optional array of { cname, cname_target, emails, 5 more } DCV Delegation records for domain validation.
DCV Delegation records for domain validation.
The set of email addresses that the certificate authority (CA) will use to complete domain validation.
The content that the certificate authority (CA) will expect to find at the http_url during the domain validation.
settings: optional { ciphers, early_hints, http2, 2 more }
status: optional "initializing" or "pending_validation" or "deleted" or 18 moreStatus of the hostname’s SSL certificates.
Status of the hostname’s SSL certificates.
validation_errors: optional array of { message } Domain validation errors that have been received by the certificate authority (CA).
Domain validation errors that have been received by the certificate authority (CA).
validation_records: optional array of { cname, cname_target, emails, 5 more }
The set of email addresses that the certificate authority (CA) will use to complete domain validation.
The content that the certificate authority (CA) will expect to find at the http_url during the domain validation.
CustomHostnameEditResponse { id, hostname, created_at, 8 more }
Unique key/value metadata for this hostname. These are per-hostname (customer) settings.
a valid hostname that’s been added to your DNS zone as an A, AAAA, or CNAME record.
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 { name, type, value } This is a record which can be placed to activate a hostname.
This is a record which can be placed to activate a hostname.
ownership_verification_http: optional { http_body, http_url } This presents the token to be served by the given http url to activate a hostname.
This presents the token to be served by the given http url to activate a hostname.
ssl: optional { id, bundle_method, certificate_authority, 17 more }
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.
dcv_delegation_records: optional array of { cname, cname_target, emails, 5 more } DCV Delegation records for domain validation.
DCV Delegation records for domain validation.
The set of email addresses that the certificate authority (CA) will use to complete domain validation.
The content that the certificate authority (CA) will expect to find at the http_url during the domain validation.
settings: optional { ciphers, early_hints, http2, 2 more }
status: optional "initializing" or "pending_validation" or "deleted" or 18 moreStatus of the hostname’s SSL certificates.
Status of the hostname’s SSL certificates.
validation_errors: optional array of { message } Domain validation errors that have been received by the certificate authority (CA).
Domain validation errors that have been received by the certificate authority (CA).
validation_records: optional array of { cname, cname_target, emails, 5 more }
The set of email addresses that the certificate authority (CA) will use to complete domain validation.
The content that the certificate authority (CA) will expect to find at the http_url during the domain validation.
Custom HostnamesFallback Origin
Get Fallback Origin for Custom Hostnames
Update Fallback Origin for Custom Hostnames
Delete Fallback Origin for Custom Hostnames
ModelsExpand Collapse
FallbackOriginGetResponse { created_at, errors, origin, 2 more }
These are errors that were encountered while trying to activate a fallback origin.
Your origin hostname that requests to your custom hostnames will be sent to.
FallbackOriginUpdateResponse { created_at, errors, origin, 2 more }
These are errors that were encountered while trying to activate a fallback origin.
Your origin hostname that requests to your custom hostnames will be sent to.
FallbackOriginDeleteResponse { created_at, errors, origin, 2 more }
These are errors that were encountered while trying to activate a fallback origin.
Your origin hostname that requests to your custom hostnames will be sent to.
Custom HostnamesCertificate Pack
Custom HostnamesCertificate PackCertificates
Replace Custom Certificate and Custom Key In Custom Hostname
Delete Single Certificate And Key For Custom Hostname
ModelsExpand Collapse
CertificateUpdateResponse { id, hostname, created_at, 8 more }
Unique key/value metadata for this hostname. These are per-hostname (customer) settings.
a valid hostname that’s been added to your DNS zone as an A, AAAA, or CNAME record.
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 { name, type, value } This is a record which can be placed to activate a hostname.
This is a record which can be placed to activate a hostname.
ownership_verification_http: optional { http_body, http_url } This presents the token to be served by the given http url to activate a hostname.
This presents the token to be served by the given http url to activate a hostname.
ssl: optional { id, bundle_method, certificate_authority, 17 more }
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.
dcv_delegation_records: optional array of { cname, cname_target, emails, 5 more } DCV Delegation records for domain validation.
DCV Delegation records for domain validation.
The set of email addresses that the certificate authority (CA) will use to complete domain validation.
The content that the certificate authority (CA) will expect to find at the http_url during the domain validation.
settings: optional { ciphers, early_hints, http2, 2 more }
status: optional "initializing" or "pending_validation" or "deleted" or 18 moreStatus of the hostname’s SSL certificates.
Status of the hostname’s SSL certificates.
validation_errors: optional array of { message } Domain validation errors that have been received by the certificate authority (CA).
Domain validation errors that have been received by the certificate authority (CA).
validation_records: optional array of { cname, cname_target, emails, 5 more }
The set of email addresses that the certificate authority (CA) will use to complete domain validation.
The content that the certificate authority (CA) will expect to find at the http_url during the domain validation.