OnCallRoles
Update an On-Call Role
Update a specific On-Call Role by id
PUT
/
v1
/
on_call_roles
/
{id}
Update an On-Call Role
curl --request PUT \
--url https://api.rootly.com/v1/on_call_roles/{id} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/vnd.api+json' \
--data '
{
"data": {
"type": "on_call_roles",
"attributes": {
"name": "<string>",
"system_role": "custom",
"alert_sources_permissions": [],
"alert_urgency_permissions": [],
"alert_fields_permissions": [],
"alert_groups_permissions": [],
"alert_routing_rules_permissions": [],
"on_call_readiness_report_permissions": [
"read"
],
"on_call_roles_permissions": [],
"alerts_permissions": [],
"api_keys_permissions": [],
"audits_permissions": [],
"contacts_permissions": [
"read"
],
"escalation_policies_permissions": [],
"groups_permissions": [],
"heartbeats_permissions": [],
"integrations_permissions": [],
"invitations_permissions": [],
"live_call_routing_permissions": [],
"schedule_override_permissions": [],
"schedules_permissions": [],
"services_permissions": [],
"functionalities_permissions": [],
"webhooks_permissions": [],
"workflows_permissions": [],
"catalogs_permissions": []
}
}
}
'import requests
url = "https://api.rootly.com/v1/on_call_roles/{id}"
payload = { "data": {
"type": "on_call_roles",
"attributes": {
"name": "<string>",
"system_role": "custom",
"alert_sources_permissions": [],
"alert_urgency_permissions": [],
"alert_fields_permissions": [],
"alert_groups_permissions": [],
"alert_routing_rules_permissions": [],
"on_call_readiness_report_permissions": ["read"],
"on_call_roles_permissions": [],
"alerts_permissions": [],
"api_keys_permissions": [],
"audits_permissions": [],
"contacts_permissions": ["read"],
"escalation_policies_permissions": [],
"groups_permissions": [],
"heartbeats_permissions": [],
"integrations_permissions": [],
"invitations_permissions": [],
"live_call_routing_permissions": [],
"schedule_override_permissions": [],
"schedules_permissions": [],
"services_permissions": [],
"functionalities_permissions": [],
"webhooks_permissions": [],
"workflows_permissions": [],
"catalogs_permissions": []
}
} }
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/vnd.api+json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/vnd.api+json'},
body: JSON.stringify({
data: {
type: 'on_call_roles',
attributes: {
name: '<string>',
system_role: 'custom',
alert_sources_permissions: [],
alert_urgency_permissions: [],
alert_fields_permissions: [],
alert_groups_permissions: [],
alert_routing_rules_permissions: [],
on_call_readiness_report_permissions: ['read'],
on_call_roles_permissions: [],
alerts_permissions: [],
api_keys_permissions: [],
audits_permissions: [],
contacts_permissions: ['read'],
escalation_policies_permissions: [],
groups_permissions: [],
heartbeats_permissions: [],
integrations_permissions: [],
invitations_permissions: [],
live_call_routing_permissions: [],
schedule_override_permissions: [],
schedules_permissions: [],
services_permissions: [],
functionalities_permissions: [],
webhooks_permissions: [],
workflows_permissions: [],
catalogs_permissions: []
}
}
})
};
fetch('https://api.rootly.com/v1/on_call_roles/{id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.rootly.com/v1/on_call_roles/{id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_POSTFIELDS => json_encode([
'data' => [
'type' => 'on_call_roles',
'attributes' => [
'name' => '<string>',
'system_role' => 'custom',
'alert_sources_permissions' => [
],
'alert_urgency_permissions' => [
],
'alert_fields_permissions' => [
],
'alert_groups_permissions' => [
],
'alert_routing_rules_permissions' => [
],
'on_call_readiness_report_permissions' => [
'read'
],
'on_call_roles_permissions' => [
],
'alerts_permissions' => [
],
'api_keys_permissions' => [
],
'audits_permissions' => [
],
'contacts_permissions' => [
'read'
],
'escalation_policies_permissions' => [
],
'groups_permissions' => [
],
'heartbeats_permissions' => [
],
'integrations_permissions' => [
],
'invitations_permissions' => [
],
'live_call_routing_permissions' => [
],
'schedule_override_permissions' => [
],
'schedules_permissions' => [
],
'services_permissions' => [
],
'functionalities_permissions' => [
],
'webhooks_permissions' => [
],
'workflows_permissions' => [
],
'catalogs_permissions' => [
]
]
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/vnd.api+json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.rootly.com/v1/on_call_roles/{id}"
payload := strings.NewReader("{\n \"data\": {\n \"type\": \"on_call_roles\",\n \"attributes\": {\n \"name\": \"<string>\",\n \"system_role\": \"custom\",\n \"alert_sources_permissions\": [],\n \"alert_urgency_permissions\": [],\n \"alert_fields_permissions\": [],\n \"alert_groups_permissions\": [],\n \"alert_routing_rules_permissions\": [],\n \"on_call_readiness_report_permissions\": [\n \"read\"\n ],\n \"on_call_roles_permissions\": [],\n \"alerts_permissions\": [],\n \"api_keys_permissions\": [],\n \"audits_permissions\": [],\n \"contacts_permissions\": [\n \"read\"\n ],\n \"escalation_policies_permissions\": [],\n \"groups_permissions\": [],\n \"heartbeats_permissions\": [],\n \"integrations_permissions\": [],\n \"invitations_permissions\": [],\n \"live_call_routing_permissions\": [],\n \"schedule_override_permissions\": [],\n \"schedules_permissions\": [],\n \"services_permissions\": [],\n \"functionalities_permissions\": [],\n \"webhooks_permissions\": [],\n \"workflows_permissions\": [],\n \"catalogs_permissions\": []\n }\n }\n}")
req, _ := http.NewRequest("PUT", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/vnd.api+json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.put("https://api.rootly.com/v1/on_call_roles/{id}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/vnd.api+json")
.body("{\n \"data\": {\n \"type\": \"on_call_roles\",\n \"attributes\": {\n \"name\": \"<string>\",\n \"system_role\": \"custom\",\n \"alert_sources_permissions\": [],\n \"alert_urgency_permissions\": [],\n \"alert_fields_permissions\": [],\n \"alert_groups_permissions\": [],\n \"alert_routing_rules_permissions\": [],\n \"on_call_readiness_report_permissions\": [\n \"read\"\n ],\n \"on_call_roles_permissions\": [],\n \"alerts_permissions\": [],\n \"api_keys_permissions\": [],\n \"audits_permissions\": [],\n \"contacts_permissions\": [\n \"read\"\n ],\n \"escalation_policies_permissions\": [],\n \"groups_permissions\": [],\n \"heartbeats_permissions\": [],\n \"integrations_permissions\": [],\n \"invitations_permissions\": [],\n \"live_call_routing_permissions\": [],\n \"schedule_override_permissions\": [],\n \"schedules_permissions\": [],\n \"services_permissions\": [],\n \"functionalities_permissions\": [],\n \"webhooks_permissions\": [],\n \"workflows_permissions\": [],\n \"catalogs_permissions\": []\n }\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.rootly.com/v1/on_call_roles/{id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/vnd.api+json'
request.body = "{\n \"data\": {\n \"type\": \"on_call_roles\",\n \"attributes\": {\n \"name\": \"<string>\",\n \"system_role\": \"custom\",\n \"alert_sources_permissions\": [],\n \"alert_urgency_permissions\": [],\n \"alert_fields_permissions\": [],\n \"alert_groups_permissions\": [],\n \"alert_routing_rules_permissions\": [],\n \"on_call_readiness_report_permissions\": [\n \"read\"\n ],\n \"on_call_roles_permissions\": [],\n \"alerts_permissions\": [],\n \"api_keys_permissions\": [],\n \"audits_permissions\": [],\n \"contacts_permissions\": [\n \"read\"\n ],\n \"escalation_policies_permissions\": [],\n \"groups_permissions\": [],\n \"heartbeats_permissions\": [],\n \"integrations_permissions\": [],\n \"invitations_permissions\": [],\n \"live_call_routing_permissions\": [],\n \"schedule_override_permissions\": [],\n \"schedules_permissions\": [],\n \"services_permissions\": [],\n \"functionalities_permissions\": [],\n \"webhooks_permissions\": [],\n \"workflows_permissions\": [],\n \"catalogs_permissions\": []\n }\n }\n}"
response = http.request(request)
puts response.read_body{
"data": {
"id": "<string>",
"type": "on_call_roles",
"attributes": {
"name": "<string>",
"created_at": "<string>",
"updated_at": "<string>",
"slug": "<string>",
"system_role": "custom",
"alert_sources_permissions": [],
"alert_urgency_permissions": [],
"alert_fields_permissions": [],
"alert_groups_permissions": [],
"alert_routing_rules_permissions": [],
"on_call_readiness_report_permissions": [
"read"
],
"on_call_roles_permissions": [],
"alerts_permissions": [],
"api_keys_permissions": [],
"audits_permissions": [],
"contacts_permissions": [
"read"
],
"escalation_policies_permissions": [],
"groups_permissions": [],
"heartbeats_permissions": [],
"integrations_permissions": [],
"invitations_permissions": [],
"live_call_routing_permissions": [],
"schedule_override_permissions": [],
"schedules_permissions": [],
"services_permissions": [],
"functionalities_permissions": [],
"webhooks_permissions": [],
"workflows_permissions": [],
"catalogs_permissions": []
}
},
"included": [
{
"id": "<string>",
"type": "<string>",
"attributes": {},
"relationships": {}
}
]
}{
"errors": [
{
"title": "<string>",
"status": "<string>",
"code": "<string>",
"detail": "<string>"
}
]
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Path Parameters
Body
application/vnd.api+json
Show child attributes
Show child attributes
Was this page helpful?
⌘I
Update an On-Call Role
curl --request PUT \
--url https://api.rootly.com/v1/on_call_roles/{id} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/vnd.api+json' \
--data '
{
"data": {
"type": "on_call_roles",
"attributes": {
"name": "<string>",
"system_role": "custom",
"alert_sources_permissions": [],
"alert_urgency_permissions": [],
"alert_fields_permissions": [],
"alert_groups_permissions": [],
"alert_routing_rules_permissions": [],
"on_call_readiness_report_permissions": [
"read"
],
"on_call_roles_permissions": [],
"alerts_permissions": [],
"api_keys_permissions": [],
"audits_permissions": [],
"contacts_permissions": [
"read"
],
"escalation_policies_permissions": [],
"groups_permissions": [],
"heartbeats_permissions": [],
"integrations_permissions": [],
"invitations_permissions": [],
"live_call_routing_permissions": [],
"schedule_override_permissions": [],
"schedules_permissions": [],
"services_permissions": [],
"functionalities_permissions": [],
"webhooks_permissions": [],
"workflows_permissions": [],
"catalogs_permissions": []
}
}
}
'import requests
url = "https://api.rootly.com/v1/on_call_roles/{id}"
payload = { "data": {
"type": "on_call_roles",
"attributes": {
"name": "<string>",
"system_role": "custom",
"alert_sources_permissions": [],
"alert_urgency_permissions": [],
"alert_fields_permissions": [],
"alert_groups_permissions": [],
"alert_routing_rules_permissions": [],
"on_call_readiness_report_permissions": ["read"],
"on_call_roles_permissions": [],
"alerts_permissions": [],
"api_keys_permissions": [],
"audits_permissions": [],
"contacts_permissions": ["read"],
"escalation_policies_permissions": [],
"groups_permissions": [],
"heartbeats_permissions": [],
"integrations_permissions": [],
"invitations_permissions": [],
"live_call_routing_permissions": [],
"schedule_override_permissions": [],
"schedules_permissions": [],
"services_permissions": [],
"functionalities_permissions": [],
"webhooks_permissions": [],
"workflows_permissions": [],
"catalogs_permissions": []
}
} }
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/vnd.api+json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/vnd.api+json'},
body: JSON.stringify({
data: {
type: 'on_call_roles',
attributes: {
name: '<string>',
system_role: 'custom',
alert_sources_permissions: [],
alert_urgency_permissions: [],
alert_fields_permissions: [],
alert_groups_permissions: [],
alert_routing_rules_permissions: [],
on_call_readiness_report_permissions: ['read'],
on_call_roles_permissions: [],
alerts_permissions: [],
api_keys_permissions: [],
audits_permissions: [],
contacts_permissions: ['read'],
escalation_policies_permissions: [],
groups_permissions: [],
heartbeats_permissions: [],
integrations_permissions: [],
invitations_permissions: [],
live_call_routing_permissions: [],
schedule_override_permissions: [],
schedules_permissions: [],
services_permissions: [],
functionalities_permissions: [],
webhooks_permissions: [],
workflows_permissions: [],
catalogs_permissions: []
}
}
})
};
fetch('https://api.rootly.com/v1/on_call_roles/{id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.rootly.com/v1/on_call_roles/{id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_POSTFIELDS => json_encode([
'data' => [
'type' => 'on_call_roles',
'attributes' => [
'name' => '<string>',
'system_role' => 'custom',
'alert_sources_permissions' => [
],
'alert_urgency_permissions' => [
],
'alert_fields_permissions' => [
],
'alert_groups_permissions' => [
],
'alert_routing_rules_permissions' => [
],
'on_call_readiness_report_permissions' => [
'read'
],
'on_call_roles_permissions' => [
],
'alerts_permissions' => [
],
'api_keys_permissions' => [
],
'audits_permissions' => [
],
'contacts_permissions' => [
'read'
],
'escalation_policies_permissions' => [
],
'groups_permissions' => [
],
'heartbeats_permissions' => [
],
'integrations_permissions' => [
],
'invitations_permissions' => [
],
'live_call_routing_permissions' => [
],
'schedule_override_permissions' => [
],
'schedules_permissions' => [
],
'services_permissions' => [
],
'functionalities_permissions' => [
],
'webhooks_permissions' => [
],
'workflows_permissions' => [
],
'catalogs_permissions' => [
]
]
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/vnd.api+json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.rootly.com/v1/on_call_roles/{id}"
payload := strings.NewReader("{\n \"data\": {\n \"type\": \"on_call_roles\",\n \"attributes\": {\n \"name\": \"<string>\",\n \"system_role\": \"custom\",\n \"alert_sources_permissions\": [],\n \"alert_urgency_permissions\": [],\n \"alert_fields_permissions\": [],\n \"alert_groups_permissions\": [],\n \"alert_routing_rules_permissions\": [],\n \"on_call_readiness_report_permissions\": [\n \"read\"\n ],\n \"on_call_roles_permissions\": [],\n \"alerts_permissions\": [],\n \"api_keys_permissions\": [],\n \"audits_permissions\": [],\n \"contacts_permissions\": [\n \"read\"\n ],\n \"escalation_policies_permissions\": [],\n \"groups_permissions\": [],\n \"heartbeats_permissions\": [],\n \"integrations_permissions\": [],\n \"invitations_permissions\": [],\n \"live_call_routing_permissions\": [],\n \"schedule_override_permissions\": [],\n \"schedules_permissions\": [],\n \"services_permissions\": [],\n \"functionalities_permissions\": [],\n \"webhooks_permissions\": [],\n \"workflows_permissions\": [],\n \"catalogs_permissions\": []\n }\n }\n}")
req, _ := http.NewRequest("PUT", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/vnd.api+json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.put("https://api.rootly.com/v1/on_call_roles/{id}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/vnd.api+json")
.body("{\n \"data\": {\n \"type\": \"on_call_roles\",\n \"attributes\": {\n \"name\": \"<string>\",\n \"system_role\": \"custom\",\n \"alert_sources_permissions\": [],\n \"alert_urgency_permissions\": [],\n \"alert_fields_permissions\": [],\n \"alert_groups_permissions\": [],\n \"alert_routing_rules_permissions\": [],\n \"on_call_readiness_report_permissions\": [\n \"read\"\n ],\n \"on_call_roles_permissions\": [],\n \"alerts_permissions\": [],\n \"api_keys_permissions\": [],\n \"audits_permissions\": [],\n \"contacts_permissions\": [\n \"read\"\n ],\n \"escalation_policies_permissions\": [],\n \"groups_permissions\": [],\n \"heartbeats_permissions\": [],\n \"integrations_permissions\": [],\n \"invitations_permissions\": [],\n \"live_call_routing_permissions\": [],\n \"schedule_override_permissions\": [],\n \"schedules_permissions\": [],\n \"services_permissions\": [],\n \"functionalities_permissions\": [],\n \"webhooks_permissions\": [],\n \"workflows_permissions\": [],\n \"catalogs_permissions\": []\n }\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.rootly.com/v1/on_call_roles/{id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/vnd.api+json'
request.body = "{\n \"data\": {\n \"type\": \"on_call_roles\",\n \"attributes\": {\n \"name\": \"<string>\",\n \"system_role\": \"custom\",\n \"alert_sources_permissions\": [],\n \"alert_urgency_permissions\": [],\n \"alert_fields_permissions\": [],\n \"alert_groups_permissions\": [],\n \"alert_routing_rules_permissions\": [],\n \"on_call_readiness_report_permissions\": [\n \"read\"\n ],\n \"on_call_roles_permissions\": [],\n \"alerts_permissions\": [],\n \"api_keys_permissions\": [],\n \"audits_permissions\": [],\n \"contacts_permissions\": [\n \"read\"\n ],\n \"escalation_policies_permissions\": [],\n \"groups_permissions\": [],\n \"heartbeats_permissions\": [],\n \"integrations_permissions\": [],\n \"invitations_permissions\": [],\n \"live_call_routing_permissions\": [],\n \"schedule_override_permissions\": [],\n \"schedules_permissions\": [],\n \"services_permissions\": [],\n \"functionalities_permissions\": [],\n \"webhooks_permissions\": [],\n \"workflows_permissions\": [],\n \"catalogs_permissions\": []\n }\n }\n}"
response = http.request(request)
puts response.read_body{
"data": {
"id": "<string>",
"type": "on_call_roles",
"attributes": {
"name": "<string>",
"created_at": "<string>",
"updated_at": "<string>",
"slug": "<string>",
"system_role": "custom",
"alert_sources_permissions": [],
"alert_urgency_permissions": [],
"alert_fields_permissions": [],
"alert_groups_permissions": [],
"alert_routing_rules_permissions": [],
"on_call_readiness_report_permissions": [
"read"
],
"on_call_roles_permissions": [],
"alerts_permissions": [],
"api_keys_permissions": [],
"audits_permissions": [],
"contacts_permissions": [
"read"
],
"escalation_policies_permissions": [],
"groups_permissions": [],
"heartbeats_permissions": [],
"integrations_permissions": [],
"invitations_permissions": [],
"live_call_routing_permissions": [],
"schedule_override_permissions": [],
"schedules_permissions": [],
"services_permissions": [],
"functionalities_permissions": [],
"webhooks_permissions": [],
"workflows_permissions": [],
"catalogs_permissions": []
}
},
"included": [
{
"id": "<string>",
"type": "<string>",
"attributes": {},
"relationships": {}
}
]
}{
"errors": [
{
"title": "<string>",
"status": "<string>",
"code": "<string>",
"detail": "<string>"
}
]
}