Create an alert rule

POST

/api/v1/alerts/rules

curl --request POST \
  --url https://example.com/api/v1/alerts/rules \
  --header 'Authorization: <Authorization>' \
  --header 'Content-Type: application/json' \
  --data '{ "channel_ids": [ 1 ], "cooldown_minutes": 1, "enabled": true, "environment_id": 1, "info": "example", "match_field": "example", "match_type": "example", "match_value": "example", "name": "example", "node_uuid": "example", "source": "example", "status_severity": "example" }'

Creates a new alert rule for the given environment (or global when environment_id is 0).

Authorizations

• ApiKeyAuth

Request Body^required

Request body

Media typeapplication/json

object

channel_ids

Array<integer>

cooldown_minutes

integer

enabled

boolean

environment_id

integer

info

string

match_field

string

match_type

string

match_value

string

name

string

node_uuid

NodeUUID optionally scopes the rule to one node (used by the node detail page’s “Alert on this node” button). Empty = all nodes.

string

source

string

status_severity

string

Example^generated

{
  "channel_ids": [
    1
  ],
  "cooldown_minutes": 1,
  "enabled": true,
  "environment_id": 1,
  "info": "example",
  "match_field": "example",
  "match_type": "example",
  "match_value": "example",
  "name": "example",
  "node_uuid": "example",
  "source": "example",
  "status_severity": "example"
}

Responses

201

Created

Media typeapplication/json

object

channel_ids

Array<integer>

cooldown_minutes

integer

created_at

string

enabled

boolean

environment_id

integer

id

integer

info

string

match_field

string

match_type

string

match_value

string

name

string

node_uuid

string

source

string

status_severity

string

updated_at

string

Example^generated

{
  "channel_ids": [
    1
  ],
  "cooldown_minutes": 1,
  "created_at": "example",
  "enabled": true,
  "environment_id": 1,
  "id": 1,
  "info": "example",
  "match_field": "example",
  "match_type": "example",
  "match_value": "example",
  "name": "example",
  "node_uuid": "example",
  "source": "example",
  "status_severity": "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"
}