Creates a service

Overview

Overview

Reference

AlertEvents
AlertGroups
AlertUrgencies
AlertSources
Alerts
Audits
Authorizations
CatalogEntities
CatalogEntityProperties
CatalogFields
Catalogs
Causes
[DEPRECATED] CustomFieldOptions
[DEPRECATED] CustomFields
CustomForms
DashboardPanels
Dashboards
Environments
EscalationPolicies
EscalationLevelsPolicies
EscalationLevelsPath
EscalationLevels
EscalationPaths
FormFieldOptions
FormFieldPlacementConditions
FormFieldPlacements
FormFieldPositions
FormFields
FormSetConditions
FormSets
Functionalities
WorkflowTasks
[DEPRECATED] WorkflowCustomFieldSelections
WorkflowFormFieldConditions
WorkflowGroups
WorkflowRuns
Workflows
Heartbeats
IncidentActionItems
[DEPRECATED] IncidentCustomFieldSelections
IncidentEventFunctionalities
IncidentEventServices
IncidentEvents
IncidentFeedbacks
IncidentFormFieldSelections
IncidentPermissionSetBooleans
IncidentPermissionSetResources
IncidentPermissionSets
IncidentRetrospectives
IncidentRetrospectiveSteps
IncidentRoleTasks
IncidentRoles
IncidentStatusPageEvents
IncidentSubStatuses
IncidentTypes
Incidents
IpRanges
LiveCallRouters
OnCallRoles
OnCallShadows
OverrideShifts
PlaybookTasks
Playbooks
RetrospectiveTemplates
Pulses
RetrospectiveConfigurations
RetrospectiveProcessGroupSteps
RetrospectiveProcessGroups
RetrospectiveProcesses
RetrospectiveSteps
Roles
ScheduleRotationActiveDays
ScheduleRotationUsers
ScheduleRotations
Schedules
Shifts
Secrets
Services
- GET
  List services
- POST
  Creates a service
- GET
  Retrieves a service
- PUT
  Update a service
- DEL
  Delete a service
- GET
  Get service incidents chart
- GET
  Get service uptime chart
Severities
StatusPageTemplates
StatusPages
SubStatuses
Teams
UserNotificationRules
Users
WebhooksDeliveries
WebhooksEndpoints

POST

services

curl --request POST \
  --url https://api.rootly.com/v1/services \
  --header 'Authorization: Bearer REPLACE_BEARER_TOKEN' \
  --header 'content-type: application/vnd.api+json'

{
  "data": {
    "id": "8816af6d-5fc3-4f3c-af9e-526671927911",
    "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": [
        "cbb5e4f2-74d9-4895-affa-3dd65c80fc87"
      ],
      "service_ids": [
        "a65f27de-4e45-497f-a519-9aa3e01ed9fd"
      ],
      "owners_group_ids": [
        "8530e7aa-1e82-4532-9751-e8597409dfac"
      ],
      "owners_user_ids": [
        461
      ],
      "incidents_count": 0,
      "alert_urgency_id": null,
      "alerts_email_enabled": true,
      "alerts_email_address": "service-37c6b84cce0ba00cfdfa89ddbe025080@test.email.rootly.io",
      "created_at": "2025-03-07T00:09:09.282-08:00",
      "updated_at": "2025-03-07T00:09:09.282-08: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

data.type

enum<string>

required

Available options:

services

data.attributes

object

required

data.attributes.name

string

required

The name of the service

data.attributes.description

string | null

The description of the service

data.attributes.public_description

string | null

The public description of the service

data.attributes.notify_emails

string[] | null

Emails to attach to the service

data.attributes.color

string | null

The hex color of the service

data.attributes.position

integer | null

Position of the service

data.attributes.show_uptime

boolean | null

Show uptime

data.attributes.show_uptime_last_days

enum<integer> | null

default:

Show uptime over x days

Available options:

30,

60,

90

data.attributes.backstage_id

string | null

The Backstage entity id associated to this service. eg: :namespace/:kind/:entity_name

data.attributes.pagerduty_id

string | null

The PagerDuty service id associated to this service

data.attributes.external_id

string | null

The external id associated to this service

data.attributes.opsgenie_id

string | null

The Opsgenie service id associated to this service

data.attributes.opsgenie_team_id

string | null

The Opsgenie team id associated to this service

data.attributes.cortex_id

string | null

The Cortex group id associated to this service

data.attributes.service_now_ci_sys_id

string | null

The Service Now CI sys id associated to this service

data.attributes.github_repository_name

string | null

The GitHub repository name associated to this service. eg: rootlyhq/my-service

data.attributes.github_repository_branch

string | null

The GitHub repository branch associated to this service. eg: main

data.attributes.gitlab_repository_name

string | null

The GitLab repository name associated to this service. eg: rootlyhq/my-service

data.attributes.gitlab_repository_branch

string | null

The GitLab repository branch associated to this service. eg: main

data.attributes.environment_ids

string[] | null

Environments associated with this service

data.attributes.service_ids

string[] | null

Services dependent on this service

data.attributes.owners_group_ids

string[] | null

Owner Teams associated with this service

data.attributes.owners_user_ids

integer[] | null

Owner Users associated with this service

data.attributes.alerts_email_enabled

boolean | null

Enable alerts through email

data.attributes.alert_urgency_id

string | null

The alert urgency id of the service

data.attributes.slack_channels

object[] | null

Slack Channels associated with this service

data.attributes.slack_aliases

object[] | null

Slack Aliases associated with this service

Response

201

application/vnd.api+json

service created

data

object

required

data.id

string

required

Unique ID of the service

data.type

enum<string>

required

Available options:

services

data.attributes

object

required

data.attributes.name

string

required

The name of the service

data.attributes.created_at

string

required

Date of creation

data.attributes.updated_at

string

required

Date of last update

data.attributes.slug

string

The slug of the service

data.attributes.description

string | null

The description of the service

data.attributes.public_description

string | null

The public description of the service

data.attributes.notify_emails

string[] | null

Emails attached to the service

data.attributes.color

string | null

The hex color of the service

data.attributes.position

integer | null

Position of the service

data.attributes.backstage_id

string | null

The Backstage entity id associated to this service. eg: :namespace/:kind/:entity_name

data.attributes.external_id

string | null

The external id associated to this service

data.attributes.pagerduty_id

string | null

The PagerDuty service id associated to this service

data.attributes.opsgenie_id

string | null

The Opsgenie service id associated to this service

data.attributes.cortex_id

string | null

The Cortex group id associated to this service

data.attributes.service_now_ci_sys_id

string | null

The Service Now CI sys id associated to this service

data.attributes.github_repository_name

string | null

The GitHub repository name associated to this service. eg: rootlyhq/my-service

data.attributes.github_repository_branch

string | null

The GitHub repository branch associated to this service. eg: main

data.attributes.gitlab_repository_name

string | null

The GitLab repository name associated to this service. eg: rootlyhq/my-service

data.attributes.gitlab_repository_branch

string | null

The GitLab repository branch associated to this service. eg: main

data.attributes.environment_ids

string[] | null

Environments associated with this service

data.attributes.service_ids

string[] | null

Services dependent on this service

data.attributes.owners_group_ids

string[] | null

Owner Teams associated with this service

data.attributes.owners_user_ids

integer[] | null

Owner Users associated with this service

data.attributes.alert_urgency_id

string | null

The alert urgency id of the service

data.attributes.alerts_email_enabled

boolean | null

Enable alerts through email

data.attributes.alerts_email_address

string | null

Email generated to send alerts to

data.attributes.slack_channels

object[] | null

Slack Channels associated with this service

data.attributes.slack_aliases

object[] | null

Slack Aliases associated with this service

Was this page helpful?

Retrieves a serviceRetrieves a specific service by id

curl --request POST \
  --url https://api.rootly.com/v1/services \
  --header 'Authorization: Bearer REPLACE_BEARER_TOKEN' \
  --header 'content-type: application/vnd.api+json'

{
  "data": {
    "id": "8816af6d-5fc3-4f3c-af9e-526671927911",
    "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": [
        "cbb5e4f2-74d9-4895-affa-3dd65c80fc87"
      ],
      "service_ids": [
        "a65f27de-4e45-497f-a519-9aa3e01ed9fd"
      ],
      "owners_group_ids": [
        "8530e7aa-1e82-4532-9751-e8597409dfac"
      ],
      "owners_user_ids": [
        461
      ],
      "incidents_count": 0,
      "alert_urgency_id": null,
      "alerts_email_enabled": true,
      "alerts_email_address": "service-37c6b84cce0ba00cfdfa89ddbe025080@test.email.rootly.io",
      "created_at": "2025-03-07T00:09:09.282-08:00",
      "updated_at": "2025-03-07T00:09:09.282-08:00"
    }
  }
}