---
title: SSL
---
[Skip to content](#_top)
[API Reference](https://developers.cloudflare.com/api)
Copy Markdown
Open in **Claude**Open in **ChatGPT**Open in **Cursor**
---
**Copy Markdown****View as Markdown**
# SSL
#### SSLAnalyze
##### [Analyze Certificate](https://developers.cloudflare.com/api/resources/ssl/subresources/analyze/methods/create)
POST/zones/{zone\_id}/ssl/analyze
##### ModelsExpand Collapse
AnalyzeCreateResponse = unknown
[Link to this property](<#(resource)%20ssl.analyze%20%3E%20(model)%20analyze_create_response%20%3E%20(schema)>)
#### SSLCertificate Packs
##### [List Certificate Packs](https://developers.cloudflare.com/api/resources/ssl/subresources/certificate_packs/methods/list)
GET/zones/{zone\_id}/ssl/certificate\_packs
##### [Get Certificate Pack](https://developers.cloudflare.com/api/resources/ssl/subresources/certificate_packs/methods/get)
GET/zones/{zone\_id}/ssl/certificate\_packs/{certificate\_pack\_id}
##### [Order Advanced Certificate Manager Certificate Pack](https://developers.cloudflare.com/api/resources/ssl/subresources/certificate_packs/methods/create)
POST/zones/{zone\_id}/ssl/certificate\_packs/order
##### [Restart Validation or Update Advanced Certificate Manager Certificate Pack](https://developers.cloudflare.com/api/resources/ssl/subresources/certificate_packs/methods/edit)
PATCH/zones/{zone\_id}/ssl/certificate\_packs/{certificate\_pack\_id}
##### [Delete Advanced Certificate Manager Certificate Pack](https://developers.cloudflare.com/api/resources/ssl/subresources/certificate_packs/methods/delete)
DELETE/zones/{zone\_id}/ssl/certificate\_packs/{certificate\_pack\_id}
##### ModelsExpand Collapse
Host = string
[Link to this property](<#(resource)%20ssl.certificate_packs%20%3E%20(model)%20host%20%3E%20(schema)>)
RequestValidity = 7or 30or 90or 4 more
The number of days for which the certificate should be valid.
One of the following:
7
Link to this property
30
Link to this property
90
Link to this property
365
Link to this property
730
Link to this property
1095
Link to this property
5475
Link to this property
[Link to this property](<#(resource)%20ssl.certificate_packs%20%3E%20(model)%20request_validity%20%3E%20(schema)>)
Status = "initializing"or "pending\_validation"or "deleted"or 18 more
Status of certificate pack.
One of the following:
"initializing"
Link to this property
"pending\_validation"
Link to this property
"deleted"
Link to this property
"pending\_issuance"
Link to this property
"pending\_deployment"
Link to this property
"pending\_deletion"
Link to this property
"pending\_expiration"
Link to this property
"expired"
Link to this property
"active"
Link to this property
"initializing\_timed\_out"
Link to this property
"validation\_timed\_out"
Link to this property
"issuance\_timed\_out"
Link to this property
"deployment\_timed\_out"
Link to this property
"deletion\_timed\_out"
Link to this property
"pending\_cleanup"
Link to this property
"staging\_deployment"
Link to this property
"staging\_active"
Link to this property
"deactivating"
Link to this property
"inactive"
Link to this property
"backup\_issued"
Link to this property
"holding\_deployment"
Link to this property
[Link to this property](<#(resource)%20ssl.certificate_packs%20%3E%20(model)%20status%20%3E%20(schema)>)
ValidationMethod = "http"or "cname"or "txt"
Validation method in use for a certificate pack order.
One of the following:
"http"
Link to this property
"cname"
Link to this property
"txt"
Link to this property
[Link to this property](<#(resource)%20ssl.certificate_packs%20%3E%20(model)%20validation_method%20%3E%20(schema)>)
CertificatePackListResponse object {id, certificates, hosts, 10 more }
A certificate pack with all its properties.
id: string
The unique identifier for a certificate\_pack.
Link to this property
certificates: array of object {id, hosts, status, 9 more }
Array of certificates in this pack.
id: string
Certificate identifier.
Link to this property
hosts: array of string
Hostnames covered by this certificate.
Link to this property
status: string
Certificate status.
Link to this property
bundle\_method: optional string
Certificate bundle method.
Link to this property
expires\_on: optional string
When the certificate from the authority expires.
formatdate-time
Link to this property
geo\_restrictions: optional object {label }
Specify the region where your private key can be held locally.
label: optional "us"or "eu"or "highest\_security"
One of the following:
"us"
Link to this property
"eu"
Link to this property
"highest\_security"
Link to this property
Link to this property
Link to this property
issuer: optional string
The certificate authority that issued the certificate.
Link to this property
modified\_on: optional string
When the certificate was last modified.
formatdate-time
Link to this property
priority: optional number
The order/priority in which the certificate will be used.
Link to this property
signature: optional string
The type of hash used for the certificate.
Link to this property
uploaded\_on: optional string
When the certificate was uploaded to Cloudflare.
formatdate-time
Link to this property
zone\_id: optional string
Identifier.
maxLength32
Link to this property
Link to this property
hosts: array of Host
Comma separated list of valid host names for the certificate packs. Must contain the zone apex, may not contain more than 50 hosts, and may not be empty.
Link to this property
status: Status
Status of certificate pack.
Link to this property
type: "mh\_custom"or "managed\_hostname"or "sni\_custom"or 5 more
Type of certificate pack.
One of the following:
"mh\_custom"
Link to this property
"managed\_hostname"
Link to this property
"sni\_custom"
Link to this property
"universal"
Link to this property
"advanced"
Link to this property
"total\_tls"
Link to this property
"keyless"
Link to this property
"legacy\_custom"
Link to this property
Link to this property
certificate\_authority: optional "google"or "lets\_encrypt"or "ssl\_com"
Certificate Authority selected for the order. For information on any certificate authority specific details or restrictions see this page for more details.
One of the following:
"google"
Link to this property
"lets\_encrypt"
Link to this property
"ssl\_com"
Link to this property
Link to this property
cloudflare\_branding: optional boolean
Whether or not to add Cloudflare Branding for the order. This will add a subdomain of sni.cloudflaressl.com as the Common Name if set to true.
Link to this property
dcv\_delegation\_records: optional array of object {cname, cname\_target, emails, 5 more }
DCV Delegation records for domain validation.
cname: optional string
The CNAME record hostname for DCV delegation.
Link to this property
cname\_target: optional string
The CNAME record target value for DCV delegation.
Link to this property
emails: optional array of string
The set of email addresses that the certificate authority (CA) will use to complete domain validation.
Link to this property
http\_body: optional string
The content that the certificate authority (CA) will expect to find at the http\_url during the domain validation.
Link to this property
http\_url: optional string
The url that will be checked during domain validation.
Link to this property
status: optional string
Status of the validation record.
Link to this property
txt\_name: optional string
The hostname that the certificate authority (CA) will check for a TXT record during domain validation .
Link to this property
txt\_value: optional string
The TXT record that the certificate authority (CA) will check during domain validation.
Link to this property
Link to this property
primary\_certificate: optional string
Identifier of the primary certificate in a pack.
Link to this property
validation\_errors: optional array of object {message }
Domain validation errors that have been received by the certificate authority (CA).
message: optional string
A domain validation error.
Link to this property
Link to this property
validation\_method: optional "txt"or "http"or "email"
Validation Method selected for the order.
One of the following:
"txt"
Link to this property
"http"
Link to this property
"email"
Link to this property
Link to this property
validation\_records: optional array of object {cname, cname\_target, emails, 5 more }
Certificates’ validation records.
cname: optional string
The CNAME record hostname for DCV delegation.
Link to this property
cname\_target: optional string
The CNAME record target value for DCV delegation.
Link to this property
emails: optional array of string
The set of email addresses that the certificate authority (CA) will use to complete domain validation.
Link to this property
http\_body: optional string
The content that the certificate authority (CA) will expect to find at the http\_url during the domain validation.
Link to this property
http\_url: optional string
The url that will be checked during domain validation.
Link to this property
status: optional string
Status of the validation record.
Link to this property
txt\_name: optional string
The hostname that the certificate authority (CA) will check for a TXT record during domain validation .
Link to this property
txt\_value: optional string
The TXT record that the certificate authority (CA) will check during domain validation.
Link to this property
Link to this property
validity\_days: optional 14or 30or 90or 365
Validity Days selected for the order.
One of the following:
14
Link to this property
30
Link to this property
90
Link to this property
365
Link to this property
Link to this property
[Link to this property](<#(resource)%20ssl.certificate_packs%20%3E%20(model)%20certificate_pack_list_response%20%3E%20(schema)>)
CertificatePackGetResponse object {id, certificates, hosts, 10 more }
A certificate pack with all its properties.
id: string
The unique identifier for a certificate\_pack.
Link to this property
certificates: array of object {id, hosts, status, 9 more }
Array of certificates in this pack.
id: string
Certificate identifier.
Link to this property
hosts: array of string
Hostnames covered by this certificate.
Link to this property
status: string
Certificate status.
Link to this property
bundle\_method: optional string
Certificate bundle method.
Link to this property
expires\_on: optional string
When the certificate from the authority expires.
formatdate-time
Link to this property
geo\_restrictions: optional object {label }
Specify the region where your private key can be held locally.
label: optional "us"or "eu"or "highest\_security"
One of the following:
"us"
Link to this property
"eu"
Link to this property
"highest\_security"
Link to this property
Link to this property
Link to this property
issuer: optional string
The certificate authority that issued the certificate.
Link to this property
modified\_on: optional string
When the certificate was last modified.
formatdate-time
Link to this property
priority: optional number
The order/priority in which the certificate will be used.
Link to this property
signature: optional string
The type of hash used for the certificate.
Link to this property
uploaded\_on: optional string
When the certificate was uploaded to Cloudflare.
formatdate-time
Link to this property
zone\_id: optional string
Identifier.
maxLength32
Link to this property
Link to this property
hosts: array of Host
Comma separated list of valid host names for the certificate packs. Must contain the zone apex, may not contain more than 50 hosts, and may not be empty.
Link to this property
status: Status
Status of certificate pack.
Link to this property
type: "mh\_custom"or "managed\_hostname"or "sni\_custom"or 5 more
Type of certificate pack.
One of the following:
"mh\_custom"
Link to this property
"managed\_hostname"
Link to this property
"sni\_custom"
Link to this property
"universal"
Link to this property
"advanced"
Link to this property
"total\_tls"
Link to this property
"keyless"
Link to this property
"legacy\_custom"
Link to this property
Link to this property
certificate\_authority: optional "google"or "lets\_encrypt"or "ssl\_com"
Certificate Authority selected for the order. For information on any certificate authority specific details or restrictions see this page for more details.
One of the following:
"google"
Link to this property
"lets\_encrypt"
Link to this property
"ssl\_com"
Link to this property
Link to this property
cloudflare\_branding: optional boolean
Whether or not to add Cloudflare Branding for the order. This will add a subdomain of sni.cloudflaressl.com as the Common Name if set to true.
Link to this property
dcv\_delegation\_records: optional array of object {cname, cname\_target, emails, 5 more }
DCV Delegation records for domain validation.
cname: optional string
The CNAME record hostname for DCV delegation.
Link to this property
cname\_target: optional string
The CNAME record target value for DCV delegation.
Link to this property
emails: optional array of string
The set of email addresses that the certificate authority (CA) will use to complete domain validation.
Link to this property
http\_body: optional string
The content that the certificate authority (CA) will expect to find at the http\_url during the domain validation.
Link to this property
http\_url: optional string
The url that will be checked during domain validation.
Link to this property
status: optional string
Status of the validation record.
Link to this property
txt\_name: optional string
The hostname that the certificate authority (CA) will check for a TXT record during domain validation .
Link to this property
txt\_value: optional string
The TXT record that the certificate authority (CA) will check during domain validation.
Link to this property
Link to this property
primary\_certificate: optional string
Identifier of the primary certificate in a pack.
Link to this property
validation\_errors: optional array of object {message }
Domain validation errors that have been received by the certificate authority (CA).
message: optional string
A domain validation error.
Link to this property
Link to this property
validation\_method: optional "txt"or "http"or "email"
Validation Method selected for the order.
One of the following:
"txt"
Link to this property
"http"
Link to this property
"email"
Link to this property
Link to this property
validation\_records: optional array of object {cname, cname\_target, emails, 5 more }
Certificates’ validation records.
cname: optional string
The CNAME record hostname for DCV delegation.
Link to this property
cname\_target: optional string
The CNAME record target value for DCV delegation.
Link to this property
emails: optional array of string
The set of email addresses that the certificate authority (CA) will use to complete domain validation.
Link to this property
http\_body: optional string
The content that the certificate authority (CA) will expect to find at the http\_url during the domain validation.
Link to this property
http\_url: optional string
The url that will be checked during domain validation.
Link to this property
status: optional string
Status of the validation record.
Link to this property
txt\_name: optional string
The hostname that the certificate authority (CA) will check for a TXT record during domain validation .
Link to this property
txt\_value: optional string
The TXT record that the certificate authority (CA) will check during domain validation.
Link to this property
Link to this property
validity\_days: optional 14or 30or 90or 365
Validity Days selected for the order.
One of the following:
14
Link to this property
30
Link to this property
90
Link to this property
365
Link to this property
Link to this property
[Link to this property](<#(resource)%20ssl.certificate_packs%20%3E%20(model)%20certificate_pack_get_response%20%3E%20(schema)>)
CertificatePackCreateResponse object {id, certificates, hosts, 10 more }
A certificate pack with all its properties.
id: string
The unique identifier for a certificate\_pack.
Link to this property
certificates: array of object {id, hosts, status, 9 more }
Array of certificates in this pack.
id: string
Certificate identifier.
Link to this property
hosts: array of string
Hostnames covered by this certificate.
Link to this property
status: string
Certificate status.
Link to this property
bundle\_method: optional string
Certificate bundle method.
Link to this property
expires\_on: optional string
When the certificate from the authority expires.
formatdate-time
Link to this property
geo\_restrictions: optional object {label }
Specify the region where your private key can be held locally.
label: optional "us"or "eu"or "highest\_security"
One of the following:
"us"
Link to this property
"eu"
Link to this property
"highest\_security"
Link to this property
Link to this property
Link to this property
issuer: optional string
The certificate authority that issued the certificate.
Link to this property
modified\_on: optional string
When the certificate was last modified.
formatdate-time
Link to this property
priority: optional number
The order/priority in which the certificate will be used.
Link to this property
signature: optional string
The type of hash used for the certificate.
Link to this property
uploaded\_on: optional string
When the certificate was uploaded to Cloudflare.
formatdate-time
Link to this property
zone\_id: optional string
Identifier.
maxLength32
Link to this property
Link to this property
hosts: array of Host
Comma separated list of valid host names for the certificate packs. Must contain the zone apex, may not contain more than 50 hosts, and may not be empty.
Link to this property
status: Status
Status of certificate pack.
Link to this property
type: "mh\_custom"or "managed\_hostname"or "sni\_custom"or 5 more
Type of certificate pack.
One of the following:
"mh\_custom"
Link to this property
"managed\_hostname"
Link to this property
"sni\_custom"
Link to this property
"universal"
Link to this property
"advanced"
Link to this property
"total\_tls"
Link to this property
"keyless"
Link to this property
"legacy\_custom"
Link to this property
Link to this property
certificate\_authority: optional "google"or "lets\_encrypt"or "ssl\_com"
Certificate Authority selected for the order. For information on any certificate authority specific details or restrictions see this page for more details.
One of the following:
"google"
Link to this property
"lets\_encrypt"
Link to this property
"ssl\_com"
Link to this property
Link to this property
cloudflare\_branding: optional boolean
Whether or not to add Cloudflare Branding for the order. This will add a subdomain of sni.cloudflaressl.com as the Common Name if set to true.
Link to this property
dcv\_delegation\_records: optional array of object {cname, cname\_target, emails, 5 more }
DCV Delegation records for domain validation.
cname: optional string
The CNAME record hostname for DCV delegation.
Link to this property
cname\_target: optional string
The CNAME record target value for DCV delegation.
Link to this property
emails: optional array of string
The set of email addresses that the certificate authority (CA) will use to complete domain validation.
Link to this property
http\_body: optional string
The content that the certificate authority (CA) will expect to find at the http\_url during the domain validation.
Link to this property
http\_url: optional string
The url that will be checked during domain validation.
Link to this property
status: optional string
Status of the validation record.
Link to this property
txt\_name: optional string
The hostname that the certificate authority (CA) will check for a TXT record during domain validation .
Link to this property
txt\_value: optional string
The TXT record that the certificate authority (CA) will check during domain validation.
Link to this property
Link to this property
primary\_certificate: optional string
Identifier of the primary certificate in a pack.
Link to this property
validation\_errors: optional array of object {message }
Domain validation errors that have been received by the certificate authority (CA).
message: optional string
A domain validation error.
Link to this property
Link to this property
validation\_method: optional "txt"or "http"or "email"
Validation Method selected for the order.
One of the following:
"txt"
Link to this property
"http"
Link to this property
"email"
Link to this property
Link to this property
validation\_records: optional array of object {cname, cname\_target, emails, 5 more }
Certificates’ validation records.
cname: optional string
The CNAME record hostname for DCV delegation.
Link to this property
cname\_target: optional string
The CNAME record target value for DCV delegation.
Link to this property
emails: optional array of string
The set of email addresses that the certificate authority (CA) will use to complete domain validation.
Link to this property
http\_body: optional string
The content that the certificate authority (CA) will expect to find at the http\_url during the domain validation.
Link to this property
http\_url: optional string
The url that will be checked during domain validation.
Link to this property
status: optional string
Status of the validation record.
Link to this property
txt\_name: optional string
The hostname that the certificate authority (CA) will check for a TXT record during domain validation .
Link to this property
txt\_value: optional string
The TXT record that the certificate authority (CA) will check during domain validation.
Link to this property
Link to this property
validity\_days: optional 14or 30or 90or 365
Validity Days selected for the order.
One of the following:
14
Link to this property
30
Link to this property
90
Link to this property
365
Link to this property
Link to this property
[Link to this property](<#(resource)%20ssl.certificate_packs%20%3E%20(model)%20certificate_pack_create_response%20%3E%20(schema)>)
CertificatePackEditResponse object {id, certificates, hosts, 10 more }
A certificate pack with all its properties.
id: string
The unique identifier for a certificate\_pack.
Link to this property
certificates: array of object {id, hosts, status, 9 more }
Array of certificates in this pack.
id: string
Certificate identifier.
Link to this property
hosts: array of string
Hostnames covered by this certificate.
Link to this property
status: string
Certificate status.
Link to this property
bundle\_method: optional string
Certificate bundle method.
Link to this property
expires\_on: optional string
When the certificate from the authority expires.
formatdate-time
Link to this property
geo\_restrictions: optional object {label }
Specify the region where your private key can be held locally.
label: optional "us"or "eu"or "highest\_security"
One of the following:
"us"
Link to this property
"eu"
Link to this property
"highest\_security"
Link to this property
Link to this property
Link to this property
issuer: optional string
The certificate authority that issued the certificate.
Link to this property
modified\_on: optional string
When the certificate was last modified.
formatdate-time
Link to this property
priority: optional number
The order/priority in which the certificate will be used.
Link to this property
signature: optional string
The type of hash used for the certificate.
Link to this property
uploaded\_on: optional string
When the certificate was uploaded to Cloudflare.
formatdate-time
Link to this property
zone\_id: optional string
Identifier.
maxLength32
Link to this property
Link to this property
hosts: array of Host
Comma separated list of valid host names for the certificate packs. Must contain the zone apex, may not contain more than 50 hosts, and may not be empty.
Link to this property
status: Status
Status of certificate pack.
Link to this property
type: "mh\_custom"or "managed\_hostname"or "sni\_custom"or 5 more
Type of certificate pack.
One of the following:
"mh\_custom"
Link to this property
"managed\_hostname"
Link to this property
"sni\_custom"
Link to this property
"universal"
Link to this property
"advanced"
Link to this property
"total\_tls"
Link to this property
"keyless"
Link to this property
"legacy\_custom"
Link to this property
Link to this property
certificate\_authority: optional "google"or "lets\_encrypt"or "ssl\_com"
Certificate Authority selected for the order. For information on any certificate authority specific details or restrictions see this page for more details.
One of the following:
"google"
Link to this property
"lets\_encrypt"
Link to this property
"ssl\_com"
Link to this property
Link to this property
cloudflare\_branding: optional boolean
Whether or not to add Cloudflare Branding for the order. This will add a subdomain of sni.cloudflaressl.com as the Common Name if set to true.
Link to this property
dcv\_delegation\_records: optional array of object {cname, cname\_target, emails, 5 more }
DCV Delegation records for domain validation.
cname: optional string
The CNAME record hostname for DCV delegation.
Link to this property
cname\_target: optional string
The CNAME record target value for DCV delegation.
Link to this property
emails: optional array of string
The set of email addresses that the certificate authority (CA) will use to complete domain validation.
Link to this property
http\_body: optional string
The content that the certificate authority (CA) will expect to find at the http\_url during the domain validation.
Link to this property
http\_url: optional string
The url that will be checked during domain validation.
Link to this property
status: optional string
Status of the validation record.
Link to this property
txt\_name: optional string
The hostname that the certificate authority (CA) will check for a TXT record during domain validation .
Link to this property
txt\_value: optional string
The TXT record that the certificate authority (CA) will check during domain validation.
Link to this property
Link to this property
primary\_certificate: optional string
Identifier of the primary certificate in a pack.
Link to this property
validation\_errors: optional array of object {message }
Domain validation errors that have been received by the certificate authority (CA).
message: optional string
A domain validation error.
Link to this property
Link to this property
validation\_method: optional "txt"or "http"or "email"
Validation Method selected for the order.
One of the following:
"txt"
Link to this property
"http"
Link to this property
"email"
Link to this property
Link to this property
validation\_records: optional array of object {cname, cname\_target, emails, 5 more }
Certificates’ validation records.
cname: optional string
The CNAME record hostname for DCV delegation.
Link to this property
cname\_target: optional string
The CNAME record target value for DCV delegation.
Link to this property
emails: optional array of string
The set of email addresses that the certificate authority (CA) will use to complete domain validation.
Link to this property
http\_body: optional string
The content that the certificate authority (CA) will expect to find at the http\_url during the domain validation.
Link to this property
http\_url: optional string
The url that will be checked during domain validation.
Link to this property
status: optional string
Status of the validation record.
Link to this property
txt\_name: optional string
The hostname that the certificate authority (CA) will check for a TXT record during domain validation .
Link to this property
txt\_value: optional string
The TXT record that the certificate authority (CA) will check during domain validation.
Link to this property
Link to this property
validity\_days: optional 14or 30or 90or 365
Validity Days selected for the order.
One of the following:
14
Link to this property
30
Link to this property
90
Link to this property
365
Link to this property
Link to this property
[Link to this property](<#(resource)%20ssl.certificate_packs%20%3E%20(model)%20certificate_pack_edit_response%20%3E%20(schema)>)
CertificatePackDeleteResponse object {id }
id: optional string
The unique identifier for a certificate\_pack.
Link to this property
[Link to this property](<#(resource)%20ssl.certificate_packs%20%3E%20(model)%20certificate_pack_delete_response%20%3E%20(schema)>)
#### SSLCertificate PacksQuota
##### [Get Certificate Pack Quotas](https://developers.cloudflare.com/api/resources/ssl/subresources/certificate_packs/subresources/quota/methods/get)
GET/zones/{zone\_id}/ssl/certificate\_packs/quota
##### ModelsExpand Collapse
QuotaGetResponse object {advanced }
advanced: optional object {allocated, used }
allocated: optional number
Quantity Allocated.
Link to this property
used: optional number
Quantity Used.
Link to this property
Link to this property
[Link to this property](<#(resource)%20ssl.certificate_packs.quota%20%3E%20(model)%20quota_get_response%20%3E%20(schema)>)
#### SSLRecommendations
##### [SSL/TLS Recommendation](https://developers.cloudflare.com/api/resources/ssl/subresources/recommendations/methods/get)
Deprecated
GET/zones/{zone\_id}/ssl/recommendation
##### ModelsExpand Collapse
RecommendationGetResponse object {id, editable, modified\_on, 2 more }
id: string
Link to this property
editable: boolean
Whether this setting can be updated or not.
Link to this property
modified\_on: string
Last time this setting was modified.
formatdate-time
Link to this property
value: "auto"or "custom"
Current setting of the automatic SSL/TLS.
One of the following:
"auto"
Link to this property
"custom"
Link to this property
Link to this property
next\_scheduled\_scan: optional string
Next time this zone will be scanned by the Automatic SSL/TLS.
formatdate-time
Link to this property
[Link to this property](<#(resource)%20ssl.recommendations%20%3E%20(model)%20recommendation_get_response%20%3E%20(schema)>)
#### SSLAutomatic Upgrader
##### [Get Automatic SSL/TLS enrollment status for the given zone](https://developers.cloudflare.com/api/resources/ssl/subresources/automatic_upgrader/methods/get)
GET/zones/{zone\_id}/settings/ssl\_automatic\_mode
##### [Patch Automatic SSL/TLS Enrollment status for given zone](https://developers.cloudflare.com/api/resources/ssl/subresources/automatic_upgrader/methods/patch)
PATCH/zones/{zone\_id}/settings/ssl\_automatic\_mode
##### ModelsExpand Collapse
AutomaticUpgraderGetResponse object {id, editable, modified\_on, 2 more }
id: string
Link to this property
editable: boolean
Whether this setting can be updated or not.
Link to this property
modified\_on: string
Last time this setting was modified.
formatdate-time
Link to this property
value: "auto"or "custom"
Current setting of the automatic SSL/TLS.
One of the following:
"auto"
Link to this property
"custom"
Link to this property
Link to this property
next\_scheduled\_scan: optional string
Next time this zone will be scanned by the Automatic SSL/TLS.
formatdate-time
Link to this property
[Link to this property](<#(resource)%20ssl.automatic_upgrader%20%3E%20(model)%20automatic_upgrader_get_response%20%3E%20(schema)>)
AutomaticUpgraderPatchResponse object {id, editable, modified\_on, 2 more }
id: string
Link to this property
editable: boolean
Whether this setting can be updated or not.
Link to this property
modified\_on: string
Last time this setting was modified.
formatdate-time
Link to this property
value: "auto"or "custom"
Current setting of the automatic SSL/TLS.
One of the following:
"auto"
Link to this property
"custom"
Link to this property
Link to this property
next\_scheduled\_scan: optional string
Next time this zone will be scanned by the Automatic SSL/TLS.
formatdate-time
Link to this property
[Link to this property](<#(resource)%20ssl.automatic_upgrader%20%3E%20(model)%20automatic_upgrader_patch_response%20%3E%20(schema)>)
#### SSLAuto Origin TLS Kex
##### [Get Auto-Origin TLS KEX enrollment status for the given zone](https://developers.cloudflare.com/api/resources/ssl/subresources/auto_origin_tls_kex/methods/get)
GET/zones/{zone\_id}/settings/auto\_origin\_tls\_kex
##### [Patch Auto-Origin TLS KEX enrollment status for the given zone](https://developers.cloudflare.com/api/resources/ssl/subresources/auto_origin_tls_kex/methods/edit)
PATCH/zones/{zone\_id}/settings/auto\_origin\_tls\_kex
##### ModelsExpand Collapse
AutoOriginTLSKexGetResponse object {id, enabled, modified\_on }
id: string
Link to this property
enabled: boolean
Whether Auto-Origin TLS KEX selection is enabled for the zone.
Link to this property
modified\_on: string
Last time this setting was modified.
formatdate-time
Link to this property
[Link to this property](<#(resource)%20ssl.auto_origin_tls_kex%20%3E%20(model)%20auto_origin_tls_kex_get_response%20%3E%20(schema)>)
AutoOriginTLSKexEditResponse object {id, enabled, modified\_on }
id: string
Link to this property
enabled: boolean
Whether Auto-Origin TLS KEX selection is enabled for the zone.
Link to this property
modified\_on: string
Last time this setting was modified.
formatdate-time
Link to this property
[Link to this property](<#(resource)%20ssl.auto_origin_tls_kex%20%3E%20(model)%20auto_origin_tls_kex_edit_response%20%3E%20(schema)>)
#### SSLUniversal
#### SSLUniversalSettings
##### [Universal SSL Settings Details](https://developers.cloudflare.com/api/resources/ssl/subresources/universal/subresources/settings/methods/get)
GET/zones/{zone\_id}/ssl/universal/settings
##### [Edit Universal SSL Settings](https://developers.cloudflare.com/api/resources/ssl/subresources/universal/subresources/settings/methods/edit)
PATCH/zones/{zone\_id}/ssl/universal/settings
##### ModelsExpand Collapse
UniversalSSLSettings object {enabled }
enabled: optional boolean
Disabling Universal SSL removes any currently active Universal SSL certificates for your zone from the edge and prevents any future Universal SSL certificates from being ordered. If there are no advanced certificates or custom certificates uploaded for the domain, visitors will be unable to access the domain over HTTPS.
By disabling Universal SSL, you understand that the following Cloudflare settings and preferences will result in visitors being unable to visit your domain unless you have uploaded a custom certificate or purchased an advanced certificate.
- HSTS
- Always Use HTTPS
- Opportunistic Encryption
- Onion Routing
- Any Page Rules redirecting traffic to HTTPS
Similarly, any HTTP redirect to HTTPS at the origin while the Cloudflare proxy is enabled will result in users being unable to visit your site without a valid certificate at Cloudflare’s edge.
If you do not have a valid custom or advanced certificate at Cloudflare’s edge and are unsure if any of the above Cloudflare settings are enabled, or if any HTTP redirects exist at your origin, we advise leaving Universal SSL enabled for your domain.
Link to this property
[Link to this property](<#(resource)%20ssl.universal.settings%20%3E%20(model)%20universal_ssl_settings%20%3E%20(schema)>)
#### SSLVerification
##### [SSL Verification Details](https://developers.cloudflare.com/api/resources/ssl/subresources/verification/methods/get)
GET/zones/{zone\_id}/ssl/verification
##### [Edit SSL Certificate Pack Validation Method](https://developers.cloudflare.com/api/resources/ssl/subresources/verification/methods/edit)
PATCH/zones/{zone\_id}/ssl/verification/{certificate\_pack\_id}
##### ModelsExpand Collapse
Verification object {certificate\_status, brand\_check, cert\_pack\_uuid, 5 more }
certificate\_status: "initializing"or "authorizing"or "active"or 4 more
Current status of certificate.
One of the following:
"initializing"
Link to this property
"authorizing"
Link to this property
"active"
Link to this property
"expired"
Link to this property
"issuing"
Link to this property
"timing\_out"
Link to this property
"pending\_deployment"
Link to this property
Link to this property
brand\_check: optional boolean
Certificate Authority is manually reviewing the order.
Link to this property
cert\_pack\_uuid: optional string
Certificate Pack UUID.
Link to this property
signature: optional "ECDSAWithSHA256"or "SHA1WithRSA"or "SHA256WithRSA"
Certificate’s signature algorithm.
One of the following:
"ECDSAWithSHA256"
Link to this property
"SHA1WithRSA"
Link to this property
"SHA256WithRSA"
Link to this property
Link to this property
validation\_method: optional ValidationMethod
Validation method in use for a certificate pack order.
Link to this property
verification\_info: optional object {record\_name, record\_target }
Certificate’s required verification information.
record\_name: optional "record\_name"or "http\_url"or "cname"or "txt\_name"
Name of CNAME record.
formathostname
One of the following:
"record\_name"
Link to this property
"http\_url"
Link to this property
"cname"
Link to this property
"txt\_name"
Link to this property
Link to this property
record\_target: optional "record\_value"or "http\_body"or "cname\_target"or "txt\_value"
Target of CNAME record.
formathostname
One of the following:
"record\_value"
Link to this property
"http\_body"
Link to this property
"cname\_target"
Link to this property
"txt\_value"
Link to this property
Link to this property
Link to this property
verification\_status: optional boolean
Status of the required verification information, omitted if verification status is unknown.
Link to this property
verification\_type: optional "cname"or "meta tag"
Method of verification.
One of the following:
"cname"
Link to this property
"meta tag"
Link to this property
Link to this property
[Link to this property](<#(resource)%20ssl.verification%20%3E%20(model)%20verification%20%3E%20(schema)>)
VerificationGetResponse = array of Verification { certificate\_status, brand\_check, cert\_pack\_uuid, 5 more }
certificate\_status: "initializing"or "authorizing"or "active"or 4 more
Current status of certificate.
One of the following:
"initializing"
Link to this property
"authorizing"
Link to this property
"active"
Link to this property
"expired"
Link to this property
"issuing"
Link to this property
"timing\_out"
Link to this property
"pending\_deployment"
Link to this property
Link to this property
brand\_check: optional boolean
Certificate Authority is manually reviewing the order.
Link to this property
cert\_pack\_uuid: optional string
Certificate Pack UUID.
Link to this property
signature: optional "ECDSAWithSHA256"or "SHA1WithRSA"or "SHA256WithRSA"
Certificate’s signature algorithm.
One of the following:
"ECDSAWithSHA256"
Link to this property
"SHA1WithRSA"
Link to this property
"SHA256WithRSA"
Link to this property
Link to this property
validation\_method: optional ValidationMethod
Validation method in use for a certificate pack order.
Link to this property
verification\_info: optional object {record\_name, record\_target }
Certificate’s required verification information.
record\_name: optional "record\_name"or "http\_url"or "cname"or "txt\_name"
Name of CNAME record.
formathostname
One of the following:
"record\_name"
Link to this property
"http\_url"
Link to this property
"cname"
Link to this property
"txt\_name"
Link to this property
Link to this property
record\_target: optional "record\_value"or "http\_body"or "cname\_target"or "txt\_value"
Target of CNAME record.
formathostname
One of the following:
"record\_value"
Link to this property
"http\_body"
Link to this property
"cname\_target"
Link to this property
"txt\_value"
Link to this property
Link to this property
Link to this property
verification\_status: optional boolean
Status of the required verification information, omitted if verification status is unknown.
Link to this property
verification\_type: optional "cname"or "meta tag"
Method of verification.
One of the following:
"cname"
Link to this property
"meta tag"
Link to this property
Link to this property
[Link to this property](<#(resource)%20ssl.verification%20%3E%20(model)%20verification_get_response%20%3E%20(schema)>)
VerificationEditResponse object {status, validation\_method }
status: optional string
Result status.
Link to this property
validation\_method: optional "http"or "cname"or "txt"or "email"
Desired validation method.
One of the following:
"http"
Link to this property
"cname"
Link to this property
"txt"
Link to this property
"email"
Link to this property
Link to this property
[Link to this property](<#(resource)%20ssl.verification%20%3E%20(model)%20verification_edit_response%20%3E%20(schema)>)