Skip to content
Start here

Datasets

Fetch all datasets
client.zeroTrust.dlp.datasets.list(DatasetListParams { account_id } params, RequestOptionsoptions?): SinglePage<Dataset { id, columns, created_at, 9 more } >
GET/accounts/{account_id}/dlp/datasets
Fetch a specific dataset
client.zeroTrust.dlp.datasets.get(stringdatasetId, DatasetGetParams { account_id } params, RequestOptionsoptions?): Dataset { id, columns, created_at, 9 more }
GET/accounts/{account_id}/dlp/datasets/{dataset_id}
Create a new dataset
client.zeroTrust.dlp.datasets.create(DatasetCreateParams { account_id, name, case_sensitive, 3 more } params, RequestOptionsoptions?): DatasetCreation { dataset, encoding_version, max_cells, 2 more }
POST/accounts/{account_id}/dlp/datasets
Update details about a dataset
client.zeroTrust.dlp.datasets.update(stringdatasetId, DatasetUpdateParams { account_id, case_sensitive, description, name } params, RequestOptionsoptions?): Dataset { id, columns, created_at, 9 more }
PUT/accounts/{account_id}/dlp/datasets/{dataset_id}
Delete a dataset
client.zeroTrust.dlp.datasets.delete(stringdatasetId, DatasetDeleteParams { account_id } params, RequestOptionsoptions?): void
DELETE/accounts/{account_id}/dlp/datasets/{dataset_id}
ModelsExpand Collapse
Dataset { id, columns, created_at, 9 more }
id: string
formatuuid
columns: Array<Column>
entry_id: string
formatuuid
header_name: string
num_cells: number
formatint64
upload_status: "empty" | "uploading" | "pending" | 3 more
One of the following:
"empty"
"uploading"
"pending"
"processing"
"failed"
"complete"
created_at: string
formatdate-time
encoding_version: number
formatint32
minimum0
name: string
num_cells: number
formatint64
secret: boolean
status: "empty" | "uploading" | "pending" | 3 more
One of the following:
"empty"
"uploading"
"pending"
"processing"
"failed"
"complete"
updated_at: string

Stores when the dataset was last updated.

This includes name or description changes as well as uploads.

formatdate-time
uploads: Array<Upload>
num_cells: number
formatint64
status: "empty" | "uploading" | "pending" | 3 more
One of the following:
"empty"
"uploading"
"pending"
"processing"
"failed"
"complete"
version: number
formatint64
case_sensitive?: boolean
description?: string | null

The description of the dataset.

DatasetArray = Array<Dataset { id, columns, created_at, 9 more } >
id: string
formatuuid
columns: Array<Column>
entry_id: string
formatuuid
header_name: string
num_cells: number
formatint64
upload_status: "empty" | "uploading" | "pending" | 3 more
One of the following:
"empty"
"uploading"
"pending"
"processing"
"failed"
"complete"
created_at: string
formatdate-time
encoding_version: number
formatint32
minimum0
name: string
num_cells: number
formatint64
secret: boolean
status: "empty" | "uploading" | "pending" | 3 more
One of the following:
"empty"
"uploading"
"pending"
"processing"
"failed"
"complete"
updated_at: string

Stores when the dataset was last updated.

This includes name or description changes as well as uploads.

formatdate-time
uploads: Array<Upload>
num_cells: number
formatint64
status: "empty" | "uploading" | "pending" | 3 more
One of the following:
"empty"
"uploading"
"pending"
"processing"
"failed"
"complete"
version: number
formatint64
case_sensitive?: boolean
description?: string | null

The description of the dataset.

DatasetCreation { dataset, encoding_version, max_cells, 2 more }
dataset: Dataset { id, columns, created_at, 9 more }
encoding_version: number

Encoding version to use for dataset.

formatint32
minimum0
max_cells: number
formatint64
minimum0
version: number

The version to use when uploading the dataset.

formatint64
secret?: string

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.create(stringdatasetId, UploadCreateParams { account_id } params, RequestOptionsoptions?): NewVersion { encoding_version, max_cells, version, 3 more }
POST/accounts/{account_id}/dlp/datasets/{dataset_id}/upload
Upload a new version of a dataset
client.zeroTrust.dlp.datasets.upload.edit(stringdatasetId, numberversion, "string" | "ArrayBufferView" | "ArrayBuffer" | BlobLikedataset, UploadEditParams { account_id } params, RequestOptionsoptions?): Dataset { id, columns, created_at, 9 more }
POST/accounts/{account_id}/dlp/datasets/{dataset_id}/upload/{version}
ModelsExpand Collapse
NewVersion { encoding_version, max_cells, version, 3 more }
encoding_version: number
formatint32
minimum0
max_cells: number
formatint64
minimum0
version: number
formatint64
case_sensitive?: boolean
columns?: Array<Column>
entry_id: string
formatuuid
header_name: string
num_cells: number
formatint64
upload_status: "empty" | "uploading" | "pending" | 3 more
One of the following:
"empty"
"uploading"
"pending"
"processing"
"failed"
"complete"
secret?: string
formatpassword

DatasetsVersions

Sets the column information for a multi-column upload
client.zeroTrust.dlp.datasets.versions.create(stringdatasetId, numberversion, VersionCreateParams { account_id, body } params, RequestOptionsoptions?): SinglePage<VersionCreateResponse { entry_id, header_name, num_cells, upload_status } >
POST/accounts/{account_id}/dlp/datasets/{dataset_id}/versions/{version}
ModelsExpand Collapse
VersionCreateResponse { entry_id, header_name, num_cells, upload_status }
entry_id: string
formatuuid
header_name: string
num_cells: number
formatint64
upload_status: "empty" | "uploading" | "pending" | 3 more
One of the following:
"empty"
"uploading"
"pending"
"processing"
"failed"
"complete"

DatasetsVersionsEntries

Upload a new version of a multi-column dataset
client.zeroTrust.dlp.datasets.versions.entries.create(stringdatasetId, numberversion, stringentryId, "string" | "ArrayBufferView" | "ArrayBuffer" | BlobLikedatasetVersionEntry, EntryCreateParams { account_id } params, RequestOptionsoptions?): EntryCreateResponse { entry_id, header_name, num_cells, upload_status }
POST/accounts/{account_id}/dlp/datasets/{dataset_id}/versions/{version}/entries/{entry_id}
ModelsExpand Collapse
EntryCreateResponse { entry_id, header_name, num_cells, upload_status }
entry_id: string
formatuuid
header_name: string
num_cells: number
formatint64
upload_status: "empty" | "uploading" | "pending" | 3 more
One of the following:
"empty"
"uploading"
"pending"
"processing"
"failed"
"complete"