Skip to main content
POST
/
datasets
Create a new dataset
curl --request POST \
  --url https://api.eu.bronto.io/datasets \
  --header 'Content-Type: application/json' \
  --header 'X-BRONTO-API-KEY: <api-key>' \
  --data '
{
  "collection": "demo",
  "dataset": "http"
}
'
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "collection": "demo",
  "dataset": "firewall",
  "is_system_generated": false,
  "tags": {
    "region": "eu",
    "environment": "production"
  },
  "parser_id": "266ea07d-b013-47c1-9c74-635e42b22cbb",
  "metadata": {
    "created_at": 123,
    "created_by": {
      "type": "API_KEY_ID",
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
    },
    "updated_at": 123,
    "updated_by": {
      "type": "API_KEY_ID",
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
    }
  }
}

Authorizations

​
X-BRONTO-API-KEY
string
header
required

Body

application/json

Identifies a dataset using its collection and dataset name.

​
collection
string
required

The name of the log collection.

Required string length: 1 - 255
Example:

"demo"

​
dataset
string

The name of the dataset within the collection.

Required string length: 1 - 255
Example:

"http"

Response

Dataset created successfully

Configuration for a dataset.

​
id
string<uuid>
required

The unique identifier of the dataset.

​
collection
string
required

Name of the log collection.

Required string length: 1 - 255
Example:

"demo"

​
dataset
string
required

Name of the dataset within the collection.

Required string length: 1 - 255
Example:

"firewall"

​
is_system_generated
boolean

Whether the dataset is generated by the system.

Example:

false

​
tags
object

A map of key value pairs associated with this log

Example:
{
  "region": "eu",
  "environment": "production"
}
​
parser_id
string<uuid>

Identifier of the parser used to process incoming events for this dataset.

Example:

"266ea07d-b013-47c1-9c74-635e42b22cbb"

​
metadata
object

Common metadata attached to all persisted resources.