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

Custom

Get custom profile
client.zeroTrust.dlp.profiles.custom.get(stringprofileId, CustomGetParams { account_id } params, RequestOptionsoptions?): Profile
GET/accounts/{account_id}/dlp/profiles/custom/{profile_id}
Create custom profile
client.zeroTrust.dlp.profiles.custom.create(CustomCreateParams { account_id, name, ai_context_enabled, 10 more } params, RequestOptionsoptions?): Profile
POST/accounts/{account_id}/dlp/profiles/custom
Update custom profile
client.zeroTrust.dlp.profiles.custom.update(stringprofileId, CustomUpdateParams { account_id, name, ai_context_enabled, 10 more } params, RequestOptionsoptions?): Profile
PUT/accounts/{account_id}/dlp/profiles/custom/{profile_id}
Delete custom profile
client.zeroTrust.dlp.profiles.custom.delete(stringprofileId, CustomDeleteParams { account_id } params, RequestOptionsoptions?): CustomDeleteResponse | null
DELETE/accounts/{account_id}/dlp/profiles/custom/{profile_id}
ModelsExpand Collapse
CustomProfile { id, allowed_match_count, created_at, 12 more }
id: string

The id of the profile (uuid).

formatuuid
allowed_match_count: number

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

formatint32
maximum1000
minimum0
created_at: string

When the profile was created.

formatdate-time
name: string

The name of the profile.

ocr_enabled: boolean
updated_at: string

When the profile was lasted updated.

formatdate-time
ai_context_enabled?: boolean
confidence_threshold?: "low" | "medium" | "high" | "very_high"
One of the following:
"low"
"medium"
"high"
"very_high"
Deprecatedcontext_awareness?: ContextAwareness { enabled, skip }

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

data_classes?: Array<string>

Data classes associated with this profile.

data_tags?: Array<string>

Data tags associated with this profile.

description?: string | null

The description of the profile.

Deprecatedentries?: Array<CustomEntry { id, created_at, enabled, 6 more } | CustomPromptTopicEntry { id, created_at, enabled, 4 more } | PredefinedEntry { id, confidence, enabled, 4 more } | 4 more>
One of the following:
CustomEntry { id, created_at, enabled, 6 more }
id: string
formatuuid
created_at: string
formatdate-time
Deprecatedenabled: boolean
name: string
pattern: Pattern { regex, validation }
type: "custom"
updated_at: string
formatdate-time
description?: string | null
Deprecatedprofile_id?: string | null
formatuuid
CustomPromptTopicEntry { id, created_at, enabled, 4 more }
id: string
formatuuid
created_at: string
formatdate-time
Deprecatedenabled: boolean
name: string
type: "custom_prompt_topic"
updated_at: string
formatdate-time
description?: string | null

The optional description of the custom prompt topic entry.

PredefinedEntry { id, confidence, enabled, 4 more }
id: string
formatuuid
confidence: Confidence { ai_context_available, available }
ai_context_available: boolean

Indicates whether this entry has AI remote service validation.

available: boolean

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

enabled: boolean
name: string
type: "predefined"
Deprecatedprofile_id?: string | null
formatuuid
variant?: UnionMember0 { topic_type, type, description } | UnionMember1 { type, description }

A Predefined AI prompt classification topic entry.

One of the following:
UnionMember0 { topic_type, type, description }

A Predefined AI prompt classification topic entry.

topic_type: "Intent" | "Content"
One of the following:
"Intent"
"Content"
type: "PromptTopic"
description?: string | null

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

UnionMember1 { type, description }

A general predefined entry.

type: "General"
description?: string | null

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

IntegrationEntry { id, created_at, enabled, 4 more }
id: string
formatuuid
created_at: string
formatdate-time
enabled: boolean
name: string
type: "integration"
updated_at: string
formatdate-time
profile_id?: string | null
formatuuid
ExactDataEntry { id, case_sensitive, created_at, 6 more }
id: string
formatuuid
case_sensitive: boolean

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: string
formatdate-time
enabled: boolean
name: string
secret: boolean
type: "exact_data"
updated_at: string
formatdate-time
description?: string | null

The optional description of the exact data entry.

DocumentFingerprintEntry { id, created_at, enabled, 4 more }
id: string
formatuuid
created_at: string
formatdate-time
enabled: boolean
name: string
type: "document_fingerprint"
updated_at: string
formatdate-time
description?: string | null

The optional description of the document fingerprint entry.

WordListEntry { id, created_at, enabled, 5 more }
id: string
formatuuid
created_at: string
formatdate-time
enabled: boolean
name: string
type: "word_list"
updated_at: string
formatdate-time
word_list: unknown
profile_id?: string | null
formatuuid
sensitivity_levels?: Array<SensitivityLevel>

Sensitivity levels associated with this profile.

group_id: string
formatuuid
level_id: string
formatuuid
shared_entries?: Array<CustomEntry { id, created_at, enabled, 6 more } | CustomPromptTopicEntry { id, created_at, enabled, 4 more } | PredefinedEntry { id, confidence, enabled, 4 more } | 4 more>
One of the following:
CustomEntry { id, created_at, enabled, 6 more }
id: string
formatuuid
created_at: string
formatdate-time
Deprecatedenabled: boolean
name: string
pattern: Pattern { regex, validation }
type: "custom"
updated_at: string
formatdate-time
description?: string | null
Deprecatedprofile_id?: string | null
formatuuid
CustomPromptTopicEntry { id, created_at, enabled, 4 more }
id: string
formatuuid
created_at: string
formatdate-time
Deprecatedenabled: boolean
name: string
type: "custom_prompt_topic"
updated_at: string
formatdate-time
description?: string | null

The optional description of the custom prompt topic entry.

PredefinedEntry { id, confidence, enabled, 4 more }
id: string
formatuuid
confidence: Confidence { ai_context_available, available }
ai_context_available: boolean

Indicates whether this entry has AI remote service validation.

available: boolean

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

enabled: boolean
name: string
type: "predefined"
Deprecatedprofile_id?: string | null
formatuuid
variant?: UnionMember0 { topic_type, type, description } | UnionMember1 { type, description }

A Predefined AI prompt classification topic entry.

One of the following:
UnionMember0 { topic_type, type, description }

A Predefined AI prompt classification topic entry.

topic_type: "Intent" | "Content"
One of the following:
"Intent"
"Content"
type: "PromptTopic"
description?: string | null

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

UnionMember1 { type, description }

A general predefined entry.

type: "General"
description?: string | null

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

IntegrationEntry { id, created_at, enabled, 4 more }
id: string
formatuuid
created_at: string
formatdate-time
enabled: boolean
name: string
type: "integration"
updated_at: string
formatdate-time
profile_id?: string | null
formatuuid
ExactDataEntry { id, case_sensitive, created_at, 6 more }
id: string
formatuuid
case_sensitive: boolean

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: string
formatdate-time
enabled: boolean
name: string
secret: boolean
type: "exact_data"
updated_at: string
formatdate-time
description?: string | null

The optional description of the exact data entry.

DocumentFingerprintEntry { id, created_at, enabled, 4 more }
id: string
formatuuid
created_at: string
formatdate-time
enabled: boolean
name: string
type: "document_fingerprint"
updated_at: string
formatdate-time
description?: string | null

The optional description of the document fingerprint entry.

WordListEntry { id, created_at, enabled, 5 more }
id: string
formatuuid
created_at: string
formatdate-time
enabled: boolean
name: string
type: "word_list"
updated_at: string
formatdate-time
word_list: unknown
profile_id?: string | null
formatuuid
Pattern { regex, validation }
regex: string
Deprecatedvalidation?: "luhn"
CustomDeleteResponse = unknown