--- title: Edit Custom Hostname --- [Skip to content](#_top) [API Reference](https://developers.cloudflare.com/api/go) [Custom Hostnames](https://developers.cloudflare.com/api/go/resources/custom_hostnames) Copy Markdown Open in **Claude**Open in **ChatGPT**Open in **Cursor** --- **Copy Markdown****View as Markdown** # Edit Custom Hostname client.CustomHostnames.Edit(ctx, customHostnameID, params) (\*[CustomHostnameEditResponse](), error) PATCH/zones/{zone\_id}/custom\_hostnames/{custom\_hostname\_id} Modify SSL configuration for a custom hostname. When sent with SSL config that matches existing config, used to indicate that hostname should pass domain control validation (DCV). Can also be used to change validation type, e.g., from ‘http’ to ‘email’. Bundle an existing certificate with another certificate by using the “custom\_cert\_bundle” field. The bundling process supports combining certificates as long as the following condition is met. One certificate must use the RSA algorithm, and the other must use the ECDSA algorithm. ##### Security

API Token

The preferred authorization scheme for interacting with the Cloudflare API. Create a token. **Example:**Authorization: Bearer Sn3lZJTBX6kkg7OdcBUAxOO963GEIyGQqnFTOFYY

API Email + API Key

The previous authorization scheme for interacting with the Cloudflare API, used in conjunction with a Global API key. **Example:**X-Auth-Email: user@example.com The previous authorization scheme for interacting with the Cloudflare API. When possible, use API tokens instead of Global API keys. **Example:**X-Auth-Key: 144c9defac04969c7bfad8efaa8ea194

##### Accepted Permissions (at least one required) `SSL and Certificates Write` ##### ParametersExpand Collapse customHostnameID string Custom hostname identifier tag. maxLength36 minLength36 [Link to this property](<#(resource)%20custom_hostnames%20%3E%20(method)%20edit%20%3E%20(params)%20default%20%3E%20(param)%20custom_hostname_id%20%3E%20(schema)>)

params CustomHostnameEditParams

ZoneID param.Field\[string] Path param: Identifier. maxLength32 Link to this property CustomMetadata param.Field\[map\[string, string]]Optional Body param: Unique key/value metadata for this hostname. These are per-hostname (customer) settings. Link to this property CustomOriginServer param.Field\[string]Optional Body param: a valid hostname that’s been added to your DNS zone as an A, AAAA, or CNAME record. Link to this property CustomOriginSNI param.Field\[string]Optional Body param: 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

SSL param.Field\[CustomHostnameEditParamsSSL]Optional Body param: SSL properties used when creating the custom hostname.

BundleMethod BundleMethodOptional A ubiquitous bundle has the highest probability of being verified everywhere, even by clients using outdated or unusual trust stores. An optimal bundle uses the shortest chain and newest intermediates. And the force bundle verifies the chain, but does not otherwise modify it.

One of the following: const BundleMethodUbiquitous BundleMethod = "ubiquitous" Link to this property const BundleMethodOptimal BundleMethod = "optimal" Link to this property const BundleMethodForce BundleMethod = "force" Link to this property

Link to this property

CertificateAuthority CertificateCAOptional The Certificate Authority that will issue the certificate.

One of the following: const CertificateCADigicert CertificateCA = "digicert" Link to this property const CertificateCAGoogle CertificateCA = "google" Link to this property const CertificateCALetsEncrypt CertificateCA = "lets\_encrypt" Link to this property const CertificateCASSLCom CertificateCA = "ssl\_com" Link to this property

Link to this property CloudflareBranding boolOptional 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

CustomCERTBundle \[]CustomHostnameEditParamsSSLCustomCERTBundleOptional Array of custom certificate and key pairs (1 or 2 pairs allowed).

CustomCertificate string If a custom uploaded certificate is used. Link to this property CustomKey string The key for a custom uploaded certificate. Link to this property

Link to this property CustomCertificate stringOptional If a custom uploaded certificate is used. Link to this property CustomCsrID stringOptional The identifier for the Custom CSR that was used. Link to this property CustomKey stringOptional The key for a custom uploaded certificate. Link to this property

Method DCVMethodOptional Domain control validation (DCV) method used for this hostname.

One of the following: const DCVMethodHTTP DCVMethod = "http" Link to this property const DCVMethodTXT DCVMethod = "txt" Link to this property const DCVMethodEmail DCVMethod = "email" Link to this property

Link to this property

Settings CustomHostnameEditParamsSSLSettingsOptional SSL specific settings.

Ciphers \[]stringOptional An allowlist of ciphers for TLS termination. These ciphers must be in the BoringSSL format. Link to this property

EarlyHints CustomHostnameEditParamsSSLSettingsEarlyHintsOptional Whether or not Early Hints is enabled.

One of the following: const CustomHostnameEditParamsSSLSettingsEarlyHintsOn CustomHostnameEditParamsSSLSettingsEarlyHints = "on" Link to this property const CustomHostnameEditParamsSSLSettingsEarlyHintsOff CustomHostnameEditParamsSSLSettingsEarlyHints = "off" Link to this property

Link to this property

HTTP2 CustomHostnameEditParamsSSLSettingsHTTP2Optional Whether or not HTTP2 is enabled.

One of the following: const CustomHostnameEditParamsSSLSettingsHTTP2On CustomHostnameEditParamsSSLSettingsHTTP2 = "on" Link to this property const CustomHostnameEditParamsSSLSettingsHTTP2Off CustomHostnameEditParamsSSLSettingsHTTP2 = "off" Link to this property

Link to this property

MinTLSVersion CustomHostnameEditParamsSSLSettingsMinTLSVersionOptional The minimum TLS version supported.

One of the following: const CustomHostnameEditParamsSSLSettingsMinTLSVersion1\_0 CustomHostnameEditParamsSSLSettingsMinTLSVersion = "1.0" Link to this property const CustomHostnameEditParamsSSLSettingsMinTLSVersion1\_1 CustomHostnameEditParamsSSLSettingsMinTLSVersion = "1.1" Link to this property const CustomHostnameEditParamsSSLSettingsMinTLSVersion1\_2 CustomHostnameEditParamsSSLSettingsMinTLSVersion = "1.2" Link to this property const CustomHostnameEditParamsSSLSettingsMinTLSVersion1\_3 CustomHostnameEditParamsSSLSettingsMinTLSVersion = "1.3" Link to this property

Link to this property

TLS1\_3 CustomHostnameEditParamsSSLSettingsTLS1\_3Optional Whether or not TLS 1.3 is enabled.

One of the following: const CustomHostnameEditParamsSSLSettingsTLS1\_3On CustomHostnameEditParamsSSLSettingsTLS1\_3 = "on" Link to this property const CustomHostnameEditParamsSSLSettingsTLS1\_3Off CustomHostnameEditParamsSSLSettingsTLS1\_3 = "off" Link to this property

Link to this property

Link to this property Type DomainValidationTypeOptional Level of validation to be used for this hostname. Domain validation (dv) must be used. Link to this property Wildcard boolOptional Indicates whether the certificate covers a wildcard. Link to this property

Link to this property

[Link to this property](<#(resource)%20custom_hostnames%20%3E%20(method)%20edit%20%3E%20(params)%20default>) ##### ReturnsExpand Collapse

type CustomHostnameEditResponse struct{…}

ID string Custom hostname identifier tag. maxLength36 minLength36 Link to this property Hostname string The custom hostname that will point to your hostname via CNAME. maxLength255 Link to this property CreatedAt TimeOptional This is the time the hostname was created. formatdate-time Link to this property CustomMetadata map\[string, string]Optional Unique key/value metadata for this hostname. These are per-hostname (customer) settings. Link to this property CustomOriginServer stringOptional a valid hostname that’s been added to your DNS zone as an A, AAAA, or CNAME record. Link to this property CustomOriginSNI stringOptional A hostname that will be sent to your custom origin server as SNI for TLS handshake. This can be a valid subdomain of the zone or custom origin server name or the string ‘:request\_host\_header:’ which will cause the host header in the request to be used as SNI. Not configurable with default/fallback origin server. Link to this property

OwnershipVerification CustomHostnameEditResponseOwnershipVerificationOptional This is a record which can be placed to activate a hostname.

Name stringOptional DNS Name for record. Link to this property Type CustomHostnameEditResponseOwnershipVerificationTypeOptional DNS Record type. Link to this property Value stringOptional Content for the record. Link to this property

Link to this property

OwnershipVerificationHTTP CustomHostnameEditResponseOwnershipVerificationHTTPOptional This presents the token to be served by the given http url to activate a hostname.

HTTPBody stringOptional Token to be served. Link to this property HTTPURL stringOptional The HTTP URL that will be checked during custom hostname verification and where the customer should host the token. Link to this property

Link to this property

SSL CustomHostnameEditResponseSSLOptional

ID stringOptional Custom hostname SSL identifier tag. maxLength36 minLength36 Link to this property

Link to this property

CertificateAuthority CertificateCAOptional The Certificate Authority that will issue the certificate.

DCVDelegationRecords \[]CustomHostnameEditResponseSsldcvDelegationRecordOptional DCV Delegation records for domain validation.

CNAME stringOptional The CNAME record hostname for DCV delegation. Link to this property CNAMETarget stringOptional The CNAME record target value for DCV delegation. Link to this property Emails \[]stringOptional The set of email addresses that the certificate authority (CA) will use to complete domain validation. Link to this property HTTPBody stringOptional The content that the certificate authority (CA) will expect to find at the http\_url during the domain validation. Link to this property HTTPURL stringOptional The url that will be checked during domain validation. Link to this property Status stringOptional Status of the validation record. Link to this property TXTName stringOptional The hostname that the certificate authority (CA) will check for a TXT record during domain validation . Link to this property TXTValue stringOptional The TXT record that the certificate authority (CA) will check during domain validation. Link to this property

Link to this property ExpiresOn TimeOptional The time the custom certificate expires on. formatdate-time Link to this property Hosts \[]stringOptional A list of Hostnames on a custom uploaded certificate. Link to this property Issuer stringOptional The issuer on a custom uploaded certificate. Link to this property

Method DCVMethodOptional Domain control validation (DCV) method used for this hostname.

Link to this property SerialNumber stringOptional The serial number on a custom uploaded certificate. Link to this property

Settings CustomHostnameEditResponseSSLSettingsOptional

Ciphers \[]stringOptional An allowlist of ciphers for TLS termination. These ciphers must be in the BoringSSL format. Link to this property

EarlyHints CustomHostnameEditResponseSSLSettingsEarlyHintsOptional Whether or not Early Hints is enabled.

One of the following: const CustomHostnameEditResponseSSLSettingsEarlyHintsOn CustomHostnameEditResponseSSLSettingsEarlyHints = "on" Link to this property const CustomHostnameEditResponseSSLSettingsEarlyHintsOff CustomHostnameEditResponseSSLSettingsEarlyHints = "off" Link to this property

Link to this property

HTTP2 CustomHostnameEditResponseSSLSettingsHTTP2Optional Whether or not HTTP2 is enabled.

One of the following: const CustomHostnameEditResponseSSLSettingsHTTP2On CustomHostnameEditResponseSSLSettingsHTTP2 = "on" Link to this property const CustomHostnameEditResponseSSLSettingsHTTP2Off CustomHostnameEditResponseSSLSettingsHTTP2 = "off" Link to this property

Link to this property

MinTLSVersion CustomHostnameEditResponseSSLSettingsMinTLSVersionOptional The minimum TLS version supported.

One of the following: const CustomHostnameEditResponseSSLSettingsMinTLSVersion1\_0 CustomHostnameEditResponseSSLSettingsMinTLSVersion = "1.0" Link to this property const CustomHostnameEditResponseSSLSettingsMinTLSVersion1\_1 CustomHostnameEditResponseSSLSettingsMinTLSVersion = "1.1" Link to this property const CustomHostnameEditResponseSSLSettingsMinTLSVersion1\_2 CustomHostnameEditResponseSSLSettingsMinTLSVersion = "1.2" Link to this property const CustomHostnameEditResponseSSLSettingsMinTLSVersion1\_3 CustomHostnameEditResponseSSLSettingsMinTLSVersion = "1.3" Link to this property

Link to this property

TLS1\_3 CustomHostnameEditResponseSSLSettingsTLS1\_3Optional Whether or not TLS 1.3 is enabled.

One of the following: const CustomHostnameEditResponseSSLSettingsTLS1\_3On CustomHostnameEditResponseSSLSettingsTLS1\_3 = "on" Link to this property const CustomHostnameEditResponseSSLSettingsTLS1\_3Off CustomHostnameEditResponseSSLSettingsTLS1\_3 = "off" Link to this property

Link to this property

Link to this property Signature stringOptional The signature on a custom uploaded certificate. Link to this property

Status CustomHostnameEditResponseSSLStatusOptional Status of the hostname’s SSL certificates.

One of the following: const CustomHostnameEditResponseSSLStatusInitializing CustomHostnameEditResponseSSLStatus = "initializing" Link to this property const CustomHostnameEditResponseSSLStatusPendingValidation CustomHostnameEditResponseSSLStatus = "pending\_validation" Link to this property const CustomHostnameEditResponseSSLStatusDeleted CustomHostnameEditResponseSSLStatus = "deleted" Link to this property const CustomHostnameEditResponseSSLStatusPendingIssuance CustomHostnameEditResponseSSLStatus = "pending\_issuance" Link to this property const CustomHostnameEditResponseSSLStatusPendingDeployment CustomHostnameEditResponseSSLStatus = "pending\_deployment" Link to this property const CustomHostnameEditResponseSSLStatusPendingDeletion CustomHostnameEditResponseSSLStatus = "pending\_deletion" Link to this property const CustomHostnameEditResponseSSLStatusPendingExpiration CustomHostnameEditResponseSSLStatus = "pending\_expiration" Link to this property const CustomHostnameEditResponseSSLStatusExpired CustomHostnameEditResponseSSLStatus = "expired" Link to this property const CustomHostnameEditResponseSSLStatusActive CustomHostnameEditResponseSSLStatus = "active" Link to this property const CustomHostnameEditResponseSSLStatusInitializingTimedOut CustomHostnameEditResponseSSLStatus = "initializing\_timed\_out" Link to this property const CustomHostnameEditResponseSSLStatusValidationTimedOut CustomHostnameEditResponseSSLStatus = "validation\_timed\_out" Link to this property const CustomHostnameEditResponseSSLStatusIssuanceTimedOut CustomHostnameEditResponseSSLStatus = "issuance\_timed\_out" Link to this property const CustomHostnameEditResponseSSLStatusDeploymentTimedOut CustomHostnameEditResponseSSLStatus = "deployment\_timed\_out" Link to this property const CustomHostnameEditResponseSSLStatusDeletionTimedOut CustomHostnameEditResponseSSLStatus = "deletion\_timed\_out" Link to this property const CustomHostnameEditResponseSSLStatusPendingCleanup CustomHostnameEditResponseSSLStatus = "pending\_cleanup" Link to this property const CustomHostnameEditResponseSSLStatusStagingDeployment CustomHostnameEditResponseSSLStatus = "staging\_deployment" Link to this property const CustomHostnameEditResponseSSLStatusStagingActive CustomHostnameEditResponseSSLStatus = "staging\_active" Link to this property const CustomHostnameEditResponseSSLStatusDeactivating CustomHostnameEditResponseSSLStatus = "deactivating" Link to this property const CustomHostnameEditResponseSSLStatusInactive CustomHostnameEditResponseSSLStatus = "inactive" Link to this property const CustomHostnameEditResponseSSLStatusBackupIssued CustomHostnameEditResponseSSLStatus = "backup\_issued" Link to this property const CustomHostnameEditResponseSSLStatusHoldingDeployment CustomHostnameEditResponseSSLStatus = "holding\_deployment" Link to this property

Link to this property Type DomainValidationTypeOptional Level of validation to be used for this hostname. Domain validation (dv) must be used. Link to this property UploadedOn TimeOptional The time the custom certificate was uploaded. formatdate-time Link to this property

ValidationErrors \[]CustomHostnameEditResponseSSLValidationErrorOptional Domain validation errors that have been received by the certificate authority (CA).

Message stringOptional A domain validation error. Link to this property

Link to this property

ValidationRecords \[]CustomHostnameEditResponseSSLValidationRecordOptional

Link to this property Wildcard boolOptional Indicates whether the certificate covers a wildcard. Link to this property

Link to this property

Status CustomHostnameEditResponseStatusOptional Status of the hostname’s activation.

One of the following: const CustomHostnameEditResponseStatusActive CustomHostnameEditResponseStatus = "active" Link to this property const CustomHostnameEditResponseStatusPending CustomHostnameEditResponseStatus = "pending" Link to this property const CustomHostnameEditResponseStatusActiveRedeploying CustomHostnameEditResponseStatus = "active\_redeploying" Link to this property const CustomHostnameEditResponseStatusMoved CustomHostnameEditResponseStatus = "moved" Link to this property const CustomHostnameEditResponseStatusPendingDeletion CustomHostnameEditResponseStatus = "pending\_deletion" Link to this property const CustomHostnameEditResponseStatusDeleted CustomHostnameEditResponseStatus = "deleted" Link to this property const CustomHostnameEditResponseStatusPendingBlocked CustomHostnameEditResponseStatus = "pending\_blocked" Link to this property const CustomHostnameEditResponseStatusPendingMigration CustomHostnameEditResponseStatus = "pending\_migration" Link to this property const CustomHostnameEditResponseStatusPendingProvisioned CustomHostnameEditResponseStatus = "pending\_provisioned" Link to this property const CustomHostnameEditResponseStatusTestPending CustomHostnameEditResponseStatus = "test\_pending" Link to this property const CustomHostnameEditResponseStatusTestActive CustomHostnameEditResponseStatus = "test\_active" Link to this property const CustomHostnameEditResponseStatusTestActiveApex CustomHostnameEditResponseStatus = "test\_active\_apex" Link to this property const CustomHostnameEditResponseStatusTestBlocked CustomHostnameEditResponseStatus = "test\_blocked" Link to this property const CustomHostnameEditResponseStatusTestFailed CustomHostnameEditResponseStatus = "test\_failed" Link to this property const CustomHostnameEditResponseStatusProvisioned CustomHostnameEditResponseStatus = "provisioned" Link to this property const CustomHostnameEditResponseStatusBlocked CustomHostnameEditResponseStatus = "blocked" Link to this property

Link to this property VerificationErrors \[]stringOptional These are errors that were encountered while trying to activate a hostname. Link to this property

[Link to this property](<#(resource)%20custom_hostnames%20%3E%20(model)%20CustomHostnameEditResponse%20%3E%20(schema)>) ### Edit Custom Hostname Go HTTPTypeScriptPythonGoTerraform ``` package main import ( "context" "fmt" "github.com/cloudflare/cloudflare-go" "github.com/cloudflare/cloudflare-go/custom_hostnames" "github.com/cloudflare/cloudflare-go/option" ) func main() { client := cloudflare.NewClient( option.WithAPIToken("Sn3lZJTBX6kkg7OdcBUAxOO963GEIyGQqnFTOFYY"), ) response, err := client.CustomHostnames.Edit( context.TODO(), "0d89c70d-ad9f-4843-b99f-6cc0252067e9", custom_hostnames.CustomHostnameEditParams{ ZoneID: cloudflare.F("023e105f4ecef8ad9ca31a8372d0c353"), }, ) if err != nil { panic(err.Error()) } fmt.Printf("%+v\n", response.ID) } ``` 200 example ``` { "errors": [ { "code": 1000, "message": "message", "documentation_url": "documentation_url", "source": { "pointer": "pointer" } } ], "messages": [ "string" ], "success": true, "result": { "id": "0d89c70d-ad9f-4843-b99f-6cc0252067e9", "hostname": "app.example.com", "created_at": "2020-02-06T18:11:23.531995Z", "custom_metadata": { "foo": "string" }, "custom_origin_server": "origin2.example.com", "custom_origin_sni": "sni.example.com", "ownership_verification": { "name": "_cf-custom-hostname.app.example.com", "type": "txt", "value": "5cc07c04-ea62-4a5a-95f0-419334a875a4" }, "ownership_verification_http": { "http_body": "5cc07c04-ea62-4a5a-95f0-419334a875a4", "http_url": "http://custom.test.com/.well-known/cf-custom-hostname-challenge/0d89c70d-ad9f-4843-b99f-6cc0252067e9" }, "ssl": { "id": "0d89c70d-ad9f-4843-b99f-6cc0252067e9", "bundle_method": "ubiquitous", "certificate_authority": "google", "custom_certificate": "-----BEGIN CERTIFICATE-----\nMIIFJDCCBAygAwIBAgIQD0ifmj/Yi5NP/2gdUySbfzANBgkqhkiG9w0BAQsFADBN\nMQswCQYDVQQGEwJVUzEVMBMGA1UEChMMRGlnaUNlcnQgSW5jMScwJQYDVQQDEx5E...SzSHfXp5lnu/3V08I72q1QNzOCgY1XeL4GKVcj4or6cT6tX6oJH7ePPmfrBfqI/O\nOeH8gMJ+FuwtXYEPa4hBf38M5eU5xWG7\n-----END CERTIFICATE-----\n", "custom_csr_id": "7b163417-1d2b-4c84-a38a-2fb7a0cd7752", "custom_key": "-----BEGIN RSA PRIVATE KEY-----\nMIIEowIBAAKCAQEAwQHoetcl9+5ikGzV6cMzWtWPJHqXT3wpbEkRU9Yz7lgvddmG\ndtcGbg/1CGZu0jJGkMoppoUo4c3dts3iwqRYmBikUP77wwY2QGmDZw2FvkJCJlKn\nabIRuGvBKwzESIXgKk2016aTP6/dAjEHyo6SeoK8lkIySUvK0fyOVlsiEsCmOpid\ntnKX/a+50GjB79CJH4ER2lLVZnhePFR/zUOyPxZQQ4naHf7yu/b5jhO0f8fwt+py\nFxIXjbEIdZliWRkRMtzrHOJIhrmJ2A1J7iOrirbbwillwjjNVUWPf3IJ3M12S9pE\newooaeO2izNTERcG9HzAacbVRn2Y2SWIyT/18QIDAQABAoIBACbhTYXBZYKmYPCb\nHBR1IBlCQA2nLGf0qRuJNJZg5iEzXows/6tc8YymZkQE7nolapWsQ+upk2y5Xdp/\naxiuprIs9JzkYK8Ox0r+dlwCG1kSW+UAbX0bQ/qUqlsTvU6muVuMP8vZYHxJ3wmb\n+ufRBKztPTQ/rYWaYQcgC0RWI20HTFBMxlTAyNxYNWzX7RKFkGVVyB9RsAtmcc8g\n+j4OdosbfNoJPS0HeIfNpAznDfHKdxDk2Yc1tV6RHBrC1ynyLE9+TaflIAdo2MVv\nKLMLq51GqYKtgJFIlBRPQqKoyXdz3fGvXrTkf/WY9QNq0J1Vk5ERePZ54mN8iZB7\n9lwy/AkCgYEA6FXzosxswaJ2wQLeoYc7ceaweX/SwTvxHgXzRyJIIT0eJWgx13Wo\n/WA3Iziimsjf6qE+SI/8laxPp2A86VMaIt3Z3mJN/CqSVGw8LK2AQst+OwdPyDMu\niacE8lj/IFGC8mwNUAb9CzGU3JpU4PxxGFjS/eMtGeRXCWkK4NE+G08CgYEA1Kp9\nN2JrVlqUz+gAX+LPmE9OEMAS9WQSQsfCHGogIFDGGcNf7+uwBM7GAaSJIP01zcoe\nVAgWdzXCv3FLhsaZoJ6RyLOLay5phbu1iaTr4UNYm5WtYTzMzqh8l1+MFFDl9xDB\nvULuCIIrglM5MeS/qnSg1uMoH2oVPj9TVst/ir8CgYEAxrI7Ws9Zc4Bt70N1As+U\nlySjaEVZCMkqvHJ6TCuVZFfQoE0r0whdLdRLU2PsLFP+q7qaeZQqgBaNSKeVcDYR\n9B+nY/jOmQoPewPVsp/vQTCnE/R81spu0mp0YI6cIheT1Z9zAy322svcc43JaWB7\nmEbeqyLOP4Z4qSOcmghZBSECgYACvR9Xs0DGn+wCsW4vze/2ei77MD4OQvepPIFX\ndFZtlBy5ADcgE9z0cuVB6CiL8DbdK5kwY9pGNr8HUCI03iHkW6Zs+0L0YmihfEVe\nPG19PSzK9CaDdhD9KFZSbLyVFmWfxOt50H7YRTTiPMgjyFpfi5j2q348yVT0tEQS\nfhRqaQKBgAcWPokmJ7EbYQGeMbS7HC8eWO/RyamlnSffdCdSc7ue3zdVJxpAkQ8W\nqu80pEIF6raIQfAf8MXiiZ7auFOSnHQTXUbhCpvDLKi0Mwq3G8Pl07l+2s6dQG6T\nlv6XTQaMyf6n1yjzL+fzDrH3qXMxHMO/b13EePXpDMpY7HQpoLDi\n-----END RSA PRIVATE KEY-----\n", "dcv_delegation_records": [ { "cname": "_acme-challenge.example.com", "cname_target": "dcv.cloudflare.com", "emails": [ "administrator@example.com", "webmaster@example.com" ], "http_body": "ca3-574923932a82475cb8592200f1a2a23d", "http_url": "http://app.example.com/.well-known/pki-validation/ca3-da12a1c25e7b48cf80408c6c1763b8a2.txt", "status": "pending", "txt_name": "_acme-challenge.app.example.com", "txt_value": "810b7d5f01154524b961ba0cd578acc2" } ], "expires_on": "2021-02-06T18:11:23.531995Z", "hosts": [ "app.example.com", "*.app.example.com" ], "issuer": "DigiCertInc", "method": "http", "serial_number": "6743787633689793699141714808227354901", "settings": { "ciphers": [ "ECDHE-RSA-AES128-GCM-SHA256", "AES128-SHA" ], "early_hints": "on", "http2": "on", "min_tls_version": "1.2", "tls_1_3": "on" }, "signature": "SHA256WithRSA", "status": "pending_validation", "type": "dv", "uploaded_on": "2020-02-06T18:11:23.531995Z", "validation_errors": [ { "message": "SERVFAIL looking up CAA for app.example.com" } ], "validation_records": [ { "cname": "_acme-challenge.example.com", "cname_target": "dcv.cloudflare.com", "emails": [ "administrator@example.com", "webmaster@example.com" ], "http_body": "ca3-574923932a82475cb8592200f1a2a23d", "http_url": "http://app.example.com/.well-known/pki-validation/ca3-da12a1c25e7b48cf80408c6c1763b8a2.txt", "status": "pending", "txt_name": "_acme-challenge.app.example.com", "txt_value": "810b7d5f01154524b961ba0cd578acc2" } ], "wildcard": false }, "status": "pending", "verification_errors": [ "None of the A or AAAA records are owned by this account and the pre-generated ownership verification token was not found." ] } } ``` ##### Returns Examples 200 example ``` { "errors": [ { "code": 1000, "message": "message", "documentation_url": "documentation_url", "source": { "pointer": "pointer" } } ], "messages": [ "string" ], "success": true, "result": { "id": "0d89c70d-ad9f-4843-b99f-6cc0252067e9", "hostname": "app.example.com", "created_at": "2020-02-06T18:11:23.531995Z", "custom_metadata": { "foo": "string" }, "custom_origin_server": "origin2.example.com", "custom_origin_sni": "sni.example.com", "ownership_verification": { "name": "_cf-custom-hostname.app.example.com", "type": "txt", "value": "5cc07c04-ea62-4a5a-95f0-419334a875a4" }, "ownership_verification_http": { "http_body": "5cc07c04-ea62-4a5a-95f0-419334a875a4", "http_url": "http://custom.test.com/.well-known/cf-custom-hostname-challenge/0d89c70d-ad9f-4843-b99f-6cc0252067e9" }, "ssl": { "id": "0d89c70d-ad9f-4843-b99f-6cc0252067e9", "bundle_method": "ubiquitous", "certificate_authority": "google", "custom_certificate": "-----BEGIN CERTIFICATE-----\nMIIFJDCCBAygAwIBAgIQD0ifmj/Yi5NP/2gdUySbfzANBgkqhkiG9w0BAQsFADBN\nMQswCQYDVQQGEwJVUzEVMBMGA1UEChMMRGlnaUNlcnQgSW5jMScwJQYDVQQDEx5E...SzSHfXp5lnu/3V08I72q1QNzOCgY1XeL4GKVcj4or6cT6tX6oJH7ePPmfrBfqI/O\nOeH8gMJ+FuwtXYEPa4hBf38M5eU5xWG7\n-----END CERTIFICATE-----\n", "custom_csr_id": "7b163417-1d2b-4c84-a38a-2fb7a0cd7752", "custom_key": "-----BEGIN RSA PRIVATE KEY-----\nMIIEowIBAAKCAQEAwQHoetcl9+5ikGzV6cMzWtWPJHqXT3wpbEkRU9Yz7lgvddmG\ndtcGbg/1CGZu0jJGkMoppoUo4c3dts3iwqRYmBikUP77wwY2QGmDZw2FvkJCJlKn\nabIRuGvBKwzESIXgKk2016aTP6/dAjEHyo6SeoK8lkIySUvK0fyOVlsiEsCmOpid\ntnKX/a+50GjB79CJH4ER2lLVZnhePFR/zUOyPxZQQ4naHf7yu/b5jhO0f8fwt+py\nFxIXjbEIdZliWRkRMtzrHOJIhrmJ2A1J7iOrirbbwillwjjNVUWPf3IJ3M12S9pE\newooaeO2izNTERcG9HzAacbVRn2Y2SWIyT/18QIDAQABAoIBACbhTYXBZYKmYPCb\nHBR1IBlCQA2nLGf0qRuJNJZg5iEzXows/6tc8YymZkQE7nolapWsQ+upk2y5Xdp/\naxiuprIs9JzkYK8Ox0r+dlwCG1kSW+UAbX0bQ/qUqlsTvU6muVuMP8vZYHxJ3wmb\n+ufRBKztPTQ/rYWaYQcgC0RWI20HTFBMxlTAyNxYNWzX7RKFkGVVyB9RsAtmcc8g\n+j4OdosbfNoJPS0HeIfNpAznDfHKdxDk2Yc1tV6RHBrC1ynyLE9+TaflIAdo2MVv\nKLMLq51GqYKtgJFIlBRPQqKoyXdz3fGvXrTkf/WY9QNq0J1Vk5ERePZ54mN8iZB7\n9lwy/AkCgYEA6FXzosxswaJ2wQLeoYc7ceaweX/SwTvxHgXzRyJIIT0eJWgx13Wo\n/WA3Iziimsjf6qE+SI/8laxPp2A86VMaIt3Z3mJN/CqSVGw8LK2AQst+OwdPyDMu\niacE8lj/IFGC8mwNUAb9CzGU3JpU4PxxGFjS/eMtGeRXCWkK4NE+G08CgYEA1Kp9\nN2JrVlqUz+gAX+LPmE9OEMAS9WQSQsfCHGogIFDGGcNf7+uwBM7GAaSJIP01zcoe\nVAgWdzXCv3FLhsaZoJ6RyLOLay5phbu1iaTr4UNYm5WtYTzMzqh8l1+MFFDl9xDB\nvULuCIIrglM5MeS/qnSg1uMoH2oVPj9TVst/ir8CgYEAxrI7Ws9Zc4Bt70N1As+U\nlySjaEVZCMkqvHJ6TCuVZFfQoE0r0whdLdRLU2PsLFP+q7qaeZQqgBaNSKeVcDYR\n9B+nY/jOmQoPewPVsp/vQTCnE/R81spu0mp0YI6cIheT1Z9zAy322svcc43JaWB7\nmEbeqyLOP4Z4qSOcmghZBSECgYACvR9Xs0DGn+wCsW4vze/2ei77MD4OQvepPIFX\ndFZtlBy5ADcgE9z0cuVB6CiL8DbdK5kwY9pGNr8HUCI03iHkW6Zs+0L0YmihfEVe\nPG19PSzK9CaDdhD9KFZSbLyVFmWfxOt50H7YRTTiPMgjyFpfi5j2q348yVT0tEQS\nfhRqaQKBgAcWPokmJ7EbYQGeMbS7HC8eWO/RyamlnSffdCdSc7ue3zdVJxpAkQ8W\nqu80pEIF6raIQfAf8MXiiZ7auFOSnHQTXUbhCpvDLKi0Mwq3G8Pl07l+2s6dQG6T\nlv6XTQaMyf6n1yjzL+fzDrH3qXMxHMO/b13EePXpDMpY7HQpoLDi\n-----END RSA PRIVATE KEY-----\n", "dcv_delegation_records": [ { "cname": "_acme-challenge.example.com", "cname_target": "dcv.cloudflare.com", "emails": [ "administrator@example.com", "webmaster@example.com" ], "http_body": "ca3-574923932a82475cb8592200f1a2a23d", "http_url": "http://app.example.com/.well-known/pki-validation/ca3-da12a1c25e7b48cf80408c6c1763b8a2.txt", "status": "pending", "txt_name": "_acme-challenge.app.example.com", "txt_value": "810b7d5f01154524b961ba0cd578acc2" } ], "expires_on": "2021-02-06T18:11:23.531995Z", "hosts": [ "app.example.com", "*.app.example.com" ], "issuer": "DigiCertInc", "method": "http", "serial_number": "6743787633689793699141714808227354901", "settings": { "ciphers": [ "ECDHE-RSA-AES128-GCM-SHA256", "AES128-SHA" ], "early_hints": "on", "http2": "on", "min_tls_version": "1.2", "tls_1_3": "on" }, "signature": "SHA256WithRSA", "status": "pending_validation", "type": "dv", "uploaded_on": "2020-02-06T18:11:23.531995Z", "validation_errors": [ { "message": "SERVFAIL looking up CAA for app.example.com" } ], "validation_records": [ { "cname": "_acme-challenge.example.com", "cname_target": "dcv.cloudflare.com", "emails": [ "administrator@example.com", "webmaster@example.com" ], "http_body": "ca3-574923932a82475cb8592200f1a2a23d", "http_url": "http://app.example.com/.well-known/pki-validation/ca3-da12a1c25e7b48cf80408c6c1763b8a2.txt", "status": "pending", "txt_name": "_acme-challenge.app.example.com", "txt_value": "810b7d5f01154524b961ba0cd578acc2" } ], "wildcard": false }, "status": "pending", "verification_errors": [ "None of the A or AAAA records are owned by this account and the pre-generated ownership verification token was not found." ] } } ```