API Reference

Zero Trust

DLP

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

Datasets

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

DatasetsUpload

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

DatasetsVersions

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}

DatasetsVersionsEntries

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}