curl --request PUT \
--url https://api.honeycomb.io/1/signals/{signalId} \
--header 'Content-Type: application/json' \
--header 'X-Honeycomb-Team: <api-key>' \
--data '
{
"enabled": true,
"sensitivity": "medium",
"recipients": [
{
"id": "hcar_01jak3ymk8s5cpc2xz3q7d8v9r",
"details": {
"pagerduty_severity": "critical",
"muted": false
}
}
]
}
'import requests
url = "https://api.honeycomb.io/1/signals/{signalId}"
payload = {
"enabled": True,
"sensitivity": "medium",
"recipients": [
{
"id": "hcar_01jak3ymk8s5cpc2xz3q7d8v9r",
"details": {
"pagerduty_severity": "critical",
"muted": 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({
enabled: true,
sensitivity: 'medium',
recipients: [
{
id: 'hcar_01jak3ymk8s5cpc2xz3q7d8v9r',
details: {pagerduty_severity: 'critical', muted: false}
}
]
})
};
fetch('https://api.honeycomb.io/1/signals/{signalId}', 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/signals/{signalId}",
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([
'enabled' => true,
'sensitivity' => 'medium',
'recipients' => [
[
'id' => 'hcar_01jak3ymk8s5cpc2xz3q7d8v9r',
'details' => [
'pagerduty_severity' => 'critical',
'muted' => 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/signals/{signalId}"
payload := strings.NewReader("{\n \"enabled\": true,\n \"sensitivity\": \"medium\",\n \"recipients\": [\n {\n \"id\": \"hcar_01jak3ymk8s5cpc2xz3q7d8v9r\",\n \"details\": {\n \"pagerduty_severity\": \"critical\",\n \"muted\": false\n }\n }\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/signals/{signalId}")
.header("X-Honeycomb-Team", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"enabled\": true,\n \"sensitivity\": \"medium\",\n \"recipients\": [\n {\n \"id\": \"hcar_01jak3ymk8s5cpc2xz3q7d8v9r\",\n \"details\": {\n \"pagerduty_severity\": \"critical\",\n \"muted\": false\n }\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.honeycomb.io/1/signals/{signalId}")
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 \"enabled\": true,\n \"sensitivity\": \"medium\",\n \"recipients\": [\n {\n \"id\": \"hcar_01jak3ymk8s5cpc2xz3q7d8v9r\",\n \"details\": {\n \"pagerduty_severity\": \"critical\",\n \"muted\": false\n }\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"id": "hcasp_01j9x1yq0k2t8m9n3v4b5r6c7d",
"service_name": "checkout-api",
"dataset_slug": "checkout-api",
"environment_slug": "production",
"measured_signal": "error_rate",
"enabled": true,
"status": "normal",
"sensitivity": "medium",
"auto_investigate": false,
"currently_anomalous": false,
"last_anomaly_started_at": 1741089600,
"last_anomaly_ended_at": 1741093200,
"created_at": "2025-02-14T17:32:11Z",
"updated_at": "2025-03-01T10:04:22Z",
"recipients": [
{
"id": "hcar_01jak3ymk8s5cpc2xz3q7d8v9r",
"type": "pagerduty",
"details": {
"pagerduty_severity": "critical",
"muted": false
}
}
]
}{
"status": 400,
"type": "https://api.honeycomb.io/problems/unparseable",
"title": "The request body could not be parsed.",
"error": "invalid gzip data"
}{
"error": "unknown API key - check your credentials"
}{
"error": "Your team has been denied access to Management APIs, please contact support to be unblocked."
}{
"error": "dataset not found"
}{
"error": "dataset not found"
}{
"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>"
}Update a Signal
Update a Signal by ID. All fields in the body are optional; only the fields you supply are applied.
enabled: Toggles the Signal on or off. Re-enabling a Signal that has already trained puts it back intonormal; otherwise it returns toonboarding.sensitivity: Sets how far a measurement must deviate from the trained normal band before the Signal fires. Not applicable topresenceSignals, and cannot be set on a Signal that has not yet trained.recipients: Replaces the Signal’s Recipient set. An empty array clears all Recipients. Modifying Recipients requires the Manage Recipients permission in addition to Manage Signals.
curl --request PUT \
--url https://api.honeycomb.io/1/signals/{signalId} \
--header 'Content-Type: application/json' \
--header 'X-Honeycomb-Team: <api-key>' \
--data '
{
"enabled": true,
"sensitivity": "medium",
"recipients": [
{
"id": "hcar_01jak3ymk8s5cpc2xz3q7d8v9r",
"details": {
"pagerduty_severity": "critical",
"muted": false
}
}
]
}
'import requests
url = "https://api.honeycomb.io/1/signals/{signalId}"
payload = {
"enabled": True,
"sensitivity": "medium",
"recipients": [
{
"id": "hcar_01jak3ymk8s5cpc2xz3q7d8v9r",
"details": {
"pagerduty_severity": "critical",
"muted": 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({
enabled: true,
sensitivity: 'medium',
recipients: [
{
id: 'hcar_01jak3ymk8s5cpc2xz3q7d8v9r',
details: {pagerduty_severity: 'critical', muted: false}
}
]
})
};
fetch('https://api.honeycomb.io/1/signals/{signalId}', 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/signals/{signalId}",
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([
'enabled' => true,
'sensitivity' => 'medium',
'recipients' => [
[
'id' => 'hcar_01jak3ymk8s5cpc2xz3q7d8v9r',
'details' => [
'pagerduty_severity' => 'critical',
'muted' => 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/signals/{signalId}"
payload := strings.NewReader("{\n \"enabled\": true,\n \"sensitivity\": \"medium\",\n \"recipients\": [\n {\n \"id\": \"hcar_01jak3ymk8s5cpc2xz3q7d8v9r\",\n \"details\": {\n \"pagerduty_severity\": \"critical\",\n \"muted\": false\n }\n }\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/signals/{signalId}")
.header("X-Honeycomb-Team", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"enabled\": true,\n \"sensitivity\": \"medium\",\n \"recipients\": [\n {\n \"id\": \"hcar_01jak3ymk8s5cpc2xz3q7d8v9r\",\n \"details\": {\n \"pagerduty_severity\": \"critical\",\n \"muted\": false\n }\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.honeycomb.io/1/signals/{signalId}")
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 \"enabled\": true,\n \"sensitivity\": \"medium\",\n \"recipients\": [\n {\n \"id\": \"hcar_01jak3ymk8s5cpc2xz3q7d8v9r\",\n \"details\": {\n \"pagerduty_severity\": \"critical\",\n \"muted\": false\n }\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"id": "hcasp_01j9x1yq0k2t8m9n3v4b5r6c7d",
"service_name": "checkout-api",
"dataset_slug": "checkout-api",
"environment_slug": "production",
"measured_signal": "error_rate",
"enabled": true,
"status": "normal",
"sensitivity": "medium",
"auto_investigate": false,
"currently_anomalous": false,
"last_anomaly_started_at": 1741089600,
"last_anomaly_ended_at": 1741093200,
"created_at": "2025-02-14T17:32:11Z",
"updated_at": "2025-03-01T10:04:22Z",
"recipients": [
{
"id": "hcar_01jak3ymk8s5cpc2xz3q7d8v9r",
"type": "pagerduty",
"details": {
"pagerduty_severity": "critical",
"muted": false
}
}
]
}{
"status": 400,
"type": "https://api.honeycomb.io/problems/unparseable",
"title": "The request body could not be parsed.",
"error": "invalid gzip data"
}{
"error": "unknown API key - check your credentials"
}{
"error": "Your team has been denied access to Management APIs, please contact support to be unblocked."
}{
"error": "dataset not found"
}{
"error": "dataset not found"
}{
"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
Fields to update on the Signal. All fields are optional.
Fields to update on a Signal. All fields are optional and only supplied fields are applied.
Replace the Signal's Recipient set with the given list. An empty array clears all Recipients. Each Recipient must be referenced by its id from the Recipients API. Requires the Manage Recipients permission in addition to Manage Signals.
Show child attributes
Show child attributes
Response
Success
A Signal with its assigned Recipients.