Skip to content
Cloudflare API
Start here
API Reference
Zero Trust
DLP

Profiles

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[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 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.

ProfilesCustom

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[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 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"]]

ProfilesPredefined

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.