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

Predefined

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.