--- title: Custom Hostnames --- [Skip to content](#_top) [API Reference](https://developers.cloudflare.com/api/terraform) Copy Markdown Open in **Claude**Open in **ChatGPT**Open in **Cursor** --- **Copy Markdown****View as Markdown** # Custom Hostnames #### resource cloudflare\_custom\_hostname ##### required Expand Collapse zone\_id: String Identifier. [Link to this property](<#(resource)%20custom_hostnames%20%3E%20(terraform%20resource)%20%3E%20(attribute)%20zone_id>) hostname: String The custom hostname that will point to your hostname via CNAME. [Link to this property](<#(resource)%20custom_hostnames%20%3E%20(terraform%20resource)%20%3E%20(attribute)%20hostname>) ##### optional Expand Collapse 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](<#(resource)%20custom_hostnames%20%3E%20(terraform%20resource)%20%3E%20(attribute)%20custom_origin_server>) 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](<#(resource)%20custom_hostnames%20%3E%20(terraform%20resource)%20%3E%20(attribute)%20custom_origin_sni>) custom\_metadata?: Map\[String] Unique key/value metadata for this hostname. These are per-hostname (customer) settings. [Link to this property](<#(resource)%20custom_hostnames%20%3E%20(terraform%20resource)%20%3E%20(attribute)%20custom_metadata>)

ssl?: Attributes SSL properties used when creating the custom hostname.

bundle\_method?: 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. Link to this property certificate\_authority?: String The Certificate Authority that will issue the certificate. Link to this property cloudflare\_branding?: Bool Whether or not to add Cloudflare Branding for the order. This will add a subdomain of sni.cloudflaressl.com as the Common Name if set to true. Link to this property

custom\_cert\_bundle?: List\[Attributes] Array of custom certificate and key pairs (1 or 2 pairs allowed).

custom\_certificate: String If a custom uploaded certificate is used. Link to this property custom\_key: String The key for a custom uploaded certificate. Link to this property

Link to this property custom\_certificate?: String If a custom uploaded certificate is used. Link to this property custom\_csr\_id?: String The identifier for the Custom CSR that was used. Link to this property custom\_key?: String The key for a custom uploaded certificate. Link to this property method?: String Domain control validation (DCV) method used for this hostname. Link to this property

settings?: Attributes SSL specific settings.

ciphers?: List\[String] An allowlist of ciphers for TLS termination. These ciphers must be in the BoringSSL format. Link to this property early\_hints?: String Whether or not Early Hints is enabled. Link to this property http2?: String Whether or not HTTP2 is enabled. Link to this property min\_tls\_version?: String The minimum TLS version supported. Link to this property tls\_1\_3?: String Whether or not TLS 1.3 is enabled. Link to this property

Link to this property type?: String Level of validation to be used for this hostname. Domain validation (dv) must be used. Link to this property wildcard?: Bool Indicates whether the certificate covers a wildcard. Link to this property

[Link to this property](<#(resource)%20custom_hostnames%20%3E%20(terraform%20resource)%20%3E%20(attribute)%20ssl>) ##### computed Expand Collapse id: String Custom hostname identifier tag. [Link to this property](<#(resource)%20custom_hostnames%20%3E%20(terraform%20resource)%20%3E%20(attribute)%20id>) created\_at: Time This is the time the hostname was created. [Link to this property](<#(resource)%20custom_hostnames%20%3E%20(terraform%20resource)%20%3E%20(attribute)%20created_at>) status: String Status of the hostname’s activation. [Link to this property](<#(resource)%20custom_hostnames%20%3E%20(terraform%20resource)%20%3E%20(attribute)%20status>) verification\_errors: List\[String] These are errors that were encountered while trying to activate a hostname. [Link to this property](<#(resource)%20custom_hostnames%20%3E%20(terraform%20resource)%20%3E%20(attribute)%20verification_errors>)

ownership\_verification: Attributes This is a record which can be placed to activate a hostname.

name: String DNS Name for record. Link to this property type: String DNS Record type. Link to this property value: String Content for the record. Link to this property

[Link to this property](<#(resource)%20custom_hostnames%20%3E%20(terraform%20resource)%20%3E%20(attribute)%20ownership_verification>)

ownership\_verification\_http: Attributes This presents the token to be served by the given http url to activate a hostname.

http\_body: String Token to be served. Link to this property http\_url: String 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](<#(resource)%20custom_hostnames%20%3E%20(terraform%20resource)%20%3E%20(attribute)%20ownership_verification_http>) ### cloudflare\_custom\_hostname Terraform HTTPTypeScriptPythonGoTerraform ``` resource "cloudflare_custom_hostname" "example_custom_hostname" { zone_id = "023e105f4ecef8ad9ca31a8372d0c353" hostname = "app.example.com" custom_metadata = { foo = "string" } custom_origin_server = "origin2.example.com" custom_origin_sni = "sni.example.com" ssl = { bundle_method = "ubiquitous" certificate_authority = "google" cloudflare_branding = false custom_cert_bundle = [{ custom_certificate = <) ##### optional Expand Collapse custom\_hostname\_id?: String Custom hostname identifier tag. [Link to this property](<#(resource)%20custom_hostnames%20%3E%20(terraform%20datasource-single)%20%3E%20(attribute)%20custom_hostname_id>)

filter?: Attributes

id?: String Hostname ID to match against. This ID was generated and returned during the initial custom\_hostname creation. This parameter cannot be used with the ‘hostname’, ‘hostname.exact’, ‘hostname.contain’, or ‘hostname.startsWith’ parameters. Link to this property certificate\_authority?: String Filter by the certificate authority that issued the SSL certificate. Link to this property custom\_origin\_server?: String Filter by custom origin server name. Link to this property direction?: String Direction to order hostnames. Link to this property

hostname?: Attributes

contain?: String Filters hostnames by a substring match on the hostname value. This parameter cannot be used with the ‘id’, ‘hostname’, ‘hostname.exact’, or ‘hostname.startsWith’ parameters. Link to this property exact?: String Fully qualified domain name to match against. This parameter cannot be used with the ‘id’, ‘hostname’, ‘hostname.contain’, or ‘hostname.startsWith’ parameters. Link to this property starts\_with?: String Filters hostnames by a prefix match on the hostname value. This parameter cannot be used with the ‘id’, ‘hostname’, ‘hostname.exact’, or ‘hostname.contain’ parameters. Link to this property

Link to this property hostname\_status?: String Filter by the hostname’s activation status. Link to this property order?: String Field to order hostnames by. Link to this property ssl?: Int64 Whether to filter hostnames based on if they have SSL enabled. Link to this property ssl\_status?: String Filter by SSL certificate status. Link to this property wildcard?: Bool Filter by whether the custom hostname is a wildcard hostname. Link to this property

[Link to this property](<#(resource)%20custom_hostnames%20%3E%20(terraform%20datasource-single)%20%3E%20(attribute)%20filter>) ##### computed Expand Collapse id: String Custom hostname identifier tag. [Link to this property](<#(resource)%20custom_hostnames%20%3E%20(terraform%20datasource-single)%20%3E%20(attribute)%20id>) created\_at: Time This is the time the hostname was created. [Link to this property](<#(resource)%20custom_hostnames%20%3E%20(terraform%20datasource-single)%20%3E%20(attribute)%20created_at>) 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](<#(resource)%20custom_hostnames%20%3E%20(terraform%20datasource-single)%20%3E%20(attribute)%20custom_origin_server>) 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](<#(resource)%20custom_hostnames%20%3E%20(terraform%20datasource-single)%20%3E%20(attribute)%20custom_origin_sni>) hostname: String The custom hostname that will point to your hostname via CNAME. [Link to this property](<#(resource)%20custom_hostnames%20%3E%20(terraform%20datasource-single)%20%3E%20(attribute)%20hostname>) status: String Status of the hostname’s activation. [Link to this property](<#(resource)%20custom_hostnames%20%3E%20(terraform%20datasource-single)%20%3E%20(attribute)%20status>) custom\_metadata: Map\[String] Unique key/value metadata for this hostname. These are per-hostname (customer) settings. [Link to this property](<#(resource)%20custom_hostnames%20%3E%20(terraform%20datasource-single)%20%3E%20(attribute)%20custom_metadata>) verification\_errors: List\[String] These are errors that were encountered while trying to activate a hostname. [Link to this property](<#(resource)%20custom_hostnames%20%3E%20(terraform%20datasource-single)%20%3E%20(attribute)%20verification_errors>)

ownership\_verification: Attributes This is a record which can be placed to activate a hostname.

name: String DNS Name for record. Link to this property type: String DNS Record type. Link to this property value: String Content for the record. Link to this property

[Link to this property](<#(resource)%20custom_hostnames%20%3E%20(terraform%20datasource-single)%20%3E%20(attribute)%20ownership_verification>)

ownership\_verification\_http: Attributes This presents the token to be served by the given http url to activate a hostname.

[Link to this property](<#(resource)%20custom_hostnames%20%3E%20(terraform%20datasource-single)%20%3E%20(attribute)%20ownership_verification_http>)

ssl: Attributes

id: String Custom hostname SSL identifier tag. Link to this property bundle\_method: 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. Link to this property certificate\_authority: String The Certificate Authority that will issue the certificate. Link to this property custom\_certificate: String If a custom uploaded certificate is used. Link to this property custom\_csr\_id: String The identifier for the Custom CSR that was used. Link to this property custom\_key: String The key for a custom uploaded certificate. Link to this property

dcv\_delegation\_records: List\[Attributes] DCV Delegation records for domain validation.

cname: String The CNAME record hostname for DCV delegation. Link to this property cname\_target: String The CNAME record target value for DCV delegation. Link to this property emails: List\[String] The set of email addresses that the certificate authority (CA) will use to complete domain validation. Link to this property http\_body: String The content that the certificate authority (CA) will expect to find at the http\_url during the domain validation. Link to this property http\_url: String The url that will be checked during domain validation. Link to this property status: String Status of the validation record. Link to this property txt\_name: String The hostname that the certificate authority (CA) will check for a TXT record during domain validation . Link to this property txt\_value: String The TXT record that the certificate authority (CA) will check during domain validation. Link to this property

Link to this property expires\_on: Time The time the custom certificate expires on. Link to this property hosts: List\[String] A list of Hostnames on a custom uploaded certificate. Link to this property issuer: String The issuer on a custom uploaded certificate. Link to this property method: String Domain control validation (DCV) method used for this hostname. Link to this property serial\_number: String The serial number on a custom uploaded certificate. Link to this property

settings: Attributes

ciphers: List\[String] An allowlist of ciphers for TLS termination. These ciphers must be in the BoringSSL format. Link to this property early\_hints: String Whether or not Early Hints is enabled. Link to this property http2: String Whether or not HTTP2 is enabled. Link to this property min\_tls\_version: String The minimum TLS version supported. Link to this property tls\_1\_3: String Whether or not TLS 1.3 is enabled. Link to this property

Link to this property signature: String The signature on a custom uploaded certificate. Link to this property status: String Status of the hostname’s SSL certificates. Link to this property type: String Level of validation to be used for this hostname. Domain validation (dv) must be used. Link to this property uploaded\_on: Time The time the custom certificate was uploaded. Link to this property

validation\_errors: List\[Attributes] Domain validation errors that have been received by the certificate authority (CA).

message: String A domain validation error. Link to this property

Link to this property

validation\_records: List\[Attributes]

Link to this property wildcard: Bool Indicates whether the certificate covers a wildcard. Link to this property

[Link to this property](<#(resource)%20custom_hostnames%20%3E%20(terraform%20datasource-single)%20%3E%20(attribute)%20ssl>) ### cloudflare\_custom\_hostname Terraform HTTPTypeScriptPythonGoTerraform ``` data "cloudflare_custom_hostname" "example_custom_hostname" { zone_id = "023e105f4ecef8ad9ca31a8372d0c353" custom_hostname_id = "0d89c70d-ad9f-4843-b99f-6cc0252067e9" } ``` #### data cloudflare\_custom\_hostnames ##### required Expand Collapse zone\_id: String Identifier. [Link to this property](<#(resource)%20custom_hostnames%20%3E%20(terraform%20datasource-plural)%20%3E%20(attribute)%20zone_id>) ##### optional Expand Collapse certificate\_authority?: String Filter by the certificate authority that issued the SSL certificate. [Link to this property](<#(resource)%20custom_hostnames%20%3E%20(terraform%20datasource-plural)%20%3E%20(attribute)%20certificate_authority>) custom\_origin\_server?: String Filter by custom origin server name. [Link to this property](<#(resource)%20custom_hostnames%20%3E%20(terraform%20datasource-plural)%20%3E%20(attribute)%20custom_origin_server>) direction?: String Direction to order hostnames. [Link to this property](<#(resource)%20custom_hostnames%20%3E%20(terraform%20datasource-plural)%20%3E%20(attribute)%20direction>) hostname\_status?: String Filter by the hostname’s activation status. [Link to this property](<#(resource)%20custom_hostnames%20%3E%20(terraform%20datasource-plural)%20%3E%20(attribute)%20hostname_status>) id?: String Hostname ID to match against. This ID was generated and returned during the initial custom\_hostname creation. This parameter cannot be used with the ‘hostname’, ‘hostname.exact’, ‘hostname.contain’, or ‘hostname.startsWith’ parameters. [Link to this property](<#(resource)%20custom_hostnames%20%3E%20(terraform%20datasource-plural)%20%3E%20(attribute)%20id>) ssl\_status?: String Filter by SSL certificate status. [Link to this property](<#(resource)%20custom_hostnames%20%3E%20(terraform%20datasource-plural)%20%3E%20(attribute)%20ssl_status>) wildcard?: Bool Filter by whether the custom hostname is a wildcard hostname. [Link to this property](<#(resource)%20custom_hostnames%20%3E%20(terraform%20datasource-plural)%20%3E%20(attribute)%20wildcard>)

hostname?: Attributes

[Link to this property](<#(resource)%20custom_hostnames%20%3E%20(terraform%20datasource-plural)%20%3E%20(attribute)%20hostname>) order?: String Field to order hostnames by. [Link to this property](<#(resource)%20custom_hostnames%20%3E%20(terraform%20datasource-plural)%20%3E%20(attribute)%20order>) ssl?: Int64 Whether to filter hostnames based on if they have SSL enabled. [Link to this property](<#(resource)%20custom_hostnames%20%3E%20(terraform%20datasource-plural)%20%3E%20(attribute)%20ssl>) max\_items?: Int64 Max items to fetch, default: 1000 [Link to this property](<#(resource)%20custom_hostnames%20%3E%20(terraform%20datasource-plural)%20%3E%20(attribute)%20max_items>) ##### computed Expand Collapse

result: List\[Attributes] The items returned by the data source

id: String Custom hostname identifier tag. Link to this property hostname: String The custom hostname that will point to your hostname via CNAME. Link to this property created\_at: Time This is the time the hostname was created. Link to this property custom\_metadata: Map\[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: Attributes This is a record which can be placed to activate a hostname.

name: String DNS Name for record. Link to this property type: String DNS Record type. Link to this property value: String Content for the record. Link to this property

Link to this property

ownership\_verification\_http: Attributes This presents the token to be served by the given http url to activate a hostname.

Link to this property

ssl: Attributes

dcv\_delegation\_records: List\[Attributes] DCV Delegation records for domain validation.

settings: Attributes

validation\_errors: List\[Attributes] Domain validation errors that have been received by the certificate authority (CA).

message: String A domain validation error. Link to this property

Link to this property

validation\_records: List\[Attributes]

Link to this property wildcard: Bool Indicates whether the certificate covers a wildcard. Link to this property

Link to this property status: String Status of the hostname’s activation. Link to this property verification\_errors: List\[String] 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(terraform%20datasource-plural)%20%3E%20(attribute)%20result>) ### cloudflare\_custom\_hostnames Terraform HTTPTypeScriptPythonGoTerraform ``` data "cloudflare_custom_hostnames" "example_custom_hostnames" { zone_id = "023e105f4ecef8ad9ca31a8372d0c353" id = "0d89c70d-ad9f-4843-b99f-6cc0252067e9" certificate_authority = "google" custom_origin_server = "origin2.example.com" direction = "desc" hostname = { contain = "example.com" exact = "app.example.com" starts_with = "app" } hostname_status = "provisioned" ssl_status = "active" wildcard = false } ``` #### Custom HostnamesFallback Origin #### resource cloudflare\_custom\_hostname\_fallback\_origin ##### required Expand Collapse zone\_id: String Identifier. [Link to this property](<#(resource)%20custom_hostnames.fallback_origin%20%3E%20(terraform%20resource)%20%3E%20(attribute)%20zone_id>) origin: String Your origin hostname that requests to your custom hostnames will be sent to. [Link to this property](<#(resource)%20custom_hostnames.fallback_origin%20%3E%20(terraform%20resource)%20%3E%20(attribute)%20origin>) ##### computed Expand Collapse id: String Identifier. [Link to this property](<#(resource)%20custom_hostnames.fallback_origin%20%3E%20(terraform%20resource)%20%3E%20(attribute)%20id>) created\_at: Time This is the time the fallback origin was created. [Link to this property](<#(resource)%20custom_hostnames.fallback_origin%20%3E%20(terraform%20resource)%20%3E%20(attribute)%20created_at>) status: String Status of the fallback origin’s activation. [Link to this property](<#(resource)%20custom_hostnames.fallback_origin%20%3E%20(terraform%20resource)%20%3E%20(attribute)%20status>) updated\_at: Time This is the time the fallback origin was updated. [Link to this property](<#(resource)%20custom_hostnames.fallback_origin%20%3E%20(terraform%20resource)%20%3E%20(attribute)%20updated_at>) errors: List\[String] These are errors that were encountered while trying to activate a fallback origin. [Link to this property](<#(resource)%20custom_hostnames.fallback_origin%20%3E%20(terraform%20resource)%20%3E%20(attribute)%20errors>) ### cloudflare\_custom\_hostname\_fallback\_origin Terraform HTTPTypeScriptPythonGoTerraform ``` resource "cloudflare_custom_hostname_fallback_origin" "example_custom_hostname_fallback_origin" { zone_id = "023e105f4ecef8ad9ca31a8372d0c353" origin = "fallback.example.com" } ``` #### data cloudflare\_custom\_hostname\_fallback\_origin ##### required Expand Collapse zone\_id: String Identifier. [Link to this property](<#(resource)%20custom_hostnames.fallback_origin%20%3E%20(terraform%20datasource-single)%20%3E%20(attribute)%20zone_id>) ##### computed Expand Collapse id: String Identifier. [Link to this property](<#(resource)%20custom_hostnames.fallback_origin%20%3E%20(terraform%20datasource-single)%20%3E%20(attribute)%20id>) created\_at: Time This is the time the fallback origin was created. [Link to this property](<#(resource)%20custom_hostnames.fallback_origin%20%3E%20(terraform%20datasource-single)%20%3E%20(attribute)%20created_at>) origin: String Your origin hostname that requests to your custom hostnames will be sent to. [Link to this property](<#(resource)%20custom_hostnames.fallback_origin%20%3E%20(terraform%20datasource-single)%20%3E%20(attribute)%20origin>) status: String Status of the fallback origin’s activation. [Link to this property](<#(resource)%20custom_hostnames.fallback_origin%20%3E%20(terraform%20datasource-single)%20%3E%20(attribute)%20status>) updated\_at: Time This is the time the fallback origin was updated. [Link to this property](<#(resource)%20custom_hostnames.fallback_origin%20%3E%20(terraform%20datasource-single)%20%3E%20(attribute)%20updated_at>) errors: List\[String] These are errors that were encountered while trying to activate a fallback origin. [Link to this property](<#(resource)%20custom_hostnames.fallback_origin%20%3E%20(terraform%20datasource-single)%20%3E%20(attribute)%20errors>) ### cloudflare\_custom\_hostname\_fallback\_origin Terraform HTTPTypeScriptPythonGoTerraform ``` data "cloudflare_custom_hostname_fallback_origin" "example_custom_hostname_fallback_origin" { zone_id = "023e105f4ecef8ad9ca31a8372d0c353" } ```