Get alert rule by ID

GET

https://localhost:8080/api/v1/alerts/rules/:id

GET

/api/v1/alerts/rules/:id

1 curl https:https://localhost:8080/api/v1/alerts/rules/id \
2      -H "Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.exampletoken1234567890" \
3      -H "X-Workspace-Id: a3f1c9d2-4b7e-4f8a-9c3d-2e5b7f6a1d9c" \
4      -H "Content-Type: application/json"

1 {
2   "id": "d9f8a7b6-c5e4-3d2c-1b0a-9f8e7d6c5b4a",
3   "name": "High CPU Usage Alert",
4   "description": "Triggers when CPU usage exceeds 85% for more than 5 minutes.",
5   "enabled": true,
6   "severity": "critical",
7   "createdAt": "2024-05-10T09:15:30Z",
8   "updatedAt": "2024-06-01T12:00:00Z",
9   "conditions": [
10     {
11       "metric": "cpu_usage",
12       "operator": ">",
13       "threshold": 85,
14       "duration": "5m"
15     }
16   ],
17   "actions": [
18     {
19       "type": "email",
20       "recipients": [
21         "ops-team@example.com"
22       ]
23     }
24   ],
25   "workspaceId": "a3f1c9d2-4b7e-4f8a-9c3d-2e5b7f6a1d9c",
26   "teamTier": "team_plus"
27 }

Single alert rule. Team+ tier.

Path parameters

idstringRequired

Rule UUID

Response

data: AlertRuleItem

Errors

403

Forbidden Error

404

Not Found Error

Path parameters

Headers

Response

Errors