List alert rules

GET

/api/v1/alert-rules

const url = 'http://localhost:3000/api/v1/alert-rules';
const options = {method: 'GET', headers: {'X-API-Key': '<X-API-Key>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url http://localhost:3000/api/v1/alert-rules \
  --header 'X-API-Key: <X-API-Key>'

Lists every alert rule in the caller’s organization, newest first.

Authorizations

api-key
bearer

Parameters

Header Parameters

x-organization-id

string format: uuid

UUID of the organization (tenant) the request acts in. It selects the tenant and grants nothing: the server checks membership or an open tenant switch. Not needed for global operations. A malformed value returns 400. API keys are fixed to their own organization; another organization returns 403. The x-organization-source header grants nothing.

Responses

200

application/json

Array<object>

object

required

string format: uuid

name

required

string

ruleType

required

string

Allowed values: DEVICE_OFFLINE METRIC_THRESHOLD WORKLOAD_CRASH ROLLOUT_HALTED

scope

required

string

Allowed values: GLOBAL LABEL DEVICE DEPLOYMENT

targetId

object

targetLabels

required

object

key

additional properties

string

expression

object

thresholdMinutes

object

severity

required

string

Allowed values: INFO WARNING CRITICAL

enabled

required

boolean

notificationTargets

required

Array<object>

object

required

string format: uuid

name

required

string

channel

required

string

enabled

required

boolean

suppression

Notification suppression for this rule (FM-1269), or null when none is set.

object

enabled

required

boolean

trigger

required

string

Allowed values: AFTER_FIRST RATE

maxNotifications

RATE trigger only. Null for AFTER_FIRST.

object

intervalSeconds

RATE trigger only. Null for AFTER_FIRST.

object

liftSchedule

required

The structured lift schedule as stored — never a cron expression. See AlertSuppressionDto.liftSchedule for the three admitted shapes.

object

key

additional properties

any

liftTimezone

required

string

liftMode

required

string

Allowed values: DIGEST REPEAT SILENT

createdAt

required

string format: date-time

updatedAt

required

string format: date-time

Example

[
  {
    "name": "CPU above 80% on edge nodes",
    "ruleType": "DEVICE_OFFLINE",
    "scope": "GLOBAL",
    "expression": "cpu > 80 for 5m",
    "severity": "INFO",
    "notificationTargets": [
      {
        "name": "Ops on-call email",
        "channel": "EMAIL"
      }
    ],
    "suppression": {
      "trigger": "AFTER_FIRST",
      "liftSchedule": {
        "type": "dailyAt",
        "time": "23:59"
      },
      "liftTimezone": "Europe/Berlin",
      "liftMode": "DIGEST"
    }
  }
]