--- title: SSL --- [Skip to content](#_top) [API Reference](https://developers.cloudflare.com/api/python) 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/python/resources/ssl/subresources/analyze/methods/create) ssl.analyze.create(AnalyzeCreateParams\*\*kwargs) -> object POST/zones/{zone\_id}/ssl/analyze #### SSLCertificate Packs ##### [List Certificate Packs](https://developers.cloudflare.com/api/python/resources/ssl/subresources/certificate_packs/methods/list) ssl.certificate\_packs.list(CertificatePackListParams\*\*kwargs) -> SyncV4PagePaginationArray\[[CertificatePackListResponse]()] GET/zones/{zone\_id}/ssl/certificate\_packs ##### [Get Certificate Pack](https://developers.cloudflare.com/api/python/resources/ssl/subresources/certificate_packs/methods/get) ssl.certificate\_packs.get(strcertificate\_pack\_id, CertificatePackGetParams\*\*kwargs) -> [CertificatePackGetResponse]() GET/zones/{zone\_id}/ssl/certificate\_packs/{certificate\_pack\_id} ##### [Order Advanced Certificate Manager Certificate Pack](https://developers.cloudflare.com/api/python/resources/ssl/subresources/certificate_packs/methods/create) ssl.certificate\_packs.create(CertificatePackCreateParams\*\*kwargs) -> [CertificatePackCreateResponse]() POST/zones/{zone\_id}/ssl/certificate\_packs/order ##### [Restart Validation or Update Advanced Certificate Manager Certificate Pack](https://developers.cloudflare.com/api/python/resources/ssl/subresources/certificate_packs/methods/edit) ssl.certificate\_packs.edit(strcertificate\_pack\_id, CertificatePackEditParams\*\*kwargs) -> [CertificatePackEditResponse]() PATCH/zones/{zone\_id}/ssl/certificate\_packs/{certificate\_pack\_id} ##### [Delete Advanced Certificate Manager Certificate Pack](https://developers.cloudflare.com/api/python/resources/ssl/subresources/certificate_packs/methods/delete) ssl.certificate\_packs.delete(strcertificate\_pack\_id, CertificatePackDeleteParams\*\*kwargs) -> [CertificatePackDeleteResponse]() DELETE/zones/{zone\_id}/ssl/certificate\_packs/{certificate\_pack\_id} ##### ModelsExpand Collapse str [Link to this property](<#(resource)%20ssl.certificate_packs%20%3E%20(model)%20host%20%3E%20(schema)>)
Literal\[7, 30, 90, 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)>)
Literal\["initializing", "pending\_validation", "deleted", 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)>)
Literal\["http", "cname", "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)>)
class CertificatePackListResponse: … A certificate pack with all its properties. id: str The unique identifier for a certificate\_pack. Link to this property
certificates: List\[Certificate] Array of certificates in this pack. id: str Certificate identifier. Link to this property hosts: List\[str] Hostnames covered by this certificate. Link to this property status: str Certificate status. Link to this property bundle\_method: Optional\[str] Certificate bundle method. Link to this property expires\_on: Optional\[datetime] When the certificate from the authority expires. formatdate-time Link to this property
geo\_restrictions: Optional\[CertificateGeoRestrictions] Specify the region where your private key can be held locally.
label: Optional\[Literal\["us", "eu", "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\[str] The certificate authority that issued the certificate. Link to this property modified\_on: Optional\[datetime] When the certificate was last modified. formatdate-time Link to this property priority: Optional\[float] The order/priority in which the certificate will be used. Link to this property signature: Optional\[str] The type of hash used for the certificate. Link to this property uploaded\_on: Optional\[datetime] When the certificate was uploaded to Cloudflare. formatdate-time Link to this property zone\_id: Optional\[str] Identifier. maxLength32 Link to this property
Link to this property hosts: List\[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: Literal\["mh\_custom", "managed\_hostname", "sni\_custom", 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\[Literal\["google", "lets\_encrypt", "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\[bool] 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\[List\[DCVDelegationRecord]] DCV Delegation records for domain validation. cname: Optional\[str] The CNAME record hostname for DCV delegation. Link to this property cname\_target: Optional\[str] The CNAME record target value for DCV delegation. Link to this property emails: Optional\[List\[str]] The set of email addresses that the certificate authority (CA) will use to complete domain validation. Link to this property http\_body: Optional\[str] 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\[str] The url that will be checked during domain validation. Link to this property status: Optional\[str] Status of the validation record. Link to this property txt\_name: Optional\[str] The hostname that the certificate authority (CA) will check for a TXT record during domain validation . Link to this property txt\_value: Optional\[str] The TXT record that the certificate authority (CA) will check during domain validation. Link to this property
Link to this property primary\_certificate: Optional\[str] Identifier of the primary certificate in a pack. Link to this property
validation\_errors: Optional\[List\[ValidationError]] Domain validation errors that have been received by the certificate authority (CA). message: Optional\[str] A domain validation error. Link to this property
Link to this property
validation\_method: Optional\[Literal\["txt", "http", "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\[List\[ValidationRecord]] Certificates’ validation records. cname: Optional\[str] The CNAME record hostname for DCV delegation. Link to this property cname\_target: Optional\[str] The CNAME record target value for DCV delegation. Link to this property emails: Optional\[List\[str]] The set of email addresses that the certificate authority (CA) will use to complete domain validation. Link to this property http\_body: Optional\[str] 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\[str] The url that will be checked during domain validation. Link to this property status: Optional\[str] Status of the validation record. Link to this property txt\_name: Optional\[str] The hostname that the certificate authority (CA) will check for a TXT record during domain validation . Link to this property txt\_value: Optional\[str] The TXT record that the certificate authority (CA) will check during domain validation. Link to this property
Link to this property
validity\_days: Optional\[Literal\[14, 30, 90, 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)>)
class CertificatePackGetResponse: … A certificate pack with all its properties. id: str The unique identifier for a certificate\_pack. Link to this property
certificates: List\[Certificate] Array of certificates in this pack. id: str Certificate identifier. Link to this property hosts: List\[str] Hostnames covered by this certificate. Link to this property status: str Certificate status. Link to this property bundle\_method: Optional\[str] Certificate bundle method. Link to this property expires\_on: Optional\[datetime] When the certificate from the authority expires. formatdate-time Link to this property
geo\_restrictions: Optional\[CertificateGeoRestrictions] Specify the region where your private key can be held locally.
label: Optional\[Literal\["us", "eu", "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\[str] The certificate authority that issued the certificate. Link to this property modified\_on: Optional\[datetime] When the certificate was last modified. formatdate-time Link to this property priority: Optional\[float] The order/priority in which the certificate will be used. Link to this property signature: Optional\[str] The type of hash used for the certificate. Link to this property uploaded\_on: Optional\[datetime] When the certificate was uploaded to Cloudflare. formatdate-time Link to this property zone\_id: Optional\[str] Identifier. maxLength32 Link to this property
Link to this property hosts: List\[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: Literal\["mh\_custom", "managed\_hostname", "sni\_custom", 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\[Literal\["google", "lets\_encrypt", "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\[bool] 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\[List\[DCVDelegationRecord]] DCV Delegation records for domain validation. cname: Optional\[str] The CNAME record hostname for DCV delegation. Link to this property cname\_target: Optional\[str] The CNAME record target value for DCV delegation. Link to this property emails: Optional\[List\[str]] The set of email addresses that the certificate authority (CA) will use to complete domain validation. Link to this property http\_body: Optional\[str] 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\[str] The url that will be checked during domain validation. Link to this property status: Optional\[str] Status of the validation record. Link to this property txt\_name: Optional\[str] The hostname that the certificate authority (CA) will check for a TXT record during domain validation . Link to this property txt\_value: Optional\[str] The TXT record that the certificate authority (CA) will check during domain validation. Link to this property
Link to this property primary\_certificate: Optional\[str] Identifier of the primary certificate in a pack. Link to this property
validation\_errors: Optional\[List\[ValidationError]] Domain validation errors that have been received by the certificate authority (CA). message: Optional\[str] A domain validation error. Link to this property
Link to this property
validation\_method: Optional\[Literal\["txt", "http", "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\[List\[ValidationRecord]] Certificates’ validation records. cname: Optional\[str] The CNAME record hostname for DCV delegation. Link to this property cname\_target: Optional\[str] The CNAME record target value for DCV delegation. Link to this property emails: Optional\[List\[str]] The set of email addresses that the certificate authority (CA) will use to complete domain validation. Link to this property http\_body: Optional\[str] 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\[str] The url that will be checked during domain validation. Link to this property status: Optional\[str] Status of the validation record. Link to this property txt\_name: Optional\[str] The hostname that the certificate authority (CA) will check for a TXT record during domain validation . Link to this property txt\_value: Optional\[str] The TXT record that the certificate authority (CA) will check during domain validation. Link to this property
Link to this property
validity\_days: Optional\[Literal\[14, 30, 90, 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)>)
class CertificatePackCreateResponse: … A certificate pack with all its properties. id: str The unique identifier for a certificate\_pack. Link to this property
certificates: List\[Certificate] Array of certificates in this pack. id: str Certificate identifier. Link to this property hosts: List\[str] Hostnames covered by this certificate. Link to this property status: str Certificate status. Link to this property bundle\_method: Optional\[str] Certificate bundle method. Link to this property expires\_on: Optional\[datetime] When the certificate from the authority expires. formatdate-time Link to this property
geo\_restrictions: Optional\[CertificateGeoRestrictions] Specify the region where your private key can be held locally.
label: Optional\[Literal\["us", "eu", "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\[str] The certificate authority that issued the certificate. Link to this property modified\_on: Optional\[datetime] When the certificate was last modified. formatdate-time Link to this property priority: Optional\[float] The order/priority in which the certificate will be used. Link to this property signature: Optional\[str] The type of hash used for the certificate. Link to this property uploaded\_on: Optional\[datetime] When the certificate was uploaded to Cloudflare. formatdate-time Link to this property zone\_id: Optional\[str] Identifier. maxLength32 Link to this property
Link to this property hosts: List\[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: Literal\["mh\_custom", "managed\_hostname", "sni\_custom", 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\[Literal\["google", "lets\_encrypt", "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\[bool] 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\[List\[DCVDelegationRecord]] DCV Delegation records for domain validation. cname: Optional\[str] The CNAME record hostname for DCV delegation. Link to this property cname\_target: Optional\[str] The CNAME record target value for DCV delegation. Link to this property emails: Optional\[List\[str]] The set of email addresses that the certificate authority (CA) will use to complete domain validation. Link to this property http\_body: Optional\[str] 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\[str] The url that will be checked during domain validation. Link to this property status: Optional\[str] Status of the validation record. Link to this property txt\_name: Optional\[str] The hostname that the certificate authority (CA) will check for a TXT record during domain validation . Link to this property txt\_value: Optional\[str] The TXT record that the certificate authority (CA) will check during domain validation. Link to this property
Link to this property primary\_certificate: Optional\[str] Identifier of the primary certificate in a pack. Link to this property
validation\_errors: Optional\[List\[ValidationError]] Domain validation errors that have been received by the certificate authority (CA). message: Optional\[str] A domain validation error. Link to this property
Link to this property
validation\_method: Optional\[Literal\["txt", "http", "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\[List\[ValidationRecord]] Certificates’ validation records. cname: Optional\[str] The CNAME record hostname for DCV delegation. Link to this property cname\_target: Optional\[str] The CNAME record target value for DCV delegation. Link to this property emails: Optional\[List\[str]] The set of email addresses that the certificate authority (CA) will use to complete domain validation. Link to this property http\_body: Optional\[str] 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\[str] The url that will be checked during domain validation. Link to this property status: Optional\[str] Status of the validation record. Link to this property txt\_name: Optional\[str] The hostname that the certificate authority (CA) will check for a TXT record during domain validation . Link to this property txt\_value: Optional\[str] The TXT record that the certificate authority (CA) will check during domain validation. Link to this property
Link to this property
validity\_days: Optional\[Literal\[14, 30, 90, 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)>)
class CertificatePackEditResponse: … A certificate pack with all its properties. id: str The unique identifier for a certificate\_pack. Link to this property
certificates: List\[Certificate] Array of certificates in this pack. id: str Certificate identifier. Link to this property hosts: List\[str] Hostnames covered by this certificate. Link to this property status: str Certificate status. Link to this property bundle\_method: Optional\[str] Certificate bundle method. Link to this property expires\_on: Optional\[datetime] When the certificate from the authority expires. formatdate-time Link to this property
geo\_restrictions: Optional\[CertificateGeoRestrictions] Specify the region where your private key can be held locally.
label: Optional\[Literal\["us", "eu", "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\[str] The certificate authority that issued the certificate. Link to this property modified\_on: Optional\[datetime] When the certificate was last modified. formatdate-time Link to this property priority: Optional\[float] The order/priority in which the certificate will be used. Link to this property signature: Optional\[str] The type of hash used for the certificate. Link to this property uploaded\_on: Optional\[datetime] When the certificate was uploaded to Cloudflare. formatdate-time Link to this property zone\_id: Optional\[str] Identifier. maxLength32 Link to this property
Link to this property hosts: List\[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: Literal\["mh\_custom", "managed\_hostname", "sni\_custom", 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\[Literal\["google", "lets\_encrypt", "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\[bool] 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\[List\[DCVDelegationRecord]] DCV Delegation records for domain validation. cname: Optional\[str] The CNAME record hostname for DCV delegation. Link to this property cname\_target: Optional\[str] The CNAME record target value for DCV delegation. Link to this property emails: Optional\[List\[str]] The set of email addresses that the certificate authority (CA) will use to complete domain validation. Link to this property http\_body: Optional\[str] 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\[str] The url that will be checked during domain validation. Link to this property status: Optional\[str] Status of the validation record. Link to this property txt\_name: Optional\[str] The hostname that the certificate authority (CA) will check for a TXT record during domain validation . Link to this property txt\_value: Optional\[str] The TXT record that the certificate authority (CA) will check during domain validation. Link to this property
Link to this property primary\_certificate: Optional\[str] Identifier of the primary certificate in a pack. Link to this property
validation\_errors: Optional\[List\[ValidationError]] Domain validation errors that have been received by the certificate authority (CA). message: Optional\[str] A domain validation error. Link to this property
Link to this property
validation\_method: Optional\[Literal\["txt", "http", "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\[List\[ValidationRecord]] Certificates’ validation records. cname: Optional\[str] The CNAME record hostname for DCV delegation. Link to this property cname\_target: Optional\[str] The CNAME record target value for DCV delegation. Link to this property emails: Optional\[List\[str]] The set of email addresses that the certificate authority (CA) will use to complete domain validation. Link to this property http\_body: Optional\[str] 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\[str] The url that will be checked during domain validation. Link to this property status: Optional\[str] Status of the validation record. Link to this property txt\_name: Optional\[str] The hostname that the certificate authority (CA) will check for a TXT record during domain validation . Link to this property txt\_value: Optional\[str] The TXT record that the certificate authority (CA) will check during domain validation. Link to this property
Link to this property
validity\_days: Optional\[Literal\[14, 30, 90, 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)>)
class CertificatePackDeleteResponse: … id: Optional\[str] 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/python/resources/ssl/subresources/certificate_packs/subresources/quota/methods/get) ssl.certificate\_packs.quota.get(QuotaGetParams\*\*kwargs) -> [QuotaGetResponse]() GET/zones/{zone\_id}/ssl/certificate\_packs/quota ##### ModelsExpand Collapse
class QuotaGetResponse: …
advanced: Optional\[Advanced] allocated: Optional\[int] Quantity Allocated. Link to this property used: Optional\[int] 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/python/resources/ssl/subresources/recommendations/methods/get) Deprecated ssl.recommendations.get(RecommendationGetParams\*\*kwargs) -> [RecommendationGetResponse]() GET/zones/{zone\_id}/ssl/recommendation ##### ModelsExpand Collapse
class RecommendationGetResponse: … id: str Link to this property editable: bool Whether this setting can be updated or not. Link to this property modified\_on: datetime Last time this setting was modified. formatdate-time Link to this property
value: Literal\["auto", "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\[datetime] 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 #### SSLAuto Origin TLS Kex ##### [Get Auto-Origin TLS KEX enrollment status for the given zone](https://developers.cloudflare.com/api/python/resources/ssl/subresources/auto_origin_tls_kex/methods/get) ssl.auto\_origin\_tls\_kex.get(AutoOriginTLSKexGetParams\*\*kwargs) -> [AutoOriginTLSKexGetResponse]() 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/python/resources/ssl/subresources/auto_origin_tls_kex/methods/edit) ssl.auto\_origin\_tls\_kex.edit(AutoOriginTLSKexEditParams\*\*kwargs) -> [AutoOriginTLSKexEditResponse]() PATCH/zones/{zone\_id}/settings/auto\_origin\_tls\_kex ##### ModelsExpand Collapse
class AutoOriginTLSKexGetResponse: … id: str Link to this property enabled: bool Whether Auto-Origin TLS KEX selection is enabled for the zone. Link to this property modified\_on: datetime 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)>)
class AutoOriginTLSKexEditResponse: … id: str Link to this property enabled: bool Whether Auto-Origin TLS KEX selection is enabled for the zone. Link to this property modified\_on: datetime 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/python/resources/ssl/subresources/universal/subresources/settings/methods/get) ssl.universal.settings.get(SettingGetParams\*\*kwargs) -> [UniversalSSLSettings]() GET/zones/{zone\_id}/ssl/universal/settings ##### [Edit Universal SSL Settings](https://developers.cloudflare.com/api/python/resources/ssl/subresources/universal/subresources/settings/methods/edit) ssl.universal.settings.edit(SettingEditParams\*\*kwargs) -> [UniversalSSLSettings]() PATCH/zones/{zone\_id}/ssl/universal/settings ##### ModelsExpand Collapse
class UniversalSSLSettings: … enabled: Optional\[bool] 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/python/resources/ssl/subresources/verification/methods/get) ssl.verification.get(VerificationGetParams\*\*kwargs) -> [VerificationGetResponse]() GET/zones/{zone\_id}/ssl/verification ##### [Edit SSL Certificate Pack Validation Method](https://developers.cloudflare.com/api/python/resources/ssl/subresources/verification/methods/edit) ssl.verification.edit(strcertificate\_pack\_id, VerificationEditParams\*\*kwargs) -> [VerificationEditResponse]() PATCH/zones/{zone\_id}/ssl/verification/{certificate\_pack\_id} ##### ModelsExpand Collapse
class Verification: …
certificate\_status: Literal\["initializing", "authorizing", "active", 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\[bool] Certificate Authority is manually reviewing the order. Link to this property cert\_pack\_uuid: Optional\[str] Certificate Pack UUID. Link to this property
signature: Optional\[Literal\["ECDSAWithSHA256", "SHA1WithRSA", "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\[VerificationInfo] Certificate’s required verification information.
record\_name: Optional\[Literal\["record\_name", "http\_url", "cname", "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\[Literal\["record\_value", "http\_body", "cname\_target", "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\[bool] Status of the required verification information, omitted if verification status is unknown. Link to this property
verification\_type: Optional\[Literal\["cname", "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)>)
List\[Verification]
certificate\_status: Literal\["initializing", "authorizing", "active", 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\[bool] Certificate Authority is manually reviewing the order. Link to this property cert\_pack\_uuid: Optional\[str] Certificate Pack UUID. Link to this property
signature: Optional\[Literal\["ECDSAWithSHA256", "SHA1WithRSA", "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\[VerificationInfo] Certificate’s required verification information.
record\_name: Optional\[Literal\["record\_name", "http\_url", "cname", "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\[Literal\["record\_value", "http\_body", "cname\_target", "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\[bool] Status of the required verification information, omitted if verification status is unknown. Link to this property
verification\_type: Optional\[Literal\["cname", "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)>)
class VerificationEditResponse: … status: Optional\[str] Result status. Link to this property
validation\_method: Optional\[Literal\["http", "cname", "txt", "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)>)