Cloudflare API | ACM › Total TLS › Enable Or Disable Total TLS

API Reference

Account & User Management

Resource Sharing

AI

Certificate Management

Enable or Disable Total TLS

Total TLS Settings Details

Certificate Authorities

Client Certificates

Custom Certificates

Custom Hostnames

Keyless Certificates

MTLS Certificates

Origin CA Certificates

Origin Post Quantum Encryption

Origin TLS Client Auth

Cloudflare One

DNS

Account Custom Nameservers

Domain/Zone Management

IP Addresses

Media

Networking

Magic Cloud Networking

Magic Network Monitoring

Network Interconnects

Observability

Security Center

Radar

Routing & Performance

Rules

Cloud Connector

Managed Transforms

URL Normalization

Security

Content Scanning

Leaked Credential Checks

Storage & Databases

Threat Intelligence

Brand Protection

Workers & Pages

Browser Rendering

Durable Objects

Workers For Platforms

Shared

ACM

acm

Total TLS

acm.total_tls

Methods

Enable Or Disable Total TLS -> Envelope<{ certificate_authority, enabled, validity_period }>

post/zones/{zone_id}/acm/total_tls

Set Total TLS Settings or disable the feature for a Zone.

Security

API Email + API Key

The previous authorization scheme for interacting with the Cloudflare API, used in conjunction with a Global API key.

Example: X-Auth-Email: user@example.com

The previous authorization scheme for interacting with the Cloudflare API. When possible, use API tokens instead of Global API keys.

Example: X-Auth-Key: 144c9defac04969c7bfad8efaa8ea194

Accepted Permissions (at least one required)

SSL and Certificates Write

path Parameters

zone_id: string

(maxLength: 32)

Identifier

Body parameters

enabled: boolean

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

certificate_authority:

CertificateAuthority

Optional

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

Response fields

errors: Array<

>

messages: Array<

>

success: true

Whether the API call was successful

result: { certificate_authority, enabled, validity_period }

Optional

Request example

curl https://api.cloudflare.com/client/v4/zones/$ZONE_ID/acm/total_tls \
    -H 'Content-Type: application/json' \
    -H "X-Auth-Email: $CLOUDFLARE_EMAIL" \
    -H "X-Auth-Key: $CLOUDFLARE_API_KEY" \
    -d '{
      "enabled": true,
      "certificate_authority": "google"
    }'

200Example

{
  "errors": [
    {
      "code": 1000,
      "message": "message"
    }
  ],
  "messages": [
    {
      "code": 1000,
      "message": "message"
    }
  ],
  "success": true,
  "result": {
    "certificate_authority": "google",
    "enabled": true,
    "validity_period": 90
  }
}

Total TLS Settings Details -> Envelope<{ certificate_authority, enabled, validity_period }>

get/zones/{zone_id}/acm/total_tls

Get Total TLS Settings for a Zone.

Domain types

CertificateAuthority = "google" | "lets_encrypt" | "ssl_com"

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