API Reference

Zero Trust

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

DLP

DLPCustom Prompt Topics

List custom prompt topics

client.zeroTrust.dlp.customPromptTopics.list(CustomPromptTopicListParams { account_id } params, RequestOptionsoptions?): SinglePage<CustomPromptTopic { id, created_at, enabled, 5 more } >

GET/accounts/{account_id}/dlp/custom_prompt_topics

Get custom prompt topic

client.zeroTrust.dlp.customPromptTopics.get(stringentryID, CustomPromptTopicGetParams { account_id } params, RequestOptionsoptions?): CustomPromptTopic { id, created_at, enabled, 5 more }

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

Create custom prompt topic

client.zeroTrust.dlp.customPromptTopics.create(CustomPromptTopicCreateParams { account_id, enabled, name, 3 more } params, RequestOptionsoptions?): CustomPromptTopic { id, created_at, enabled, 5 more }

POST/accounts/{account_id}/dlp/custom_prompt_topics

Update custom prompt topic

client.zeroTrust.dlp.customPromptTopics.update(stringentryID, CustomPromptTopicUpdateParams { account_id, enabled, name, 2 more } params, RequestOptionsoptions?): CustomPromptTopic { id, created_at, enabled, 5 more }

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

Delete custom prompt topic

client.zeroTrust.dlp.customPromptTopics.delete(stringentryID, CustomPromptTopicDeleteParams { account_id } params, RequestOptionsoptions?): CustomPromptTopicDeleteResponse | null

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

ModelsExpand Collapse

CustomPromptTopic { id, created_at, enabled, 5 more }

id: string

formatuuid

created_at: string

formatdate-time

Deprecatedenabled: boolean

name: string

topic: string

maxLength50

minLength2

updated_at: string

formatdate-time

description?: string | null

Deprecatedprofile_id?: string | null

formatuuid

CustomPromptTopicDeleteResponse = unknown

DLPDatasets

Fetch all datasets

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

GET/accounts/{account_id}/dlp/datasets

Fetch a specific dataset

client.zeroTrust.dlp.datasets.get(stringdatasetID, DatasetGetParams { account_id } params, RequestOptionsoptions?): Dataset { id, columns, created_at, 9 more }

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

Create a new dataset

client.zeroTrust.dlp.datasets.create(DatasetCreateParams { account_id, name, case_sensitive, 3 more } params, RequestOptionsoptions?): DatasetCreation { dataset, encoding_version, max_cells, 2 more }

POST/accounts/{account_id}/dlp/datasets

Update details about a dataset

client.zeroTrust.dlp.datasets.update(stringdatasetID, DatasetUpdateParams { account_id, case_sensitive, description, name } params, RequestOptionsoptions?): Dataset { id, columns, created_at, 9 more }

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

Delete a dataset

client.zeroTrust.dlp.datasets.delete(stringdatasetID, DatasetDeleteParams { account_id } params, RequestOptionsoptions?): 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

name: string

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

name: string

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(stringdatasetID, UploadCreateParams { account_id } params, RequestOptionsoptions?): 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(numberversion, "string" | "ArrayBuffer" | "ArrayBufferView" | 2 moredataset, UploadEditParams { account_id, dataset_id } params, RequestOptionsoptions?): 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(numberversion, VersionCreateParams { account_id, dataset_id, body } params, RequestOptionsoptions?): 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(stringentryID, "string" | "ArrayBuffer" | "ArrayBufferView" | 2 moredatasetVersionEntry, EntryCreateParams { account_id, dataset_id, version } params, RequestOptionsoptions?): 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(PatternValidateParams { account_id, regex, max_match_bytes } params, RequestOptionsoptions?): PatternValidateResponse { valid }

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

ModelsExpand Collapse

PatternValidateResponse { valid }

valid: boolean

DLPPayload Logs

Get payload log settings

Deprecated

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

GET/accounts/{account_id}/dlp/payload_log

Set payload log settings

Deprecated

client.zeroTrust.dlp.payloadLogs.update(PayloadLogUpdateParams { account_id, masking_level, public_key } params, RequestOptionsoptions?): 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.

DLPSettings

Get DLP account-level settings.

client.zeroTrust.dlp.settings.get(SettingGetParams { account_id } params, RequestOptionsoptions?): DLPSettings { ai_context_analysis, ocr, payload_logging }

GET/accounts/{account_id}/dlp/settings

Update DLP account-level settings (full replacement).

client.zeroTrust.dlp.settings.update(SettingUpdateParams { account_id, ai_context_analysis, ocr, payload_logging } params, RequestOptionsoptions?): DLPSettings { ai_context_analysis, ocr, payload_logging }

PUT/accounts/{account_id}/dlp/settings

Partially update DLP account-level settings.

client.zeroTrust.dlp.settings.edit(SettingEditParams { account_id, ai_context_analysis, ocr, payload_logging } params, RequestOptionsoptions?): DLPSettings { ai_context_analysis, ocr, payload_logging }

PATCH/accounts/{account_id}/dlp/settings

Delete (reset) DLP account-level settings to initial values.

client.zeroTrust.dlp.settings.delete(SettingDeleteParams { account_id } params, RequestOptionsoptions?): DLPSettings { ai_context_analysis, ocr, payload_logging }

DELETE/accounts/{account_id}/dlp/settings

ModelsExpand Collapse

DLPSettings { ai_context_analysis, ocr, payload_logging }

DLP account-level settings response.

ai_context_analysis: boolean

Whether AI context analysis is enabled at the account level.

ocr: boolean

Whether OCR is enabled at the account level.

payload_logging: PayloadLogging { 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(AccountMappingGetParams { account_id } params, RequestOptionsoptions?): AccountMappingGetResponse { addin_identifier_token, auth_requirements }

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

Create mapping

client.zeroTrust.dlp.email.accountMapping.create(AccountMappingCreateParams { account_id, auth_requirements } params, RequestOptionsoptions?): 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(RuleListParams { account_id } params, RequestOptionsoptions?): 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(stringruleID, RuleGetParams { account_id } params, RequestOptionsoptions?): 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(RuleCreateParams { account_id, action, conditions, 3 more } params, RequestOptionsoptions?): RuleCreateResponse { action, conditions, created_at, 6 more }

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

Update email scanner rule

client.zeroTrust.dlp.email.rules.update(stringruleID, RuleUpdateParams { account_id, action, conditions, 3 more } params, RequestOptionsoptions?): 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(stringruleID, RuleDeleteParams { account_id } params, RequestOptionsoptions?): 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(RuleBulkEditParams { account_id, new_priorities } params, RequestOptionsoptions?): 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

name: string

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

name: string

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

name: string

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

name: string

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

name: string

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

name: string

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(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, 6 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, 7 more } | CustomPromptTopicEntry { id, created_at, enabled, 4 more } | PredefinedEntry { id, confidence, enabled, 5 more } | 4 more>

One of the following:

CustomEntry { id, created_at, enabled, 7 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

validator_ids?: Array<string>

Validators this entry references, by id, at most 10. An empty list means the entry references none.

Returned by the entry endpoints. Not returned on entries embedded in other responses, such as profiles.

CustomPromptTopicEntry { id, created_at, enabled, 4 more }

id: string

formatuuid

created_at: string

formatdate-time

Deprecatedenabled: boolean

name: string

type: "custom_prompt_topic"

updated_at: string

formatdate-time

description?: string | null

The optional description of the custom prompt topic entry.

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

name: string

type: "predefined"

deprecated?: boolean

Whether this entry is deprecated for new use. This is computed from the static catalog and emitted only when true.

Deprecatedprofile_id?: string | null

formatuuid

variant?: UnionMember0 { topic_type, type, description } | UnionMember1 { type, description }

A Predefined AI prompt classification topic entry.

One of the following:

UnionMember0 { topic_type, type, description }

A Predefined AI prompt classification topic entry.

topic_type: "Intent" | "Content"

One of the following:

"Intent"

"Content"

type: "PromptTopic"

description?: string | null

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

UnionMember1 { type, description }

A general predefined entry.

type: "General"

description?: string | null

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

IntegrationEntry { id, created_at, enabled, 4 more }

id: string

formatuuid

created_at: string

formatdate-time

enabled: boolean

name: string

type: "integration"

updated_at: string

formatdate-time

profile_id?: string | null

formatuuid

ExactDataEntry { id, case_sensitive, created_at, 6 more }

id: string

formatuuid

case_sensitive: boolean

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

created_at: string

formatdate-time

enabled: boolean

name: string

secret: boolean

type: "exact_data"

updated_at: string

formatdate-time

description?: string | null

The optional description of the exact data entry.

DocumentFingerprintEntry { id, created_at, enabled, 4 more }

id: string

formatuuid

created_at: string

formatdate-time

enabled: boolean

name: string

type: "document_fingerprint"

updated_at: string

formatdate-time

description?: string | null

The optional description of the document fingerprint entry.

WordListEntry { id, created_at, enabled, 5 more }

id: string

formatuuid

created_at: string

formatdate-time

enabled: boolean

name: string

type: "word_list"

updated_at: string

formatdate-time

word_list: Array<string>

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

One of the following:

CustomEntry { id, created_at, enabled, 7 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

validator_ids?: Array<string>

Validators this entry references, by id, at most 10. An empty list means the entry references none.

Returned by the entry endpoints. Not returned on entries embedded in other responses, such as profiles.

CustomPromptTopicEntry { id, created_at, enabled, 4 more }

id: string

formatuuid

created_at: string

formatdate-time

Deprecatedenabled: boolean

name: string

type: "custom_prompt_topic"

updated_at: string

formatdate-time

description?: string | null

The optional description of the custom prompt topic entry.

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

name: string

type: "predefined"

deprecated?: boolean

Whether this entry is deprecated for new use. This is computed from the static catalog and emitted only when true.

Deprecatedprofile_id?: string | null

formatuuid

variant?: UnionMember0 { topic_type, type, description } | UnionMember1 { type, description }

A Predefined AI prompt classification topic entry.

One of the following:

UnionMember0 { topic_type, type, description }

A Predefined AI prompt classification topic entry.

topic_type: "Intent" | "Content"

One of the following:

"Intent"

"Content"

type: "PromptTopic"

description?: string | null

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

UnionMember1 { type, description }

A general predefined entry.

type: "General"

description?: string | null

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

IntegrationEntry { id, created_at, enabled, 4 more }

id: string

formatuuid

created_at: string

formatdate-time

enabled: boolean

name: string

type: "integration"

updated_at: string

formatdate-time

profile_id?: string | null

formatuuid

ExactDataEntry { id, case_sensitive, created_at, 6 more }

id: string

formatuuid

case_sensitive: boolean

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

created_at: string

formatdate-time

enabled: boolean

name: string

secret: boolean

type: "exact_data"

updated_at: string

formatdate-time

description?: string | null

The optional description of the exact data entry.

DocumentFingerprintEntry { id, created_at, enabled, 4 more }

id: string

formatuuid

created_at: string

formatdate-time

enabled: boolean

name: string

type: "document_fingerprint"

updated_at: string

formatdate-time

description?: string | null

The optional description of the document fingerprint entry.

WordListEntry { id, created_at, enabled, 5 more }

id: string

formatuuid

created_at: string

formatdate-time

enabled: boolean

name: string

type: "word_list"

updated_at: string

formatdate-time

word_list: Array<string>

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

One of the following:

CustomEntry { id, created_at, enabled, 7 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

validator_ids?: Array<string>

Validators this entry references, by id, at most 10. An empty list means the entry references none.

Returned by the entry endpoints. Not returned on entries embedded in other responses, such as profiles.

CustomPromptTopicEntry { id, created_at, enabled, 4 more }

id: string

formatuuid

created_at: string

formatdate-time

Deprecatedenabled: boolean

name: string

type: "custom_prompt_topic"

updated_at: string

formatdate-time

description?: string | null

The optional description of the custom prompt topic entry.

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

name: string

type: "predefined"

deprecated?: boolean

Whether this entry is deprecated for new use. This is computed from the static catalog and emitted only when true.

Deprecatedprofile_id?: string | null

formatuuid

variant?: UnionMember0 { topic_type, type, description } | UnionMember1 { type, description }

A Predefined AI prompt classification topic entry.

One of the following:

UnionMember0 { topic_type, type, description }

A Predefined AI prompt classification topic entry.

topic_type: "Intent" | "Content"

One of the following:

"Intent"

"Content"

type: "PromptTopic"

description?: string | null

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

UnionMember1 { type, description }

A general predefined entry.

type: "General"

description?: string | null

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

IntegrationEntry { id, created_at, enabled, 4 more }

id: string

formatuuid

created_at: string

formatdate-time

enabled: boolean

name: string

type: "integration"

updated_at: string

formatdate-time

profile_id?: string | null

formatuuid

ExactDataEntry { id, case_sensitive, created_at, 6 more }

id: string

formatuuid

case_sensitive: boolean

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

created_at: string

formatdate-time

enabled: boolean

name: string

secret: boolean

type: "exact_data"

updated_at: string

formatdate-time

description?: string | null

The optional description of the exact data entry.

DocumentFingerprintEntry { id, created_at, enabled, 4 more }

id: string

formatuuid

created_at: string

formatdate-time

enabled: boolean

name: string

type: "document_fingerprint"

updated_at: string

formatdate-time

description?: string | null

The optional description of the document fingerprint entry.

WordListEntry { id, created_at, enabled, 5 more }

id: string

formatuuid

created_at: string

formatdate-time

enabled: boolean

name: string

type: "word_list"

updated_at: string

formatdate-time

word_list: Array<string>

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, 6 more }

id: string

formatuuid

created_at: string

formatdate-time

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

One of the following:

CustomEntry { id, created_at, enabled, 7 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

validator_ids?: Array<string>

Validators this entry references, by id, at most 10. An empty list means the entry references none.

Returned by the entry endpoints. Not returned on entries embedded in other responses, such as profiles.

CustomPromptTopicEntry { id, created_at, enabled, 4 more }

id: string

formatuuid

created_at: string

formatdate-time

Deprecatedenabled: boolean

name: string

type: "custom_prompt_topic"

updated_at: string

formatdate-time

description?: string | null

The optional description of the custom prompt topic entry.

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

name: string

type: "predefined"

deprecated?: boolean

Whether this entry is deprecated for new use. This is computed from the static catalog and emitted only when true.

Deprecatedprofile_id?: string | null

formatuuid

variant?: UnionMember0 { topic_type, type, description } | UnionMember1 { type, description }

A Predefined AI prompt classification topic entry.

One of the following:

UnionMember0 { topic_type, type, description }

A Predefined AI prompt classification topic entry.

topic_type: "Intent" | "Content"

One of the following:

"Intent"

"Content"

type: "PromptTopic"

description?: string | null

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

UnionMember1 { type, description }

A general predefined entry.

type: "General"

description?: string | null

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

IntegrationEntry { id, created_at, enabled, 4 more }

id: string

formatuuid

created_at: string

formatdate-time

enabled: boolean

name: string

type: "integration"

updated_at: string

formatdate-time

profile_id?: string | null

formatuuid

ExactDataEntry { id, case_sensitive, created_at, 6 more }

id: string

formatuuid

case_sensitive: boolean

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

created_at: string

formatdate-time

enabled: boolean

name: string

secret: boolean

type: "exact_data"

updated_at: string

formatdate-time

description?: string | null

The optional description of the exact data entry.

DocumentFingerprintEntry { id, created_at, enabled, 4 more }

id: string

formatuuid

created_at: string

formatdate-time

enabled: boolean

name: string

type: "document_fingerprint"

updated_at: string

formatdate-time

description?: string | null

The optional description of the document fingerprint entry.

WordListEntry { id, created_at, enabled, 5 more }

id: string

formatuuid

created_at: string

formatdate-time

enabled: boolean

name: string

type: "word_list"

updated_at: string

formatdate-time

word_list: Array<string>

profile_id?: string | null

formatuuid

integration_id: string

formatuuid

name: string

shared_entries: Array<CustomEntry { id, created_at, enabled, 7 more } | CustomPromptTopicEntry { id, created_at, enabled, 4 more } | PredefinedEntry { id, confidence, enabled, 5 more } | 4 more>

One of the following:

CustomEntry { id, created_at, enabled, 7 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

validator_ids?: Array<string>

Validators this entry references, by id, at most 10. An empty list means the entry references none.

Returned by the entry endpoints. Not returned on entries embedded in other responses, such as profiles.

CustomPromptTopicEntry { id, created_at, enabled, 4 more }

id: string

formatuuid

created_at: string

formatdate-time

Deprecatedenabled: boolean

name: string

type: "custom_prompt_topic"

updated_at: string

formatdate-time

description?: string | null

The optional description of the custom prompt topic entry.

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

name: string

type: "predefined"

deprecated?: boolean

Whether this entry is deprecated for new use. This is computed from the static catalog and emitted only when true.

Deprecatedprofile_id?: string | null

formatuuid

variant?: UnionMember0 { topic_type, type, description } | UnionMember1 { type, description }

A Predefined AI prompt classification topic entry.

One of the following:

UnionMember0 { topic_type, type, description }

A Predefined AI prompt classification topic entry.

topic_type: "Intent" | "Content"

One of the following:

"Intent"

"Content"

type: "PromptTopic"

description?: string | null

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

UnionMember1 { type, description }

A general predefined entry.

type: "General"

description?: string | null

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

IntegrationEntry { id, created_at, enabled, 4 more }

id: string

formatuuid

created_at: string

formatdate-time

enabled: boolean

name: string

type: "integration"

updated_at: string

formatdate-time

profile_id?: string | null

formatuuid

ExactDataEntry { id, case_sensitive, created_at, 6 more }

id: string

formatuuid

case_sensitive: boolean

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

created_at: string

formatdate-time

enabled: boolean

name: string

secret: boolean

type: "exact_data"

updated_at: string

formatdate-time

description?: string | null

The optional description of the exact data entry.

DocumentFingerprintEntry { id, created_at, enabled, 4 more }

id: string

formatuuid

created_at: string

formatdate-time

enabled: boolean

name: string

type: "document_fingerprint"

updated_at: string

formatdate-time

description?: string | null

The optional description of the document fingerprint entry.

WordListEntry { id, created_at, enabled, 5 more }

id: string

formatuuid

created_at: string

formatdate-time

enabled: boolean

name: string

type: "word_list"

updated_at: string

formatdate-time

word_list: Array<string>

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(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, 7 more } | CustomPromptTopicEntry { id, created_at, enabled, 4 more } | PredefinedEntry { id, confidence, enabled, 5 more } | 4 more>

One of the following:

CustomEntry { id, created_at, enabled, 7 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

validator_ids?: Array<string>

Validators this entry references, by id, at most 10. An empty list means the entry references none.

Returned by the entry endpoints. Not returned on entries embedded in other responses, such as profiles.

CustomPromptTopicEntry { id, created_at, enabled, 4 more }

id: string

formatuuid

created_at: string

formatdate-time

Deprecatedenabled: boolean

name: string

type: "custom_prompt_topic"

updated_at: string

formatdate-time

description?: string | null

The optional description of the custom prompt topic entry.

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

name: string

type: "predefined"

deprecated?: boolean

Whether this entry is deprecated for new use. This is computed from the static catalog and emitted only when true.

Deprecatedprofile_id?: string | null

formatuuid

variant?: UnionMember0 { topic_type, type, description } | UnionMember1 { type, description }

A Predefined AI prompt classification topic entry.

One of the following:

UnionMember0 { topic_type, type, description }

A Predefined AI prompt classification topic entry.

topic_type: "Intent" | "Content"

One of the following:

"Intent"

"Content"

type: "PromptTopic"

description?: string | null

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

UnionMember1 { type, description }

A general predefined entry.

type: "General"

description?: string | null

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

IntegrationEntry { id, created_at, enabled, 4 more }

id: string

formatuuid

created_at: string

formatdate-time

enabled: boolean

name: string

type: "integration"

updated_at: string

formatdate-time

profile_id?: string | null

formatuuid

ExactDataEntry { id, case_sensitive, created_at, 6 more }

id: string

formatuuid

case_sensitive: boolean

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

created_at: string

formatdate-time

enabled: boolean

name: string

secret: boolean

type: "exact_data"

updated_at: string

formatdate-time

description?: string | null

The optional description of the exact data entry.

DocumentFingerprintEntry { id, created_at, enabled, 4 more }

id: string

formatuuid

created_at: string

formatdate-time

enabled: boolean

name: string

type: "document_fingerprint"

updated_at: string

formatdate-time

description?: string | null

The optional description of the document fingerprint entry.

WordListEntry { id, created_at, enabled, 5 more }

id: string

formatuuid

created_at: string

formatdate-time

enabled: boolean

name: string

type: "word_list"

updated_at: string

formatdate-time

word_list: Array<string>

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

One of the following:

CustomEntry { id, created_at, enabled, 7 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

validator_ids?: Array<string>

Validators this entry references, by id, at most 10. An empty list means the entry references none.

Returned by the entry endpoints. Not returned on entries embedded in other responses, such as profiles.

CustomPromptTopicEntry { id, created_at, enabled, 4 more }

id: string

formatuuid

created_at: string

formatdate-time

Deprecatedenabled: boolean

name: string

type: "custom_prompt_topic"

updated_at: string

formatdate-time

description?: string | null

The optional description of the custom prompt topic entry.

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

name: string

type: "predefined"

deprecated?: boolean

Whether this entry is deprecated for new use. This is computed from the static catalog and emitted only when true.

Deprecatedprofile_id?: string | null

formatuuid

variant?: UnionMember0 { topic_type, type, description } | UnionMember1 { type, description }

A Predefined AI prompt classification topic entry.

One of the following:

UnionMember0 { topic_type, type, description }

A Predefined AI prompt classification topic entry.

topic_type: "Intent" | "Content"

One of the following:

"Intent"

"Content"

type: "PromptTopic"

description?: string | null

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

UnionMember1 { type, description }

A general predefined entry.

type: "General"

description?: string | null

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

IntegrationEntry { id, created_at, enabled, 4 more }

id: string

formatuuid

created_at: string

formatdate-time

enabled: boolean

name: string

type: "integration"

updated_at: string

formatdate-time

profile_id?: string | null

formatuuid

ExactDataEntry { id, case_sensitive, created_at, 6 more }

id: string

formatuuid

case_sensitive: boolean

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

created_at: string

formatdate-time

enabled: boolean

name: string

secret: boolean

type: "exact_data"

updated_at: string

formatdate-time

description?: string | null

The optional description of the exact data entry.

DocumentFingerprintEntry { id, created_at, enabled, 4 more }

id: string

formatuuid

created_at: string

formatdate-time

enabled: boolean

name: string

type: "document_fingerprint"

updated_at: string

formatdate-time

description?: string | null

The optional description of the document fingerprint entry.

WordListEntry { id, created_at, enabled, 5 more }

id: string

formatuuid

created_at: string

formatdate-time

enabled: boolean

name: string

type: "word_list"

updated_at: string

formatdate-time

word_list: Array<string>

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(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, 7 more } | CustomPromptTopicEntry { id, created_at, enabled, 4 more } | PredefinedEntry { id, confidence, enabled, 5 more } | 4 more>

This field has been deprecated for enabled_entries.

One of the following:

CustomEntry { id, created_at, enabled, 7 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

validator_ids?: Array<string>

Validators this entry references, by id, at most 10. An empty list means the entry references none.

Returned by the entry endpoints. Not returned on entries embedded in other responses, such as profiles.

CustomPromptTopicEntry { id, created_at, enabled, 4 more }

id: string

formatuuid

created_at: string

formatdate-time

Deprecatedenabled: boolean

name: string

type: "custom_prompt_topic"

updated_at: string

formatdate-time

description?: string | null

The optional description of the custom prompt topic entry.

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

name: string

type: "predefined"

deprecated?: boolean

Whether this entry is deprecated for new use. This is computed from the static catalog and emitted only when true.

Deprecatedprofile_id?: string | null

formatuuid

variant?: UnionMember0 { topic_type, type, description } | UnionMember1 { type, description }

A Predefined AI prompt classification topic entry.

One of the following:

UnionMember0 { topic_type, type, description }

A Predefined AI prompt classification topic entry.

topic_type: "Intent" | "Content"

One of the following:

"Intent"

"Content"

type: "PromptTopic"

description?: string | null

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

UnionMember1 { type, description }

A general predefined entry.

type: "General"

description?: string | null

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

IntegrationEntry { id, created_at, enabled, 4 more }

id: string

formatuuid

created_at: string

formatdate-time

enabled: boolean

name: string

type: "integration"

updated_at: string

formatdate-time

profile_id?: string | null

formatuuid

ExactDataEntry { id, case_sensitive, created_at, 6 more }

id: string

formatuuid

case_sensitive: boolean

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

created_at: string

formatdate-time

enabled: boolean

name: string

secret: boolean

type: "exact_data"

updated_at: string

formatdate-time

description?: string | null

The optional description of the exact data entry.

DocumentFingerprintEntry { id, created_at, enabled, 4 more }

id: string

formatuuid

created_at: string

formatdate-time

enabled: boolean

name: string

type: "document_fingerprint"

updated_at: string

formatdate-time

description?: string | null

The optional description of the document fingerprint entry.

WordListEntry { id, created_at, enabled, 5 more }

id: string

formatuuid

created_at: string

formatdate-time

enabled: boolean

name: string

type: "word_list"

updated_at: string

formatdate-time

word_list: Array<string>

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

DLPLimits

Fetch limits associated with DLP for account

client.zeroTrust.dlp.limits.list(LimitListParams { account_id } params, RequestOptionsoptions?): LimitListResponse { max_custom_regex_entries, max_dataset_cells, max_document_fingerprints, 3 more }

GET/accounts/{account_id}/dlp/limits

ModelsExpand Collapse

LimitListResponse { max_custom_regex_entries, max_dataset_cells, max_document_fingerprints, 3 more }

max_custom_regex_entries: number

Maximum number of custom regex entries allowed for the account.

formatint64

minimum0

max_dataset_cells: number

Maximum number of dataset cells allowed for the account, across all EDM and CWL datasets.

formatint64

minimum0

max_document_fingerprints: number

Maximum number of document fingerprints allowed for the account.

formatint64

minimum0

used_custom_regex_entries: number

Number of custom regex entries currently configured for the account.

formatint64

minimum0

used_dataset_cells: number

Number of dataset cells currently configured for the account, across all EDM and CWL datasets. Document fingerprints do not count towards this limit.

formatint64

minimum0

used_document_fingerprints: number

Number of document fingerprints currently configured for the account.

formatint64

minimum0

DLPEntries

List all entries

client.zeroTrust.dlp.entries.list(EntryListParams { account_id } params, RequestOptionsoptions?): SinglePage<EntryListResponse>

GET/accounts/{account_id}/dlp/entries

Get DLP Entry

client.zeroTrust.dlp.entries.get(stringentryID, EntryGetParams { account_id } params, RequestOptionsoptions?): EntryGetResponse

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

Create custom entry

client.zeroTrust.dlp.entries.create(EntryCreateParams { account_id, enabled, name, 4 more } params, RequestOptionsoptions?): EntryCreateResponse { id, created_at, enabled, 6 more }

POST/accounts/{account_id}/dlp/entries

Update entry

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

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

Delete custom entry

client.zeroTrust.dlp.entries.delete(stringentryID, EntryDeleteParams { account_id } params, RequestOptionsoptions?): EntryDeleteResponse | null

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

ModelsExpand Collapse

EntryListResponse = UnionMember0 { id, created_at, enabled, 8 more } | UnionMember1 { id, created_at, enabled, 5 more } | UnionMember2 { id, confidence, enabled, 6 more } | 4 more

One of the following:

UnionMember0 { id, created_at, enabled, 8 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

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

One of the following:

"empty"

"uploading"

"pending"

"processing"

"failed"

"complete"

validator_ids?: Array<string>

Validators this entry references, by id, at most 10. An empty list means the entry references none.

Returned by the entry endpoints. Not returned on entries embedded in other responses, such as profiles.

UnionMember1 { id, created_at, enabled, 5 more }

id: string

formatuuid

created_at: string

formatdate-time

Deprecatedenabled: boolean

name: string

type: "custom_prompt_topic"

updated_at: string

formatdate-time

description?: string | null

The optional description of the custom prompt topic entry.

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

One of the following:

"empty"

"uploading"

"pending"

"processing"

"failed"

"complete"

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

name: string

type: "predefined"

deprecated?: boolean

Whether this entry is deprecated for new use. This is computed from the static catalog and emitted only when true.

Deprecatedprofile_id?: string | null

formatuuid

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

One of the following:

"empty"

"uploading"

"pending"

"processing"

"failed"

"complete"

variant?: UnionMember0 { topic_type, type, description } | UnionMember1 { type, description }

A Predefined AI prompt classification topic entry.

One of the following:

UnionMember0 { topic_type, type, description }

A Predefined AI prompt classification topic entry.

topic_type: "Intent" | "Content"

One of the following:

"Intent"

"Content"

type: "PromptTopic"

description?: string | null

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

UnionMember1 { type, description }

A general predefined entry.

type: "General"

description?: string | null

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

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

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

One of the following:

"empty"

"uploading"

"pending"

"processing"

"failed"

"complete"

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

name: string

secret: boolean

type: "exact_data"

updated_at: string

formatdate-time

description?: string | null

The optional description of the exact data entry.

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

One of the following:

"empty"

"uploading"

"pending"

"processing"

"failed"

"complete"

UnionMember5 { id, created_at, enabled, 5 more }

id: string

formatuuid

created_at: string

formatdate-time

enabled: boolean

name: string

type: "document_fingerprint"

updated_at: string

formatdate-time

description?: string | null

The optional description of the document fingerprint entry.

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

One of the following:

"empty"

"uploading"

"pending"

"processing"

"failed"

"complete"

UnionMember6 { id, created_at, enabled, 6 more }

id: string

formatuuid

created_at: string

formatdate-time

enabled: boolean

name: string

type: "word_list"

updated_at: string

formatdate-time

word_list: Array<string>

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, 9 more } | UnionMember1 { id, created_at, enabled, 6 more } | UnionMember2 { id, confidence, enabled, 7 more } | 4 more

One of the following:

UnionMember0 { id, created_at, enabled, 9 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

profiles?: Array<Profile>

id: string

formatuuid

name: string

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

One of the following:

"empty"

"uploading"

"pending"

"processing"

"failed"

"complete"

validator_ids?: Array<string>

Validators this entry references, by id, at most 10. An empty list means the entry references none.

Returned by the entry endpoints. Not returned on entries embedded in other responses, such as profiles.

UnionMember1 { id, created_at, enabled, 6 more }

id: string

formatuuid

created_at: string

formatdate-time

Deprecatedenabled: boolean

name: string

type: "custom_prompt_topic"

updated_at: string

formatdate-time

description?: string | null

The optional description of the custom prompt topic entry.

profiles?: Array<Profile>

id: string

formatuuid

name: string

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

One of the following:

"empty"

"uploading"

"pending"

"processing"

"failed"

"complete"

UnionMember2 { id, confidence, enabled, 7 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"

deprecated?: boolean

Whether this entry is deprecated for new use. This is computed from the static catalog and emitted only when true.

Deprecatedprofile_id?: string | null

formatuuid

profiles?: Array<Profile>

id: string

formatuuid

name: string

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

One of the following:

"empty"

"uploading"

"pending"

"processing"

"failed"

"complete"

variant?: UnionMember0 { topic_type, type, description } | UnionMember1 { type, description }

A Predefined AI prompt classification topic entry.

One of the following:

UnionMember0 { topic_type, type, description }

A Predefined AI prompt classification topic entry.

topic_type: "Intent" | "Content"

One of the following:

"Intent"

"Content"

type: "PromptTopic"

description?: string | null

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

UnionMember1 { type, description }

A general predefined entry.

type: "General"

description?: string | null

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

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

profiles?: Array<Profile>

id: string

formatuuid

name: string

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

One of the following:

"empty"

"uploading"

"pending"

"processing"

"failed"

"complete"

UnionMember4 { id, case_sensitive, created_at, 8 more }

id: string

formatuuid

case_sensitive: boolean

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

created_at: string

formatdate-time

enabled: boolean

name: string

secret: boolean

type: "exact_data"

updated_at: string

formatdate-time

description?: string | null

The optional description of the exact data entry.

profiles?: Array<Profile>

id: string

formatuuid

name: string

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

name: string

type: "document_fingerprint"

updated_at: string

formatdate-time

description?: string | null

The optional description of the document fingerprint entry.

profiles?: Array<Profile>

id: string

formatuuid

name: string

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

One of the following:

"empty"

"uploading"

"pending"

"processing"

"failed"

"complete"

UnionMember6 { id, created_at, enabled, 7 more }

id: string

formatuuid

created_at: string

formatdate-time

enabled: boolean

name: string

type: "word_list"

updated_at: string

formatdate-time

word_list: Array<string>

profile_id?: string | null

formatuuid

profiles?: Array<Profile>

id: string

formatuuid

name: string

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

One of the following:

"empty"

"uploading"

"pending"

"processing"

"failed"

"complete"

EntryCreateResponse { id, created_at, enabled, 6 more }

id: string

formatuuid

created_at: string

formatdate-time

Deprecatedenabled: boolean

name: string

pattern: Pattern { regex, validation }

updated_at: string

formatdate-time

description?: string | null

Deprecatedprofile_id?: string | null

formatuuid

validator_ids?: Array<string>

Validators this entry references, by id, at most 10. An empty list means the entry references none.

Returned by the entry endpoints. Not returned on entries embedded in other responses, such as profiles.

EntryUpdateResponse = CustomEntry { id, created_at, enabled, 7 more } | CustomPromptTopicEntry { id, created_at, enabled, 4 more } | PredefinedEntry { id, confidence, enabled, 5 more } | 4 more

One of the following:

CustomEntry { id, created_at, enabled, 7 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

validator_ids?: Array<string>

Validators this entry references, by id, at most 10. An empty list means the entry references none.

Returned by the entry endpoints. Not returned on entries embedded in other responses, such as profiles.

CustomPromptTopicEntry { id, created_at, enabled, 4 more }

id: string

formatuuid

created_at: string

formatdate-time

Deprecatedenabled: boolean

name: string

type: "custom_prompt_topic"

updated_at: string

formatdate-time

description?: string | null

The optional description of the custom prompt topic entry.

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

name: string

type: "predefined"

deprecated?: boolean

Whether this entry is deprecated for new use. This is computed from the static catalog and emitted only when true.

Deprecatedprofile_id?: string | null

formatuuid

variant?: UnionMember0 { topic_type, type, description } | UnionMember1 { type, description }

A Predefined AI prompt classification topic entry.

One of the following:

UnionMember0 { topic_type, type, description }

A Predefined AI prompt classification topic entry.

topic_type: "Intent" | "Content"

One of the following:

"Intent"

"Content"

type: "PromptTopic"

description?: string | null

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

UnionMember1 { type, description }

A general predefined entry.

type: "General"

description?: string | null

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

IntegrationEntry { id, created_at, enabled, 4 more }

id: string

formatuuid

created_at: string

formatdate-time

enabled: boolean

name: string

type: "integration"

updated_at: string

formatdate-time

profile_id?: string | null

formatuuid

ExactDataEntry { id, case_sensitive, created_at, 6 more }

id: string

formatuuid

case_sensitive: boolean

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

created_at: string

formatdate-time

enabled: boolean

name: string

secret: boolean

type: "exact_data"

updated_at: string

formatdate-time

description?: string | null

The optional description of the exact data entry.

DocumentFingerprintEntry { id, created_at, enabled, 4 more }

id: string

formatuuid

created_at: string

formatdate-time

enabled: boolean

name: string

type: "document_fingerprint"

updated_at: string

formatdate-time

description?: string | null

The optional description of the document fingerprint entry.

WordListEntry { id, created_at, enabled, 5 more }

id: string

formatuuid

created_at: string

formatdate-time

enabled: boolean

name: string

type: "word_list"

updated_at: string

formatdate-time

word_list: Array<string>

profile_id?: string | null

formatuuid

EntryDeleteResponse = unknown

DLPEntriesCustom

Create custom entry

client.zeroTrust.dlp.entries.custom.create(CustomCreateParams { account_id, enabled, name, 4 more } params, RequestOptionsoptions?): CustomCreateResponse { id, created_at, enabled, 6 more }

POST/accounts/{account_id}/dlp/entries

Update custom entry

client.zeroTrust.dlp.entries.custom.update(stringentryID, CustomUpdateParams { account_id, enabled, name, 3 more } params, RequestOptionsoptions?): CustomUpdateResponse { id, created_at, enabled, 6 more }

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

Delete custom entry

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

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

Get DLP Entry

client.zeroTrust.dlp.entries.custom.get(stringentryID, CustomGetParams { account_id } params, RequestOptionsoptions?): CustomGetResponse

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

List all entries

client.zeroTrust.dlp.entries.custom.list(CustomListParams { account_id } params, RequestOptionsoptions?): SinglePage<CustomListResponse>

GET/accounts/{account_id}/dlp/entries

ModelsExpand Collapse

CustomCreateResponse { id, created_at, enabled, 6 more }

id: string

formatuuid

created_at: string

formatdate-time

Deprecatedenabled: boolean

name: string

pattern: Pattern { regex, validation }

updated_at: string

formatdate-time

description?: string | null

Deprecatedprofile_id?: string | null

formatuuid

validator_ids?: Array<string>

Validators this entry references, by id, at most 10. An empty list means the entry references none.

Returned by the entry endpoints. Not returned on entries embedded in other responses, such as profiles.

CustomUpdateResponse { id, created_at, enabled, 6 more }

id: string

formatuuid

created_at: string

formatdate-time

Deprecatedenabled: boolean

name: string

pattern: Pattern { regex, validation }

updated_at: string

formatdate-time

description?: string | null

Deprecatedprofile_id?: string | null

formatuuid

validator_ids?: Array<string>

Validators this entry references, by id, at most 10. An empty list means the entry references none.

Returned by the entry endpoints. Not returned on entries embedded in other responses, such as profiles.

CustomDeleteResponse = unknown

CustomGetResponse = UnionMember0 { id, created_at, enabled, 9 more } | UnionMember1 { id, created_at, enabled, 6 more } | UnionMember2 { id, confidence, enabled, 7 more } | 4 more

One of the following:

UnionMember0 { id, created_at, enabled, 9 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

profiles?: Array<Profile>

id: string

formatuuid

name: string

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

One of the following:

"empty"

"uploading"

"pending"

"processing"

"failed"

"complete"

validator_ids?: Array<string>

Validators this entry references, by id, at most 10. An empty list means the entry references none.

Returned by the entry endpoints. Not returned on entries embedded in other responses, such as profiles.

UnionMember1 { id, created_at, enabled, 6 more }

id: string

formatuuid

created_at: string

formatdate-time

Deprecatedenabled: boolean

name: string

type: "custom_prompt_topic"

updated_at: string

formatdate-time

description?: string | null

The optional description of the custom prompt topic entry.

profiles?: Array<Profile>

id: string

formatuuid

name: string

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

One of the following:

"empty"

"uploading"

"pending"

"processing"

"failed"

"complete"

UnionMember2 { id, confidence, enabled, 7 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"

deprecated?: boolean

Whether this entry is deprecated for new use. This is computed from the static catalog and emitted only when true.

Deprecatedprofile_id?: string | null

formatuuid

profiles?: Array<Profile>

id: string

formatuuid

name: string

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

One of the following:

"empty"

"uploading"

"pending"

"processing"

"failed"

"complete"

variant?: UnionMember0 { topic_type, type, description } | UnionMember1 { type, description }

A Predefined AI prompt classification topic entry.

One of the following:

UnionMember0 { topic_type, type, description }

A Predefined AI prompt classification topic entry.

topic_type: "Intent" | "Content"

One of the following:

"Intent"

"Content"

type: "PromptTopic"

description?: string | null

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

UnionMember1 { type, description }

A general predefined entry.

type: "General"

description?: string | null

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

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

profiles?: Array<Profile>

id: string

formatuuid

name: string

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

One of the following:

"empty"

"uploading"

"pending"

"processing"

"failed"

"complete"

UnionMember4 { id, case_sensitive, created_at, 8 more }

id: string

formatuuid

case_sensitive: boolean

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

created_at: string

formatdate-time

enabled: boolean

name: string

secret: boolean

type: "exact_data"

updated_at: string

formatdate-time

description?: string | null

The optional description of the exact data entry.

profiles?: Array<Profile>

id: string

formatuuid

name: string

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

name: string

type: "document_fingerprint"

updated_at: string

formatdate-time

description?: string | null

The optional description of the document fingerprint entry.

profiles?: Array<Profile>

id: string

formatuuid

name: string

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

One of the following:

"empty"

"uploading"

"pending"

"processing"

"failed"

"complete"

UnionMember6 { id, created_at, enabled, 7 more }

id: string

formatuuid

created_at: string

formatdate-time

enabled: boolean

name: string

type: "word_list"

updated_at: string

formatdate-time

word_list: Array<string>

profile_id?: string | null

formatuuid

profiles?: Array<Profile>

id: string

formatuuid

name: string

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

One of the following:

"empty"

"uploading"

"pending"

"processing"

"failed"

"complete"

CustomListResponse = UnionMember0 { id, created_at, enabled, 8 more } | UnionMember1 { id, created_at, enabled, 5 more } | UnionMember2 { id, confidence, enabled, 6 more } | 4 more

One of the following:

UnionMember0 { id, created_at, enabled, 8 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

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

One of the following:

"empty"

"uploading"

"pending"

"processing"

"failed"

"complete"

validator_ids?: Array<string>

Validators this entry references, by id, at most 10. An empty list means the entry references none.

Returned by the entry endpoints. Not returned on entries embedded in other responses, such as profiles.

UnionMember1 { id, created_at, enabled, 5 more }

id: string

formatuuid

created_at: string

formatdate-time

Deprecatedenabled: boolean

name: string

type: "custom_prompt_topic"

updated_at: string

formatdate-time

description?: string | null

The optional description of the custom prompt topic entry.

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

One of the following:

"empty"

"uploading"

"pending"

"processing"

"failed"

"complete"

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

name: string

type: "predefined"

deprecated?: boolean

Whether this entry is deprecated for new use. This is computed from the static catalog and emitted only when true.

Deprecatedprofile_id?: string | null

formatuuid

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

One of the following:

"empty"

"uploading"

"pending"

"processing"

"failed"

"complete"

variant?: UnionMember0 { topic_type, type, description } | UnionMember1 { type, description }

A Predefined AI prompt classification topic entry.

One of the following:

UnionMember0 { topic_type, type, description }

A Predefined AI prompt classification topic entry.

topic_type: "Intent" | "Content"

One of the following:

"Intent"

"Content"

type: "PromptTopic"

description?: string | null

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

UnionMember1 { type, description }

A general predefined entry.

type: "General"

description?: string | null

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

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

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

One of the following:

"empty"

"uploading"

"pending"

"processing"

"failed"

"complete"

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

name: string

secret: boolean

type: "exact_data"

updated_at: string

formatdate-time

description?: string | null

The optional description of the exact data entry.

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

One of the following:

"empty"

"uploading"

"pending"

"processing"

"failed"

"complete"

UnionMember5 { id, created_at, enabled, 5 more }

id: string

formatuuid

created_at: string

formatdate-time

enabled: boolean

name: string

type: "document_fingerprint"

updated_at: string

formatdate-time

description?: string | null

The optional description of the document fingerprint entry.

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

One of the following:

"empty"

"uploading"

"pending"

"processing"

"failed"

"complete"

UnionMember6 { id, created_at, enabled, 6 more }

id: string

formatuuid

created_at: string

formatdate-time

enabled: boolean

name: string

type: "word_list"

updated_at: string

formatdate-time

word_list: Array<string>

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(PredefinedCreateParams { account_id, enabled, entry_id, profile_id } params, RequestOptionsoptions?): PredefinedCreateResponse { id, confidence, enabled, 4 more }

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

Update predefined entry

client.zeroTrust.dlp.entries.predefined.update(stringentryID, PredefinedUpdateParams { account_id, enabled } params, RequestOptionsoptions?): PredefinedUpdateResponse { id, confidence, enabled, 4 more }

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

Delete predefined entry

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

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

Get DLP Entry

client.zeroTrust.dlp.entries.predefined.get(stringentryID, PredefinedGetParams { account_id } params, RequestOptionsoptions?): PredefinedGetResponse

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

List all entries

client.zeroTrust.dlp.entries.predefined.list(PredefinedListParams { account_id } params, RequestOptionsoptions?): SinglePage<PredefinedListResponse>

GET/accounts/{account_id}/dlp/entries

ModelsExpand Collapse

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

deprecated?: boolean

Whether this entry is deprecated for new use. This is computed from the static catalog and emitted only when true.

Deprecatedprofile_id?: string | null

formatuuid

variant?: UnionMember0 { topic_type, type, description } | UnionMember1 { type, description }

A Predefined AI prompt classification topic entry.

One of the following:

UnionMember0 { topic_type, type, description }

A Predefined AI prompt classification topic entry.

topic_type: "Intent" | "Content"

One of the following:

"Intent"

"Content"

type: "PromptTopic"

description?: string | null

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

UnionMember1 { type, description }

A general predefined entry.

type: "General"

description?: string | null

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

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

deprecated?: boolean

Whether this entry is deprecated for new use. This is computed from the static catalog and emitted only when true.

Deprecatedprofile_id?: string | null

formatuuid

variant?: UnionMember0 { topic_type, type, description } | UnionMember1 { type, description }

A Predefined AI prompt classification topic entry.

One of the following:

UnionMember0 { topic_type, type, description }

A Predefined AI prompt classification topic entry.

topic_type: "Intent" | "Content"

One of the following:

"Intent"

"Content"

type: "PromptTopic"

description?: string | null

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

UnionMember1 { type, description }

A general predefined entry.

type: "General"

description?: string | null

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

PredefinedDeleteResponse = unknown

PredefinedGetResponse = UnionMember0 { id, created_at, enabled, 9 more } | UnionMember1 { id, created_at, enabled, 6 more } | UnionMember2 { id, confidence, enabled, 7 more } | 4 more

One of the following:

UnionMember0 { id, created_at, enabled, 9 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

profiles?: Array<Profile>

id: string

formatuuid

name: string

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

One of the following:

"empty"

"uploading"

"pending"

"processing"

"failed"

"complete"

validator_ids?: Array<string>

Validators this entry references, by id, at most 10. An empty list means the entry references none.

Returned by the entry endpoints. Not returned on entries embedded in other responses, such as profiles.

UnionMember1 { id, created_at, enabled, 6 more }

id: string

formatuuid

created_at: string

formatdate-time

Deprecatedenabled: boolean

name: string

type: "custom_prompt_topic"

updated_at: string

formatdate-time

description?: string | null

The optional description of the custom prompt topic entry.

profiles?: Array<Profile>

id: string

formatuuid

name: string

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

One of the following:

"empty"

"uploading"

"pending"

"processing"

"failed"

"complete"

UnionMember2 { id, confidence, enabled, 7 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"

deprecated?: boolean

Whether this entry is deprecated for new use. This is computed from the static catalog and emitted only when true.

Deprecatedprofile_id?: string | null

formatuuid

profiles?: Array<Profile>

id: string

formatuuid

name: string

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

One of the following:

"empty"

"uploading"

"pending"

"processing"

"failed"

"complete"

variant?: UnionMember0 { topic_type, type, description } | UnionMember1 { type, description }

A Predefined AI prompt classification topic entry.

One of the following:

UnionMember0 { topic_type, type, description }

A Predefined AI prompt classification topic entry.

topic_type: "Intent" | "Content"

One of the following:

"Intent"

"Content"

type: "PromptTopic"

description?: string | null

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

UnionMember1 { type, description }

A general predefined entry.

type: "General"

description?: string | null

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

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

profiles?: Array<Profile>

id: string

formatuuid

name: string

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

One of the following:

"empty"

"uploading"

"pending"

"processing"

"failed"

"complete"

UnionMember4 { id, case_sensitive, created_at, 8 more }

id: string

formatuuid

case_sensitive: boolean

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

created_at: string

formatdate-time

enabled: boolean

name: string

secret: boolean

type: "exact_data"

updated_at: string

formatdate-time

description?: string | null

The optional description of the exact data entry.

profiles?: Array<Profile>

id: string

formatuuid

name: string

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

name: string

type: "document_fingerprint"

updated_at: string

formatdate-time

description?: string | null

The optional description of the document fingerprint entry.

profiles?: Array<Profile>

id: string

formatuuid

name: string

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

One of the following:

"empty"

"uploading"

"pending"

"processing"

"failed"

"complete"

UnionMember6 { id, created_at, enabled, 7 more }

id: string

formatuuid

created_at: string

formatdate-time

enabled: boolean

name: string

type: "word_list"

updated_at: string

formatdate-time

word_list: Array<string>

profile_id?: string | null

formatuuid

profiles?: Array<Profile>

id: string

formatuuid

name: string

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

One of the following:

"empty"

"uploading"

"pending"

"processing"

"failed"

"complete"

PredefinedListResponse = UnionMember0 { id, created_at, enabled, 8 more } | UnionMember1 { id, created_at, enabled, 5 more } | UnionMember2 { id, confidence, enabled, 6 more } | 4 more

One of the following:

UnionMember0 { id, created_at, enabled, 8 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

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

One of the following:

"empty"

"uploading"

"pending"

"processing"

"failed"

"complete"

validator_ids?: Array<string>

Validators this entry references, by id, at most 10. An empty list means the entry references none.

Returned by the entry endpoints. Not returned on entries embedded in other responses, such as profiles.

UnionMember1 { id, created_at, enabled, 5 more }

id: string

formatuuid

created_at: string

formatdate-time

Deprecatedenabled: boolean

name: string

type: "custom_prompt_topic"

updated_at: string

formatdate-time

description?: string | null

The optional description of the custom prompt topic entry.

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

One of the following:

"empty"

"uploading"

"pending"

"processing"

"failed"

"complete"

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

name: string

type: "predefined"

deprecated?: boolean

Whether this entry is deprecated for new use. This is computed from the static catalog and emitted only when true.

Deprecatedprofile_id?: string | null

formatuuid

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

One of the following:

"empty"

"uploading"

"pending"

"processing"

"failed"

"complete"

variant?: UnionMember0 { topic_type, type, description } | UnionMember1 { type, description }

A Predefined AI prompt classification topic entry.

One of the following:

UnionMember0 { topic_type, type, description }

A Predefined AI prompt classification topic entry.

topic_type: "Intent" | "Content"

One of the following:

"Intent"

"Content"

type: "PromptTopic"

description?: string | null

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

UnionMember1 { type, description }

A general predefined entry.

type: "General"

description?: string | null

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

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

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

One of the following:

"empty"

"uploading"

"pending"

"processing"

"failed"

"complete"

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

name: string

secret: boolean

type: "exact_data"

updated_at: string

formatdate-time

description?: string | null

The optional description of the exact data entry.

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

One of the following:

"empty"

"uploading"

"pending"

"processing"

"failed"

"complete"

UnionMember5 { id, created_at, enabled, 5 more }

id: string

formatuuid

created_at: string

formatdate-time

enabled: boolean

name: string

type: "document_fingerprint"

updated_at: string

formatdate-time

description?: string | null

The optional description of the document fingerprint entry.

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

One of the following:

"empty"

"uploading"

"pending"

"processing"

"failed"

"complete"

UnionMember6 { id, created_at, enabled, 6 more }

id: string

formatuuid

created_at: string

formatdate-time

enabled: boolean

name: string

type: "word_list"

updated_at: string

formatdate-time

word_list: Array<string>

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(IntegrationCreateParams { account_id, enabled, entry_id, profile_id } params, RequestOptionsoptions?): IntegrationCreateResponse { id, created_at, enabled, 3 more }

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

Update integration entry

client.zeroTrust.dlp.entries.integration.update(stringentryID, IntegrationUpdateParams { account_id, enabled } params, RequestOptionsoptions?): 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(stringentryID, IntegrationDeleteParams { account_id } params, RequestOptionsoptions?): IntegrationDeleteResponse | null

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

Get DLP Entry

client.zeroTrust.dlp.entries.integration.get(stringentryID, IntegrationGetParams { account_id } params, RequestOptionsoptions?): IntegrationGetResponse

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

List all entries

client.zeroTrust.dlp.entries.integration.list(IntegrationListParams { account_id } params, RequestOptionsoptions?): 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

name: string

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

name: string

updated_at: string

formatdate-time

profile_id?: string | null

formatuuid

IntegrationDeleteResponse = unknown

IntegrationGetResponse = UnionMember0 { id, created_at, enabled, 9 more } | UnionMember1 { id, created_at, enabled, 6 more } | UnionMember2 { id, confidence, enabled, 7 more } | 4 more

One of the following:

UnionMember0 { id, created_at, enabled, 9 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

profiles?: Array<Profile>

id: string

formatuuid

name: string

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

One of the following:

"empty"

"uploading"

"pending"

"processing"

"failed"

"complete"

validator_ids?: Array<string>

Validators this entry references, by id, at most 10. An empty list means the entry references none.

Returned by the entry endpoints. Not returned on entries embedded in other responses, such as profiles.

UnionMember1 { id, created_at, enabled, 6 more }

id: string

formatuuid

created_at: string

formatdate-time

Deprecatedenabled: boolean

name: string

type: "custom_prompt_topic"

updated_at: string

formatdate-time

description?: string | null

The optional description of the custom prompt topic entry.

profiles?: Array<Profile>

id: string

formatuuid

name: string

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

One of the following:

"empty"

"uploading"

"pending"

"processing"

"failed"

"complete"

UnionMember2 { id, confidence, enabled, 7 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"

deprecated?: boolean

Whether this entry is deprecated for new use. This is computed from the static catalog and emitted only when true.

Deprecatedprofile_id?: string | null

formatuuid

profiles?: Array<Profile>

id: string

formatuuid

name: string

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

One of the following:

"empty"

"uploading"

"pending"

"processing"

"failed"

"complete"

variant?: UnionMember0 { topic_type, type, description } | UnionMember1 { type, description }

A Predefined AI prompt classification topic entry.

One of the following:

UnionMember0 { topic_type, type, description }

A Predefined AI prompt classification topic entry.

topic_type: "Intent" | "Content"

One of the following:

"Intent"

"Content"

type: "PromptTopic"

description?: string | null

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

UnionMember1 { type, description }

A general predefined entry.

type: "General"

description?: string | null

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

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

profiles?: Array<Profile>

id: string

formatuuid

name: string

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

One of the following:

"empty"

"uploading"

"pending"

"processing"

"failed"

"complete"

UnionMember4 { id, case_sensitive, created_at, 8 more }

id: string

formatuuid

case_sensitive: boolean

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

created_at: string

formatdate-time

enabled: boolean

name: string

secret: boolean

type: "exact_data"

updated_at: string

formatdate-time

description?: string | null

The optional description of the exact data entry.

profiles?: Array<Profile>

id: string

formatuuid

name: string

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

name: string

type: "document_fingerprint"

updated_at: string

formatdate-time

description?: string | null

The optional description of the document fingerprint entry.

profiles?: Array<Profile>

id: string

formatuuid

name: string

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

One of the following:

"empty"

"uploading"

"pending"

"processing"

"failed"

"complete"

UnionMember6 { id, created_at, enabled, 7 more }

id: string

formatuuid

created_at: string

formatdate-time

enabled: boolean

name: string

type: "word_list"

updated_at: string

formatdate-time

word_list: Array<string>

profile_id?: string | null

formatuuid

profiles?: Array<Profile>

id: string

formatuuid

name: string

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

One of the following:

"empty"

"uploading"

"pending"

"processing"

"failed"

"complete"

IntegrationListResponse = UnionMember0 { id, created_at, enabled, 8 more } | UnionMember1 { id, created_at, enabled, 5 more } | UnionMember2 { id, confidence, enabled, 6 more } | 4 more

One of the following:

UnionMember0 { id, created_at, enabled, 8 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

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

One of the following:

"empty"

"uploading"

"pending"

"processing"

"failed"

"complete"

validator_ids?: Array<string>

Validators this entry references, by id, at most 10. An empty list means the entry references none.

Returned by the entry endpoints. Not returned on entries embedded in other responses, such as profiles.

UnionMember1 { id, created_at, enabled, 5 more }

id: string

formatuuid

created_at: string

formatdate-time

Deprecatedenabled: boolean

name: string

type: "custom_prompt_topic"

updated_at: string

formatdate-time

description?: string | null

The optional description of the custom prompt topic entry.

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

One of the following:

"empty"

"uploading"

"pending"

"processing"

"failed"

"complete"

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

name: string

type: "predefined"

deprecated?: boolean

Whether this entry is deprecated for new use. This is computed from the static catalog and emitted only when true.

Deprecatedprofile_id?: string | null

formatuuid

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

One of the following:

"empty"

"uploading"

"pending"

"processing"

"failed"

"complete"

variant?: UnionMember0 { topic_type, type, description } | UnionMember1 { type, description }

A Predefined AI prompt classification topic entry.

One of the following:

UnionMember0 { topic_type, type, description }

A Predefined AI prompt classification topic entry.

topic_type: "Intent" | "Content"

One of the following:

"Intent"

"Content"

type: "PromptTopic"

description?: string | null

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

UnionMember1 { type, description }

A general predefined entry.

type: "General"

description?: string | null

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

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

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

One of the following:

"empty"

"uploading"

"pending"

"processing"

"failed"

"complete"

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

name: string

secret: boolean

type: "exact_data"

updated_at: string

formatdate-time

description?: string | null

The optional description of the exact data entry.

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

One of the following:

"empty"

"uploading"

"pending"

"processing"

"failed"

"complete"

UnionMember5 { id, created_at, enabled, 5 more }

id: string

formatuuid

created_at: string

formatdate-time

enabled: boolean

name: string

type: "document_fingerprint"

updated_at: string

formatdate-time

description?: string | null

The optional description of the document fingerprint entry.

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

One of the following:

"empty"

"uploading"

"pending"

"processing"

"failed"

"complete"

UnionMember6 { id, created_at, enabled, 6 more }

id: string

formatuuid

created_at: string

formatdate-time

enabled: boolean

name: string

type: "word_list"

updated_at: string

formatdate-time

word_list: Array<string>

profile_id?: string | null

formatuuid

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

One of the following:

"empty"

"uploading"

"pending"

"processing"

"failed"

"complete"

DLPValidators

List validators

client.zeroTrust.dlp.validators.list(ValidatorListParams { account_id, kind } params, RequestOptionsoptions?): SinglePage<Validator>

GET/accounts/{account_id}/dlp/validators

Get a validator

client.zeroTrust.dlp.validators.get(stringvalidatorID, ValidatorGetParams { account_id } params, RequestOptionsoptions?): Validator

GET/accounts/{account_id}/dlp/validators/{validator_id}

ModelsExpand Collapse

References { entries, entry_count }

What currently uses a validator. Deleting a validator that is still in use returns 409, so check this first.

Read-only. A validator is attached or detached by updating the detection entry that uses it, not by writing this back.

entries: Array<Entry>

The detection entries using this validator, ordered by name.

id: string

formatuuid

name: string

type: "custom" | "custom_prompt_topic" | "predefined" | 4 more

The type of a detection entry.

One of the following:

"custom"

"custom_prompt_topic"

"predefined"

"integration"

"exact_data"

"document_fingerprint"

"word_list"

entry_count: number

Number of detection entries this validator is attached to.

formatint32

minimum0

Validator = ProximityWordValidator { id, created_at, kind, 4 more } | WorkerValidator { id, created_at, kind, 5 more }

Reusable logic that a detection entry can attach to in order to refine its matches. The kind field determines the rest of the body.

One of the following:

ProximityWordValidator { id, created_at, kind, 4 more }

A reusable list of weighted words. Attaching it to a detection entry raises the confidence of that entry’s matches when one of the words appears nearby, and lowers it when none do.

id: string

formatuuid

created_at: string

formatdate-time

kind: "proximity_words"

name: string

A name for this validator, at most 50 characters.

referenced_by: References { entries, entry_count }

What currently uses a validator. Deleting a validator that is still in use returns 409, so check this first.

Read-only. A validator is attached or detached by updating the detection entry that uses it, not by writing this back.

updated_at: string

formatdate-time

words: Array<Word { weight, word } >

The words that raise confidence when found near a match.

weight: Weight

How much a word contributes to a match’s confidence when it is found nearby.

Separate from a profile’s high/medium/low confidence threshold: this describes how telling the word is, not how confident the resulting match is.

word: string

The word or phrase to look for. Must contain 1–128 characters and is matched case-insensitively.

WorkerValidator { id, created_at, kind, 5 more }

A customer Worker registered as a validator.

id: string

formatuuid

created_at: string

formatdate-time

kind: "worker"

name: string

A name for this validator, at most 50 characters.

referenced_by: References { entries, entry_count }

What currently uses a validator. Deleting a validator that is still in use returns 409, so check this first.

Read-only. A validator is attached or detached by updating the detection entry that uses it, not by writing this back.

script_tag: string

The public script tag of the customer’s Worker that scores matches.

updated_at: string

formatdate-time

default?: number | "veto"

One of the following:

number

"veto"

"veto"

ValidatorArray = Array<Validator>

One of the following:

ProximityWordValidator { id, created_at, kind, 4 more }

A reusable list of weighted words. Attaching it to a detection entry raises the confidence of that entry’s matches when one of the words appears nearby, and lowers it when none do.

id: string

formatuuid

created_at: string

formatdate-time

kind: "proximity_words"

name: string

A name for this validator, at most 50 characters.

referenced_by: References { entries, entry_count }

What currently uses a validator. Deleting a validator that is still in use returns 409, so check this first.

Read-only. A validator is attached or detached by updating the detection entry that uses it, not by writing this back.

updated_at: string

formatdate-time

words: Array<Word { weight, word } >

The words that raise confidence when found near a match.

weight: Weight

How much a word contributes to a match’s confidence when it is found nearby.

Separate from a profile’s high/medium/low confidence threshold: this describes how telling the word is, not how confident the resulting match is.

word: string

The word or phrase to look for. Must contain 1–128 characters and is matched case-insensitively.

WorkerValidator { id, created_at, kind, 5 more }

A customer Worker registered as a validator.

id: string

formatuuid

created_at: string

formatdate-time

kind: "worker"

name: string

A name for this validator, at most 50 characters.

referenced_by: References { entries, entry_count }

What currently uses a validator. Deleting a validator that is still in use returns 409, so check this first.

Read-only. A validator is attached or detached by updating the detection entry that uses it, not by writing this back.

script_tag: string

The public script tag of the customer’s Worker that scores matches.

updated_at: string

formatdate-time

default?: number | "veto"

One of the following:

number

"veto"

"veto"

WorkerValidator { id, created_at, name, 4 more }

A customer Worker registered as a validator.

id: string

formatuuid

created_at: string

formatdate-time

name: string

A name for this validator, at most 50 characters.

referenced_by: References { entries, entry_count }

What currently uses a validator. Deleting a validator that is still in use returns 409, so check this first.

Read-only. A validator is attached or detached by updating the detection entry that uses it, not by writing this back.

script_tag: string

The public script tag of the customer’s Worker that scores matches.

updated_at: string

formatdate-time

default?: number | "veto"

One of the following:

number

"veto"

"veto"

DLPValidatorsProximity Words

List proximity word validators

client.zeroTrust.dlp.validators.proximityWords.list(ProximityWordListParams { account_id } params, RequestOptionsoptions?): SinglePage<ProximityWordValidator { id, created_at, name, 3 more } >

GET/accounts/{account_id}/dlp/validators/proximity_words

Get a proximity word validator

client.zeroTrust.dlp.validators.proximityWords.get(stringvalidatorID, ProximityWordGetParams { account_id } params, RequestOptionsoptions?): ProximityWordValidator { id, created_at, name, 3 more }

GET/accounts/{account_id}/dlp/validators/proximity_words/{validator_id}

Create a proximity word validator

client.zeroTrust.dlp.validators.proximityWords.create(ProximityWordCreateParams { account_id, name, words } params, RequestOptionsoptions?): ProximityWordValidator { id, created_at, name, 3 more }

POST/accounts/{account_id}/dlp/validators/proximity_words

Update a proximity word validator

client.zeroTrust.dlp.validators.proximityWords.update(stringvalidatorID, ProximityWordUpdateParams { account_id, name, words } params, RequestOptionsoptions?): ProximityWordValidator { id, created_at, name, 3 more }

PUT/accounts/{account_id}/dlp/validators/proximity_words/{validator_id}

Delete a proximity word validator

client.zeroTrust.dlp.validators.proximityWords.delete(stringvalidatorID, ProximityWordDeleteParams { account_id } params, RequestOptionsoptions?): ProximityWordDeleteResponse | null

DELETE/accounts/{account_id}/dlp/validators/proximity_words/{validator_id}

ModelsExpand Collapse

ProximityWordValidator { id, created_at, name, 3 more }

A reusable list of weighted words. Attaching it to a detection entry raises the confidence of that entry’s matches when one of the words appears nearby, and lowers it when none do.

id: string

formatuuid

created_at: string

formatdate-time

name: string

A name for this validator, at most 50 characters.

referenced_by: References { entries, entry_count }

What currently uses a validator. Deleting a validator that is still in use returns 409, so check this first.

Read-only. A validator is attached or detached by updating the detection entry that uses it, not by writing this back.

updated_at: string

formatdate-time

words: Array<Word { weight, word } >

The words that raise confidence when found near a match.

weight: Weight

How much a word contributes to a match’s confidence when it is found nearby.

Separate from a profile’s high/medium/low confidence threshold: this describes how telling the word is, not how confident the resulting match is.

word: string

The word or phrase to look for. Must contain 1–128 characters and is matched case-insensitively.

ProximityWordValidatorArray = Array<ProximityWordValidator { id, created_at, name, 3 more } >

id: string

formatuuid

created_at: string

formatdate-time

name: string

A name for this validator, at most 50 characters.

referenced_by: References { entries, entry_count }

What currently uses a validator. Deleting a validator that is still in use returns 409, so check this first.

Read-only. A validator is attached or detached by updating the detection entry that uses it, not by writing this back.

updated_at: string

formatdate-time

words: Array<Word { weight, word } >

The words that raise confidence when found near a match.

weight: Weight

How much a word contributes to a match’s confidence when it is found nearby.

Separate from a profile’s high/medium/low confidence threshold: this describes how telling the word is, not how confident the resulting match is.

word: string

The word or phrase to look for. Must contain 1–128 characters and is matched case-insensitively.

Weight = "strong" | "moderate" | "weak"

How much a word contributes to a match’s confidence when it is found nearby.

Separate from a profile’s high/medium/low confidence threshold: this describes how telling the word is, not how confident the resulting match is.

One of the following:

"strong"

"moderate"

"weak"

Word { weight, word }

A word that raises a match’s confidence when it appears near the match.

weight: Weight

How much a word contributes to a match’s confidence when it is found nearby.

Separate from a profile’s high/medium/low confidence threshold: this describes how telling the word is, not how confident the resulting match is.

word: string

The word or phrase to look for. Must contain 1–128 characters and is matched case-insensitively.

ProximityWordDeleteResponse = unknown

DLPSensitivity Groups

Retrieve all sensitivity groups in an account

client.zeroTrust.dlp.sensitivityGroups.list(SensitivityGroupListParams { account_id } params, RequestOptionsoptions?): SinglePage<SensitivityGroupListResponse { id, created_at, levels, 4 more } >

GET/accounts/{account_id}/dlp/sensitivity_groups

Retrieve a specific sensitivity group.

client.zeroTrust.dlp.sensitivityGroups.get(stringsensitivityGroupID, SensitivityGroupGetParams { account_id } params, RequestOptionsoptions?): SensitivityGroupGetResponse { id, created_at, levels, 4 more }

GET/accounts/{account_id}/dlp/sensitivity_groups/{sensitivity_group_id}

Creates a new sensitivity group.

client.zeroTrust.dlp.sensitivityGroups.create(SensitivityGroupCreateParams { account_id, name, description, 2 more } params, RequestOptionsoptions?): SensitivityGroupCreateResponse { id, created_at, levels, 4 more }

POST/accounts/{account_id}/dlp/sensitivity_groups

Update the attributes of a single sensitivity group.

client.zeroTrust.dlp.sensitivityGroups.update(stringsensitivityGroupID, SensitivityGroupUpdateParams { account_id, description, levels, name } params, RequestOptionsoptions?): SensitivityGroupUpdateResponse { id, created_at, levels, 4 more }

PUT/accounts/{account_id}/dlp/sensitivity_groups/{sensitivity_group_id}

Delete a single sensitivity group.

client.zeroTrust.dlp.sensitivityGroups.delete(stringsensitivityGroupID, SensitivityGroupDeleteParams { account_id } params, RequestOptionsoptions?): SensitivityGroupDeleteResponse | null

DELETE/accounts/{account_id}/dlp/sensitivity_groups/{sensitivity_group_id}

ModelsExpand Collapse

SensitivityGroupListResponse { id, created_at, levels, 4 more }

id: string

formatuuid

created_at: string

formatdate-time

levels: Array<Level>

id: string

formatuuid

created_at: string

formatdate-time

name: string

updated_at: string

formatdate-time

description?: string | null

name: string

updated_at: string

formatdate-time

description?: string | null

template_id?: string | null

formatuuid

SensitivityGroupGetResponse { id, created_at, levels, 4 more }

id: string

formatuuid

created_at: string

formatdate-time

levels: Array<Level>

id: string

formatuuid

created_at: string

formatdate-time

name: string

updated_at: string

formatdate-time

description?: string | null

name: string

updated_at: string

formatdate-time

description?: string | null

template_id?: string | null

formatuuid

SensitivityGroupCreateResponse { id, created_at, levels, 4 more }

id: string

formatuuid

created_at: string

formatdate-time

levels: Array<Level>

id: string

formatuuid

created_at: string

formatdate-time

name: string

updated_at: string

formatdate-time

description?: string | null

name: string

updated_at: string

formatdate-time

description?: string | null

template_id?: string | null

formatuuid

SensitivityGroupUpdateResponse { id, created_at, levels, 4 more }

id: string

formatuuid

created_at: string

formatdate-time

levels: Array<Level>

id: string

formatuuid

created_at: string

formatdate-time

name: string

updated_at: string

formatdate-time

description?: string | null

name: string

updated_at: string

formatdate-time

description?: string | null

template_id?: string | null

formatuuid

SensitivityGroupDeleteResponse = unknown

DLPSensitivity GroupsLevels

Retrieve all sensitivity levels in a sensitivity group

client.zeroTrust.dlp.sensitivityGroups.levels.list(stringsensitivityGroupID, LevelListParams { account_id } params, RequestOptionsoptions?): SinglePage<LevelListResponse { id, created_at, name, 2 more } >

GET/accounts/{account_id}/dlp/sensitivity_groups/{sensitivity_group_id}/levels

Retrieve a specific sensitivity level.

client.zeroTrust.dlp.sensitivityGroups.levels.get(stringsensitivityLevelID, LevelGetParams { account_id, sensitivity_group_id } params, RequestOptionsoptions?): LevelGetResponse { id, created_at, name, 2 more }

GET/accounts/{account_id}/dlp/sensitivity_groups/{sensitivity_group_id}/levels/{sensitivity_level_id}

Creates a new sensitivity level.

client.zeroTrust.dlp.sensitivityGroups.levels.create(stringsensitivityGroupID, LevelCreateParams { account_id, name, description } params, RequestOptionsoptions?): LevelCreateResponse { id, created_at, name, 2 more }

POST/accounts/{account_id}/dlp/sensitivity_groups/{sensitivity_group_id}/levels

Update the attributes of a single sensitivity level.

client.zeroTrust.dlp.sensitivityGroups.levels.update(stringsensitivityLevelID, LevelUpdateParams { account_id, sensitivity_group_id, description, name } params, RequestOptionsoptions?): LevelUpdateResponse { id, created_at, name, 2 more }

PUT/accounts/{account_id}/dlp/sensitivity_groups/{sensitivity_group_id}/levels/{sensitivity_level_id}

Delete a single sensitivity level.

client.zeroTrust.dlp.sensitivityGroups.levels.delete(stringsensitivityLevelID, LevelDeleteParams { account_id, sensitivity_group_id } params, RequestOptionsoptions?): LevelDeleteResponse | null

DELETE/accounts/{account_id}/dlp/sensitivity_groups/{sensitivity_group_id}/levels/{sensitivity_level_id}

ModelsExpand Collapse

LevelListResponse { id, created_at, name, 2 more }

id: string

formatuuid

created_at: string

formatdate-time

name: string

updated_at: string

formatdate-time

description?: string | null

LevelGetResponse { id, created_at, name, 2 more }

id: string

formatuuid

created_at: string

formatdate-time

name: string

updated_at: string

formatdate-time

description?: string | null

LevelCreateResponse { id, created_at, name, 2 more }

id: string

formatuuid

created_at: string

formatdate-time

name: string

updated_at: string

formatdate-time

description?: string | null

LevelUpdateResponse { id, created_at, name, 2 more }

id: string

formatuuid

created_at: string

formatdate-time

name: string

updated_at: string

formatdate-time

description?: string | null

LevelDeleteResponse = unknown

DLPSensitivity GroupsLevelsOrder

Retrieve the ordered list of level IDs for a sensitivity group.

client.zeroTrust.dlp.sensitivityGroups.levels.order.get(stringsensitivityGroupID, OrderGetParams { account_id } params, RequestOptionsoptions?): OrderGetResponse { level_ids }

GET/accounts/{account_id}/dlp/sensitivity_groups/{sensitivity_group_id}/level_order

Set the ordering of levels within a sensitivity group.

client.zeroTrust.dlp.sensitivityGroups.levels.order.update(stringsensitivityGroupID, OrderUpdateParams { account_id, level_ids } params, RequestOptionsoptions?): OrderUpdateResponse { level_ids }

PUT/accounts/{account_id}/dlp/sensitivity_groups/{sensitivity_group_id}/level_order

ModelsExpand Collapse

OrderGetResponse { level_ids }

The ordered list of level IDs for a sensitivity group. Used to get and set the ordering of levels independently of level attributes.

level_ids: Array<string>

OrderUpdateResponse { level_ids }

The ordered list of level IDs for a sensitivity group. Used to get and set the ordering of levels independently of level attributes.

level_ids: Array<string>

DLPData Tag Categories

Retrieve all data tag categories in an account

client.zeroTrust.dlp.dataTagCategories.list(DataTagCategoryListParams { account_id } params, RequestOptionsoptions?): SinglePage<DataTagCategoryListResponse { id, created_at, name, 4 more } >

GET/accounts/{account_id}/dlp/data_tag_categories

Retrieve a specific data tag category.

client.zeroTrust.dlp.dataTagCategories.get(stringcategoryID, DataTagCategoryGetParams { account_id } params, RequestOptionsoptions?): DataTagCategoryGetResponse { id, created_at, name, 4 more }

GET/accounts/{account_id}/dlp/data_tag_categories/{category_id}

Creates a new data tag category.

client.zeroTrust.dlp.dataTagCategories.create(DataTagCategoryCreateParams { account_id, name, description, 2 more } params, RequestOptionsoptions?): DataTagCategoryCreateResponse { id, created_at, name, 4 more }

POST/accounts/{account_id}/dlp/data_tag_categories

Update the attributes of a single data tag category.

client.zeroTrust.dlp.dataTagCategories.update(stringcategoryID, DataTagCategoryUpdateParams { account_id, description, name, tags } params, RequestOptionsoptions?): DataTagCategoryUpdateResponse { id, created_at, name, 4 more }

PUT/accounts/{account_id}/dlp/data_tag_categories/{category_id}

Delete a single data tag category.

client.zeroTrust.dlp.dataTagCategories.delete(stringcategoryID, DataTagCategoryDeleteParams { account_id } params, RequestOptionsoptions?): DataTagCategoryDeleteResponse | null

DELETE/accounts/{account_id}/dlp/data_tag_categories/{category_id}

ModelsExpand Collapse

DataTagCategoryListResponse { id, created_at, name, 4 more }

id: string

formatuuid

created_at: string

formatdate-time

name: string

tags: Array<Tag>

id: string

formatuuid

created_at: string

formatdate-time

name: string

updated_at: string

formatdate-time

description?: string | null

updated_at: string

formatdate-time

description?: string | null

template_id?: string | null

formatuuid

DataTagCategoryGetResponse { id, created_at, name, 4 more }

id: string

formatuuid

created_at: string

formatdate-time

name: string

tags: Array<Tag>

id: string

formatuuid

created_at: string

formatdate-time

name: string

updated_at: string

formatdate-time

description?: string | null

updated_at: string

formatdate-time

description?: string | null

template_id?: string | null

formatuuid

DataTagCategoryCreateResponse { id, created_at, name, 4 more }

id: string

formatuuid

created_at: string

formatdate-time

name: string

tags: Array<Tag>

id: string

formatuuid

created_at: string

formatdate-time

name: string

updated_at: string

formatdate-time

description?: string | null

updated_at: string

formatdate-time

description?: string | null

template_id?: string | null

formatuuid

DataTagCategoryUpdateResponse { id, created_at, name, 4 more }

id: string

formatuuid

created_at: string

formatdate-time

name: string

tags: Array<Tag>

id: string

formatuuid

created_at: string

formatdate-time

name: string

updated_at: string

formatdate-time

description?: string | null

updated_at: string

formatdate-time

description?: string | null

template_id?: string | null

formatuuid

DataTagCategoryDeleteResponse = unknown

DLPData Tag CategoriesData Tags

Retrieve all data tags in a data tag category

client.zeroTrust.dlp.dataTagCategories.dataTags.list(stringcategoryID, DataTagListParams { account_id } params, RequestOptionsoptions?): SinglePage<DataTagListResponse { id, created_at, name, 2 more } >

GET/accounts/{account_id}/dlp/data_tag_categories/{category_id}/data_tags

Retrieve a specific data tag.

client.zeroTrust.dlp.dataTagCategories.dataTags.get(stringtagID, DataTagGetParams { account_id, category_id } params, RequestOptionsoptions?): DataTagGetResponse { id, created_at, name, 2 more }

GET/accounts/{account_id}/dlp/data_tag_categories/{category_id}/data_tags/{tag_id}

Creates a new data tag.

client.zeroTrust.dlp.dataTagCategories.dataTags.create(stringcategoryID, DataTagCreateParams { account_id, name, description } params, RequestOptionsoptions?): DataTagCreateResponse { id, created_at, name, 2 more }

POST/accounts/{account_id}/dlp/data_tag_categories/{category_id}/data_tags

Update the attributes of a single data tag.

client.zeroTrust.dlp.dataTagCategories.dataTags.update(stringtagID, DataTagUpdateParams { account_id, category_id, description, name } params, RequestOptionsoptions?): DataTagUpdateResponse { id, created_at, name, 2 more }

PUT/accounts/{account_id}/dlp/data_tag_categories/{category_id}/data_tags/{tag_id}

Delete a single data tag.

client.zeroTrust.dlp.dataTagCategories.dataTags.delete(stringtagID, DataTagDeleteParams { account_id, category_id } params, RequestOptionsoptions?): DataTagDeleteResponse | null

DELETE/accounts/{account_id}/dlp/data_tag_categories/{category_id}/data_tags/{tag_id}

ModelsExpand Collapse

DataTagListResponse { id, created_at, name, 2 more }

id: string

formatuuid

created_at: string

formatdate-time

name: string

updated_at: string

formatdate-time

description?: string | null

DataTagGetResponse { id, created_at, name, 2 more }

id: string

formatuuid

created_at: string

formatdate-time

name: string

updated_at: string

formatdate-time

description?: string | null

DataTagCreateResponse { id, created_at, name, 2 more }

id: string

formatuuid

created_at: string

formatdate-time

name: string

updated_at: string

formatdate-time

description?: string | null

DataTagUpdateResponse { id, created_at, name, 2 more }

id: string

formatuuid

created_at: string

formatdate-time

name: string

updated_at: string

formatdate-time

description?: string | null

DataTagDeleteResponse = unknown

DLPData Classes

Retrieve all data classes in an account

client.zeroTrust.dlp.dataClasses.list(DataClassListParams { account_id } params, RequestOptionsoptions?): SinglePage<DataClassListResponse { id, created_at, data_tags, 5 more } >

GET/accounts/{account_id}/dlp/data_classes

Retrieve a specific data class

client.zeroTrust.dlp.dataClasses.get(stringdataClassID, DataClassGetParams { account_id } params, RequestOptionsoptions?): DataClassGetResponse { id, created_at, data_tags, 5 more }

GET/accounts/{account_id}/dlp/data_classes/{data_class_id}

Creates a new data class

client.zeroTrust.dlp.dataClasses.create(DataClassCreateParams { account_id, data_tags, expression, 3 more } params, RequestOptionsoptions?): DataClassCreateResponse { id, created_at, data_tags, 5 more }

POST/accounts/{account_id}/dlp/data_classes

Update the attributes of a single data class

client.zeroTrust.dlp.dataClasses.update(stringdataClassID, DataClassUpdateParams { account_id, data_tags, description, 3 more } params, RequestOptionsoptions?): DataClassUpdateResponse { id, created_at, data_tags, 5 more }

PUT/accounts/{account_id}/dlp/data_classes/{data_class_id}

Delete a single data class

client.zeroTrust.dlp.dataClasses.delete(stringdataClassID, DataClassDeleteParams { account_id } params, RequestOptionsoptions?): DataClassDeleteResponse | null

DELETE/accounts/{account_id}/dlp/data_classes/{data_class_id}

ModelsExpand Collapse

DataClassListResponse { id, created_at, data_tags, 5 more }

id: string

formatuuid

created_at: string

formatdate-time

data_tags: Array<string>

expression: string

name: string

sensitivity_levels: Array<SensitivityLevel>

group_id: string

formatuuid

level_id: string

formatuuid

updated_at: string

formatdate-time

description?: string | null

DataClassGetResponse { id, created_at, data_tags, 5 more }

id: string

formatuuid

created_at: string

formatdate-time

data_tags: Array<string>

expression: string

name: string

sensitivity_levels: Array<SensitivityLevel>

group_id: string

formatuuid

level_id: string

formatuuid

updated_at: string

formatdate-time

description?: string | null

DataClassCreateResponse { id, created_at, data_tags, 5 more }

id: string

formatuuid

created_at: string

formatdate-time

data_tags: Array<string>

expression: string

name: string

sensitivity_levels: Array<SensitivityLevel>

group_id: string

formatuuid

level_id: string

formatuuid

updated_at: string

formatdate-time

description?: string | null

DataClassUpdateResponse { id, created_at, data_tags, 5 more }

id: string

formatuuid

created_at: string

formatdate-time

data_tags: Array<string>

expression: string

name: string

sensitivity_levels: Array<SensitivityLevel>

group_id: string

formatuuid

level_id: string

formatuuid

updated_at: string

formatdate-time

description?: string | null

DataClassDeleteResponse = unknown