--- title: Custom Hostnames --- [Skip to content](#_top) [API Reference](https://developers.cloudflare.com/api/go) Copy Markdown Open in **Claude**Open in **ChatGPT**Open in **Cursor** --- **Copy Markdown****View as Markdown** # Custom Hostnames ##### [List Custom Hostnames](https://developers.cloudflare.com/api/go/resources/custom_hostnames/methods/list) client.CustomHostnames.List(ctx, params) (\*V4PagePaginationArray\[[CustomHostnameListResponse]()], error) GET/zones/{zone\_id}/custom\_hostnames ##### [Custom Hostname Details](https://developers.cloudflare.com/api/go/resources/custom_hostnames/methods/get) client.CustomHostnames.Get(ctx, customHostnameID, query) (\*[CustomHostnameGetResponse](), error) GET/zones/{zone\_id}/custom\_hostnames/{custom\_hostname\_id} ##### [Create Custom Hostname](https://developers.cloudflare.com/api/go/resources/custom_hostnames/methods/create) client.CustomHostnames.New(ctx, params) (\*[CustomHostnameNewResponse](), error) POST/zones/{zone\_id}/custom\_hostnames ##### [Edit Custom Hostname](https://developers.cloudflare.com/api/go/resources/custom_hostnames/methods/edit) client.CustomHostnames.Edit(ctx, customHostnameID, params) (\*[CustomHostnameEditResponse](), error) PATCH/zones/{zone\_id}/custom\_hostnames/{custom\_hostname\_id} ##### [Delete Custom Hostname (and any issued SSL certificates)](https://developers.cloudflare.com/api/go/resources/custom_hostnames/methods/delete) client.CustomHostnames.Delete(ctx, customHostnameID, body) (\*[CustomHostnameDeleteResponse](), error) DELETE/zones/{zone\_id}/custom\_hostnames/{custom\_hostname\_id} ##### ModelsExpand Collapse
type BundleMethod string A ubiquitous bundle has the highest probability of being verified everywhere, even by clients using outdated or unusual trust stores. An optimal bundle uses the shortest chain and newest intermediates. And the force bundle verifies the chain, but does not otherwise modify it. One of the following: const BundleMethodUbiquitous BundleMethod = "ubiquitous" Link to this property const BundleMethodOptimal BundleMethod = "optimal" Link to this property const BundleMethodForce BundleMethod = "force" Link to this property
[Link to this property](<#(resource)%20custom_hostnames%20%3E%20(model)%20bundle_method%20%3E%20(schema)>)
type CustomHostname struct{…} ID string Custom hostname identifier tag. maxLength36 minLength36 Link to this property Hostname string The custom hostname that will point to your hostname via CNAME. maxLength255 Link to this property CreatedAt TimeOptional This is the time the hostname was created. formatdate-time Link to this property CustomMetadata map\[string, string]Optional Unique key/value metadata for this hostname. These are per-hostname (customer) settings. Link to this property CustomOriginServer stringOptional a valid hostname that’s been added to your DNS zone as an A, AAAA, or CNAME record. Link to this property CustomOriginSNI stringOptional 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. Link to this property
OwnershipVerification CustomHostnameOwnershipVerificationOptional This is a record which can be placed to activate a hostname. Name stringOptional DNS Name for record. Link to this property Type CustomHostnameOwnershipVerificationTypeOptional DNS Record type. Link to this property Value stringOptional Content for the record. Link to this property
Link to this property
OwnershipVerificationHTTP CustomHostnameOwnershipVerificationHTTPOptional This presents the token to be served by the given http url to activate a hostname. HTTPBody stringOptional Token to be served. Link to this property HTTPURL stringOptional The HTTP URL that will be checked during custom hostname verification and where the customer should host the token. Link to this property
Link to this property
SSL CustomHostnameSSLOptional ID stringOptional Custom hostname SSL identifier tag. maxLength36 minLength36 Link to this property BundleMethod BundleMethodOptional 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. Link to this property CertificateAuthority CertificateCAOptional The Certificate Authority that will issue the certificate. Link to this property CustomCertificate stringOptional If a custom uploaded certificate is used. Link to this property CustomCsrID stringOptional The identifier for the Custom CSR that was used. Link to this property CustomKey stringOptional The key for a custom uploaded certificate. Link to this property
DCVDelegationRecords \[]CustomHostnameSsldcvDelegationRecordOptional DCV Delegation records for domain validation. CNAME stringOptional The CNAME record hostname for DCV delegation. Link to this property CNAMETarget stringOptional The CNAME record target value for DCV delegation. Link to this property Emails \[]stringOptional The set of email addresses that the certificate authority (CA) will use to complete domain validation. Link to this property HTTPBody stringOptional The content that the certificate authority (CA) will expect to find at the http\_url during the domain validation. Link to this property HTTPURL stringOptional The url that will be checked during domain validation. Link to this property Status stringOptional Status of the validation record. Link to this property TXTName stringOptional The hostname that the certificate authority (CA) will check for a TXT record during domain validation . Link to this property TXTValue stringOptional The TXT record that the certificate authority (CA) will check during domain validation. Link to this property
Link to this property ExpiresOn TimeOptional The time the custom certificate expires on. formatdate-time Link to this property Hosts \[]stringOptional A list of Hostnames on a custom uploaded certificate. Link to this property Issuer stringOptional The issuer on a custom uploaded certificate. Link to this property Method DCVMethodOptional Domain control validation (DCV) method used for this hostname. Link to this property SerialNumber stringOptional The serial number on a custom uploaded certificate. Link to this property
Settings CustomHostnameSSLSettingsOptional Ciphers \[]stringOptional An allowlist of ciphers for TLS termination. These ciphers must be in the BoringSSL format. Link to this property
EarlyHints CustomHostnameSSLSettingsEarlyHintsOptional Whether or not Early Hints is enabled. One of the following: const CustomHostnameSSLSettingsEarlyHintsOn CustomHostnameSSLSettingsEarlyHints = "on" Link to this property const CustomHostnameSSLSettingsEarlyHintsOff CustomHostnameSSLSettingsEarlyHints = "off" Link to this property
Link to this property
HTTP2 CustomHostnameSSLSettingsHTTP2Optional Whether or not HTTP2 is enabled. One of the following: const CustomHostnameSSLSettingsHTTP2On CustomHostnameSSLSettingsHTTP2 = "on" Link to this property const CustomHostnameSSLSettingsHTTP2Off CustomHostnameSSLSettingsHTTP2 = "off" Link to this property
Link to this property
MinTLSVersion CustomHostnameSSLSettingsMinTLSVersionOptional The minimum TLS version supported. One of the following: const CustomHostnameSSLSettingsMinTLSVersion1\_0 CustomHostnameSSLSettingsMinTLSVersion = "1.0" Link to this property const CustomHostnameSSLSettingsMinTLSVersion1\_1 CustomHostnameSSLSettingsMinTLSVersion = "1.1" Link to this property const CustomHostnameSSLSettingsMinTLSVersion1\_2 CustomHostnameSSLSettingsMinTLSVersion = "1.2" Link to this property const CustomHostnameSSLSettingsMinTLSVersion1\_3 CustomHostnameSSLSettingsMinTLSVersion = "1.3" Link to this property
Link to this property
TLS1\_3 CustomHostnameSSLSettingsTLS1\_3Optional Whether or not TLS 1.3 is enabled. One of the following: const CustomHostnameSSLSettingsTLS1\_3On CustomHostnameSSLSettingsTLS1\_3 = "on" Link to this property const CustomHostnameSSLSettingsTLS1\_3Off CustomHostnameSSLSettingsTLS1\_3 = "off" Link to this property
Link to this property
Link to this property Signature stringOptional The signature on a custom uploaded certificate. Link to this property
Status CustomHostnameSSLStatusOptional Status of the hostname’s SSL certificates. One of the following: const CustomHostnameSSLStatusInitializing CustomHostnameSSLStatus = "initializing" Link to this property const CustomHostnameSSLStatusPendingValidation CustomHostnameSSLStatus = "pending\_validation" Link to this property const CustomHostnameSSLStatusDeleted CustomHostnameSSLStatus = "deleted" Link to this property const CustomHostnameSSLStatusPendingIssuance CustomHostnameSSLStatus = "pending\_issuance" Link to this property const CustomHostnameSSLStatusPendingDeployment CustomHostnameSSLStatus = "pending\_deployment" Link to this property const CustomHostnameSSLStatusPendingDeletion CustomHostnameSSLStatus = "pending\_deletion" Link to this property const CustomHostnameSSLStatusPendingExpiration CustomHostnameSSLStatus = "pending\_expiration" Link to this property const CustomHostnameSSLStatusExpired CustomHostnameSSLStatus = "expired" Link to this property const CustomHostnameSSLStatusActive CustomHostnameSSLStatus = "active" Link to this property const CustomHostnameSSLStatusInitializingTimedOut CustomHostnameSSLStatus = "initializing\_timed\_out" Link to this property const CustomHostnameSSLStatusValidationTimedOut CustomHostnameSSLStatus = "validation\_timed\_out" Link to this property const CustomHostnameSSLStatusIssuanceTimedOut CustomHostnameSSLStatus = "issuance\_timed\_out" Link to this property const CustomHostnameSSLStatusDeploymentTimedOut CustomHostnameSSLStatus = "deployment\_timed\_out" Link to this property const CustomHostnameSSLStatusDeletionTimedOut CustomHostnameSSLStatus = "deletion\_timed\_out" Link to this property const CustomHostnameSSLStatusPendingCleanup CustomHostnameSSLStatus = "pending\_cleanup" Link to this property const CustomHostnameSSLStatusStagingDeployment CustomHostnameSSLStatus = "staging\_deployment" Link to this property const CustomHostnameSSLStatusStagingActive CustomHostnameSSLStatus = "staging\_active" Link to this property const CustomHostnameSSLStatusDeactivating CustomHostnameSSLStatus = "deactivating" Link to this property const CustomHostnameSSLStatusInactive CustomHostnameSSLStatus = "inactive" Link to this property const CustomHostnameSSLStatusBackupIssued CustomHostnameSSLStatus = "backup\_issued" Link to this property const CustomHostnameSSLStatusHoldingDeployment CustomHostnameSSLStatus = "holding\_deployment" Link to this property
Link to this property Type DomainValidationTypeOptional Level of validation to be used for this hostname. Domain validation (dv) must be used. Link to this property UploadedOn TimeOptional The time the custom certificate was uploaded. formatdate-time Link to this property
ValidationErrors \[]CustomHostnameSSLValidationErrorOptional Domain validation errors that have been received by the certificate authority (CA). Message stringOptional A domain validation error. Link to this property
Link to this property
ValidationRecords \[]CustomHostnameSSLValidationRecordOptional CNAME stringOptional The CNAME record hostname for DCV delegation. Link to this property CNAMETarget stringOptional The CNAME record target value for DCV delegation. Link to this property Emails \[]stringOptional The set of email addresses that the certificate authority (CA) will use to complete domain validation. Link to this property HTTPBody stringOptional The content that the certificate authority (CA) will expect to find at the http\_url during the domain validation. Link to this property HTTPURL stringOptional The url that will be checked during domain validation. Link to this property Status stringOptional Status of the validation record. Link to this property TXTName stringOptional The hostname that the certificate authority (CA) will check for a TXT record during domain validation . Link to this property TXTValue stringOptional The TXT record that the certificate authority (CA) will check during domain validation. Link to this property
Link to this property Wildcard boolOptional Indicates whether the certificate covers a wildcard. Link to this property
Link to this property
Status CustomHostnameStatusOptional Status of the hostname’s activation. One of the following: const CustomHostnameStatusActive CustomHostnameStatus = "active" Link to this property const CustomHostnameStatusPending CustomHostnameStatus = "pending" Link to this property const CustomHostnameStatusActiveRedeploying CustomHostnameStatus = "active\_redeploying" Link to this property const CustomHostnameStatusMoved CustomHostnameStatus = "moved" Link to this property const CustomHostnameStatusPendingDeletion CustomHostnameStatus = "pending\_deletion" Link to this property const CustomHostnameStatusDeleted CustomHostnameStatus = "deleted" Link to this property const CustomHostnameStatusPendingBlocked CustomHostnameStatus = "pending\_blocked" Link to this property const CustomHostnameStatusPendingMigration CustomHostnameStatus = "pending\_migration" Link to this property const CustomHostnameStatusPendingProvisioned CustomHostnameStatus = "pending\_provisioned" Link to this property const CustomHostnameStatusTestPending CustomHostnameStatus = "test\_pending" Link to this property const CustomHostnameStatusTestActive CustomHostnameStatus = "test\_active" Link to this property const CustomHostnameStatusTestActiveApex CustomHostnameStatus = "test\_active\_apex" Link to this property const CustomHostnameStatusTestBlocked CustomHostnameStatus = "test\_blocked" Link to this property const CustomHostnameStatusTestFailed CustomHostnameStatus = "test\_failed" Link to this property const CustomHostnameStatusProvisioned CustomHostnameStatus = "provisioned" Link to this property const CustomHostnameStatusBlocked CustomHostnameStatus = "blocked" Link to this property
Link to this property VerificationErrors \[]stringOptional These are errors that were encountered while trying to activate a hostname. Link to this property
[Link to this property](<#(resource)%20custom_hostnames%20%3E%20(model)%20custom_hostname%20%3E%20(schema)>)
type DCVMethod string Domain control validation (DCV) method used for this hostname. One of the following: const DCVMethodHTTP DCVMethod = "http" Link to this property const DCVMethodTXT DCVMethod = "txt" Link to this property const DCVMethodEmail DCVMethod = "email" Link to this property
[Link to this property](<#(resource)%20custom_hostnames%20%3E%20(model)%20dcv_method%20%3E%20(schema)>) type DomainValidationType string Level of validation to be used for this hostname. Domain validation (dv) must be used. [Link to this property](<#(resource)%20custom_hostnames%20%3E%20(model)%20domain_validation_type%20%3E%20(schema)>) #### Custom HostnamesFallback Origin ##### [Get Fallback Origin for Custom Hostnames](https://developers.cloudflare.com/api/go/resources/custom_hostnames/subresources/fallback_origin/methods/get) client.CustomHostnames.FallbackOrigin.Get(ctx, query) (\*[FallbackOriginGetResponse](), error) GET/zones/{zone\_id}/custom\_hostnames/fallback\_origin ##### [Update Fallback Origin for Custom Hostnames](https://developers.cloudflare.com/api/go/resources/custom_hostnames/subresources/fallback_origin/methods/update) client.CustomHostnames.FallbackOrigin.Update(ctx, params) (\*[FallbackOriginUpdateResponse](), error) PUT/zones/{zone\_id}/custom\_hostnames/fallback\_origin ##### [Delete Fallback Origin for Custom Hostnames](https://developers.cloudflare.com/api/go/resources/custom_hostnames/subresources/fallback_origin/methods/delete) client.CustomHostnames.FallbackOrigin.Delete(ctx, body) (\*[FallbackOriginDeleteResponse](), error) DELETE/zones/{zone\_id}/custom\_hostnames/fallback\_origin #### Custom HostnamesCertificate Pack #### Custom HostnamesCertificate PackCertificates ##### [Replace Custom Certificate and Custom Key In Custom Hostname](https://developers.cloudflare.com/api/go/resources/custom_hostnames/subresources/certificate_pack/subresources/certificates/methods/update) client.CustomHostnames.CertificatePack.Certificates.Update(ctx, customHostnameID, certificatePackID, certificateID, params) (\*[CertificatePackCertificateUpdateResponse](), error) 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](https://developers.cloudflare.com/api/go/resources/custom_hostnames/subresources/certificate_pack/subresources/certificates/methods/delete) client.CustomHostnames.CertificatePack.Certificates.Delete(ctx, customHostnameID, certificatePackID, certificateID, body) (\*[CertificatePackCertificateDeleteResponse](), error) DELETE/zones/{zone\_id}/custom\_hostnames/{custom\_hostname\_id}/certificate\_pack/{certificate\_pack\_id}/certificates/{certificate\_id} #### Custom HostnamesQuota ##### [Get Custom Hostname Quota](https://developers.cloudflare.com/api/go/resources/custom_hostnames/subresources/quota/methods/get) client.CustomHostnames.Quota.Get(ctx, query) (\*[QuotaGetResponse](), error) GET/zones/{zone\_id}/custom\_hostnames/quota