API Reference

Zero Trust

DLP

Profiles

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

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

Update predefined profile config

client.zeroTrust.dlp.profiles.predefined.update(stringprofileId, PredefinedUpdateParams { account_id, ai_context_enabled, allowed_match_count, 4 more } params, RequestOptionsoptions?): PredefinedProfile { id, allowed_match_count, confidence_threshold, 6 more }

PUT/accounts/{account_id}/dlp/profiles/predefined/{profile_id}/config

Delete predefined profile

client.zeroTrust.dlp.profiles.predefined.delete(stringprofileId, PredefinedDeleteParams { account_id } params, RequestOptionsoptions?): PredefinedDeleteResponse | null

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

ModelsExpand 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 }

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.

PredefinedDeleteResponse = unknown