Create an alert channel

POST

/api/v1/alerts/channels

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

Creates a new notification channel. Config is validated against the channel type registry.

Authorizations

• ApiKeyAuth

Request Body^required

Request body

Media typeapplication/json

object

config

object

enabled

boolean

environment_id

integer

info

string

name

string

type

string

Example^generated

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

Responses

201

Created

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

409

Conflict

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