Create alert rule

post

https://example.com/api/v1/alerts/rules/

Create a new alert rule.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

Request body for creating an alert rule.

name

string

required

length between 1 and 100

Alert rule name

type

string | null

Simple rule type

operator

string

enum

Defaults to eq

eq - eq
neq - neq
ne - ne
lt - lt
le - le
gt - gt
ge - ge
contains - contains
startswith - startswith
endswith - endswith
regex - regex
in - in

value

string | null

Comparison value

conditions

object | null

Complex conditions with multiple groups.

description

string

length between 1 and 200

Rule description

enabled

boolean

Defaults to true

Rule enabled status

priority

string

enum

Defaults to info

info - info
warning - warning
critical - critical

Allowed:

starts_at

date-time | null

Rule activation time

expires_at

date-time | null

Rule expiration time

api_url

string | null

External API to fetch when triggered

cooldown_minutes

integer

0 to 1440

Defaults to 5

Cooldown in minutes before rule can trigger again for same aircraft

visibility

string

enum

Defaults to private

private - private
shared - shared
public - public

Allowed:

suppression_windows

array of objects

Time windows when rule should not trigger

suppression_windows

notification_channel_ids

array of integers

IDs of notification channels to use for this rule

notification_channel_ids

use_global_notifications

boolean

Defaults to true

Also send to global notification URLs from environment

Headers

content-type

string

enum

Defaults to application/json

Generated from available request content types

Allowed:

Response

Language

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

201