Overview
AlertEvents
AlertGroups
AlertRoutingRules
AlertUrgencies
AlertSources
Alerts
Audits
Authorizations
CatalogEntities
CatalogEntityProperties
CatalogFields
Catalogs
[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
- GETList incidents
- POSTCreates an incident
- GETRetrieves an incident
- PUTUpdate an incident
- DELDelete an incident
- PUTMitigate an incident
- PUTResolve an incident
- PUTCancel an incident
- PUTTriage an incident
- PUTRestart an incident
- PUTMark an incident as a duplicate
- POSTAdd subscribers to incident
- DELRemove subscribers from incident
- POSTAssign user to incident
- DELRemove assigned user from incident
IpRanges
LiveCallRouters
OnCallRoles
OnCallShadows
OverrideShifts
PlaybookTasks
Playbooks
RetrospectiveTemplates
RetrospectiveConfigurations
RetrospectiveProcessGroupSteps
RetrospectiveProcessGroups
RetrospectiveProcesses
RetrospectiveSteps
ScheduleRotationActiveDays
ScheduleRotationUsers
ScheduleRotations
Schedules
Services
Severities
StatusPageTemplates
StatusPages
SubStatuses
Teams
UserNotificationRules
WebhooksDeliveries
OnCallShadows
Update an On Call Shadow configuration
OnCallShadows
Update an On Call Shadow configuration
Update a specific on call shadow configuration by id
PUT
/
v1
/
on_call_shadows
/
{id}
curl --request PUT \
--url https://api.rootly.com/v1/on_call_shadows/{id} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/vnd.api+json' \
--data '{
"data": {
"type": "on_call_shadows",
"attributes": {
"schedule_id": "<string>",
"shadowable_type": "User",
"shadowable_id": "<string>",
"shadow_user_id": 123,
"starts_at": "2023-11-07T05:31:56Z",
"ends_at": "2023-11-07T05:31:56Z"
}
}
}'
{
"data": {
"id": "5bb1c54d-fe75-4ed2-81de-28954bbd014a",
"type": "on_call_shadows",
"attributes": {
"schedule_id": "65679212-5afa-4959-9765-8c9bef5160e4",
"shadowable_type": "Schedule",
"shadowable_id": "65679212-5afa-4959-9765-8c9bef5160e4",
"shadow_user_id": 360,
"starts_at": "2025-03-29T01:03:36.000-07:00",
"ends_at": "2025-03-29T23:03:36.000-07:00",
"created_at": "2025-03-28T23:03:36.827-07:00",
"updated_at": "2025-03-28T23:03:38.299-07:00"
}
}
}
Authorizations
Bearer authentication header of the form Bearer <token>
, where <token>
is your auth token.
Path Parameters
Body
application/vnd.api+json
Available options:
on_call_shadows
ID of schedule the shadow shift belongs to
Available options:
User
, Schedule
ID of schedule or user the shadow user is shadowing
Which user the shadow shift belongs to.
Start datetime of shadow shift
End datetime for shadow shift
Response
200
application/vnd.api+json
on call shadows configuration is is updated
Unique ID of shadow shift
Available options:
on_call_shadows
ID of schedule the shadow shift belongs to
Available options:
User
, Schedule
ID of schedule or user the shadow user is shadowing
Which user the shadow shift belongs to.
Start datetime of shadow shift
End datetime for shadow shift
Date of creation
Date of last update
curl --request PUT \
--url https://api.rootly.com/v1/on_call_shadows/{id} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/vnd.api+json' \
--data '{
"data": {
"type": "on_call_shadows",
"attributes": {
"schedule_id": "<string>",
"shadowable_type": "User",
"shadowable_id": "<string>",
"shadow_user_id": 123,
"starts_at": "2023-11-07T05:31:56Z",
"ends_at": "2023-11-07T05:31:56Z"
}
}
}'
{
"data": {
"id": "5bb1c54d-fe75-4ed2-81de-28954bbd014a",
"type": "on_call_shadows",
"attributes": {
"schedule_id": "65679212-5afa-4959-9765-8c9bef5160e4",
"shadowable_type": "Schedule",
"shadowable_id": "65679212-5afa-4959-9765-8c9bef5160e4",
"shadow_user_id": 360,
"starts_at": "2025-03-29T01:03:36.000-07:00",
"ends_at": "2025-03-29T23:03:36.000-07:00",
"created_at": "2025-03-28T23:03:36.827-07:00",
"updated_at": "2025-03-28T23:03:38.299-07:00"
}
}
}