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

Predefined

Get predefined profile config
client.ZeroTrust.DLP.Profiles.Predefined.Get(ctx, profileID, query) (*PredefinedProfile, error)
GET/accounts/{account_id}/dlp/profiles/predefined/{profile_id}/config
Update predefined profile config
client.ZeroTrust.DLP.Profiles.Predefined.Update(ctx, profileID, params) (*PredefinedProfile, error)
PUT/accounts/{account_id}/dlp/profiles/predefined/{profile_id}/config
Delete predefined profile
client.ZeroTrust.DLP.Profiles.Predefined.Delete(ctx, profileID, body) (*DLPProfilePredefinedDeleteResponse, error)
DELETE/accounts/{account_id}/dlp/profiles/predefined/{profile_id}
ModelsExpand Collapse
type PredefinedProfile struct{…}
ID string

The id of the predefined profile (uuid).

formatuuid
AllowedMatchCount int64
formatint32
ConfidenceThreshold string
EnabledEntries []string

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

DeprecatedEntries []PredefinedProfileEntry

This field has been deprecated for enabled_entries.

One of the following:
type PredefinedProfileEntriesCustomEntry struct{…}
ID string
formatuuid
CreatedAt Time
formatdate-time
DeprecatedEnabled bool
Name string
Pattern Pattern
Type PredefinedProfileEntriesCustomEntryType
UpdatedAt Time
formatdate-time
Description stringOptional
DeprecatedProfileID stringOptional
formatuuid
type PredefinedProfileEntriesCustomPromptTopicEntry struct{…}
ID string
formatuuid
CreatedAt Time
formatdate-time
DeprecatedEnabled bool
Name string
Type PredefinedProfileEntriesCustomPromptTopicEntryType
UpdatedAt Time
formatdate-time
Description stringOptional

The optional description of the custom prompt topic entry.

type PredefinedProfileEntriesPredefinedEntry struct{…}
ID string
formatuuid
Confidence PredefinedProfileEntriesPredefinedEntryConfidence
AIContextAvailable 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 string
Type PredefinedProfileEntriesPredefinedEntryType
DeprecatedProfileID stringOptional
formatuuid
Variant PredefinedProfileEntriesPredefinedEntryVariantOptional

A Predefined AI prompt classification topic entry.

One of the following:
type PredefinedProfileEntriesPredefinedEntryVariantObject struct{…}

A Predefined AI prompt classification topic entry.

TopicType PredefinedProfileEntriesPredefinedEntryVariantObjectTopicType
One of the following:
const PredefinedProfileEntriesPredefinedEntryVariantObjectTopicTypeIntent PredefinedProfileEntriesPredefinedEntryVariantObjectTopicType = "Intent"
const PredefinedProfileEntriesPredefinedEntryVariantObjectTopicTypeContent PredefinedProfileEntriesPredefinedEntryVariantObjectTopicType = "Content"
Type PredefinedProfileEntriesPredefinedEntryVariantObjectType
Description stringOptional

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

type PredefinedProfileEntriesPredefinedEntryVariantObject struct{…}

A general predefined entry.

Type PredefinedProfileEntriesPredefinedEntryVariantObjectType
Description stringOptional

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

type PredefinedProfileEntriesIntegrationEntry struct{…}
ID string
formatuuid
CreatedAt Time
formatdate-time
Enabled bool
Name string
Type PredefinedProfileEntriesIntegrationEntryType
UpdatedAt Time
formatdate-time
ProfileID stringOptional
formatuuid
type PredefinedProfileEntriesExactDataEntry struct{…}
ID string
formatuuid
CaseSensitive 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

CreatedAt Time
formatdate-time
Enabled bool
Name string
Secret bool
Type PredefinedProfileEntriesExactDataEntryType
UpdatedAt Time
formatdate-time
Description stringOptional

The optional description of the exact data entry.

type PredefinedProfileEntriesDocumentFingerprintEntry struct{…}
ID string
formatuuid
CreatedAt Time
formatdate-time
Enabled bool
Name string
Type PredefinedProfileEntriesDocumentFingerprintEntryType
UpdatedAt Time
formatdate-time
Description stringOptional

The optional description of the document fingerprint entry.

type PredefinedProfileEntriesWordListEntry struct{…}
ID string
formatuuid
CreatedAt Time
formatdate-time
Enabled bool
Name string
Type PredefinedProfileEntriesWordListEntryType
UpdatedAt Time
formatdate-time
WordList unknown
ProfileID stringOptional
formatuuid
Name string

The name of the predefined profile.

AIContextEnabled boolOptional
OCREnabled boolOptional
OpenAccess boolOptional

Whether this profile can be accessed by anyone.