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

Datasets

Fetch all datasets
zero_trust.dlp.datasets.list(DatasetListParams**kwargs) -> SyncSinglePage[Dataset]
GET/accounts/{account_id}/dlp/datasets
Fetch a specific dataset
zero_trust.dlp.datasets.get(strdataset_id, DatasetGetParams**kwargs) -> Dataset
GET/accounts/{account_id}/dlp/datasets/{dataset_id}
Create a new dataset
zero_trust.dlp.datasets.create(DatasetCreateParams**kwargs) -> DatasetCreation
POST/accounts/{account_id}/dlp/datasets
Update details about a dataset
zero_trust.dlp.datasets.update(strdataset_id, DatasetUpdateParams**kwargs) -> Dataset
PUT/accounts/{account_id}/dlp/datasets/{dataset_id}
Delete a dataset
zero_trust.dlp.datasets.delete(strdataset_id, DatasetDeleteParams**kwargs)
DELETE/accounts/{account_id}/dlp/datasets/{dataset_id}
ModelsExpand Collapse
class Dataset: …
id: str
formatuuid
columns: List[Column]
entry_id: str
formatuuid
header_name: str
num_cells: int
formatint64
upload_status: Literal["empty", "uploading", "pending", 3 more]
One of the following:
"empty"
"uploading"
"pending"
"processing"
"failed"
"complete"
created_at: datetime
formatdate-time
encoding_version: int
formatint32
minimum0
name: str
num_cells: int
formatint64
secret: bool
status: Literal["empty", "uploading", "pending", 3 more]
One of the following:
"empty"
"uploading"
"pending"
"processing"
"failed"
"complete"
updated_at: datetime

Stores when the dataset was last updated.

This includes name or description changes as well as uploads.

formatdate-time
uploads: List[Upload]
num_cells: int
formatint64
status: Literal["empty", "uploading", "pending", 3 more]
One of the following:
"empty"
"uploading"
"pending"
"processing"
"failed"
"complete"
version: int
formatint64
case_sensitive: Optional[bool]
description: Optional[str]

The description of the dataset.

List[Dataset]
id: str
formatuuid
columns: List[Column]
entry_id: str
formatuuid
header_name: str
num_cells: int
formatint64
upload_status: Literal["empty", "uploading", "pending", 3 more]
One of the following:
"empty"
"uploading"
"pending"
"processing"
"failed"
"complete"
created_at: datetime
formatdate-time
encoding_version: int
formatint32
minimum0
name: str
num_cells: int
formatint64
secret: bool
status: Literal["empty", "uploading", "pending", 3 more]
One of the following:
"empty"
"uploading"
"pending"
"processing"
"failed"
"complete"
updated_at: datetime

Stores when the dataset was last updated.

This includes name or description changes as well as uploads.

formatdate-time
uploads: List[Upload]
num_cells: int
formatint64
status: Literal["empty", "uploading", "pending", 3 more]
One of the following:
"empty"
"uploading"
"pending"
"processing"
"failed"
"complete"
version: int
formatint64
case_sensitive: Optional[bool]
description: Optional[str]

The description of the dataset.

class DatasetCreation: …
dataset: Dataset
encoding_version: int

Encoding version to use for dataset.

formatint32
minimum0
max_cells: int
formatint64
minimum0
version: int

The version to use when uploading the dataset.

formatint64
secret: Optional[str]

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
zero_trust.dlp.datasets.upload.create(strdataset_id, UploadCreateParams**kwargs) -> NewVersion
POST/accounts/{account_id}/dlp/datasets/{dataset_id}/upload
Upload a new version of a dataset
zero_trust.dlp.datasets.upload.edit(intversion, objectdataset, UploadEditParams**kwargs) -> Dataset
POST/accounts/{account_id}/dlp/datasets/{dataset_id}/upload/{version}
ModelsExpand Collapse
class NewVersion: …
encoding_version: int
formatint32
minimum0
max_cells: int
formatint64
minimum0
version: int
formatint64
case_sensitive: Optional[bool]
columns: Optional[List[Column]]
entry_id: str
formatuuid
header_name: str
num_cells: int
formatint64
upload_status: Literal["empty", "uploading", "pending", 3 more]
One of the following:
"empty"
"uploading"
"pending"
"processing"
"failed"
"complete"
secret: Optional[str]
formatpassword

DatasetsVersions

Sets the column information for a multi-column upload
zero_trust.dlp.datasets.versions.create(intversion, VersionCreateParams**kwargs) -> SyncSinglePage[VersionCreateResponse]
POST/accounts/{account_id}/dlp/datasets/{dataset_id}/versions/{version}
ModelsExpand Collapse
class VersionCreateResponse: …
entry_id: str
formatuuid
header_name: str
num_cells: int
formatint64
upload_status: Literal["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
zero_trust.dlp.datasets.versions.entries.create(strentry_id, objectdataset_version_entry, EntryCreateParams**kwargs) -> EntryCreateResponse
POST/accounts/{account_id}/dlp/datasets/{dataset_id}/versions/{version}/entries/{entry_id}
ModelsExpand Collapse
class EntryCreateResponse: …
entry_id: str
formatuuid
header_name: str
num_cells: int
formatint64
upload_status: Literal["empty", "uploading", "pending", 3 more]
One of the following:
"empty"
"uploading"
"pending"
"processing"
"failed"
"complete"