--- title: List Custom Hostnames --- [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** # List Custom Hostnames client.CustomHostnames.List(ctx, params) (\*V4PagePaginationArray\[[CustomHostnameListResponse]()], error) GET/zones/{zone\_id}/custom\_hostnames List, search, sort, and filter all of your custom hostnames. ##### 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``SSL and Certificates Read` ##### ParametersExpand Collapse

params CustomHostnameListParams

ZoneID param.Field\[string] Path param: Identifier. maxLength32 Link to this property ID param.Field\[string]Optional Query param: Hostname ID to match against. This ID was generated and returned during the initial custom\_hostname creation. This parameter cannot be used with the ‘hostname’, ‘hostname.exact’, ‘hostname.contain’, or ‘hostname.startsWith’ parameters. maxLength36 minLength36 Link to this property

CertificateAuthority param.Field\[CustomHostnameListParamsCertificateAuthority]Optional Query param: Filter by the certificate authority that issued the SSL certificate.

const CustomHostnameListParamsCertificateAuthorityGoogle CustomHostnameListParamsCertificateAuthority = "google" Link to this property const CustomHostnameListParamsCertificateAuthorityLetsEncrypt CustomHostnameListParamsCertificateAuthority = "lets\_encrypt" Link to this property const CustomHostnameListParamsCertificateAuthoritySSLCom CustomHostnameListParamsCertificateAuthority = "ssl\_com" Link to this property

Link to this property CustomOriginServer param.Field\[string]Optional Query param: Filter by custom origin server name. Link to this property

Direction param.Field\[CustomHostnameListParamsDirection]Optional Query param: Direction to order hostnames.

const CustomHostnameListParamsDirectionAsc CustomHostnameListParamsDirection = "asc" Link to this property const CustomHostnameListParamsDirectionDesc CustomHostnameListParamsDirection = "desc" Link to this property

Link to this property

Hostname param.Field\[CustomHostnameListParamsHostname]Optional Query param

Contain stringOptional Filters hostnames by a substring match on the hostname value. This parameter cannot be used with the ‘id’, ‘hostname’, ‘hostname.exact’, or ‘hostname.startsWith’ parameters. maxLength255 Link to this property Exact stringOptional Fully qualified domain name to match against. This parameter cannot be used with the ‘id’, ‘hostname’, ‘hostname.contain’, or ‘hostname.startsWith’ parameters. maxLength255 Link to this property StartsWith stringOptional Filters hostnames by a prefix match on the hostname value. This parameter cannot be used with the ‘id’, ‘hostname’, ‘hostname.exact’, or ‘hostname.contain’ parameters. maxLength255 Link to this property

Link to this property

HostnameStatus param.Field\[CustomHostnameListParamsHostnameStatus]Optional Query param: Filter by the hostname’s activation status.

const CustomHostnameListParamsHostnameStatusActive CustomHostnameListParamsHostnameStatus = "active" Link to this property const CustomHostnameListParamsHostnameStatusPending CustomHostnameListParamsHostnameStatus = "pending" Link to this property const CustomHostnameListParamsHostnameStatusActiveRedeploying CustomHostnameListParamsHostnameStatus = "active\_redeploying" Link to this property const CustomHostnameListParamsHostnameStatusMoved CustomHostnameListParamsHostnameStatus = "moved" Link to this property const CustomHostnameListParamsHostnameStatusPendingDeletion CustomHostnameListParamsHostnameStatus = "pending\_deletion" Link to this property const CustomHostnameListParamsHostnameStatusDeleted CustomHostnameListParamsHostnameStatus = "deleted" Link to this property const CustomHostnameListParamsHostnameStatusPendingBlocked CustomHostnameListParamsHostnameStatus = "pending\_blocked" Link to this property const CustomHostnameListParamsHostnameStatusPendingMigration CustomHostnameListParamsHostnameStatus = "pending\_migration" Link to this property const CustomHostnameListParamsHostnameStatusPendingProvisioned CustomHostnameListParamsHostnameStatus = "pending\_provisioned" Link to this property const CustomHostnameListParamsHostnameStatusTestPending CustomHostnameListParamsHostnameStatus = "test\_pending" Link to this property const CustomHostnameListParamsHostnameStatusTestActive CustomHostnameListParamsHostnameStatus = "test\_active" Link to this property const CustomHostnameListParamsHostnameStatusTestActiveApex CustomHostnameListParamsHostnameStatus = "test\_active\_apex" Link to this property const CustomHostnameListParamsHostnameStatusTestBlocked CustomHostnameListParamsHostnameStatus = "test\_blocked" Link to this property const CustomHostnameListParamsHostnameStatusTestFailed CustomHostnameListParamsHostnameStatus = "test\_failed" Link to this property const CustomHostnameListParamsHostnameStatusProvisioned CustomHostnameListParamsHostnameStatus = "provisioned" Link to this property const CustomHostnameListParamsHostnameStatusBlocked CustomHostnameListParamsHostnameStatus = "blocked" Link to this property

Link to this property

Order param.Field\[CustomHostnameListParamsOrder]Optional Query param: Field to order hostnames by.

const CustomHostnameListParamsOrderSSL CustomHostnameListParamsOrder = "ssl" Link to this property const CustomHostnameListParamsOrderSSLStatus CustomHostnameListParamsOrder = "ssl\_status" Link to this property

Link to this property Page param.Field\[float64]Optional Query param: Page number of paginated results. minimum1 Link to this property PerPage param.Field\[float64]Optional Query param: Number of hostnames per page. maximum1000 minimum5 Link to this property

SSL param.Field\[CustomHostnameListParamsSSL]Optional Query param: Whether to filter hostnames based on if they have SSL enabled.

const CustomHostnameListParamsSSL0 CustomHostnameListParamsSSL = 0 Link to this property const CustomHostnameListParamsSSL1 CustomHostnameListParamsSSL = 1 Link to this property

Link to this property

SSLStatus param.Field\[CustomHostnameListParamsSSLStatus]Optional Query param: Filter by SSL certificate status.

const CustomHostnameListParamsSSLStatusInitializing CustomHostnameListParamsSSLStatus = "initializing" Link to this property const CustomHostnameListParamsSSLStatusPendingValidation CustomHostnameListParamsSSLStatus = "pending\_validation" Link to this property const CustomHostnameListParamsSSLStatusDeleted CustomHostnameListParamsSSLStatus = "deleted" Link to this property const CustomHostnameListParamsSSLStatusPendingIssuance CustomHostnameListParamsSSLStatus = "pending\_issuance" Link to this property const CustomHostnameListParamsSSLStatusPendingDeployment CustomHostnameListParamsSSLStatus = "pending\_deployment" Link to this property const CustomHostnameListParamsSSLStatusPendingDeletion CustomHostnameListParamsSSLStatus = "pending\_deletion" Link to this property const CustomHostnameListParamsSSLStatusPendingExpiration CustomHostnameListParamsSSLStatus = "pending\_expiration" Link to this property const CustomHostnameListParamsSSLStatusExpired CustomHostnameListParamsSSLStatus = "expired" Link to this property const CustomHostnameListParamsSSLStatusActive CustomHostnameListParamsSSLStatus = "active" Link to this property const CustomHostnameListParamsSSLStatusInitializingTimedOut CustomHostnameListParamsSSLStatus = "initializing\_timed\_out" Link to this property const CustomHostnameListParamsSSLStatusValidationTimedOut CustomHostnameListParamsSSLStatus = "validation\_timed\_out" Link to this property const CustomHostnameListParamsSSLStatusIssuanceTimedOut CustomHostnameListParamsSSLStatus = "issuance\_timed\_out" Link to this property const CustomHostnameListParamsSSLStatusDeploymentTimedOut CustomHostnameListParamsSSLStatus = "deployment\_timed\_out" Link to this property const CustomHostnameListParamsSSLStatusDeletionTimedOut CustomHostnameListParamsSSLStatus = "deletion\_timed\_out" Link to this property const CustomHostnameListParamsSSLStatusPendingCleanup CustomHostnameListParamsSSLStatus = "pending\_cleanup" Link to this property const CustomHostnameListParamsSSLStatusStagingDeployment CustomHostnameListParamsSSLStatus = "staging\_deployment" Link to this property const CustomHostnameListParamsSSLStatusStagingActive CustomHostnameListParamsSSLStatus = "staging\_active" Link to this property const CustomHostnameListParamsSSLStatusDeactivating CustomHostnameListParamsSSLStatus = "deactivating" Link to this property const CustomHostnameListParamsSSLStatusInactive CustomHostnameListParamsSSLStatus = "inactive" Link to this property const CustomHostnameListParamsSSLStatusBackupIssued CustomHostnameListParamsSSLStatus = "backup\_issued" Link to this property const CustomHostnameListParamsSSLStatusHoldingDeployment CustomHostnameListParamsSSLStatus = "holding\_deployment" Link to this property

Link to this property Wildcard param.Field\[bool]Optional Query param: Filter by whether the custom hostname is a wildcard hostname. Link to this property

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

type CustomHostnameListResponse 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 CustomHostnameListResponseOwnershipVerificationOptional This is a record which can be placed to activate a hostname.

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

Link to this property

OwnershipVerificationHTTP CustomHostnameListResponseOwnershipVerificationHTTPOptional 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 CustomHostnameListResponseSSLOptional

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

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

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 CustomCertificate stringOptional If a custom uploaded certificate is used. Link to this property CustomCsrID stringOptional The identifier for the Custom CSR that was used. Link to this property CustomKey stringOptional The key for a custom uploaded certificate. Link to this property

DCVDelegationRecords \[]CustomHostnameListResponseSsldcvDelegationRecordOptional 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.

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 SerialNumber stringOptional The serial number on a custom uploaded certificate. Link to this property

Settings CustomHostnameListResponseSSLSettingsOptional

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

EarlyHints CustomHostnameListResponseSSLSettingsEarlyHintsOptional Whether or not Early Hints is enabled.

One of the following: const CustomHostnameListResponseSSLSettingsEarlyHintsOn CustomHostnameListResponseSSLSettingsEarlyHints = "on" Link to this property const CustomHostnameListResponseSSLSettingsEarlyHintsOff CustomHostnameListResponseSSLSettingsEarlyHints = "off" Link to this property

Link to this property

HTTP2 CustomHostnameListResponseSSLSettingsHTTP2Optional Whether or not HTTP2 is enabled.

One of the following: const CustomHostnameListResponseSSLSettingsHTTP2On CustomHostnameListResponseSSLSettingsHTTP2 = "on" Link to this property const CustomHostnameListResponseSSLSettingsHTTP2Off CustomHostnameListResponseSSLSettingsHTTP2 = "off" Link to this property

Link to this property

MinTLSVersion CustomHostnameListResponseSSLSettingsMinTLSVersionOptional The minimum TLS version supported.

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

Link to this property

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

One of the following: const CustomHostnameListResponseSSLSettingsTLS1\_3On CustomHostnameListResponseSSLSettingsTLS1\_3 = "on" Link to this property const CustomHostnameListResponseSSLSettingsTLS1\_3Off CustomHostnameListResponseSSLSettingsTLS1\_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 CustomHostnameListResponseSSLStatusOptional Status of the hostname’s SSL certificates.

One of the following: const CustomHostnameListResponseSSLStatusInitializing CustomHostnameListResponseSSLStatus = "initializing" Link to this property const CustomHostnameListResponseSSLStatusPendingValidation CustomHostnameListResponseSSLStatus = "pending\_validation" Link to this property const CustomHostnameListResponseSSLStatusDeleted CustomHostnameListResponseSSLStatus = "deleted" Link to this property const CustomHostnameListResponseSSLStatusPendingIssuance CustomHostnameListResponseSSLStatus = "pending\_issuance" Link to this property const CustomHostnameListResponseSSLStatusPendingDeployment CustomHostnameListResponseSSLStatus = "pending\_deployment" Link to this property const CustomHostnameListResponseSSLStatusPendingDeletion CustomHostnameListResponseSSLStatus = "pending\_deletion" Link to this property const CustomHostnameListResponseSSLStatusPendingExpiration CustomHostnameListResponseSSLStatus = "pending\_expiration" Link to this property const CustomHostnameListResponseSSLStatusExpired CustomHostnameListResponseSSLStatus = "expired" Link to this property const CustomHostnameListResponseSSLStatusActive CustomHostnameListResponseSSLStatus = "active" Link to this property const CustomHostnameListResponseSSLStatusInitializingTimedOut CustomHostnameListResponseSSLStatus = "initializing\_timed\_out" Link to this property const CustomHostnameListResponseSSLStatusValidationTimedOut CustomHostnameListResponseSSLStatus = "validation\_timed\_out" Link to this property const CustomHostnameListResponseSSLStatusIssuanceTimedOut CustomHostnameListResponseSSLStatus = "issuance\_timed\_out" Link to this property const CustomHostnameListResponseSSLStatusDeploymentTimedOut CustomHostnameListResponseSSLStatus = "deployment\_timed\_out" Link to this property const CustomHostnameListResponseSSLStatusDeletionTimedOut CustomHostnameListResponseSSLStatus = "deletion\_timed\_out" Link to this property const CustomHostnameListResponseSSLStatusPendingCleanup CustomHostnameListResponseSSLStatus = "pending\_cleanup" Link to this property const CustomHostnameListResponseSSLStatusStagingDeployment CustomHostnameListResponseSSLStatus = "staging\_deployment" Link to this property const CustomHostnameListResponseSSLStatusStagingActive CustomHostnameListResponseSSLStatus = "staging\_active" Link to this property const CustomHostnameListResponseSSLStatusDeactivating CustomHostnameListResponseSSLStatus = "deactivating" Link to this property const CustomHostnameListResponseSSLStatusInactive CustomHostnameListResponseSSLStatus = "inactive" Link to this property const CustomHostnameListResponseSSLStatusBackupIssued CustomHostnameListResponseSSLStatus = "backup\_issued" Link to this property const CustomHostnameListResponseSSLStatusHoldingDeployment CustomHostnameListResponseSSLStatus = "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 \[]CustomHostnameListResponseSSLValidationErrorOptional 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 \[]CustomHostnameListResponseSSLValidationRecordOptional

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

Link to this property

Status CustomHostnameListResponseStatusOptional Status of the hostname’s activation.

One of the following: const CustomHostnameListResponseStatusActive CustomHostnameListResponseStatus = "active" Link to this property const CustomHostnameListResponseStatusPending CustomHostnameListResponseStatus = "pending" Link to this property const CustomHostnameListResponseStatusActiveRedeploying CustomHostnameListResponseStatus = "active\_redeploying" Link to this property const CustomHostnameListResponseStatusMoved CustomHostnameListResponseStatus = "moved" Link to this property const CustomHostnameListResponseStatusPendingDeletion CustomHostnameListResponseStatus = "pending\_deletion" Link to this property const CustomHostnameListResponseStatusDeleted CustomHostnameListResponseStatus = "deleted" Link to this property const CustomHostnameListResponseStatusPendingBlocked CustomHostnameListResponseStatus = "pending\_blocked" Link to this property const CustomHostnameListResponseStatusPendingMigration CustomHostnameListResponseStatus = "pending\_migration" Link to this property const CustomHostnameListResponseStatusPendingProvisioned CustomHostnameListResponseStatus = "pending\_provisioned" Link to this property const CustomHostnameListResponseStatusTestPending CustomHostnameListResponseStatus = "test\_pending" Link to this property const CustomHostnameListResponseStatusTestActive CustomHostnameListResponseStatus = "test\_active" Link to this property const CustomHostnameListResponseStatusTestActiveApex CustomHostnameListResponseStatus = "test\_active\_apex" Link to this property const CustomHostnameListResponseStatusTestBlocked CustomHostnameListResponseStatus = "test\_blocked" Link to this property const CustomHostnameListResponseStatusTestFailed CustomHostnameListResponseStatus = "test\_failed" Link to this property const CustomHostnameListResponseStatusProvisioned CustomHostnameListResponseStatus = "provisioned" Link to this property const CustomHostnameListResponseStatusBlocked CustomHostnameListResponseStatus = "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)%20CustomHostnameListResponse%20%3E%20(schema)>) ### List Custom Hostnames 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"), ) page, err := client.CustomHostnames.List(context.TODO(), custom_hostnames.CustomHostnameListParams{ ZoneID: cloudflare.F("023e105f4ecef8ad9ca31a8372d0c353"), }) if err != nil { panic(err.Error()) } fmt.Printf("%+v\n", page) } ``` 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." ] } ], "result_info": { "count": 1, "page": 1, "per_page": 20, "total_count": 2000, "total_pages": 100 } } ``` ##### 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." ] } ], "result_info": { "count": 1, "page": 1, "per_page": 20, "total_count": 2000, "total_pages": 100 } } ```