Get an alert rule

GET

/api/v1/alert-rules/{id}

const url = 'http://localhost:3000/api/v1/alert-rules/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0';
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/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0 \
  --header 'X-API-Key: <X-API-Key>'

Authorizations

api-key
bearer

Parameters

Path Parameters

required

string format: uuid

Responses

200

application/json

object

required

string format: uuid

name

required

string

ruleType

required

string

Allowed values: DEVICE_OFFLINE METRIC_THRESHOLD WORKLOAD_CRASH

scope

required

string

Allowed values: GLOBAL LABEL DEVICE

targetId

object

targetLabels

required

object

key

additional properties

string

expression

object

thresholdMinutes

object

enabled

required

boolean

notificationTargets

required

Array<object>

object

required

string format: uuid

name

required

string

channel

required

string

enabled

required

boolean

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",
  "notificationTargets": [
    {
      "name": "Ops on-call email",
      "channel": "EMAIL"
    }
  ]
}

404

No such rule in the caller’s organization