Get DLP account-level settings.

zero_trust.dlp.settings.get() -> DLPSettings

GET/accounts/{account_id}/dlp/settings

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

account_id: Optional[str]

ReturnsExpand Collapse

class DLPSettings: …

DLP account-level settings response.

ai_context_analysis: bool

Whether AI context analysis is enabled at the account level.

ocr: bool

Whether OCR is enabled at the account level.

payload_logging: PayloadLogging

updated_at: datetime

formatdate-time

masking_level: Optional[Literal["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: Optional[str]

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

Get DLP account-level settings.

import os
from cloudflare import Cloudflare

client = Cloudflare(
    api_token=os.environ.get("CLOUDFLARE_API_TOKEN"),  # This is the default and can be omitted
)
dlp_settings = client.zero_trust.dlp.settings.get(
    account_id="account_id",
)
print(dlp_settings.ai_context_analysis)

{
  "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": {
    "ai_context_analysis": true,
    "ocr": true,
    "payload_logging": {
      "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": {
    "ai_context_analysis": true,
    "ocr": true,
    "payload_logging": {
      "updated_at": "2019-12-27T18:11:19.117Z",
      "masking_level": "full",
      "public_key": "public_key"
    }
  }
}