Documentation · API reference
GET
/api/v1/channelsWhere alerts go
This page as Markdown, or in an AI chatMore ways to read this page
Where alerts go: each channel, and whether it is on.
# Where alerts go
> tidekeeper's API reference: https://tidekeeper.eu/docs/api/get-channels
`GET /api/v1/channels`
Where alerts go: each channel, and whether it is on.
## The answer
200, `A list of ChannelView`: Somewhere alerts go. Its secrets are never sent back: `target` says where it points with them left out.
- `created_at` (string, needed)
- `declared` (boolean, needed): From the instance's configuration: not edited here.
- `disabled` (boolean, needed)
- `id` (string, needed)
- `kind` (string, needed): `alertmanager`, `email`, `webhook`, `ntfy`, `discord`, `slack`, `telegram`.
- `kinds` (list of string, needed): The alerts this channel is told about: its row of the matrix.
- `name` (string, needed)
- `target` (string, needed)
## Asking
```sh
curl https://tidekeeper.eu/api/v1/channels \
-H "Authorization: Bearer $TIDEKEEPER_TOKEN"
```
The answer
Status 200
A list of ChannelView Somewhere alerts go. Its secrets are never sent back: `target` says where it points with them left out.
- created_at
- stringneeded
- declared
- booleanneededFrom the instance's configuration: not edited here.
- disabled
- booleanneeded
- id
- stringneeded
- kind
- stringneeded`alertmanager`, `email`, `webhook`, `ntfy`, `discord`, `slack`, `telegram`.
- kinds
- list of stringneededThe alerts this channel is told about: its row of the matrix.
- name
- stringneeded
- target
- stringneeded
Asking
curl https://tidekeeper.eu/api/v1/channels \ -H "Authorization: Bearer $TIDEKEEPER_TOKEN"
const answer = await fetch("https://tidekeeper.eu/api/v1/channels", { headers: { Authorization: `Bearer ${process.env.TIDEKEEPER_TOKEN}`, }, }).then((r) => r.json());