Get payload log settings

client.zeroTrust.dlp.payloadLogs.get(, ?): PayloadLogGetResponse { updated_at, masking_level, public_key }

GET/accounts/{account_id}/dlp/payload_log

Gets the current payload logging configuration for DLP, showing whether matched content is being logged.

Security

API Token

The preferred authorization scheme for interacting with the Cloudflare API. Create a token.

Example:Authorization: Bearer Sn3lZJTBX6kkg7OdcBUAxOO963GEIyGQqnFTOFYY

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)

Zero Trust ReadZero Trust Write

ParametersExpand Collapse

params: PayloadLogGetParams { account_id }

account_id: string

ReturnsExpand Collapse

PayloadLogGetResponse { updated_at, masking_level, public_key }

updated_at: string

formatdate-time

masking_level?: "full" | "partial" | "clear" | "default"

Masking level for payload logs.

full: The entire payload is masked.
partial: Only partial payload content is masked.
clear: No masking is applied to the payload content.
default: DLP uses its default masking behavior.

One of the following:

"full"

"partial"

"clear"

"default"

public_key?: string | null

Base64-encoded public key for encrypting payload logs. Null when payload logging is disabled.

Get payload log settings

import Cloudflare from 'cloudflare';

const client = new Cloudflare({
  apiToken: process.env['CLOUDFLARE_API_TOKEN'], // This is the default and can be omitted
});

const payloadLog = await client.zeroTrust.dlp.payloadLogs.get({ account_id: 'account_id' });

console.log(payloadLog.updated_at);

{
  "errors": [
    {
      "code": 1000,
      "message": "message",
      "documentation_url": "documentation_url",
      "source": {
        "pointer": "pointer"
      }
    }
  ],
  "messages": [
    {
      "code": 1000,
      "message": "message",
      "documentation_url": "documentation_url",
      "source": {
        "pointer": "pointer"
      }
    }
  ],
  "success": true,
  "result": {
    "updated_at": "2019-12-27T18:11:19.117Z",
    "masking_level": "full",
    "public_key": "public_key"
  }
}

Returns Examples

{
  "errors": [
    {
      "code": 1000,
      "message": "message",
      "documentation_url": "documentation_url",
      "source": {
        "pointer": "pointer"
      }
    }
  ],
  "messages": [
    {
      "code": 1000,
      "message": "message",
      "documentation_url": "documentation_url",
      "source": {
        "pointer": "pointer"
      }
    }
  ],
  "success": true,
  "result": {
    "updated_at": "2019-12-27T18:11:19.117Z",
    "masking_level": "full",
    "public_key": "public_key"
  }
}