---
title: SSL Configuration Details
---

[Skip to content](#_top)

[API Reference](https://developers.cloudflare.com/api/go)

[Custom Certificates](https://developers.cloudflare.com/api/go/resources/custom_certificates)

Copy Markdown

Open in **Claude**Open in **ChatGPT**Open in **Cursor**

---

**Copy Markdown****View as Markdown**

# SSL Configuration Details

client.CustomCertificates.Get(ctx, customCertificateID, query) (\*[CustomCertificate](<https://developers.cloudflare.com/api/go/resources/custom_certificates#(resource)%20custom_certificates%20%3E%20(model)%20custom_certificate%20%3E%20(schema)>), error)

GET/zones/{zone\_id}/custom\_certificates/{custom\_certificate\_id}

Retrieves details for a specific custom SSL certificate, including certificate metadata, bundle method, geographic restrictions, and associated keyless server configuration.

##### Security

<details>

<summary>API Token</summary>



The preferred authorization scheme for interacting with the Cloudflare API. <a href="https://developers.cloudflare.com/fundamentals/api/get-started/create-token/">Create a token</a>.

**Example:**<code>Authorization: Bearer Sn3lZJTBX6kkg7OdcBUAxOO963GEIyGQqnFTOFYY</code>

</details>

<details>

<summary>API Email + API Key</summary>



The previous authorization scheme for interacting with the Cloudflare API, used in conjunction with a Global API key.

**Example:**<code>X-Auth-Email: user@example.com</code>

The previous authorization scheme for interacting with the Cloudflare API. When possible, use API tokens instead of Global API keys.

**Example:**<code>X-Auth-Key: 144c9defac04969c7bfad8efaa8ea194</code>

</details>

##### Accepted Permissions (at least one required)

`Access: Mutual TLS Certificates Write``Access: Mutual TLS Certificates Read``SSL and Certificates Write``SSL and Certificates Read`

##### ParametersExpand Collapse

customCertificateID string

Custom certificate identifier tag.

maxLength36

[Link to this property](<#(resource)%20custom_certificates%20%3E%20(method)%20get%20%3E%20(params)%20default%20%3E%20(param)%20custom_certificate_id%20%3E%20(schema)>)

<details>

<summary>

query CustomCertificateGetParams

</summary>

ZoneID param.Field\[string]

Identifier.

maxLength32

<a href="#(resource)%20custom_certificates%20%3E%20(method)%20get%20%3E%20(params)%20default%20%3E%20(param)%20zone_id">Link to this property</a>

</details>

[Link to this property](<#(resource)%20custom_certificates%20%3E%20(method)%20get%20%3E%20(params)%20default>)

##### ReturnsExpand Collapse

<details>

<summary>

type CustomCertificate struct{…}

</summary>

ID string

Custom certificate identifier tag.

maxLength36

<a href="#(resource)%20custom_certificates%20%3E%20(model)%20custom_certificate%20%3E%20(schema)%20%3E%20(property)%20id">Link to this property</a>

ZoneID string

Identifier.

maxLength32

<a href="#(resource)%20custom_certificates%20%3E%20(model)%20custom_certificate%20%3E%20(schema)%20%3E%20(property)%20zone_id">Link to this property</a>

<details>

<summary>

BundleMethod <a href="https://developers.cloudflare.com/api/go/resources/custom_hostnames#(resource)%20custom_hostnames%20%3E%20(model)%20bundle_method%20%3E%20(schema)">BundleMethod</a>Optional

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.

</summary>

One of the following:

const BundleMethodUbiquitous <a href="https://developers.cloudflare.com/api/go/resources/custom_hostnames#(resource)%20custom_hostnames%20%3E%20(model)%20bundle_method%20%3E%20(schema)">BundleMethod</a> = "ubiquitous"

<a href="#(resource)%20custom_certificates%20%3E%20(model)%20custom_certificate%20%3E%20(schema)%20%3E%20(property)%20bundle_method%20%2B%20(resource)%20custom_hostnames%20%3E%20(model)%20bundle_method%20%3E%20(schema)%20%3E%20(member)%200">Link to this property</a>

const BundleMethodOptimal <a href="https://developers.cloudflare.com/api/go/resources/custom_hostnames#(resource)%20custom_hostnames%20%3E%20(model)%20bundle_method%20%3E%20(schema)">BundleMethod</a> = "optimal"

<a href="#(resource)%20custom_certificates%20%3E%20(model)%20custom_certificate%20%3E%20(schema)%20%3E%20(property)%20bundle_method%20%2B%20(resource)%20custom_hostnames%20%3E%20(model)%20bundle_method%20%3E%20(schema)%20%3E%20(member)%201">Link to this property</a>

const BundleMethodForce <a href="https://developers.cloudflare.com/api/go/resources/custom_hostnames#(resource)%20custom_hostnames%20%3E%20(model)%20bundle_method%20%3E%20(schema)">BundleMethod</a> = "force"

<a href="#(resource)%20custom_certificates%20%3E%20(model)%20custom_certificate%20%3E%20(schema)%20%3E%20(property)%20bundle_method%20%2B%20(resource)%20custom_hostnames%20%3E%20(model)%20bundle_method%20%3E%20(schema)%20%3E%20(member)%202">Link to this property</a>

</details>

<a href="#(resource)%20custom_certificates%20%3E%20(model)%20custom_certificate%20%3E%20(schema)%20%3E%20(property)%20bundle_method">Link to this property</a>

CustomCsrID stringOptional

The identifier for the Custom CSR that was used.

<a href="#(resource)%20custom_certificates%20%3E%20(model)%20custom_certificate%20%3E%20(schema)%20%3E%20(property)%20custom_csr_id">Link to this property</a>

ExpiresOn TimeOptional

When the certificate from the authority expires.

formatdate-time

<a href="#(resource)%20custom_certificates%20%3E%20(model)%20custom_certificate%20%3E%20(schema)%20%3E%20(property)%20expires_on">Link to this property</a>

<details>

<summary>

GeoRestrictions <a href="https://developers.cloudflare.com/api/go/resources/custom_certificates#(resource)%20custom_certificates%20%3E%20(model)%20geo_restrictions%20%3E%20(schema)">GeoRestrictions</a>Optional

Specify the region where your private key can be held locally for optimal TLS performance. HTTPS connections to any excluded data center will still be fully encrypted, but will incur some latency while Keyless SSL is used to complete the handshake with the nearest allowed data center. Options allow distribution to only to U.S. data centers, only to E.U. data centers, or only to highest security data centers. Default distribution is to all Cloudflare datacenters, for optimal performance.

</summary>

<details>

<summary>

Label GeoRestrictionsLabelOptional

</summary>

One of the following:

const GeoRestrictionsLabelUs GeoRestrictionsLabel = "us"

<a href="#(resource)%20custom_certificates%20%3E%20(model)%20custom_certificate%20%3E%20(schema)%20%3E%20(property)%20geo_restrictions%20%2B%20(resource)%20custom_certificates%20%3E%20(model)%20geo_restrictions%20%3E%20(schema)%20%3E%20(property)%20label%20%3E%20(member)%200">Link to this property</a>

const GeoRestrictionsLabelEu GeoRestrictionsLabel = "eu"

<a href="#(resource)%20custom_certificates%20%3E%20(model)%20custom_certificate%20%3E%20(schema)%20%3E%20(property)%20geo_restrictions%20%2B%20(resource)%20custom_certificates%20%3E%20(model)%20geo_restrictions%20%3E%20(schema)%20%3E%20(property)%20label%20%3E%20(member)%201">Link to this property</a>

const GeoRestrictionsLabelHighestSecurity GeoRestrictionsLabel = "highest\_security"

<a href="#(resource)%20custom_certificates%20%3E%20(model)%20custom_certificate%20%3E%20(schema)%20%3E%20(property)%20geo_restrictions%20%2B%20(resource)%20custom_certificates%20%3E%20(model)%20geo_restrictions%20%3E%20(schema)%20%3E%20(property)%20label%20%3E%20(member)%202">Link to this property</a>

</details>

<a href="#(resource)%20custom_certificates%20%3E%20(model)%20custom_certificate%20%3E%20(schema)%20%3E%20(property)%20geo_restrictions%20%2B%20(resource)%20custom_certificates%20%3E%20(model)%20geo_restrictions%20%3E%20(schema)%20%3E%20(property)%20label">Link to this property</a>

</details>

<a href="#(resource)%20custom_certificates%20%3E%20(model)%20custom_certificate%20%3E%20(schema)%20%3E%20(property)%20geo_restrictions">Link to this property</a>

Hosts \[]stringOptional

<a href="#(resource)%20custom_certificates%20%3E%20(model)%20custom_certificate%20%3E%20(schema)%20%3E%20(property)%20hosts">Link to this property</a>

Issuer stringOptional

The certificate authority that issued the certificate.

<a href="#(resource)%20custom_certificates%20%3E%20(model)%20custom_certificate%20%3E%20(schema)%20%3E%20(property)%20issuer">Link to this property</a>

<details>

<summary>

KeylessServer <a href="https://developers.cloudflare.com/api/go/resources/keyless_certificates#(resource)%20keyless_certificates%20%3E%20(model)%20keyless_certificate%20%3E%20(schema)">KeylessCertificate</a>Optional

</summary>

ID string

Keyless certificate identifier tag.

maxLength32

<a href="#(resource)%20custom_certificates%20%3E%20(model)%20custom_certificate%20%3E%20(schema)%20%3E%20(property)%20keyless_server%20%2B%20(resource)%20keyless_certificates%20%3E%20(model)%20keyless_certificate%20%3E%20(schema)%20%3E%20(property)%20id">Link to this property</a>

CreatedOn Time

When the Keyless SSL was created.

formatdate-time

<a href="#(resource)%20custom_certificates%20%3E%20(model)%20custom_certificate%20%3E%20(schema)%20%3E%20(property)%20keyless_server%20%2B%20(resource)%20keyless_certificates%20%3E%20(model)%20keyless_certificate%20%3E%20(schema)%20%3E%20(property)%20created_on">Link to this property</a>

Enabled bool

Whether or not the Keyless SSL is on or off.

<a href="#(resource)%20custom_certificates%20%3E%20(model)%20custom_certificate%20%3E%20(schema)%20%3E%20(property)%20keyless_server%20%2B%20(resource)%20keyless_certificates%20%3E%20(model)%20keyless_certificate%20%3E%20(schema)%20%3E%20(property)%20enabled">Link to this property</a>

Host string

The keyless SSL name.

formathostname

maxLength253

<a href="#(resource)%20custom_certificates%20%3E%20(model)%20custom_certificate%20%3E%20(schema)%20%3E%20(property)%20keyless_server%20%2B%20(resource)%20keyless_certificates%20%3E%20(model)%20keyless_certificate%20%3E%20(schema)%20%3E%20(property)%20host">Link to this property</a>

ModifiedOn Time

When the Keyless SSL was last modified.

formatdate-time

<a href="#(resource)%20custom_certificates%20%3E%20(model)%20custom_certificate%20%3E%20(schema)%20%3E%20(property)%20keyless_server%20%2B%20(resource)%20keyless_certificates%20%3E%20(model)%20keyless_certificate%20%3E%20(schema)%20%3E%20(property)%20modified_on">Link to this property</a>

Name string

The keyless SSL name.

maxLength180

<a href="#(resource)%20custom_certificates%20%3E%20(model)%20custom_certificate%20%3E%20(schema)%20%3E%20(property)%20keyless_server%20%2B%20(resource)%20keyless_certificates%20%3E%20(model)%20keyless_certificate%20%3E%20(schema)%20%3E%20(property)%20name">Link to this property</a>

Permissions \[]string

Available permissions for the Keyless SSL for the current user requesting the item.

<a href="#(resource)%20custom_certificates%20%3E%20(model)%20custom_certificate%20%3E%20(schema)%20%3E%20(property)%20keyless_server%20%2B%20(resource)%20keyless_certificates%20%3E%20(model)%20keyless_certificate%20%3E%20(schema)%20%3E%20(property)%20permissions">Link to this property</a>

Port float64

The keyless SSL port used to communicate between Cloudflare and the client’s Keyless SSL server.

maxLength65535

<a href="#(resource)%20custom_certificates%20%3E%20(model)%20custom_certificate%20%3E%20(schema)%20%3E%20(property)%20keyless_server%20%2B%20(resource)%20keyless_certificates%20%3E%20(model)%20keyless_certificate%20%3E%20(schema)%20%3E%20(property)%20port">Link to this property</a>

<details>

<summary>

Status KeylessCertificateStatus

Status of the Keyless SSL.

</summary>

One of the following:

const KeylessCertificateStatusActive KeylessCertificateStatus = "active"

<a href="#(resource)%20custom_certificates%20%3E%20(model)%20custom_certificate%20%3E%20(schema)%20%3E%20(property)%20keyless_server%20%2B%20(resource)%20keyless_certificates%20%3E%20(model)%20keyless_certificate%20%3E%20(schema)%20%3E%20(property)%20status%20%3E%20(member)%200">Link to this property</a>

const KeylessCertificateStatusDeleted KeylessCertificateStatus = "deleted"

<a href="#(resource)%20custom_certificates%20%3E%20(model)%20custom_certificate%20%3E%20(schema)%20%3E%20(property)%20keyless_server%20%2B%20(resource)%20keyless_certificates%20%3E%20(model)%20keyless_certificate%20%3E%20(schema)%20%3E%20(property)%20status%20%3E%20(member)%201">Link to this property</a>

</details>

<a href="#(resource)%20custom_certificates%20%3E%20(model)%20custom_certificate%20%3E%20(schema)%20%3E%20(property)%20keyless_server%20%2B%20(resource)%20keyless_certificates%20%3E%20(model)%20keyless_certificate%20%3E%20(schema)%20%3E%20(property)%20status">Link to this property</a>

<details>

<summary>

Tunnel <a href="https://developers.cloudflare.com/api/go/resources/keyless_certificates#(resource)%20keyless_certificates%20%3E%20(model)%20tunnel%20%3E%20(schema)">Tunnel</a>Optional

Configuration for using Keyless SSL through a Cloudflare Tunnel.

</summary>

PrivateIP string

Private IP of the Key Server Host.

<a href="#(resource)%20keyless_certificates%20%3E%20(model)%20keyless_certificate%20%3E%20(schema)%20%3E%20(property)%20tunnel%20%2B%20(resource)%20keyless_certificates%20%3E%20(model)%20tunnel%20%3E%20(schema)%20%3E%20(property)%20private_ip">Link to this property</a>

VnetID string

Cloudflare Tunnel Virtual Network ID.

<a href="#(resource)%20keyless_certificates%20%3E%20(model)%20keyless_certificate%20%3E%20(schema)%20%3E%20(property)%20tunnel%20%2B%20(resource)%20keyless_certificates%20%3E%20(model)%20tunnel%20%3E%20(schema)%20%3E%20(property)%20vnet_id">Link to this property</a>

</details>

<a href="#(resource)%20custom_certificates%20%3E%20(model)%20custom_certificate%20%3E%20(schema)%20%3E%20(property)%20keyless_server%20%2B%20(resource)%20keyless_certificates%20%3E%20(model)%20keyless_certificate%20%3E%20(schema)%20%3E%20(property)%20tunnel">Link to this property</a>

</details>

<a href="#(resource)%20custom_certificates%20%3E%20(model)%20custom_certificate%20%3E%20(schema)%20%3E%20(property)%20keyless_server">Link to this property</a>

ModifiedOn TimeOptional

When the certificate was last modified.

formatdate-time

<a href="#(resource)%20custom_certificates%20%3E%20(model)%20custom_certificate%20%3E%20(schema)%20%3E%20(property)%20modified_on">Link to this property</a>

PolicyRestrictions stringOptional

The policy restrictions returned by the API. This field is returned in responses when a policy has been set. The API accepts the “policy” field in requests but returns this field as “policy\_restrictions” in responses.

Specifies the region(s) where your private key can be held locally for optimal TLS performance. Format is a boolean expression, for example: “(country: US) or (region: EU)”

<a href="#(resource)%20custom_certificates%20%3E%20(model)%20custom_certificate%20%3E%20(schema)%20%3E%20(property)%20policy_restrictions">Link to this property</a>

Priority float64Optional

The order/priority in which the certificate will be used in a request. The higher priority will break ties across overlapping ‘legacy\_custom’ certificates, but ‘legacy\_custom’ certificates will always supercede ‘sni\_custom’ certificates.

<a href="#(resource)%20custom_certificates%20%3E%20(model)%20custom_certificate%20%3E%20(schema)%20%3E%20(property)%20priority">Link to this property</a>

Signature stringOptional

The type of hash used for the certificate.

<a href="#(resource)%20custom_certificates%20%3E%20(model)%20custom_certificate%20%3E%20(schema)%20%3E%20(property)%20signature">Link to this property</a>

<details>

<summary>

Status CustomCertificateStatusOptional

Status of the zone’s custom SSL.

</summary>

One of the following:

const CustomCertificateStatusActive CustomCertificateStatus = "active"

<a href="#(resource)%20custom_certificates%20%3E%20(model)%20custom_certificate%20%3E%20(schema)%20%3E%20(property)%20status%20%3E%20(member)%200">Link to this property</a>

const CustomCertificateStatusExpired CustomCertificateStatus = "expired"

<a href="#(resource)%20custom_certificates%20%3E%20(model)%20custom_certificate%20%3E%20(schema)%20%3E%20(property)%20status%20%3E%20(member)%201">Link to this property</a>

const CustomCertificateStatusDeleted CustomCertificateStatus = "deleted"

<a href="#(resource)%20custom_certificates%20%3E%20(model)%20custom_certificate%20%3E%20(schema)%20%3E%20(property)%20status%20%3E%20(member)%202">Link to this property</a>

const CustomCertificateStatusPending CustomCertificateStatus = "pending"

<a href="#(resource)%20custom_certificates%20%3E%20(model)%20custom_certificate%20%3E%20(schema)%20%3E%20(property)%20status%20%3E%20(member)%203">Link to this property</a>

const CustomCertificateStatusInitializing CustomCertificateStatus = "initializing"

<a href="#(resource)%20custom_certificates%20%3E%20(model)%20custom_certificate%20%3E%20(schema)%20%3E%20(property)%20status%20%3E%20(member)%204">Link to this property</a>

</details>

<a href="#(resource)%20custom_certificates%20%3E%20(model)%20custom_certificate%20%3E%20(schema)%20%3E%20(property)%20status">Link to this property</a>

UploadedOn TimeOptional

When the certificate was uploaded to Cloudflare.

formatdate-time

<a href="#(resource)%20custom_certificates%20%3E%20(model)%20custom_certificate%20%3E%20(schema)%20%3E%20(property)%20uploaded_on">Link to this property</a>

</details>

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

### SSL Configuration Details

Go

HTTPTypeScriptPythonGoTerraform

```
package main

import (
  "context"
  "fmt"

  "github.com/cloudflare/cloudflare-go"
  "github.com/cloudflare/cloudflare-go/custom_certificates"
  "github.com/cloudflare/cloudflare-go/option"
)

func main() {
  client := cloudflare.NewClient(
    option.WithAPIToken("Sn3lZJTBX6kkg7OdcBUAxOO963GEIyGQqnFTOFYY"),
  )
  customCertificate, err := client.CustomCertificates.Get(
    context.TODO(),
    "2458ce5a-0c35-4c7f-82c7-8e9487d3ff60",
    custom_certificates.CustomCertificateGetParams{
      ZoneID: cloudflare.F("023e105f4ecef8ad9ca31a8372d0c353"),
    },
  )
  if err != nil {
    panic(err.Error())
  }
  fmt.Printf("%+v\n", customCertificate.ID)
}
```

200 example

```
{
  "errors": [
    {
      "code": 1000,
      "message": "message",
      "documentation_url": "documentation_url",
      "source": {
        "pointer": "pointer"
      }
    }
  ],
  "messages": [
    {
      "code": 1000,
      "message": "message",
      "documentation_url": "documentation_url",
      "source": {
        "pointer": "pointer"
      }
    }
  ],
  "success": true,
  "result": {
    "id": "2458ce5a-0c35-4c7f-82c7-8e9487d3ff60",
    "zone_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "bundle_method": "ubiquitous",
    "custom_csr_id": "7b163417-1d2b-4c84-a38a-2fb7a0cd7752",
    "expires_on": "2016-01-01T05:20:00Z",
    "geo_restrictions": {
      "label": "us"
    },
    "hosts": [
      "example.com"
    ],
    "issuer": "GlobalSign",
    "keyless_server": {
      "id": "4d2844d2ce78891c34d0b6c0535a291e",
      "created_on": "2014-01-01T05:20:00Z",
      "enabled": false,
      "host": "example.com",
      "modified_on": "2014-01-01T05:20:00Z",
      "name": "example.com Keyless SSL",
      "permissions": [
        "#ssl:read",
        "#ssl:edit"
      ],
      "port": 24008,
      "status": "active",
      "tunnel": {
        "private_ip": "10.0.0.1",
        "vnet_id": "7365377a-85a4-4390-9480-531ef7dc7a3c"
      }
    },
    "modified_on": "2014-01-01T05:20:00Z",
    "policy_restrictions": "(country: US) or (region: EU)",
    "priority": 1,
    "signature": "SHA256WithRSA",
    "status": "active",
    "uploaded_on": "2014-01-01T05:20:00Z"
  }
}
```

##### Returns Examples

200 example

```
{
  "errors": [
    {
      "code": 1000,
      "message": "message",
      "documentation_url": "documentation_url",
      "source": {
        "pointer": "pointer"
      }
    }
  ],
  "messages": [
    {
      "code": 1000,
      "message": "message",
      "documentation_url": "documentation_url",
      "source": {
        "pointer": "pointer"
      }
    }
  ],
  "success": true,
  "result": {
    "id": "2458ce5a-0c35-4c7f-82c7-8e9487d3ff60",
    "zone_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "bundle_method": "ubiquitous",
    "custom_csr_id": "7b163417-1d2b-4c84-a38a-2fb7a0cd7752",
    "expires_on": "2016-01-01T05:20:00Z",
    "geo_restrictions": {
      "label": "us"
    },
    "hosts": [
      "example.com"
    ],
    "issuer": "GlobalSign",
    "keyless_server": {
      "id": "4d2844d2ce78891c34d0b6c0535a291e",
      "created_on": "2014-01-01T05:20:00Z",
      "enabled": false,
      "host": "example.com",
      "modified_on": "2014-01-01T05:20:00Z",
      "name": "example.com Keyless SSL",
      "permissions": [
        "#ssl:read",
        "#ssl:edit"
      ],
      "port": 24008,
      "status": "active",
      "tunnel": {
        "private_ip": "10.0.0.1",
        "vnet_id": "7365377a-85a4-4390-9480-531ef7dc7a3c"
      }
    },
    "modified_on": "2014-01-01T05:20:00Z",
    "policy_restrictions": "(country: US) or (region: EU)",
    "priority": 1,
    "signature": "SHA256WithRSA",
    "status": "active",
    "uploaded_on": "2014-01-01T05:20:00Z"
  }
}
```