Get one alert channel

GET

/api/v1/alerts/channels/{id}

curl --request GET \
  --url https://example.com/api/v1/alerts/channels/1 \
  --header 'Authorization: <Authorization>'

Returns a single alert channel by ID. Secrets are redacted unless reveal=1.

Authorizations

• ApiKeyAuth

Parameters

Path Parameters

id

required

integer

Channel ID

Query Parameters

reveal

integer

Pass 1 to include secret fields (admin only)

Responses

200

OK

Media typeapplication/json

object

config

object

created_at

string

enabled

boolean

environment_id

integer

id

integer

info

string

name

string

type

string

updated_at

string

Example^generated

{
  "config": {},
  "created_at": "example",
  "enabled": true,
  "environment_id": 1,
  "id": 1,
  "info": "example",
  "name": "example",
  "type": "example",
  "updated_at": "example"
}

400

Bad request

Media typeapplication/json

object

code

string

error

string

Example^generated

{
  "code": "example",
  "error": "example"
}

401

Unauthorized

Media typeapplication/json

object

code

string

error

string

Example^generated

{
  "code": "example",
  "error": "example"
}

403

Forbidden

Media typeapplication/json

object

code

string

error

string

Example^generated

{
  "code": "example",
  "error": "example"
}

404

Not found

Media typeapplication/json

object

code

string

error

string

Example^generated

{
  "code": "example",
  "error": "example"
}

503

Alerts disabled

Media typeapplication/json

object

code

string

error

string

Example^generated

{
  "code": "example",
  "error": "example"
}