List alert rules

GET

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

GET

/api/v1/alerts/rules

1 curl -G https:https://localhost:8080/api/v1/alerts/rules \
2      -H "Authorization: Bearer pat_team_9f8e7d6c5b4a3f2e1d0c" \
3      -H "X-Workspace-Id: a3f1c2d4-5678-90ab-cdef-1234567890ab" \
4      -H "Content-Type: application/json" \
5      -d page=1 \
6      -d pageSize=20

1 {
2   "data": [
3     {
4       "id": "b7e23f2e-8c4a-4d3a-9f1b-2a3c4d5e6f7a",
5       "name": "High CPU Usage Alert",
6       "description": "Triggers when CPU usage exceeds 90% for 5 minutes",
7       "enabled": true,
8       "severity": "critical",
9       "createdAt": "2024-05-10T12:00:00Z",
10       "updatedAt": "2024-05-15T08:30:00Z",
11       "conditions": [
12         {
13           "metric": "cpu_usage",
14           "operator": ">",
15           "threshold": 90,
16           "duration": "5m"
17         }
18       ],
19       "actions": [
20         {
21           "type": "email",
22           "target": "ops-team@example.com"
23         }
24       ]
25     },
26     {
27       "id": "d4f5a6b7-c8d9-4e0f-9a1b-2c3d4e5f6a7b",
28       "name": "Disk Space Warning",
29       "description": "Warns when disk space is below 15%",
30       "enabled": true,
31       "severity": "warning",
32       "createdAt": "2024-04-20T09:15:00Z",
33       "updatedAt": "2024-05-01T10:00:00Z",
34       "conditions": [
35         {
36           "metric": "disk_free_percent",
37           "operator": "<",
38           "threshold": 15,
39           "duration": "10m"
40         }
41       ],
42       "actions": [
43         {
44           "type": "slack",
45           "target": "#alerts-disk-space"
46         }
47       ]
48     }
49   ],
50   "meta": {
51     "page": 1,
52     "pageSize": 20,
53     "totalPages": 3,
54     "totalItems": 45
55   }
56 }

Offset-paginated alert rules. Team+ tier.

Query parameters

pageintegerOptional

Page (default 1)

pageSizeintegerOptional

Page size (default 20, max 100)

Response

data: AlertRuleItem[], meta: AlertsListMeta

Errors

403

Forbidden Error

Headers

Query parameters

Response

Errors