Cloudflare API | Custom Certificates › List SSL Configurations

Upload a new private key and/or PEM/CRT for the SSL certificate. Note: PATCHing a configuration for sni_custom certificates will result in a new resource id being returned, and the previous one being deleted.

SSL Configuration Details -> Envelope<

CustomCertificate

get/zones/{zone_id}/custom_certificates/{custom_certificate_id}

SSL Configuration Details

List SSL Configurations -> V4PagePaginationArray<

CustomCertificate

get/zones/{zone_id}/custom_certificates

List, search, and filter all of your custom SSL certificates. The higher priority will break ties across overlapping 'legacy_custom' certificates, but 'legacy_custom' certificates will always supercede 'sni_custom' certificates.

Security

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

Parameters

zone_id: string

(maxLength: 32)

Identifier

match:

Optional

Whether to match all search requirements or at least one (any).

"any"

"all"

page: number

Optional

(minimum: 1)

Page number of paginated results.

per_page: number

Optional

(maximum: 50, minimum: 5)

Number of zones per page.

status:

Optional

Status of the zone's custom SSL.

"active"

"expired"

"deleted"

"pending"

"initializing"

Response fields

errors: Array<

ResponseInfo

messages: Array<

ResponseInfo

success: true

Whether the API call was successful

result: Array<

CustomCertificate

Optional

result_info: { count, page, per_page, 1 more... }

Optional

Request example

curl https://api.cloudflare.com/client/v4/zones/$ZONE_ID/custom_certificates \
    -H "X-Auth-Email: $CLOUDFLARE_EMAIL" \
    -H "X-Auth-Key: $CLOUDFLARE_API_KEY"

200Example

{
  "errors": [
    {
      "code": 1000,
      "message": "message"
    }
  ],
  "messages": [
    {
      "code": 1000,
      "message": "message"
    }
  ],
  "success": true,
  "result": [
    {
      "id": "023e105f4ecef8ad9ca31a8372d0c353",
      "bundle_method": "ubiquitous",
      "expires_on": "2016-01-01T05:20:00Z",
      "hosts": [
        "example.com"
      ],
      "issuer": "GlobalSign",
      "modified_on": "2014-01-01T05:20:00Z",
      "priority": 1,
      "signature": "SHA256WithRSA",
      "status": "active",
      "uploaded_on": "2014-01-01T05:20:00Z",
      "zone_id": "023e105f4ecef8ad9ca31a8372d0c353",
      "geo_restrictions": {
        "label": "us"
      },
      "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"
        }
      },
      "policy": "(country: US) or (region: EU)"
    }
  ],
  "result_info": {
    "count": 1,
    "page": 1,
    "per_page": 20,
    "total_count": 2000
  }
}

Domain types

CustomCertificate = { id, bundle_method, expires_on, 11 more... }

GeoRestrictions = { label }

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.

Status = "active" | "pending_reactivation" | "pending_revocation" | 1 more...

Client Certificates may be active or revoked, and the pending_reactivation or pending_revocation represent in-progress asynchronous transitions

Custom Certificates

Prioritize

custom_certificates.prioritize

Methods

Re Prioritize SSL Certificates -> Envelope<Array<

CustomCertificate

put/zones/{zone_id}/custom_certificates/prioritize

If a zone has multiple SSL certificates, you can set the order in which they should be used during a request. The higher priority will break ties across overlapping 'legacy_custom' certificates.