API Reference

Zero Trust

DLP

Entries

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

Predefined

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

id: string

formatuuid

confidence: { ai_context_available, available }

ai_context_available: boolean

Indicates whether this entry has AI remote service validation.

available: boolean

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

enabled: boolean

name: string

Deprecatedprofile_id: optional string

formatuuid

variant: optional { topic_type, type, description }

topic_type: "Intent" or "Content"

One of the following:

"Intent"

"Content"

type: "PromptTopic"

description: optional string

PredefinedUpdateResponse { id, confidence, enabled, 3 more }

id: string

formatuuid

confidence: { ai_context_available, available }

ai_context_available: boolean

Indicates whether this entry has AI remote service validation.

available: boolean

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

enabled: boolean

name: string

Deprecatedprofile_id: optional string

formatuuid

variant: optional { topic_type, type, description }

topic_type: "Intent" or "Content"

One of the following:

"Intent"

"Content"

type: "PromptTopic"

description: optional string

PredefinedDeleteResponse = unknown

PredefinedGetResponse = { id, created_at, enabled, 8 more } or { id, confidence, enabled, 6 more } or { id, created_at, enabled, 6 more } or 3 more

One of the following:

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

{ id, confidence, enabled, 6 more }

id: string

formatuuid

confidence: { ai_context_available, available }

ai_context_available: boolean

Indicates whether this entry has AI remote service validation.

available: boolean

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

enabled: boolean

name: string

type: "predefined"

Deprecatedprofile_id: optional string

formatuuid

profiles: optional array of { 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 { topic_type, type, description }

topic_type: "Intent" or "Content"

One of the following:

"Intent"

"Content"

type: "PromptTopic"

description: optional string

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

{ 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

profiles: optional array of { 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"

{ 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

profiles: optional array of { 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"

{ 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 { 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 = { id, created_at, enabled, 7 more } or { id, confidence, enabled, 5 more } or { id, created_at, enabled, 5 more } or 3 more

One of the following:

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

{ id, confidence, enabled, 5 more }

id: string

formatuuid

confidence: { ai_context_available, available }

ai_context_available: boolean

Indicates whether this entry has AI remote service validation.

available: boolean

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

enabled: boolean

name: string

type: "predefined"

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

topic_type: "Intent" or "Content"

One of the following:

"Intent"

"Content"

type: "PromptTopic"

description: optional string

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

{ 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

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

One of the following:

"empty"

"uploading"

"pending"

"processing"

"failed"

"complete"

{ 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

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

One of the following:

"empty"

"uploading"

"pending"

"processing"

"failed"

"complete"

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