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

zero_trust.dlp.custom_prompt_topics.list(CustomPromptTopicListParams**kwargs) -> SyncSinglePage[CustomPromptTopic]

GET/accounts/{account_id}/dlp/custom_prompt_topics

Get custom prompt topic

zero_trust.dlp.custom_prompt_topics.get(strentry_id, CustomPromptTopicGetParams**kwargs) -> CustomPromptTopic

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

Create custom prompt topic

zero_trust.dlp.custom_prompt_topics.create(CustomPromptTopicCreateParams**kwargs) -> CustomPromptTopic

POST/accounts/{account_id}/dlp/custom_prompt_topics

Update custom prompt topic

zero_trust.dlp.custom_prompt_topics.update(strentry_id, CustomPromptTopicUpdateParams**kwargs) -> CustomPromptTopic

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

Delete custom prompt topic

zero_trust.dlp.custom_prompt_topics.delete(strentry_id, CustomPromptTopicDeleteParams**kwargs) -> object

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

ModelsExpand Collapse

class CustomPromptTopic: …

id: str

formatuuid

created_at: datetime

formatdate-time

Deprecatedenabled: bool

name: str

topic: str

maxLength50

updated_at: datetime

formatdate-time

description: Optional[str]

Deprecatedprofile_id: Optional[str]

formatuuid

DLPDatasets

Fetch all datasets

zero_trust.dlp.datasets.list(DatasetListParams**kwargs) -> SyncSinglePage[Dataset]

GET/accounts/{account_id}/dlp/datasets

Fetch a specific dataset

zero_trust.dlp.datasets.get(strdataset_id, DatasetGetParams**kwargs) -> Dataset

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

Create a new dataset

zero_trust.dlp.datasets.create(DatasetCreateParams**kwargs) -> DatasetCreation

POST/accounts/{account_id}/dlp/datasets

Update details about a dataset

zero_trust.dlp.datasets.update(strdataset_id, DatasetUpdateParams**kwargs) -> Dataset

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

Delete a dataset

zero_trust.dlp.datasets.delete(strdataset_id, DatasetDeleteParams**kwargs)

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

ModelsExpand Collapse

class Dataset: …

id: str

formatuuid

columns: List[Column]

entry_id: str

formatuuid

header_name: str

num_cells: int

formatint64

upload_status: Literal["empty", "uploading", "pending", 3 more]

One of the following:

"empty"

"uploading"

"pending"

"processing"

"failed"

"complete"

created_at: datetime

formatdate-time

encoding_version: int

formatint32

minimum0

name: str

num_cells: int

formatint64

secret: bool

status: Literal["empty", "uploading", "pending", 3 more]

One of the following:

"empty"

"uploading"

"pending"

"processing"

"failed"

"complete"

updated_at: datetime

Stores when the dataset was last updated.

This includes name or description changes as well as uploads.

formatdate-time

uploads: List[Upload]

num_cells: int

formatint64

status: Literal["empty", "uploading", "pending", 3 more]

One of the following:

"empty"

"uploading"

"pending"

"processing"

"failed"

"complete"

version: int

formatint64

case_sensitive: Optional[bool]

description: Optional[str]

The description of the dataset.

List[Dataset]

id: str

formatuuid

columns: List[Column]

entry_id: str

formatuuid

header_name: str

num_cells: int

formatint64

upload_status: Literal["empty", "uploading", "pending", 3 more]

One of the following:

"empty"

"uploading"

"pending"

"processing"

"failed"

"complete"

created_at: datetime

formatdate-time

encoding_version: int

formatint32

minimum0

name: str

num_cells: int

formatint64

secret: bool

status: Literal["empty", "uploading", "pending", 3 more]

One of the following:

"empty"

"uploading"

"pending"

"processing"

"failed"

"complete"

updated_at: datetime

Stores when the dataset was last updated.

This includes name or description changes as well as uploads.

formatdate-time

uploads: List[Upload]

num_cells: int

formatint64

status: Literal["empty", "uploading", "pending", 3 more]

One of the following:

"empty"

"uploading"

"pending"

"processing"

"failed"

"complete"

version: int

formatint64

case_sensitive: Optional[bool]

description: Optional[str]

The description of the dataset.

class DatasetCreation: …

dataset: Dataset

encoding_version: int

Encoding version to use for dataset.

formatint32

minimum0

max_cells: int

formatint64

minimum0

version: int

The version to use when uploading the dataset.

formatint64

secret: Optional[str]

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

zero_trust.dlp.datasets.upload.create(strdataset_id, UploadCreateParams**kwargs) -> NewVersion

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

Upload a new version of a dataset

zero_trust.dlp.datasets.upload.edit(intversion, objectdataset, UploadEditParams**kwargs) -> Dataset

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

ModelsExpand Collapse

class NewVersion: …

encoding_version: int

formatint32

minimum0

max_cells: int

formatint64

minimum0

version: int

formatint64

case_sensitive: Optional[bool]

columns: Optional[List[Column]]

entry_id: str

formatuuid

header_name: str

num_cells: int

formatint64

upload_status: Literal["empty", "uploading", "pending", 3 more]

One of the following:

"empty"

"uploading"

"pending"

"processing"

"failed"

"complete"

secret: Optional[str]

formatpassword

DLPDatasetsVersions

Sets the column information for a multi-column upload

zero_trust.dlp.datasets.versions.create(intversion, VersionCreateParams**kwargs) -> SyncSinglePage[VersionCreateResponse]

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

ModelsExpand Collapse

class VersionCreateResponse: …

entry_id: str

formatuuid

header_name: str

num_cells: int

formatint64

upload_status: Literal["empty", "uploading", "pending", 3 more]

One of the following:

"empty"

"uploading"

"pending"

"processing"

"failed"

"complete"

DLPDatasetsVersionsEntries

Upload a new version of a multi-column dataset

zero_trust.dlp.datasets.versions.entries.create(strentry_id, objectdataset_version_entry, EntryCreateParams**kwargs) -> EntryCreateResponse

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

ModelsExpand Collapse

class EntryCreateResponse: …

entry_id: str

formatuuid

header_name: str

num_cells: int

formatint64

upload_status: Literal["empty", "uploading", "pending", 3 more]

One of the following:

"empty"

"uploading"

"pending"

"processing"

"failed"

"complete"

DLPPatterns

Validate a DLP regex pattern

zero_trust.dlp.patterns.validate(PatternValidateParams**kwargs) -> PatternValidateResponse

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

ModelsExpand Collapse

class PatternValidateResponse: …

valid: bool

DLPPayload Logs

Get payload log settings

zero_trust.dlp.payload_logs.get(PayloadLogGetParams**kwargs) -> PayloadLogGetResponse

GET/accounts/{account_id}/dlp/payload_log

Set payload log settings

zero_trust.dlp.payload_logs.update(PayloadLogUpdateParams**kwargs) -> PayloadLogUpdateResponse

PUT/accounts/{account_id}/dlp/payload_log

ModelsExpand Collapse

class PayloadLogGetResponse: …

updated_at: datetime

formatdate-time

masking_level: Optional[Literal["full", "partial", "clear", "default"]]

Masking level for payload logs.

• full: The entire payload is masked.
• partial: Only partial payload content is masked.
• clear: No masking is applied to the payload content.
• default: DLP uses its default masking behavior.

One of the following:

"full"

"partial"

"clear"

"default"

public_key: Optional[str]

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

class PayloadLogUpdateResponse: …

updated_at: datetime

formatdate-time

masking_level: Optional[Literal["full", "partial", "clear", "default"]]

Masking level for payload logs.

• full: The entire payload is masked.
• partial: Only partial payload content is masked.
• clear: No masking is applied to the payload content.
• default: DLP uses its default masking behavior.

One of the following:

"full"

"partial"

"clear"

"default"

public_key: Optional[str]

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

DLPSettings

Get DLP account-level settings.

zero_trust.dlp.settings.get(SettingGetParams**kwargs) -> DLPSettings

GET/accounts/{account_id}/dlp/settings

Update DLP account-level settings (full replacement).

zero_trust.dlp.settings.update(SettingUpdateParams**kwargs) -> DLPSettings

PUT/accounts/{account_id}/dlp/settings

Partially update DLP account-level settings.

zero_trust.dlp.settings.edit(SettingEditParams**kwargs) -> DLPSettings

PATCH/accounts/{account_id}/dlp/settings

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

zero_trust.dlp.settings.delete(SettingDeleteParams**kwargs) -> DLPSettings

DELETE/accounts/{account_id}/dlp/settings

ModelsExpand Collapse

class DLPSettings: …

DLP account-level settings response.

ai_context_analysis: bool

Whether AI context analysis is enabled at the account level.

ocr: bool

Whether OCR is enabled at the account level.

payload_logging: PayloadLogging

updated_at: datetime

formatdate-time

masking_level: Optional[Literal["full", "partial", "clear", "default"]]

Masking level for payload logs.

• full: The entire payload is masked.
• partial: Only partial payload content is masked.
• clear: No masking is applied to the payload content.
• default: DLP uses its default masking behavior.

One of the following:

"full"

"partial"

"clear"

"default"

public_key: Optional[str]

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

DLPEmail

DLPEmailAccount Mapping

Get mapping

zero_trust.dlp.email.account_mapping.get(AccountMappingGetParams**kwargs) -> AccountMappingGetResponse

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

Create mapping

zero_trust.dlp.email.account_mapping.create(AccountMappingCreateParams**kwargs) -> AccountMappingCreateResponse

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

ModelsExpand Collapse

class AccountMappingGetResponse: …

addin_identifier_token: str

formatuuid

auth_requirements: AuthRequirements

One of the following:

class AuthRequirementsUnionMember0: …

allowed_microsoft_organizations: List[str]

type: Literal["Org"]

class AuthRequirementsType: …

type: Literal["NoAuth"]

class AccountMappingCreateResponse: …

addin_identifier_token: str

formatuuid

auth_requirements: AuthRequirements

One of the following:

class AuthRequirementsUnionMember0: …

allowed_microsoft_organizations: List[str]

type: Literal["Org"]

class AuthRequirementsType: …

type: Literal["NoAuth"]

DLPEmailRules

List all email scanner rules

zero_trust.dlp.email.rules.list(RuleListParams**kwargs) -> SyncSinglePage[RuleListResponse]

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

Get an email scanner rule

zero_trust.dlp.email.rules.get(strrule_id, RuleGetParams**kwargs) -> RuleGetResponse

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

Create email scanner rule

zero_trust.dlp.email.rules.create(RuleCreateParams**kwargs) -> RuleCreateResponse

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

Update email scanner rule

zero_trust.dlp.email.rules.update(strrule_id, RuleUpdateParams**kwargs) -> RuleUpdateResponse

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

Delete email scanner rule

zero_trust.dlp.email.rules.delete(strrule_id, RuleDeleteParams**kwargs) -> RuleDeleteResponse

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

Update email scanner rule priorities

zero_trust.dlp.email.rules.bulk_edit(RuleBulkEditParams**kwargs) -> RuleBulkEditResponse

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

ModelsExpand Collapse

class RuleListResponse: …

action: Action

action: Literal["Block"]

message: Optional[str]

conditions: List[Condition]

Triggered if all conditions match.

operator: Literal["InList", "NotInList", "MatchRegex", "NotMatchRegex"]

One of the following:

"InList"

"NotInList"

"MatchRegex"

"NotMatchRegex"

selector: Literal["Recipients", "Sender", "DLPProfiles"]

One of the following:

"Recipients"

"Sender"

"DLPProfiles"

value: Union[List[str], str]

One of the following:

List[str]

str

created_at: datetime

formatdate-time

enabled: bool

name: str

priority: int

formatint32

minimum0

rule_id: str

formatuuid

updated_at: datetime

formatdate-time

description: Optional[str]

class RuleGetResponse: …

action: Action

action: Literal["Block"]

message: Optional[str]

conditions: List[Condition]

Triggered if all conditions match.

operator: Literal["InList", "NotInList", "MatchRegex", "NotMatchRegex"]

One of the following:

"InList"

"NotInList"

"MatchRegex"

"NotMatchRegex"

selector: Literal["Recipients", "Sender", "DLPProfiles"]

One of the following:

"Recipients"

"Sender"

"DLPProfiles"

value: Union[List[str], str]

One of the following:

List[str]

str

created_at: datetime

formatdate-time

enabled: bool

name: str

priority: int

formatint32

minimum0

rule_id: str

formatuuid

updated_at: datetime

formatdate-time

description: Optional[str]

class RuleCreateResponse: …

action: Action

action: Literal["Block"]

message: Optional[str]

conditions: List[Condition]

Triggered if all conditions match.

operator: Literal["InList", "NotInList", "MatchRegex", "NotMatchRegex"]

One of the following:

"InList"

"NotInList"

"MatchRegex"

"NotMatchRegex"

selector: Literal["Recipients", "Sender", "DLPProfiles"]

One of the following:

"Recipients"

"Sender"

"DLPProfiles"

value: Union[List[str], str]

One of the following:

List[str]

str

created_at: datetime

formatdate-time

enabled: bool

name: str

priority: int

formatint32

minimum0

rule_id: str

formatuuid

updated_at: datetime

formatdate-time

description: Optional[str]

class RuleUpdateResponse: …

action: Action

action: Literal["Block"]

message: Optional[str]

conditions: List[Condition]

Triggered if all conditions match.

operator: Literal["InList", "NotInList", "MatchRegex", "NotMatchRegex"]

One of the following:

"InList"

"NotInList"

"MatchRegex"

"NotMatchRegex"

selector: Literal["Recipients", "Sender", "DLPProfiles"]

One of the following:

"Recipients"

"Sender"

"DLPProfiles"

value: Union[List[str], str]

One of the following:

List[str]

str

created_at: datetime

formatdate-time

enabled: bool

name: str

priority: int

formatint32

minimum0

rule_id: str

formatuuid

updated_at: datetime

formatdate-time

description: Optional[str]

class RuleDeleteResponse: …

action: Action

action: Literal["Block"]

message: Optional[str]

conditions: List[Condition]

Triggered if all conditions match.

operator: Literal["InList", "NotInList", "MatchRegex", "NotMatchRegex"]

One of the following:

"InList"

"NotInList"

"MatchRegex"

"NotMatchRegex"

selector: Literal["Recipients", "Sender", "DLPProfiles"]

One of the following:

"Recipients"

"Sender"

"DLPProfiles"

value: Union[List[str], str]

One of the following:

List[str]

str

created_at: datetime

formatdate-time

enabled: bool

name: str

priority: int

formatint32

minimum0

rule_id: str

formatuuid

updated_at: datetime

formatdate-time

description: Optional[str]

class RuleBulkEditResponse: …

action: Action

action: Literal["Block"]

message: Optional[str]

conditions: List[Condition]

Triggered if all conditions match.

operator: Literal["InList", "NotInList", "MatchRegex", "NotMatchRegex"]

One of the following:

"InList"

"NotInList"

"MatchRegex"

"NotMatchRegex"

selector: Literal["Recipients", "Sender", "DLPProfiles"]

One of the following:

"Recipients"

"Sender"

"DLPProfiles"

value: Union[List[str], str]

One of the following:

List[str]

str

created_at: datetime

formatdate-time

enabled: bool

name: str

priority: int

formatint32

minimum0

rule_id: str

formatuuid

updated_at: datetime

formatdate-time

description: Optional[str]

DLPProfiles

List all profiles

zero_trust.dlp.profiles.list(ProfileListParams**kwargs) -> SyncSinglePage[Profile]

GET/accounts/{account_id}/dlp/profiles

Get DLP Profile

zero_trust.dlp.profiles.get(strprofile_id, ProfileGetParams**kwargs) -> Profile

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

ModelsExpand Collapse

class ContextAwareness: …

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

enabled: bool

If true, scan the context of predefined entries to only return matches surrounded by keywords.

skip: SkipConfiguration

Content types to exclude from context analysis and return all matches.

Profile

One of the following:

class CustomProfile: …

id: str

The id of the profile (uuid).

formatuuid

allowed_match_count: int

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

formatint32

maximum1000

minimum0

created_at: datetime

When the profile was created.

formatdate-time

name: str

The name of the profile.

ocr_enabled: bool

type: Literal["custom"]

updated_at: datetime

When the profile was lasted updated.

formatdate-time

ai_context_enabled: Optional[bool]

confidence_threshold: Optional[Literal["low", "medium", "high", "very_high"]]

One of the following:

"low"

"medium"

"high"

"very_high"

Deprecatedcontext_awareness: Optional[ContextAwareness]

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

data_classes: Optional[List[str]]

Data classes associated with this profile.

data_tags: Optional[List[str]]

Data tags associated with this profile.

description: Optional[str]

The description of the profile.

Deprecatedentries: Optional[List[CustomProfileEntry]]

One of the following:

class CustomProfileEntryCustomEntry: …

id: str

formatuuid

created_at: datetime

formatdate-time

Deprecatedenabled: bool

name: str

pattern: Pattern

type: Literal["custom"]

updated_at: datetime

formatdate-time

description: Optional[str]

Deprecatedprofile_id: Optional[str]

formatuuid

class CustomProfileEntryCustomPromptTopicEntry: …

id: str

formatuuid

created_at: datetime

formatdate-time

Deprecatedenabled: bool

name: str

type: Literal["custom_prompt_topic"]

updated_at: datetime

formatdate-time

description: Optional[str]

The optional description of the custom prompt topic entry.

class CustomProfileEntryPredefinedEntry: …

id: str

formatuuid

confidence: CustomProfileEntryPredefinedEntryConfidence

ai_context_available: bool

Indicates whether this entry has AI remote service validation.

available: bool

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

enabled: bool

name: str

type: Literal["predefined"]

Deprecatedprofile_id: Optional[str]

formatuuid

variant: Optional[CustomProfileEntryPredefinedEntryVariant]

A Predefined AI prompt classification topic entry.

One of the following:

class CustomProfileEntryPredefinedEntryVariantUnionMember0: …

A Predefined AI prompt classification topic entry.

topic_type: Literal["Intent", "Content"]

One of the following:

"Intent"

"Content"

type: Literal["PromptTopic"]

description: Optional[str]

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

class CustomProfileEntryPredefinedEntryVariantUnionMember1: …

A general predefined entry.

type: Literal["General"]

description: Optional[str]

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

class CustomProfileEntryIntegrationEntry: …

id: str

formatuuid

created_at: datetime

formatdate-time

enabled: bool

name: str

type: Literal["integration"]

updated_at: datetime

formatdate-time

profile_id: Optional[str]

formatuuid

class CustomProfileEntryExactDataEntry: …

id: str

formatuuid

case_sensitive: bool

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

formatdate-time

enabled: bool

name: str

secret: bool

type: Literal["exact_data"]

updated_at: datetime

formatdate-time

description: Optional[str]

The optional description of the exact data entry.

class CustomProfileEntryDocumentFingerprintEntry: …

id: str

formatuuid

created_at: datetime

formatdate-time

enabled: bool

name: str

type: Literal["document_fingerprint"]

updated_at: datetime

formatdate-time

description: Optional[str]

The optional description of the document fingerprint entry.

class CustomProfileEntryWordListEntry: …

id: str

formatuuid

created_at: datetime

formatdate-time

enabled: bool

name: str

type: Literal["word_list"]

updated_at: datetime

formatdate-time

word_list: object

profile_id: Optional[str]

formatuuid

sensitivity_levels: Optional[List[CustomProfileSensitivityLevel]]

Sensitivity levels associated with this profile.

group_id: str

formatuuid

level_id: str

formatuuid

shared_entries: Optional[List[CustomProfileSharedEntry]]

One of the following:

class CustomProfileSharedEntryCustomEntry: …

id: str

formatuuid

created_at: datetime

formatdate-time

Deprecatedenabled: bool

name: str

pattern: Pattern

type: Literal["custom"]

updated_at: datetime

formatdate-time

description: Optional[str]

Deprecatedprofile_id: Optional[str]

formatuuid

class CustomProfileSharedEntryCustomPromptTopicEntry: …

id: str

formatuuid

created_at: datetime

formatdate-time

Deprecatedenabled: bool

name: str

type: Literal["custom_prompt_topic"]

updated_at: datetime

formatdate-time

description: Optional[str]

The optional description of the custom prompt topic entry.

class CustomProfileSharedEntryPredefinedEntry: …

id: str

formatuuid

confidence: CustomProfileSharedEntryPredefinedEntryConfidence

ai_context_available: bool

Indicates whether this entry has AI remote service validation.

available: bool

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

enabled: bool

name: str

type: Literal["predefined"]

Deprecatedprofile_id: Optional[str]

formatuuid

variant: Optional[CustomProfileSharedEntryPredefinedEntryVariant]

A Predefined AI prompt classification topic entry.

One of the following:

class CustomProfileSharedEntryPredefinedEntryVariantUnionMember0: …

A Predefined AI prompt classification topic entry.

topic_type: Literal["Intent", "Content"]

One of the following:

"Intent"

"Content"

type: Literal["PromptTopic"]

description: Optional[str]

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

class CustomProfileSharedEntryPredefinedEntryVariantUnionMember1: …

A general predefined entry.

type: Literal["General"]

description: Optional[str]

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

class CustomProfileSharedEntryIntegrationEntry: …

id: str

formatuuid

created_at: datetime

formatdate-time

enabled: bool

name: str

type: Literal["integration"]

updated_at: datetime

formatdate-time

profile_id: Optional[str]

formatuuid

class CustomProfileSharedEntryExactDataEntry: …

id: str

formatuuid

case_sensitive: bool

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

formatdate-time

enabled: bool

name: str

secret: bool

type: Literal["exact_data"]

updated_at: datetime

formatdate-time

description: Optional[str]

The optional description of the exact data entry.

class CustomProfileSharedEntryDocumentFingerprintEntry: …

id: str

formatuuid

created_at: datetime

formatdate-time

enabled: bool

name: str

type: Literal["document_fingerprint"]

updated_at: datetime

formatdate-time

description: Optional[str]

The optional description of the document fingerprint entry.

class CustomProfileSharedEntryWordListEntry: …

id: str

formatuuid

created_at: datetime

formatdate-time

enabled: bool

name: str

type: Literal["word_list"]

updated_at: datetime

formatdate-time

word_list: object

profile_id: Optional[str]

formatuuid

class PredefinedProfile: …

id: str

The id of the predefined profile (uuid).

formatuuid

allowed_match_count: int

formatint32

Deprecatedentries: List[PredefinedProfileEntry]

One of the following:

class PredefinedProfileEntryCustomEntry: …

id: str

formatuuid

created_at: datetime

formatdate-time

Deprecatedenabled: bool

name: str

pattern: Pattern

type: Literal["custom"]

updated_at: datetime

formatdate-time

description: Optional[str]

Deprecatedprofile_id: Optional[str]

formatuuid

class PredefinedProfileEntryCustomPromptTopicEntry: …

id: str

formatuuid

created_at: datetime

formatdate-time

Deprecatedenabled: bool

name: str

type: Literal["custom_prompt_topic"]

updated_at: datetime

formatdate-time

description: Optional[str]

The optional description of the custom prompt topic entry.

class PredefinedProfileEntryPredefinedEntry: …

id: str

formatuuid

confidence: PredefinedProfileEntryPredefinedEntryConfidence

ai_context_available: bool

Indicates whether this entry has AI remote service validation.

available: bool

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

enabled: bool

name: str

type: Literal["predefined"]

Deprecatedprofile_id: Optional[str]

formatuuid

variant: Optional[PredefinedProfileEntryPredefinedEntryVariant]

A Predefined AI prompt classification topic entry.

One of the following:

class PredefinedProfileEntryPredefinedEntryVariantUnionMember0: …

A Predefined AI prompt classification topic entry.

topic_type: Literal["Intent", "Content"]

One of the following:

"Intent"

"Content"

type: Literal["PromptTopic"]

description: Optional[str]

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

class PredefinedProfileEntryPredefinedEntryVariantUnionMember1: …

A general predefined entry.

type: Literal["General"]

description: Optional[str]

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

class PredefinedProfileEntryIntegrationEntry: …

id: str

formatuuid

created_at: datetime

formatdate-time

enabled: bool

name: str

type: Literal["integration"]

updated_at: datetime

formatdate-time

profile_id: Optional[str]

formatuuid

class PredefinedProfileEntryExactDataEntry: …

id: str

formatuuid

case_sensitive: bool

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

formatdate-time

enabled: bool

name: str

secret: bool

type: Literal["exact_data"]

updated_at: datetime

formatdate-time

description: Optional[str]

The optional description of the exact data entry.

class PredefinedProfileEntryDocumentFingerprintEntry: …

id: str

formatuuid

created_at: datetime

formatdate-time

enabled: bool

name: str

type: Literal["document_fingerprint"]

updated_at: datetime

formatdate-time

description: Optional[str]

The optional description of the document fingerprint entry.

class PredefinedProfileEntryWordListEntry: …

id: str

formatuuid

created_at: datetime

formatdate-time

enabled: bool

name: str

type: Literal["word_list"]

updated_at: datetime

formatdate-time

word_list: object

profile_id: Optional[str]

formatuuid

name: str

The name of the predefined profile.

type: Literal["predefined"]

ai_context_enabled: Optional[bool]

confidence_threshold: Optional[Literal["low", "medium", "high", "very_high"]]

One of the following:

"low"

"medium"

"high"

"very_high"

Deprecatedcontext_awareness: Optional[ContextAwareness]

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

ocr_enabled: Optional[bool]

open_access: Optional[bool]

Whether this profile can be accessed by anyone.

class IntegrationProfile: …

id: str

formatuuid

created_at: datetime

formatdate-time

Deprecatedentries: List[IntegrationProfileEntry]

One of the following:

class IntegrationProfileEntryCustomEntry: …

id: str

formatuuid

created_at: datetime

formatdate-time

Deprecatedenabled: bool

name: str

pattern: Pattern

type: Literal["custom"]

updated_at: datetime

formatdate-time

description: Optional[str]

Deprecatedprofile_id: Optional[str]

formatuuid

class IntegrationProfileEntryCustomPromptTopicEntry: …

id: str

formatuuid

created_at: datetime

formatdate-time

Deprecatedenabled: bool

name: str

type: Literal["custom_prompt_topic"]

updated_at: datetime

formatdate-time

description: Optional[str]

The optional description of the custom prompt topic entry.

class IntegrationProfileEntryPredefinedEntry: …

id: str

formatuuid

confidence: IntegrationProfileEntryPredefinedEntryConfidence

ai_context_available: bool

Indicates whether this entry has AI remote service validation.

available: bool

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

enabled: bool

name: str

type: Literal["predefined"]

Deprecatedprofile_id: Optional[str]

formatuuid

variant: Optional[IntegrationProfileEntryPredefinedEntryVariant]

A Predefined AI prompt classification topic entry.

One of the following:

class IntegrationProfileEntryPredefinedEntryVariantUnionMember0: …

A Predefined AI prompt classification topic entry.

topic_type: Literal["Intent", "Content"]

One of the following:

"Intent"

"Content"

type: Literal["PromptTopic"]

description: Optional[str]

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

class IntegrationProfileEntryPredefinedEntryVariantUnionMember1: …

A general predefined entry.

type: Literal["General"]

description: Optional[str]

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

class IntegrationProfileEntryIntegrationEntry: …

id: str

formatuuid

created_at: datetime

formatdate-time

enabled: bool

name: str

type: Literal["integration"]

updated_at: datetime

formatdate-time

profile_id: Optional[str]

formatuuid

class IntegrationProfileEntryExactDataEntry: …

id: str

formatuuid

case_sensitive: bool

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

formatdate-time

enabled: bool

name: str

secret: bool

type: Literal["exact_data"]

updated_at: datetime

formatdate-time

description: Optional[str]

The optional description of the exact data entry.

class IntegrationProfileEntryDocumentFingerprintEntry: …

id: str

formatuuid

created_at: datetime

formatdate-time

enabled: bool

name: str

type: Literal["document_fingerprint"]

updated_at: datetime

formatdate-time

description: Optional[str]

The optional description of the document fingerprint entry.

class IntegrationProfileEntryWordListEntry: …

id: str

formatuuid

created_at: datetime

formatdate-time

enabled: bool

name: str

type: Literal["word_list"]

updated_at: datetime

formatdate-time

word_list: object

profile_id: Optional[str]

formatuuid

name: str

shared_entries: List[IntegrationProfileSharedEntry]

One of the following:

class IntegrationProfileSharedEntryCustomEntry: …

id: str

formatuuid

created_at: datetime

formatdate-time

Deprecatedenabled: bool

name: str

pattern: Pattern

type: Literal["custom"]

updated_at: datetime

formatdate-time

description: Optional[str]

Deprecatedprofile_id: Optional[str]

formatuuid

class IntegrationProfileSharedEntryCustomPromptTopicEntry: …

id: str

formatuuid

created_at: datetime

formatdate-time

Deprecatedenabled: bool

name: str

type: Literal["custom_prompt_topic"]

updated_at: datetime

formatdate-time

description: Optional[str]

The optional description of the custom prompt topic entry.

class IntegrationProfileSharedEntryPredefinedEntry: …

id: str

formatuuid

confidence: IntegrationProfileSharedEntryPredefinedEntryConfidence

ai_context_available: bool

Indicates whether this entry has AI remote service validation.

available: bool

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

enabled: bool

name: str

type: Literal["predefined"]

Deprecatedprofile_id: Optional[str]

formatuuid

variant: Optional[IntegrationProfileSharedEntryPredefinedEntryVariant]

A Predefined AI prompt classification topic entry.

One of the following:

class IntegrationProfileSharedEntryPredefinedEntryVariantUnionMember0: …

A Predefined AI prompt classification topic entry.

topic_type: Literal["Intent", "Content"]

One of the following:

"Intent"

"Content"

type: Literal["PromptTopic"]

description: Optional[str]

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

class IntegrationProfileSharedEntryPredefinedEntryVariantUnionMember1: …

A general predefined entry.

type: Literal["General"]

description: Optional[str]

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

class IntegrationProfileSharedEntryIntegrationEntry: …

id: str

formatuuid

created_at: datetime

formatdate-time

enabled: bool

name: str

type: Literal["integration"]

updated_at: datetime

formatdate-time

profile_id: Optional[str]

formatuuid

class IntegrationProfileSharedEntryExactDataEntry: …

id: str

formatuuid

case_sensitive: bool

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

formatdate-time

enabled: bool

name: str

secret: bool

type: Literal["exact_data"]

updated_at: datetime

formatdate-time

description: Optional[str]

The optional description of the exact data entry.

class IntegrationProfileSharedEntryDocumentFingerprintEntry: …

id: str

formatuuid

created_at: datetime

formatdate-time

enabled: bool

name: str

type: Literal["document_fingerprint"]

updated_at: datetime

formatdate-time

description: Optional[str]

The optional description of the document fingerprint entry.

class IntegrationProfileSharedEntryWordListEntry: …

id: str

formatuuid

created_at: datetime

formatdate-time

enabled: bool

name: str

type: Literal["word_list"]

updated_at: datetime

formatdate-time

word_list: object

profile_id: Optional[str]

formatuuid

type: Literal["integration"]

updated_at: datetime

formatdate-time

description: Optional[str]

The description of the profile.

class SkipConfiguration: …

Content types to exclude from context analysis and return all matches.

files: bool

If the content type is a file, skip context analysis and return all matches.

DLPProfilesCustom

Get custom profile

zero_trust.dlp.profiles.custom.get(strprofile_id, CustomGetParams**kwargs) -> Profile

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

Create custom profile

zero_trust.dlp.profiles.custom.create(CustomCreateParams**kwargs) -> Profile

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

Update custom profile

zero_trust.dlp.profiles.custom.update(strprofile_id, CustomUpdateParams**kwargs) -> Profile

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

Delete custom profile

zero_trust.dlp.profiles.custom.delete(strprofile_id, CustomDeleteParams**kwargs) -> object

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

ModelsExpand Collapse

class CustomProfile: …

id: str

The id of the profile (uuid).

formatuuid

allowed_match_count: int

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

formatint32

maximum1000

minimum0

created_at: datetime

When the profile was created.

formatdate-time

name: str

The name of the profile.

ocr_enabled: bool

updated_at: datetime

When the profile was lasted updated.

formatdate-time

ai_context_enabled: Optional[bool]

confidence_threshold: Optional[Literal["low", "medium", "high", "very_high"]]

One of the following:

"low"

"medium"

"high"

"very_high"

Deprecatedcontext_awareness: Optional[ContextAwareness]

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

data_classes: Optional[List[str]]

Data classes associated with this profile.

data_tags: Optional[List[str]]

Data tags associated with this profile.

description: Optional[str]

The description of the profile.

Deprecatedentries: Optional[List[Entry]]

One of the following:

class EntryCustomEntry: …

id: str

formatuuid

created_at: datetime

formatdate-time

Deprecatedenabled: bool

name: str

pattern: Pattern

type: Literal["custom"]

updated_at: datetime

formatdate-time

description: Optional[str]

Deprecatedprofile_id: Optional[str]

formatuuid

class EntryCustomPromptTopicEntry: …

id: str

formatuuid

created_at: datetime

formatdate-time

Deprecatedenabled: bool

name: str

type: Literal["custom_prompt_topic"]

updated_at: datetime

formatdate-time

description: Optional[str]

The optional description of the custom prompt topic entry.

class EntryPredefinedEntry: …

id: str

formatuuid

confidence: EntryPredefinedEntryConfidence

ai_context_available: bool

Indicates whether this entry has AI remote service validation.

available: bool

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

enabled: bool

name: str

type: Literal["predefined"]

Deprecatedprofile_id: Optional[str]

formatuuid

variant: Optional[EntryPredefinedEntryVariant]

A Predefined AI prompt classification topic entry.

One of the following:

class EntryPredefinedEntryVariantUnionMember0: …

A Predefined AI prompt classification topic entry.

topic_type: Literal["Intent", "Content"]

One of the following:

"Intent"

"Content"

type: Literal["PromptTopic"]

description: Optional[str]

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

class EntryPredefinedEntryVariantUnionMember1: …

A general predefined entry.

type: Literal["General"]

description: Optional[str]

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

class EntryIntegrationEntry: …

id: str

formatuuid

created_at: datetime

formatdate-time

enabled: bool

name: str

type: Literal["integration"]

updated_at: datetime

formatdate-time

profile_id: Optional[str]

formatuuid

class EntryExactDataEntry: …

id: str

formatuuid

case_sensitive: bool

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

formatdate-time

enabled: bool

name: str

secret: bool

type: Literal["exact_data"]

updated_at: datetime

formatdate-time

description: Optional[str]

The optional description of the exact data entry.

class EntryDocumentFingerprintEntry: …

id: str

formatuuid

created_at: datetime

formatdate-time

enabled: bool

name: str

type: Literal["document_fingerprint"]

updated_at: datetime

formatdate-time

description: Optional[str]

The optional description of the document fingerprint entry.

class EntryWordListEntry: …

id: str

formatuuid

created_at: datetime

formatdate-time

enabled: bool

name: str

type: Literal["word_list"]

updated_at: datetime

formatdate-time

word_list: object

profile_id: Optional[str]

formatuuid

sensitivity_levels: Optional[List[SensitivityLevel]]

Sensitivity levels associated with this profile.

group_id: str

formatuuid

level_id: str

formatuuid

shared_entries: Optional[List[SharedEntry]]

One of the following:

class SharedEntryCustomEntry: …

id: str

formatuuid

created_at: datetime

formatdate-time

Deprecatedenabled: bool

name: str

pattern: Pattern

type: Literal["custom"]

updated_at: datetime

formatdate-time

description: Optional[str]

Deprecatedprofile_id: Optional[str]

formatuuid

class SharedEntryCustomPromptTopicEntry: …

id: str

formatuuid

created_at: datetime

formatdate-time

Deprecatedenabled: bool

name: str

type: Literal["custom_prompt_topic"]

updated_at: datetime

formatdate-time

description: Optional[str]

The optional description of the custom prompt topic entry.

class SharedEntryPredefinedEntry: …

id: str

formatuuid

confidence: SharedEntryPredefinedEntryConfidence

ai_context_available: bool

Indicates whether this entry has AI remote service validation.

available: bool

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

enabled: bool

name: str

type: Literal["predefined"]

Deprecatedprofile_id: Optional[str]

formatuuid

variant: Optional[SharedEntryPredefinedEntryVariant]

A Predefined AI prompt classification topic entry.

One of the following:

class SharedEntryPredefinedEntryVariantUnionMember0: …

A Predefined AI prompt classification topic entry.

topic_type: Literal["Intent", "Content"]

One of the following:

"Intent"

"Content"

type: Literal["PromptTopic"]

description: Optional[str]

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

class SharedEntryPredefinedEntryVariantUnionMember1: …

A general predefined entry.

type: Literal["General"]

description: Optional[str]

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

class SharedEntryIntegrationEntry: …

id: str

formatuuid

created_at: datetime

formatdate-time

enabled: bool

name: str

type: Literal["integration"]

updated_at: datetime

formatdate-time

profile_id: Optional[str]

formatuuid

class SharedEntryExactDataEntry: …

id: str

formatuuid

case_sensitive: bool

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

formatdate-time

enabled: bool

name: str

secret: bool

type: Literal["exact_data"]

updated_at: datetime

formatdate-time

description: Optional[str]

The optional description of the exact data entry.

class SharedEntryDocumentFingerprintEntry: …

id: str

formatuuid

created_at: datetime

formatdate-time

enabled: bool

name: str

type: Literal["document_fingerprint"]

updated_at: datetime

formatdate-time

description: Optional[str]

The optional description of the document fingerprint entry.

class SharedEntryWordListEntry: …

id: str

formatuuid

created_at: datetime

formatdate-time

enabled: bool

name: str

type: Literal["word_list"]

updated_at: datetime

formatdate-time

word_list: object

profile_id: Optional[str]

formatuuid

class Pattern: …

regex: str

Deprecatedvalidation: Optional[Literal["luhn"]]

DLPProfilesPredefined

Get predefined profile config

zero_trust.dlp.profiles.predefined.get(strprofile_id, PredefinedGetParams**kwargs) -> PredefinedProfile

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

Update predefined profile config

zero_trust.dlp.profiles.predefined.update(strprofile_id, PredefinedUpdateParams**kwargs) -> PredefinedProfile

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

Delete predefined profile

zero_trust.dlp.profiles.predefined.delete(strprofile_id, PredefinedDeleteParams**kwargs) -> object

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

ModelsExpand Collapse

class PredefinedProfile: …

id: str

The id of the predefined profile (uuid).

formatuuid

allowed_match_count: int

formatint32

confidence_threshold: Optional[str]

enabled_entries: List[str]

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

Deprecatedentries: List[Entry]

This field has been deprecated for enabled_entries.

One of the following:

class EntryCustomEntry: …

id: str

formatuuid

created_at: datetime

formatdate-time

Deprecatedenabled: bool

name: str

pattern: Pattern

type: Literal["custom"]

updated_at: datetime

formatdate-time

description: Optional[str]

Deprecatedprofile_id: Optional[str]

formatuuid

class EntryCustomPromptTopicEntry: …

id: str

formatuuid

created_at: datetime

formatdate-time

Deprecatedenabled: bool

name: str

type: Literal["custom_prompt_topic"]

updated_at: datetime

formatdate-time

description: Optional[str]

The optional description of the custom prompt topic entry.

class EntryPredefinedEntry: …

id: str

formatuuid

confidence: EntryPredefinedEntryConfidence

ai_context_available: bool

Indicates whether this entry has AI remote service validation.

available: bool

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

enabled: bool

name: str

type: Literal["predefined"]

Deprecatedprofile_id: Optional[str]

formatuuid

variant: Optional[EntryPredefinedEntryVariant]

A Predefined AI prompt classification topic entry.

One of the following:

class EntryPredefinedEntryVariantUnionMember0: …

A Predefined AI prompt classification topic entry.

topic_type: Literal["Intent", "Content"]

One of the following:

"Intent"

"Content"

type: Literal["PromptTopic"]

description: Optional[str]

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

class EntryPredefinedEntryVariantUnionMember1: …

A general predefined entry.

type: Literal["General"]

description: Optional[str]

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

class EntryIntegrationEntry: …

id: str

formatuuid

created_at: datetime

formatdate-time

enabled: bool

name: str

type: Literal["integration"]

updated_at: datetime

formatdate-time

profile_id: Optional[str]

formatuuid

class EntryExactDataEntry: …

id: str

formatuuid

case_sensitive: bool

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

formatdate-time

enabled: bool

name: str

secret: bool

type: Literal["exact_data"]

updated_at: datetime

formatdate-time

description: Optional[str]

The optional description of the exact data entry.

class EntryDocumentFingerprintEntry: …

id: str

formatuuid

created_at: datetime

formatdate-time

enabled: bool

name: str

type: Literal["document_fingerprint"]

updated_at: datetime

formatdate-time

description: Optional[str]

The optional description of the document fingerprint entry.

class EntryWordListEntry: …

id: str

formatuuid

created_at: datetime

formatdate-time

enabled: bool

name: str

type: Literal["word_list"]

updated_at: datetime

formatdate-time

word_list: object

profile_id: Optional[str]

formatuuid

name: str

The name of the predefined profile.

ai_context_enabled: Optional[bool]

ocr_enabled: Optional[bool]

open_access: Optional[bool]

Whether this profile can be accessed by anyone.

DLPLimits

Fetch limits associated with DLP for account

zero_trust.dlp.limits.list(LimitListParams**kwargs) -> LimitListResponse

GET/accounts/{account_id}/dlp/limits

ModelsExpand Collapse

class LimitListResponse: …

max_custom_regex_entries: int

Maximum number of custom regex entries allowed for the account.

formatint64

minimum0

max_dataset_cells: int

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

formatint64

minimum0

max_document_fingerprints: int

Maximum number of document fingerprints allowed for the account.

formatint64

minimum0

used_custom_regex_entries: int

Number of custom regex entries currently configured for the account.

formatint64

minimum0

used_dataset_cells: int

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

Number of document fingerprints currently configured for the account.

formatint64

minimum0

DLPEntries

List all entries

zero_trust.dlp.entries.list(EntryListParams**kwargs) -> SyncSinglePage[EntryListResponse]

GET/accounts/{account_id}/dlp/entries

Get DLP Entry

zero_trust.dlp.entries.get(strentry_id, EntryGetParams**kwargs) -> EntryGetResponse

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

Create custom entry

zero_trust.dlp.entries.create(EntryCreateParams**kwargs) -> EntryCreateResponse

POST/accounts/{account_id}/dlp/entries

Update entry

zero_trust.dlp.entries.update(strentry_id, EntryUpdateParams**kwargs) -> EntryUpdateResponse

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

Delete custom entry

zero_trust.dlp.entries.delete(strentry_id, EntryDeleteParams**kwargs) -> object

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

ModelsExpand Collapse

EntryListResponse

One of the following:

class UnionMember0: …

id: str

formatuuid

created_at: datetime

formatdate-time

Deprecatedenabled: bool

name: str

pattern: Pattern

type: Literal["custom"]

updated_at: datetime

formatdate-time

description: Optional[str]

Deprecatedprofile_id: Optional[str]

formatuuid

upload_status: Optional[Literal["empty", "uploading", "pending", 3 more]]

One of the following:

"empty"

"uploading"

"pending"

"processing"

"failed"

"complete"

class UnionMember1: …

id: str

formatuuid

created_at: datetime

formatdate-time

Deprecatedenabled: bool

name: str

type: Literal["custom_prompt_topic"]

updated_at: datetime

formatdate-time

description: Optional[str]

The optional description of the custom prompt topic entry.

upload_status: Optional[Literal["empty", "uploading", "pending", 3 more]]

One of the following:

"empty"

"uploading"

"pending"

"processing"

"failed"

"complete"

class UnionMember2: …

id: str

formatuuid

confidence: UnionMember2Confidence

ai_context_available: bool

Indicates whether this entry has AI remote service validation.

available: bool

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

enabled: bool

name: str

type: Literal["predefined"]

Deprecatedprofile_id: Optional[str]

formatuuid

upload_status: Optional[Literal["empty", "uploading", "pending", 3 more]]

One of the following:

"empty"

"uploading"

"pending"

"processing"

"failed"

"complete"

variant: Optional[UnionMember2Variant]

A Predefined AI prompt classification topic entry.

One of the following:

class UnionMember2VariantUnionMember0: …

A Predefined AI prompt classification topic entry.

topic_type: Literal["Intent", "Content"]

One of the following:

"Intent"

"Content"

type: Literal["PromptTopic"]

description: Optional[str]

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

class UnionMember2VariantUnionMember1: …

A general predefined entry.

type: Literal["General"]

description: Optional[str]

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

class UnionMember3: …

id: str

formatuuid

created_at: datetime

formatdate-time

enabled: bool

name: str

type: Literal["integration"]

updated_at: datetime

formatdate-time

profile_id: Optional[str]

formatuuid

upload_status: Optional[Literal["empty", "uploading", "pending", 3 more]]

One of the following:

"empty"

"uploading"

"pending"

"processing"

"failed"

"complete"

class UnionMember4: …

id: str

formatuuid

case_sensitive: bool

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

formatdate-time

enabled: bool

name: str

secret: bool

type: Literal["exact_data"]

updated_at: datetime

formatdate-time

description: Optional[str]

The optional description of the exact data entry.

upload_status: Optional[Literal["empty", "uploading", "pending", 3 more]]

One of the following:

"empty"

"uploading"

"pending"

"processing"

"failed"

"complete"

class UnionMember5: …

id: str

formatuuid

created_at: datetime

formatdate-time

enabled: bool

name: str

type: Literal["document_fingerprint"]

updated_at: datetime

formatdate-time

description: Optional[str]

The optional description of the document fingerprint entry.

upload_status: Optional[Literal["empty", "uploading", "pending", 3 more]]

One of the following:

"empty"

"uploading"

"pending"

"processing"

"failed"

"complete"

class UnionMember6: …

id: str

formatuuid

created_at: datetime

formatdate-time

enabled: bool

name: str

type: Literal["word_list"]

updated_at: datetime

formatdate-time

word_list: object

profile_id: Optional[str]

formatuuid

upload_status: Optional[Literal["empty", "uploading", "pending", 3 more]]

One of the following:

"empty"

"uploading"

"pending"

"processing"

"failed"

"complete"

EntryGetResponse

One of the following:

class UnionMember0: …

id: str

formatuuid

created_at: datetime

formatdate-time

Deprecatedenabled: bool

name: str

pattern: Pattern

type: Literal["custom"]

updated_at: datetime

formatdate-time

description: Optional[str]

Deprecatedprofile_id: Optional[str]

formatuuid

profiles: Optional[List[UnionMember0Profile]]

id: str

formatuuid

name: str

upload_status: Optional[Literal["empty", "uploading", "pending", 3 more]]

One of the following:

"empty"

"uploading"

"pending"

"processing"

"failed"

"complete"

class UnionMember1: …

id: str

formatuuid

created_at: datetime

formatdate-time

Deprecatedenabled: bool

name: str

type: Literal["custom_prompt_topic"]

updated_at: datetime

formatdate-time

description: Optional[str]

The optional description of the custom prompt topic entry.

profiles: Optional[List[UnionMember1Profile]]

id: str

formatuuid

name: str

upload_status: Optional[Literal["empty", "uploading", "pending", 3 more]]

One of the following:

"empty"

"uploading"

"pending"

"processing"

"failed"

"complete"

class UnionMember2: …

id: str

formatuuid

confidence: UnionMember2Confidence

ai_context_available: bool

Indicates whether this entry has AI remote service validation.

available: bool

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

enabled: bool

name: str

type: Literal["predefined"]

Deprecatedprofile_id: Optional[str]

formatuuid

profiles: Optional[List[UnionMember2Profile]]

id: str

formatuuid

name: str

upload_status: Optional[Literal["empty", "uploading", "pending", 3 more]]

One of the following:

"empty"

"uploading"

"pending"

"processing"

"failed"

"complete"

variant: Optional[UnionMember2Variant]

A Predefined AI prompt classification topic entry.

One of the following:

class UnionMember2VariantUnionMember0: …

A Predefined AI prompt classification topic entry.

topic_type: Literal["Intent", "Content"]

One of the following:

"Intent"

"Content"

type: Literal["PromptTopic"]

description: Optional[str]

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

class UnionMember2VariantUnionMember1: …

A general predefined entry.

type: Literal["General"]

description: Optional[str]

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

class UnionMember3: …

id: str

formatuuid

created_at: datetime

formatdate-time

enabled: bool

name: str

type: Literal["integration"]

updated_at: datetime

formatdate-time

profile_id: Optional[str]

formatuuid

profiles: Optional[List[UnionMember3Profile]]

id: str

formatuuid

name: str

upload_status: Optional[Literal["empty", "uploading", "pending", 3 more]]

One of the following:

"empty"

"uploading"

"pending"

"processing"

"failed"

"complete"

class UnionMember4: …

id: str

formatuuid

case_sensitive: bool

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

formatdate-time

enabled: bool

name: str

secret: bool

type: Literal["exact_data"]

updated_at: datetime

formatdate-time

description: Optional[str]

The optional description of the exact data entry.

profiles: Optional[List[UnionMember4Profile]]

id: str

formatuuid

name: str

upload_status: Optional[Literal["empty", "uploading", "pending", 3 more]]

One of the following:

"empty"

"uploading"

"pending"

"processing"

"failed"

"complete"

class UnionMember5: …

id: str

formatuuid

created_at: datetime

formatdate-time

enabled: bool

name: str

type: Literal["document_fingerprint"]

updated_at: datetime

formatdate-time

description: Optional[str]

The optional description of the document fingerprint entry.

profiles: Optional[List[UnionMember5Profile]]

id: str

formatuuid

name: str

upload_status: Optional[Literal["empty", "uploading", "pending", 3 more]]

One of the following:

"empty"

"uploading"

"pending"

"processing"

"failed"

"complete"

class UnionMember6: …

id: str

formatuuid

created_at: datetime

formatdate-time

enabled: bool

name: str

type: Literal["word_list"]

updated_at: datetime

formatdate-time

word_list: object

profile_id: Optional[str]

formatuuid

profiles: Optional[List[UnionMember6Profile]]

id: str

formatuuid

name: str

upload_status: Optional[Literal["empty", "uploading", "pending", 3 more]]

One of the following:

"empty"

"uploading"

"pending"

"processing"

"failed"

"complete"

class EntryCreateResponse: …

id: str

formatuuid

created_at: datetime

formatdate-time

Deprecatedenabled: bool

name: str

pattern: Pattern

updated_at: datetime

formatdate-time

description: Optional[str]

Deprecatedprofile_id: Optional[str]

formatuuid

EntryUpdateResponse

One of the following:

class CustomEntry: …

id: str

formatuuid

created_at: datetime

formatdate-time

Deprecatedenabled: bool

name: str

pattern: Pattern

type: Literal["custom"]

updated_at: datetime

formatdate-time

description: Optional[str]

Deprecatedprofile_id: Optional[str]

formatuuid

class CustomPromptTopicEntry: …

id: str

formatuuid

created_at: datetime

formatdate-time

Deprecatedenabled: bool

name: str

type: Literal["custom_prompt_topic"]

updated_at: datetime

formatdate-time

description: Optional[str]

The optional description of the custom prompt topic entry.

class PredefinedEntry: …

id: str

formatuuid

confidence: PredefinedEntryConfidence

ai_context_available: bool

Indicates whether this entry has AI remote service validation.

available: bool

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

enabled: bool

name: str

type: Literal["predefined"]

Deprecatedprofile_id: Optional[str]

formatuuid

variant: Optional[PredefinedEntryVariant]

A Predefined AI prompt classification topic entry.

One of the following:

class PredefinedEntryVariantUnionMember0: …

A Predefined AI prompt classification topic entry.

topic_type: Literal["Intent", "Content"]

One of the following:

"Intent"

"Content"

type: Literal["PromptTopic"]

description: Optional[str]

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

class PredefinedEntryVariantUnionMember1: …

A general predefined entry.

type: Literal["General"]

description: Optional[str]

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

class IntegrationEntry: …

id: str

formatuuid

created_at: datetime

formatdate-time

enabled: bool

name: str

type: Literal["integration"]

updated_at: datetime

formatdate-time

profile_id: Optional[str]

formatuuid

class ExactDataEntry: …

id: str

formatuuid

case_sensitive: bool

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

formatdate-time

enabled: bool

name: str

secret: bool

type: Literal["exact_data"]

updated_at: datetime

formatdate-time

description: Optional[str]

The optional description of the exact data entry.

class DocumentFingerprintEntry: …

id: str

formatuuid

created_at: datetime

formatdate-time

enabled: bool

name: str

type: Literal["document_fingerprint"]

updated_at: datetime

formatdate-time

description: Optional[str]

The optional description of the document fingerprint entry.

class WordListEntry: …

id: str

formatuuid

created_at: datetime

formatdate-time

enabled: bool

name: str

type: Literal["word_list"]

updated_at: datetime

formatdate-time

word_list: object

profile_id: Optional[str]

formatuuid

DLPEntriesCustom

Create custom entry

zero_trust.dlp.entries.custom.create(CustomCreateParams**kwargs) -> CustomCreateResponse

POST/accounts/{account_id}/dlp/entries

Update custom entry

zero_trust.dlp.entries.custom.update(strentry_id, CustomUpdateParams**kwargs) -> CustomUpdateResponse

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

Delete custom entry

zero_trust.dlp.entries.custom.delete(strentry_id, CustomDeleteParams**kwargs) -> object

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

Get DLP Entry

zero_trust.dlp.entries.custom.get(strentry_id, CustomGetParams**kwargs) -> CustomGetResponse

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

List all entries

zero_trust.dlp.entries.custom.list(CustomListParams**kwargs) -> SyncSinglePage[CustomListResponse]

GET/accounts/{account_id}/dlp/entries

ModelsExpand Collapse

class CustomCreateResponse: …

id: str

formatuuid

created_at: datetime

formatdate-time

Deprecatedenabled: bool

name: str

pattern: Pattern

updated_at: datetime

formatdate-time

description: Optional[str]

Deprecatedprofile_id: Optional[str]

formatuuid

class CustomUpdateResponse: …

id: str

formatuuid

created_at: datetime

formatdate-time

Deprecatedenabled: bool

name: str

pattern: Pattern

updated_at: datetime

formatdate-time

description: Optional[str]

Deprecatedprofile_id: Optional[str]

formatuuid

CustomGetResponse

One of the following:

class UnionMember0: …

id: str

formatuuid

created_at: datetime

formatdate-time

Deprecatedenabled: bool

name: str

pattern: Pattern

type: Literal["custom"]

updated_at: datetime

formatdate-time

description: Optional[str]

Deprecatedprofile_id: Optional[str]

formatuuid

profiles: Optional[List[UnionMember0Profile]]

id: str

formatuuid

name: str

upload_status: Optional[Literal["empty", "uploading", "pending", 3 more]]

One of the following:

"empty"

"uploading"

"pending"

"processing"

"failed"

"complete"

class UnionMember1: …

id: str

formatuuid

created_at: datetime

formatdate-time

Deprecatedenabled: bool

name: str

type: Literal["custom_prompt_topic"]

updated_at: datetime

formatdate-time

description: Optional[str]

The optional description of the custom prompt topic entry.

profiles: Optional[List[UnionMember1Profile]]

id: str

formatuuid

name: str

upload_status: Optional[Literal["empty", "uploading", "pending", 3 more]]

One of the following:

"empty"

"uploading"

"pending"

"processing"

"failed"

"complete"

class UnionMember2: …

id: str

formatuuid

confidence: UnionMember2Confidence

ai_context_available: bool

Indicates whether this entry has AI remote service validation.

available: bool

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

enabled: bool

name: str

type: Literal["predefined"]

Deprecatedprofile_id: Optional[str]

formatuuid

profiles: Optional[List[UnionMember2Profile]]

id: str

formatuuid

name: str

upload_status: Optional[Literal["empty", "uploading", "pending", 3 more]]

One of the following:

"empty"

"uploading"

"pending"

"processing"

"failed"

"complete"

variant: Optional[UnionMember2Variant]

A Predefined AI prompt classification topic entry.

One of the following:

class UnionMember2VariantUnionMember0: …

A Predefined AI prompt classification topic entry.

topic_type: Literal["Intent", "Content"]

One of the following:

"Intent"

"Content"

type: Literal["PromptTopic"]

description: Optional[str]

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

class UnionMember2VariantUnionMember1: …

A general predefined entry.

type: Literal["General"]

description: Optional[str]

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

class UnionMember3: …

id: str

formatuuid

created_at: datetime

formatdate-time

enabled: bool

name: str

type: Literal["integration"]

updated_at: datetime

formatdate-time

profile_id: Optional[str]

formatuuid

profiles: Optional[List[UnionMember3Profile]]

id: str

formatuuid

name: str

upload_status: Optional[Literal["empty", "uploading", "pending", 3 more]]

One of the following:

"empty"

"uploading"

"pending"

"processing"

"failed"

"complete"

class UnionMember4: …

id: str

formatuuid

case_sensitive: bool

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

formatdate-time

enabled: bool

name: str

secret: bool

type: Literal["exact_data"]

updated_at: datetime

formatdate-time

description: Optional[str]

The optional description of the exact data entry.

profiles: Optional[List[UnionMember4Profile]]

id: str

formatuuid

name: str

upload_status: Optional[Literal["empty", "uploading", "pending", 3 more]]

One of the following:

"empty"

"uploading"

"pending"

"processing"

"failed"

"complete"

class UnionMember5: …

id: str

formatuuid

created_at: datetime

formatdate-time

enabled: bool

name: str

type: Literal["document_fingerprint"]

updated_at: datetime

formatdate-time

description: Optional[str]

The optional description of the document fingerprint entry.

profiles: Optional[List[UnionMember5Profile]]

id: str

formatuuid

name: str

upload_status: Optional[Literal["empty", "uploading", "pending", 3 more]]

One of the following:

"empty"

"uploading"

"pending"

"processing"

"failed"

"complete"

class UnionMember6: …

id: str

formatuuid

created_at: datetime

formatdate-time

enabled: bool

name: str

type: Literal["word_list"]

updated_at: datetime

formatdate-time

word_list: object

profile_id: Optional[str]

formatuuid

profiles: Optional[List[UnionMember6Profile]]

id: str

formatuuid

name: str

upload_status: Optional[Literal["empty", "uploading", "pending", 3 more]]

One of the following:

"empty"

"uploading"

"pending"

"processing"

"failed"

"complete"

CustomListResponse

One of the following:

class UnionMember0: …

id: str

formatuuid

created_at: datetime

formatdate-time

Deprecatedenabled: bool

name: str

pattern: Pattern

type: Literal["custom"]

updated_at: datetime

formatdate-time

description: Optional[str]

Deprecatedprofile_id: Optional[str]

formatuuid

upload_status: Optional[Literal["empty", "uploading", "pending", 3 more]]

One of the following:

"empty"

"uploading"

"pending"

"processing"

"failed"

"complete"

class UnionMember1: …

id: str

formatuuid

created_at: datetime

formatdate-time

Deprecatedenabled: bool

name: str

type: Literal["custom_prompt_topic"]

updated_at: datetime

formatdate-time

description: Optional[str]

The optional description of the custom prompt topic entry.

upload_status: Optional[Literal["empty", "uploading", "pending", 3 more]]

One of the following:

"empty"

"uploading"

"pending"

"processing"

"failed"

"complete"

class UnionMember2: …

id: str

formatuuid

confidence: UnionMember2Confidence

ai_context_available: bool

Indicates whether this entry has AI remote service validation.

available: bool

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

enabled: bool

name: str

type: Literal["predefined"]

Deprecatedprofile_id: Optional[str]

formatuuid

upload_status: Optional[Literal["empty", "uploading", "pending", 3 more]]

One of the following:

"empty"

"uploading"

"pending"

"processing"

"failed"

"complete"

variant: Optional[UnionMember2Variant]

A Predefined AI prompt classification topic entry.

One of the following:

class UnionMember2VariantUnionMember0: …

A Predefined AI prompt classification topic entry.

topic_type: Literal["Intent", "Content"]

One of the following:

"Intent"

"Content"

type: Literal["PromptTopic"]

description: Optional[str]

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

class UnionMember2VariantUnionMember1: …

A general predefined entry.

type: Literal["General"]

description: Optional[str]

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

class UnionMember3: …

id: str

formatuuid

created_at: datetime

formatdate-time

enabled: bool

name: str

type: Literal["integration"]

updated_at: datetime

formatdate-time

profile_id: Optional[str]

formatuuid

upload_status: Optional[Literal["empty", "uploading", "pending", 3 more]]

One of the following:

"empty"

"uploading"

"pending"

"processing"

"failed"

"complete"

class UnionMember4: …

id: str

formatuuid

case_sensitive: bool

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

formatdate-time

enabled: bool

name: str

secret: bool

type: Literal["exact_data"]

updated_at: datetime

formatdate-time

description: Optional[str]

The optional description of the exact data entry.

upload_status: Optional[Literal["empty", "uploading", "pending", 3 more]]

One of the following:

"empty"

"uploading"

"pending"

"processing"

"failed"

"complete"

class UnionMember5: …

id: str

formatuuid

created_at: datetime

formatdate-time

enabled: bool

name: str

type: Literal["document_fingerprint"]

updated_at: datetime

formatdate-time

description: Optional[str]

The optional description of the document fingerprint entry.

upload_status: Optional[Literal["empty", "uploading", "pending", 3 more]]

One of the following:

"empty"

"uploading"

"pending"

"processing"

"failed"

"complete"

class UnionMember6: …

id: str

formatuuid

created_at: datetime

formatdate-time

enabled: bool

name: str

type: Literal["word_list"]

updated_at: datetime

formatdate-time

word_list: object

profile_id: Optional[str]

formatuuid

upload_status: Optional[Literal["empty", "uploading", "pending", 3 more]]

One of the following:

"empty"

"uploading"

"pending"

"processing"

"failed"

"complete"

DLPEntriesPredefined

Create predefined entry

zero_trust.dlp.entries.predefined.create(PredefinedCreateParams**kwargs) -> PredefinedCreateResponse

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

Update predefined entry

zero_trust.dlp.entries.predefined.update(strentry_id, PredefinedUpdateParams**kwargs) -> PredefinedUpdateResponse

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

Delete predefined entry

zero_trust.dlp.entries.predefined.delete(strentry_id, PredefinedDeleteParams**kwargs) -> object

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

Get DLP Entry

zero_trust.dlp.entries.predefined.get(strentry_id, PredefinedGetParams**kwargs) -> PredefinedGetResponse

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

List all entries

zero_trust.dlp.entries.predefined.list(PredefinedListParams**kwargs) -> SyncSinglePage[PredefinedListResponse]

GET/accounts/{account_id}/dlp/entries

ModelsExpand Collapse

class PredefinedCreateResponse: …

id: str

formatuuid

confidence: Confidence

ai_context_available: bool

Indicates whether this entry has AI remote service validation.

available: bool

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

enabled: bool

name: str

Deprecatedprofile_id: Optional[str]

formatuuid

variant: Optional[Variant]

A Predefined AI prompt classification topic entry.

One of the following:

class VariantUnionMember0: …

A Predefined AI prompt classification topic entry.

topic_type: Literal["Intent", "Content"]

One of the following:

"Intent"

"Content"

type: Literal["PromptTopic"]

description: Optional[str]

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

class VariantUnionMember1: …

A general predefined entry.

type: Literal["General"]

description: Optional[str]

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

class PredefinedUpdateResponse: …

id: str

formatuuid

confidence: Confidence

ai_context_available: bool

Indicates whether this entry has AI remote service validation.

available: bool

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

enabled: bool

name: str

Deprecatedprofile_id: Optional[str]

formatuuid

variant: Optional[Variant]

A Predefined AI prompt classification topic entry.

One of the following:

class VariantUnionMember0: …

A Predefined AI prompt classification topic entry.

topic_type: Literal["Intent", "Content"]

One of the following:

"Intent"

"Content"

type: Literal["PromptTopic"]

description: Optional[str]

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

class VariantUnionMember1: …

A general predefined entry.

type: Literal["General"]

description: Optional[str]

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

PredefinedGetResponse

One of the following:

class UnionMember0: …

id: str

formatuuid

created_at: datetime

formatdate-time

Deprecatedenabled: bool

name: str

pattern: Pattern

type: Literal["custom"]

updated_at: datetime

formatdate-time

description: Optional[str]

Deprecatedprofile_id: Optional[str]

formatuuid

profiles: Optional[List[UnionMember0Profile]]

id: str

formatuuid

name: str

upload_status: Optional[Literal["empty", "uploading", "pending", 3 more]]

One of the following:

"empty"

"uploading"

"pending"

"processing"

"failed"

"complete"

class UnionMember1: …

id: str

formatuuid

created_at: datetime

formatdate-time

Deprecatedenabled: bool

name: str

type: Literal["custom_prompt_topic"]

updated_at: datetime

formatdate-time

description: Optional[str]

The optional description of the custom prompt topic entry.

profiles: Optional[List[UnionMember1Profile]]

id: str

formatuuid

name: str

upload_status: Optional[Literal["empty", "uploading", "pending", 3 more]]

One of the following:

"empty"

"uploading"

"pending"

"processing"

"failed"

"complete"

class UnionMember2: …

id: str

formatuuid

confidence: UnionMember2Confidence

ai_context_available: bool

Indicates whether this entry has AI remote service validation.

available: bool

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

enabled: bool

name: str

type: Literal["predefined"]

Deprecatedprofile_id: Optional[str]

formatuuid

profiles: Optional[List[UnionMember2Profile]]

id: str

formatuuid

name: str

upload_status: Optional[Literal["empty", "uploading", "pending", 3 more]]

One of the following:

"empty"

"uploading"

"pending"

"processing"

"failed"

"complete"

variant: Optional[UnionMember2Variant]

A Predefined AI prompt classification topic entry.

One of the following:

class UnionMember2VariantUnionMember0: …

A Predefined AI prompt classification topic entry.

topic_type: Literal["Intent", "Content"]

One of the following:

"Intent"

"Content"

type: Literal["PromptTopic"]

description: Optional[str]

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

class UnionMember2VariantUnionMember1: …

A general predefined entry.

type: Literal["General"]

description: Optional[str]

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

class UnionMember3: …

id: str

formatuuid

created_at: datetime

formatdate-time

enabled: bool

name: str

type: Literal["integration"]

updated_at: datetime

formatdate-time

profile_id: Optional[str]

formatuuid

profiles: Optional[List[UnionMember3Profile]]

id: str

formatuuid

name: str

upload_status: Optional[Literal["empty", "uploading", "pending", 3 more]]

One of the following:

"empty"

"uploading"

"pending"

"processing"

"failed"

"complete"

class UnionMember4: …

id: str

formatuuid

case_sensitive: bool

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

formatdate-time

enabled: bool

name: str

secret: bool

type: Literal["exact_data"]

updated_at: datetime

formatdate-time

description: Optional[str]

The optional description of the exact data entry.

profiles: Optional[List[UnionMember4Profile]]

id: str

formatuuid

name: str

upload_status: Optional[Literal["empty", "uploading", "pending", 3 more]]

One of the following:

"empty"

"uploading"

"pending"

"processing"

"failed"

"complete"

class UnionMember5: …

id: str

formatuuid

created_at: datetime

formatdate-time

enabled: bool

name: str

type: Literal["document_fingerprint"]

updated_at: datetime

formatdate-time

description: Optional[str]

The optional description of the document fingerprint entry.

profiles: Optional[List[UnionMember5Profile]]

id: str

formatuuid

name: str

upload_status: Optional[Literal["empty", "uploading", "pending", 3 more]]

One of the following:

"empty"

"uploading"

"pending"

"processing"

"failed"

"complete"

class UnionMember6: …

id: str

formatuuid

created_at: datetime

formatdate-time

enabled: bool

name: str

type: Literal["word_list"]

updated_at: datetime

formatdate-time

word_list: object

profile_id: Optional[str]

formatuuid

profiles: Optional[List[UnionMember6Profile]]

id: str

formatuuid

name: str

upload_status: Optional[Literal["empty", "uploading", "pending", 3 more]]

One of the following:

"empty"

"uploading"

"pending"

"processing"

"failed"

"complete"

PredefinedListResponse

One of the following:

class UnionMember0: …

id: str

formatuuid

created_at: datetime

formatdate-time

Deprecatedenabled: bool

name: str

pattern: Pattern

type: Literal["custom"]

updated_at: datetime

formatdate-time

description: Optional[str]

Deprecatedprofile_id: Optional[str]

formatuuid

upload_status: Optional[Literal["empty", "uploading", "pending", 3 more]]

One of the following:

"empty"

"uploading"

"pending"

"processing"

"failed"

"complete"

class UnionMember1: …

id: str

formatuuid

created_at: datetime

formatdate-time

Deprecatedenabled: bool

name: str

type: Literal["custom_prompt_topic"]

updated_at: datetime

formatdate-time

description: Optional[str]

The optional description of the custom prompt topic entry.

upload_status: Optional[Literal["empty", "uploading", "pending", 3 more]]

One of the following:

"empty"

"uploading"

"pending"

"processing"

"failed"

"complete"

class UnionMember2: …

id: str

formatuuid

confidence: UnionMember2Confidence

ai_context_available: bool

Indicates whether this entry has AI remote service validation.

available: bool

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

enabled: bool

name: str

type: Literal["predefined"]

Deprecatedprofile_id: Optional[str]

formatuuid

upload_status: Optional[Literal["empty", "uploading", "pending", 3 more]]

One of the following:

"empty"

"uploading"

"pending"

"processing"

"failed"

"complete"

variant: Optional[UnionMember2Variant]

A Predefined AI prompt classification topic entry.

One of the following:

class UnionMember2VariantUnionMember0: …

A Predefined AI prompt classification topic entry.

topic_type: Literal["Intent", "Content"]

One of the following:

"Intent"

"Content"

type: Literal["PromptTopic"]

description: Optional[str]

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

class UnionMember2VariantUnionMember1: …

A general predefined entry.

type: Literal["General"]

description: Optional[str]

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

class UnionMember3: …

id: str

formatuuid

created_at: datetime

formatdate-time

enabled: bool

name: str

type: Literal["integration"]

updated_at: datetime

formatdate-time

profile_id: Optional[str]

formatuuid

upload_status: Optional[Literal["empty", "uploading", "pending", 3 more]]

One of the following:

"empty"

"uploading"

"pending"

"processing"

"failed"

"complete"

class UnionMember4: …

id: str

formatuuid

case_sensitive: bool

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

formatdate-time

enabled: bool

name: str

secret: bool

type: Literal["exact_data"]

updated_at: datetime

formatdate-time

description: Optional[str]

The optional description of the exact data entry.

upload_status: Optional[Literal["empty", "uploading", "pending", 3 more]]

One of the following:

"empty"

"uploading"

"pending"

"processing"

"failed"

"complete"

class UnionMember5: …

id: str

formatuuid

created_at: datetime

formatdate-time

enabled: bool

name: str

type: Literal["document_fingerprint"]

updated_at: datetime

formatdate-time

description: Optional[str]

The optional description of the document fingerprint entry.

upload_status: Optional[Literal["empty", "uploading", "pending", 3 more]]

One of the following:

"empty"

"uploading"

"pending"

"processing"

"failed"

"complete"

class UnionMember6: …

id: str

formatuuid

created_at: datetime

formatdate-time

enabled: bool

name: str

type: Literal["word_list"]

updated_at: datetime

formatdate-time

word_list: object

profile_id: Optional[str]

formatuuid

upload_status: Optional[Literal["empty", "uploading", "pending", 3 more]]

One of the following:

"empty"

"uploading"

"pending"

"processing"

"failed"

"complete"

DLPEntriesIntegration

Create integration entry

zero_trust.dlp.entries.integration.create(IntegrationCreateParams**kwargs) -> IntegrationCreateResponse

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

Update integration entry

zero_trust.dlp.entries.integration.update(strentry_id, IntegrationUpdateParams**kwargs) -> IntegrationUpdateResponse

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

Delete integration entry

zero_trust.dlp.entries.integration.delete(strentry_id, IntegrationDeleteParams**kwargs) -> object

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

Get DLP Entry

zero_trust.dlp.entries.integration.get(strentry_id, IntegrationGetParams**kwargs) -> IntegrationGetResponse

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

List all entries

zero_trust.dlp.entries.integration.list(IntegrationListParams**kwargs) -> SyncSinglePage[IntegrationListResponse]

GET/accounts/{account_id}/dlp/entries

ModelsExpand Collapse

class IntegrationCreateResponse: …

id: str

formatuuid

created_at: datetime

formatdate-time

enabled: bool

name: str

updated_at: datetime

formatdate-time

profile_id: Optional[str]

formatuuid

class IntegrationUpdateResponse: …

id: str

formatuuid

created_at: datetime

formatdate-time

enabled: bool

name: str

updated_at: datetime

formatdate-time

profile_id: Optional[str]

formatuuid

IntegrationGetResponse

One of the following:

class UnionMember0: …

id: str

formatuuid

created_at: datetime

formatdate-time

Deprecatedenabled: bool

name: str

pattern: Pattern

type: Literal["custom"]

updated_at: datetime

formatdate-time

description: Optional[str]

Deprecatedprofile_id: Optional[str]

formatuuid

profiles: Optional[List[UnionMember0Profile]]

id: str

formatuuid

name: str

upload_status: Optional[Literal["empty", "uploading", "pending", 3 more]]

One of the following:

"empty"

"uploading"

"pending"

"processing"

"failed"

"complete"

class UnionMember1: …

id: str

formatuuid

created_at: datetime

formatdate-time

Deprecatedenabled: bool

name: str

type: Literal["custom_prompt_topic"]

updated_at: datetime

formatdate-time

description: Optional[str]

The optional description of the custom prompt topic entry.

profiles: Optional[List[UnionMember1Profile]]

id: str

formatuuid

name: str

upload_status: Optional[Literal["empty", "uploading", "pending", 3 more]]

One of the following:

"empty"

"uploading"

"pending"

"processing"

"failed"

"complete"

class UnionMember2: …

id: str

formatuuid

confidence: UnionMember2Confidence

ai_context_available: bool

Indicates whether this entry has AI remote service validation.

available: bool

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

enabled: bool

name: str

type: Literal["predefined"]

Deprecatedprofile_id: Optional[str]

formatuuid

profiles: Optional[List[UnionMember2Profile]]

id: str

formatuuid

name: str

upload_status: Optional[Literal["empty", "uploading", "pending", 3 more]]

One of the following:

"empty"

"uploading"

"pending"

"processing"

"failed"

"complete"

variant: Optional[UnionMember2Variant]

A Predefined AI prompt classification topic entry.

One of the following:

class UnionMember2VariantUnionMember0: …

A Predefined AI prompt classification topic entry.

topic_type: Literal["Intent", "Content"]

One of the following:

"Intent"

"Content"

type: Literal["PromptTopic"]

description: Optional[str]

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

class UnionMember2VariantUnionMember1: …

A general predefined entry.

type: Literal["General"]

description: Optional[str]

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

class UnionMember3: …

id: str

formatuuid

created_at: datetime

formatdate-time

enabled: bool

name: str

type: Literal["integration"]

updated_at: datetime

formatdate-time

profile_id: Optional[str]

formatuuid

profiles: Optional[List[UnionMember3Profile]]

id: str

formatuuid

name: str

upload_status: Optional[Literal["empty", "uploading", "pending", 3 more]]

One of the following:

"empty"

"uploading"

"pending"

"processing"

"failed"

"complete"

class UnionMember4: …

id: str

formatuuid

case_sensitive: bool

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

formatdate-time

enabled: bool

name: str

secret: bool

type: Literal["exact_data"]

updated_at: datetime

formatdate-time

description: Optional[str]

The optional description of the exact data entry.

profiles: Optional[List[UnionMember4Profile]]

id: str

formatuuid

name: str

upload_status: Optional[Literal["empty", "uploading", "pending", 3 more]]

One of the following:

"empty"

"uploading"

"pending"

"processing"

"failed"

"complete"

class UnionMember5: …

id: str

formatuuid

created_at: datetime

formatdate-time

enabled: bool

name: str

type: Literal["document_fingerprint"]

updated_at: datetime

formatdate-time

description: Optional[str]

The optional description of the document fingerprint entry.

profiles: Optional[List[UnionMember5Profile]]

id: str

formatuuid

name: str

upload_status: Optional[Literal["empty", "uploading", "pending", 3 more]]

One of the following:

"empty"

"uploading"

"pending"

"processing"

"failed"

"complete"

class UnionMember6: …

id: str

formatuuid

created_at: datetime

formatdate-time

enabled: bool

name: str

type: Literal["word_list"]

updated_at: datetime

formatdate-time

word_list: object

profile_id: Optional[str]

formatuuid

profiles: Optional[List[UnionMember6Profile]]

id: str

formatuuid

name: str

upload_status: Optional[Literal["empty", "uploading", "pending", 3 more]]

One of the following:

"empty"

"uploading"

"pending"

"processing"

"failed"

"complete"

IntegrationListResponse

One of the following:

class UnionMember0: …

id: str

formatuuid

created_at: datetime

formatdate-time

Deprecatedenabled: bool

name: str

pattern: Pattern

type: Literal["custom"]

updated_at: datetime

formatdate-time

description: Optional[str]

Deprecatedprofile_id: Optional[str]

formatuuid

upload_status: Optional[Literal["empty", "uploading", "pending", 3 more]]

One of the following:

"empty"

"uploading"

"pending"

"processing"

"failed"

"complete"

class UnionMember1: …

id: str

formatuuid

created_at: datetime

formatdate-time

Deprecatedenabled: bool

name: str

type: Literal["custom_prompt_topic"]

updated_at: datetime

formatdate-time

description: Optional[str]

The optional description of the custom prompt topic entry.

upload_status: Optional[Literal["empty", "uploading", "pending", 3 more]]

One of the following:

"empty"

"uploading"

"pending"

"processing"

"failed"

"complete"

class UnionMember2: …

id: str

formatuuid

confidence: UnionMember2Confidence

ai_context_available: bool

Indicates whether this entry has AI remote service validation.

available: bool

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

enabled: bool

name: str

type: Literal["predefined"]

Deprecatedprofile_id: Optional[str]

formatuuid

upload_status: Optional[Literal["empty", "uploading", "pending", 3 more]]

One of the following:

"empty"

"uploading"

"pending"

"processing"

"failed"

"complete"

variant: Optional[UnionMember2Variant]

A Predefined AI prompt classification topic entry.

One of the following:

class UnionMember2VariantUnionMember0: …

A Predefined AI prompt classification topic entry.

topic_type: Literal["Intent", "Content"]

One of the following:

"Intent"

"Content"

type: Literal["PromptTopic"]

description: Optional[str]

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

class UnionMember2VariantUnionMember1: …

A general predefined entry.

type: Literal["General"]

description: Optional[str]

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

class UnionMember3: …

id: str

formatuuid

created_at: datetime

formatdate-time

enabled: bool

name: str

type: Literal["integration"]

updated_at: datetime

formatdate-time

profile_id: Optional[str]

formatuuid

upload_status: Optional[Literal["empty", "uploading", "pending", 3 more]]

One of the following:

"empty"

"uploading"

"pending"

"processing"

"failed"

"complete"

class UnionMember4: …

id: str

formatuuid

case_sensitive: bool

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

formatdate-time

enabled: bool

name: str

secret: bool

type: Literal["exact_data"]

updated_at: datetime

formatdate-time

description: Optional[str]

The optional description of the exact data entry.

upload_status: Optional[Literal["empty", "uploading", "pending", 3 more]]

One of the following:

"empty"

"uploading"

"pending"

"processing"

"failed"

"complete"

class UnionMember5: …

id: str

formatuuid

created_at: datetime

formatdate-time

enabled: bool

name: str

type: Literal["document_fingerprint"]

updated_at: datetime

formatdate-time

description: Optional[str]

The optional description of the document fingerprint entry.

upload_status: Optional[Literal["empty", "uploading", "pending", 3 more]]

One of the following:

"empty"

"uploading"

"pending"

"processing"

"failed"

"complete"

class UnionMember6: …

id: str

formatuuid

created_at: datetime

formatdate-time

enabled: bool

name: str

type: Literal["word_list"]

updated_at: datetime

formatdate-time

word_list: object

profile_id: Optional[str]

formatuuid

upload_status: Optional[Literal["empty", "uploading", "pending", 3 more]]

One of the following:

"empty"

"uploading"

"pending"

"processing"

"failed"

"complete"

DLPSensitivity Groups

Retrieve all sensitivity groups in an account

zero_trust.dlp.sensitivity_groups.list(SensitivityGroupListParams**kwargs) -> SyncSinglePage[SensitivityGroupListResponse]

GET/accounts/{account_id}/dlp/sensitivity_groups

Retrieve a specific sensitivity group.

zero_trust.dlp.sensitivity_groups.get(strsensitivity_group_id, SensitivityGroupGetParams**kwargs) -> SensitivityGroupGetResponse

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

Creates a new sensitivity group.

zero_trust.dlp.sensitivity_groups.create(SensitivityGroupCreateParams**kwargs) -> SensitivityGroupCreateResponse

POST/accounts/{account_id}/dlp/sensitivity_groups

Update the attributes of a single sensitivity group.

zero_trust.dlp.sensitivity_groups.update(strsensitivity_group_id, SensitivityGroupUpdateParams**kwargs) -> SensitivityGroupUpdateResponse

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

Delete a single sensitivity group.

zero_trust.dlp.sensitivity_groups.delete(strsensitivity_group_id, SensitivityGroupDeleteParams**kwargs) -> object

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

ModelsExpand Collapse

class SensitivityGroupListResponse: …

id: str

formatuuid

created_at: datetime

formatdate-time

levels: List[Level]

id: str

formatuuid

created_at: datetime

formatdate-time

name: str

updated_at: datetime

formatdate-time

description: Optional[str]

name: str

updated_at: datetime

formatdate-time

description: Optional[str]

template_id: Optional[str]

formatuuid

class SensitivityGroupGetResponse: …

id: str

formatuuid

created_at: datetime

formatdate-time

levels: List[Level]

id: str

formatuuid

created_at: datetime

formatdate-time

name: str

updated_at: datetime

formatdate-time

description: Optional[str]

name: str

updated_at: datetime

formatdate-time

description: Optional[str]

template_id: Optional[str]

formatuuid

class SensitivityGroupCreateResponse: …

id: str

formatuuid

created_at: datetime

formatdate-time

levels: List[Level]

id: str

formatuuid

created_at: datetime

formatdate-time

name: str

updated_at: datetime

formatdate-time

description: Optional[str]

name: str

updated_at: datetime

formatdate-time

description: Optional[str]

template_id: Optional[str]

formatuuid

class SensitivityGroupUpdateResponse: …

id: str

formatuuid

created_at: datetime

formatdate-time

levels: List[Level]

id: str

formatuuid

created_at: datetime

formatdate-time

name: str

updated_at: datetime

formatdate-time

description: Optional[str]

name: str

updated_at: datetime

formatdate-time

description: Optional[str]

template_id: Optional[str]

formatuuid

DLPSensitivity GroupsLevels

Retrieve all sensitivity levels in a sensitivity group

zero_trust.dlp.sensitivity_groups.levels.list(strsensitivity_group_id, LevelListParams**kwargs) -> SyncSinglePage[LevelListResponse]

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

Retrieve a specific sensitivity level.

zero_trust.dlp.sensitivity_groups.levels.get(strsensitivity_level_id, LevelGetParams**kwargs) -> LevelGetResponse

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

Creates a new sensitivity level.

zero_trust.dlp.sensitivity_groups.levels.create(strsensitivity_group_id, LevelCreateParams**kwargs) -> LevelCreateResponse

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

Update the attributes of a single sensitivity level.

zero_trust.dlp.sensitivity_groups.levels.update(strsensitivity_level_id, LevelUpdateParams**kwargs) -> LevelUpdateResponse

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

Delete a single sensitivity level.

zero_trust.dlp.sensitivity_groups.levels.delete(strsensitivity_level_id, LevelDeleteParams**kwargs) -> object

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

ModelsExpand Collapse

class LevelListResponse: …

id: str

formatuuid

created_at: datetime

formatdate-time

name: str

updated_at: datetime

formatdate-time

description: Optional[str]

class LevelGetResponse: …

id: str

formatuuid

created_at: datetime

formatdate-time

name: str

updated_at: datetime

formatdate-time

description: Optional[str]

class LevelCreateResponse: …

id: str

formatuuid

created_at: datetime

formatdate-time

name: str

updated_at: datetime

formatdate-time

description: Optional[str]

class LevelUpdateResponse: …

id: str

formatuuid

created_at: datetime

formatdate-time

name: str

updated_at: datetime

formatdate-time

description: Optional[str]

DLPSensitivity GroupsLevelsOrder

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

zero_trust.dlp.sensitivity_groups.levels.order.get(strsensitivity_group_id, OrderGetParams**kwargs) -> OrderGetResponse

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

Set the ordering of levels within a sensitivity group.

zero_trust.dlp.sensitivity_groups.levels.order.update(strsensitivity_group_id, OrderUpdateParams**kwargs) -> OrderUpdateResponse

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

ModelsExpand Collapse

class OrderGetResponse: …

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: List[str]

class OrderUpdateResponse: …

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: List[str]

DLPData Tag Categories

Retrieve all data tag categories in an account

zero_trust.dlp.data_tag_categories.list(DataTagCategoryListParams**kwargs) -> SyncSinglePage[DataTagCategoryListResponse]

GET/accounts/{account_id}/dlp/data_tag_categories

Retrieve a specific data tag category.

zero_trust.dlp.data_tag_categories.get(strcategory_id, DataTagCategoryGetParams**kwargs) -> DataTagCategoryGetResponse

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

Creates a new data tag category.

zero_trust.dlp.data_tag_categories.create(DataTagCategoryCreateParams**kwargs) -> DataTagCategoryCreateResponse

POST/accounts/{account_id}/dlp/data_tag_categories

Update the attributes of a single data tag category.

zero_trust.dlp.data_tag_categories.update(strcategory_id, DataTagCategoryUpdateParams**kwargs) -> DataTagCategoryUpdateResponse

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

Delete a single data tag category.

zero_trust.dlp.data_tag_categories.delete(strcategory_id, DataTagCategoryDeleteParams**kwargs) -> object

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

ModelsExpand Collapse

class DataTagCategoryListResponse: …

id: str

formatuuid

created_at: datetime

formatdate-time

name: str

tags: List[Tag]

id: str

formatuuid

created_at: datetime

formatdate-time

name: str

updated_at: datetime

formatdate-time

description: Optional[str]

updated_at: datetime

formatdate-time

description: Optional[str]

template_id: Optional[str]

formatuuid

class DataTagCategoryGetResponse: …

id: str

formatuuid

created_at: datetime

formatdate-time

name: str

tags: List[Tag]

id: str

formatuuid

created_at: datetime

formatdate-time

name: str

updated_at: datetime

formatdate-time

description: Optional[str]

updated_at: datetime

formatdate-time

description: Optional[str]

template_id: Optional[str]

formatuuid

class DataTagCategoryCreateResponse: …

id: str

formatuuid

created_at: datetime

formatdate-time

name: str

tags: List[Tag]

id: str

formatuuid

created_at: datetime

formatdate-time

name: str

updated_at: datetime

formatdate-time

description: Optional[str]

updated_at: datetime

formatdate-time

description: Optional[str]

template_id: Optional[str]

formatuuid

class DataTagCategoryUpdateResponse: …

id: str

formatuuid

created_at: datetime

formatdate-time

name: str

tags: List[Tag]

id: str

formatuuid

created_at: datetime

formatdate-time

name: str

updated_at: datetime

formatdate-time

description: Optional[str]

updated_at: datetime

formatdate-time

description: Optional[str]

template_id: Optional[str]

formatuuid

DLPData Tag CategoriesData Tags

Retrieve all data tags in a data tag category

zero_trust.dlp.data_tag_categories.data_tags.list(strcategory_id, DataTagListParams**kwargs) -> SyncSinglePage[DataTagListResponse]

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

Retrieve a specific data tag.

zero_trust.dlp.data_tag_categories.data_tags.get(strtag_id, DataTagGetParams**kwargs) -> DataTagGetResponse

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

Creates a new data tag.

zero_trust.dlp.data_tag_categories.data_tags.create(strcategory_id, DataTagCreateParams**kwargs) -> DataTagCreateResponse

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

Update the attributes of a single data tag.

zero_trust.dlp.data_tag_categories.data_tags.update(strtag_id, DataTagUpdateParams**kwargs) -> DataTagUpdateResponse

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

Delete a single data tag.

zero_trust.dlp.data_tag_categories.data_tags.delete(strtag_id, DataTagDeleteParams**kwargs) -> object

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

ModelsExpand Collapse

class DataTagListResponse: …

id: str

formatuuid

created_at: datetime

formatdate-time

name: str

updated_at: datetime

formatdate-time

description: Optional[str]

class DataTagGetResponse: …

id: str

formatuuid

created_at: datetime

formatdate-time

name: str

updated_at: datetime

formatdate-time

description: Optional[str]

class DataTagCreateResponse: …

id: str

formatuuid

created_at: datetime

formatdate-time

name: str

updated_at: datetime

formatdate-time

description: Optional[str]

class DataTagUpdateResponse: …

id: str

formatuuid

created_at: datetime

formatdate-time

name: str

updated_at: datetime

formatdate-time

description: Optional[str]

DLPData Classes

Retrieve all data classes in an account

zero_trust.dlp.data_classes.list(DataClassListParams**kwargs) -> SyncSinglePage[DataClassListResponse]

GET/accounts/{account_id}/dlp/data_classes

Retrieve a specific data class

zero_trust.dlp.data_classes.get(strdata_class_id, DataClassGetParams**kwargs) -> DataClassGetResponse

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

Creates a new data class

zero_trust.dlp.data_classes.create(DataClassCreateParams**kwargs) -> DataClassCreateResponse

POST/accounts/{account_id}/dlp/data_classes

Update the attributes of a single data class

zero_trust.dlp.data_classes.update(strdata_class_id, DataClassUpdateParams**kwargs) -> DataClassUpdateResponse

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

Delete a single data class

zero_trust.dlp.data_classes.delete(strdata_class_id, DataClassDeleteParams**kwargs) -> object

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

ModelsExpand Collapse

class DataClassListResponse: …

id: str

formatuuid

created_at: datetime

formatdate-time

data_tags: List[str]

expression: str

name: str

sensitivity_levels: List[SensitivityLevel]

group_id: str

formatuuid

level_id: str

formatuuid

updated_at: datetime

formatdate-time

description: Optional[str]

class DataClassGetResponse: …

id: str

formatuuid

created_at: datetime

formatdate-time

data_tags: List[str]

expression: str

name: str

sensitivity_levels: List[SensitivityLevel]

group_id: str

formatuuid

level_id: str

formatuuid

updated_at: datetime

formatdate-time

description: Optional[str]

class DataClassCreateResponse: …

id: str

formatuuid

created_at: datetime

formatdate-time

data_tags: List[str]

expression: str

name: str

sensitivity_levels: List[SensitivityLevel]

group_id: str

formatuuid

level_id: str

formatuuid

updated_at: datetime

formatdate-time

description: Optional[str]

class DataClassUpdateResponse: …

id: str

formatuuid

created_at: datetime

formatdate-time

data_tags: List[str]

expression: str

name: str

sensitivity_levels: List[SensitivityLevel]

group_id: str

formatuuid

level_id: str

formatuuid

updated_at: datetime

formatdate-time

description: Optional[str]