Creates a new service from provided data
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>"
],
"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": "eceb0911-5e1d-4288-88e2-18269ac9040c",
"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": [
"4940620a-185f-44fb-97e4-e5abc9a7bc25"
],
"service_ids": [
"f58b7db6-594d-42b9-9ae4-1ddfd7b410e6"
],
"owner_group_ids": [
"89832cc1-c603-48ea-bd1e-b082be95837d"
],
"owners_group_ids": [
"89832cc1-c603-48ea-bd1e-b082be95837d"
],
"owner_user_ids": [
472
],
"owners_user_ids": [
472
],
"incidents_count": 0,
"alert_urgency_id": null,
"alerts_email_enabled": true,
"alerts_email_address": "service-d4a92770f2e60a69b360c2dac2ee975d@test.email.rootly.com",
"alert_broadcast_enabled": true,
"alert_broadcast_channel": {
"id": "C789ALERT",
"name": "service-alerts"
},
"incident_broadcast_enabled": false,
"incident_broadcast_channel": {},
"created_at": "2025-08-26T21:17:12.511-07:00",
"updated_at": "2025-08-26T21:17:12.511-07:00"
}
}
}
Bearer authentication header of the form Bearer <token>
, where <token>
is your auth token.
service created
The response is of type object
.
Was this page helpful?
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>"
],
"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": "eceb0911-5e1d-4288-88e2-18269ac9040c",
"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": [
"4940620a-185f-44fb-97e4-e5abc9a7bc25"
],
"service_ids": [
"f58b7db6-594d-42b9-9ae4-1ddfd7b410e6"
],
"owner_group_ids": [
"89832cc1-c603-48ea-bd1e-b082be95837d"
],
"owners_group_ids": [
"89832cc1-c603-48ea-bd1e-b082be95837d"
],
"owner_user_ids": [
472
],
"owners_user_ids": [
472
],
"incidents_count": 0,
"alert_urgency_id": null,
"alerts_email_enabled": true,
"alerts_email_address": "service-d4a92770f2e60a69b360c2dac2ee975d@test.email.rootly.com",
"alert_broadcast_enabled": true,
"alert_broadcast_channel": {
"id": "C789ALERT",
"name": "service-alerts"
},
"incident_broadcast_enabled": false,
"incident_broadcast_channel": {},
"created_at": "2025-08-26T21:17:12.511-07:00",
"updated_at": "2025-08-26T21:17:12.511-07:00"
}
}
}