API Reference

Zero Trust

DLP

Entries

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

Custom

Create custom entry

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

POST/accounts/{account_id}/dlp/entries

Update custom entry

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

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

Delete custom entry

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

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

Get DLP Entry

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

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

List all entries

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

GET/accounts/{account_id}/dlp/entries

ModelsExpand Collapse

CustomCreateResponse { id, created_at, enabled, 5 more }

id: string

formatuuid

created_at: string

formatdate-time

Deprecatedenabled: boolean

name: string

pattern: Pattern { regex, validation }

updated_at: string

formatdate-time

description?: string | null

Deprecatedprofile_id?: string | null

formatuuid

CustomUpdateResponse { 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?: string | null

Deprecatedprofile_id?: string | null

formatuuid

CustomDeleteResponse = unknown

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

One of the following:

UnionMember0 { id, created_at, enabled, 8 more }

id: string

formatuuid

created_at: string

formatdate-time

Deprecatedenabled: boolean

name: string

pattern: Pattern { regex, validation }

type: "custom"

updated_at: string

formatdate-time

description?: string | null

Deprecatedprofile_id?: string | null

formatuuid

profiles?: Array<Profile>

id: string

formatuuid

name: string

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

One of the following:

"empty"

"uploading"

"pending"

"processing"

"failed"

"complete"

UnionMember1 { id, created_at, enabled, 6 more }

id: string

formatuuid

created_at: string

formatdate-time

Deprecatedenabled: boolean

name: string

type: "custom_prompt_topic"

updated_at: string

formatdate-time

description?: string | null

The optional description of the custom prompt topic entry.

profiles?: Array<Profile>

id: string

formatuuid

name: string

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

One of the following:

"empty"

"uploading"

"pending"

"processing"

"failed"

"complete"

UnionMember2 { id, confidence, enabled, 6 more }

id: string

formatuuid

confidence: Confidence { ai_context_available, available }

ai_context_available: boolean

Indicates whether this entry has AI remote service validation.

available: boolean

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

enabled: boolean

name: string

type: "predefined"

Deprecatedprofile_id?: string | null

formatuuid

profiles?: Array<Profile>

id: string

formatuuid

name: string

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

One of the following:

"empty"

"uploading"

"pending"

"processing"

"failed"

"complete"

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

A Predefined AI prompt classification topic entry.

One of the following:

UnionMember0 { topic_type, type, description }

A Predefined AI prompt classification topic entry.

topic_type: "Intent" | "Content"

One of the following:

"Intent"

"Content"

type: "PromptTopic"

description?: string | null

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

UnionMember1 { type, description }

A general predefined entry.

type: "General"

description?: string | null

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

UnionMember3 { id, created_at, enabled, 6 more }

id: string

formatuuid

created_at: string

formatdate-time

enabled: boolean

name: string

type: "integration"

updated_at: string

formatdate-time

profile_id?: string | null

formatuuid

profiles?: Array<Profile>

id: string

formatuuid

name: string

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

One of the following:

"empty"

"uploading"

"pending"

"processing"

"failed"

"complete"

UnionMember4 { id, case_sensitive, created_at, 8 more }

id: string

formatuuid

case_sensitive: boolean

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

created_at: string

formatdate-time

enabled: boolean

name: string

secret: boolean

type: "exact_data"

updated_at: string

formatdate-time

description?: string | null

The optional description of the exact data entry.

profiles?: Array<Profile>

id: string

formatuuid

name: string

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

One of the following:

"empty"

"uploading"

"pending"

"processing"

"failed"

"complete"

UnionMember5 { id, created_at, enabled, 6 more }

id: string

formatuuid

created_at: string

formatdate-time

enabled: boolean

name: string

type: "document_fingerprint"

updated_at: string

formatdate-time

description?: string | null

The optional description of the document fingerprint entry.

profiles?: Array<Profile>

id: string

formatuuid

name: string

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

One of the following:

"empty"

"uploading"

"pending"

"processing"

"failed"

"complete"

UnionMember6 { id, created_at, enabled, 7 more }

id: string

formatuuid

created_at: string

formatdate-time

enabled: boolean

name: string

type: "word_list"

updated_at: string

formatdate-time

word_list: unknown

profile_id?: string | null

formatuuid

profiles?: Array<Profile>

id: string

formatuuid

name: string

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

One of the following:

"empty"

"uploading"

"pending"

"processing"

"failed"

"complete"

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

One of the following:

UnionMember0 { id, created_at, enabled, 7 more }

id: string

formatuuid

created_at: string

formatdate-time

Deprecatedenabled: boolean

name: string

pattern: Pattern { regex, validation }

type: "custom"

updated_at: string

formatdate-time

description?: string | null

Deprecatedprofile_id?: string | null

formatuuid

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

One of the following:

"empty"

"uploading"

"pending"

"processing"

"failed"

"complete"

UnionMember1 { id, created_at, enabled, 5 more }

id: string

formatuuid

created_at: string

formatdate-time

Deprecatedenabled: boolean

name: string

type: "custom_prompt_topic"

updated_at: string

formatdate-time

description?: string | null

The optional description of the custom prompt topic entry.

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

One of the following:

"empty"

"uploading"

"pending"

"processing"

"failed"

"complete"

UnionMember2 { id, confidence, enabled, 5 more }

id: string

formatuuid

confidence: Confidence { ai_context_available, available }

ai_context_available: boolean

Indicates whether this entry has AI remote service validation.

available: boolean

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

enabled: boolean

name: string

type: "predefined"

Deprecatedprofile_id?: string | null

formatuuid

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

One of the following:

"empty"

"uploading"

"pending"

"processing"

"failed"

"complete"

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

A Predefined AI prompt classification topic entry.

One of the following:

UnionMember0 { topic_type, type, description }

A Predefined AI prompt classification topic entry.

topic_type: "Intent" | "Content"

One of the following:

"Intent"

"Content"

type: "PromptTopic"

description?: string | null

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

UnionMember1 { type, description }

A general predefined entry.

type: "General"

description?: string | null

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

UnionMember3 { id, created_at, enabled, 5 more }

id: string

formatuuid

created_at: string

formatdate-time

enabled: boolean

name: string

type: "integration"

updated_at: string

formatdate-time

profile_id?: string | null

formatuuid

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

One of the following:

"empty"

"uploading"

"pending"

"processing"

"failed"

"complete"

UnionMember4 { id, case_sensitive, created_at, 7 more }

id: string

formatuuid

case_sensitive: boolean

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

created_at: string

formatdate-time

enabled: boolean

name: string

secret: boolean

type: "exact_data"

updated_at: string

formatdate-time

description?: string | null

The optional description of the exact data entry.

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

One of the following:

"empty"

"uploading"

"pending"

"processing"

"failed"

"complete"

UnionMember5 { id, created_at, enabled, 5 more }

id: string

formatuuid

created_at: string

formatdate-time

enabled: boolean

name: string

type: "document_fingerprint"

updated_at: string

formatdate-time

description?: string | null

The optional description of the document fingerprint entry.

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

One of the following:

"empty"

"uploading"

"pending"

"processing"

"failed"

"complete"

UnionMember6 { id, created_at, enabled, 6 more }

id: string

formatuuid

created_at: string

formatdate-time

enabled: boolean

name: string

type: "word_list"

updated_at: string

formatdate-time

word_list: unknown

profile_id?: string | null

formatuuid

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

One of the following:

"empty"

"uploading"

"pending"

"processing"

"failed"

"complete"