Create a Dataset
curl --request POST \
--url https://api.honeycomb.io/1/datasets \
--header 'Content-Type: application/json' \
--header 'X-Honeycomb-Team: <api-key>' \
--data '
{
"name": "<string>",
"description": "A nice description of my dataset",
"expand_json_depth": 3
}
'import requests
url = "https://api.honeycomb.io/1/datasets"
payload = {
"name": "<string>",
"description": "A nice description of my dataset",
"expand_json_depth": 3
}
headers = {
"X-Honeycomb-Team": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'X-Honeycomb-Team': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: '<string>',
description: 'A nice description of my dataset',
expand_json_depth: 3
})
};
fetch('https://api.honeycomb.io/1/datasets', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.honeycomb.io/1/datasets",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'name' => '<string>',
'description' => 'A nice description of my dataset',
'expand_json_depth' => 3
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-Honeycomb-Team: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.honeycomb.io/1/datasets"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"description\": \"A nice description of my dataset\",\n \"expand_json_depth\": 3\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("X-Honeycomb-Team", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.honeycomb.io/1/datasets")
.header("X-Honeycomb-Team", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"description\": \"A nice description of my dataset\",\n \"expand_json_depth\": 3\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.honeycomb.io/1/datasets")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["X-Honeycomb-Team"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"<string>\",\n \"description\": \"A nice description of my dataset\",\n \"expand_json_depth\": 3\n}"
response = http.request(request)
puts response.read_body{
"name": "My Dataset!",
"description": "A nice description of my dataset",
"settings": {
"delete_protected": true
},
"expand_json_depth": 3,
"slug": "my-dataset-",
"regular_columns_count": 100,
"last_written_at": "2022-07-21T18:39:23Z",
"created_at": "2022-09-22T17:32:11Z",
"dataset_type": "metrics"
}{
"name": "MyDataset!",
"slug": "mydataset-",
"description": "A nice description of my dataset",
"expand_json_depth": 3,
"created_at": "2022-07-21T18:39:23.000Z",
"last_written_at": null,
"regular_columns_count": 0
}{
"error": "unknown API key - check your credentials"
}{
"error": "Your team has been denied access to Management APIs, please contact support to be unblocked."
}{
"error": "we could not create a dataset with that name"
}{
"status": 422,
"type": "https://api.honeycomb.io/problems/validation-failed",
"error": "The provided input is invalid.",
"title": "The provided input is invalid",
"type_detail": [
{
"field": "type",
"code": "invalid",
"description": "type: must be a valid value"
}
]
}{
"error": "Rate Limited"
}{
"error": "<string>"
}Create a Dataset
Create a Dataset in the environment associated with your API key. If a Dataset already exists by that name (or slug), then the existing dataset will be returned.
POST
/
1
/
datasets
Create a Dataset
curl --request POST \
--url https://api.honeycomb.io/1/datasets \
--header 'Content-Type: application/json' \
--header 'X-Honeycomb-Team: <api-key>' \
--data '
{
"name": "<string>",
"description": "A nice description of my dataset",
"expand_json_depth": 3
}
'import requests
url = "https://api.honeycomb.io/1/datasets"
payload = {
"name": "<string>",
"description": "A nice description of my dataset",
"expand_json_depth": 3
}
headers = {
"X-Honeycomb-Team": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'X-Honeycomb-Team': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: '<string>',
description: 'A nice description of my dataset',
expand_json_depth: 3
})
};
fetch('https://api.honeycomb.io/1/datasets', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.honeycomb.io/1/datasets",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'name' => '<string>',
'description' => 'A nice description of my dataset',
'expand_json_depth' => 3
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-Honeycomb-Team: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.honeycomb.io/1/datasets"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"description\": \"A nice description of my dataset\",\n \"expand_json_depth\": 3\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("X-Honeycomb-Team", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.honeycomb.io/1/datasets")
.header("X-Honeycomb-Team", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"description\": \"A nice description of my dataset\",\n \"expand_json_depth\": 3\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.honeycomb.io/1/datasets")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["X-Honeycomb-Team"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"<string>\",\n \"description\": \"A nice description of my dataset\",\n \"expand_json_depth\": 3\n}"
response = http.request(request)
puts response.read_body{
"name": "My Dataset!",
"description": "A nice description of my dataset",
"settings": {
"delete_protected": true
},
"expand_json_depth": 3,
"slug": "my-dataset-",
"regular_columns_count": 100,
"last_written_at": "2022-07-21T18:39:23Z",
"created_at": "2022-09-22T17:32:11Z",
"dataset_type": "metrics"
}{
"name": "MyDataset!",
"slug": "mydataset-",
"description": "A nice description of my dataset",
"expand_json_depth": 3,
"created_at": "2022-07-21T18:39:23.000Z",
"last_written_at": null,
"regular_columns_count": 0
}{
"error": "unknown API key - check your credentials"
}{
"error": "Your team has been denied access to Management APIs, please contact support to be unblocked."
}{
"error": "we could not create a dataset with that name"
}{
"status": 422,
"type": "https://api.honeycomb.io/problems/validation-failed",
"error": "The provided input is invalid.",
"title": "The provided input is invalid",
"type_detail": [
{
"field": "type",
"code": "invalid",
"description": "type: must be a valid value"
}
]
}{
"error": "Rate Limited"
}{
"error": "<string>"
}Authorizations
Authenticate using a Honeycomb Configuration Key.
Pass the Token in the X-Honeycomb-Team header:
X-Honeycomb-Team: 1234567890123456789012
If you created your key using the API, use data.attributes.secret; this is the same value as the Token in the UI.
To learn how to create a Configuration Key, visit Manage Environment API Keys. To learn more about authenticating requests, visit API Authentication.
Body
application/json
The dataset will be created within the environment associated with your API key.
an object to send to the Dataset API via PUT
Response
OK - Dataset already exists
Datasets are a collection of events from a specific source or related source.