Skip to content
Cloudflare API
Start here
API Reference

ACM

ACMTotal TLS

Total TLS Settings Details
acm.total_tls.get(TotalTLSGetParams**kwargs) -> TotalTLSGetResponse
GET/zones/{zone_id}/acm/total_tls
Enable or Disable Total TLS
acm.total_tls.update(TotalTLSUpdateParams**kwargs) -> TotalTLSUpdateResponse
POST/zones/{zone_id}/acm/total_tls
Enable or Disable Total TLS
acm.total_tls.edit(TotalTLSEditParams**kwargs) -> TotalTLSEditResponse
POST/zones/{zone_id}/acm/total_tls
ModelsExpand Collapse
Literal["google", "lets_encrypt", "ssl_com"]

The Certificate Authority that Total TLS certificates will be issued through.

One of the following:
"google"
"lets_encrypt"
"ssl_com"
class TotalTLSGetResponse: …
certificate_authority: Optional[CertificateAuthority]

The Certificate Authority that Total TLS certificates will be issued through.

enabled: Optional[bool]

If enabled, Total TLS will order a hostname specific TLS certificate for any proxied A, AAAA, or CNAME record in your zone.

validity_period: Optional[Literal[90]]

The validity period in days for the certificates ordered via Total TLS.

class TotalTLSUpdateResponse: …
certificate_authority: Optional[CertificateAuthority]

The Certificate Authority that Total TLS certificates will be issued through.

enabled: Optional[bool]

If enabled, Total TLS will order a hostname specific TLS certificate for any proxied A, AAAA, or CNAME record in your zone.

validity_period: Optional[Literal[90]]

The validity period in days for the certificates ordered via Total TLS.

class TotalTLSEditResponse: …
certificate_authority: Optional[CertificateAuthority]

The Certificate Authority that Total TLS certificates will be issued through.

enabled: Optional[bool]

If enabled, Total TLS will order a hostname specific TLS certificate for any proxied A, AAAA, or CNAME record in your zone.

validity_period: Optional[Literal[90]]

The validity period in days for the certificates ordered via Total TLS.

ACMCustom Trust Store

List Custom Origin Trust Store Details
acm.custom_trust_store.list(CustomTrustStoreListParams**kwargs) -> SyncV4PagePaginationArray[CustomTrustStore]
GET/zones/{zone_id}/acm/custom_trust_store
Upload Custom Origin Trust Store
acm.custom_trust_store.create(CustomTrustStoreCreateParams**kwargs) -> CustomTrustStore
POST/zones/{zone_id}/acm/custom_trust_store
Custom Origin Trust Store Details
acm.custom_trust_store.get(strcustom_origin_trust_store_id, CustomTrustStoreGetParams**kwargs) -> CustomTrustStore
GET/zones/{zone_id}/acm/custom_trust_store/{custom_origin_trust_store_id}
Delete Custom Origin Trust Store
acm.custom_trust_store.delete(strcustom_origin_trust_store_id, CustomTrustStoreDeleteParams**kwargs) -> CustomTrustStoreDeleteResponse
DELETE/zones/{zone_id}/acm/custom_trust_store/{custom_origin_trust_store_id}
ModelsExpand Collapse
class CustomTrustStore: …
id: str

Identifier.

maxLength32
certificate: str

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

expires_on: datetime

When the certificate expires.

formatdate-time
issuer: str

The certificate authority that issued the certificate.

signature: str

The type of hash used for the certificate.

status: Literal["initializing", "pending_deployment", "active", 3 more]

Status of the zone's custom SSL.

One of the following:
"initializing"
"pending_deployment"
"active"
"pending_deletion"
"deleted"
"expired"
updated_at: datetime

When the certificate was last modified.

formatdate-time
uploaded_on: datetime

When the certificate was uploaded to Cloudflare.

formatdate-time
class CustomTrustStoreDeleteResponse: …
id: Optional[str]

Identifier.

maxLength32