API Reference

Zero Trust

DLP

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

Entries

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

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

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: unknown

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

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

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: unknown

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

EntryUpdateResponse = object { id, created_at, enabled, 6 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, 6 more }

id: string

formatuuid

created_at: string

formatdate-time

Deprecatedenabled: boolean

name: string

pattern: Pattern { regex, validation }

type: "custom"

updated_at: string

formatdate-time

description: optional string

Deprecatedprofile_id: optional string

formatuuid

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: unknown

profile_id: optional string

formatuuid

EntryDeleteResponse = unknown

EntriesCustom

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

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

CustomDeleteResponse = unknown

CustomGetResponse = object { id, created_at, enabled, 8 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, 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

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

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: unknown

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

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

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: unknown

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"

EntriesPredefined

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

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

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: unknown

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

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

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: unknown

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"

EntriesIntegration

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

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

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: unknown

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

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

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: unknown

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"