Skip to content
Cloudflare API
Start here
API Reference

ACM

ACMTotal TLS

Total TLS Settings Details
GET/zones/{zone_id}/acm/total_tls
Enable or Disable Total TLS
POST/zones/{zone_id}/acm/total_tls
Enable or Disable Total TLS
POST/zones/{zone_id}/acm/total_tls
ModelsExpand Collapse
CertificateAuthority = "google" or "lets_encrypt" or "ssl_com"

The Certificate Authority that Total TLS certificates will be issued through. Not returned in responses when Total TLS is disabled.

One of the following:
"google"
"lets_encrypt"
"ssl_com"
TotalTLSGetResponse object { certificate_authority, enabled, validity_period }
certificate_authority: optional CertificateAuthority

The Certificate Authority that Total TLS certificates will be issued through. Not returned in responses when Total TLS is disabled.

enabled: optional boolean

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 90

The validity period in days for the certificates ordered via Total TLS. Not returned when Total TLS is disabled.

TotalTLSUpdateResponse object { certificate_authority, enabled, validity_period }
certificate_authority: optional CertificateAuthority

The Certificate Authority that Total TLS certificates will be issued through. Not returned in responses when Total TLS is disabled.

enabled: optional boolean

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 90

The validity period in days for the certificates ordered via Total TLS. Not returned when Total TLS is disabled.

TotalTLSEditResponse object { certificate_authority, enabled, validity_period }
certificate_authority: optional CertificateAuthority

The Certificate Authority that Total TLS certificates will be issued through. Not returned in responses when Total TLS is disabled.

enabled: optional boolean

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 90

The validity period in days for the certificates ordered via Total TLS. Not returned when Total TLS is disabled.

ACMCustom Trust Store

List Custom Origin Trust Store Details
GET/zones/{zone_id}/acm/custom_trust_store
Upload Custom Origin Trust Store
POST/zones/{zone_id}/acm/custom_trust_store
Custom Origin Trust Store Details
GET/zones/{zone_id}/acm/custom_trust_store/{custom_origin_trust_store_id}
Delete Custom Origin Trust Store
DELETE/zones/{zone_id}/acm/custom_trust_store/{custom_origin_trust_store_id}
ModelsExpand Collapse
CustomTrustStore object { id, certificate, expires_on, 5 more }
id: string

Certificate identifier tag.

maxLength36
certificate: string

The root CA certificate in PEM format. Only root CA certificates are accepted; intermediate and leaf certificates are not supported.

expires_on: string

When the certificate expires.

formatdate-time
issuer: string

The certificate authority that issued the certificate.

signature: string

The type of hash used for the certificate.

status: "initializing" or "pending_deployment" or "active" or 3 more

Status of the zone’s custom SSL.

One of the following:
"initializing"
"pending_deployment"
"active"
"pending_deletion"
"deleted"
"expired"
uploaded_on: string

When the certificate was uploaded to Cloudflare.

formatdate-time
updated_at: optional string

When the certificate was last modified. Only returned when uploading a certificate.

formatdate-time
CustomTrustStoreDeleteResponse object { id }
id: optional string

Certificate identifier tag.

maxLength36