POST
/
v1
/
services
curl --request POST \
  --url https://api.rootly.com/v1/services \
  --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,
      "show_uptime": true,
      "show_uptime_last_days": 60,
      "backstage_id": "<string>",
      "pagerduty_id": "<string>",
      "external_id": "<string>",
      "opsgenie_id": "<string>",
      "opsgenie_team_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>"
      ],
      "owners_group_ids": [
        "<string>"
      ],
      "owners_user_ids": [
        123
      ],
      "alerts_email_enabled": true,
      "alert_urgency_id": "<string>",
      "slack_channels": [
        {
          "id": "<string>",
          "name": "<string>"
        }
      ],
      "slack_aliases": [
        {
          "id": "<string>",
          "name": "<string>"
        }
      ]
    }
  }
}'
{
  "data": {
    "id": "9e96c9f5-b0e4-4616-8356-db96a5a04c46",
    "type": "services",
    "attributes": {
      "name": "elasticsearch-prod",
      "slug": "elasticsearch-prod",
      "description": "Elastisearch",
      "public_description": "Public description",
      "notify_emails": [
        "john@rootly.com",
        "doe@rootly.com"
      ],
      "color": "#FFF",
      "status": "operational",
      "position": 1,
      "show_uptime": true,
      "show_uptime_last_days": 60,
      "slack_channels": [
        {
          "id": "C03MKDSEJE8",
          "name": "elastisearch"
        }
      ],
      "slack_aliases": [
        {
          "id": "S03F7QUV7F1",
          "name": "engineering"
        }
      ],
      "github_repository_name": "rootlyhq/my-github-service",
      "github_repository_branch": "main",
      "gitlab_repository_name": "rootlyhq/my-gitlab-service",
      "gitlab_repository_branch": "main",
      "opsgenie_id": "8743a1b2-11da-480e-8493-744660987bef",
      "pagerduty_id": "PQ9K7I8",
      "backstage_id": null,
      "external_id": "d795fe69-acc2-4b30-92c9-3c25cbb92056",
      "cortex_id": null,
      "service_now_ci_sys_id": null,
      "environment_ids": [
        "f0de4725-aac0-4ebd-9990-ff968d767674"
      ],
      "service_ids": [
        "43551e19-b5f5-4799-8c37-5eb7a68b4355"
      ],
      "owners_group_ids": [
        "3a471ce7-6df8-4692-8cd6-07610c92251d"
      ],
      "owners_user_ids": [
        474
      ],
      "incidents_count": 0,
      "alert_urgency_id": null,
      "alerts_email_enabled": true,
      "alerts_email_address": "service-eca4697343ff944fa602aeaa902835d1@test.email.rootly.io",
      "created_at": "2025-03-26T23:25:11.064-07:00",
      "updated_at": "2025-03-26T23:25:11.064-07:00"
    }
  }
}

Authorizations

​
Authorization
string
header
required

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

Body

application/vnd.api+json
​
data
object
required

Response

201
application/vnd.api+json
service created
​
data
object
required

Was this page helpful?