Skip to content

Retrieve detailed configuration of a specific alarm filter

Request

Security
JWTAuthorizer
Path
uidstringrequired
curl -i -X GET \
  'https://apidocs.trustgrid.io/_mock/v2/alarm/{uid}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

OK

Bodyapplication/json
uidstring

Unique identifier for this alarm filter

namestringrequired

Human-readable name for the alarm filter

descriptionstring

Optional description of the alarm's purpose

enabledboolean

Whether this alarm filter is active

internalboolean

Whether this alarm is managed by Trustgrid (read-only)

orgIdstring

Organization ID that owns this alarm

channelsArray of strings

UIDs of AlarmChannels to notify when this alarm triggers

typesArray of strings

Event types to match (e.g., "Node Connect", "Node Disconnect", "Network Error"). An empty list matches all types.

nodesArray of strings

Node names to scope this alarm to. Empty matches all nodes.

tagsArray of strings

Tag filters expressed as key=value strings. Nodes must match these tags (combined per operator) to trigger this alarm.

operatorstring

How multiple criteria (nodes, tags, types) are combined. all = all criteria must match; any = at least one must match; none = no criteria should match.

Enum:"any""all""none"
tagsOperatorstring

How multiple tag criteria are combined

Enum:"any""all"
thresholdstring

Minimum event severity level to trigger this alarm

Enum:"INFO""WARNING""ERROR""CRITICAL"
freetextstring

Free-text string that must appear in the event message

exprstring

CEL (Common Expression Language) expression for advanced matching

Response
{
  "uid": "string",
  "name": "string",
  "description": "string",
  "enabled": true,
  "internal": true,
  "orgId": "string",
  "channels": [
    "string"
  ],
  "types": [
    "string"
  ],
  "nodes": [
    "string"
  ],
  "tags": [
    "string"
  ],
  "operator": "any",
  "tagsOperator": "any",
  "threshold": "INFO",
  "freetext": "string",
  "expr": "string"
}