Cloudflare API | SSL › Verification › SSL Verification Details

For a given zone, restart validation or add cloudflare branding for an advanced certificate pack. The former is only a validation operation for a Certificate Pack in a validation_timed_out status.

Get Certificate Pack -> Envelope<unknown>

get/zones/{zone_id}/ssl/certificate_packs/{certificate_pack_id}

For a given zone, get a certificate pack.

List Certificate Packs -> SinglePage<unknown>

get/zones/{zone_id}/ssl/certificate_packs

For a given zone, list all active certificate packs.

Domain types

Host = string

RequestValidity = 7 | 30 | 90 | 4 more...

Status = "initializing" | "pending_validation" | "deleted" | 18 more...

ValidationMethod = "http" | "cname" | "txt"

SSL Certificate Packs

Quota

ssl.certificate_packs.quota

Methods

Get Certificate Pack Quotas -> Envelope<{ advanced }>

get/zones/{zone_id}/ssl/certificate_packs/quota

For a given zone, list certificate pack quotas.

SSL

Recommendations

ssl.recommendations

Methods

SSL TLS Recommendation -> Envelope<{ id, modified_on, value }>

get/zones/{zone_identifier}/ssl/recommendation

Retrieve the SSL/TLS Recommender's recommendation for a zone.

SSL

Universal

ssl.universal

SSL Universal

Settings

ssl.universal.settings

Methods

Edit Universal SSL Settings -> Envelope<

UniversalSSLSettings

patch/zones/{zone_id}/ssl/universal/settings

Patch Universal SSL Settings for a Zone.

Universal SSL Settings Details -> Envelope<

UniversalSSLSettings

get/zones/{zone_id}/ssl/universal/settings

Get Universal SSL Settings for a Zone.

Domain types

UniversalSSLSettings = { enabled }

SSL

Verification

ssl.verification

Methods

Edit SSL Certificate Pack Validation Method -> Envelope<{ status, validation_method }>

patch/zones/{zone_id}/ssl/verification/{certificate_pack_id}

Edit SSL validation method for a certificate pack. A PATCH request will request an immediate validation check on any certificate, and return the updated status. If a validation method is provided, the validation will be immediately attempted using that method.

SSL Verification Details -> Envelope<Array<

Verification

get/zones/{zone_id}/ssl/verification

Get SSL Verification Info for a Zone.

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

Identifier

retry:

Optional

Immediately retry SSL Verification.

true

Response fields

result: Array<

Verification

Optional

Request example

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

200Example

{
  "result": [
    {
      "certificate_status": "initializing",
      "brand_check": false,
      "cert_pack_uuid": "a77f8bd7-3b47-46b4-a6f1-75cf98109948",
      "signature": "ECDSAWithSHA256",
      "validation_method": "http",
      "verification_info": {
        "record_name": "record_name",
        "record_target": "record_value"
      },
      "verification_status": true,
      "verification_type": "cname"
    }
  ]
}

Domain types

Verification = { certificate_status, brand_check, cert_pack_uuid, 5 more... }