Skip to content
Cloudflare API
Start here
API Reference
Zero Trust

DLP

DLPDatasets

Fetch all datasets
client.ZeroTrust.DLP.Datasets.List(ctx, query) (*SinglePage[Dataset], error)
GET/accounts/{account_id}/dlp/datasets
Fetch a specific dataset
client.ZeroTrust.DLP.Datasets.Get(ctx, datasetID, query) (*Dataset, error)
GET/accounts/{account_id}/dlp/datasets/{dataset_id}
Create a new dataset
client.ZeroTrust.DLP.Datasets.New(ctx, params) (*DatasetCreation, error)
POST/accounts/{account_id}/dlp/datasets
Update details about a dataset
client.ZeroTrust.DLP.Datasets.Update(ctx, datasetID, params) (*Dataset, error)
PUT/accounts/{account_id}/dlp/datasets/{dataset_id}
Delete a dataset
client.ZeroTrust.DLP.Datasets.Delete(ctx, datasetID, body) error
DELETE/accounts/{account_id}/dlp/datasets/{dataset_id}
ModelsExpand Collapse
type Dataset struct{…}
ID string
formatuuid
Columns []DatasetColumn
EntryID string
formatuuid
HeaderName string
NumCells int64
formatint64
UploadStatus DatasetColumnsUploadStatus
One of the following:
const DatasetColumnsUploadStatusEmpty DatasetColumnsUploadStatus = "empty"
const DatasetColumnsUploadStatusUploading DatasetColumnsUploadStatus = "uploading"
const DatasetColumnsUploadStatusPending DatasetColumnsUploadStatus = "pending"
const DatasetColumnsUploadStatusProcessing DatasetColumnsUploadStatus = "processing"
const DatasetColumnsUploadStatusFailed DatasetColumnsUploadStatus = "failed"
const DatasetColumnsUploadStatusComplete DatasetColumnsUploadStatus = "complete"
CreatedAt Time
formatdate-time
EncodingVersion int64
formatint32
minimum0
Name string
NumCells int64
formatint64
Secret bool
Status DatasetStatus
One of the following:
const DatasetStatusEmpty DatasetStatus = "empty"
const DatasetStatusUploading DatasetStatus = "uploading"
const DatasetStatusPending DatasetStatus = "pending"
const DatasetStatusProcessing DatasetStatus = "processing"
const DatasetStatusFailed DatasetStatus = "failed"
const DatasetStatusComplete DatasetStatus = "complete"
UpdatedAt Time

Stores when the dataset was last updated.

This includes name or description changes as well as uploads.

formatdate-time
Uploads []DatasetUpload
NumCells int64
formatint64
Status DatasetUploadsStatus
One of the following:
const DatasetUploadsStatusEmpty DatasetUploadsStatus = "empty"
const DatasetUploadsStatusUploading DatasetUploadsStatus = "uploading"
const DatasetUploadsStatusPending DatasetUploadsStatus = "pending"
const DatasetUploadsStatusProcessing DatasetUploadsStatus = "processing"
const DatasetUploadsStatusFailed DatasetUploadsStatus = "failed"
const DatasetUploadsStatusComplete DatasetUploadsStatus = "complete"
Version int64
formatint64
CaseSensitive booloptional
Description stringoptional

The description of the dataset.

type DatasetArray []Dataset
ID string
formatuuid
Columns []DatasetColumn
EntryID string
formatuuid
HeaderName string
NumCells int64
formatint64
UploadStatus DatasetColumnsUploadStatus
One of the following:
const DatasetColumnsUploadStatusEmpty DatasetColumnsUploadStatus = "empty"
const DatasetColumnsUploadStatusUploading DatasetColumnsUploadStatus = "uploading"
const DatasetColumnsUploadStatusPending DatasetColumnsUploadStatus = "pending"
const DatasetColumnsUploadStatusProcessing DatasetColumnsUploadStatus = "processing"
const DatasetColumnsUploadStatusFailed DatasetColumnsUploadStatus = "failed"
const DatasetColumnsUploadStatusComplete DatasetColumnsUploadStatus = "complete"
CreatedAt Time
formatdate-time
EncodingVersion int64
formatint32
minimum0
Name string
NumCells int64
formatint64
Secret bool
Status DatasetStatus
One of the following:
const DatasetStatusEmpty DatasetStatus = "empty"
const DatasetStatusUploading DatasetStatus = "uploading"
const DatasetStatusPending DatasetStatus = "pending"
const DatasetStatusProcessing DatasetStatus = "processing"
const DatasetStatusFailed DatasetStatus = "failed"
const DatasetStatusComplete DatasetStatus = "complete"
UpdatedAt Time

Stores when the dataset was last updated.

This includes name or description changes as well as uploads.

formatdate-time
Uploads []DatasetUpload
NumCells int64
formatint64
Status DatasetUploadsStatus
One of the following:
const DatasetUploadsStatusEmpty DatasetUploadsStatus = "empty"
const DatasetUploadsStatusUploading DatasetUploadsStatus = "uploading"
const DatasetUploadsStatusPending DatasetUploadsStatus = "pending"
const DatasetUploadsStatusProcessing DatasetUploadsStatus = "processing"
const DatasetUploadsStatusFailed DatasetUploadsStatus = "failed"
const DatasetUploadsStatusComplete DatasetUploadsStatus = "complete"
Version int64
formatint64
CaseSensitive booloptional
Description stringoptional

The description of the dataset.

type DatasetCreation struct{…}
Dataset Dataset
EncodingVersion int64

Encoding version to use for dataset.

formatint32
minimum0
MaxCells int64
formatint64
minimum0
Version int64

The version to use when uploading the dataset.

formatint64
Secret stringoptional

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
client.ZeroTrust.DLP.Datasets.Upload.New(ctx, datasetID, body) (*NewVersion, error)
POST/accounts/{account_id}/dlp/datasets/{dataset_id}/upload
Upload a new version of a dataset
client.ZeroTrust.DLP.Datasets.Upload.Edit(ctx, datasetID, version, dataset, params) (*Dataset, error)
POST/accounts/{account_id}/dlp/datasets/{dataset_id}/upload/{version}
ModelsExpand Collapse
type NewVersion struct{…}
EncodingVersion int64
formatint32
minimum0
MaxCells int64
formatint64
minimum0
Version int64
formatint64
CaseSensitive booloptional
Columns []NewVersionColumnoptional
EntryID string
formatuuid
HeaderName string
NumCells int64
formatint64
UploadStatus NewVersionColumnsUploadStatus
One of the following:
const NewVersionColumnsUploadStatusEmpty NewVersionColumnsUploadStatus = "empty"
const NewVersionColumnsUploadStatusUploading NewVersionColumnsUploadStatus = "uploading"
const NewVersionColumnsUploadStatusPending NewVersionColumnsUploadStatus = "pending"
const NewVersionColumnsUploadStatusProcessing NewVersionColumnsUploadStatus = "processing"
const NewVersionColumnsUploadStatusFailed NewVersionColumnsUploadStatus = "failed"
const NewVersionColumnsUploadStatusComplete NewVersionColumnsUploadStatus = "complete"
Secret stringoptional
formatpassword

DLPDatasetsVersions

Sets the column information for a multi-column upload
client.ZeroTrust.DLP.Datasets.Versions.New(ctx, datasetID, version, params) (*SinglePage[DLPDatasetVersionNewResponse], error)
POST/accounts/{account_id}/dlp/datasets/{dataset_id}/versions/{version}

DLPDatasetsVersionsEntries

Upload a new version of a multi-column dataset
client.ZeroTrust.DLP.Datasets.Versions.Entries.New(ctx, datasetID, version, entryID, datasetVersionEntry, params) (*DLPDatasetVersionEntryNewResponse, error)
POST/accounts/{account_id}/dlp/datasets/{dataset_id}/versions/{version}/entries/{entry_id}

DLPPatterns

Validate a DLP regex pattern
client.ZeroTrust.DLP.Patterns.Validate(ctx, params) (*DLPPatternValidateResponse, error)
POST/accounts/{account_id}/dlp/patterns/validate

DLPPayload Logs

Get payload log settings
client.ZeroTrust.DLP.PayloadLogs.Get(ctx, query) (*DLPPayloadLogGetResponse, error)
GET/accounts/{account_id}/dlp/payload_log
Set payload log settings
client.ZeroTrust.DLP.PayloadLogs.Update(ctx, params) (*DLPPayloadLogUpdateResponse, error)
PUT/accounts/{account_id}/dlp/payload_log

DLPEmail

DLPEmailAccount Mapping

Get mapping
client.ZeroTrust.DLP.Email.AccountMapping.Get(ctx, query) (*DLPEmailAccountMappingGetResponse, error)
GET/accounts/{account_id}/dlp/email/account_mapping
Create mapping
client.ZeroTrust.DLP.Email.AccountMapping.New(ctx, params) (*DLPEmailAccountMappingNewResponse, error)
POST/accounts/{account_id}/dlp/email/account_mapping

DLPEmailRules

List all email scanner rules
client.ZeroTrust.DLP.Email.Rules.List(ctx, query) (*SinglePage[DLPEmailRuleListResponse], error)
GET/accounts/{account_id}/dlp/email/rules
Get an email scanner rule
client.ZeroTrust.DLP.Email.Rules.Get(ctx, ruleID, query) (*DLPEmailRuleGetResponse, error)
GET/accounts/{account_id}/dlp/email/rules/{rule_id}
Create email scanner rule
client.ZeroTrust.DLP.Email.Rules.New(ctx, params) (*DLPEmailRuleNewResponse, error)
POST/accounts/{account_id}/dlp/email/rules
Update email scanner rule
client.ZeroTrust.DLP.Email.Rules.Update(ctx, ruleID, params) (*DLPEmailRuleUpdateResponse, error)
PUT/accounts/{account_id}/dlp/email/rules/{rule_id}
Delete email scanner rule
client.ZeroTrust.DLP.Email.Rules.Delete(ctx, ruleID, body) (*DLPEmailRuleDeleteResponse, error)
DELETE/accounts/{account_id}/dlp/email/rules/{rule_id}
Update email scanner rule priorities
client.ZeroTrust.DLP.Email.Rules.BulkEdit(ctx, params) (*DLPEmailRuleBulkEditResponse, error)
PATCH/accounts/{account_id}/dlp/email/rules

DLPProfiles

List all profiles
client.ZeroTrust.DLP.Profiles.List(ctx, params) (*SinglePage[Profile], error)
GET/accounts/{account_id}/dlp/profiles
Get DLP Profile
client.ZeroTrust.DLP.Profiles.Get(ctx, profileID, query) (*Profile, error)
GET/accounts/{account_id}/dlp/profiles/{profile_id}
ModelsExpand Collapse
type ContextAwareness struct{…}

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.

type Profile interface{…}
One of the following:
type ProfileCustomProfile struct{…}
ID string

The id of the profile (uuid).

formatuuid
AllowedMatchCount int64

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

formatint32
maximum1000
minimum0
CreatedAt Time

When the profile was created.

formatdate-time
Name string

The name of the profile.

OCREnabled bool
Type ProfileCustomProfileType
UpdatedAt Time

When the profile was lasted updated.

formatdate-time
AIContextEnabled booloptional
ConfidenceThreshold ProfileCustomProfileConfidenceThresholdoptional
One of the following:
const ProfileCustomProfileConfidenceThresholdLow ProfileCustomProfileConfidenceThreshold = "low"
const ProfileCustomProfileConfidenceThresholdMedium ProfileCustomProfileConfidenceThreshold = "medium"
const ProfileCustomProfileConfidenceThresholdHigh ProfileCustomProfileConfidenceThreshold = "high"
const ProfileCustomProfileConfidenceThresholdVeryHigh ProfileCustomProfileConfidenceThreshold = "very_high"
DeprecatedContextAwareness ContextAwarenessoptional

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

DataClasses []stringoptional

Data classes associated with this profile.

DataTags []stringoptional

Data tags associated with this profile.

Description stringoptional

The description of the profile.

DeprecatedEntries []ProfileCustomProfileEntryoptional
One of the following:
type ProfileCustomProfileEntriesCustomEntry struct{…}
ID string
formatuuid
CreatedAt Time
formatdate-time
DeprecatedEnabled bool
Name string
Pattern Pattern
Type ProfileCustomProfileEntriesCustomEntryType
UpdatedAt Time
formatdate-time
Description stringoptional
DeprecatedProfileID stringoptional
formatuuid
type ProfileCustomProfileEntriesPredefinedEntry struct{…}
ID string
formatuuid
Confidence ProfileCustomProfileEntriesPredefinedEntryConfidence
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 ProfileCustomProfileEntriesPredefinedEntryType
DeprecatedProfileID stringoptional
formatuuid
Variant ProfileCustomProfileEntriesPredefinedEntryVariantoptional
TopicType ProfileCustomProfileEntriesPredefinedEntryVariantTopicType
One of the following:
const ProfileCustomProfileEntriesPredefinedEntryVariantTopicTypeIntent ProfileCustomProfileEntriesPredefinedEntryVariantTopicType = "Intent"
const ProfileCustomProfileEntriesPredefinedEntryVariantTopicTypeContent ProfileCustomProfileEntriesPredefinedEntryVariantTopicType = "Content"
Type ProfileCustomProfileEntriesPredefinedEntryVariantType
Description stringoptional
type ProfileCustomProfileEntriesIntegrationEntry struct{…}
ID string
formatuuid
CreatedAt Time
formatdate-time
Enabled bool
Name string
Type ProfileCustomProfileEntriesIntegrationEntryType
UpdatedAt Time
formatdate-time
ProfileID stringoptional
formatuuid
type ProfileCustomProfileEntriesExactDataEntry 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 ProfileCustomProfileEntriesExactDataEntryType
UpdatedAt Time
formatdate-time
type ProfileCustomProfileEntriesDocumentFingerprintEntry struct{…}
ID string
formatuuid
CreatedAt Time
formatdate-time
Enabled bool
Name string
Type ProfileCustomProfileEntriesDocumentFingerprintEntryType
UpdatedAt Time
formatdate-time
type ProfileCustomProfileEntriesWordListEntry struct{…}
ID string
formatuuid
CreatedAt Time
formatdate-time
Enabled bool
Name string
Type ProfileCustomProfileEntriesWordListEntryType
UpdatedAt Time
formatdate-time
WordList unknown
ProfileID stringoptional
formatuuid
SensitivityLevels [][]stringoptional

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

SharedEntries []ProfileCustomProfileSharedEntryoptional
One of the following:
type ProfileCustomProfileSharedEntriesCustomEntry struct{…}
ID string
formatuuid
CreatedAt Time
formatdate-time
DeprecatedEnabled bool
Name string
Pattern Pattern
Type ProfileCustomProfileSharedEntriesCustomEntryType
UpdatedAt Time
formatdate-time
Description stringoptional
DeprecatedProfileID stringoptional
formatuuid
type ProfileCustomProfileSharedEntriesPredefinedEntry struct{…}
ID string
formatuuid
Confidence ProfileCustomProfileSharedEntriesPredefinedEntryConfidence
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 ProfileCustomProfileSharedEntriesPredefinedEntryType
DeprecatedProfileID stringoptional
formatuuid
Variant ProfileCustomProfileSharedEntriesPredefinedEntryVariantoptional
TopicType ProfileCustomProfileSharedEntriesPredefinedEntryVariantTopicType
One of the following:
const ProfileCustomProfileSharedEntriesPredefinedEntryVariantTopicTypeIntent ProfileCustomProfileSharedEntriesPredefinedEntryVariantTopicType = "Intent"
const ProfileCustomProfileSharedEntriesPredefinedEntryVariantTopicTypeContent ProfileCustomProfileSharedEntriesPredefinedEntryVariantTopicType = "Content"
Type ProfileCustomProfileSharedEntriesPredefinedEntryVariantType
Description stringoptional
type ProfileCustomProfileSharedEntriesIntegrationEntry struct{…}
ID string
formatuuid
CreatedAt Time
formatdate-time
Enabled bool
Name string
Type ProfileCustomProfileSharedEntriesIntegrationEntryType
UpdatedAt Time
formatdate-time
ProfileID stringoptional
formatuuid
type ProfileCustomProfileSharedEntriesExactDataEntry 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 ProfileCustomProfileSharedEntriesExactDataEntryType
UpdatedAt Time
formatdate-time
type ProfileCustomProfileSharedEntriesDocumentFingerprintEntry struct{…}
ID string
formatuuid
CreatedAt Time
formatdate-time
Enabled bool
Name string
Type ProfileCustomProfileSharedEntriesDocumentFingerprintEntryType
UpdatedAt Time
formatdate-time
type ProfileCustomProfileSharedEntriesWordListEntry struct{…}
ID string
formatuuid
CreatedAt Time
formatdate-time
Enabled bool
Name string
Type ProfileCustomProfileSharedEntriesWordListEntryType
UpdatedAt Time
formatdate-time
WordList unknown
ProfileID stringoptional
formatuuid
type ProfilePredefinedProfile struct{…}
ID string

The id of the predefined profile (uuid).

formatuuid
AllowedMatchCount int64
formatint32
DeprecatedEntries []ProfilePredefinedProfileEntry
One of the following:
type ProfilePredefinedProfileEntriesCustomEntry struct{…}
ID string
formatuuid
CreatedAt Time
formatdate-time
DeprecatedEnabled bool
Name string
Pattern Pattern
Type ProfilePredefinedProfileEntriesCustomEntryType
UpdatedAt Time
formatdate-time
Description stringoptional
DeprecatedProfileID stringoptional
formatuuid
type ProfilePredefinedProfileEntriesPredefinedEntry struct{…}
ID string
formatuuid
Confidence ProfilePredefinedProfileEntriesPredefinedEntryConfidence
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 ProfilePredefinedProfileEntriesPredefinedEntryType
DeprecatedProfileID stringoptional
formatuuid
Variant ProfilePredefinedProfileEntriesPredefinedEntryVariantoptional
TopicType ProfilePredefinedProfileEntriesPredefinedEntryVariantTopicType
One of the following:
const ProfilePredefinedProfileEntriesPredefinedEntryVariantTopicTypeIntent ProfilePredefinedProfileEntriesPredefinedEntryVariantTopicType = "Intent"
const ProfilePredefinedProfileEntriesPredefinedEntryVariantTopicTypeContent ProfilePredefinedProfileEntriesPredefinedEntryVariantTopicType = "Content"
Type ProfilePredefinedProfileEntriesPredefinedEntryVariantType
Description stringoptional
type ProfilePredefinedProfileEntriesIntegrationEntry struct{…}
ID string
formatuuid
CreatedAt Time
formatdate-time
Enabled bool
Name string
Type ProfilePredefinedProfileEntriesIntegrationEntryType
UpdatedAt Time
formatdate-time
ProfileID stringoptional
formatuuid
type ProfilePredefinedProfileEntriesExactDataEntry 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 ProfilePredefinedProfileEntriesExactDataEntryType
UpdatedAt Time
formatdate-time
type ProfilePredefinedProfileEntriesDocumentFingerprintEntry struct{…}
ID string
formatuuid
CreatedAt Time
formatdate-time
Enabled bool
Name string
Type ProfilePredefinedProfileEntriesDocumentFingerprintEntryType
UpdatedAt Time
formatdate-time
type ProfilePredefinedProfileEntriesWordListEntry struct{…}
ID string
formatuuid
CreatedAt Time
formatdate-time
Enabled bool
Name string
Type ProfilePredefinedProfileEntriesWordListEntryType
UpdatedAt Time
formatdate-time
WordList unknown
ProfileID stringoptional
formatuuid
Name string

The name of the predefined profile.

Type ProfilePredefinedProfileType
AIContextEnabled booloptional
ConfidenceThreshold ProfilePredefinedProfileConfidenceThresholdoptional
One of the following:
const ProfilePredefinedProfileConfidenceThresholdLow ProfilePredefinedProfileConfidenceThreshold = "low"
const ProfilePredefinedProfileConfidenceThresholdMedium ProfilePredefinedProfileConfidenceThreshold = "medium"
const ProfilePredefinedProfileConfidenceThresholdHigh ProfilePredefinedProfileConfidenceThreshold = "high"
const ProfilePredefinedProfileConfidenceThresholdVeryHigh ProfilePredefinedProfileConfidenceThreshold = "very_high"
DeprecatedContextAwareness ContextAwarenessoptional

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

OCREnabled booloptional
OpenAccess booloptional

Whether this profile can be accessed by anyone.

type ProfileIntegrationProfile struct{…}
ID string
formatuuid
CreatedAt Time
formatdate-time
DeprecatedEntries []ProfileIntegrationProfileEntry
One of the following:
type ProfileIntegrationProfileEntriesCustomEntry struct{…}
ID string
formatuuid
CreatedAt Time
formatdate-time
DeprecatedEnabled bool
Name string
Pattern Pattern
Type ProfileIntegrationProfileEntriesCustomEntryType
UpdatedAt Time
formatdate-time
Description stringoptional
DeprecatedProfileID stringoptional
formatuuid
type ProfileIntegrationProfileEntriesPredefinedEntry struct{…}
ID string
formatuuid
Confidence ProfileIntegrationProfileEntriesPredefinedEntryConfidence
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 ProfileIntegrationProfileEntriesPredefinedEntryType
DeprecatedProfileID stringoptional
formatuuid
Variant ProfileIntegrationProfileEntriesPredefinedEntryVariantoptional
TopicType ProfileIntegrationProfileEntriesPredefinedEntryVariantTopicType
One of the following:
const ProfileIntegrationProfileEntriesPredefinedEntryVariantTopicTypeIntent ProfileIntegrationProfileEntriesPredefinedEntryVariantTopicType = "Intent"
const ProfileIntegrationProfileEntriesPredefinedEntryVariantTopicTypeContent ProfileIntegrationProfileEntriesPredefinedEntryVariantTopicType = "Content"
Type ProfileIntegrationProfileEntriesPredefinedEntryVariantType
Description stringoptional
type ProfileIntegrationProfileEntriesIntegrationEntry struct{…}
ID string
formatuuid
CreatedAt Time
formatdate-time
Enabled bool
Name string
Type ProfileIntegrationProfileEntriesIntegrationEntryType
UpdatedAt Time
formatdate-time
ProfileID stringoptional
formatuuid
type ProfileIntegrationProfileEntriesExactDataEntry 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 ProfileIntegrationProfileEntriesExactDataEntryType
UpdatedAt Time
formatdate-time
type ProfileIntegrationProfileEntriesDocumentFingerprintEntry struct{…}
ID string
formatuuid
CreatedAt Time
formatdate-time
Enabled bool
Name string
Type ProfileIntegrationProfileEntriesDocumentFingerprintEntryType
UpdatedAt Time
formatdate-time
type ProfileIntegrationProfileEntriesWordListEntry struct{…}
ID string
formatuuid
CreatedAt Time
formatdate-time
Enabled bool
Name string
Type ProfileIntegrationProfileEntriesWordListEntryType
UpdatedAt Time
formatdate-time
WordList unknown
ProfileID stringoptional
formatuuid
Name string
SharedEntries []ProfileIntegrationProfileSharedEntry
One of the following:
type ProfileIntegrationProfileSharedEntriesCustomEntry struct{…}
ID string
formatuuid
CreatedAt Time
formatdate-time
DeprecatedEnabled bool
Name string
Pattern Pattern
Type ProfileIntegrationProfileSharedEntriesCustomEntryType
UpdatedAt Time
formatdate-time
Description stringoptional
DeprecatedProfileID stringoptional
formatuuid
type ProfileIntegrationProfileSharedEntriesPredefinedEntry struct{…}
ID string
formatuuid
Confidence ProfileIntegrationProfileSharedEntriesPredefinedEntryConfidence
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 ProfileIntegrationProfileSharedEntriesPredefinedEntryType
DeprecatedProfileID stringoptional
formatuuid
Variant ProfileIntegrationProfileSharedEntriesPredefinedEntryVariantoptional
TopicType ProfileIntegrationProfileSharedEntriesPredefinedEntryVariantTopicType
One of the following:
const ProfileIntegrationProfileSharedEntriesPredefinedEntryVariantTopicTypeIntent ProfileIntegrationProfileSharedEntriesPredefinedEntryVariantTopicType = "Intent"
const ProfileIntegrationProfileSharedEntriesPredefinedEntryVariantTopicTypeContent ProfileIntegrationProfileSharedEntriesPredefinedEntryVariantTopicType = "Content"
Type ProfileIntegrationProfileSharedEntriesPredefinedEntryVariantType
Description stringoptional
type ProfileIntegrationProfileSharedEntriesIntegrationEntry struct{…}
ID string
formatuuid
CreatedAt Time
formatdate-time
Enabled bool
Name string
Type ProfileIntegrationProfileSharedEntriesIntegrationEntryType
UpdatedAt Time
formatdate-time
ProfileID stringoptional
formatuuid
type ProfileIntegrationProfileSharedEntriesExactDataEntry 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 ProfileIntegrationProfileSharedEntriesExactDataEntryType
UpdatedAt Time
formatdate-time
type ProfileIntegrationProfileSharedEntriesDocumentFingerprintEntry struct{…}
ID string
formatuuid
CreatedAt Time
formatdate-time
Enabled bool
Name string
Type ProfileIntegrationProfileSharedEntriesDocumentFingerprintEntryType
UpdatedAt Time
formatdate-time
type ProfileIntegrationProfileSharedEntriesWordListEntry struct{…}
ID string
formatuuid
CreatedAt Time
formatdate-time
Enabled bool
Name string
Type ProfileIntegrationProfileSharedEntriesWordListEntryType
UpdatedAt Time
formatdate-time
WordList unknown
ProfileID stringoptional
formatuuid
Type ProfileIntegrationProfileType
UpdatedAt Time
formatdate-time
Description stringoptional

The description of the profile.

type SkipConfiguration struct{…}

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
client.ZeroTrust.DLP.Profiles.Custom.Get(ctx, profileID, query) (*Profile, error)
GET/accounts/{account_id}/dlp/profiles/custom/{profile_id}
Create custom profile
client.ZeroTrust.DLP.Profiles.Custom.New(ctx, params) (*Profile, error)
POST/accounts/{account_id}/dlp/profiles/custom
Update custom profile
client.ZeroTrust.DLP.Profiles.Custom.Update(ctx, profileID, params) (*Profile, error)
PUT/accounts/{account_id}/dlp/profiles/custom/{profile_id}
Delete custom profile
client.ZeroTrust.DLP.Profiles.Custom.Delete(ctx, profileID, body) (*DLPProfileCustomDeleteResponse, error)
DELETE/accounts/{account_id}/dlp/profiles/custom/{profile_id}
ModelsExpand Collapse
type CustomProfile struct{…}
ID string

The id of the profile (uuid).

formatuuid
AllowedMatchCount int64

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

formatint32
maximum1000
minimum0
CreatedAt Time

When the profile was created.

formatdate-time
Name string

The name of the profile.

OCREnabled bool
UpdatedAt Time

When the profile was lasted updated.

formatdate-time
AIContextEnabled booloptional
ConfidenceThreshold CustomProfileConfidenceThresholdoptional
One of the following:
const CustomProfileConfidenceThresholdLow CustomProfileConfidenceThreshold = "low"
const CustomProfileConfidenceThresholdMedium CustomProfileConfidenceThreshold = "medium"
const CustomProfileConfidenceThresholdHigh CustomProfileConfidenceThreshold = "high"
const CustomProfileConfidenceThresholdVeryHigh CustomProfileConfidenceThreshold = "very_high"
DeprecatedContextAwareness ContextAwarenessoptional

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

DataClasses []stringoptional

Data classes associated with this profile.

DataTags []stringoptional

Data tags associated with this profile.

Description stringoptional

The description of the profile.

DeprecatedEntries []CustomProfileEntryoptional
One of the following:
CustomProfileEntriesCustomEntry
ID string
formatuuid
CreatedAt Time
formatdate-time
DeprecatedEnabled bool
Name string
Pattern Pattern
Type CustomProfileEntriesCustomEntryType
UpdatedAt Time
formatdate-time
Description stringoptional
DeprecatedProfileID stringoptional
formatuuid
CustomProfileEntriesPredefinedEntry
ID string
formatuuid
Confidence CustomProfileEntriesPredefinedEntryConfidence
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 CustomProfileEntriesPredefinedEntryType
DeprecatedProfileID stringoptional
formatuuid
Variant CustomProfileEntriesPredefinedEntryVariantoptional
TopicType CustomProfileEntriesPredefinedEntryVariantTopicType
One of the following:
const CustomProfileEntriesPredefinedEntryVariantTopicTypeIntent CustomProfileEntriesPredefinedEntryVariantTopicType = "Intent"
const CustomProfileEntriesPredefinedEntryVariantTopicTypeContent CustomProfileEntriesPredefinedEntryVariantTopicType = "Content"
Type CustomProfileEntriesPredefinedEntryVariantType
Description stringoptional
CustomProfileEntriesIntegrationEntry
ID string
formatuuid
CreatedAt Time
formatdate-time
Enabled bool
Name string
Type CustomProfileEntriesIntegrationEntryType
UpdatedAt Time
formatdate-time
ProfileID stringoptional
formatuuid
CustomProfileEntriesExactDataEntry
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 CustomProfileEntriesExactDataEntryType
UpdatedAt Time
formatdate-time
CustomProfileEntriesDocumentFingerprintEntry
ID string
formatuuid
CreatedAt Time
formatdate-time
Enabled bool
Name string
Type CustomProfileEntriesDocumentFingerprintEntryType
UpdatedAt Time
formatdate-time
CustomProfileEntriesWordListEntry
ID string
formatuuid
CreatedAt Time
formatdate-time
Enabled bool
Name string
Type CustomProfileEntriesWordListEntryType
UpdatedAt Time
formatdate-time
WordList unknown
ProfileID stringoptional
formatuuid
SensitivityLevels [][]stringoptional

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

SharedEntries []CustomProfileSharedEntryoptional
One of the following:
CustomProfileSharedEntriesCustomEntry
ID string
formatuuid
CreatedAt Time
formatdate-time
DeprecatedEnabled bool
Name string
Pattern Pattern
Type CustomProfileSharedEntriesCustomEntryType
UpdatedAt Time
formatdate-time
Description stringoptional
DeprecatedProfileID stringoptional
formatuuid
CustomProfileSharedEntriesPredefinedEntry
ID string
formatuuid
Confidence CustomProfileSharedEntriesPredefinedEntryConfidence
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 CustomProfileSharedEntriesPredefinedEntryType
DeprecatedProfileID stringoptional
formatuuid
Variant CustomProfileSharedEntriesPredefinedEntryVariantoptional
TopicType CustomProfileSharedEntriesPredefinedEntryVariantTopicType
One of the following:
const CustomProfileSharedEntriesPredefinedEntryVariantTopicTypeIntent CustomProfileSharedEntriesPredefinedEntryVariantTopicType = "Intent"
const CustomProfileSharedEntriesPredefinedEntryVariantTopicTypeContent CustomProfileSharedEntriesPredefinedEntryVariantTopicType = "Content"
Type CustomProfileSharedEntriesPredefinedEntryVariantType
Description stringoptional
CustomProfileSharedEntriesIntegrationEntry
ID string
formatuuid
CreatedAt Time
formatdate-time
Enabled bool
Name string
Type CustomProfileSharedEntriesIntegrationEntryType
UpdatedAt Time
formatdate-time
ProfileID stringoptional
formatuuid
CustomProfileSharedEntriesExactDataEntry
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 CustomProfileSharedEntriesExactDataEntryType
UpdatedAt Time
formatdate-time
CustomProfileSharedEntriesDocumentFingerprintEntry
ID string
formatuuid
CreatedAt Time
formatdate-time
Enabled bool
Name string
Type CustomProfileSharedEntriesDocumentFingerprintEntryType
UpdatedAt Time
formatdate-time
CustomProfileSharedEntriesWordListEntry
ID string
formatuuid
CreatedAt Time
formatdate-time
Enabled bool
Name string
Type CustomProfileSharedEntriesWordListEntryType
UpdatedAt Time
formatdate-time
WordList unknown
ProfileID stringoptional
formatuuid
type Pattern struct{…}
Regex string
DeprecatedValidation PatternValidationoptional

DLPProfilesPredefined

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 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
TopicType PredefinedProfileEntriesPredefinedEntryVariantTopicType
One of the following:
const PredefinedProfileEntriesPredefinedEntryVariantTopicTypeIntent PredefinedProfileEntriesPredefinedEntryVariantTopicType = "Intent"
const PredefinedProfileEntriesPredefinedEntryVariantTopicTypeContent PredefinedProfileEntriesPredefinedEntryVariantTopicType = "Content"
Type PredefinedProfileEntriesPredefinedEntryVariantType
Description stringoptional
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
type PredefinedProfileEntriesDocumentFingerprintEntry struct{…}
ID string
formatuuid
CreatedAt Time
formatdate-time
Enabled bool
Name string
Type PredefinedProfileEntriesDocumentFingerprintEntryType
UpdatedAt Time
formatdate-time
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.

DLPLimits

Fetch limits associated with DLP for account
client.ZeroTrust.DLP.Limits.List(ctx, query) (*DLPLimitListResponse, error)
GET/accounts/{account_id}/dlp/limits

DLPEntries

List all entries
client.ZeroTrust.DLP.Entries.List(ctx, query) (*SinglePage[DLPEntryListResponse], error)
GET/accounts/{account_id}/dlp/entries
Get DLP Entry
client.ZeroTrust.DLP.Entries.Get(ctx, entryID, query) (*DLPEntryGetResponse, error)
GET/accounts/{account_id}/dlp/entries/{entry_id}
Create custom entry
client.ZeroTrust.DLP.Entries.New(ctx, params) (*DLPEntryNewResponse, error)
POST/accounts/{account_id}/dlp/entries
Update entry
client.ZeroTrust.DLP.Entries.Update(ctx, entryID, params) (*DLPEntryUpdateResponse, error)
PUT/accounts/{account_id}/dlp/entries/{entry_id}
Delete custom entry
client.ZeroTrust.DLP.Entries.Delete(ctx, entryID, body) (*DLPEntryDeleteResponse, error)
DELETE/accounts/{account_id}/dlp/entries/{entry_id}

DLPEntriesCustom

Create custom entry
client.ZeroTrust.DLP.Entries.Custom.New(ctx, params) (*DLPEntryCustomNewResponse, error)
POST/accounts/{account_id}/dlp/entries
Update custom entry
client.ZeroTrust.DLP.Entries.Custom.Update(ctx, entryID, params) (*DLPEntryCustomUpdateResponse, error)
PUT/accounts/{account_id}/dlp/entries/custom/{entry_id}
Delete custom entry
client.ZeroTrust.DLP.Entries.Custom.Delete(ctx, entryID, body) (*DLPEntryCustomDeleteResponse, error)
DELETE/accounts/{account_id}/dlp/entries/{entry_id}
Get DLP Entry
client.ZeroTrust.DLP.Entries.Custom.Get(ctx, entryID, query) (*DLPEntryCustomGetResponse, error)
GET/accounts/{account_id}/dlp/entries/{entry_id}
List all entries
client.ZeroTrust.DLP.Entries.Custom.List(ctx, query) (*SinglePage[DLPEntryCustomListResponse], error)
GET/accounts/{account_id}/dlp/entries

DLPEntriesPredefined

Create predefined entry
client.ZeroTrust.DLP.Entries.Predefined.New(ctx, params) (*DLPEntryPredefinedNewResponse, error)
POST/accounts/{account_id}/dlp/entries/predefined
Update predefined entry
client.ZeroTrust.DLP.Entries.Predefined.Update(ctx, entryID, params) (*DLPEntryPredefinedUpdateResponse, error)
PUT/accounts/{account_id}/dlp/entries/predefined/{entry_id}
Delete predefined entry
client.ZeroTrust.DLP.Entries.Predefined.Delete(ctx, entryID, body) (*DLPEntryPredefinedDeleteResponse, error)
DELETE/accounts/{account_id}/dlp/entries/predefined/{entry_id}
Get DLP Entry
client.ZeroTrust.DLP.Entries.Predefined.Get(ctx, entryID, query) (*DLPEntryPredefinedGetResponse, error)
GET/accounts/{account_id}/dlp/entries/{entry_id}
List all entries
client.ZeroTrust.DLP.Entries.Predefined.List(ctx, query) (*SinglePage[DLPEntryPredefinedListResponse], error)
GET/accounts/{account_id}/dlp/entries

DLPEntriesIntegration

Create integration entry
client.ZeroTrust.DLP.Entries.Integration.New(ctx, params) (*DLPEntryIntegrationNewResponse, error)
POST/accounts/{account_id}/dlp/entries/integration
Update integration entry
client.ZeroTrust.DLP.Entries.Integration.Update(ctx, entryID, params) (*DLPEntryIntegrationUpdateResponse, error)
PUT/accounts/{account_id}/dlp/entries/integration/{entry_id}
Delete integration entry
client.ZeroTrust.DLP.Entries.Integration.Delete(ctx, entryID, body) (*DLPEntryIntegrationDeleteResponse, error)
DELETE/accounts/{account_id}/dlp/entries/integration/{entry_id}
Get DLP Entry
client.ZeroTrust.DLP.Entries.Integration.Get(ctx, entryID, query) (*DLPEntryIntegrationGetResponse, error)
GET/accounts/{account_id}/dlp/entries/{entry_id}
List all entries
client.ZeroTrust.DLP.Entries.Integration.List(ctx, query) (*SinglePage[DLPEntryIntegrationListResponse], error)
GET/accounts/{account_id}/dlp/entries