Sets the column information for a multi-column upload

client.zeroTrust.dlp.datasets.versions.create(, , ?): SinglePage<VersionCreateResponse { entry_id, header_name, num_cells, upload_status } >

POST/accounts/{account_id}/dlp/datasets/{dataset_id}/versions/{version}

This is used for multi-column EDMv2 datasets. The EDMv2 format can only be created in the Cloudflare dashboard. The columns in the response appear in the same order as in the request.

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

version: number

formatint64

params: VersionCreateParams { account_id, dataset_id, body }

account_id: string

Path param

dataset_id: string

Path param

formatuuid

body: Array<ExistingColumn { entry_id, header_name, num_cells } | NewColumn { entry_name, header_name, num_cells } >

Body param

One of the following:

ExistingColumn { entry_id, header_name, num_cells }

entry_id: string

formatuuid

header_name?: string

num_cells?: number

formatint64

minimum0

NewColumn { entry_name, header_name, num_cells }

entry_name: string

header_name?: string

num_cells?: number

formatint64

minimum0

ReturnsExpand 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"

Sets the column information for a multi-column upload

import Cloudflare from 'cloudflare';

const client = new Cloudflare({
  apiToken: process.env['CLOUDFLARE_API_TOKEN'], // This is the default and can be omitted
});

// Automatically fetches more pages as needed.
for await (const versionCreateResponse of client.zeroTrust.dlp.datasets.versions.create(0, {
  account_id: 'account_id',
  dataset_id: '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
  body: [{ entry_id: '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e' }],
})) {
  console.log(versionCreateResponse.entry_id);
}

{
  "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": [
    {
      "entry_id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
      "header_name": "header_name",
      "num_cells": 0,
      "upload_status": "empty"
    }
  ]
}

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": [
    {
      "entry_id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
      "header_name": "header_name",
      "num_cells": 0,
      "upload_status": "empty"
    }
  ]
}