Cloudflare API | SSL › Analyze › Analyze Certificate

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.

certificate: string

Optional

The zone's SSL certificate or certificate and the intermediate(s).

Response fields

errors: Array<

ResponseInfo

messages: Array<

ResponseInfo

success: true

Whether the API call was successful

result: unknown

Optional

Request example

curl https://api.cloudflare.com/client/v4/zones/$ZONE_ID/ssl/analyze \
    -H 'Content-Type: application/json' \
    -H "X-Auth-Email: $CLOUDFLARE_EMAIL" \
    -H "X-Auth-Key: $CLOUDFLARE_API_KEY" \
    -d '{
      "bundle_method": "ubiquitous",
      "certificate": "-----BEGIN CERTIFICATE-----\\nMIIDtTCCAp2gAwIBAgIJAMHAwfXZ5/PWMA0GCSqGSIb3DQEBCwUAMEUxCzAJBgNV\\nBAYTAkFVMRMwEQYDVQQIEwpTb21lLVN0YXRlMSEwHwYDVQQKExhJbnRlcm5ldCBX\\naWRnaXRzIFB0eSBMdGQwHhcNMTYwODI0MTY0MzAxWhcNMTYxMTIyMTY0MzAxWjBF\\nMQswCQYDVQQGEwJBVTETMBEGA1UECBMKU29tZS1TdGF0ZTEhMB8GA1UEChMYSW50\\nZXJuZXQgV2lkZ2l0cyBQdHkgTHRkMIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIB\\nCgKCAQEAwQHoetcl9+5ikGzV6cMzWtWPJHqXT3wpbEkRU9Yz7lgvddmGdtcGbg/1\\nCGZu0jJGkMoppoUo4c3dts3iwqRYmBikUP77wwY2QGmDZw2FvkJCJlKnabIRuGvB\\nKwzESIXgKk2016aTP6/dAjEHyo6SeoK8lkIySUvK0fyOVlsiEsCmOpidtnKX/a+5\\n0GjB79CJH4ER2lLVZnhePFR/zUOyPxZQQ4naHf7yu/b5jhO0f8fwt+pyFxIXjbEI\\ndZliWRkRMtzrHOJIhrmJ2A1J7iOrirbbwillwjjNVUWPf3IJ3M12S9pEewooaeO2\\nizNTERcG9HzAacbVRn2Y2SWIyT/18QIDAQABo4GnMIGkMB0GA1UdDgQWBBT/LbE4\\n9rWf288N6sJA5BRb6FJIGDB1BgNVHSMEbjBsgBT/LbE49rWf288N6sJA5BRb6FJI\\nGKFJpEcwRTELMAkGA1UEBhMCQVUxEzARBgNVBAgTClNvbWUtU3RhdGUxITAfBgNV\\nBAoTGEludGVybmV0IFdpZGdpdHMgUHR5IEx0ZIIJAMHAwfXZ5/PWMAwGA1UdEwQF\\nMAMBAf8wDQYJKoZIhvcNAQELBQADggEBAHHFwl0tH0quUYZYO0dZYt4R7SJ0pCm2\\n2satiyzHl4OnXcHDpekAo7/a09c6Lz6AU83cKy/+x3/djYHXWba7HpEu0dR3ugQP\\nMlr4zrhd9xKZ0KZKiYmtJH+ak4OM4L3FbT0owUZPyjLSlhMtJVcoRp5CJsjAMBUG\\nSvD8RX+T01wzox/Qb+lnnNnOlaWpqu8eoOenybxKp1a9ULzIVvN/LAcc+14vioFq\\n2swRWtmocBAs8QR9n4uvbpiYvS8eYueDCWMM4fvFfBhaDZ3N9IbtySh3SpFdQDhw\\nYbjM2rxXiyLGxB4Bol7QTv4zHif7Zt89FReT/NBy4rzaskDJY5L6xmY=\\n-----END CERTIFICATE-----\\n"
    }'

200Example

{
  "errors": [
    {
      "code": 1000,
      "message": "message"
    }
  ],
  "messages": [
    {
      "code": 1000,
      "message": "message"
    }
  ],
  "success": true,
  "result": {}
}

SSL

Certificate Packs

ssl.certificate_packs

Methods

Order Advanced Certificate Manager Certificate Pack -> Envelope<{ id, certificate_authority, cloudflare_branding, 5 more... }>

post/zones/{zone_id}/ssl/certificate_packs/order

For a given zone, order an advanced certificate pack.

Delete Advanced Certificate Manager Certificate Pack -> Envelope<{ id }>

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

For a given zone, delete an advanced certificate pack.

Restart Validation Or Update Advanced Certificate Manager Certificate Pack -> Envelope<{ id, certificate_authority, cloudflare_branding, 5 more... }>

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

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...

The number of days for which the certificate should be valid.

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

Status of certificate pack.

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

Validation method in use for a certificate pack order.

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_id}/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.

Domain types

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