DLP

DLPDatasets

Fetch all datasets

client.zeroTrust.dlp.datasets.list(, ?): SinglePage<Dataset { id, columns, created_at, 9 more } >

GET/accounts/{account_id}/dlp/datasets

Fetch a specific dataset

client.zeroTrust.dlp.datasets.get(, , ?): Dataset { id, columns, created_at, 9 more }

GET/accounts/{account_id}/dlp/datasets/{dataset_id}

Create a new dataset

client.zeroTrust.dlp.datasets.create(, ?): DatasetCreation { dataset, encoding_version, max_cells, 2 more }

POST/accounts/{account_id}/dlp/datasets

Update details about a dataset

client.zeroTrust.dlp.datasets.update(, , ?): Dataset { id, columns, created_at, 9 more }

PUT/accounts/{account_id}/dlp/datasets/{dataset_id}

Delete a dataset

client.zeroTrust.dlp.datasets.delete(, , ?): void

DELETE/accounts/{account_id}/dlp/datasets/{dataset_id}

ModelsExpand Collapse

Dataset { id, columns, created_at, 9 more }

id: string

formatuuid

columns: Array<Column>

entry_id: string

formatuuid

header_name: string

num_cells: number

formatint64

upload_status: "empty" | "uploading" | "pending" | 3 more

One of the following:

"empty"

"uploading"

"pending"

"processing"

"failed"

"complete"

created_at: string

formatdate-time

encoding_version: number

formatint32

minimum0

num_cells: number

formatint64

secret: boolean

status: "empty" | "uploading" | "pending" | 3 more

One of the following:

"empty"

"uploading"

"pending"

"processing"

"failed"

"complete"

updated_at: string

Stores when the dataset was last updated.

This includes name or description changes as well as uploads.

formatdate-time

uploads: Array<Upload>

num_cells: number

formatint64

status: "empty" | "uploading" | "pending" | 3 more

One of the following:

"empty"

"uploading"

"pending"

"processing"

"failed"

"complete"

version: number

formatint64

case_sensitive?: boolean

description?: string | null

The description of the dataset.

DatasetArray = Array<Dataset { id, columns, created_at, 9 more } >

id: string

formatuuid

columns: Array<Column>

entry_id: string

formatuuid

header_name: string

num_cells: number

formatint64

upload_status: "empty" | "uploading" | "pending" | 3 more

One of the following:

"empty"

"uploading"

"pending"

"processing"

"failed"

"complete"

created_at: string

formatdate-time

encoding_version: number

formatint32

minimum0

num_cells: number

formatint64

secret: boolean

status: "empty" | "uploading" | "pending" | 3 more

One of the following:

"empty"

"uploading"

"pending"

"processing"

"failed"

"complete"

updated_at: string

Stores when the dataset was last updated.

This includes name or description changes as well as uploads.

formatdate-time

uploads: Array<Upload>

num_cells: number

formatint64

status: "empty" | "uploading" | "pending" | 3 more

One of the following:

"empty"

"uploading"

"pending"

"processing"

"failed"

"complete"

version: number

formatint64

case_sensitive?: boolean

description?: string | null

The description of the dataset.

DatasetCreation { dataset, encoding_version, max_cells, 2 more }

dataset: Dataset { id, columns, created_at, 9 more }

encoding_version: number

Encoding version to use for dataset.

formatint32

minimum0

max_cells: number

formatint64

minimum0

version: number

The version to use when uploading the dataset.

formatint64

secret?: string

The secret to use for Exact Data Match datasets.

This is not present in Custom Wordlists.

formatpassword

DLPDatasetsUpload

Prepare to upload a new version of a dataset

client.zeroTrust.dlp.datasets.upload.create(, , ?): NewVersion { encoding_version, max_cells, version, 3 more }

POST/accounts/{account_id}/dlp/datasets/{dataset_id}/upload

Upload a new version of a dataset

client.zeroTrust.dlp.datasets.upload.edit(, , , , ?): Dataset { id, columns, created_at, 9 more }

POST/accounts/{account_id}/dlp/datasets/{dataset_id}/upload/{version}

ModelsExpand Collapse

NewVersion { encoding_version, max_cells, version, 3 more }

encoding_version: number

formatint32

minimum0

max_cells: number

formatint64

minimum0

version: number

formatint64

case_sensitive?: boolean

columns?: Array<Column>

entry_id: string

formatuuid

header_name: string

num_cells: number

formatint64

upload_status: "empty" | "uploading" | "pending" | 3 more

One of the following:

"empty"

"uploading"

"pending"

"processing"

"failed"

"complete"

secret?: string

formatpassword

DLPDatasetsVersions

Sets the column information for a multi-column upload

client.zeroTrust.dlp.datasets.versions.create(, , , ?): SinglePage<VersionCreateResponse { entry_id, header_name, num_cells, upload_status } >

POST/accounts/{account_id}/dlp/datasets/{dataset_id}/versions/{version}

ModelsExpand Collapse

VersionCreateResponse { entry_id, header_name, num_cells, upload_status }

entry_id: string

formatuuid

header_name: string

num_cells: number

formatint64

upload_status: "empty" | "uploading" | "pending" | 3 more

One of the following:

"empty"

"uploading"

"pending"

"processing"

"failed"

"complete"

DLPDatasetsVersionsEntries

Upload a new version of a multi-column dataset

client.zeroTrust.dlp.datasets.versions.entries.create(, , , , , ?): EntryCreateResponse { entry_id, header_name, num_cells, upload_status }

POST/accounts/{account_id}/dlp/datasets/{dataset_id}/versions/{version}/entries/{entry_id}

ModelsExpand Collapse

EntryCreateResponse { entry_id, header_name, num_cells, upload_status }

entry_id: string

formatuuid

header_name: string

num_cells: number

formatint64

upload_status: "empty" | "uploading" | "pending" | 3 more

One of the following:

"empty"

"uploading"

"pending"

"processing"

"failed"

"complete"

DLPPatterns

Validate a DLP regex pattern

client.zeroTrust.dlp.patterns.validate(, ?): PatternValidateResponse { valid }

POST/accounts/{account_id}/dlp/patterns/validate

ModelsExpand Collapse

PatternValidateResponse { valid }

valid: boolean

DLPPayload Logs

Get payload log settings

client.zeroTrust.dlp.payloadLogs.get(, ?): PayloadLogGetResponse { updated_at, masking_level, public_key }

GET/accounts/{account_id}/dlp/payload_log

Set payload log settings

client.zeroTrust.dlp.payloadLogs.update(, ?): PayloadLogUpdateResponse { updated_at, masking_level, public_key }

PUT/accounts/{account_id}/dlp/payload_log

ModelsExpand Collapse

PayloadLogGetResponse { updated_at, masking_level, public_key }

updated_at: string

formatdate-time

masking_level?: "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?: string | null

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

PayloadLogUpdateResponse { updated_at, masking_level, public_key }

updated_at: string

formatdate-time

masking_level?: "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?: string | null

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

DLPEmail

DLPEmailAccount Mapping

Get mapping

client.zeroTrust.dlp.email.accountMapping.get(, ?): AccountMappingGetResponse { addin_identifier_token, auth_requirements }

GET/accounts/{account_id}/dlp/email/account_mapping

Create mapping

client.zeroTrust.dlp.email.accountMapping.create(, ?): AccountMappingCreateResponse { addin_identifier_token, auth_requirements }

POST/accounts/{account_id}/dlp/email/account_mapping

ModelsExpand Collapse

AccountMappingGetResponse { addin_identifier_token, auth_requirements }

addin_identifier_token: string

formatuuid

auth_requirements: UnionMember0 { allowed_microsoft_organizations, type } | Type { type }

One of the following:

UnionMember0 { allowed_microsoft_organizations, type }

allowed_microsoft_organizations: Array<string>

type: "Org"

Type { type }

type: "NoAuth"

AccountMappingCreateResponse { addin_identifier_token, auth_requirements }

addin_identifier_token: string

formatuuid

auth_requirements: UnionMember0 { allowed_microsoft_organizations, type } | Type { type }

One of the following:

UnionMember0 { allowed_microsoft_organizations, type }

allowed_microsoft_organizations: Array<string>

type: "Org"

Type { type }

type: "NoAuth"

DLPEmailRules

List all email scanner rules

client.zeroTrust.dlp.email.rules.list(, ?): SinglePage<RuleListResponse { action, conditions, created_at, 6 more } >

GET/accounts/{account_id}/dlp/email/rules

Get an email scanner rule

client.zeroTrust.dlp.email.rules.get(, , ?): RuleGetResponse { action, conditions, created_at, 6 more }

GET/accounts/{account_id}/dlp/email/rules/{rule_id}

Create email scanner rule

client.zeroTrust.dlp.email.rules.create(, ?): RuleCreateResponse { action, conditions, created_at, 6 more }

POST/accounts/{account_id}/dlp/email/rules

Update email scanner rule

client.zeroTrust.dlp.email.rules.update(, , ?): RuleUpdateResponse { action, conditions, created_at, 6 more }

PUT/accounts/{account_id}/dlp/email/rules/{rule_id}

Delete email scanner rule

client.zeroTrust.dlp.email.rules.delete(, , ?): RuleDeleteResponse { action, conditions, created_at, 6 more }

DELETE/accounts/{account_id}/dlp/email/rules/{rule_id}

Update email scanner rule priorities

client.zeroTrust.dlp.email.rules.bulkEdit(, ?): RuleBulkEditResponse { action, conditions, created_at, 6 more }

PATCH/accounts/{account_id}/dlp/email/rules

ModelsExpand Collapse

RuleListResponse { action, conditions, created_at, 6 more }

action: Action { action, message }

action: "Block"

message?: string | null

conditions: Array<Condition>

Triggered if all conditions match.

operator: "InList" | "NotInList" | "MatchRegex" | "NotMatchRegex"

One of the following:

"InList"

"NotInList"

"MatchRegex"

"NotMatchRegex"

selector: "Recipients" | "Sender" | "DLPProfiles"

One of the following:

"Recipients"

"Sender"

"DLPProfiles"

value: Array<string> | string

One of the following:

Array<string>

string

created_at: string

formatdate-time

enabled: boolean

priority: number

formatint32

minimum0

rule_id: string

formatuuid

updated_at: string

formatdate-time

description?: string | null

RuleGetResponse { action, conditions, created_at, 6 more }

action: Action { action, message }

action: "Block"

message?: string | null

conditions: Array<Condition>

Triggered if all conditions match.

operator: "InList" | "NotInList" | "MatchRegex" | "NotMatchRegex"

One of the following:

"InList"

"NotInList"

"MatchRegex"

"NotMatchRegex"

selector: "Recipients" | "Sender" | "DLPProfiles"

One of the following:

"Recipients"

"Sender"

"DLPProfiles"

value: Array<string> | string

One of the following:

Array<string>

string

created_at: string

formatdate-time

enabled: boolean

priority: number

formatint32

minimum0

rule_id: string

formatuuid

updated_at: string

formatdate-time

description?: string | null

RuleCreateResponse { action, conditions, created_at, 6 more }

action: Action { action, message }

action: "Block"

message?: string | null

conditions: Array<Condition>

Triggered if all conditions match.

operator: "InList" | "NotInList" | "MatchRegex" | "NotMatchRegex"

One of the following:

"InList"

"NotInList"

"MatchRegex"

"NotMatchRegex"

selector: "Recipients" | "Sender" | "DLPProfiles"

One of the following:

"Recipients"

"Sender"

"DLPProfiles"

value: Array<string> | string

One of the following:

Array<string>

string

created_at: string

formatdate-time

enabled: boolean

priority: number

formatint32

minimum0

rule_id: string

formatuuid

updated_at: string

formatdate-time

description?: string | null

RuleUpdateResponse { action, conditions, created_at, 6 more }

action: Action { action, message }

action: "Block"

message?: string | null

conditions: Array<Condition>

Triggered if all conditions match.

operator: "InList" | "NotInList" | "MatchRegex" | "NotMatchRegex"

One of the following:

"InList"

"NotInList"

"MatchRegex"

"NotMatchRegex"

selector: "Recipients" | "Sender" | "DLPProfiles"

One of the following:

"Recipients"

"Sender"

"DLPProfiles"

value: Array<string> | string

One of the following:

Array<string>

string

created_at: string

formatdate-time

enabled: boolean

priority: number

formatint32

minimum0

rule_id: string

formatuuid

updated_at: string

formatdate-time

description?: string | null

RuleDeleteResponse { action, conditions, created_at, 6 more }

action: Action { action, message }

action: "Block"

message?: string | null

conditions: Array<Condition>

Triggered if all conditions match.

operator: "InList" | "NotInList" | "MatchRegex" | "NotMatchRegex"

One of the following:

"InList"

"NotInList"

"MatchRegex"

"NotMatchRegex"

selector: "Recipients" | "Sender" | "DLPProfiles"

One of the following:

"Recipients"

"Sender"

"DLPProfiles"

value: Array<string> | string

One of the following:

Array<string>

string

created_at: string

formatdate-time

enabled: boolean

priority: number

formatint32

minimum0

rule_id: string

formatuuid

updated_at: string

formatdate-time

description?: string | null

RuleBulkEditResponse { action, conditions, created_at, 6 more }

action: Action { action, message }

action: "Block"

message?: string | null

conditions: Array<Condition>

Triggered if all conditions match.

operator: "InList" | "NotInList" | "MatchRegex" | "NotMatchRegex"

One of the following:

"InList"

"NotInList"

"MatchRegex"

"NotMatchRegex"

selector: "Recipients" | "Sender" | "DLPProfiles"

One of the following:

"Recipients"

"Sender"

"DLPProfiles"

value: Array<string> | string

One of the following:

Array<string>

string

created_at: string

formatdate-time

enabled: boolean

priority: number

formatint32

minimum0

rule_id: string

formatuuid

updated_at: string

formatdate-time

description?: string | null

DLPProfiles

List all profiles

client.zeroTrust.dlp.profiles.list(, ?): SinglePage<Profile>

GET/accounts/{account_id}/dlp/profiles

Get DLP Profile

client.zeroTrust.dlp.profiles.get(, , ?): 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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

type: "word_list"

updated_at: string

formatdate-time

word_list: unknown

profile_id?: string | null

formatuuid

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

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

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

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

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

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

type: "word_list"

updated_at: string

formatdate-time

word_list: unknown

profile_id?: string | null

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

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

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

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

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

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

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.

DLPProfilesCustom

Get custom profile

client.zeroTrust.dlp.profiles.custom.get(, , ?): Profile

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

Create custom profile

client.zeroTrust.dlp.profiles.custom.create(, ?): Profile

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

Update custom profile

client.zeroTrust.dlp.profiles.custom.update(, , ?): Profile

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

Delete custom profile

client.zeroTrust.dlp.profiles.custom.delete(, , ?): 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

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

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

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

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

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

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

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

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

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

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

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

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

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

DLPProfilesPredefined

Get predefined profile config

client.zeroTrust.dlp.profiles.predefined.get(, , ?): 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(, , ?): 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(, , ?): 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

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

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

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

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

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

type: "word_list"

updated_at: string

formatdate-time

word_list: unknown

profile_id?: string | null

formatuuid

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

DLPLimits

Fetch limits associated with DLP for account

client.zeroTrust.dlp.limits.list(, ?): LimitListResponse { max_dataset_cells }

GET/accounts/{account_id}/dlp/limits

ModelsExpand Collapse

LimitListResponse { max_dataset_cells }

max_dataset_cells: number

formatint64

minimum0

DLPEntries

List all entries

client.zeroTrust.dlp.entries.list(, ?): SinglePage<EntryListResponse>

GET/accounts/{account_id}/dlp/entries

Get DLP Entry

client.zeroTrust.dlp.entries.get(, , ?): EntryGetResponse

GET/accounts/{account_id}/dlp/entries/{entry_id}

Create custom entry

client.zeroTrust.dlp.entries.create(, ?): EntryCreateResponse { id, created_at, enabled, 5 more }

POST/accounts/{account_id}/dlp/entries

Update entry

client.zeroTrust.dlp.entries.update(, , ?): EntryUpdateResponse

PUT/accounts/{account_id}/dlp/entries/{entry_id}

Delete custom entry

client.zeroTrust.dlp.entries.delete(, , ?): EntryDeleteResponse | null

DELETE/accounts/{account_id}/dlp/entries/{entry_id}

ModelsExpand Collapse

EntryListResponse = UnionMember0 { id, created_at, enabled, 7 more } | UnionMember1 { id, confidence, enabled, 5 more } | UnionMember2 { id, created_at, enabled, 5 more } | 3 more

One of the following:

UnionMember0 { id, created_at, enabled, 7 more }

id: string

formatuuid

created_at: string

formatdate-time

Deprecatedenabled: boolean

pattern: Pattern { regex, validation }

type: "custom"

updated_at: string

formatdate-time

description?: string | null

Deprecatedprofile_id?: string | null

formatuuid

upload_status?: "empty" | "uploading" | "pending" | 3 more

One of the following:

"empty"

"uploading"

"pending"

"processing"

"failed"

"complete"

UnionMember1 { id, confidence, enabled, 5 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

type: "predefined"

Deprecatedprofile_id?: string | null

formatuuid

upload_status?: "empty" | "uploading" | "pending" | 3 more

One of the following:

"empty"

"uploading"

"pending"

"processing"

"failed"

"complete"

variant?: Variant { topic_type, type, description }

topic_type: "Intent" | "Content"

One of the following:

"Intent"

"Content"

type: "PromptTopic"

description?: string | null

UnionMember2 { id, created_at, enabled, 5 more }

id: string

formatuuid

created_at: string

formatdate-time

enabled: boolean

type: "integration"

updated_at: string

formatdate-time

profile_id?: string | null

formatuuid

upload_status?: "empty" | "uploading" | "pending" | 3 more

One of the following:

"empty"

"uploading"

"pending"

"processing"

"failed"

"complete"

UnionMember3 { 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

secret: boolean

type: "exact_data"

updated_at: string

formatdate-time

upload_status?: "empty" | "uploading" | "pending" | 3 more

One of the following:

"empty"

"uploading"

"pending"

"processing"

"failed"

"complete"

UnionMember4 { id, created_at, enabled, 4 more }

id: string

formatuuid

created_at: string

formatdate-time

enabled: boolean

type: "document_fingerprint"

updated_at: string

formatdate-time

upload_status?: "empty" | "uploading" | "pending" | 3 more

One of the following:

"empty"

"uploading"

"pending"

"processing"

"failed"

"complete"

UnionMember5 { id, created_at, enabled, 6 more }

id: string

formatuuid

created_at: string

formatdate-time

enabled: boolean

type: "word_list"

updated_at: string

formatdate-time

word_list: unknown

profile_id?: string | null

formatuuid

upload_status?: "empty" | "uploading" | "pending" | 3 more

One of the following:

"empty"

"uploading"

"pending"

"processing"

"failed"

"complete"

EntryGetResponse = UnionMember0 { id, created_at, enabled, 8 more } | UnionMember1 { id, confidence, enabled, 6 more } | UnionMember2 { id, created_at, enabled, 6 more } | 3 more

One of the following:

UnionMember0 { id, created_at, enabled, 8 more }

id: string

formatuuid

created_at: string

formatdate-time

Deprecatedenabled: boolean

pattern: Pattern { regex, validation }

type: "custom"

updated_at: string

formatdate-time

description?: string | null

Deprecatedprofile_id?: string | null

formatuuid

profiles?: Array<Profile>

id: string

formatuuid

upload_status?: "empty" | "uploading" | "pending" | 3 more

One of the following:

"empty"

"uploading"

"pending"

"processing"

"failed"

"complete"

UnionMember1 { id, confidence, enabled, 6 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

type: "predefined"

Deprecatedprofile_id?: string | null

formatuuid

profiles?: Array<Profile>

id: string

formatuuid

upload_status?: "empty" | "uploading" | "pending" | 3 more

One of the following:

"empty"

"uploading"

"pending"

"processing"

"failed"

"complete"

variant?: Variant { topic_type, type, description }

topic_type: "Intent" | "Content"

One of the following:

"Intent"

"Content"

type: "PromptTopic"

description?: string | null

UnionMember2 { id, created_at, enabled, 6 more }

id: string

formatuuid

created_at: string

formatdate-time

enabled: boolean

type: "integration"

updated_at: string

formatdate-time

profile_id?: string | null

formatuuid

profiles?: Array<Profile>

id: string

formatuuid

upload_status?: "empty" | "uploading" | "pending" | 3 more

One of the following:

"empty"

"uploading"

"pending"

"processing"

"failed"

"complete"

UnionMember3 { id, case_sensitive, created_at, 7 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

secret: boolean

type: "exact_data"

updated_at: string

formatdate-time

profiles?: Array<Profile>

id: string

formatuuid

upload_status?: "empty" | "uploading" | "pending" | 3 more

One of the following:

"empty"

"uploading"

"pending"

"processing"

"failed"

"complete"

UnionMember4 { id, created_at, enabled, 5 more }

id: string

formatuuid

created_at: string

formatdate-time

enabled: boolean

type: "document_fingerprint"

updated_at: string

formatdate-time

profiles?: Array<Profile>

id: string

formatuuid

upload_status?: "empty" | "uploading" | "pending" | 3 more

One of the following:

"empty"

"uploading"

"pending"

"processing"

"failed"

"complete"

UnionMember5 { id, created_at, enabled, 7 more }

id: string

formatuuid

created_at: string

formatdate-time

enabled: boolean

type: "word_list"

updated_at: string

formatdate-time

word_list: unknown

profile_id?: string | null

formatuuid

profiles?: Array<Profile>

id: string

formatuuid

upload_status?: "empty" | "uploading" | "pending" | 3 more

One of the following:

"empty"

"uploading"

"pending"

"processing"

"failed"

"complete"

EntryCreateResponse { id, created_at, enabled, 5 more }

id: string

formatuuid

created_at: string

formatdate-time

Deprecatedenabled: boolean

pattern: Pattern { regex, validation }

updated_at: string

formatdate-time

description?: string | null

Deprecatedprofile_id?: string | null

formatuuid

EntryUpdateResponse = 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

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

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

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

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

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

type: "word_list"

updated_at: string

formatdate-time

word_list: unknown

profile_id?: string | null

formatuuid

EntryDeleteResponse = unknown

DLPEntriesCustom

Create custom entry

client.zeroTrust.dlp.entries.custom.create(, ?): CustomCreateResponse { id, created_at, enabled, 5 more }

POST/accounts/{account_id}/dlp/entries

Update custom entry

client.zeroTrust.dlp.entries.custom.update(, , ?): CustomUpdateResponse { id, created_at, enabled, 5 more }

PUT/accounts/{account_id}/dlp/entries/custom/{entry_id}

Delete custom entry

client.zeroTrust.dlp.entries.custom.delete(, , ?): CustomDeleteResponse | null

DELETE/accounts/{account_id}/dlp/entries/{entry_id}

Get DLP Entry

client.zeroTrust.dlp.entries.custom.get(, , ?): CustomGetResponse

GET/accounts/{account_id}/dlp/entries/{entry_id}

List all entries

client.zeroTrust.dlp.entries.custom.list(, ?): SinglePage<CustomListResponse>

GET/accounts/{account_id}/dlp/entries

ModelsExpand Collapse

CustomCreateResponse { id, created_at, enabled, 5 more }

id: string

formatuuid

created_at: string

formatdate-time

Deprecatedenabled: boolean

pattern: Pattern { regex, validation }

updated_at: string

formatdate-time

description?: string | null

Deprecatedprofile_id?: string | null

formatuuid

CustomUpdateResponse { id, created_at, enabled, 5 more }

id: string

formatuuid

created_at: string

formatdate-time

Deprecatedenabled: boolean

pattern: Pattern { regex, validation }

updated_at: string

formatdate-time

description?: string | null

Deprecatedprofile_id?: string | null

formatuuid

CustomDeleteResponse = unknown

CustomGetResponse = UnionMember0 { id, created_at, enabled, 8 more } | UnionMember1 { id, confidence, enabled, 6 more } | UnionMember2 { id, created_at, enabled, 6 more } | 3 more

One of the following:

UnionMember0 { id, created_at, enabled, 8 more }

id: string

formatuuid

created_at: string

formatdate-time

Deprecatedenabled: boolean

pattern: Pattern { regex, validation }

type: "custom"

updated_at: string

formatdate-time

description?: string | null

Deprecatedprofile_id?: string | null

formatuuid

profiles?: Array<Profile>

id: string

formatuuid

upload_status?: "empty" | "uploading" | "pending" | 3 more

One of the following:

"empty"

"uploading"

"pending"

"processing"

"failed"

"complete"

UnionMember1 { id, confidence, enabled, 6 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

type: "predefined"

Deprecatedprofile_id?: string | null

formatuuid

profiles?: Array<Profile>

id: string

formatuuid

upload_status?: "empty" | "uploading" | "pending" | 3 more

One of the following:

"empty"

"uploading"

"pending"

"processing"

"failed"

"complete"

variant?: Variant { topic_type, type, description }

topic_type: "Intent" | "Content"

One of the following:

"Intent"

"Content"

type: "PromptTopic"

description?: string | null

UnionMember2 { id, created_at, enabled, 6 more }

id: string

formatuuid

created_at: string

formatdate-time

enabled: boolean

type: "integration"

updated_at: string

formatdate-time

profile_id?: string | null

formatuuid

profiles?: Array<Profile>

id: string

formatuuid

upload_status?: "empty" | "uploading" | "pending" | 3 more

One of the following:

"empty"

"uploading"

"pending"

"processing"

"failed"

"complete"

UnionMember3 { id, case_sensitive, created_at, 7 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

secret: boolean

type: "exact_data"

updated_at: string

formatdate-time

profiles?: Array<Profile>

id: string

formatuuid

upload_status?: "empty" | "uploading" | "pending" | 3 more

One of the following:

"empty"

"uploading"

"pending"

"processing"

"failed"

"complete"

UnionMember4 { id, created_at, enabled, 5 more }

id: string

formatuuid

created_at: string

formatdate-time

enabled: boolean

type: "document_fingerprint"

updated_at: string

formatdate-time

profiles?: Array<Profile>

id: string

formatuuid

upload_status?: "empty" | "uploading" | "pending" | 3 more

One of the following:

"empty"

"uploading"

"pending"

"processing"

"failed"

"complete"

UnionMember5 { id, created_at, enabled, 7 more }

id: string

formatuuid

created_at: string

formatdate-time

enabled: boolean

type: "word_list"

updated_at: string

formatdate-time

word_list: unknown

profile_id?: string | null

formatuuid

profiles?: Array<Profile>

id: string

formatuuid

upload_status?: "empty" | "uploading" | "pending" | 3 more

One of the following:

"empty"

"uploading"

"pending"

"processing"

"failed"

"complete"

CustomListResponse = UnionMember0 { id, created_at, enabled, 7 more } | UnionMember1 { id, confidence, enabled, 5 more } | UnionMember2 { id, created_at, enabled, 5 more } | 3 more

One of the following:

UnionMember0 { id, created_at, enabled, 7 more }

id: string

formatuuid

created_at: string

formatdate-time

Deprecatedenabled: boolean

pattern: Pattern { regex, validation }

type: "custom"

updated_at: string

formatdate-time

description?: string | null

Deprecatedprofile_id?: string | null

formatuuid

upload_status?: "empty" | "uploading" | "pending" | 3 more

One of the following:

"empty"

"uploading"

"pending"

"processing"

"failed"

"complete"

UnionMember1 { id, confidence, enabled, 5 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

type: "predefined"

Deprecatedprofile_id?: string | null

formatuuid

upload_status?: "empty" | "uploading" | "pending" | 3 more

One of the following:

"empty"

"uploading"

"pending"

"processing"

"failed"

"complete"

variant?: Variant { topic_type, type, description }

topic_type: "Intent" | "Content"

One of the following:

"Intent"

"Content"

type: "PromptTopic"

description?: string | null

UnionMember2 { id, created_at, enabled, 5 more }

id: string

formatuuid

created_at: string

formatdate-time

enabled: boolean

type: "integration"

updated_at: string

formatdate-time

profile_id?: string | null

formatuuid

upload_status?: "empty" | "uploading" | "pending" | 3 more

One of the following:

"empty"

"uploading"

"pending"

"processing"

"failed"

"complete"

UnionMember3 { 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

secret: boolean

type: "exact_data"

updated_at: string

formatdate-time

upload_status?: "empty" | "uploading" | "pending" | 3 more

One of the following:

"empty"

"uploading"

"pending"

"processing"

"failed"

"complete"

UnionMember4 { id, created_at, enabled, 4 more }

id: string

formatuuid

created_at: string

formatdate-time

enabled: boolean

type: "document_fingerprint"

updated_at: string

formatdate-time

upload_status?: "empty" | "uploading" | "pending" | 3 more

One of the following:

"empty"

"uploading"

"pending"

"processing"

"failed"

"complete"

UnionMember5 { id, created_at, enabled, 6 more }

id: string

formatuuid

created_at: string

formatdate-time

enabled: boolean

type: "word_list"

updated_at: string

formatdate-time

word_list: unknown

profile_id?: string | null

formatuuid

upload_status?: "empty" | "uploading" | "pending" | 3 more

One of the following:

"empty"

"uploading"

"pending"

"processing"

"failed"

"complete"

DLPEntriesPredefined

Create predefined entry

client.zeroTrust.dlp.entries.predefined.create(, ?): PredefinedCreateResponse { id, confidence, enabled, 3 more }

POST/accounts/{account_id}/dlp/entries/predefined

Update predefined entry

client.zeroTrust.dlp.entries.predefined.update(, , ?): PredefinedUpdateResponse { id, confidence, enabled, 3 more }

PUT/accounts/{account_id}/dlp/entries/predefined/{entry_id}

Delete predefined entry

client.zeroTrust.dlp.entries.predefined.delete(, , ?): PredefinedDeleteResponse | null

DELETE/accounts/{account_id}/dlp/entries/predefined/{entry_id}

Get DLP Entry

client.zeroTrust.dlp.entries.predefined.get(, , ?): PredefinedGetResponse

GET/accounts/{account_id}/dlp/entries/{entry_id}

List all entries

client.zeroTrust.dlp.entries.predefined.list(, ?): SinglePage<PredefinedListResponse>

GET/accounts/{account_id}/dlp/entries

ModelsExpand Collapse

PredefinedCreateResponse { id, confidence, enabled, 3 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

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

PredefinedUpdateResponse { id, confidence, enabled, 3 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

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

PredefinedDeleteResponse = unknown

PredefinedGetResponse = UnionMember0 { id, created_at, enabled, 8 more } | UnionMember1 { id, confidence, enabled, 6 more } | UnionMember2 { id, created_at, enabled, 6 more } | 3 more

One of the following:

UnionMember0 { id, created_at, enabled, 8 more }

id: string

formatuuid

created_at: string

formatdate-time

Deprecatedenabled: boolean

pattern: Pattern { regex, validation }

type: "custom"

updated_at: string

formatdate-time

description?: string | null

Deprecatedprofile_id?: string | null

formatuuid

profiles?: Array<Profile>

id: string

formatuuid

upload_status?: "empty" | "uploading" | "pending" | 3 more

One of the following:

"empty"

"uploading"

"pending"

"processing"

"failed"

"complete"

UnionMember1 { id, confidence, enabled, 6 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

type: "predefined"

Deprecatedprofile_id?: string | null

formatuuid

profiles?: Array<Profile>

id: string

formatuuid

upload_status?: "empty" | "uploading" | "pending" | 3 more

One of the following:

"empty"

"uploading"

"pending"

"processing"

"failed"

"complete"

variant?: Variant { topic_type, type, description }

topic_type: "Intent" | "Content"

One of the following:

"Intent"

"Content"

type: "PromptTopic"

description?: string | null

UnionMember2 { id, created_at, enabled, 6 more }

id: string

formatuuid

created_at: string

formatdate-time

enabled: boolean

type: "integration"

updated_at: string

formatdate-time

profile_id?: string | null

formatuuid

profiles?: Array<Profile>

id: string

formatuuid

upload_status?: "empty" | "uploading" | "pending" | 3 more

One of the following:

"empty"

"uploading"

"pending"

"processing"

"failed"

"complete"

UnionMember3 { id, case_sensitive, created_at, 7 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

secret: boolean

type: "exact_data"

updated_at: string

formatdate-time

profiles?: Array<Profile>

id: string

formatuuid

upload_status?: "empty" | "uploading" | "pending" | 3 more

One of the following:

"empty"

"uploading"

"pending"

"processing"

"failed"

"complete"

UnionMember4 { id, created_at, enabled, 5 more }

id: string

formatuuid

created_at: string

formatdate-time

enabled: boolean

type: "document_fingerprint"

updated_at: string

formatdate-time

profiles?: Array<Profile>

id: string

formatuuid

upload_status?: "empty" | "uploading" | "pending" | 3 more

One of the following:

"empty"

"uploading"

"pending"

"processing"

"failed"

"complete"

UnionMember5 { id, created_at, enabled, 7 more }

id: string

formatuuid

created_at: string

formatdate-time

enabled: boolean

type: "word_list"

updated_at: string

formatdate-time

word_list: unknown

profile_id?: string | null

formatuuid

profiles?: Array<Profile>

id: string

formatuuid

upload_status?: "empty" | "uploading" | "pending" | 3 more

One of the following:

"empty"

"uploading"

"pending"

"processing"

"failed"

"complete"

PredefinedListResponse = UnionMember0 { id, created_at, enabled, 7 more } | UnionMember1 { id, confidence, enabled, 5 more } | UnionMember2 { id, created_at, enabled, 5 more } | 3 more

One of the following:

UnionMember0 { id, created_at, enabled, 7 more }

id: string

formatuuid

created_at: string

formatdate-time

Deprecatedenabled: boolean

pattern: Pattern { regex, validation }

type: "custom"

updated_at: string

formatdate-time

description?: string | null

Deprecatedprofile_id?: string | null

formatuuid

upload_status?: "empty" | "uploading" | "pending" | 3 more

One of the following:

"empty"

"uploading"

"pending"

"processing"

"failed"

"complete"

UnionMember1 { id, confidence, enabled, 5 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

type: "predefined"

Deprecatedprofile_id?: string | null

formatuuid

upload_status?: "empty" | "uploading" | "pending" | 3 more

One of the following:

"empty"

"uploading"

"pending"

"processing"

"failed"

"complete"

variant?: Variant { topic_type, type, description }

topic_type: "Intent" | "Content"

One of the following:

"Intent"

"Content"

type: "PromptTopic"

description?: string | null

UnionMember2 { id, created_at, enabled, 5 more }

id: string

formatuuid

created_at: string

formatdate-time

enabled: boolean

type: "integration"

updated_at: string

formatdate-time

profile_id?: string | null

formatuuid

upload_status?: "empty" | "uploading" | "pending" | 3 more

One of the following:

"empty"

"uploading"

"pending"

"processing"

"failed"

"complete"

UnionMember3 { 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

secret: boolean

type: "exact_data"

updated_at: string

formatdate-time

upload_status?: "empty" | "uploading" | "pending" | 3 more

One of the following:

"empty"

"uploading"

"pending"

"processing"

"failed"

"complete"

UnionMember4 { id, created_at, enabled, 4 more }

id: string

formatuuid

created_at: string

formatdate-time

enabled: boolean

type: "document_fingerprint"

updated_at: string

formatdate-time

upload_status?: "empty" | "uploading" | "pending" | 3 more

One of the following:

"empty"

"uploading"

"pending"

"processing"

"failed"

"complete"

UnionMember5 { id, created_at, enabled, 6 more }

id: string

formatuuid

created_at: string

formatdate-time

enabled: boolean

type: "word_list"

updated_at: string

formatdate-time

word_list: unknown

profile_id?: string | null

formatuuid

upload_status?: "empty" | "uploading" | "pending" | 3 more

One of the following:

"empty"

"uploading"

"pending"

"processing"

"failed"

"complete"

DLPEntriesIntegration

Create integration entry

client.zeroTrust.dlp.entries.integration.create(, ?): IntegrationCreateResponse { id, created_at, enabled, 3 more }

POST/accounts/{account_id}/dlp/entries/integration

Update integration entry

client.zeroTrust.dlp.entries.integration.update(, , ?): IntegrationUpdateResponse { id, created_at, enabled, 3 more }

PUT/accounts/{account_id}/dlp/entries/integration/{entry_id}

Delete integration entry

client.zeroTrust.dlp.entries.integration.delete(, , ?): IntegrationDeleteResponse | null

DELETE/accounts/{account_id}/dlp/entries/integration/{entry_id}

Get DLP Entry

client.zeroTrust.dlp.entries.integration.get(, , ?): IntegrationGetResponse

GET/accounts/{account_id}/dlp/entries/{entry_id}

List all entries

client.zeroTrust.dlp.entries.integration.list(, ?): SinglePage<IntegrationListResponse>

GET/accounts/{account_id}/dlp/entries

ModelsExpand Collapse

IntegrationCreateResponse { id, created_at, enabled, 3 more }

id: string

formatuuid

created_at: string

formatdate-time

enabled: boolean

updated_at: string

formatdate-time

profile_id?: string | null

formatuuid

IntegrationUpdateResponse { id, created_at, enabled, 3 more }

id: string

formatuuid

created_at: string

formatdate-time

enabled: boolean

updated_at: string

formatdate-time

profile_id?: string | null

formatuuid

IntegrationDeleteResponse = unknown

IntegrationGetResponse = UnionMember0 { id, created_at, enabled, 8 more } | UnionMember1 { id, confidence, enabled, 6 more } | UnionMember2 { id, created_at, enabled, 6 more } | 3 more

One of the following:

UnionMember0 { id, created_at, enabled, 8 more }

id: string

formatuuid

created_at: string

formatdate-time

Deprecatedenabled: boolean

pattern: Pattern { regex, validation }

type: "custom"

updated_at: string

formatdate-time

description?: string | null

Deprecatedprofile_id?: string | null

formatuuid

profiles?: Array<Profile>

id: string

formatuuid

upload_status?: "empty" | "uploading" | "pending" | 3 more

One of the following:

"empty"

"uploading"

"pending"

"processing"

"failed"

"complete"

UnionMember1 { id, confidence, enabled, 6 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

type: "predefined"

Deprecatedprofile_id?: string | null

formatuuid

profiles?: Array<Profile>

id: string

formatuuid

upload_status?: "empty" | "uploading" | "pending" | 3 more

One of the following:

"empty"

"uploading"

"pending"

"processing"

"failed"

"complete"

variant?: Variant { topic_type, type, description }

topic_type: "Intent" | "Content"

One of the following:

"Intent"

"Content"

type: "PromptTopic"

description?: string | null

UnionMember2 { id, created_at, enabled, 6 more }

id: string

formatuuid

created_at: string

formatdate-time

enabled: boolean

type: "integration"

updated_at: string

formatdate-time

profile_id?: string | null

formatuuid

profiles?: Array<Profile>

id: string

formatuuid

upload_status?: "empty" | "uploading" | "pending" | 3 more

One of the following:

"empty"

"uploading"

"pending"

"processing"

"failed"

"complete"

UnionMember3 { id, case_sensitive, created_at, 7 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

secret: boolean

type: "exact_data"

updated_at: string

formatdate-time

profiles?: Array<Profile>

id: string

formatuuid

upload_status?: "empty" | "uploading" | "pending" | 3 more

One of the following:

"empty"

"uploading"

"pending"

"processing"

"failed"

"complete"

UnionMember4 { id, created_at, enabled, 5 more }

id: string

formatuuid

created_at: string

formatdate-time

enabled: boolean

type: "document_fingerprint"

updated_at: string

formatdate-time

profiles?: Array<Profile>

id: string

formatuuid

upload_status?: "empty" | "uploading" | "pending" | 3 more

One of the following:

"empty"

"uploading"

"pending"

"processing"

"failed"

"complete"

UnionMember5 { id, created_at, enabled, 7 more }

id: string

formatuuid

created_at: string

formatdate-time

enabled: boolean

type: "word_list"

updated_at: string

formatdate-time

word_list: unknown

profile_id?: string | null

formatuuid

profiles?: Array<Profile>

id: string

formatuuid

upload_status?: "empty" | "uploading" | "pending" | 3 more

One of the following:

"empty"

"uploading"

"pending"

"processing"

"failed"

"complete"

IntegrationListResponse = UnionMember0 { id, created_at, enabled, 7 more } | UnionMember1 { id, confidence, enabled, 5 more } | UnionMember2 { id, created_at, enabled, 5 more } | 3 more

One of the following:

UnionMember0 { id, created_at, enabled, 7 more }

id: string

formatuuid

created_at: string

formatdate-time

Deprecatedenabled: boolean

pattern: Pattern { regex, validation }

type: "custom"

updated_at: string

formatdate-time

description?: string | null

Deprecatedprofile_id?: string | null

formatuuid

upload_status?: "empty" | "uploading" | "pending" | 3 more

One of the following:

"empty"

"uploading"

"pending"

"processing"

"failed"

"complete"

UnionMember1 { id, confidence, enabled, 5 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

type: "predefined"

Deprecatedprofile_id?: string | null

formatuuid

upload_status?: "empty" | "uploading" | "pending" | 3 more

One of the following:

"empty"

"uploading"

"pending"

"processing"

"failed"

"complete"

variant?: Variant { topic_type, type, description }

topic_type: "Intent" | "Content"

One of the following:

"Intent"

"Content"

type: "PromptTopic"

description?: string | null

UnionMember2 { id, created_at, enabled, 5 more }

id: string

formatuuid

created_at: string

formatdate-time

enabled: boolean

type: "integration"

updated_at: string

formatdate-time

profile_id?: string | null

formatuuid

upload_status?: "empty" | "uploading" | "pending" | 3 more

One of the following:

"empty"

"uploading"

"pending"

"processing"

"failed"

"complete"

UnionMember3 { 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

secret: boolean

type: "exact_data"

updated_at: string

formatdate-time

upload_status?: "empty" | "uploading" | "pending" | 3 more

One of the following:

"empty"

"uploading"

"pending"

"processing"

"failed"

"complete"

UnionMember4 { id, created_at, enabled, 4 more }

id: string

formatuuid

created_at: string

formatdate-time

enabled: boolean

type: "document_fingerprint"

updated_at: string

formatdate-time

upload_status?: "empty" | "uploading" | "pending" | 3 more

One of the following:

"empty"

"uploading"

"pending"

"processing"

"failed"

"complete"

UnionMember5 { id, created_at, enabled, 6 more }

id: string

formatuuid

created_at: string

formatdate-time

enabled: boolean

type: "word_list"

updated_at: string

formatdate-time

word_list: unknown

profile_id?: string | null

formatuuid

upload_status?: "empty" | "uploading" | "pending" | 3 more

One of the following:

"empty"

"uploading"

"pending"

"processing"

"failed"

"complete"