Update an alert from an organization.
PATCH
/v1/alerts/{org_uuid}/{alert_uuid}
Update an alert from an organization.
A fixed alert cannot change so it will lead a BadRequest response.
Authorizations
jwtToken
TypeHTTP (bearer)
Parameters
Path Parameters
org_uuid*
UUID of the organization
Typestring
Requiredformat
"uuid"alert_uuid*
The ID of the alert
Typestring
RequiredExample
"01c9fb02-7648-45f5-9bdd-f2c27e59c448"format
"uuid"Request Body
application/json
JSON
{
"severity": 0,
"assignees": [
[
"fd842d03-45e8-40db-8c48-f398e1535640",
"7820a663-50d7-4a72-a0d4-abca14e962b3"
]
],
"resolved_at": "2024-04-15T09:17:00Z"
}
Responses
OK with the updated alert entity.
application/json
JSON
{
"id": "f1c9ecfe-1a45-499b-ab6d-1aa0a8ea2f95",
"severity": {
"name": "string",
"rank": 0
},
"created_at": "2024-04-12T07:06:00Z",
"updated_at": "2024-04-15T11:05:00Z",
"trigger": {
"started_at": "string",
"finished_at": "string",
"id": 0,
"auth_type": "string",
"auth_user": {
"display_name": "Marius Tolzmann",
"position": "CTPO",
"user_picture_url": "https://lh3.googleusercontent.com/a/AAcHTtcBqudpP0hVoQyjDv-v5b4lP6e0vN_92zi_aPp90hE=s96-c"
},
"auth_trust": {
"auth_id": "terramate-io/somerepo/.github/workflows/check-all.yml@refs/heads/main"
},
"org_uuid": "string",
"stack_id": 0,
"stack": {
"stack_id": 1337,
"repository": "github.com/terramate-io/iac-gcloud",
"target": "staging",
"path": "/path/to/stack",
"default_branch": "main",
"meta_id": "a754255a-c92a-4aeb-9668-bd3ce21dc8a2",
"meta_name": "My Stack Name",
"meta_description": "My Stack Description",
"meta_tags": [
[
"tagA",
"tagB"
]
],
"status": "string",
"created_at": "string",
"updated_at": "string",
"seen_at": "string",
"is_archived": true,
"archived_at": "string",
"archived_by_user_uuid": "string",
"unarchived_at": "string",
"unarchived_by_user_uuid": "string",
"deployment_status": "string",
"drift_status": "string",
"draft": true,
"related_stacks": [
{
"stack_id": 0,
"target": "string"
}
],
"resources": {
"count": 42,
"policy_check": {
"created_at": "2024-09-12T07:06:00Z",
"passed": false,
"counters": {
"passed_count": 42,
"severity_low_count": 3,
"severity_medium_count": 2,
"severity_high_count": 1
}
}
}
},
"status": "string",
"metadata": {
"additionalProperties": "string"
},
"drift_details": {
"provisioner": "string",
"serial": 0,
"changeset_ascii": "string",
"changeset_json": "string"
},
"grouping_key": "repo+id+1",
"cmd": [
[
"terraform",
"plan"
]
]
},
"triggered_event": {
"author_id": "string",
"created_at": "string",
"type": "string",
"actions": [
{
"action": "add",
"field": "resolved_at",
"value": "42",
"grouping_id": 323
}
]
},
"resolved_event": {
"author_id": "string",
"created_at": "string",
"type": "string",
"actions": [
{
"action": "add",
"field": "resolved_at",
"value": "42",
"grouping_id": 323
}
]
},
"assignees": [
{
"user_uuid": "683e0589-65a8-48b8-bd90-6ee89e0682ab",
"display_name": "Marius Tolzmann",
"user_picture_url": "https://lh3.googleusercontent.com/a/AAcHTtcBqudpP0hVoQyjDv-v5b4lP6e0vN_92zi_aPp90hE=s96-c"
}
],
"resolved_at": "2024-04-12T07:53:00Z",
"fixed_at": "2024-04-12T07:53:00Z"
}