PUT
/
v1
/
services
/
{id}
Update a service
curl --request PUT \
  --url https://api.rootly.com/v1/services/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/vnd.api+json' \
  --data '{
  "data": {
    "type": "services",
    "attributes": {
      "name": "<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>",
      "environment_ids": [
        "<string>"
      ],
      "service_ids": [
        "<string>"
      ],
      "owner_group_ids": [
        "<string>"
      ],
      "owner_user_ids": [
        123
      ],
      "alerts_email_enabled": true,
      "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>"
      }
    }
  }
}'
{
  "data": {
    "id": "07fc03ab-2b90-46e6-9eaa-0922fa822aa4",
    "type": "services",
    "attributes": {
      "name": "elasticsearch-staging",
      "slug": "quasi-vitae-quo-modi",
      "description": "Elastisearch",
      "public_description": "Public description updated",
      "notify_emails": [
        "hello@rootly.com",
        "world@rootly.com"
      ],
      "color": "#FFF",
      "status": "partial_outage",
      "position": 2,
      "show_uptime": true,
      "show_uptime_last_days": 60,
      "slack_channels": [
        {
          "id": "C03MKDSEJE8",
          "name": "elastisearch"
        }
      ],
      "slack_aliases": [
        {
          "id": "S03F7QUV7F1",
          "name": "leadership"
        }
      ],
      "github_repository_name": "rootlyhq/my-another-github-service",
      "github_repository_branch": "master",
      "gitlab_repository_name": "rootlyhq/my-another-gitlab-service",
      "gitlab_repository_branch": "master",
      "opsgenie_id": "8743a1b2-11da-480e-8493-744660987bec",
      "pagerduty_id": "PQ9K7I9",
      "backstage_id": null,
      "external_id": "33bfcc62-cc35-46e6-a270-8c52a56fb358",
      "cortex_id": null,
      "service_now_ci_sys_id": null,
      "environment_ids": [
        "c7ee2b73-be71-4f47-b251-7e1855a552d1"
      ],
      "service_ids": [
        "07fc03ab-2b90-46e6-9eaa-0922fa822aa4"
      ],
      "owner_group_ids": [],
      "owners_group_ids": [],
      "owner_user_ids": [],
      "owners_user_ids": [],
      "incidents_count": 1,
      "alert_urgency_id": null,
      "alerts_email_enabled": false,
      "alerts_email_address": "service-df4c426b969631d87104ffb2ce0fe5db@email.rootly.com",
      "alert_broadcast_enabled": true,
      "alert_broadcast_channel": {
        "id": "C999ALERT",
        "name": "staging-alerts"
      },
      "incident_broadcast_enabled": true,
      "incident_broadcast_channel": {
        "id": "C999INCIDENT",
        "name": "staging-incidents"
      },
      "created_at": "2025-07-29T05:04:27.783-07:00",
      "updated_at": "2025-07-29T05:04:35.919-07:00"
    }
  }
}

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

id
string
required

Body

application/vnd.api+json

Response

200
application/vnd.api+json

service updated

The response is of type object.