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

GET/accounts/{account_id}/dlp/custom_prompt_topics

Get custom prompt topic

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

Create custom prompt topic

POST/accounts/{account_id}/dlp/custom_prompt_topics

Update custom prompt topic

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

Delete custom prompt topic

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

ModelsExpand Collapse

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

Deprecatedprofile_id: optional string

formatuuid

CustomPromptTopicDeleteResponse = unknown

DLPDatasets

Fetch all datasets

GET/accounts/{account_id}/dlp/datasets

Fetch a specific dataset

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

Create a new dataset

POST/accounts/{account_id}/dlp/datasets

Update details about a dataset

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

Delete a dataset

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

ModelsExpand Collapse

Dataset object { id, columns, created_at, 9 more }

id: string

formatuuid

columns: array of object { entry_id, header_name, num_cells, upload_status }

entry_id: string

formatuuid

header_name: string

num_cells: number

formatint64

upload_status: "empty" or "uploading" or "pending" or 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" or "uploading" or "pending" or 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 of object { num_cells, status, version }

num_cells: number

formatint64

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

One of the following:

"empty"

"uploading"

"pending"

"processing"

"failed"

"complete"

version: number

formatint64

case_sensitive: optional boolean

description: optional string

The description of the dataset.

DatasetArray = array of Dataset { id, columns, created_at, 9 more }

id: string

formatuuid

columns: array of object { entry_id, header_name, num_cells, upload_status }

entry_id: string

formatuuid

header_name: string

num_cells: number

formatint64

upload_status: "empty" or "uploading" or "pending" or 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" or "uploading" or "pending" or 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 of object { num_cells, status, version }

num_cells: number

formatint64

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

One of the following:

"empty"

"uploading"

"pending"

"processing"

"failed"

"complete"

version: number

formatint64

case_sensitive: optional boolean

description: optional string

The description of the dataset.

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

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

Upload a new version of a dataset

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

ModelsExpand Collapse

NewVersion object { encoding_version, max_cells, version, 3 more }

encoding_version: number

formatint32

minimum0

max_cells: number

formatint64

minimum0

version: number

formatint64

case_sensitive: optional boolean

columns: optional array of object { entry_id, header_name, num_cells, upload_status }

entry_id: string

formatuuid

header_name: string

num_cells: number

formatint64

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

One of the following:

"empty"

"uploading"

"pending"

"processing"

"failed"

"complete"

secret: optional string

formatpassword

DLPDatasetsVersions

Sets the column information for a multi-column upload

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

ModelsExpand Collapse

VersionCreateResponse object { entry_id, header_name, num_cells, upload_status }

entry_id: string

formatuuid

header_name: string

num_cells: number

formatint64

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

One of the following:

"empty"

"uploading"

"pending"

"processing"

"failed"

"complete"

DLPDatasetsVersionsEntries

Upload a new version of a multi-column dataset

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

ModelsExpand Collapse

EntryCreateResponse object { entry_id, header_name, num_cells, upload_status }

entry_id: string

formatuuid

header_name: string

num_cells: number

formatint64

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

One of the following:

"empty"

"uploading"

"pending"

"processing"

"failed"

"complete"

DLPPatterns

Validate a DLP regex pattern

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

ModelsExpand Collapse

PatternValidateResponse object { valid }

valid: boolean

DLPPayload Logs

Get payload log settings

Deprecated

GET/accounts/{account_id}/dlp/payload_log

Set payload log settings

Deprecated

PUT/accounts/{account_id}/dlp/payload_log

ModelsExpand Collapse

PayloadLogGetResponse object { updated_at, masking_level, public_key }

updated_at: string

formatdate-time

masking_level: optional "full" or "partial" or "clear" or "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: optional string

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

PayloadLogUpdateResponse object { updated_at, masking_level, public_key }

updated_at: string

formatdate-time

masking_level: optional "full" or "partial" or "clear" or "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: optional string

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

DLPSettings

Get DLP account-level settings.

GET/accounts/{account_id}/dlp/settings

Update DLP account-level settings (full replacement).

PUT/accounts/{account_id}/dlp/settings

Partially update DLP account-level settings.

PATCH/accounts/{account_id}/dlp/settings

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

DELETE/accounts/{account_id}/dlp/settings

ModelsExpand Collapse

DLPSettings object { 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: object { updated_at, masking_level, public_key }

updated_at: string

formatdate-time

masking_level: optional "full" or "partial" or "clear" or "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: optional string

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

DLPEmail

DLPEmailAccount Mapping

Get mapping

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

Create mapping

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

ModelsExpand Collapse

AccountMappingGetResponse object { addin_identifier_token, auth_requirements }

addin_identifier_token: string

formatuuid

auth_requirements: object { allowed_microsoft_organizations, type } or object { type }

One of the following:

object { allowed_microsoft_organizations, type }

allowed_microsoft_organizations: array of string

type: "Org"

Type object { type }

type: "NoAuth"

AccountMappingCreateResponse object { addin_identifier_token, auth_requirements }

addin_identifier_token: string

formatuuid

auth_requirements: object { allowed_microsoft_organizations, type } or object { type }

One of the following:

object { allowed_microsoft_organizations, type }

allowed_microsoft_organizations: array of string

type: "Org"

Type object { type }

type: "NoAuth"

DLPEmailRules

List all email scanner rules

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

Get an email scanner rule

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

Create email scanner rule

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

Update email scanner rule

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

Delete email scanner rule

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

Update email scanner rule priorities

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

ModelsExpand Collapse

RuleListResponse object { action, conditions, created_at, 6 more }

action: object { action, message }

action: "Block"

message: optional string

conditions: array of object { operator, selector, value }

Triggered if all conditions match.

operator: "InList" or "NotInList" or "MatchRegex" or "NotMatchRegex"

One of the following:

"InList"

"NotInList"

"MatchRegex"

"NotMatchRegex"

selector: "Recipients" or "Sender" or "DLPProfiles"

One of the following:

"Recipients"

"Sender"

"DLPProfiles"

value: array of string or string

One of the following:

array of 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: optional string

RuleGetResponse object { action, conditions, created_at, 6 more }

action: object { action, message }

action: "Block"

message: optional string

conditions: array of object { operator, selector, value }

Triggered if all conditions match.

operator: "InList" or "NotInList" or "MatchRegex" or "NotMatchRegex"

One of the following:

"InList"

"NotInList"

"MatchRegex"

"NotMatchRegex"

selector: "Recipients" or "Sender" or "DLPProfiles"

One of the following:

"Recipients"

"Sender"

"DLPProfiles"

value: array of string or string

One of the following:

array of 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: optional string

RuleCreateResponse object { action, conditions, created_at, 6 more }

action: object { action, message }

action: "Block"

message: optional string

conditions: array of object { operator, selector, value }

Triggered if all conditions match.

operator: "InList" or "NotInList" or "MatchRegex" or "NotMatchRegex"

One of the following:

"InList"

"NotInList"

"MatchRegex"

"NotMatchRegex"

selector: "Recipients" or "Sender" or "DLPProfiles"

One of the following:

"Recipients"

"Sender"

"DLPProfiles"

value: array of string or string

One of the following:

array of 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: optional string

RuleUpdateResponse object { action, conditions, created_at, 6 more }

action: object { action, message }

action: "Block"

message: optional string

conditions: array of object { operator, selector, value }

Triggered if all conditions match.

operator: "InList" or "NotInList" or "MatchRegex" or "NotMatchRegex"

One of the following:

"InList"

"NotInList"

"MatchRegex"

"NotMatchRegex"

selector: "Recipients" or "Sender" or "DLPProfiles"

One of the following:

"Recipients"

"Sender"

"DLPProfiles"

value: array of string or string

One of the following:

array of 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: optional string

RuleDeleteResponse object { action, conditions, created_at, 6 more }

action: object { action, message }

action: "Block"

message: optional string

conditions: array of object { operator, selector, value }

Triggered if all conditions match.

operator: "InList" or "NotInList" or "MatchRegex" or "NotMatchRegex"

One of the following:

"InList"

"NotInList"

"MatchRegex"

"NotMatchRegex"

selector: "Recipients" or "Sender" or "DLPProfiles"

One of the following:

"Recipients"

"Sender"

"DLPProfiles"

value: array of string or string

One of the following:

array of 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: optional string

RuleBulkEditResponse object { action, conditions, created_at, 6 more }

action: object { action, message }

action: "Block"

message: optional string

conditions: array of object { operator, selector, value }

Triggered if all conditions match.

operator: "InList" or "NotInList" or "MatchRegex" or "NotMatchRegex"

One of the following:

"InList"

"NotInList"

"MatchRegex"

"NotMatchRegex"

selector: "Recipients" or "Sender" or "DLPProfiles"

One of the following:

"Recipients"

"Sender"

"DLPProfiles"

value: array of string or string

One of the following:

array of 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: optional string

DLPProfiles

List all profiles

GET/accounts/{account_id}/dlp/profiles

Get DLP Profile

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

ModelsExpand Collapse

ContextAwareness object { 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 = object { id, allowed_match_count, created_at, 13 more } or object { id, allowed_match_count, entries, 7 more } or object { id, created_at, entries, 6 more }

One of the following:

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

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

One of the following:

"low"

"medium"

"high"

"very_high"

Deprecatedcontext_awareness: optional ContextAwareness { enabled, skip }

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

data_classes: optional array of string

Data classes associated with this profile.

data_tags: optional array of string

Data tags associated with this profile.

description: optional string

The description of the profile.

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

One of the following:

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

Deprecatedprofile_id: optional string

formatuuid

validator_ids: optional array of 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 object { id, created_at, enabled, 4 more }

id: string

formatuuid

created_at: string

formatdate-time

Deprecatedenabled: boolean

name: string

type: "custom_prompt_topic"

updated_at: string

formatdate-time

description: optional string

The optional description of the custom prompt topic entry.

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

id: string

formatuuid

confidence: object { ai_context_available, available }

ai_context_available: boolean

Indicates whether this entry has AI remote service validation.

available: boolean

Indicates whether this entry has any form of validation that is not an AI remote service.

enabled: boolean

name: string

type: "predefined"

deprecated: optional boolean

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

Deprecatedprofile_id: optional string

formatuuid

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

A Predefined AI prompt classification topic entry.

One of the following:

object { topic_type, type, description }

A Predefined AI prompt classification topic entry.

topic_type: "Intent" or "Content"

One of the following:

"Intent"

"Content"

type: "PromptTopic"

description: optional string

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

object { type, description }

A general predefined entry.

type: "General"

description: optional string

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

IntegrationEntry object { id, created_at, enabled, 4 more }

id: string

formatuuid

created_at: string

formatdate-time

enabled: boolean

name: string

type: "integration"

updated_at: string

formatdate-time

profile_id: optional string

formatuuid

ExactDataEntry object { id, case_sensitive, created_at, 6 more }

id: string

formatuuid

case_sensitive: boolean

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

created_at: string

formatdate-time

enabled: boolean

name: string

secret: boolean

type: "exact_data"

updated_at: string

formatdate-time

description: optional string

The optional description of the exact data entry.

DocumentFingerprintEntry object { id, created_at, enabled, 4 more }

id: string

formatuuid

created_at: string

formatdate-time

enabled: boolean

name: string

type: "document_fingerprint"

updated_at: string

formatdate-time

description: optional string

The optional description of the document fingerprint entry.

WordListEntry object { id, created_at, enabled, 5 more }

id: string

formatuuid

created_at: string

formatdate-time

enabled: boolean

name: string

type: "word_list"

updated_at: string

formatdate-time

word_list: array of string

profile_id: optional string

formatuuid

sensitivity_levels: optional array of object { group_id, level_id }

Sensitivity levels associated with this profile.

group_id: string

formatuuid

level_id: string

formatuuid

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

One of the following:

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

Deprecatedprofile_id: optional string

formatuuid

validator_ids: optional array of 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 object { id, created_at, enabled, 4 more }

id: string

formatuuid

created_at: string

formatdate-time

Deprecatedenabled: boolean

name: string

type: "custom_prompt_topic"

updated_at: string

formatdate-time

description: optional string

The optional description of the custom prompt topic entry.

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

id: string

formatuuid

confidence: object { ai_context_available, available }

ai_context_available: boolean

Indicates whether this entry has AI remote service validation.

available: boolean

Indicates whether this entry has any form of validation that is not an AI remote service.

enabled: boolean

name: string

type: "predefined"

deprecated: optional boolean

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

Deprecatedprofile_id: optional string

formatuuid

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

A Predefined AI prompt classification topic entry.

One of the following:

object { topic_type, type, description }

A Predefined AI prompt classification topic entry.

topic_type: "Intent" or "Content"

One of the following:

"Intent"

"Content"

type: "PromptTopic"

description: optional string

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

object { type, description }

A general predefined entry.

type: "General"

description: optional string

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

IntegrationEntry object { id, created_at, enabled, 4 more }

id: string

formatuuid

created_at: string

formatdate-time

enabled: boolean

name: string

type: "integration"

updated_at: string

formatdate-time

profile_id: optional string

formatuuid

ExactDataEntry object { id, case_sensitive, created_at, 6 more }

id: string

formatuuid

case_sensitive: boolean

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

created_at: string

formatdate-time

enabled: boolean

name: string

secret: boolean

type: "exact_data"

updated_at: string

formatdate-time

description: optional string

The optional description of the exact data entry.

DocumentFingerprintEntry object { id, created_at, enabled, 4 more }

id: string

formatuuid

created_at: string

formatdate-time

enabled: boolean

name: string

type: "document_fingerprint"

updated_at: string

formatdate-time

description: optional string

The optional description of the document fingerprint entry.

WordListEntry object { id, created_at, enabled, 5 more }

id: string

formatuuid

created_at: string

formatdate-time

enabled: boolean

name: string

type: "word_list"

updated_at: string

formatdate-time

word_list: array of string

profile_id: optional string

formatuuid

PredefinedProfile object { id, allowed_match_count, entries, 7 more }

id: string

The id of the predefined profile (uuid).

formatuuid

allowed_match_count: number

formatint32

Deprecatedentries: array of object { id, created_at, enabled, 7 more } or object { id, created_at, enabled, 4 more } or object { id, confidence, enabled, 5 more } or 4 more

One of the following:

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

Deprecatedprofile_id: optional string

formatuuid

validator_ids: optional array of 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 object { id, created_at, enabled, 4 more }

id: string

formatuuid

created_at: string

formatdate-time

Deprecatedenabled: boolean

name: string

type: "custom_prompt_topic"

updated_at: string

formatdate-time

description: optional string

The optional description of the custom prompt topic entry.

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

id: string

formatuuid

confidence: object { ai_context_available, available }

ai_context_available: boolean

Indicates whether this entry has AI remote service validation.

available: boolean

Indicates whether this entry has any form of validation that is not an AI remote service.

enabled: boolean

name: string

type: "predefined"

deprecated: optional boolean

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

Deprecatedprofile_id: optional string

formatuuid

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

A Predefined AI prompt classification topic entry.

One of the following:

object { topic_type, type, description }

A Predefined AI prompt classification topic entry.

topic_type: "Intent" or "Content"

One of the following:

"Intent"

"Content"

type: "PromptTopic"

description: optional string

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

object { type, description }

A general predefined entry.

type: "General"

description: optional string

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

IntegrationEntry object { id, created_at, enabled, 4 more }

id: string

formatuuid

created_at: string

formatdate-time

enabled: boolean

name: string

type: "integration"

updated_at: string

formatdate-time

profile_id: optional string

formatuuid

ExactDataEntry object { id, case_sensitive, created_at, 6 more }

id: string

formatuuid

case_sensitive: boolean

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

created_at: string

formatdate-time

enabled: boolean

name: string

secret: boolean

type: "exact_data"

updated_at: string

formatdate-time

description: optional string

The optional description of the exact data entry.

DocumentFingerprintEntry object { id, created_at, enabled, 4 more }

id: string

formatuuid

created_at: string

formatdate-time

enabled: boolean

name: string

type: "document_fingerprint"

updated_at: string

formatdate-time

description: optional string

The optional description of the document fingerprint entry.

WordListEntry object { id, created_at, enabled, 5 more }

id: string

formatuuid

created_at: string

formatdate-time

enabled: boolean

name: string

type: "word_list"

updated_at: string

formatdate-time

word_list: array of string

profile_id: optional string

formatuuid

name: string

The name of the predefined profile.

type: "predefined"

ai_context_enabled: optional boolean

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

One of the following:

"low"

"medium"

"high"

"very_high"

Deprecatedcontext_awareness: optional ContextAwareness { enabled, skip }

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

ocr_enabled: optional boolean

open_access: optional boolean

Whether this profile can be accessed by anyone.

IntegrationProfile object { id, created_at, entries, 6 more }

id: string

formatuuid

created_at: string

formatdate-time

Deprecatedentries: array of object { id, created_at, enabled, 7 more } or object { id, created_at, enabled, 4 more } or object { id, confidence, enabled, 5 more } or 4 more

One of the following:

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

Deprecatedprofile_id: optional string

formatuuid

validator_ids: optional array of 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 object { id, created_at, enabled, 4 more }

id: string

formatuuid

created_at: string

formatdate-time

Deprecatedenabled: boolean

name: string

type: "custom_prompt_topic"

updated_at: string

formatdate-time

description: optional string

The optional description of the custom prompt topic entry.

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

id: string

formatuuid

confidence: object { ai_context_available, available }

ai_context_available: boolean

Indicates whether this entry has AI remote service validation.

available: boolean

Indicates whether this entry has any form of validation that is not an AI remote service.

enabled: boolean

name: string

type: "predefined"

deprecated: optional boolean

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

Deprecatedprofile_id: optional string

formatuuid

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

A Predefined AI prompt classification topic entry.

One of the following:

object { topic_type, type, description }

A Predefined AI prompt classification topic entry.

topic_type: "Intent" or "Content"

One of the following:

"Intent"

"Content"

type: "PromptTopic"

description: optional string

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

object { type, description }

A general predefined entry.

type: "General"

description: optional string

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

IntegrationEntry object { id, created_at, enabled, 4 more }

id: string

formatuuid

created_at: string

formatdate-time

enabled: boolean

name: string

type: "integration"

updated_at: string

formatdate-time

profile_id: optional string

formatuuid

ExactDataEntry object { id, case_sensitive, created_at, 6 more }

id: string

formatuuid

case_sensitive: boolean

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

created_at: string

formatdate-time

enabled: boolean

name: string

secret: boolean

type: "exact_data"

updated_at: string

formatdate-time

description: optional string

The optional description of the exact data entry.

DocumentFingerprintEntry object { id, created_at, enabled, 4 more }

id: string

formatuuid

created_at: string

formatdate-time

enabled: boolean

name: string

type: "document_fingerprint"

updated_at: string

formatdate-time

description: optional string

The optional description of the document fingerprint entry.

WordListEntry object { id, created_at, enabled, 5 more }

id: string

formatuuid

created_at: string

formatdate-time

enabled: boolean

name: string

type: "word_list"

updated_at: string

formatdate-time

word_list: array of string

profile_id: optional string

formatuuid

integration_id: string

formatuuid

name: string

shared_entries: array of object { id, created_at, enabled, 7 more } or object { id, created_at, enabled, 4 more } or object { id, confidence, enabled, 5 more } or 4 more

One of the following:

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

Deprecatedprofile_id: optional string

formatuuid

validator_ids: optional array of 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 object { id, created_at, enabled, 4 more }

id: string

formatuuid

created_at: string

formatdate-time

Deprecatedenabled: boolean

name: string

type: "custom_prompt_topic"

updated_at: string

formatdate-time

description: optional string

The optional description of the custom prompt topic entry.

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

id: string

formatuuid

confidence: object { ai_context_available, available }

ai_context_available: boolean

Indicates whether this entry has AI remote service validation.

available: boolean

Indicates whether this entry has any form of validation that is not an AI remote service.

enabled: boolean

name: string

type: "predefined"

deprecated: optional boolean

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

Deprecatedprofile_id: optional string

formatuuid

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

A Predefined AI prompt classification topic entry.

One of the following:

object { topic_type, type, description }

A Predefined AI prompt classification topic entry.

topic_type: "Intent" or "Content"

One of the following:

"Intent"

"Content"

type: "PromptTopic"

description: optional string

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

object { type, description }

A general predefined entry.

type: "General"

description: optional string

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

IntegrationEntry object { id, created_at, enabled, 4 more }

id: string

formatuuid

created_at: string

formatdate-time

enabled: boolean

name: string

type: "integration"

updated_at: string

formatdate-time

profile_id: optional string

formatuuid

ExactDataEntry object { id, case_sensitive, created_at, 6 more }

id: string

formatuuid

case_sensitive: boolean

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

created_at: string

formatdate-time

enabled: boolean

name: string

secret: boolean

type: "exact_data"

updated_at: string

formatdate-time

description: optional string

The optional description of the exact data entry.

DocumentFingerprintEntry object { id, created_at, enabled, 4 more }

id: string

formatuuid

created_at: string

formatdate-time

enabled: boolean

name: string

type: "document_fingerprint"

updated_at: string

formatdate-time

description: optional string

The optional description of the document fingerprint entry.

WordListEntry object { id, created_at, enabled, 5 more }

id: string

formatuuid

created_at: string

formatdate-time

enabled: boolean

name: string

type: "word_list"

updated_at: string

formatdate-time

word_list: array of string

profile_id: optional string

formatuuid

type: "integration"

updated_at: string

formatdate-time

description: optional string

The description of the profile.

SkipConfiguration object { 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

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

Create custom profile

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

Update custom profile

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

Delete custom profile

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

ModelsExpand Collapse

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

id: string

The id of the profile (uuid).

formatuuid

allowed_match_count: number

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

formatint32

maximum1000

minimum0

created_at: string

When the profile was created.

formatdate-time

name: string

The name of the profile.

ocr_enabled: boolean

updated_at: string

When the profile was lasted updated.

formatdate-time

ai_context_enabled: optional boolean

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

One of the following:

"low"

"medium"

"high"

"very_high"

Deprecatedcontext_awareness: optional ContextAwareness { enabled, skip }

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

data_classes: optional array of string

Data classes associated with this profile.

data_tags: optional array of string

Data tags associated with this profile.

description: optional string

The description of the profile.

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

One of the following:

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

Deprecatedprofile_id: optional string

formatuuid

validator_ids: optional array of 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 object { id, created_at, enabled, 4 more }

id: string

formatuuid

created_at: string

formatdate-time

Deprecatedenabled: boolean

name: string

type: "custom_prompt_topic"

updated_at: string

formatdate-time

description: optional string

The optional description of the custom prompt topic entry.

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

id: string

formatuuid

confidence: object { ai_context_available, available }

ai_context_available: boolean

Indicates whether this entry has AI remote service validation.

available: boolean

Indicates whether this entry has any form of validation that is not an AI remote service.

enabled: boolean

name: string

type: "predefined"

deprecated: optional boolean

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

Deprecatedprofile_id: optional string

formatuuid

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

A Predefined AI prompt classification topic entry.

One of the following:

object { topic_type, type, description }

A Predefined AI prompt classification topic entry.

topic_type: "Intent" or "Content"

One of the following:

"Intent"

"Content"

type: "PromptTopic"

description: optional string

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

object { type, description }

A general predefined entry.

type: "General"

description: optional string

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

IntegrationEntry object { id, created_at, enabled, 4 more }

id: string

formatuuid

created_at: string

formatdate-time

enabled: boolean

name: string

type: "integration"

updated_at: string

formatdate-time

profile_id: optional string

formatuuid

ExactDataEntry object { id, case_sensitive, created_at, 6 more }

id: string

formatuuid

case_sensitive: boolean

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

created_at: string

formatdate-time

enabled: boolean

name: string

secret: boolean

type: "exact_data"

updated_at: string

formatdate-time

description: optional string

The optional description of the exact data entry.

DocumentFingerprintEntry object { id, created_at, enabled, 4 more }

id: string

formatuuid

created_at: string

formatdate-time

enabled: boolean

name: string

type: "document_fingerprint"

updated_at: string

formatdate-time

description: optional string

The optional description of the document fingerprint entry.

WordListEntry object { id, created_at, enabled, 5 more }

id: string

formatuuid

created_at: string

formatdate-time

enabled: boolean

name: string

type: "word_list"

updated_at: string

formatdate-time

word_list: array of string

profile_id: optional string

formatuuid

sensitivity_levels: optional array of object { group_id, level_id }

Sensitivity levels associated with this profile.

group_id: string

formatuuid

level_id: string

formatuuid

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

One of the following:

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

Deprecatedprofile_id: optional string

formatuuid

validator_ids: optional array of 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 object { id, created_at, enabled, 4 more }

id: string

formatuuid

created_at: string

formatdate-time

Deprecatedenabled: boolean

name: string

type: "custom_prompt_topic"

updated_at: string

formatdate-time

description: optional string

The optional description of the custom prompt topic entry.

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

id: string

formatuuid

confidence: object { ai_context_available, available }

ai_context_available: boolean

Indicates whether this entry has AI remote service validation.

available: boolean

Indicates whether this entry has any form of validation that is not an AI remote service.

enabled: boolean

name: string

type: "predefined"

deprecated: optional boolean

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

Deprecatedprofile_id: optional string

formatuuid

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

A Predefined AI prompt classification topic entry.

One of the following:

object { topic_type, type, description }

A Predefined AI prompt classification topic entry.

topic_type: "Intent" or "Content"

One of the following:

"Intent"

"Content"

type: "PromptTopic"

description: optional string

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

object { type, description }

A general predefined entry.

type: "General"

description: optional string

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

IntegrationEntry object { id, created_at, enabled, 4 more }

id: string

formatuuid

created_at: string

formatdate-time

enabled: boolean

name: string

type: "integration"

updated_at: string

formatdate-time

profile_id: optional string

formatuuid

ExactDataEntry object { id, case_sensitive, created_at, 6 more }

id: string

formatuuid

case_sensitive: boolean

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

created_at: string

formatdate-time

enabled: boolean

name: string

secret: boolean

type: "exact_data"

updated_at: string

formatdate-time

description: optional string

The optional description of the exact data entry.

DocumentFingerprintEntry object { id, created_at, enabled, 4 more }

id: string

formatuuid

created_at: string

formatdate-time

enabled: boolean

name: string

type: "document_fingerprint"

updated_at: string

formatdate-time

description: optional string

The optional description of the document fingerprint entry.

WordListEntry object { id, created_at, enabled, 5 more }

id: string

formatuuid

created_at: string

formatdate-time

enabled: boolean

name: string

type: "word_list"

updated_at: string

formatdate-time

word_list: array of string

profile_id: optional string

formatuuid

Pattern object { regex, validation }

regex: string

Deprecatedvalidation: optional "luhn"

CustomDeleteResponse = unknown

DLPProfilesPredefined

Get predefined profile config

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

Update predefined profile config

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

Delete predefined profile

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

ModelsExpand Collapse

PredefinedProfile object { 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

enabled_entries: array of string

Entries to enable for this predefined profile. Any entries not provided will be disabled.

Deprecatedentries: array of object { id, created_at, enabled, 7 more } or object { id, created_at, enabled, 4 more } or object { id, confidence, enabled, 5 more } or 4 more

This field has been deprecated for enabled_entries.

One of the following:

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

Deprecatedprofile_id: optional string

formatuuid

validator_ids: optional array of 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 object { id, created_at, enabled, 4 more }

id: string

formatuuid

created_at: string

formatdate-time

Deprecatedenabled: boolean

name: string

type: "custom_prompt_topic"

updated_at: string

formatdate-time

description: optional string

The optional description of the custom prompt topic entry.

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

id: string

formatuuid

confidence: object { ai_context_available, available }

ai_context_available: boolean

Indicates whether this entry has AI remote service validation.

available: boolean

Indicates whether this entry has any form of validation that is not an AI remote service.

enabled: boolean

name: string

type: "predefined"

deprecated: optional boolean

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

Deprecatedprofile_id: optional string

formatuuid

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

A Predefined AI prompt classification topic entry.

One of the following:

object { topic_type, type, description }

A Predefined AI prompt classification topic entry.

topic_type: "Intent" or "Content"

One of the following:

"Intent"

"Content"

type: "PromptTopic"

description: optional string

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

object { type, description }

A general predefined entry.

type: "General"

description: optional string

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

IntegrationEntry object { id, created_at, enabled, 4 more }

id: string

formatuuid

created_at: string

formatdate-time

enabled: boolean

name: string

type: "integration"

updated_at: string

formatdate-time

profile_id: optional string

formatuuid

ExactDataEntry object { id, case_sensitive, created_at, 6 more }

id: string

formatuuid

case_sensitive: boolean

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

created_at: string

formatdate-time

enabled: boolean

name: string

secret: boolean

type: "exact_data"

updated_at: string

formatdate-time

description: optional string

The optional description of the exact data entry.

DocumentFingerprintEntry object { id, created_at, enabled, 4 more }

id: string

formatuuid

created_at: string

formatdate-time

enabled: boolean

name: string

type: "document_fingerprint"

updated_at: string

formatdate-time

description: optional string

The optional description of the document fingerprint entry.

WordListEntry object { id, created_at, enabled, 5 more }

id: string

formatuuid

created_at: string

formatdate-time

enabled: boolean

name: string

type: "word_list"

updated_at: string

formatdate-time

word_list: array of string

profile_id: optional string

formatuuid

name: string

The name of the predefined profile.

ai_context_enabled: optional boolean

ocr_enabled: optional boolean

open_access: optional boolean

Whether this profile can be accessed by anyone.

PredefinedDeleteResponse = unknown

DLPLimits

Fetch limits associated with DLP for account

GET/accounts/{account_id}/dlp/limits

ModelsExpand Collapse

LimitListResponse object { 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

GET/accounts/{account_id}/dlp/entries

Get DLP Entry

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

Create custom entry

POST/accounts/{account_id}/dlp/entries

Update entry

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

Delete custom entry

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

ModelsExpand Collapse

EntryListResponse = object { id, created_at, enabled, 8 more } or object { id, created_at, enabled, 5 more } or object { id, confidence, enabled, 6 more } or 4 more

One of the following:

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

Deprecatedprofile_id: optional string

formatuuid

upload_status: optional "empty" or "uploading" or "pending" or 3 more

One of the following:

"empty"

"uploading"

"pending"

"processing"

"failed"

"complete"

validator_ids: optional array of 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.

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

The optional description of the custom prompt topic entry.

upload_status: optional "empty" or "uploading" or "pending" or 3 more

One of the following:

"empty"

"uploading"

"pending"

"processing"

"failed"

"complete"

object { id, confidence, enabled, 6 more }

id: string

formatuuid

confidence: object { ai_context_available, available }

ai_context_available: boolean

Indicates whether this entry has AI remote service validation.

available: boolean

Indicates whether this entry has any form of validation that is not an AI remote service.

enabled: boolean

name: string

type: "predefined"

deprecated: optional boolean

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

Deprecatedprofile_id: optional string

formatuuid

upload_status: optional "empty" or "uploading" or "pending" or 3 more

One of the following:

"empty"

"uploading"

"pending"

"processing"

"failed"

"complete"

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

A Predefined AI prompt classification topic entry.

One of the following:

object { topic_type, type, description }

A Predefined AI prompt classification topic entry.

topic_type: "Intent" or "Content"

One of the following:

"Intent"

"Content"

type: "PromptTopic"

description: optional string

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

object { type, description }

A general predefined entry.

type: "General"

description: optional string

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

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

formatuuid

upload_status: optional "empty" or "uploading" or "pending" or 3 more

One of the following:

"empty"

"uploading"

"pending"

"processing"

"failed"

"complete"

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

The optional description of the exact data entry.

upload_status: optional "empty" or "uploading" or "pending" or 3 more

One of the following:

"empty"

"uploading"

"pending"

"processing"

"failed"

"complete"

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

The optional description of the document fingerprint entry.

upload_status: optional "empty" or "uploading" or "pending" or 3 more

One of the following:

"empty"

"uploading"

"pending"

"processing"

"failed"

"complete"

object { 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 of string

profile_id: optional string

formatuuid

upload_status: optional "empty" or "uploading" or "pending" or 3 more

One of the following:

"empty"

"uploading"

"pending"

"processing"

"failed"

"complete"

EntryGetResponse = object { id, created_at, enabled, 9 more } or object { id, created_at, enabled, 6 more } or object { id, confidence, enabled, 7 more } or 4 more

One of the following:

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

Deprecatedprofile_id: optional string

formatuuid

profiles: optional array of object { id, name }

id: string

formatuuid

name: string

upload_status: optional "empty" or "uploading" or "pending" or 3 more

One of the following:

"empty"

"uploading"

"pending"

"processing"

"failed"

"complete"

validator_ids: optional array of 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.

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

The optional description of the custom prompt topic entry.

profiles: optional array of object { id, name }

id: string

formatuuid

name: string

upload_status: optional "empty" or "uploading" or "pending" or 3 more

One of the following:

"empty"

"uploading"

"pending"

"processing"

"failed"

"complete"

object { id, confidence, enabled, 7 more }

id: string

formatuuid

confidence: object { ai_context_available, available }

ai_context_available: boolean

Indicates whether this entry has AI remote service validation.

available: boolean

Indicates whether this entry has any form of validation that is not an AI remote service.

enabled: boolean

name: string

type: "predefined"

deprecated: optional boolean

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

Deprecatedprofile_id: optional string

formatuuid

profiles: optional array of object { id, name }

id: string

formatuuid

name: string

upload_status: optional "empty" or "uploading" or "pending" or 3 more

One of the following:

"empty"

"uploading"

"pending"

"processing"

"failed"

"complete"

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

A Predefined AI prompt classification topic entry.

One of the following:

object { topic_type, type, description }

A Predefined AI prompt classification topic entry.

topic_type: "Intent" or "Content"

One of the following:

"Intent"

"Content"

type: "PromptTopic"

description: optional string

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

object { type, description }

A general predefined entry.

type: "General"

description: optional string

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

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

formatuuid

profiles: optional array of object { id, name }

id: string

formatuuid

name: string

upload_status: optional "empty" or "uploading" or "pending" or 3 more

One of the following:

"empty"

"uploading"

"pending"

"processing"

"failed"

"complete"

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

The optional description of the exact data entry.

profiles: optional array of object { id, name }

id: string

formatuuid

name: string

upload_status: optional "empty" or "uploading" or "pending" or 3 more

One of the following:

"empty"

"uploading"

"pending"

"processing"

"failed"

"complete"

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

The optional description of the document fingerprint entry.

profiles: optional array of object { id, name }

id: string

formatuuid

name: string

upload_status: optional "empty" or "uploading" or "pending" or 3 more

One of the following:

"empty"

"uploading"

"pending"

"processing"

"failed"

"complete"

object { 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 of string

profile_id: optional string

formatuuid

profiles: optional array of object { id, name }

id: string

formatuuid

name: string

upload_status: optional "empty" or "uploading" or "pending" or 3 more

One of the following:

"empty"

"uploading"

"pending"

"processing"

"failed"

"complete"

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

Deprecatedprofile_id: optional string

formatuuid

validator_ids: optional array of 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 = object { id, created_at, enabled, 7 more } or object { id, created_at, enabled, 4 more } or object { id, confidence, enabled, 5 more } or 4 more

One of the following:

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

Deprecatedprofile_id: optional string

formatuuid

validator_ids: optional array of 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 object { id, created_at, enabled, 4 more }

id: string

formatuuid

created_at: string

formatdate-time

Deprecatedenabled: boolean

name: string

type: "custom_prompt_topic"

updated_at: string

formatdate-time

description: optional string

The optional description of the custom prompt topic entry.

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

id: string

formatuuid

confidence: object { ai_context_available, available }

ai_context_available: boolean

Indicates whether this entry has AI remote service validation.

available: boolean

Indicates whether this entry has any form of validation that is not an AI remote service.

enabled: boolean

name: string

type: "predefined"

deprecated: optional boolean

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

Deprecatedprofile_id: optional string

formatuuid

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

A Predefined AI prompt classification topic entry.

One of the following:

object { topic_type, type, description }

A Predefined AI prompt classification topic entry.

topic_type: "Intent" or "Content"

One of the following:

"Intent"

"Content"

type: "PromptTopic"

description: optional string

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

object { type, description }

A general predefined entry.

type: "General"

description: optional string

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

IntegrationEntry object { id, created_at, enabled, 4 more }

id: string

formatuuid

created_at: string

formatdate-time

enabled: boolean

name: string

type: "integration"

updated_at: string

formatdate-time

profile_id: optional string

formatuuid

ExactDataEntry object { id, case_sensitive, created_at, 6 more }

id: string

formatuuid

case_sensitive: boolean

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

created_at: string

formatdate-time

enabled: boolean

name: string

secret: boolean

type: "exact_data"

updated_at: string

formatdate-time

description: optional string

The optional description of the exact data entry.

DocumentFingerprintEntry object { id, created_at, enabled, 4 more }

id: string

formatuuid

created_at: string

formatdate-time

enabled: boolean

name: string

type: "document_fingerprint"

updated_at: string

formatdate-time

description: optional string

The optional description of the document fingerprint entry.

WordListEntry object { id, created_at, enabled, 5 more }

id: string

formatuuid

created_at: string

formatdate-time

enabled: boolean

name: string

type: "word_list"

updated_at: string

formatdate-time

word_list: array of string

profile_id: optional string

formatuuid

EntryDeleteResponse = unknown

DLPEntriesCustom

Create custom entry

POST/accounts/{account_id}/dlp/entries

Update custom entry

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

Delete custom entry

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

Get DLP Entry

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

List all entries

GET/accounts/{account_id}/dlp/entries

ModelsExpand Collapse

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

Deprecatedprofile_id: optional string

formatuuid

validator_ids: optional array of 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 object { 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: optional string

Deprecatedprofile_id: optional string

formatuuid

validator_ids: optional array of 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 = object { id, created_at, enabled, 9 more } or object { id, created_at, enabled, 6 more } or object { id, confidence, enabled, 7 more } or 4 more

One of the following:

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

Deprecatedprofile_id: optional string

formatuuid

profiles: optional array of object { id, name }

id: string

formatuuid

name: string

upload_status: optional "empty" or "uploading" or "pending" or 3 more

One of the following:

"empty"

"uploading"

"pending"

"processing"

"failed"

"complete"

validator_ids: optional array of 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.

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

The optional description of the custom prompt topic entry.

profiles: optional array of object { id, name }

id: string

formatuuid

name: string

upload_status: optional "empty" or "uploading" or "pending" or 3 more

One of the following:

"empty"

"uploading"

"pending"

"processing"

"failed"

"complete"

object { id, confidence, enabled, 7 more }

id: string

formatuuid

confidence: object { ai_context_available, available }

ai_context_available: boolean

Indicates whether this entry has AI remote service validation.

available: boolean

Indicates whether this entry has any form of validation that is not an AI remote service.

enabled: boolean

name: string

type: "predefined"

deprecated: optional boolean

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

Deprecatedprofile_id: optional string

formatuuid

profiles: optional array of object { id, name }

id: string

formatuuid

name: string

upload_status: optional "empty" or "uploading" or "pending" or 3 more

One of the following:

"empty"

"uploading"

"pending"

"processing"

"failed"

"complete"

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

A Predefined AI prompt classification topic entry.

One of the following:

object { topic_type, type, description }

A Predefined AI prompt classification topic entry.

topic_type: "Intent" or "Content"

One of the following:

"Intent"

"Content"

type: "PromptTopic"

description: optional string

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

object { type, description }

A general predefined entry.

type: "General"

description: optional string

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

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

formatuuid

profiles: optional array of object { id, name }

id: string

formatuuid

name: string

upload_status: optional "empty" or "uploading" or "pending" or 3 more

One of the following:

"empty"

"uploading"

"pending"

"processing"

"failed"

"complete"

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

The optional description of the exact data entry.

profiles: optional array of object { id, name }

id: string

formatuuid

name: string

upload_status: optional "empty" or "uploading" or "pending" or 3 more

One of the following:

"empty"

"uploading"

"pending"

"processing"

"failed"

"complete"

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

The optional description of the document fingerprint entry.

profiles: optional array of object { id, name }

id: string

formatuuid

name: string

upload_status: optional "empty" or "uploading" or "pending" or 3 more

One of the following:

"empty"

"uploading"

"pending"

"processing"

"failed"

"complete"

object { 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 of string

profile_id: optional string

formatuuid

profiles: optional array of object { id, name }

id: string

formatuuid

name: string

upload_status: optional "empty" or "uploading" or "pending" or 3 more

One of the following:

"empty"

"uploading"

"pending"

"processing"

"failed"

"complete"

CustomListResponse = object { id, created_at, enabled, 8 more } or object { id, created_at, enabled, 5 more } or object { id, confidence, enabled, 6 more } or 4 more

One of the following:

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

Deprecatedprofile_id: optional string

formatuuid

upload_status: optional "empty" or "uploading" or "pending" or 3 more

One of the following:

"empty"

"uploading"

"pending"

"processing"

"failed"

"complete"

validator_ids: optional array of 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.

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

The optional description of the custom prompt topic entry.

upload_status: optional "empty" or "uploading" or "pending" or 3 more

One of the following:

"empty"

"uploading"

"pending"

"processing"

"failed"

"complete"

object { id, confidence, enabled, 6 more }

id: string

formatuuid

confidence: object { ai_context_available, available }

ai_context_available: boolean

Indicates whether this entry has AI remote service validation.

available: boolean

Indicates whether this entry has any form of validation that is not an AI remote service.

enabled: boolean

name: string

type: "predefined"

deprecated: optional boolean

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

Deprecatedprofile_id: optional string

formatuuid

upload_status: optional "empty" or "uploading" or "pending" or 3 more

One of the following:

"empty"

"uploading"

"pending"

"processing"

"failed"

"complete"

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

A Predefined AI prompt classification topic entry.

One of the following:

object { topic_type, type, description }

A Predefined AI prompt classification topic entry.

topic_type: "Intent" or "Content"

One of the following:

"Intent"

"Content"

type: "PromptTopic"

description: optional string

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

object { type, description }

A general predefined entry.

type: "General"

description: optional string

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

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

formatuuid

upload_status: optional "empty" or "uploading" or "pending" or 3 more

One of the following:

"empty"

"uploading"

"pending"

"processing"

"failed"

"complete"

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

The optional description of the exact data entry.

upload_status: optional "empty" or "uploading" or "pending" or 3 more

One of the following:

"empty"

"uploading"

"pending"

"processing"

"failed"

"complete"

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

The optional description of the document fingerprint entry.

upload_status: optional "empty" or "uploading" or "pending" or 3 more

One of the following:

"empty"

"uploading"

"pending"

"processing"

"failed"

"complete"

object { 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 of string

profile_id: optional string

formatuuid

upload_status: optional "empty" or "uploading" or "pending" or 3 more

One of the following:

"empty"

"uploading"

"pending"

"processing"

"failed"

"complete"

DLPEntriesPredefined

Create predefined entry

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

Update predefined entry

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

Delete predefined entry

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

Get DLP Entry

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

List all entries

GET/accounts/{account_id}/dlp/entries

ModelsExpand Collapse

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

id: string

formatuuid

confidence: object { ai_context_available, available }

ai_context_available: boolean

Indicates whether this entry has AI remote service validation.

available: boolean

Indicates whether this entry has any form of validation that is not an AI remote service.

enabled: boolean

name: string

deprecated: optional boolean

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

Deprecatedprofile_id: optional string

formatuuid

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

A Predefined AI prompt classification topic entry.

One of the following:

object { topic_type, type, description }

A Predefined AI prompt classification topic entry.

topic_type: "Intent" or "Content"

One of the following:

"Intent"

"Content"

type: "PromptTopic"

description: optional string

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

object { type, description }

A general predefined entry.

type: "General"

description: optional string

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

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

id: string

formatuuid

confidence: object { ai_context_available, available }

ai_context_available: boolean

Indicates whether this entry has AI remote service validation.

available: boolean

Indicates whether this entry has any form of validation that is not an AI remote service.

enabled: boolean

name: string

deprecated: optional boolean

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

Deprecatedprofile_id: optional string

formatuuid

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

A Predefined AI prompt classification topic entry.

One of the following:

object { topic_type, type, description }

A Predefined AI prompt classification topic entry.

topic_type: "Intent" or "Content"

One of the following:

"Intent"

"Content"

type: "PromptTopic"

description: optional string

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

object { type, description }

A general predefined entry.

type: "General"

description: optional string

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

PredefinedDeleteResponse = unknown

PredefinedGetResponse = object { id, created_at, enabled, 9 more } or object { id, created_at, enabled, 6 more } or object { id, confidence, enabled, 7 more } or 4 more

One of the following:

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

Deprecatedprofile_id: optional string

formatuuid

profiles: optional array of object { id, name }

id: string

formatuuid

name: string

upload_status: optional "empty" or "uploading" or "pending" or 3 more

One of the following:

"empty"

"uploading"

"pending"

"processing"

"failed"

"complete"

validator_ids: optional array of 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.

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

The optional description of the custom prompt topic entry.

profiles: optional array of object { id, name }

id: string

formatuuid

name: string

upload_status: optional "empty" or "uploading" or "pending" or 3 more

One of the following:

"empty"

"uploading"

"pending"

"processing"

"failed"

"complete"

object { id, confidence, enabled, 7 more }

id: string

formatuuid

confidence: object { ai_context_available, available }

ai_context_available: boolean

Indicates whether this entry has AI remote service validation.

available: boolean

Indicates whether this entry has any form of validation that is not an AI remote service.

enabled: boolean

name: string

type: "predefined"

deprecated: optional boolean

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

Deprecatedprofile_id: optional string

formatuuid

profiles: optional array of object { id, name }

id: string

formatuuid

name: string

upload_status: optional "empty" or "uploading" or "pending" or 3 more

One of the following:

"empty"

"uploading"

"pending"

"processing"

"failed"

"complete"

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

A Predefined AI prompt classification topic entry.

One of the following:

object { topic_type, type, description }

A Predefined AI prompt classification topic entry.

topic_type: "Intent" or "Content"

One of the following:

"Intent"

"Content"

type: "PromptTopic"

description: optional string

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

object { type, description }

A general predefined entry.

type: "General"

description: optional string

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

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

formatuuid

profiles: optional array of object { id, name }

id: string

formatuuid

name: string

upload_status: optional "empty" or "uploading" or "pending" or 3 more

One of the following:

"empty"

"uploading"

"pending"

"processing"

"failed"

"complete"

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

The optional description of the exact data entry.

profiles: optional array of object { id, name }

id: string

formatuuid

name: string

upload_status: optional "empty" or "uploading" or "pending" or 3 more

One of the following:

"empty"

"uploading"

"pending"

"processing"

"failed"

"complete"

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

The optional description of the document fingerprint entry.

profiles: optional array of object { id, name }

id: string

formatuuid

name: string

upload_status: optional "empty" or "uploading" or "pending" or 3 more

One of the following:

"empty"

"uploading"

"pending"

"processing"

"failed"

"complete"

object { 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 of string

profile_id: optional string

formatuuid

profiles: optional array of object { id, name }

id: string

formatuuid

name: string

upload_status: optional "empty" or "uploading" or "pending" or 3 more

One of the following:

"empty"

"uploading"

"pending"

"processing"

"failed"

"complete"

PredefinedListResponse = object { id, created_at, enabled, 8 more } or object { id, created_at, enabled, 5 more } or object { id, confidence, enabled, 6 more } or 4 more

One of the following:

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

Deprecatedprofile_id: optional string

formatuuid

upload_status: optional "empty" or "uploading" or "pending" or 3 more

One of the following:

"empty"

"uploading"

"pending"

"processing"

"failed"

"complete"

validator_ids: optional array of 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.

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

The optional description of the custom prompt topic entry.

upload_status: optional "empty" or "uploading" or "pending" or 3 more

One of the following:

"empty"

"uploading"

"pending"

"processing"

"failed"

"complete"

object { id, confidence, enabled, 6 more }

id: string

formatuuid

confidence: object { ai_context_available, available }

ai_context_available: boolean

Indicates whether this entry has AI remote service validation.

available: boolean

Indicates whether this entry has any form of validation that is not an AI remote service.

enabled: boolean

name: string

type: "predefined"

deprecated: optional boolean

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

Deprecatedprofile_id: optional string

formatuuid

upload_status: optional "empty" or "uploading" or "pending" or 3 more

One of the following:

"empty"

"uploading"

"pending"

"processing"

"failed"

"complete"

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

A Predefined AI prompt classification topic entry.

One of the following:

object { topic_type, type, description }

A Predefined AI prompt classification topic entry.

topic_type: "Intent" or "Content"

One of the following:

"Intent"

"Content"

type: "PromptTopic"

description: optional string

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

object { type, description }

A general predefined entry.

type: "General"

description: optional string

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

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

formatuuid

upload_status: optional "empty" or "uploading" or "pending" or 3 more

One of the following:

"empty"

"uploading"

"pending"

"processing"

"failed"

"complete"

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

The optional description of the exact data entry.

upload_status: optional "empty" or "uploading" or "pending" or 3 more

One of the following:

"empty"

"uploading"

"pending"

"processing"

"failed"

"complete"

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

The optional description of the document fingerprint entry.

upload_status: optional "empty" or "uploading" or "pending" or 3 more

One of the following:

"empty"

"uploading"

"pending"

"processing"

"failed"

"complete"

object { 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 of string

profile_id: optional string

formatuuid

upload_status: optional "empty" or "uploading" or "pending" or 3 more

One of the following:

"empty"

"uploading"

"pending"

"processing"

"failed"

"complete"

DLPEntriesIntegration

Create integration entry

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

Update integration entry

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

Delete integration entry

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

Get DLP Entry

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

List all entries

GET/accounts/{account_id}/dlp/entries

ModelsExpand Collapse

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

formatuuid

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

formatuuid

IntegrationDeleteResponse = unknown

IntegrationGetResponse = object { id, created_at, enabled, 9 more } or object { id, created_at, enabled, 6 more } or object { id, confidence, enabled, 7 more } or 4 more

One of the following:

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

Deprecatedprofile_id: optional string

formatuuid

profiles: optional array of object { id, name }

id: string

formatuuid

name: string

upload_status: optional "empty" or "uploading" or "pending" or 3 more

One of the following:

"empty"

"uploading"

"pending"

"processing"

"failed"

"complete"

validator_ids: optional array of 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.

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

The optional description of the custom prompt topic entry.

profiles: optional array of object { id, name }

id: string

formatuuid

name: string

upload_status: optional "empty" or "uploading" or "pending" or 3 more

One of the following:

"empty"

"uploading"

"pending"

"processing"

"failed"

"complete"

object { id, confidence, enabled, 7 more }

id: string

formatuuid

confidence: object { ai_context_available, available }

ai_context_available: boolean

Indicates whether this entry has AI remote service validation.

available: boolean

Indicates whether this entry has any form of validation that is not an AI remote service.

enabled: boolean

name: string

type: "predefined"

deprecated: optional boolean

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

Deprecatedprofile_id: optional string

formatuuid

profiles: optional array of object { id, name }

id: string

formatuuid

name: string

upload_status: optional "empty" or "uploading" or "pending" or 3 more

One of the following:

"empty"

"uploading"

"pending"

"processing"

"failed"

"complete"

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

A Predefined AI prompt classification topic entry.

One of the following:

object { topic_type, type, description }

A Predefined AI prompt classification topic entry.

topic_type: "Intent" or "Content"

One of the following:

"Intent"

"Content"

type: "PromptTopic"

description: optional string

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

object { type, description }

A general predefined entry.

type: "General"

description: optional string

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

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

formatuuid

profiles: optional array of object { id, name }

id: string

formatuuid

name: string

upload_status: optional "empty" or "uploading" or "pending" or 3 more

One of the following:

"empty"

"uploading"

"pending"

"processing"

"failed"

"complete"

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

The optional description of the exact data entry.

profiles: optional array of object { id, name }

id: string

formatuuid

name: string

upload_status: optional "empty" or "uploading" or "pending" or 3 more

One of the following:

"empty"

"uploading"

"pending"

"processing"

"failed"

"complete"

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

The optional description of the document fingerprint entry.

profiles: optional array of object { id, name }

id: string

formatuuid

name: string

upload_status: optional "empty" or "uploading" or "pending" or 3 more

One of the following:

"empty"

"uploading"

"pending"

"processing"

"failed"

"complete"

object { 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 of string

profile_id: optional string

formatuuid

profiles: optional array of object { id, name }

id: string

formatuuid

name: string

upload_status: optional "empty" or "uploading" or "pending" or 3 more

One of the following:

"empty"

"uploading"

"pending"

"processing"

"failed"

"complete"

IntegrationListResponse = object { id, created_at, enabled, 8 more } or object { id, created_at, enabled, 5 more } or object { id, confidence, enabled, 6 more } or 4 more

One of the following:

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

Deprecatedprofile_id: optional string

formatuuid

upload_status: optional "empty" or "uploading" or "pending" or 3 more

One of the following:

"empty"

"uploading"

"pending"

"processing"

"failed"

"complete"

validator_ids: optional array of 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.

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

The optional description of the custom prompt topic entry.

upload_status: optional "empty" or "uploading" or "pending" or 3 more

One of the following:

"empty"

"uploading"

"pending"

"processing"

"failed"

"complete"

object { id, confidence, enabled, 6 more }

id: string

formatuuid

confidence: object { ai_context_available, available }

ai_context_available: boolean

Indicates whether this entry has AI remote service validation.

available: boolean

Indicates whether this entry has any form of validation that is not an AI remote service.

enabled: boolean

name: string

type: "predefined"

deprecated: optional boolean

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

Deprecatedprofile_id: optional string

formatuuid

upload_status: optional "empty" or "uploading" or "pending" or 3 more

One of the following:

"empty"

"uploading"

"pending"

"processing"

"failed"

"complete"

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

A Predefined AI prompt classification topic entry.

One of the following:

object { topic_type, type, description }

A Predefined AI prompt classification topic entry.

topic_type: "Intent" or "Content"

One of the following:

"Intent"

"Content"

type: "PromptTopic"

description: optional string

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

object { type, description }

A general predefined entry.

type: "General"

description: optional string

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

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

formatuuid

upload_status: optional "empty" or "uploading" or "pending" or 3 more

One of the following:

"empty"

"uploading"

"pending"

"processing"

"failed"

"complete"

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

The optional description of the exact data entry.

upload_status: optional "empty" or "uploading" or "pending" or 3 more

One of the following:

"empty"

"uploading"

"pending"

"processing"

"failed"

"complete"

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

The optional description of the document fingerprint entry.

upload_status: optional "empty" or "uploading" or "pending" or 3 more

One of the following:

"empty"

"uploading"

"pending"

"processing"

"failed"

"complete"

object { 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 of string

profile_id: optional string

formatuuid

upload_status: optional "empty" or "uploading" or "pending" or 3 more

One of the following:

"empty"

"uploading"

"pending"

"processing"

"failed"

"complete"

DLPSensitivity Groups

Retrieve all sensitivity groups in an account

GET/accounts/{account_id}/dlp/sensitivity_groups

Retrieve a specific sensitivity group.

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

Creates a new sensitivity group.

POST/accounts/{account_id}/dlp/sensitivity_groups

Update the attributes of a single sensitivity group.

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

Delete a single sensitivity group.

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

ModelsExpand Collapse

SensitivityGroupListResponse object { id, created_at, levels, 4 more }

id: string

formatuuid

created_at: string

formatdate-time

levels: array of object { id, created_at, name, 2 more }

id: string

formatuuid

created_at: string

formatdate-time

name: string

updated_at: string

formatdate-time

description: optional string

name: string

updated_at: string

formatdate-time

description: optional string

template_id: optional string

formatuuid

SensitivityGroupGetResponse object { id, created_at, levels, 4 more }

id: string

formatuuid

created_at: string

formatdate-time

levels: array of object { id, created_at, name, 2 more }

id: string

formatuuid

created_at: string

formatdate-time

name: string

updated_at: string

formatdate-time

description: optional string

name: string

updated_at: string

formatdate-time

description: optional string

template_id: optional string

formatuuid

SensitivityGroupCreateResponse object { id, created_at, levels, 4 more }

id: string

formatuuid

created_at: string

formatdate-time

levels: array of object { id, created_at, name, 2 more }

id: string

formatuuid

created_at: string

formatdate-time

name: string

updated_at: string

formatdate-time

description: optional string

name: string

updated_at: string

formatdate-time

description: optional string

template_id: optional string

formatuuid

SensitivityGroupUpdateResponse object { id, created_at, levels, 4 more }

id: string

formatuuid

created_at: string

formatdate-time

levels: array of object { id, created_at, name, 2 more }

id: string

formatuuid

created_at: string

formatdate-time

name: string

updated_at: string

formatdate-time

description: optional string

name: string

updated_at: string

formatdate-time

description: optional string

template_id: optional string

formatuuid

SensitivityGroupDeleteResponse = unknown

DLPSensitivity GroupsLevels

Retrieve all sensitivity levels in a sensitivity group

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

Retrieve a specific sensitivity level.

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

Creates a new sensitivity level.

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

Update the attributes of a single sensitivity level.

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

Delete a single sensitivity level.

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

ModelsExpand Collapse

LevelListResponse object { id, created_at, name, 2 more }

id: string

formatuuid

created_at: string

formatdate-time

name: string

updated_at: string

formatdate-time

description: optional string

LevelGetResponse object { id, created_at, name, 2 more }

id: string

formatuuid

created_at: string

formatdate-time

name: string

updated_at: string

formatdate-time

description: optional string

LevelCreateResponse object { id, created_at, name, 2 more }

id: string

formatuuid

created_at: string

formatdate-time

name: string

updated_at: string

formatdate-time

description: optional string

LevelUpdateResponse object { id, created_at, name, 2 more }

id: string

formatuuid

created_at: string

formatdate-time

name: string

updated_at: string

formatdate-time

description: optional string

LevelDeleteResponse = unknown

DLPSensitivity GroupsLevelsOrder

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

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

Set the ordering of levels within a sensitivity group.

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

ModelsExpand Collapse

OrderGetResponse object { 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 of string

OrderUpdateResponse object { 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 of string

DLPData Tag Categories

Retrieve all data tag categories in an account

GET/accounts/{account_id}/dlp/data_tag_categories

Retrieve a specific data tag category.

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

Creates a new data tag category.

POST/accounts/{account_id}/dlp/data_tag_categories

Update the attributes of a single data tag category.

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

Delete a single data tag category.

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

ModelsExpand Collapse

DataTagCategoryListResponse object { id, created_at, name, 4 more }

id: string

formatuuid

created_at: string

formatdate-time

name: string

tags: array of object { id, created_at, name, 2 more }

id: string

formatuuid

created_at: string

formatdate-time

name: string

updated_at: string

formatdate-time

description: optional string

updated_at: string

formatdate-time

description: optional string

template_id: optional string

formatuuid

DataTagCategoryGetResponse object { id, created_at, name, 4 more }

id: string

formatuuid

created_at: string

formatdate-time

name: string

tags: array of object { id, created_at, name, 2 more }

id: string

formatuuid

created_at: string

formatdate-time

name: string

updated_at: string

formatdate-time

description: optional string

updated_at: string

formatdate-time

description: optional string

template_id: optional string

formatuuid

DataTagCategoryCreateResponse object { id, created_at, name, 4 more }

id: string

formatuuid

created_at: string

formatdate-time

name: string

tags: array of object { id, created_at, name, 2 more }

id: string

formatuuid

created_at: string

formatdate-time

name: string

updated_at: string

formatdate-time

description: optional string

updated_at: string

formatdate-time

description: optional string

template_id: optional string

formatuuid

DataTagCategoryUpdateResponse object { id, created_at, name, 4 more }

id: string

formatuuid

created_at: string

formatdate-time

name: string

tags: array of object { id, created_at, name, 2 more }

id: string

formatuuid

created_at: string

formatdate-time

name: string

updated_at: string

formatdate-time

description: optional string

updated_at: string

formatdate-time

description: optional string

template_id: optional string

formatuuid

DataTagCategoryDeleteResponse = unknown

DLPData Tag CategoriesData Tags

Retrieve all data tags in a data tag category

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

Retrieve a specific data tag.

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

Creates a new data tag.

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

Update the attributes of a single data tag.

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

Delete a single data tag.

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

ModelsExpand Collapse

DataTagListResponse object { id, created_at, name, 2 more }

id: string

formatuuid

created_at: string

formatdate-time

name: string

updated_at: string

formatdate-time

description: optional string

DataTagGetResponse object { id, created_at, name, 2 more }

id: string

formatuuid

created_at: string

formatdate-time

name: string

updated_at: string

formatdate-time

description: optional string

DataTagCreateResponse object { id, created_at, name, 2 more }

id: string

formatuuid

created_at: string

formatdate-time

name: string

updated_at: string

formatdate-time

description: optional string

DataTagUpdateResponse object { id, created_at, name, 2 more }

id: string

formatuuid

created_at: string

formatdate-time

name: string

updated_at: string

formatdate-time

description: optional string

DataTagDeleteResponse = unknown

DLPData Classes

Retrieve all data classes in an account

GET/accounts/{account_id}/dlp/data_classes

Retrieve a specific data class

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

Creates a new data class

POST/accounts/{account_id}/dlp/data_classes

Update the attributes of a single data class

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

Delete a single data class

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

ModelsExpand Collapse

DataClassListResponse object { id, created_at, data_tags, 5 more }

id: string

formatuuid

created_at: string

formatdate-time

data_tags: array of string

expression: string

name: string

sensitivity_levels: array of object { group_id, level_id }

group_id: string

formatuuid

level_id: string

formatuuid

updated_at: string

formatdate-time

description: optional string

DataClassGetResponse object { id, created_at, data_tags, 5 more }

id: string

formatuuid

created_at: string

formatdate-time

data_tags: array of string

expression: string

name: string

sensitivity_levels: array of object { group_id, level_id }

group_id: string

formatuuid

level_id: string

formatuuid

updated_at: string

formatdate-time

description: optional string

DataClassCreateResponse object { id, created_at, data_tags, 5 more }

id: string

formatuuid

created_at: string

formatdate-time

data_tags: array of string

expression: string

name: string

sensitivity_levels: array of object { group_id, level_id }

group_id: string

formatuuid

level_id: string

formatuuid

updated_at: string

formatdate-time

description: optional string

DataClassUpdateResponse object { id, created_at, data_tags, 5 more }

id: string

formatuuid

created_at: string

formatdate-time

data_tags: array of string

expression: string

name: string

sensitivity_levels: array of object { group_id, level_id }

group_id: string

formatuuid

level_id: string

formatuuid

updated_at: string

formatdate-time

description: optional string

DataClassDeleteResponse = unknown