Update Zero Trust account configuration

PUT

https://api.cloudflare.com/client/v4/accounts/{identifier}/gateway/configuration

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

Updates the current Zero Trust account configuration.

Request

Path Params

identifier

string

required

Body Params application/json

account settings.

settings

object

optional

account settings.

activity_log

object (activity-log-settings)

optional

Activity log settings.

antivirus

object (anti-virus-settings)

optional

Anti virus settings.

block_page

object (block-page-settings)

optional

Block page layout settings.

browser_isolation

object (browser-isolation-settings)

optional

Browser isolation settings.

custom_certificate

object (custom-certificate-settings)

optional

Custom certificate settings for BYO-PKI.

fips

object (fips-settings)

optional

FIPS settings.

tls_decrypt

object (tls-settings)

optional

TLS interception settings.

Example

{
    "settings": {
        "activity_log": {
            "enabled": true
        },
        "antivirus": {
            "enabled_download_phase": false,
            "enabled_upload_phase": false,
            "fail_closed": false
        },
        "block_page": {
            "background_color": "string",
            "enabled": true,
            "footer_text": "--footer--",
            "header_text": "--header--",
            "logo_path": "https://logos.com/a.png",
            "mailto_address": "admin@example.com",
            "mailto_subject": "Blocked User Inquiry",
            "name": "Cloudflare",
            "suppress_footer": false
        },
        "browser_isolation": {
            "url_browser_isolation_enabled": true
        },
        "custom_certificate": {
            "enabled": true,
            "id": "d1b364c5-1311-466e-a194-f0e943e0799f"
        },
        "fips": {
            "tls": true
        },
        "tls_decrypt": {
            "enabled": true
        }
    }
}

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request PUT 'https://api.cloudflare.com/client/v4/accounts//gateway/configuration' \
--header 'Content-Type: application/json' \
--data-raw '{
    "settings": {
        "activity_log": {
            "enabled": true
        },
        "antivirus": {
            "enabled_download_phase": false,
            "enabled_upload_phase": false,
            "fail_closed": false
        },
        "block_page": {
            "background_color": "string",
            "enabled": true,
            "footer_text": "--footer--",
            "header_text": "--header--",
            "logo_path": "https://logos.com/a.png",
            "mailto_address": "admin@example.com",
            "mailto_subject": "Blocked User Inquiry",
            "name": "Cloudflare",
            "suppress_footer": false
        },
        "browser_isolation": {
            "url_browser_isolation_enabled": true
        },
        "custom_certificate": {
            "enabled": true,
            "id": "d1b364c5-1311-466e-a194-f0e943e0799f"
        },
        "fips": {
            "tls": true
        },
        "tls_decrypt": {
            "enabled": true
        }
    }
}'

Responses

🟢200Update Zero Trust account configuration 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 | allOf {2}

optional

Example

🟢200Update Zero Trust account configuration response failure

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

Get Zero Trust account configuration

Get logging settings for the Zero Trust account