Set where a monitor's alerts go
const url = 'https://dev.tunnelhq.com/api/v1/servers/srv_42/channels';const options = { method: 'PUT', headers: { 'X-Project-Id': 'prj_12', 'X-API-Key': '<X-API-Key>', 'Content-Type': 'application/json' }, body: '{"channel_ids":["chn_21","chn_22"]}'};
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}curl --request PUT \ --url https://dev.tunnelhq.com/api/v1/servers/srv_42/channels \ --header 'Content-Type: application/json' \ --header 'X-API-Key: <X-API-Key>' \ --header 'X-Project-Id: prj_12' \ --data '{ "channel_ids": [ "chn_21", "chn_22" ] }'Replaces the whole list of channels a check’s or tunnel’s alerts go to. Send every channel it should keep:
Get where a monitor’s alerts go gives
the current list. An empty list ([]) means its alerts go to no channel.
Channel IDs come from List alert channels. A channel already linked to it is accepted too, so you can always send back the list you read. A channel of another project is refused by name. Up to 50 channels.
It needs a role that can edit monitors (Owner, Admin and Manager have it by default).
Need an API key? See Getting an API key.
Authorizations
Section titled “Authorizations”Parameters
Section titled “ Parameters ”Path Parameters
Section titled “Path Parameters”The monitor, as srv_42 or 42.
Example
srv_42Header Parameters
Section titled “Header Parameters”The project, as prj_12 or 12. A workspace key can only reach its own workspace’s projects.
Example
prj_12Request Bodyrequired
Section titled “Request Bodyrequired”object
Every channel its alerts should go to, as chn_21 or 21. [] for none.
Examples
Two channels
{ "channel_ids": [ "chn_21", "chn_22" ]}No channel
{ "channel_ids": []}Responses
Section titled “ Responses ”Its channels after the change.
object
The check or tunnel.
The IDs of channels, ready to change and send back.
An alert channel, without its settings.
object
The kind of channel, such as slack, telegram, smtp (email), or webhook.
Whether the channel is switched on. One that is off sends nothing.
Examples
A check whose alerts go to two channels
{ "id": "srv_42", "channel_ids": [ "chn_21", "chn_22" ], "channels": [ { "id": "chn_21", "name": "Ops Slack", "type": "slack", "active": true }, { "id": "chn_22", "name": "On call email", "type": "smtp", "active": true } ]}Headers
Section titled “Headers”Requests the workspace’s plan allows per minute.
Requests left in the current minute.
Unix time, in seconds, when the current minute ends.
The list isn’t a list of channel IDs, has more than 50, names a channel of another project, or the monitor is a group.
object
The HTTP status, repeated.
What went wrong.
More detail, on some errors.
Seconds to wait, on the 429 for wrong keys.
Examples
{ "error": true, "code": 400, "message": "channel_ids must be a list of channel ids from GET /api/v1/channels, such as [\"chn_12\"]; [] means no channel."}{ "error": true, "code": 400, "message": "Not a channel of this project: chn_99. GET /api/v1/channels lists them."}{ "error": true, "code": 400, "message": "A group sends no alerts of its own: give its checks or tunnels their channels."}The API key is missing, wrong, expired, switched off, or no longer valid.
object
The HTTP status, repeated.
What went wrong.
More detail, on some errors.
Seconds to wait, on the 429 for wrong keys.
Examples
{ "error": true, "code": 401, "message": "API key is required. Provide X-API-Key header or Authorization: Bearer <key>"}{ "error": true, "code": 401, "message": "Invalid or expired API key"}{ "error": true, "code": 401, "message": "API key has expired"}{ "error": true, "code": 401, "message": "API key owner account is inactive"}{ "error": true, "code": 401, "message": "This API key's workspace access has been removed"}Your role can’t edit monitors.
object
The HTTP status, repeated.
What went wrong.
More detail, on some errors.
Seconds to wait, on the 429 for wrong keys.
Example
{ "error": true, "code": 403, "message": "Changing where alerts go needs a role that can edit monitors."}The project has no check or tunnel with this ID, or the project doesn’t exist.
object
The HTTP status, repeated.
What went wrong.
More detail, on some errors.
Seconds to wait, on the 429 for wrong keys.
Examples
{ "error": true, "code": 404, "message": "Check or tunnel not found"}{ "error": true, "code": 404, "message": "Project not found"}A usage limit was reached, or this IP address made too many requests with a wrong key.
Usage limits are per workspace and plan: per minute (Retry-After: 60), per day
(Retry-After: 3600), and per month (no Retry-After). They use their own body shape.
An IP address may send 10 wrong keys a minute; one more is allowed every 6 seconds. While
that allowance is used up, every request from the address is refused, even one with a
valid key.
object
Seconds to wait. Absent for the monthly limit.
object
The HTTP status, repeated.
What went wrong.
More detail, on some errors.
Seconds to wait, on the 429 for wrong keys.
Examples
{ "error": "Rate limit exceeded", "message": "Per-minute limit of 60 requests exceeded", "retry_after": 60}{ "error": "Daily limit exceeded", "message": "Daily limit of 25000 requests exceeded", "retry_after": 3600}{ "error": "Monthly limit exceeded", "message": "Monthly limit of 250000 requests exceeded"}{ "error": true, "code": 429, "message": "Too many failed API key attempts from this address. Wait a few seconds and try again.", "retry_after": 6}Headers
Section titled “Headers”Seconds to wait. 60 for the per-minute limit, 3600 for the daily limit, 6 after wrong keys. Absent for the monthly limit.
Something failed on TunnelHQ’s side.
object
The HTTP status, repeated.
What went wrong.
More detail, on some errors.
Seconds to wait, on the 429 for wrong keys.
Example
{ "error": true, "code": 500, "message": "Internal server error"}