Skip to content
Cloudflare API
Start here
API Reference
Zero Trust

DLP

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.

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.

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 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]
topic_type: Literal["Intent", "Content"]
One of the following:
"Intent"
"Content"
type: Literal["PromptTopic"]
description: Optional[str]
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
class CustomProfileEntryDocumentFingerprintEntry: …
id: str
formatuuid
created_at: datetime
formatdate-time
enabled: bool
name: str
type: Literal["document_fingerprint"]
updated_at: datetime
formatdate-time
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[List[str]]]

Sensitivity levels associated with this profile as (group_id, level_id) tuples.

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 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]
topic_type: Literal["Intent", "Content"]
One of the following:
"Intent"
"Content"
type: Literal["PromptTopic"]
description: Optional[str]
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
class CustomProfileSharedEntryDocumentFingerprintEntry: …
id: str
formatuuid
created_at: datetime
formatdate-time
enabled: bool
name: str
type: Literal["document_fingerprint"]
updated_at: datetime
formatdate-time
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 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]
topic_type: Literal["Intent", "Content"]
One of the following:
"Intent"
"Content"
type: Literal["PromptTopic"]
description: Optional[str]
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
class PredefinedProfileEntryDocumentFingerprintEntry: …
id: str
formatuuid
created_at: datetime
formatdate-time
enabled: bool
name: str
type: Literal["document_fingerprint"]
updated_at: datetime
formatdate-time
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 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]
topic_type: Literal["Intent", "Content"]
One of the following:
"Intent"
"Content"
type: Literal["PromptTopic"]
description: Optional[str]
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
class IntegrationProfileEntryDocumentFingerprintEntry: …
id: str
formatuuid
created_at: datetime
formatdate-time
enabled: bool
name: str
type: Literal["document_fingerprint"]
updated_at: datetime
formatdate-time
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 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]
topic_type: Literal["Intent", "Content"]
One of the following:
"Intent"
"Content"
type: Literal["PromptTopic"]
description: Optional[str]
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
class IntegrationProfileSharedEntryDocumentFingerprintEntry: …
id: str
formatuuid
created_at: datetime
formatdate-time
enabled: bool
name: str
type: Literal["document_fingerprint"]
updated_at: datetime
formatdate-time
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 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]
topic_type: Literal["Intent", "Content"]
One of the following:
"Intent"
"Content"
type: Literal["PromptTopic"]
description: Optional[str]
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
class EntryDocumentFingerprintEntry: …
id: str
formatuuid
created_at: datetime
formatdate-time
enabled: bool
name: str
type: Literal["document_fingerprint"]
updated_at: datetime
formatdate-time
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[List[str]]]

Sensitivity levels associated with this profile as (group_id, level_id) tuples.

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 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]
topic_type: Literal["Intent", "Content"]
One of the following:
"Intent"
"Content"
type: Literal["PromptTopic"]
description: Optional[str]
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
class SharedEntryDocumentFingerprintEntry: …
id: str
formatuuid
created_at: datetime
formatdate-time
enabled: bool
name: str
type: Literal["document_fingerprint"]
updated_at: datetime
formatdate-time
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 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]
topic_type: Literal["Intent", "Content"]
One of the following:
"Intent"
"Content"
type: Literal["PromptTopic"]
description: Optional[str]
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
class EntryDocumentFingerprintEntry: …
id: str
formatuuid
created_at: datetime
formatdate-time
enabled: bool
name: str
type: Literal["document_fingerprint"]
updated_at: datetime
formatdate-time
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_dataset_cells: int
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
confidence: UnionMember1Confidence
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[UnionMember1Variant]
topic_type: Literal["Intent", "Content"]
One of the following:
"Intent"
"Content"
type: Literal["PromptTopic"]
description: Optional[str]
class UnionMember2: …
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 UnionMember3: …
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
upload_status: Optional[Literal["empty", "uploading", "pending", 3 more]]
One of the following:
"empty"
"uploading"
"pending"
"processing"
"failed"
"complete"
class UnionMember4: …
id: str
formatuuid
created_at: datetime
formatdate-time
enabled: bool
name: str
type: Literal["document_fingerprint"]
updated_at: datetime
formatdate-time
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["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
confidence: UnionMember1Confidence
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[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"
variant: Optional[UnionMember1Variant]
topic_type: Literal["Intent", "Content"]
One of the following:
"Intent"
"Content"
type: Literal["PromptTopic"]
description: Optional[str]
class UnionMember2: …
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[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"
class UnionMember3: …
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
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
created_at: datetime
formatdate-time
enabled: bool
name: str
type: Literal["document_fingerprint"]
updated_at: datetime
formatdate-time
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["word_list"]
updated_at: datetime
formatdate-time
word_list: object
profile_id: Optional[str]
formatuuid
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 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 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]
topic_type: Literal["Intent", "Content"]
One of the following:
"Intent"
"Content"
type: Literal["PromptTopic"]
description: Optional[str]
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
class DocumentFingerprintEntry: …
id: str
formatuuid
created_at: datetime
formatdate-time
enabled: bool
name: str
type: Literal["document_fingerprint"]
updated_at: datetime
formatdate-time
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
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
confidence: UnionMember1Confidence
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[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"
variant: Optional[UnionMember1Variant]
topic_type: Literal["Intent", "Content"]
One of the following:
"Intent"
"Content"
type: Literal["PromptTopic"]
description: Optional[str]
class UnionMember2: …
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[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"
class UnionMember3: …
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
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
created_at: datetime
formatdate-time
enabled: bool
name: str
type: Literal["document_fingerprint"]
updated_at: datetime
formatdate-time
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["word_list"]
updated_at: datetime
formatdate-time
word_list: object
profile_id: Optional[str]
formatuuid
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"
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
confidence: UnionMember1Confidence
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[UnionMember1Variant]
topic_type: Literal["Intent", "Content"]
One of the following:
"Intent"
"Content"
type: Literal["PromptTopic"]
description: Optional[str]
class UnionMember2: …
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 UnionMember3: …
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
upload_status: Optional[Literal["empty", "uploading", "pending", 3 more]]
One of the following:
"empty"
"uploading"
"pending"
"processing"
"failed"
"complete"
class UnionMember4: …
id: str
formatuuid
created_at: datetime
formatdate-time
enabled: bool
name: str
type: Literal["document_fingerprint"]
updated_at: datetime
formatdate-time
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["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]
topic_type: Literal["Intent", "Content"]
One of the following:
"Intent"
"Content"
type: Literal["PromptTopic"]
description: Optional[str]
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]
topic_type: Literal["Intent", "Content"]
One of the following:
"Intent"
"Content"
type: Literal["PromptTopic"]
description: Optional[str]
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
confidence: UnionMember1Confidence
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[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"
variant: Optional[UnionMember1Variant]
topic_type: Literal["Intent", "Content"]
One of the following:
"Intent"
"Content"
type: Literal["PromptTopic"]
description: Optional[str]
class UnionMember2: …
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[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"
class UnionMember3: …
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
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
created_at: datetime
formatdate-time
enabled: bool
name: str
type: Literal["document_fingerprint"]
updated_at: datetime
formatdate-time
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["word_list"]
updated_at: datetime
formatdate-time
word_list: object
profile_id: Optional[str]
formatuuid
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"
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
confidence: UnionMember1Confidence
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[UnionMember1Variant]
topic_type: Literal["Intent", "Content"]
One of the following:
"Intent"
"Content"
type: Literal["PromptTopic"]
description: Optional[str]
class UnionMember2: …
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 UnionMember3: …
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
upload_status: Optional[Literal["empty", "uploading", "pending", 3 more]]
One of the following:
"empty"
"uploading"
"pending"
"processing"
"failed"
"complete"
class UnionMember4: …
id: str
formatuuid
created_at: datetime
formatdate-time
enabled: bool
name: str
type: Literal["document_fingerprint"]
updated_at: datetime
formatdate-time
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["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
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
confidence: UnionMember1Confidence
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[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"
variant: Optional[UnionMember1Variant]
topic_type: Literal["Intent", "Content"]
One of the following:
"Intent"
"Content"
type: Literal["PromptTopic"]
description: Optional[str]
class UnionMember2: …
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[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"
class UnionMember3: …
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
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
created_at: datetime
formatdate-time
enabled: bool
name: str
type: Literal["document_fingerprint"]
updated_at: datetime
formatdate-time
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["word_list"]
updated_at: datetime
formatdate-time
word_list: object
profile_id: Optional[str]
formatuuid
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"
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
confidence: UnionMember1Confidence
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[UnionMember1Variant]
topic_type: Literal["Intent", "Content"]
One of the following:
"Intent"
"Content"
type: Literal["PromptTopic"]
description: Optional[str]
class UnionMember2: …
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 UnionMember3: …
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
upload_status: Optional[Literal["empty", "uploading", "pending", 3 more]]
One of the following:
"empty"
"uploading"
"pending"
"processing"
"failed"
"complete"
class UnionMember4: …
id: str
formatuuid
created_at: datetime
formatdate-time
enabled: bool
name: str
type: Literal["document_fingerprint"]
updated_at: datetime
formatdate-time
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["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"