Skip to content
Cloudflare API
Start here
API Reference

ACM

ACMTotal TLS

Total TLS Settings Details
client.acm.totalTLS.get(TotalTLSGetParams { zone_id } params, RequestOptionsoptions?): TotalTLSGetResponse { certificate_authority, enabled, validity_period }
GET/zones/{zone_id}/acm/total_tls
Enable or Disable Total TLS
client.acm.totalTLS.update(TotalTLSUpdateParams { zone_id, enabled, certificate_authority } params, RequestOptionsoptions?): TotalTLSUpdateResponse { certificate_authority, enabled, validity_period }
POST/zones/{zone_id}/acm/total_tls
Enable or Disable Total TLS
client.acm.totalTLS.edit(TotalTLSEditParams { zone_id, enabled, certificate_authority } params, RequestOptionsoptions?): TotalTLSEditResponse { certificate_authority, enabled, validity_period }
POST/zones/{zone_id}/acm/total_tls
ModelsExpand Collapse
CertificateAuthority = "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"
TotalTLSGetResponse { certificate_authority, enabled, validity_period }
certificate_authority?: CertificateAuthority

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

enabled?: 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?: 90

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

TotalTLSUpdateResponse { certificate_authority, enabled, validity_period }
certificate_authority?: CertificateAuthority

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

enabled?: 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?: 90

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

TotalTLSEditResponse { certificate_authority, enabled, validity_period }
certificate_authority?: CertificateAuthority

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

enabled?: 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?: 90

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

ACMCustom Trust Store

List Custom Origin Trust Store Details
client.acm.customTrustStore.list(CustomTrustStoreListParams { zone_id, limit, offset, 2 more } params, RequestOptionsoptions?): V4PagePaginationArray<CustomTrustStore { id, certificate, expires_on, 5 more } >
GET/zones/{zone_id}/acm/custom_trust_store
Upload Custom Origin Trust Store
client.acm.customTrustStore.create(CustomTrustStoreCreateParams { zone_id, certificate } params, RequestOptionsoptions?): CustomTrustStore { id, certificate, expires_on, 5 more }
POST/zones/{zone_id}/acm/custom_trust_store
Custom Origin Trust Store Details
client.acm.customTrustStore.get(stringcustomOriginTrustStoreId, CustomTrustStoreGetParams { zone_id } params, RequestOptionsoptions?): CustomTrustStore { id, certificate, expires_on, 5 more }
GET/zones/{zone_id}/acm/custom_trust_store/{custom_origin_trust_store_id}
Delete Custom Origin Trust Store
client.acm.customTrustStore.delete(stringcustomOriginTrustStoreId, CustomTrustStoreDeleteParams { zone_id } params, RequestOptionsoptions?): CustomTrustStoreDeleteResponse { id }
DELETE/zones/{zone_id}/acm/custom_trust_store/{custom_origin_trust_store_id}
ModelsExpand Collapse
CustomTrustStore { id, certificate, expires_on, 5 more }
id: string

Identifier.

maxLength32
certificate: string

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

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" | "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: string

When the certificate was last modified.

formatdate-time
uploaded_on: string

When the certificate was uploaded to Cloudflare.

formatdate-time
CustomTrustStoreDeleteResponse { id }
id?: string

Identifier.

maxLength32