Update a Dataset
curl --request PUT \
--url https://api.honeycomb.io/1/datasets/{datasetSlug} \
--header 'Content-Type: application/json' \
--header 'X-Honeycomb-Team: <api-key>' \
--data '
{
"expand_json_depth": 3,
"description": "my updated description",
"settings": {
"delete_protected": false
}
}
'import requests
url = "https://api.honeycomb.io/1/datasets/{datasetSlug}"
payload = {
"expand_json_depth": 3,
"description": "my updated description",
"settings": { "delete_protected": False }
}
headers = {
"X-Honeycomb-Team": "<api-key>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {'X-Honeycomb-Team': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
expand_json_depth: 3,
description: 'my updated description',
settings: {delete_protected: false}
})
};
fetch('https://api.honeycomb.io/1/datasets/{datasetSlug}', 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/{datasetSlug}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_POSTFIELDS => json_encode([
'expand_json_depth' => 3,
'description' => 'my updated description',
'settings' => [
'delete_protected' => false
]
]),
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/{datasetSlug}"
payload := strings.NewReader("{\n \"expand_json_depth\": 3,\n \"description\": \"my updated description\",\n \"settings\": {\n \"delete_protected\": false\n }\n}")
req, _ := http.NewRequest("PUT", 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.put("https://api.honeycomb.io/1/datasets/{datasetSlug}")
.header("X-Honeycomb-Team", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"expand_json_depth\": 3,\n \"description\": \"my updated description\",\n \"settings\": {\n \"delete_protected\": false\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.honeycomb.io/1/datasets/{datasetSlug}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["X-Honeycomb-Team"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"expand_json_depth\": 3,\n \"description\": \"my updated description\",\n \"settings\": {\n \"delete_protected\": false\n }\n}"
response = http.request(request)
puts response.read_body{
"name": "My Dataset!",
"slug": "my-dataset-",
"description": "my updated description",
"settings": {
"delete_protected": false
},
"expand_json_depth": 3,
"created_at": "2022-07-21T18:39:23Z",
"last_written_at": "2022-09-22T17:32:03Z",
"regular_columns_count": 100
}{
"error": "unknown API key - check your credentials"
}{
"error": "dataset not found"
}{
"error": "Rate Limited"
}Update a Dataset
Update a Dataset’s settings.
PUT
/
1
/
datasets
/
{datasetSlug}
Update a Dataset
curl --request PUT \
--url https://api.honeycomb.io/1/datasets/{datasetSlug} \
--header 'Content-Type: application/json' \
--header 'X-Honeycomb-Team: <api-key>' \
--data '
{
"expand_json_depth": 3,
"description": "my updated description",
"settings": {
"delete_protected": false
}
}
'import requests
url = "https://api.honeycomb.io/1/datasets/{datasetSlug}"
payload = {
"expand_json_depth": 3,
"description": "my updated description",
"settings": { "delete_protected": False }
}
headers = {
"X-Honeycomb-Team": "<api-key>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {'X-Honeycomb-Team': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
expand_json_depth: 3,
description: 'my updated description',
settings: {delete_protected: false}
})
};
fetch('https://api.honeycomb.io/1/datasets/{datasetSlug}', 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/{datasetSlug}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_POSTFIELDS => json_encode([
'expand_json_depth' => 3,
'description' => 'my updated description',
'settings' => [
'delete_protected' => false
]
]),
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/{datasetSlug}"
payload := strings.NewReader("{\n \"expand_json_depth\": 3,\n \"description\": \"my updated description\",\n \"settings\": {\n \"delete_protected\": false\n }\n}")
req, _ := http.NewRequest("PUT", 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.put("https://api.honeycomb.io/1/datasets/{datasetSlug}")
.header("X-Honeycomb-Team", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"expand_json_depth\": 3,\n \"description\": \"my updated description\",\n \"settings\": {\n \"delete_protected\": false\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.honeycomb.io/1/datasets/{datasetSlug}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["X-Honeycomb-Team"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"expand_json_depth\": 3,\n \"description\": \"my updated description\",\n \"settings\": {\n \"delete_protected\": false\n }\n}"
response = http.request(request)
puts response.read_body{
"name": "My Dataset!",
"slug": "my-dataset-",
"description": "my updated description",
"settings": {
"delete_protected": false
},
"expand_json_depth": 3,
"created_at": "2022-07-21T18:39:23Z",
"last_written_at": "2022-09-22T17:32:03Z",
"regular_columns_count": 100
}{
"error": "unknown API key - check your credentials"
}{
"error": "dataset not found"
}{
"error": "Rate Limited"
}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
Update a Dataset's settings. All fields must be specified, as omitting one will have the effect of reverting the setting to the default.
an object to send to the Dataset API via PUT
Response
Updated
Datasets are a collection of events from a specific source or related source.