Create a new dataset

client.ZeroTrust.DLP.Datasets.New(ctx, params) (*DatasetCreation, error)

POST/accounts/{account_id}/dlp/datasets

Creates a new DLP (Data Loss Prevention) dataset for storing custom detection patterns. Datasets can contain exact match data, word lists, or EDM (Exact Data Match) configurations.

Security

API Token

The preferred authorization scheme for interacting with the Cloudflare API. Create a token.

Example:Authorization: Bearer Sn3lZJTBX6kkg7OdcBUAxOO963GEIyGQqnFTOFYY

API Email + API Key

The previous authorization scheme for interacting with the Cloudflare API, used in conjunction with a Global API key.

Example:X-Auth-Email: user@example.com

The previous authorization scheme for interacting with the Cloudflare API. When possible, use API tokens instead of Global API keys.

Example:X-Auth-Key: 144c9defac04969c7bfad8efaa8ea194

Accepted Permissions (at least one required)

Zero Trust Write

ParametersExpand Collapse

params DLPDatasetNewParams

AccountID param.Field[string]

Path param

Name param.Field[string]

Body param

CaseSensitive param.Field[bool]Optional

Body param: 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 or undefined

Description param.Field[string]Optional

Body param: The description of the dataset.

EncodingVersion param.Field[int64]Optional

Body param: Dataset encoding version

Non-secret custom word lists with no header are always version 1. Secret EDM lists with no header are version 1. Multicolumn CSV with headers are version 2. Omitting this field provides the default value 0, which is interpreted the same as 1.

formatint32

minimum0

Secret param.Field[bool]Optional

Body param: Generate a secret dataset.

If true, the response will include a secret to use with the EDM encoder. If false, the response has no secret and the dataset is uploaded in plaintext.

ReturnsExpand Collapse

type DatasetCreation struct{…}

Dataset 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.

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

Create a new dataset

package main

import (
  "context"
  "fmt"

  "github.com/stainless-sdks/cloudflare-go"
  "github.com/stainless-sdks/cloudflare-go/option"
  "github.com/stainless-sdks/cloudflare-go/zero_trust"
)

func main() {
  client := cloudflare.NewClient(
    option.WithAPIToken("Sn3lZJTBX6kkg7OdcBUAxOO963GEIyGQqnFTOFYY"),
  )
  datasetCreation, err := client.ZeroTrust.DLP.Datasets.New(context.TODO(), zero_trust.DLPDatasetNewParams{
    AccountID: cloudflare.F("account_id"),
    Name: cloudflare.F("name"),
  })
  if err != nil {
    panic(err.Error())
  }
  fmt.Printf("%+v\n", datasetCreation.Dataset)
}

{
  "errors": [
    {
      "code": 1000,
      "message": "message",
      "documentation_url": "documentation_url",
      "source": {
        "pointer": "pointer"
      }
    }
  ],
  "messages": [
    {
      "code": 1000,
      "message": "message",
      "documentation_url": "documentation_url",
      "source": {
        "pointer": "pointer"
      }
    }
  ],
  "success": true,
  "result": {
    "dataset": {
      "id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
      "columns": [
        {
          "entry_id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
          "header_name": "header_name",
          "num_cells": 0,
          "upload_status": "empty"
        }
      ],
      "created_at": "2019-12-27T18:11:19.117Z",
      "encoding_version": 0,
      "name": "name",
      "num_cells": 0,
      "secret": true,
      "status": "empty",
      "updated_at": "2019-12-27T18:11:19.117Z",
      "uploads": [
        {
          "num_cells": 0,
          "status": "empty",
          "version": 0
        }
      ],
      "case_sensitive": true,
      "description": "description"
    },
    "encoding_version": 0,
    "max_cells": 0,
    "version": 0,
    "secret": "secret"
  }
}

Returns Examples

{
  "errors": [
    {
      "code": 1000,
      "message": "message",
      "documentation_url": "documentation_url",
      "source": {
        "pointer": "pointer"
      }
    }
  ],
  "messages": [
    {
      "code": 1000,
      "message": "message",
      "documentation_url": "documentation_url",
      "source": {
        "pointer": "pointer"
      }
    }
  ],
  "success": true,
  "result": {
    "dataset": {
      "id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
      "columns": [
        {
          "entry_id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
          "header_name": "header_name",
          "num_cells": 0,
          "upload_status": "empty"
        }
      ],
      "created_at": "2019-12-27T18:11:19.117Z",
      "encoding_version": 0,
      "name": "name",
      "num_cells": 0,
      "secret": true,
      "status": "empty",
      "updated_at": "2019-12-27T18:11:19.117Z",
      "uploads": [
        {
          "num_cells": 0,
          "status": "empty",
          "version": 0
        }
      ],
      "case_sensitive": true,
      "description": "description"
    },
    "encoding_version": 0,
    "max_cells": 0,
    "version": 0,
    "secret": "secret"
  }
}