--- title: Custom Hostnames --- [Skip to content](#_top) [API Reference](https://developers.cloudflare.com/api/python) 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/python/resources/custom_hostnames/methods/list) custom\_hostnames.list(CustomHostnameListParams\*\*kwargs) -> SyncV4PagePaginationArray\[[CustomHostnameListResponse]()] GET/zones/{zone\_id}/custom\_hostnames ##### [Custom Hostname Details](https://developers.cloudflare.com/api/python/resources/custom_hostnames/methods/get) custom\_hostnames.get(strcustom\_hostname\_id, CustomHostnameGetParams\*\*kwargs) -> [CustomHostnameGetResponse]() GET/zones/{zone\_id}/custom\_hostnames/{custom\_hostname\_id} ##### [Create Custom Hostname](https://developers.cloudflare.com/api/python/resources/custom_hostnames/methods/create) custom\_hostnames.create(CustomHostnameCreateParams\*\*kwargs) -> [CustomHostnameCreateResponse]() POST/zones/{zone\_id}/custom\_hostnames ##### [Edit Custom Hostname](https://developers.cloudflare.com/api/python/resources/custom_hostnames/methods/edit) 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)](https://developers.cloudflare.com/api/python/resources/custom_hostnames/methods/delete) 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" 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)>)
class CustomHostname: … id: str Custom hostname identifier tag. maxLength36 minLength36 Link to this property hostname: str The custom hostname that will point to your hostname via CNAME. maxLength255 Link to this property created\_at: Optional\[datetime] This is the time the hostname was created. formatdate-time Link to this property custom\_metadata: Optional\[Dict\[str, str]] Unique key/value metadata for this hostname. These are per-hostname (customer) settings. Link to this property custom\_origin\_server: Optional\[str] 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: 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. Link to this property
ownership\_verification: Optional\[OwnershipVerification] This is a record which can be placed to activate a hostname. name: Optional\[str] DNS Name for record. Link to this property type: Optional\[Literal\["txt"]] DNS Record type. Link to this property value: Optional\[str] Content for the record. Link to this property
Link to this property
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. Link to this property http\_url: Optional\[str] 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: Optional\[SSL] id: Optional\[str] Custom hostname SSL identifier tag. maxLength36 minLength36 Link to this property 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. Link to this property certificate\_authority: Optional\[CertificateCA] The Certificate Authority that will issue the certificate. Link to this property custom\_certificate: Optional\[str] If a custom uploaded certificate is used. Link to this property custom\_csr\_id: Optional\[str] The identifier for the Custom CSR that was used. Link to this property custom\_key: Optional\[str] The key for a custom uploaded certificate. Link to this property
dcv\_delegation\_records: Optional\[List\[SsldcvDelegationRecord]] DCV Delegation records for domain validation. cname: Optional\[str] The CNAME record hostname for DCV delegation. Link to this property cname\_target: Optional\[str] The CNAME record target value for DCV delegation. Link to this property emails: Optional\[List\[str]] The set of email addresses that the certificate authority (CA) will use to complete domain validation. Link to this property http\_body: Optional\[str] 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: Optional\[str] The url that will be checked during domain validation. Link to this property status: Optional\[str] Status of the validation record. Link to this property txt\_name: Optional\[str] The hostname that the certificate authority (CA) will check for a TXT record during domain validation . Link to this property txt\_value: Optional\[str] The TXT record that the certificate authority (CA) will check during domain validation. Link to this property
Link to this property expires\_on: Optional\[datetime] The time the custom certificate expires on. formatdate-time Link to this property hosts: Optional\[List\[str]] A list of Hostnames on a custom uploaded certificate. Link to this property issuer: Optional\[str] The issuer on a custom uploaded certificate. Link to this property method: Optional\[DCVMethod] Domain control validation (DCV) method used for this hostname. Link to this property serial\_number: Optional\[str] The serial number on a custom uploaded certificate. Link to this property
settings: Optional\[SSLSettings] ciphers: Optional\[List\[str]] An allowlist of ciphers for TLS termination. These ciphers must be in the BoringSSL format. Link to this property
early\_hints: Optional\[Literal\["on", "off"]] Whether or not Early Hints is enabled. One of the following: "on" Link to this property "off" Link to this property
Link to this property
http2: Optional\[Literal\["on", "off"]] Whether or not HTTP2 is enabled. One of the following: "on" Link to this property "off" Link to this property
Link to this property
min\_tls\_version: Optional\[Literal\["1.0", "1.1", "1.2", "1.3"]] The minimum TLS version supported. One of the following: "1.0" Link to this property "1.1" Link to this property "1.2" Link to this property "1.3" Link to this property
Link to this property
tls\_1\_3: Optional\[Literal\["on", "off"]] Whether or not TLS 1.3 is enabled. One of the following: "on" Link to this property "off" Link to this property
Link to this property
Link to this property signature: Optional\[str] The signature on a custom uploaded certificate. Link to this property
status: Optional\[Literal\["initializing", "pending\_validation", "deleted", 18 more]] Status of the hostname’s SSL certificates. One of the following: "initializing" Link to this property "pending\_validation" Link to this property "deleted" Link to this property "pending\_issuance" Link to this property "pending\_deployment" Link to this property "pending\_deletion" Link to this property "pending\_expiration" Link to this property "expired" Link to this property "active" Link to this property "initializing\_timed\_out" Link to this property "validation\_timed\_out" Link to this property "issuance\_timed\_out" Link to this property "deployment\_timed\_out" Link to this property "deletion\_timed\_out" Link to this property "pending\_cleanup" Link to this property "staging\_deployment" Link to this property "staging\_active" Link to this property "deactivating" Link to this property "inactive" Link to this property "backup\_issued" Link to this property "holding\_deployment" Link to this property
Link to this property type: Optional\[DomainValidationType] Level of validation to be used for this hostname. Domain validation (dv) must be used. Link to this property uploaded\_on: Optional\[datetime] The time the custom certificate was uploaded. formatdate-time Link to this property
validation\_errors: Optional\[List\[SSLValidationError]] Domain validation errors that have been received by the certificate authority (CA). message: Optional\[str] A domain validation error. Link to this property
Link to this property
validation\_records: Optional\[List\[SSLValidationRecord]] cname: Optional\[str] The CNAME record hostname for DCV delegation. Link to this property cname\_target: Optional\[str] The CNAME record target value for DCV delegation. Link to this property emails: Optional\[List\[str]] The set of email addresses that the certificate authority (CA) will use to complete domain validation. Link to this property http\_body: Optional\[str] 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: Optional\[str] The url that will be checked during domain validation. Link to this property status: Optional\[str] Status of the validation record. Link to this property txt\_name: Optional\[str] The hostname that the certificate authority (CA) will check for a TXT record during domain validation . Link to this property txt\_value: Optional\[str] The TXT record that the certificate authority (CA) will check during domain validation. Link to this property
Link to this property wildcard: Optional\[bool] Indicates whether the certificate covers a wildcard. Link to this property
Link to this property
status: Optional\[Literal\["active", "pending", "active\_redeploying", 13 more]] Status of the hostname’s activation. One of the following: "active" Link to this property "pending" Link to this property "active\_redeploying" Link to this property "moved" Link to this property "pending\_deletion" Link to this property "deleted" Link to this property "pending\_blocked" Link to this property "pending\_migration" Link to this property "pending\_provisioned" Link to this property "test\_pending" Link to this property "test\_active" Link to this property "test\_active\_apex" Link to this property "test\_blocked" Link to this property "test\_failed" Link to this property "provisioned" Link to this property "blocked" Link to this property
Link to this property verification\_errors: Optional\[List\[str]] 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)>)
Literal\["http", "txt", "email"] Domain control validation (DCV) method used for this hostname. One of the following: "http" Link to this property "txt" Link to this property "email" Link to this property
[Link to this property](<#(resource)%20custom_hostnames%20%3E%20(model)%20dcv_method%20%3E%20(schema)>) Literal\["dv"] 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)>)
class CustomHostnameListResponse: … id: str Custom hostname identifier tag. maxLength36 minLength36 Link to this property hostname: str The custom hostname that will point to your hostname via CNAME. maxLength255 Link to this property created\_at: Optional\[datetime] This is the time the hostname was created. formatdate-time Link to this property custom\_metadata: Optional\[Dict\[str, str]] Unique key/value metadata for this hostname. These are per-hostname (customer) settings. Link to this property custom\_origin\_server: Optional\[str] 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: 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. Link to this property
ownership\_verification: Optional\[OwnershipVerification] This is a record which can be placed to activate a hostname. name: Optional\[str] DNS Name for record. Link to this property type: Optional\[Literal\["txt"]] DNS Record type. Link to this property value: Optional\[str] Content for the record. Link to this property
Link to this property
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. Link to this property http\_url: Optional\[str] 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: Optional\[SSL] id: Optional\[str] Custom hostname SSL identifier tag. maxLength36 minLength36 Link to this property 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. Link to this property certificate\_authority: Optional\[CertificateCA] The Certificate Authority that will issue the certificate. Link to this property custom\_certificate: Optional\[str] If a custom uploaded certificate is used. Link to this property custom\_csr\_id: Optional\[str] The identifier for the Custom CSR that was used. Link to this property custom\_key: Optional\[str] The key for a custom uploaded certificate. Link to this property
dcv\_delegation\_records: Optional\[List\[SsldcvDelegationRecord]] DCV Delegation records for domain validation. cname: Optional\[str] The CNAME record hostname for DCV delegation. Link to this property cname\_target: Optional\[str] The CNAME record target value for DCV delegation. Link to this property emails: Optional\[List\[str]] The set of email addresses that the certificate authority (CA) will use to complete domain validation. Link to this property http\_body: Optional\[str] 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: Optional\[str] The url that will be checked during domain validation. Link to this property status: Optional\[str] Status of the validation record. Link to this property txt\_name: Optional\[str] The hostname that the certificate authority (CA) will check for a TXT record during domain validation . Link to this property txt\_value: Optional\[str] The TXT record that the certificate authority (CA) will check during domain validation. Link to this property
Link to this property expires\_on: Optional\[datetime] The time the custom certificate expires on. formatdate-time Link to this property hosts: Optional\[List\[str]] A list of Hostnames on a custom uploaded certificate. Link to this property issuer: Optional\[str] The issuer on a custom uploaded certificate. Link to this property method: Optional\[DCVMethod] Domain control validation (DCV) method used for this hostname. Link to this property serial\_number: Optional\[str] The serial number on a custom uploaded certificate. Link to this property
settings: Optional\[SSLSettings] ciphers: Optional\[List\[str]] An allowlist of ciphers for TLS termination. These ciphers must be in the BoringSSL format. Link to this property
early\_hints: Optional\[Literal\["on", "off"]] Whether or not Early Hints is enabled. One of the following: "on" Link to this property "off" Link to this property
Link to this property
http2: Optional\[Literal\["on", "off"]] Whether or not HTTP2 is enabled. One of the following: "on" Link to this property "off" Link to this property
Link to this property
min\_tls\_version: Optional\[Literal\["1.0", "1.1", "1.2", "1.3"]] The minimum TLS version supported. One of the following: "1.0" Link to this property "1.1" Link to this property "1.2" Link to this property "1.3" Link to this property
Link to this property
tls\_1\_3: Optional\[Literal\["on", "off"]] Whether or not TLS 1.3 is enabled. One of the following: "on" Link to this property "off" Link to this property
Link to this property
Link to this property signature: Optional\[str] The signature on a custom uploaded certificate. Link to this property
status: Optional\[Literal\["initializing", "pending\_validation", "deleted", 18 more]] Status of the hostname’s SSL certificates. One of the following: "initializing" Link to this property "pending\_validation" Link to this property "deleted" Link to this property "pending\_issuance" Link to this property "pending\_deployment" Link to this property "pending\_deletion" Link to this property "pending\_expiration" Link to this property "expired" Link to this property "active" Link to this property "initializing\_timed\_out" Link to this property "validation\_timed\_out" Link to this property "issuance\_timed\_out" Link to this property "deployment\_timed\_out" Link to this property "deletion\_timed\_out" Link to this property "pending\_cleanup" Link to this property "staging\_deployment" Link to this property "staging\_active" Link to this property "deactivating" Link to this property "inactive" Link to this property "backup\_issued" Link to this property "holding\_deployment" Link to this property
Link to this property type: Optional\[DomainValidationType] Level of validation to be used for this hostname. Domain validation (dv) must be used. Link to this property uploaded\_on: Optional\[datetime] The time the custom certificate was uploaded. formatdate-time Link to this property
validation\_errors: Optional\[List\[SSLValidationError]] Domain validation errors that have been received by the certificate authority (CA). message: Optional\[str] A domain validation error. Link to this property
Link to this property
validation\_records: Optional\[List\[SSLValidationRecord]] cname: Optional\[str] The CNAME record hostname for DCV delegation. Link to this property cname\_target: Optional\[str] The CNAME record target value for DCV delegation. Link to this property emails: Optional\[List\[str]] The set of email addresses that the certificate authority (CA) will use to complete domain validation. Link to this property http\_body: Optional\[str] 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: Optional\[str] The url that will be checked during domain validation. Link to this property status: Optional\[str] Status of the validation record. Link to this property txt\_name: Optional\[str] The hostname that the certificate authority (CA) will check for a TXT record during domain validation . Link to this property txt\_value: Optional\[str] The TXT record that the certificate authority (CA) will check during domain validation. Link to this property
Link to this property wildcard: Optional\[bool] Indicates whether the certificate covers a wildcard. Link to this property
Link to this property
status: Optional\[Literal\["active", "pending", "active\_redeploying", 13 more]] Status of the hostname’s activation. One of the following: "active" Link to this property "pending" Link to this property "active\_redeploying" Link to this property "moved" Link to this property "pending\_deletion" Link to this property "deleted" Link to this property "pending\_blocked" Link to this property "pending\_migration" Link to this property "pending\_provisioned" Link to this property "test\_pending" Link to this property "test\_active" Link to this property "test\_active\_apex" Link to this property "test\_blocked" Link to this property "test\_failed" Link to this property "provisioned" Link to this property "blocked" Link to this property
Link to this property verification\_errors: Optional\[List\[str]] 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_list_response%20%3E%20(schema)>)
class CustomHostnameGetResponse: … id: str Custom hostname identifier tag. maxLength36 minLength36 Link to this property hostname: str The custom hostname that will point to your hostname via CNAME. maxLength255 Link to this property created\_at: Optional\[datetime] This is the time the hostname was created. formatdate-time Link to this property custom\_metadata: Optional\[Dict\[str, str]] Unique key/value metadata for this hostname. These are per-hostname (customer) settings. Link to this property custom\_origin\_server: Optional\[str] 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: 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. Link to this property
ownership\_verification: Optional\[OwnershipVerification] This is a record which can be placed to activate a hostname. name: Optional\[str] DNS Name for record. Link to this property type: Optional\[Literal\["txt"]] DNS Record type. Link to this property value: Optional\[str] Content for the record. Link to this property
Link to this property
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. Link to this property http\_url: Optional\[str] 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: Optional\[SSL] id: Optional\[str] Custom hostname SSL identifier tag. maxLength36 minLength36 Link to this property 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. Link to this property certificate\_authority: Optional\[CertificateCA] The Certificate Authority that will issue the certificate. Link to this property custom\_certificate: Optional\[str] If a custom uploaded certificate is used. Link to this property custom\_csr\_id: Optional\[str] The identifier for the Custom CSR that was used. Link to this property custom\_key: Optional\[str] The key for a custom uploaded certificate. Link to this property
dcv\_delegation\_records: Optional\[List\[SsldcvDelegationRecord]] DCV Delegation records for domain validation. cname: Optional\[str] The CNAME record hostname for DCV delegation. Link to this property cname\_target: Optional\[str] The CNAME record target value for DCV delegation. Link to this property emails: Optional\[List\[str]] The set of email addresses that the certificate authority (CA) will use to complete domain validation. Link to this property http\_body: Optional\[str] 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: Optional\[str] The url that will be checked during domain validation. Link to this property status: Optional\[str] Status of the validation record. Link to this property txt\_name: Optional\[str] The hostname that the certificate authority (CA) will check for a TXT record during domain validation . Link to this property txt\_value: Optional\[str] The TXT record that the certificate authority (CA) will check during domain validation. Link to this property
Link to this property expires\_on: Optional\[datetime] The time the custom certificate expires on. formatdate-time Link to this property hosts: Optional\[List\[str]] A list of Hostnames on a custom uploaded certificate. Link to this property issuer: Optional\[str] The issuer on a custom uploaded certificate. Link to this property method: Optional\[DCVMethod] Domain control validation (DCV) method used for this hostname. Link to this property serial\_number: Optional\[str] The serial number on a custom uploaded certificate. Link to this property
settings: Optional\[SSLSettings] ciphers: Optional\[List\[str]] An allowlist of ciphers for TLS termination. These ciphers must be in the BoringSSL format. Link to this property
early\_hints: Optional\[Literal\["on", "off"]] Whether or not Early Hints is enabled. One of the following: "on" Link to this property "off" Link to this property
Link to this property
http2: Optional\[Literal\["on", "off"]] Whether or not HTTP2 is enabled. One of the following: "on" Link to this property "off" Link to this property
Link to this property
min\_tls\_version: Optional\[Literal\["1.0", "1.1", "1.2", "1.3"]] The minimum TLS version supported. One of the following: "1.0" Link to this property "1.1" Link to this property "1.2" Link to this property "1.3" Link to this property
Link to this property
tls\_1\_3: Optional\[Literal\["on", "off"]] Whether or not TLS 1.3 is enabled. One of the following: "on" Link to this property "off" Link to this property
Link to this property
Link to this property signature: Optional\[str] The signature on a custom uploaded certificate. Link to this property
status: Optional\[Literal\["initializing", "pending\_validation", "deleted", 18 more]] Status of the hostname’s SSL certificates. One of the following: "initializing" Link to this property "pending\_validation" Link to this property "deleted" Link to this property "pending\_issuance" Link to this property "pending\_deployment" Link to this property "pending\_deletion" Link to this property "pending\_expiration" Link to this property "expired" Link to this property "active" Link to this property "initializing\_timed\_out" Link to this property "validation\_timed\_out" Link to this property "issuance\_timed\_out" Link to this property "deployment\_timed\_out" Link to this property "deletion\_timed\_out" Link to this property "pending\_cleanup" Link to this property "staging\_deployment" Link to this property "staging\_active" Link to this property "deactivating" Link to this property "inactive" Link to this property "backup\_issued" Link to this property "holding\_deployment" Link to this property
Link to this property type: Optional\[DomainValidationType] Level of validation to be used for this hostname. Domain validation (dv) must be used. Link to this property uploaded\_on: Optional\[datetime] The time the custom certificate was uploaded. formatdate-time Link to this property
validation\_errors: Optional\[List\[SSLValidationError]] Domain validation errors that have been received by the certificate authority (CA). message: Optional\[str] A domain validation error. Link to this property
Link to this property
validation\_records: Optional\[List\[SSLValidationRecord]] cname: Optional\[str] The CNAME record hostname for DCV delegation. Link to this property cname\_target: Optional\[str] The CNAME record target value for DCV delegation. Link to this property emails: Optional\[List\[str]] The set of email addresses that the certificate authority (CA) will use to complete domain validation. Link to this property http\_body: Optional\[str] 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: Optional\[str] The url that will be checked during domain validation. Link to this property status: Optional\[str] Status of the validation record. Link to this property txt\_name: Optional\[str] The hostname that the certificate authority (CA) will check for a TXT record during domain validation . Link to this property txt\_value: Optional\[str] The TXT record that the certificate authority (CA) will check during domain validation. Link to this property
Link to this property wildcard: Optional\[bool] Indicates whether the certificate covers a wildcard. Link to this property
Link to this property
status: Optional\[Literal\["active", "pending", "active\_redeploying", 13 more]] Status of the hostname’s activation. One of the following: "active" Link to this property "pending" Link to this property "active\_redeploying" Link to this property "moved" Link to this property "pending\_deletion" Link to this property "deleted" Link to this property "pending\_blocked" Link to this property "pending\_migration" Link to this property "pending\_provisioned" Link to this property "test\_pending" Link to this property "test\_active" Link to this property "test\_active\_apex" Link to this property "test\_blocked" Link to this property "test\_failed" Link to this property "provisioned" Link to this property "blocked" Link to this property
Link to this property verification\_errors: Optional\[List\[str]] 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_get_response%20%3E%20(schema)>)
class CustomHostnameCreateResponse: … id: str Custom hostname identifier tag. maxLength36 minLength36 Link to this property hostname: str The custom hostname that will point to your hostname via CNAME. maxLength255 Link to this property created\_at: Optional\[datetime] This is the time the hostname was created. formatdate-time Link to this property custom\_metadata: Optional\[Dict\[str, str]] Unique key/value metadata for this hostname. These are per-hostname (customer) settings. Link to this property custom\_origin\_server: Optional\[str] 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: 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. Link to this property
ownership\_verification: Optional\[OwnershipVerification] This is a record which can be placed to activate a hostname. name: Optional\[str] DNS Name for record. Link to this property type: Optional\[Literal\["txt"]] DNS Record type. Link to this property value: Optional\[str] Content for the record. Link to this property
Link to this property
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. Link to this property http\_url: Optional\[str] 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: Optional\[SSL] id: Optional\[str] Custom hostname SSL identifier tag. maxLength36 minLength36 Link to this property 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. Link to this property certificate\_authority: Optional\[CertificateCA] The Certificate Authority that will issue the certificate. Link to this property custom\_certificate: Optional\[str] If a custom uploaded certificate is used. Link to this property custom\_csr\_id: Optional\[str] The identifier for the Custom CSR that was used. Link to this property custom\_key: Optional\[str] The key for a custom uploaded certificate. Link to this property
dcv\_delegation\_records: Optional\[List\[SsldcvDelegationRecord]] DCV Delegation records for domain validation. cname: Optional\[str] The CNAME record hostname for DCV delegation. Link to this property cname\_target: Optional\[str] The CNAME record target value for DCV delegation. Link to this property emails: Optional\[List\[str]] The set of email addresses that the certificate authority (CA) will use to complete domain validation. Link to this property http\_body: Optional\[str] 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: Optional\[str] The url that will be checked during domain validation. Link to this property status: Optional\[str] Status of the validation record. Link to this property txt\_name: Optional\[str] The hostname that the certificate authority (CA) will check for a TXT record during domain validation . Link to this property txt\_value: Optional\[str] The TXT record that the certificate authority (CA) will check during domain validation. Link to this property
Link to this property expires\_on: Optional\[datetime] The time the custom certificate expires on. formatdate-time Link to this property hosts: Optional\[List\[str]] A list of Hostnames on a custom uploaded certificate. Link to this property issuer: Optional\[str] The issuer on a custom uploaded certificate. Link to this property method: Optional\[DCVMethod] Domain control validation (DCV) method used for this hostname. Link to this property serial\_number: Optional\[str] The serial number on a custom uploaded certificate. Link to this property
settings: Optional\[SSLSettings] ciphers: Optional\[List\[str]] An allowlist of ciphers for TLS termination. These ciphers must be in the BoringSSL format. Link to this property
early\_hints: Optional\[Literal\["on", "off"]] Whether or not Early Hints is enabled. One of the following: "on" Link to this property "off" Link to this property
Link to this property
http2: Optional\[Literal\["on", "off"]] Whether or not HTTP2 is enabled. One of the following: "on" Link to this property "off" Link to this property
Link to this property
min\_tls\_version: Optional\[Literal\["1.0", "1.1", "1.2", "1.3"]] The minimum TLS version supported. One of the following: "1.0" Link to this property "1.1" Link to this property "1.2" Link to this property "1.3" Link to this property
Link to this property
tls\_1\_3: Optional\[Literal\["on", "off"]] Whether or not TLS 1.3 is enabled. One of the following: "on" Link to this property "off" Link to this property
Link to this property
Link to this property signature: Optional\[str] The signature on a custom uploaded certificate. Link to this property
status: Optional\[Literal\["initializing", "pending\_validation", "deleted", 18 more]] Status of the hostname’s SSL certificates. One of the following: "initializing" Link to this property "pending\_validation" Link to this property "deleted" Link to this property "pending\_issuance" Link to this property "pending\_deployment" Link to this property "pending\_deletion" Link to this property "pending\_expiration" Link to this property "expired" Link to this property "active" Link to this property "initializing\_timed\_out" Link to this property "validation\_timed\_out" Link to this property "issuance\_timed\_out" Link to this property "deployment\_timed\_out" Link to this property "deletion\_timed\_out" Link to this property "pending\_cleanup" Link to this property "staging\_deployment" Link to this property "staging\_active" Link to this property "deactivating" Link to this property "inactive" Link to this property "backup\_issued" Link to this property "holding\_deployment" Link to this property
Link to this property type: Optional\[DomainValidationType] Level of validation to be used for this hostname. Domain validation (dv) must be used. Link to this property uploaded\_on: Optional\[datetime] The time the custom certificate was uploaded. formatdate-time Link to this property
validation\_errors: Optional\[List\[SSLValidationError]] Domain validation errors that have been received by the certificate authority (CA). message: Optional\[str] A domain validation error. Link to this property
Link to this property
validation\_records: Optional\[List\[SSLValidationRecord]] cname: Optional\[str] The CNAME record hostname for DCV delegation. Link to this property cname\_target: Optional\[str] The CNAME record target value for DCV delegation. Link to this property emails: Optional\[List\[str]] The set of email addresses that the certificate authority (CA) will use to complete domain validation. Link to this property http\_body: Optional\[str] 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: Optional\[str] The url that will be checked during domain validation. Link to this property status: Optional\[str] Status of the validation record. Link to this property txt\_name: Optional\[str] The hostname that the certificate authority (CA) will check for a TXT record during domain validation . Link to this property txt\_value: Optional\[str] The TXT record that the certificate authority (CA) will check during domain validation. Link to this property
Link to this property wildcard: Optional\[bool] Indicates whether the certificate covers a wildcard. Link to this property
Link to this property
status: Optional\[Literal\["active", "pending", "active\_redeploying", 13 more]] Status of the hostname’s activation. One of the following: "active" Link to this property "pending" Link to this property "active\_redeploying" Link to this property "moved" Link to this property "pending\_deletion" Link to this property "deleted" Link to this property "pending\_blocked" Link to this property "pending\_migration" Link to this property "pending\_provisioned" Link to this property "test\_pending" Link to this property "test\_active" Link to this property "test\_active\_apex" Link to this property "test\_blocked" Link to this property "test\_failed" Link to this property "provisioned" Link to this property "blocked" Link to this property
Link to this property verification\_errors: Optional\[List\[str]] 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_create_response%20%3E%20(schema)>)
class CustomHostnameEditResponse: … id: str Custom hostname identifier tag. maxLength36 minLength36 Link to this property hostname: str The custom hostname that will point to your hostname via CNAME. maxLength255 Link to this property created\_at: Optional\[datetime] This is the time the hostname was created. formatdate-time Link to this property custom\_metadata: Optional\[Dict\[str, str]] Unique key/value metadata for this hostname. These are per-hostname (customer) settings. Link to this property custom\_origin\_server: Optional\[str] 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: 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. Link to this property
ownership\_verification: Optional\[OwnershipVerification] This is a record which can be placed to activate a hostname. name: Optional\[str] DNS Name for record. Link to this property type: Optional\[Literal\["txt"]] DNS Record type. Link to this property value: Optional\[str] Content for the record. Link to this property
Link to this property
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. Link to this property http\_url: Optional\[str] 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: Optional\[SSL] id: Optional\[str] Custom hostname SSL identifier tag. maxLength36 minLength36 Link to this property 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. Link to this property certificate\_authority: Optional\[CertificateCA] The Certificate Authority that will issue the certificate. Link to this property custom\_certificate: Optional\[str] If a custom uploaded certificate is used. Link to this property custom\_csr\_id: Optional\[str] The identifier for the Custom CSR that was used. Link to this property custom\_key: Optional\[str] The key for a custom uploaded certificate. Link to this property
dcv\_delegation\_records: Optional\[List\[SsldcvDelegationRecord]] DCV Delegation records for domain validation. cname: Optional\[str] The CNAME record hostname for DCV delegation. Link to this property cname\_target: Optional\[str] The CNAME record target value for DCV delegation. Link to this property emails: Optional\[List\[str]] The set of email addresses that the certificate authority (CA) will use to complete domain validation. Link to this property http\_body: Optional\[str] 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: Optional\[str] The url that will be checked during domain validation. Link to this property status: Optional\[str] Status of the validation record. Link to this property txt\_name: Optional\[str] The hostname that the certificate authority (CA) will check for a TXT record during domain validation . Link to this property txt\_value: Optional\[str] The TXT record that the certificate authority (CA) will check during domain validation. Link to this property
Link to this property expires\_on: Optional\[datetime] The time the custom certificate expires on. formatdate-time Link to this property hosts: Optional\[List\[str]] A list of Hostnames on a custom uploaded certificate. Link to this property issuer: Optional\[str] The issuer on a custom uploaded certificate. Link to this property method: Optional\[DCVMethod] Domain control validation (DCV) method used for this hostname. Link to this property serial\_number: Optional\[str] The serial number on a custom uploaded certificate. Link to this property
settings: Optional\[SSLSettings] ciphers: Optional\[List\[str]] An allowlist of ciphers for TLS termination. These ciphers must be in the BoringSSL format. Link to this property
early\_hints: Optional\[Literal\["on", "off"]] Whether or not Early Hints is enabled. One of the following: "on" Link to this property "off" Link to this property
Link to this property
http2: Optional\[Literal\["on", "off"]] Whether or not HTTP2 is enabled. One of the following: "on" Link to this property "off" Link to this property
Link to this property
min\_tls\_version: Optional\[Literal\["1.0", "1.1", "1.2", "1.3"]] The minimum TLS version supported. One of the following: "1.0" Link to this property "1.1" Link to this property "1.2" Link to this property "1.3" Link to this property
Link to this property
tls\_1\_3: Optional\[Literal\["on", "off"]] Whether or not TLS 1.3 is enabled. One of the following: "on" Link to this property "off" Link to this property
Link to this property
Link to this property signature: Optional\[str] The signature on a custom uploaded certificate. Link to this property
status: Optional\[Literal\["initializing", "pending\_validation", "deleted", 18 more]] Status of the hostname’s SSL certificates. One of the following: "initializing" Link to this property "pending\_validation" Link to this property "deleted" Link to this property "pending\_issuance" Link to this property "pending\_deployment" Link to this property "pending\_deletion" Link to this property "pending\_expiration" Link to this property "expired" Link to this property "active" Link to this property "initializing\_timed\_out" Link to this property "validation\_timed\_out" Link to this property "issuance\_timed\_out" Link to this property "deployment\_timed\_out" Link to this property "deletion\_timed\_out" Link to this property "pending\_cleanup" Link to this property "staging\_deployment" Link to this property "staging\_active" Link to this property "deactivating" Link to this property "inactive" Link to this property "backup\_issued" Link to this property "holding\_deployment" Link to this property
Link to this property type: Optional\[DomainValidationType] Level of validation to be used for this hostname. Domain validation (dv) must be used. Link to this property uploaded\_on: Optional\[datetime] The time the custom certificate was uploaded. formatdate-time Link to this property
validation\_errors: Optional\[List\[SSLValidationError]] Domain validation errors that have been received by the certificate authority (CA). message: Optional\[str] A domain validation error. Link to this property
Link to this property
validation\_records: Optional\[List\[SSLValidationRecord]] cname: Optional\[str] The CNAME record hostname for DCV delegation. Link to this property cname\_target: Optional\[str] The CNAME record target value for DCV delegation. Link to this property emails: Optional\[List\[str]] The set of email addresses that the certificate authority (CA) will use to complete domain validation. Link to this property http\_body: Optional\[str] 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: Optional\[str] The url that will be checked during domain validation. Link to this property status: Optional\[str] Status of the validation record. Link to this property txt\_name: Optional\[str] The hostname that the certificate authority (CA) will check for a TXT record during domain validation . Link to this property txt\_value: Optional\[str] The TXT record that the certificate authority (CA) will check during domain validation. Link to this property
Link to this property wildcard: Optional\[bool] Indicates whether the certificate covers a wildcard. Link to this property
Link to this property
status: Optional\[Literal\["active", "pending", "active\_redeploying", 13 more]] Status of the hostname’s activation. One of the following: "active" Link to this property "pending" Link to this property "active\_redeploying" Link to this property "moved" Link to this property "pending\_deletion" Link to this property "deleted" Link to this property "pending\_blocked" Link to this property "pending\_migration" Link to this property "pending\_provisioned" Link to this property "test\_pending" Link to this property "test\_active" Link to this property "test\_active\_apex" Link to this property "test\_blocked" Link to this property "test\_failed" Link to this property "provisioned" Link to this property "blocked" Link to this property
Link to this property verification\_errors: Optional\[List\[str]] 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_edit_response%20%3E%20(schema)>)
class CustomHostnameDeleteResponse: … id: Optional\[str] Custom hostname identifier tag. maxLength36 minLength36 Link to this property
[Link to this property](<#(resource)%20custom_hostnames%20%3E%20(model)%20custom_hostname_delete_response%20%3E%20(schema)>) #### Custom HostnamesFallback Origin ##### [Get Fallback Origin for Custom Hostnames](https://developers.cloudflare.com/api/python/resources/custom_hostnames/subresources/fallback_origin/methods/get) custom\_hostnames.fallback\_origin.get(FallbackOriginGetParams\*\*kwargs) -> [FallbackOriginGetResponse]() GET/zones/{zone\_id}/custom\_hostnames/fallback\_origin ##### [Update Fallback Origin for Custom Hostnames](https://developers.cloudflare.com/api/python/resources/custom_hostnames/subresources/fallback_origin/methods/update) custom\_hostnames.fallback\_origin.update(FallbackOriginUpdateParams\*\*kwargs) -> [FallbackOriginUpdateResponse]() PUT/zones/{zone\_id}/custom\_hostnames/fallback\_origin ##### [Delete Fallback Origin for Custom Hostnames](https://developers.cloudflare.com/api/python/resources/custom_hostnames/subresources/fallback_origin/methods/delete) 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 Link to this property errors: Optional\[List\[str]] These are errors that were encountered while trying to activate a fallback origin. Link to this property origin: Optional\[str] Your origin hostname that requests to your custom hostnames will be sent to. maxLength255 Link to this property
status: Optional\[Literal\["initializing", "pending\_deployment", "pending\_deletion", 3 more]] Status of the fallback origin’s activation. One of the following: "initializing" Link to this property "pending\_deployment" Link to this property "pending\_deletion" Link to this property "active" Link to this property "deployment\_timed\_out" Link to this property "deletion\_timed\_out" Link to this property
Link to this property updated\_at: Optional\[datetime] This is the time the fallback origin was updated. formatdate-time Link to this property
[Link to this property](<#(resource)%20custom_hostnames.fallback_origin%20%3E%20(model)%20fallback_origin_get_response%20%3E%20(schema)>)
class FallbackOriginUpdateResponse: … created\_at: Optional\[datetime] This is the time the fallback origin was created. formatdate-time Link to this property errors: Optional\[List\[str]] These are errors that were encountered while trying to activate a fallback origin. Link to this property origin: Optional\[str] Your origin hostname that requests to your custom hostnames will be sent to. maxLength255 Link to this property
status: Optional\[Literal\["initializing", "pending\_deployment", "pending\_deletion", 3 more]] Status of the fallback origin’s activation. One of the following: "initializing" Link to this property "pending\_deployment" Link to this property "pending\_deletion" Link to this property "active" Link to this property "deployment\_timed\_out" Link to this property "deletion\_timed\_out" Link to this property
Link to this property updated\_at: Optional\[datetime] This is the time the fallback origin was updated. formatdate-time Link to this property
[Link to this property](<#(resource)%20custom_hostnames.fallback_origin%20%3E%20(model)%20fallback_origin_update_response%20%3E%20(schema)>)
class FallbackOriginDeleteResponse: … created\_at: Optional\[datetime] This is the time the fallback origin was created. formatdate-time Link to this property errors: Optional\[List\[str]] These are errors that were encountered while trying to activate a fallback origin. Link to this property origin: Optional\[str] Your origin hostname that requests to your custom hostnames will be sent to. maxLength255 Link to this property
status: Optional\[Literal\["initializing", "pending\_deployment", "pending\_deletion", 3 more]] Status of the fallback origin’s activation. One of the following: "initializing" Link to this property "pending\_deployment" Link to this property "pending\_deletion" Link to this property "active" Link to this property "deployment\_timed\_out" Link to this property "deletion\_timed\_out" Link to this property
Link to this property updated\_at: Optional\[datetime] This is the time the fallback origin was updated. formatdate-time Link to this property
[Link to this property](<#(resource)%20custom_hostnames.fallback_origin%20%3E%20(model)%20fallback_origin_delete_response%20%3E%20(schema)>) #### Custom HostnamesCertificate Pack #### Custom HostnamesCertificate PackCertificates ##### [Replace Custom Certificate and Custom Key In Custom Hostname](https://developers.cloudflare.com/api/python/resources/custom_hostnames/subresources/certificate_pack/subresources/certificates/methods/update) 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](https://developers.cloudflare.com/api/python/resources/custom_hostnames/subresources/certificate_pack/subresources/certificates/methods/delete) 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 Custom hostname identifier tag. maxLength36 minLength36 Link to this property hostname: str The custom hostname that will point to your hostname via CNAME. maxLength255 Link to this property created\_at: Optional\[datetime] This is the time the hostname was created. formatdate-time Link to this property custom\_metadata: Optional\[Dict\[str, str]] Unique key/value metadata for this hostname. These are per-hostname (customer) settings. Link to this property custom\_origin\_server: Optional\[str] 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: 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. Link to this property
ownership\_verification: Optional\[OwnershipVerification] This is a record which can be placed to activate a hostname. name: Optional\[str] DNS Name for record. Link to this property type: Optional\[Literal\["txt"]] DNS Record type. Link to this property value: Optional\[str] Content for the record. Link to this property
Link to this property
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. Link to this property http\_url: Optional\[str] 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: Optional\[SSL] id: Optional\[str] Custom hostname SSL identifier tag. maxLength36 minLength36 Link to this property 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. Link to this property certificate\_authority: Optional\[CertificateCA] The Certificate Authority that will issue the certificate. Link to this property custom\_certificate: Optional\[str] If a custom uploaded certificate is used. Link to this property custom\_csr\_id: Optional\[str] The identifier for the Custom CSR that was used. Link to this property custom\_key: Optional\[str] The key for a custom uploaded certificate. Link to this property
dcv\_delegation\_records: Optional\[List\[SsldcvDelegationRecord]] DCV Delegation records for domain validation. cname: Optional\[str] The CNAME record hostname for DCV delegation. Link to this property cname\_target: Optional\[str] The CNAME record target value for DCV delegation. Link to this property emails: Optional\[List\[str]] The set of email addresses that the certificate authority (CA) will use to complete domain validation. Link to this property http\_body: Optional\[str] 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: Optional\[str] The url that will be checked during domain validation. Link to this property status: Optional\[str] Status of the validation record. Link to this property txt\_name: Optional\[str] The hostname that the certificate authority (CA) will check for a TXT record during domain validation . Link to this property txt\_value: Optional\[str] The TXT record that the certificate authority (CA) will check during domain validation. Link to this property
Link to this property expires\_on: Optional\[datetime] The time the custom certificate expires on. formatdate-time Link to this property hosts: Optional\[List\[str]] A list of Hostnames on a custom uploaded certificate. Link to this property issuer: Optional\[str] The issuer on a custom uploaded certificate. Link to this property method: Optional\[DCVMethod] Domain control validation (DCV) method used for this hostname. Link to this property serial\_number: Optional\[str] The serial number on a custom uploaded certificate. Link to this property
settings: Optional\[SSLSettings] ciphers: Optional\[List\[str]] An allowlist of ciphers for TLS termination. These ciphers must be in the BoringSSL format. Link to this property
early\_hints: Optional\[Literal\["on", "off"]] Whether or not Early Hints is enabled. One of the following: "on" Link to this property "off" Link to this property
Link to this property
http2: Optional\[Literal\["on", "off"]] Whether or not HTTP2 is enabled. One of the following: "on" Link to this property "off" Link to this property
Link to this property
min\_tls\_version: Optional\[Literal\["1.0", "1.1", "1.2", "1.3"]] The minimum TLS version supported. One of the following: "1.0" Link to this property "1.1" Link to this property "1.2" Link to this property "1.3" Link to this property
Link to this property
tls\_1\_3: Optional\[Literal\["on", "off"]] Whether or not TLS 1.3 is enabled. One of the following: "on" Link to this property "off" Link to this property
Link to this property
Link to this property signature: Optional\[str] The signature on a custom uploaded certificate. Link to this property
status: Optional\[Literal\["initializing", "pending\_validation", "deleted", 18 more]] Status of the hostname’s SSL certificates. One of the following: "initializing" Link to this property "pending\_validation" Link to this property "deleted" Link to this property "pending\_issuance" Link to this property "pending\_deployment" Link to this property "pending\_deletion" Link to this property "pending\_expiration" Link to this property "expired" Link to this property "active" Link to this property "initializing\_timed\_out" Link to this property "validation\_timed\_out" Link to this property "issuance\_timed\_out" Link to this property "deployment\_timed\_out" Link to this property "deletion\_timed\_out" Link to this property "pending\_cleanup" Link to this property "staging\_deployment" Link to this property "staging\_active" Link to this property "deactivating" Link to this property "inactive" Link to this property "backup\_issued" Link to this property "holding\_deployment" Link to this property
Link to this property type: Optional\[DomainValidationType] Level of validation to be used for this hostname. Domain validation (dv) must be used. Link to this property uploaded\_on: Optional\[datetime] The time the custom certificate was uploaded. formatdate-time Link to this property
validation\_errors: Optional\[List\[SSLValidationError]] Domain validation errors that have been received by the certificate authority (CA). message: Optional\[str] A domain validation error. Link to this property
Link to this property
validation\_records: Optional\[List\[SSLValidationRecord]] cname: Optional\[str] The CNAME record hostname for DCV delegation. Link to this property cname\_target: Optional\[str] The CNAME record target value for DCV delegation. Link to this property emails: Optional\[List\[str]] The set of email addresses that the certificate authority (CA) will use to complete domain validation. Link to this property http\_body: Optional\[str] 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: Optional\[str] The url that will be checked during domain validation. Link to this property status: Optional\[str] Status of the validation record. Link to this property txt\_name: Optional\[str] The hostname that the certificate authority (CA) will check for a TXT record during domain validation . Link to this property txt\_value: Optional\[str] The TXT record that the certificate authority (CA) will check during domain validation. Link to this property
Link to this property wildcard: Optional\[bool] Indicates whether the certificate covers a wildcard. Link to this property
Link to this property
status: Optional\[Literal\["active", "pending", "active\_redeploying", 13 more]] Status of the hostname’s activation. One of the following: "active" Link to this property "pending" Link to this property "active\_redeploying" Link to this property "moved" Link to this property "pending\_deletion" Link to this property "deleted" Link to this property "pending\_blocked" Link to this property "pending\_migration" Link to this property "pending\_provisioned" Link to this property "test\_pending" Link to this property "test\_active" Link to this property "test\_active\_apex" Link to this property "test\_blocked" Link to this property "test\_failed" Link to this property "provisioned" Link to this property "blocked" Link to this property
Link to this property verification\_errors: Optional\[List\[str]] These are errors that were encountered while trying to activate a hostname. Link to this property
[Link to this property](<#(resource)%20custom_hostnames.certificate_pack.certificates%20%3E%20(model)%20certificate_update_response%20%3E%20(schema)>)
class CertificateDeleteResponse: … id: Optional\[str] Custom hostname identifier tag. maxLength36 minLength36 Link to this property
[Link to this property](<#(resource)%20custom_hostnames.certificate_pack.certificates%20%3E%20(model)%20certificate_delete_response%20%3E%20(schema)>) #### Custom HostnamesQuota ##### [Get Custom Hostname Quota](https://developers.cloudflare.com/api/python/resources/custom_hostnames/subresources/quota/methods/get) custom\_hostnames.quota.get(QuotaGetParams\*\*kwargs) -> [QuotaGetResponse]() GET/zones/{zone\_id}/custom\_hostnames/quota ##### ModelsExpand Collapse
class QuotaGetResponse: … allocated: int The allocated custom hostname quota. formatint64 Link to this property exceeded: bool Whether the current usage has exceeded the allocated quota. Link to this property hard\_cap: int The maximum number of custom hostnames allowed before create requests are rejected. formatint64 Link to this property used: int The number of custom hostnames currently in use. formatint64 Link to this property
[Link to this property](<#(resource)%20custom_hostnames.quota%20%3E%20(model)%20quota_get_response%20%3E%20(schema)>)