API Reference

Zero Trust

DLP

Profiles

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

Custom

Get custom profile

GET/accounts/{account_id}/dlp/profiles/custom/{profile_id}

Create custom profile

POST/accounts/{account_id}/dlp/profiles/custom

Update custom profile

PUT/accounts/{account_id}/dlp/profiles/custom/{profile_id}

Delete custom profile

DELETE/accounts/{account_id}/dlp/profiles/custom/{profile_id}

ModelsExpand Collapse

CustomProfile object { id, allowed_match_count, created_at, 12 more }

id: string

The id of the profile (uuid).

formatuuid

allowed_match_count: number

Related DLP policies will trigger when the match count exceeds the number set.

formatint32

maximum1000

minimum0

created_at: string

When the profile was created.

formatdate-time

name: string

The name of the profile.

ocr_enabled: boolean

updated_at: string

When the profile was lasted updated.

formatdate-time

ai_context_enabled: optional boolean

confidence_threshold: optional "low" or "medium" or "high" or "very_high"

One of the following:

"low"

"medium"

"high"

"very_high"

Deprecatedcontext_awareness: optional ContextAwareness { enabled, skip }

Scan the context of predefined entries to only return matches surrounded by keywords.

data_classes: optional array of string

Data classes associated with this profile.

data_tags: optional array of string

Data tags associated with this profile.

description: optional string

The description of the profile.

Deprecatedentries: optional array of object { id, created_at, enabled, 6 more } or object { id, created_at, enabled, 4 more } or object { id, confidence, enabled, 4 more } or 4 more

One of the following:

CustomEntry object { id, created_at, enabled, 6 more }

id: string

formatuuid

created_at: string

formatdate-time

Deprecatedenabled: boolean

name: string

pattern: Pattern { regex, validation }

type: "custom"

updated_at: string

formatdate-time

description: optional string

Deprecatedprofile_id: optional string

formatuuid

CustomPromptTopicEntry object { 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: optional string

The optional description of the custom prompt topic entry.

PredefinedEntry object { id, confidence, enabled, 4 more }

id: string

formatuuid

confidence: object { 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: optional string

formatuuid

variant: optional object { topic_type, type, description } or object { type, description }

A Predefined AI prompt classification topic entry.

One of the following:

object { topic_type, type, description }

A Predefined AI prompt classification topic entry.

topic_type: "Intent" or "Content"

One of the following:

"Intent"

"Content"

type: "PromptTopic"

description: optional string

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

object { type, description }

A general predefined entry.

type: "General"

description: optional string

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

IntegrationEntry object { 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: optional string

formatuuid

ExactDataEntry object { 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: optional string

The optional description of the exact data entry.

DocumentFingerprintEntry object { 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: optional string

The optional description of the document fingerprint entry.

WordListEntry object { 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: optional string

formatuuid

sensitivity_levels: optional array of object { group_id, level_id }

Sensitivity levels associated with this profile.

group_id: string

formatuuid

level_id: string

formatuuid

shared_entries: optional array of object { id, created_at, enabled, 6 more } or object { id, created_at, enabled, 4 more } or object { id, confidence, enabled, 4 more } or 4 more

One of the following:

CustomEntry object { id, created_at, enabled, 6 more }

id: string

formatuuid

created_at: string

formatdate-time

Deprecatedenabled: boolean

name: string

pattern: Pattern { regex, validation }

type: "custom"

updated_at: string

formatdate-time

description: optional string

Deprecatedprofile_id: optional string

formatuuid

CustomPromptTopicEntry object { 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: optional string

The optional description of the custom prompt topic entry.

PredefinedEntry object { id, confidence, enabled, 4 more }

id: string

formatuuid

confidence: object { 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: optional string

formatuuid

variant: optional object { topic_type, type, description } or object { type, description }

A Predefined AI prompt classification topic entry.

One of the following:

object { topic_type, type, description }

A Predefined AI prompt classification topic entry.

topic_type: "Intent" or "Content"

One of the following:

"Intent"

"Content"

type: "PromptTopic"

description: optional string

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

object { type, description }

A general predefined entry.

type: "General"

description: optional string

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

IntegrationEntry object { 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: optional string

formatuuid

ExactDataEntry object { 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: optional string

The optional description of the exact data entry.

DocumentFingerprintEntry object { 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: optional string

The optional description of the document fingerprint entry.

WordListEntry object { 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: optional string

formatuuid

Pattern object { regex, validation }

regex: string

Deprecatedvalidation: optional "luhn"

CustomDeleteResponse = unknown