Create a new dataset.
/accounts/{account_identifier}/dlp/datasets
post
DLP Datasets
dlp-datasets-create
nullnull[
{
"in": "path",
"name": "account_identifier",
"required": true,
"schema": {
"type": "string"
}
}
]{
"content": {
"application/json": {
"schema": {
"properties": {
"description": {
"nullable": true,
"type": "string"
},
"name": {
"type": "string"
},
"secret": {
"description": "Generate a secret dataset.\n\nIf true, the response will include a secret to use with the EDM encoder.\nIf false, the response has no secret and the dataset is uploaded in plaintext.",
"type": "boolean"
}
},
"required": [
"name"
],
"type": "object"
}
}
},
"description": "Dataset description",
"required": true
}{
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"properties": {
"errors": {
"items": {
"properties": {
"code": {
"format": "int32",
"minimum": 1000,
"type": "integer"
},
"message": {
"type": "string"
}
},
"required": [
"code",
"message"
],
"type": "object"
},
"type": "array"
},
"messages": {
"items": {
"properties": {
"code": {
"format": "int32",
"minimum": 1000,
"type": "integer"
},
"message": {
"type": "string"
}
},
"required": [
"code",
"message"
],
"type": "object"
},
"type": "array"
},
"result_info": {
"allOf": [
{
"properties": {
"count": {
"description": "total number of pages",
"format": "int32",
"minimum": 0,
"type": "integer"
},
"page": {
"description": "current page",
"format": "int32",
"minimum": 0,
"type": "integer"
},
"per_page": {
"description": "number of items per page",
"format": "int32",
"minimum": 0,
"type": "integer"
},
"total_count": {
"description": "total number of items",
"format": "int32",
"minimum": 0,
"type": "integer"
}
},
"required": [
"page",
"per_page",
"count",
"total_count"
],
"type": "object"
}
]
},
"success": {
"type": "boolean"
}
},
"required": [
"success",
"errors",
"messages"
],
"type": "object"
},
{
"properties": {
"result": {
"properties": {
"dataset": {
"properties": {
"created_at": {
"format": "date-time",
"type": "string"
},
"description": {
"nullable": true,
"type": "string"
},
"id": {
"format": "uuid",
"type": "string"
},
"name": {
"type": "string"
},
"num_cells": {
"format": "int64",
"type": "integer"
},
"secret": {
"type": "boolean"
},
"status": {
"enum": [
"empty",
"uploading",
"failed",
"complete"
],
"type": "string"
},
"updated_at": {
"format": "date-time",
"type": "string"
},
"uploads": {
"items": {
"properties": {
"num_cells": {
"format": "int64",
"type": "integer"
},
"status": {
"enum": [
"empty",
"uploading",
"failed",
"complete"
],
"type": "string"
},
"version": {
"format": "int64",
"type": "integer"
}
},
"required": [
"version",
"status",
"num_cells"
],
"type": "object"
},
"type": "array"
}
},
"required": [
"name",
"id",
"status",
"num_cells",
"created_at",
"updated_at",
"uploads",
"secret"
],
"type": "object"
},
"max_cells": {
"format": "int64",
"minimum": 0,
"type": "integer"
},
"secret": {
"description": "The secret to use for Exact Data Match datasets. This is not present in\nCustom Wordlists.",
"format": "password",
"type": "string"
},
"version": {
"description": "The version to use when uploading the dataset.",
"format": "int64",
"type": "integer"
}
},
"required": [
"version",
"max_cells",
"dataset"
],
"type": "object"
}
},
"type": "object"
}
]
}
}
},
"description": "Dataset created successfully"
},
"4XX": {
"content": {
"application/json": {
"schema": {
"properties": {
"errors": {
"items": {
"properties": {
"code": {
"format": "int32",
"minimum": 1000,
"type": "integer"
},
"message": {
"type": "string"
}
},
"required": [
"code",
"message"
],
"type": "object"
},
"type": "array"
},
"messages": {
"items": {
"properties": {
"code": {
"format": "int32",
"minimum": 1000,
"type": "integer"
},
"message": {
"type": "string"
}
},
"required": [
"code",
"message"
],
"type": "object"
},
"type": "array"
},
"result": {
"nullable": true,
"type": "object"
},
"success": {
"type": "boolean"
}
},
"required": [
"success",
"errors",
"messages"
],
"type": "object"
}
}
},
"description": "Dataset creation failed"
}
}[
{
"api_token": []
},
{
"api_email": [],
"api_key": []
},
{
"api_email": [],
"api_key": []
}
]