1. Docs
2. API
3. Datasets API

Datasets API

This API allows you to create a dataset. Datasets are created automatically for you when events are received. The intended use case of this API is for creating a dataset programmatically in a Config-as-Code/Infrastructure-as-Code context as a preface to using the Columns or Derived Columns APIs.

Authorization and Headers  🔗

The only expected header is X-Honeycomb-Team, which is your Team API key, and it is required. The API key must have the Create Datasets permission. Learn more about API keys.

Create a Dataset  🔗

Datasets are created by sending a POST request to /1/datasets.

The body should be a JSON encoded object containing a name.

Response status should be 201, and the body will contain the created dataset, including its slug.

Create Example Request  🔗

curl https://api.honeycomb.io/1/datasets \
    -X POST \
    -H "X-Honeycomb-Team: $LIBHONEY_WRITE_KEY" \
    -d '{"name": "my dataset!"}'

Create Example Response  🔗

{
  "name": "my dataset!",
  "slug": "my-dataset-"
}

Get One Dataset  🔗

A singular Dataset may be retrieved by sending a GET request to /1/datasets/$DATASET_SLUG.

Get One Example Request  🔗

curl https://api.honeycomb.io/1/datasets/my-dataset- \
    -X GET \
    -H "X-Honeycomb-Team: $LIBHONEY_WRITE_KEY"

Get One Example Response  🔗

{
  "name": "my dataset!",
  "slug": "my-dataset-"
}

Get All Datasets  🔗

All Datasets for your team may be retrieved by sending a GET request to /1/datasets.

Get All Example Request  🔗

curl https://api.honeycomb.io/1/datasets \
    -X GET \
    -H "X-Honeycomb-Team: $LIBHONEY_WRITE_KEY"

Get All Example Response  🔗

[
  {
    "name": "my dataset!",
    "slug": "my-dataset-"
  }
]