Update logging settings for the Zero Trust account

PUT

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

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

Updates the current logging settings for the Zero Trust accounty.

Request

Path Params

identifier

string

required

Body Params application/json

redact_pii

boolean

optional

Redact personally identifiable information from activity logging (PII fields are: source IP, user email, user ID, device ID, URL, referrer, user agent).

Example:

true

settings_by_rule_type

object

optional

Logging settings by rule type.

dns

object

optional

Logging settings for DNS firewall.

http

object

optional

Logging settings for HTTP/HTTPS firewall.

object

optional

Logging settings for Network firewall.

Example

{
    "redact_pii": true,
    "settings_by_rule_type": {
        "dns": {},
        "http": {},
        "l4": {}
    }
}

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/logging' \
--header 'Content-Type: application/json' \
--data-raw '{
    "redact_pii": true,
    "settings_by_rule_type": {
        "dns": {},
        "http": {},
        "l4": {}
    }
}'

Responses

🟢200Update logging settings for the Zero Trust account 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 (gateway-account-logging-settings)

optional

Example

{
    "errors": [],
    "messages": [],
    "result": {
        "redact_pii": true,
        "settings_by_rule_type": {
            "dns": {},
            "http": {},
            "l4": {}
        }
    },
    "success": true
}

🟢200Update logging settings for the Zero Trust account response failure

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

Get logging settings for the Zero Trust account

Get your Zero Trust organization