Skip to main content
GET
/
1
/
marker_settings
/
{datasetSlug}
Get a Marker Setting
curl --request GET \
  --url https://api.honeycomb.io/1/marker_settings/{datasetSlug} \
  --header 'X-Honeycomb-Team: <api-key>'
import requests

url = "https://api.honeycomb.io/1/marker_settings/{datasetSlug}"

headers = {"X-Honeycomb-Team": "<api-key>"}

response = requests.get(url, headers=headers)

print(response.text)
const options = {method: 'GET', headers: {'X-Honeycomb-Team': '<api-key>'}};

fetch('https://api.honeycomb.io/1/marker_settings/{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/marker_settings/{datasetSlug}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "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"
	"net/http"
	"io"
)

func main() {

	url := "https://api.honeycomb.io/1/marker_settings/{datasetSlug}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("X-Honeycomb-Team", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.get("https://api.honeycomb.io/1/marker_settings/{datasetSlug}")
  .header("X-Honeycomb-Team", "<api-key>")
  .asString();
require 'uri'
require 'net/http'

url = URI("https://api.honeycomb.io/1/marker_settings/{datasetSlug}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["X-Honeycomb-Team"] = '<api-key>'

response = http.request(request)
puts response.read_body
[
  {
    "type": "deploy",
    "color": "#7b1fa2",
    "id": "gwAHiE5TS4j",
    "created_at": "2022-09-15T05:39:42Z",
    "updated_at": "2022-12-15T04:25:14Z"
  }
]
{
  "error": "<string>"
}
{
  "error": "Rate Limited"
}

Authorizations

​
X-Honeycomb-Team
string
header
required

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.

Path Parameters

​
datasetSlug
string
required

The dataset slug or use __all__ for endpoints that support environment-wide operations.

Response

Success

​
type
string
required

Groups similar Markers. For example, 'deploys'. All Markers of the same type appears with the same color on the graph.

Example:

"deploy"

​
color
string
required

Color to use for display of this marker type. Specified as hexadecimal RGB. For example, "#F96E11".

Example:

"#7b1fa2"

​
id
string
read-only

The unique identifier (ID) for the Marker Setting.

Example:

"gwAHiE5TS4j"

​
created_at
string
read-only

The ISO8601-formatted time when the Marker Setting was created.

Example:

"2022-09-15T05:39:42Z"

​
updated_at
null | string
read-only

The ISO8601-formatted time when the Marker Setting was updated.

Example:

"2022-12-15T04:25:14Z"