Help
Models
ActionItemEntity
ActionItemEntityPaginated
AlertEntity
AlertEntityPaginated
AuthorEntity
BucketEntity
ChangeEntity
ChangeEntityPaginated
ChangeEventEntity
ChangeEventSlimEntity
ChangeEventSlimEntityPaginated
ChangeIdentityEntity
ChangeIdentityEntityPaginated
DataPointEntity
EnvironmentEntity
EnvironmentEntityPaginated
ErrorEntity
EventEntity
FunctionalityEntity
IncidentAttachmentEntity
IncidentEntity
IncidentEntityPaginated
IncidentEventEntity
IncidentEventEntityPaginated
IncidentImpactEntity
IncidentImpactEntityPaginated
IncidentRoleEntity
IncidentRoleEntityPaginated
IncidentRoleSuccinctEntity
IncidentRoleTaskEntity
IncidentTeamAssignmentsEntity
IntegrationEntity
MembershipEntity
MilestoneEntity
MilestoneEntityPaginated
NoteEntity
PaginationEntity
ParticipantEntity
ParticipantEntityPaginated
ParticipantSearchEntity
ReasonEntity
ReasonEntityPaginated
RelatedChangeEventEntity
RelatedChangeEventEntityPaginated
ReportEntity
ReportEntityPaginated
RoleAssignmentEntity
RoleAssignmentEntityPaginated
SavedSearchEntity
ScheduleEntity
ServiceEntity
ServiceEntityPaginated
SeverityEntity
SeverityMatrixItemEntity
SlimServiceEntity
StarEntity
StarEntityPaginated
StatusPageEntity
SuccinctTeamEntity
SuccinctUserEntity
TaskAssigneeEntity
TaskEntity
TaskEntityPaginated
TeamEntity
TeamEntityPaginated
UserEntity
UserEntityPaginated
WebhookEntity
patchV1Changes
patchV1ChangesChangeIdIdentities
patchV1ChangesEvents
patchV1Environments
patchV1Functionalities
patchV1IncidentRoles
patchV1Incidents
patchV1IncidentsIncidentIdAlertsIncidentAlertIdPrimary
patchV1IncidentsIncidentIdNotes
patchV1IncidentsIncidentIdRelatedChangeEvents
patchV1PostMortemsReportsReportIdActionItems
patchV1PostMortemsReportsReportIdEvents
patchV1PostMortemsReportsReportIdEventsNotes
patchV1SavedSearchesResourceType
patchV1Services
patchV1SeverityMatrix
patchV1Teams
patchV1Webhooks
postV1Changes
postV1ChangesChangeIdIdentities
postV1ChangesEvents
postV1Environments
postV1Functionalities
postV1IncidentRoles
postV1Incidents
postV1IncidentsIncidentIdImpact
postV1IncidentsIncidentIdNotes
postV1IncidentsIncidentIdRelatedChangeEvents
postV1IncidentsIncidentIdRoleAssignments
postV1IncidentsIncidentIdTeamAssignments
postV1PostMortemsReports
postV1PostMortemsReportsReportIdActionItems
postV1PostMortemsReportsReportIdEventsNotes
postV1PostMortemsReportsReportIdParticipants
postV1PostMortemsReportsReportIdReasons
postV1SavedSearches
postV1Services
postV1Severities
postV1Teams
postV1Webhooks
putV1IncidentsIncidentIdMilestonesBulkUpdate
Powered by Stoplight
patch

/v1/services/{service_id}

Update a services attributes, you may also add or remove functionalities from the service as well. Note: You may not remove or add individual label key/value pairs. You must include the entire object to override label values.

Authorization

apiKey - Authorization

Request Parameters

1 Path Parameter

Request Body

Schema
object

Update a services attributes, you may also add or remove functionalities from the service as well. Note: You may not remove or add individual label key/value pairs. You must include the entire object to override label values.

name
string
required
description
string
labels
object

A hash of label keys and values

remove_remaining_functionalities
boolean

If set to true, any functionality objects tagged on the service that are not included in the given array will be removed. Set this if you want to do a replacement operation for the functionalities

functionalities
array[object]

An array of functionalities

Responses

Update a services attributes, you may also add or remove functionalities from the service as well. Note: You may not remove or add individual label key/value pairs. You must include the entire object to override label values.

Schema
object

Retrieves a single service by ID or Slug

id
string
name
string
description
string
slug
string
created_at
string
1 validation
updated_at
string
1 validation
labels
object

A key/value of labels

functionalities
array[object]

List of functionalities attached to the service

Send a Test Request

Send requests directly from the browser (CORS must be enabled)
Path Params
1 path param not set
service_id
$$.env
2 variables not set
host
Authorization