Enable or Disable Total TLS

POST

https://api.cloudflare.com/client/v4/zones/{zone_identifier}/acm/total_tls

Last modified:2022-12-16 13:48:35

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

Request

Path Params

zone_identifier

string

required

Body Params application/json

certificate_authority

enum<string>

optional

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

Allowed values:

googlelets_encrypt

Example:

google

enabled

boolean

required

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

Example:

true

Example

{
    "certificate_authority": "google",
    "enabled": true
}

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST 'https://api.cloudflare.com/client/v4/zones//acm/total_tls' \
--header 'Content-Type: application/json' \
--data-raw '{
    "certificate_authority": "google",
    "enabled": true
}'

Responses

🟢200Enable or Disable Total TLS response

application/json

Body

allOf {2}

optional

object (api-response-single)

optional

errors

array [object {2}]

messages

required

Example:

[]

messages

array [object {2}]

messages

required

Example:

[]

result

required

success

enum<boolean>

required

Whether the API call was successful

Allowed value:

true

Example:

true

object

optional

result

object

optional

Example

{
    "errors": [],
    "messages": [],
    "result": {
        "certificate_authority": "google",
        "enabled": true,
        "validity_days": 90
    },
    "success": true
}

🟢200Enable or Disable Total TLS response failure

Modified at 2022-12-16 13:48:35

Total TLS Settings Details

List Transform Rules