API Reference

Zero Trust

DLP

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

Profiles

List all profiles

client.zeroTrust.dlp.profiles.list(ProfileListParams { account_id, all } params, RequestOptionsoptions?): SinglePage<Profile>

GET/accounts/{account_id}/dlp/profiles

Get DLP Profile

client.zeroTrust.dlp.profiles.get(stringprofileId, ProfileGetParams { account_id } params, RequestOptionsoptions?): Profile

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

ModelsExpand Collapse

ContextAwareness { enabled, skip }

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

enabled: boolean

If true, scan the context of predefined entries to only return matches surrounded by keywords.

skip: SkipConfiguration { files }

Content types to exclude from context analysis and return all matches.

Profile = CustomProfile { id, allowed_match_count, created_at, 13 more } | PredefinedProfile { id, allowed_match_count, entries, 7 more } | IntegrationProfile { id, created_at, entries, 5 more }

One of the following:

CustomProfile { id, allowed_match_count, created_at, 13 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

type: "custom"

updated_at: string

When the profile was lasted updated.

formatdate-time

ai_context_enabled?: boolean

confidence_threshold?: "low" | "medium" | "high" | "very_high"

One of the following:

"low"

"medium"

"high"

"very_high"

Deprecatedcontext_awareness?: ContextAwareness { enabled, skip }

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

data_classes?: Array<string>

Data classes associated with this profile.

data_tags?: Array<string>

Data tags associated with this profile.

description?: string | null

The description of the profile.

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

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

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?: Variant { topic_type, type, description }

topic_type: "Intent" | "Content"

One of the following:

"Intent"

"Content"

type: "PromptTopic"

description?: string | null

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, 5 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

DocumentFingerprintEntry { id, created_at, enabled, 3 more }

id: string

formatuuid

created_at: string

formatdate-time

enabled: boolean

name: string

type: "document_fingerprint"

updated_at: string

formatdate-time

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

sensitivity_levels?: Array<SensitivityLevel>

Sensitivity levels associated with this profile.

group_id: string

formatuuid

level_id: string

formatuuid

shared_entries?: Array<CustomEntry { id, created_at, enabled, 6 more } | PredefinedEntry { id, confidence, enabled, 4 more } | IntegrationEntry { id, created_at, enabled, 4 more } | 3 more>

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

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?: Variant { topic_type, type, description }

topic_type: "Intent" | "Content"

One of the following:

"Intent"

"Content"

type: "PromptTopic"

description?: string | null

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, 5 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

DocumentFingerprintEntry { id, created_at, enabled, 3 more }

id: string

formatuuid

created_at: string

formatdate-time

enabled: boolean

name: string

type: "document_fingerprint"

updated_at: string

formatdate-time

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

PredefinedProfile { id, allowed_match_count, entries, 7 more }

id: string

The id of the predefined profile (uuid).

formatuuid

allowed_match_count: number

formatint32

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

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

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?: Variant { topic_type, type, description }

topic_type: "Intent" | "Content"

One of the following:

"Intent"

"Content"

type: "PromptTopic"

description?: string | null

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, 5 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

DocumentFingerprintEntry { id, created_at, enabled, 3 more }

id: string

formatuuid

created_at: string

formatdate-time

enabled: boolean

name: string

type: "document_fingerprint"

updated_at: string

formatdate-time

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.

type: "predefined"

ai_context_enabled?: boolean

confidence_threshold?: "low" | "medium" | "high" | "very_high"

One of the following:

"low"

"medium"

"high"

"very_high"

Deprecatedcontext_awareness?: ContextAwareness { enabled, skip }

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

ocr_enabled?: boolean

open_access?: boolean

Whether this profile can be accessed by anyone.

IntegrationProfile { id, created_at, entries, 5 more }

id: string

formatuuid

created_at: string

formatdate-time

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

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

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?: Variant { topic_type, type, description }

topic_type: "Intent" | "Content"

One of the following:

"Intent"

"Content"

type: "PromptTopic"

description?: string | null

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, 5 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

DocumentFingerprintEntry { id, created_at, enabled, 3 more }

id: string

formatuuid

created_at: string

formatdate-time

enabled: boolean

name: string

type: "document_fingerprint"

updated_at: string

formatdate-time

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

shared_entries: Array<CustomEntry { id, created_at, enabled, 6 more } | PredefinedEntry { id, confidence, enabled, 4 more } | IntegrationEntry { id, created_at, enabled, 4 more } | 3 more>

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

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?: Variant { topic_type, type, description }

topic_type: "Intent" | "Content"

One of the following:

"Intent"

"Content"

type: "PromptTopic"

description?: string | null

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, 5 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

DocumentFingerprintEntry { id, created_at, enabled, 3 more }

id: string

formatuuid

created_at: string

formatdate-time

enabled: boolean

name: string

type: "document_fingerprint"

updated_at: string

formatdate-time

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

type: "integration"

updated_at: string

formatdate-time

description?: string | null

The description of the profile.

SkipConfiguration { files }

Content types to exclude from context analysis and return all matches.

files: boolean

If the content type is a file, skip context analysis and return all matches.

ProfilesCustom

Get custom profile

client.zeroTrust.dlp.profiles.custom.get(stringprofileId, CustomGetParams { account_id } params, RequestOptionsoptions?): Profile

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

Create custom profile

client.zeroTrust.dlp.profiles.custom.create(CustomCreateParams { account_id, name, ai_context_enabled, 10 more } params, RequestOptionsoptions?): Profile

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

Update custom profile

client.zeroTrust.dlp.profiles.custom.update(stringprofileId, CustomUpdateParams { account_id, name, ai_context_enabled, 10 more } params, RequestOptionsoptions?): Profile

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

Delete custom profile

client.zeroTrust.dlp.profiles.custom.delete(stringprofileId, CustomDeleteParams { account_id } params, RequestOptionsoptions?): CustomDeleteResponse | null

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

ModelsExpand Collapse

CustomProfile { 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?: boolean

confidence_threshold?: "low" | "medium" | "high" | "very_high"

One of the following:

"low"

"medium"

"high"

"very_high"

Deprecatedcontext_awareness?: ContextAwareness { enabled, skip }

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

data_classes?: Array<string>

Data classes associated with this profile.

data_tags?: Array<string>

Data tags associated with this profile.

description?: string | null

The description of the profile.

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

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

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?: Variant { topic_type, type, description }

topic_type: "Intent" | "Content"

One of the following:

"Intent"

"Content"

type: "PromptTopic"

description?: string | null

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, 5 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

DocumentFingerprintEntry { id, created_at, enabled, 3 more }

id: string

formatuuid

created_at: string

formatdate-time

enabled: boolean

name: string

type: "document_fingerprint"

updated_at: string

formatdate-time

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

sensitivity_levels?: Array<SensitivityLevel>

Sensitivity levels associated with this profile.

group_id: string

formatuuid

level_id: string

formatuuid

shared_entries?: Array<CustomEntry { id, created_at, enabled, 6 more } | PredefinedEntry { id, confidence, enabled, 4 more } | IntegrationEntry { id, created_at, enabled, 4 more } | 3 more>

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

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?: Variant { topic_type, type, description }

topic_type: "Intent" | "Content"

One of the following:

"Intent"

"Content"

type: "PromptTopic"

description?: string | null

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, 5 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

DocumentFingerprintEntry { id, created_at, enabled, 3 more }

id: string

formatuuid

created_at: string

formatdate-time

enabled: boolean

name: string

type: "document_fingerprint"

updated_at: string

formatdate-time

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

Pattern { regex, validation }

regex: string

Deprecatedvalidation?: "luhn"

CustomDeleteResponse = unknown

ProfilesPredefined

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 } | PredefinedEntry { id, confidence, enabled, 4 more } | IntegrationEntry { id, created_at, enabled, 4 more } | 3 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

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?: Variant { topic_type, type, description }

topic_type: "Intent" | "Content"

One of the following:

"Intent"

"Content"

type: "PromptTopic"

description?: string | null

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, 5 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

DocumentFingerprintEntry { id, created_at, enabled, 3 more }

id: string

formatuuid

created_at: string

formatdate-time

enabled: boolean

name: string

type: "document_fingerprint"

updated_at: string

formatdate-time

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