Updates an alert
curl --request PATCH \
--url https://api.rootly.com/v1/alerts/{id} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/vnd.api+json' \
--data '
{
"data": {
"attributes": {
"noise": "noise",
"source": "rootly",
"summary": "<string>",
"description": "<string>",
"service_ids": [
"<string>"
],
"group_ids": [
"<string>"
],
"environment_ids": [
"<string>"
],
"started_at": "2023-11-07T05:31:56Z",
"ended_at": "2023-11-07T05:31:56Z",
"external_id": "<string>",
"external_url": "<string>",
"alert_urgency_id": "<string>",
"labels": [
{
"key": "<string>",
"value": "<string>"
}
],
"data": {},
"deduplication_key": "<string>",
"alert_field_values_attributes": [
{
"alert_field_id": "<string>",
"value": "<string>"
}
]
},
"type": "alerts"
}
}
'{
"data": {
"id": "<string>",
"type": "alerts",
"attributes": {
"short_id": "<string>",
"source": "rootly",
"summary": "<string>",
"created_at": "<string>",
"updated_at": "<string>",
"noise": "noise",
"status": "open",
"description": "<string>",
"services": [
{
"name": "<string>",
"created_at": "<string>",
"updated_at": "<string>",
"slug": "<string>",
"description": "<string>",
"public_description": "<string>",
"notify_emails": [
"<string>"
],
"color": "<string>",
"position": 123,
"backstage_id": "<string>",
"external_id": "<string>",
"pagerduty_id": "<string>",
"opsgenie_id": "<string>",
"cortex_id": "<string>",
"service_now_ci_sys_id": "<string>",
"github_repository_name": "<string>",
"github_repository_branch": "<string>",
"gitlab_repository_name": "<string>",
"gitlab_repository_branch": "<string>",
"kubernetes_deployment_name": "<string>",
"environment_ids": [
"<string>"
],
"service_ids": [
"<string>"
],
"owner_group_ids": [
"<string>"
],
"owner_user_ids": [
123
],
"alert_urgency_id": "<string>",
"escalation_policy_id": "<string>",
"alerts_email_enabled": true,
"alerts_email_address": "<string>",
"slack_channels": [
{
"id": "<string>",
"name": "<string>"
}
],
"slack_aliases": [
{
"id": "<string>",
"name": "<string>"
}
],
"alert_broadcast_enabled": true,
"alert_broadcast_channel": {
"id": "<string>",
"name": "<string>"
},
"incident_broadcast_enabled": true,
"incident_broadcast_channel": {
"id": "<string>",
"name": "<string>"
},
"fields": [
{
"catalog_field_id": "<string>",
"value": "<string>"
}
]
}
],
"groups": [
{
"name": "<string>",
"created_at": "<string>",
"updated_at": "<string>",
"slug": "<string>",
"description": "<string>",
"notify_emails": [
"<string>"
],
"color": "<string>",
"position": 123,
"backstage_id": "<string>",
"external_id": "<string>",
"pagerduty_id": "<string>",
"pagerduty_service_id": "<string>",
"opsgenie_id": "<string>",
"victor_ops_id": "<string>",
"pagertree_id": "<string>",
"cortex_id": "<string>",
"service_now_ci_sys_id": "<string>",
"user_ids": [
123
],
"admin_ids": [
123
],
"alerts_email_enabled": true,
"alerts_email_address": "<string>",
"alert_urgency_id": "<string>",
"slack_channels": [
{
"id": "<string>",
"name": "<string>"
}
],
"slack_aliases": [
{
"id": "<string>",
"name": "<string>"
}
],
"alert_broadcast_enabled": true,
"alert_broadcast_channel": {
"id": "<string>",
"name": "<string>"
},
"incident_broadcast_enabled": true,
"incident_broadcast_channel": {
"id": "<string>",
"name": "<string>"
},
"auto_add_members_when_attached": true,
"fields": [
{
"catalog_field_id": "<string>",
"value": "<string>"
}
]
}
],
"environments": [
{
"name": "<string>",
"created_at": "<string>",
"updated_at": "<string>",
"slug": "<string>",
"description": "<string>",
"notify_emails": [
"<string>"
],
"color": "<string>",
"position": 123,
"slack_channels": [
{
"id": "<string>",
"name": "<string>"
}
],
"slack_aliases": [
{
"id": "<string>",
"name": "<string>"
}
],
"fields": [
{
"catalog_field_id": "<string>",
"value": "<string>"
}
]
}
],
"service_ids": [
"<string>"
],
"group_ids": [
"<string>"
],
"environment_ids": [
"<string>"
],
"external_id": "<string>",
"external_url": "<string>",
"alert_urgency_id": "<string>",
"group_leader_alert_id": "<string>",
"is_group_leader_alert": true,
"labels": [
{
"key": "<string>",
"value": "<string>"
}
],
"data": {},
"deduplication_key": "<string>",
"alert_field_values_attributes": [
{
"alert_field_id": "<string>",
"value": "<string>"
}
],
"started_at": "2023-11-07T05:31:56Z",
"ended_at": "2023-11-07T05:31:56Z"
},
"source": "rootly"
}
}Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Show child attributes
removes existing alert field values and adds new ones
Show child attributes
Was this page helpful?
curl --request PATCH \
--url https://api.rootly.com/v1/alerts/{id} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/vnd.api+json' \
--data '
{
"data": {
"attributes": {
"noise": "noise",
"source": "rootly",
"summary": "<string>",
"description": "<string>",
"service_ids": [
"<string>"
],
"group_ids": [
"<string>"
],
"environment_ids": [
"<string>"
],
"started_at": "2023-11-07T05:31:56Z",
"ended_at": "2023-11-07T05:31:56Z",
"external_id": "<string>",
"external_url": "<string>",
"alert_urgency_id": "<string>",
"labels": [
{
"key": "<string>",
"value": "<string>"
}
],
"data": {},
"deduplication_key": "<string>",
"alert_field_values_attributes": [
{
"alert_field_id": "<string>",
"value": "<string>"
}
]
},
"type": "alerts"
}
}
'{
"data": {
"id": "<string>",
"type": "alerts",
"attributes": {
"short_id": "<string>",
"source": "rootly",
"summary": "<string>",
"created_at": "<string>",
"updated_at": "<string>",
"noise": "noise",
"status": "open",
"description": "<string>",
"services": [
{
"name": "<string>",
"created_at": "<string>",
"updated_at": "<string>",
"slug": "<string>",
"description": "<string>",
"public_description": "<string>",
"notify_emails": [
"<string>"
],
"color": "<string>",
"position": 123,
"backstage_id": "<string>",
"external_id": "<string>",
"pagerduty_id": "<string>",
"opsgenie_id": "<string>",
"cortex_id": "<string>",
"service_now_ci_sys_id": "<string>",
"github_repository_name": "<string>",
"github_repository_branch": "<string>",
"gitlab_repository_name": "<string>",
"gitlab_repository_branch": "<string>",
"kubernetes_deployment_name": "<string>",
"environment_ids": [
"<string>"
],
"service_ids": [
"<string>"
],
"owner_group_ids": [
"<string>"
],
"owner_user_ids": [
123
],
"alert_urgency_id": "<string>",
"escalation_policy_id": "<string>",
"alerts_email_enabled": true,
"alerts_email_address": "<string>",
"slack_channels": [
{
"id": "<string>",
"name": "<string>"
}
],
"slack_aliases": [
{
"id": "<string>",
"name": "<string>"
}
],
"alert_broadcast_enabled": true,
"alert_broadcast_channel": {
"id": "<string>",
"name": "<string>"
},
"incident_broadcast_enabled": true,
"incident_broadcast_channel": {
"id": "<string>",
"name": "<string>"
},
"fields": [
{
"catalog_field_id": "<string>",
"value": "<string>"
}
]
}
],
"groups": [
{
"name": "<string>",
"created_at": "<string>",
"updated_at": "<string>",
"slug": "<string>",
"description": "<string>",
"notify_emails": [
"<string>"
],
"color": "<string>",
"position": 123,
"backstage_id": "<string>",
"external_id": "<string>",
"pagerduty_id": "<string>",
"pagerduty_service_id": "<string>",
"opsgenie_id": "<string>",
"victor_ops_id": "<string>",
"pagertree_id": "<string>",
"cortex_id": "<string>",
"service_now_ci_sys_id": "<string>",
"user_ids": [
123
],
"admin_ids": [
123
],
"alerts_email_enabled": true,
"alerts_email_address": "<string>",
"alert_urgency_id": "<string>",
"slack_channels": [
{
"id": "<string>",
"name": "<string>"
}
],
"slack_aliases": [
{
"id": "<string>",
"name": "<string>"
}
],
"alert_broadcast_enabled": true,
"alert_broadcast_channel": {
"id": "<string>",
"name": "<string>"
},
"incident_broadcast_enabled": true,
"incident_broadcast_channel": {
"id": "<string>",
"name": "<string>"
},
"auto_add_members_when_attached": true,
"fields": [
{
"catalog_field_id": "<string>",
"value": "<string>"
}
]
}
],
"environments": [
{
"name": "<string>",
"created_at": "<string>",
"updated_at": "<string>",
"slug": "<string>",
"description": "<string>",
"notify_emails": [
"<string>"
],
"color": "<string>",
"position": 123,
"slack_channels": [
{
"id": "<string>",
"name": "<string>"
}
],
"slack_aliases": [
{
"id": "<string>",
"name": "<string>"
}
],
"fields": [
{
"catalog_field_id": "<string>",
"value": "<string>"
}
]
}
],
"service_ids": [
"<string>"
],
"group_ids": [
"<string>"
],
"environment_ids": [
"<string>"
],
"external_id": "<string>",
"external_url": "<string>",
"alert_urgency_id": "<string>",
"group_leader_alert_id": "<string>",
"is_group_leader_alert": true,
"labels": [
{
"key": "<string>",
"value": "<string>"
}
],
"data": {},
"deduplication_key": "<string>",
"alert_field_values_attributes": [
{
"alert_field_id": "<string>",
"value": "<string>"
}
],
"started_at": "2023-11-07T05:31:56Z",
"ended_at": "2023-11-07T05:31:56Z"
},
"source": "rootly"
}
}