Re-prioritize SSL Certificates

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.

application/json

Body

result

required

Any of

allOf {2}

array[object (custom-certificate) {14}]

allOf {2}

One of

array[object (custom-certificate) {14}]

object

bundle_method

enum<string>

bundle_method

required

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.

Allowed values:

ubiquitousoptimalforce

Default:

ubiquitous

Example:

ubiquitous

expires_on

string <date-time>

components-schemas-expires_on

read-onlyrequired

When the certificate from the authority expires.

Example:

2016-01-01T05:20:00Z

geo_restrictions

object

geo_restrictions

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.

hosts

array[string]

hosts

required

string

custom-certificate_components-schemas-identifier

read-onlyrequired

Custom certificate identifier tag.

<= 36 characters

Example:

2458ce5a-0c35-4c7f-82c7-8e9487d3ff60

issuer

string

issuer

read-onlyrequired

The certificate authority that issued the certificate.

Example:

GlobalSign

keyless_server

object

keyless-certificate

optional

modified_on

string <date-time>

components-schemas-modified_on

read-onlyrequired

When the certificate was last modified.

Example:

2014-01-01T05:20:00Z

policy

string

policy

optional

Specify the policy that determines the region where your private key will be held locally. 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. Any combination of countries, specified by their two letter country code (https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2#Officially_assigned_code_elements) can be chosen, such as 'country: IN', as well as 'region: EU' which refers to the EU region. If there are too few data centers satisfying the policy, it will be rejected.

Example:

(country: US) or (region: EU)

priority

number

schemas-priority

required

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.

Default:

Example:

signature

string

signature

read-onlyrequired

The type of hash used for the certificate.

Example:

SHA256WithRSA

status

custom-certificate_components-schemas-status

read-onlyrequired

Status of the zone's custom SSL.

Allowed values:

activeexpireddeletedpendinginitializing

Example:

active

uploaded_on

string <date-time>

uploaded_on

read-onlyrequired

When the certificate was uploaded to Cloudflare.

Example:

2014-01-01T05:20:00Z

zone_id

string

common_components-schemas-identifier

read-onlyrequired

Identifier

<= 32 characters

Example:

023e105f4ecef8ad9ca31a8372d0c353

errors

array [object {2}]

messages

required

Example:

[]

code

integer

required

>= 1000

message

string

required

messages

array [object {2}]

messages

required

Example:

[]

code

integer

required

>= 1000

message

string

required

success

enum<boolean>

required

Whether the API call was successful

Allowed value:

true

Example:

true

result_info

object

result_info

optional

count

number

optional

Total number of results for the requested service

Example:

page

number

optional

Current page within paginated list of results

Example:

per_page

number

optional

Number of results per page of results

Example:

total_count

number

optional

Total results available without any search parameters

Example:

2000

Example

{
    "errors": [],
    "messages": [],
    "result": [
        {
            "bundle_method": "ubiquitous",
            "expires_on": "2016-01-01T05:20:00Z",
            "geo_restrictions": {
                "label": "us"
            },
            "hosts": [
                "example.com"
            ],
            "id": "2458ce5a-0c35-4c7f-82c7-8e9487d3ff60",
            "issuer": "GlobalSign",
            "keyless_server": {
                "created_on": "2014-01-01T05:20:00Z",
                "enabled": false,
                "host": "example.com",
                "id": "4d2844d2ce78891c34d0b6c0535a291e",
                "modified_on": "2014-01-01T05:20:00Z",
                "name": "example.com Keyless SSL",
                "permissions": [
                    "#ssl:read",
                    "#ssl:edit"
                ],
                "port": 24008,
                "status": "active"
            },
            "modified_on": "2014-01-01T05:20:00Z",
            "policy": "(country: US) or (region: EU)",
            "priority": 1,
            "signature": "SHA256WithRSA",
            "status": "active",
            "uploaded_on": "2014-01-01T05:20:00Z",
            "zone_id": "023e105f4ecef8ad9ca31a8372d0c353"
        }
    ],
    "success": true,
    "result_info": {
        "count": 1,
        "page": 1,
        "per_page": 20,
        "total_count": 2000
    }
}

Re-prioritize SSL Certificates

Request

Request samples

Responses