SSL

ssl

SSL

Analyze

ssl.analyze

Methods

Analyze Certificate -> Envelope<unknown>
post/zones/{zone_id}/ssl/analyze

Returns the set of hostnames, the signature algorithm, and the expiration date of the certificate.

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...
Status = "initializing" | "pending_validation" | "deleted" | 18 more...
ValidationMethod = "http" | "cname" | "txt"

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

SSLUniversal

Settings

ssl.universal.settings

Methods

Edit Universal SSL Settings -> Envelope<>
patch/zones/{zone_id}/ssl/universal/settings

Patch Universal SSL Settings 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

Response fields
errors: Array<>
messages: Array<>
success: true

Whether the API call was successful

result:
Optional
Request example
200Example
Universal SSL Settings Details -> Envelope<>
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<>>
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... }