Test an alert channel

POST

/api/v1/alerts/channels/test

curl --request POST \
  --url https://example.com/api/v1/alerts/channels/test \
  --header 'Authorization: <Authorization>' \
  --header 'Content-Type: application/json' \
  --data '{ "config": {}, "id": 1, "type": "example" }'

Delivers a test notification through the posted channel config. Secrets left as “***” are merged from the stored channel named by id.

Authorizations

• ApiKeyAuth

Request Body^required

Request body

Media typeapplication/json

object

config

object

id

integer

type

string

Example^generated

{
  "config": {},
  "id": 1,
  "type": "example"
}

Responses

200

OK

Media typeapplication/json

object

message

string

Example^generated

{
  "message": "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"
}

502

Delivery failed

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"
}