--- title: Custom Hostnames --- [Skip to content](#_top) [API Reference](https://developers.cloudflare.com/api/typescript) 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/typescript/resources/custom_hostnames/methods/list) client.customHostnames.list(CustomHostnameListParams {zone\_id, id, certificate\_authority, 10 more } params, RequestOptionsoptions?): V4PagePaginationArray< [CustomHostnameListResponse]() {id, hostname, created\_at, 8 more } > GET/zones/{zone\_id}/custom\_hostnames ##### [Custom Hostname Details](https://developers.cloudflare.com/api/typescript/resources/custom_hostnames/methods/get) client.customHostnames.get(stringcustomHostnameID, CustomHostnameGetParams {zone\_id } params, RequestOptionsoptions?): [CustomHostnameGetResponse]() {id, hostname, created\_at, 8 more } GET/zones/{zone\_id}/custom\_hostnames/{custom\_hostname\_id} ##### [Create Custom Hostname](https://developers.cloudflare.com/api/typescript/resources/custom_hostnames/methods/create) client.customHostnames.create(CustomHostnameCreateParams {zone\_id, hostname, custom\_metadata, 3 more } params, RequestOptionsoptions?): [CustomHostnameCreateResponse]() {id, hostname, created\_at, 8 more } POST/zones/{zone\_id}/custom\_hostnames ##### [Edit Custom Hostname](https://developers.cloudflare.com/api/typescript/resources/custom_hostnames/methods/edit) client.customHostnames.edit(stringcustomHostnameID, CustomHostnameEditParams {zone\_id, custom\_metadata, custom\_origin\_server, 2 more } params, RequestOptionsoptions?): [CustomHostnameEditResponse]() {id, hostname, created\_at, 8 more } PATCH/zones/{zone\_id}/custom\_hostnames/{custom\_hostname\_id} ##### [Delete Custom Hostname (and any issued SSL certificates)](https://developers.cloudflare.com/api/typescript/resources/custom_hostnames/methods/delete) client.customHostnames.delete(stringcustomHostnameID, CustomHostnameDeleteParams {zone\_id } params, RequestOptionsoptions?): [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" Link to this property "optimal" Link to this property "force" Link to this property

[Link to this property](<#(resource)%20custom_hostnames%20%3E%20(model)%20bundle_method%20%3E%20(schema)>)

CustomHostname {id, hostname, created\_at, 8 more }

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 created\_at?: string This is the time the hostname was created. formatdate-time Link to this property custom\_metadata?: Record<string, string> Unique key/value metadata for this hostname. These are per-hostname (customer) settings. Link to this property custom\_origin\_server?: string a valid hostname that’s been added to your DNS zone as an A, AAAA, or CNAME record. Link to this property 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. Link to this property

ownership\_verification?: OwnershipVerification {name, type, value } This is a record which can be placed to activate a hostname.

name?: string DNS Name for record. Link to this property type?: "txt" DNS Record type. Link to this property value?: string Content for the record. Link to this property