Skip to content
Cloudflare API
Start here
API Reference
Zero Trust
DLP
Profiles
Predefined

Get predefined profile config

client.zeroTrust.dlp.profiles.predefined.get(stringprofileId, PredefinedGetParams { account_id } params, RequestOptionsoptions?): PredefinedProfile { id, allowed_match_count, confidence_threshold, 6 more }
GET/accounts/{account_id}/dlp/profiles/predefined/{profile_id}/config

This is similar to get_predefined but only returns entries that are enabled. This is needed for our terraform API Fetches a predefined DLP profile by id.

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
profileId: string
formatuuid
params: PredefinedGetParams { account_id }
account_id: string
ReturnsExpand Collapse
PredefinedProfile { id, allowed_match_count, confidence_threshold, 6 more }
id: string

The id of the predefined profile (uuid).

formatuuid
allowed_match_count: number
formatint32
confidence_threshold: string | null
enabled_entries: Array<string>

Entries to enable for this predefined profile. Any entries not provided will be disabled.

Deprecatedentries: Array<CustomEntry { id, created_at, enabled, 6 more } | CustomPromptTopicEntry { id, created_at, enabled, 4 more } | PredefinedEntry { id, confidence, enabled, 4 more } | 4 more>

This field has been deprecated for enabled_entries.

One of the following:
CustomEntry { id, created_at, enabled, 6 more }
id: string
formatuuid
created_at: string
formatdate-time
Deprecatedenabled: boolean
name: string
pattern: Pattern { regex, validation }
regex: string
Deprecatedvalidation?: "luhn"
type: "custom"
updated_at: string
formatdate-time
description?: string | null
Deprecatedprofile_id?: string | null
formatuuid
CustomPromptTopicEntry { id, created_at, enabled, 4 more }
id: string
formatuuid
created_at: string
formatdate-time
Deprecatedenabled: boolean
name: string
type: "custom_prompt_topic"
updated_at: string
formatdate-time
description?: string | null

The optional description of the custom prompt topic entry.

PredefinedEntry { id, confidence, enabled, 4 more }
id: string
formatuuid
confidence: Confidence { ai_context_available, available }
ai_context_available: boolean

Indicates whether this entry has AI remote service validation.

available: boolean

Indicates whether this entry has any form of validation that is not an AI remote service.

enabled: boolean
name: string
type: "predefined"
Deprecatedprofile_id?: string | null
formatuuid
variant?: UnionMember0 { topic_type, type, description } | UnionMember1 { type, description }

A Predefined AI prompt classification topic entry.

One of the following:
UnionMember0 { topic_type, type, description }

A Predefined AI prompt classification topic entry.

topic_type: "Intent" | "Content"
One of the following:
"Intent"
"Content"
type: "PromptTopic"
description?: string | null

A customer-facing explanation of what this predefined AI prompt topic represents.

UnionMember1 { type, description }

A general predefined entry.

type: "General"
description?: string | null

A customer-facing explanation of what this predefined entry represents.

IntegrationEntry { id, created_at, enabled, 4 more }
id: string
formatuuid
created_at: string
formatdate-time
enabled: boolean
name: string
type: "integration"
updated_at: string
formatdate-time
profile_id?: string | null
formatuuid
ExactDataEntry { id, case_sensitive, created_at, 6 more }
id: string
formatuuid
case_sensitive: boolean

Only applies to custom word lists. Determines if the words should be matched in a case-sensitive manner Cannot be set to false if secret is true

created_at: string
formatdate-time
enabled: boolean
name: string
secret: boolean
type: "exact_data"
updated_at: string
formatdate-time
description?: string | null

The optional description of the exact data entry.

DocumentFingerprintEntry { id, created_at, enabled, 4 more }
id: string
formatuuid
created_at: string
formatdate-time
enabled: boolean
name: string
type: "document_fingerprint"
updated_at: string
formatdate-time
description?: string | null

The optional description of the document fingerprint entry.

WordListEntry { id, created_at, enabled, 5 more }
id: string
formatuuid
created_at: string
formatdate-time
enabled: boolean
name: string
type: "word_list"
updated_at: string
formatdate-time
word_list: unknown
profile_id?: string | null
formatuuid
name: string

The name of the predefined profile.

ai_context_enabled?: boolean
ocr_enabled?: boolean
open_access?: boolean

Whether this profile can be accessed by anyone.

Get predefined profile config

import Cloudflare from 'cloudflare';

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

const predefinedProfile = await client.zeroTrust.dlp.profiles.predefined.get(
  '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
  { account_id: 'account_id' },
);

console.log(predefinedProfile.id);
{
  "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": {
    "id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
    "allowed_match_count": 0,
    "confidence_threshold": "confidence_threshold",
    "enabled_entries": [
      "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e"
    ],
    "entries": [
      {
        "id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
        "created_at": "2019-12-27T18:11:19.117Z",
        "enabled": true,
        "name": "name",
        "pattern": {
          "regex": "regex",
          "validation": "luhn"
        },
        "type": "custom",
        "updated_at": "2019-12-27T18:11:19.117Z",
        "description": "description",
        "profile_id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e"
      }
    ],
    "name": "name",
    "ai_context_enabled": true,
    "ocr_enabled": true,
    "open_access": true
  }
}
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": {
    "id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
    "allowed_match_count": 0,
    "confidence_threshold": "confidence_threshold",
    "enabled_entries": [
      "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e"
    ],
    "entries": [
      {
        "id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
        "created_at": "2019-12-27T18:11:19.117Z",
        "enabled": true,
        "name": "name",
        "pattern": {
          "regex": "regex",
          "validation": "luhn"
        },
        "type": "custom",
        "updated_at": "2019-12-27T18:11:19.117Z",
        "description": "description",
        "profile_id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e"
      }
    ],
    "name": "name",
    "ai_context_enabled": true,
    "ocr_enabled": true,
    "open_access": true
  }
}