Get Alert by id

GET

/v1/private/alerts/:id

GET

/api/v1/private/alerts/:id

$ curl http://localhost:5173/api/v1/private/alerts/id \
>      -H "Content-Type: application/json"

1 {
2   "webhook": {
3     "url": "https://hooks.example.com/alerts/error",
4     "id": "7b9c9f1e-4d2a-4f3a-9a1e-8f3b2c4d5e6f",
5     "name": "Error Notifications Webhook",
6     "secret_token": "s3cr3tT0k3n123",
7     "headers": {
8       "Authorization": "Bearer abcdef123456",
9       "Content-Type": "application/json"
10     },
11     "created_at": "2024-01-15T09:30:00Z",
12     "created_by": "alice@example.com",
13     "last_updated_at": "2024-01-15T09:30:00Z",
14     "last_updated_by": "bob@example.com"
15   },
16   "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
17   "name": "High Error Rate Alert",
18   "enabled": true,
19   "alert_type": "general",
20   "metadata": {
21     "owner": "devops-team",
22     "severity": "high"
23   },
24   "triggers": [
25     {
26       "event_type": "trace:errors",
27       "id": "d4e5f6a7-b8c9-4d0e-9f1a-2b3c4d5e6f7a",
28       "alert_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
29       "trigger_configs": [
30         {
31           "type": "scope:project",
32           "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
33           "alert_trigger_id": "d4e5f6a7-b8c9-4d0e-9f1a-2b3c4d5e6f7a",
34           "config_value": {},
35           "group_index": 1,
36           "created_at": "2024-01-15T09:30:00Z",
37           "created_by": "alice@example.com",
38           "last_updated_at": "2024-01-15T09:30:00Z",
39           "last_updated_by": "bob@example.com"
40         }
41       ],
42       "created_at": "2024-01-15T09:30:00Z",
43       "created_by": "alice@example.com"
44     }
45   ],
46   "created_at": "2024-01-15T09:30:00Z",
47   "created_by": "alice@example.com",
48   "last_updated_at": "2024-01-15T09:30:00Z",
49   "last_updated_by": "bob@example.com",
50   "project_id": "9f8e7d6c-5b4a-3210-9f8e-7d6c5b4a3210"
51 }

Get Alert by id

Path parameters

idstringRequiredformat: "uuid"

Response

Alert resource

webhookobject

idstringOptionalformat: "uuid"

namestringOptional0-255 characters

enabledbooleanOptional

alert_typeenumOptional

metadatamap from strings to stringsOptional

triggerslist of objectsOptional

created_atdatetimeOptionalRead-only

created_bystringOptionalRead-only

last_updated_atdatetimeOptionalRead-only

last_updated_bystringOptionalRead-only

project_idstringOptionalformat: "uuid"

Optional project scope for this alert. When set, the alert is scoped to the specified project. Do NOT also provide a ‘scope:project’ trigger config — the system will create it automatically from this field. Sending both project_id and a scope:project trigger config will result in an error.

Errors

404

Not Found Error