Creates a role

POST

roles

curl --request POST \
  --url https://api.rootly.com/v1/roles \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/vnd.api+json' \
  --data '{
  "data": {
    "type": "roles",
    "attributes": {
      "name": "<string>",
      "slug": "<string>",
      "incident_permission_set_id": "<string>",
      "alerts_permissions": [
        "create"
      ],
      "api_keys_permissions": [
        "create"
      ],
      "audits_permissions": [
        "create"
      ],
      "billing_permissions": [
        "create"
      ],
      "environments_permissions": [
        "create"
      ],
      "form_fields_permissions": [
        "create"
      ],
      "functionalities_permissions": [
        "create"
      ],
      "groups_permissions": [
        "create"
      ],
      "incident_causes_permissions": [
        "create"
      ],
      "incident_feedbacks_permissions": [
        "create"
      ],
      "incident_roles_permissions": [
        "create"
      ],
      "incident_types_permissions": [
        "create"
      ],
      "incidents_permissions": [
        "create"
      ],
      "integrations_permissions": [
        "create"
      ],
      "invitations_permissions": [
        "create"
      ],
      "playbooks_permissions": [
        "create"
      ],
      "private_incidents_permissions": [
        "create"
      ],
      "pulses_permissions": [
        "create"
      ],
      "retrospective_permissions": [
        "create"
      ],
      "roles_permissions": [
        "create"
      ],
      "secrets_permissions": [
        "create"
      ],
      "services_permissions": [
        "create"
      ],
      "severities_permissions": [
        "create"
      ],
      "status_pages_permissions": [
        "create"
      ],
      "webhooks_permissions": [
        "create"
      ],
      "workflows_permissions": [
        "create"
      ]
    }
  }
}'

{
  "data": {
    "id": "5afda192-c005-489f-94e7-02c91b245744",
    "type": "roles",
    "attributes": {
      "team_id": 376,
      "name": "Infrastructure",
      "slug": "infrastructure",
      "is_deletable": true,
      "is_editable": true,
      "alerts_permissions": [
        "create",
        "read"
      ],
      "api_keys_permissions": [
        "read"
      ],
      "audits_permissions": [],
      "billing_permissions": [
        "update"
      ],
      "environments_permissions": [
        "read"
      ],
      "form_fields_permissions": [
        "read"
      ],
      "functionalities_permissions": [
        "read"
      ],
      "groups_permissions": [
        "read"
      ],
      "incident_causes_permissions": [
        "read"
      ],
      "incident_feedbacks_permissions": [
        "read",
        "create",
        "update"
      ],
      "incident_permission_set_id": "041d555f-25fa-4972-aa16-b5e0991bb156",
      "incident_roles_permissions": [
        "read"
      ],
      "incident_types_permissions": [
        "read"
      ],
      "incidents_permissions": [
        "read"
      ],
      "integrations_permissions": [],
      "invitations_permissions": [
        "read"
      ],
      "playbooks_permissions": [
        "read"
      ],
      "private_incidents_permissions": [],
      "pulses_permissions": [
        "create",
        "update",
        "read"
      ],
      "retrospective_permissions": [
        "read"
      ],
      "roles_permissions": [
        "read"
      ],
      "secrets_permissions": [
        "create"
      ],
      "services_permissions": [
        "read"
      ],
      "severities_permissions": [
        "read"
      ],
      "status_pages_permissions": [
        "read"
      ],
      "webhooks_permissions": [
        "read"
      ],
      "workflows_permissions": [
        "read"
      ],
      "updated_at": "2025-03-19T07:54:41.275-07:00",
      "created_at": "2025-03-19T07:54:41.275-07: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:

roles

data.attributes

object

required

data.attributes.name

string

required

The role name.

data.attributes.slug

string

The role slug.

data.attributes.incident_permission_set_id

string | null

Associated incident permissions set.

data.attributes.alerts_permissions

enum<string>[]

Available options:

create,

read

data.attributes.api_keys_permissions

enum<string>[]

Available options:

create,

read,

update,

delete

data.attributes.audits_permissions

enum<string>[]

Available options:

create,

read,

update,

delete

data.attributes.billing_permissions

enum<string>[]

Available options:

create,

read,

update,

delete

data.attributes.environments_permissions

enum<string>[]

Available options:

create,

read,

update,

delete

data.attributes.form_fields_permissions

enum<string>[]

Available options:

create,

read,

update,

delete

data.attributes.functionalities_permissions

enum<string>[]

Available options:

create,

read,

update,

delete

data.attributes.groups_permissions

enum<string>[]

Available options:

create,

read,

update,

delete

data.attributes.incident_causes_permissions

enum<string>[]

Available options:

create,

read,

update,

delete

data.attributes.incident_feedbacks_permissions

enum<string>[]

Available options:

create,

read,

update,

delete

data.attributes.incident_roles_permissions

enum<string>[]

Available options:

create,

read,

update,

delete

data.attributes.incident_types_permissions

enum<string>[]

Available options:

create,

read,

update,

delete

data.attributes.incidents_permissions

enum<string>[]

Available options:

create,

read,

update,

delete

data.attributes.integrations_permissions

enum<string>[]

Available options:

create,

read,

update,

delete

data.attributes.invitations_permissions

enum<string>[]

Available options:

create,

read,

update,

delete

data.attributes.playbooks_permissions

enum<string>[]

Available options:

create,

read,

update,

delete

data.attributes.private_incidents_permissions

enum<string>[]

Available options:

create,

read,

update,

delete

data.attributes.pulses_permissions

enum<string>[]

Available options:

create,

update,

read

data.attributes.retrospective_permissions

enum<string>[]

Available options:

create,

read,

update,

delete

data.attributes.roles_permissions

enum<string>[]

Available options:

create,

read,

update,

delete

data.attributes.secrets_permissions

enum<string>[]

Available options:

create,

read,

update,

delete

data.attributes.services_permissions

enum<string>[]

Available options:

create,

read,

update,

delete

data.attributes.severities_permissions

enum<string>[]

Available options:

create,

read,

update,

delete

data.attributes.status_pages_permissions

enum<string>[]

Available options:

create,

read,

update,

delete

data.attributes.webhooks_permissions

enum<string>[]

Available options:

create,

read,

update,

delete

data.attributes.workflows_permissions

enum<string>[]

Available options:

create,

read,

update,

delete

Response

201

application/vnd.api+json

role created

data

object

required

data.id

string

required

Unique ID of the role

data.type

enum<string>

required

Available options:

roles

data.attributes

object

required

data.attributes.name

string

required

The role name.

data.attributes.slug

string

required

The role slug.

data.attributes.created_at

string

required

data.attributes.updated_at

string

required

data.attributes.incident_permission_set_id

string | null

Associated incident permissions set.

data.attributes.is_deletable

boolean

Whether the role can be deleted.

data.attributes.is_editable

boolean

Whether the role can be edited.

data.attributes.alerts_permissions

enum<string>[]

Available options:

create,

read

data.attributes.api_keys_permissions

enum<string>[]

Available options:

create,

read,

update,

delete

data.attributes.audits_permissions

enum<string>[]

Available options:

create,

read,

update,

delete

data.attributes.billing_permissions

enum<string>[]

Available options:

create,

read,

update,

delete

data.attributes.environments_permissions

enum<string>[]

Available options:

create,

read,

update,

delete

data.attributes.form_fields_permissions

enum<string>[]

Available options:

create,

read,

update,

delete

data.attributes.functionalities_permissions

enum<string>[]

Available options:

create,

read,

update,

delete

data.attributes.groups_permissions

enum<string>[]

Available options:

create,

read,

update,

delete

data.attributes.incident_causes_permissions

enum<string>[]

Available options:

create,

read,

update,

delete

data.attributes.incident_feedbacks_permissions

enum<string>[]

Available options:

create,

read,

update,

delete

data.attributes.incident_roles_permissions

enum<string>[]

Available options:

create,

read,

update,

delete

data.attributes.incident_types_permissions

enum<string>[]

Available options:

create,

read,

update,

delete

data.attributes.incidents_permissions

enum<string>[]

Available options:

create,

read,

update,

delete

data.attributes.integrations_permissions

enum<string>[]

Available options:

create,

read,

update,

delete

data.attributes.invitations_permissions

enum<string>[]

Available options:

create,

read,

update,

delete

data.attributes.playbooks_permissions

enum<string>[]

Available options:

create,

read,

update,

delete

data.attributes.private_incidents_permissions

enum<string>[]

Available options:

create,

read,

update,

delete

data.attributes.pulses_permissions

enum<string>[]

Available options:

create,

update,

read

data.attributes.retrospective_permissions

enum<string>[]

Available options:

create,

read,

update,

delete

data.attributes.roles_permissions

enum<string>[]

Available options:

create,

read,

update,

delete

data.attributes.secrets_permissions

enum<string>[]

Available options:

create,

read,

update,

delete

data.attributes.services_permissions

enum<string>[]

Available options:

create,

read,

update,

delete

data.attributes.severities_permissions

enum<string>[]

Available options:

create,

read,

update,

delete

data.attributes.status_pages_permissions

enum<string>[]

Available options:

create,

read,

update,

delete

data.attributes.webhooks_permissions

enum<string>[]

Available options:

create,

read,

update,

delete

data.attributes.workflows_permissions

enum<string>[]

Available options:

create,

read,

update,

delete

Was this page helpful?

Retrieves a roleRetrieves a specific role by id

curl --request POST \
  --url https://api.rootly.com/v1/roles \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/vnd.api+json' \
  --data '{
  "data": {
    "type": "roles",
    "attributes": {
      "name": "<string>",
      "slug": "<string>",
      "incident_permission_set_id": "<string>",
      "alerts_permissions": [
        "create"
      ],
      "api_keys_permissions": [
        "create"
      ],
      "audits_permissions": [
        "create"
      ],
      "billing_permissions": [
        "create"
      ],
      "environments_permissions": [
        "create"
      ],
      "form_fields_permissions": [
        "create"
      ],
      "functionalities_permissions": [
        "create"
      ],
      "groups_permissions": [
        "create"
      ],
      "incident_causes_permissions": [
        "create"
      ],
      "incident_feedbacks_permissions": [
        "create"
      ],
      "incident_roles_permissions": [
        "create"
      ],
      "incident_types_permissions": [
        "create"
      ],
      "incidents_permissions": [
        "create"
      ],
      "integrations_permissions": [
        "create"
      ],
      "invitations_permissions": [
        "create"
      ],
      "playbooks_permissions": [
        "create"
      ],
      "private_incidents_permissions": [
        "create"
      ],
      "pulses_permissions": [
        "create"
      ],
      "retrospective_permissions": [
        "create"
      ],
      "roles_permissions": [
        "create"
      ],
      "secrets_permissions": [
        "create"
      ],
      "services_permissions": [
        "create"
      ],
      "severities_permissions": [
        "create"
      ],
      "status_pages_permissions": [
        "create"
      ],
      "webhooks_permissions": [
        "create"
      ],
      "workflows_permissions": [
        "create"
      ]
    }
  }
}'

{
  "data": {
    "id": "5afda192-c005-489f-94e7-02c91b245744",
    "type": "roles",
    "attributes": {
      "team_id": 376,
      "name": "Infrastructure",
      "slug": "infrastructure",
      "is_deletable": true,
      "is_editable": true,
      "alerts_permissions": [
        "create",
        "read"
      ],
      "api_keys_permissions": [
        "read"
      ],
      "audits_permissions": [],
      "billing_permissions": [
        "update"
      ],
      "environments_permissions": [
        "read"
      ],
      "form_fields_permissions": [
        "read"
      ],
      "functionalities_permissions": [
        "read"
      ],
      "groups_permissions": [
        "read"
      ],
      "incident_causes_permissions": [
        "read"
      ],
      "incident_feedbacks_permissions": [
        "read",
        "create",
        "update"
      ],
      "incident_permission_set_id": "041d555f-25fa-4972-aa16-b5e0991bb156",
      "incident_roles_permissions": [
        "read"
      ],
      "incident_types_permissions": [
        "read"
      ],
      "incidents_permissions": [
        "read"
      ],
      "integrations_permissions": [],
      "invitations_permissions": [
        "read"
      ],
      "playbooks_permissions": [
        "read"
      ],
      "private_incidents_permissions": [],
      "pulses_permissions": [
        "create",
        "update",
        "read"
      ],
      "retrospective_permissions": [
        "read"
      ],
      "roles_permissions": [
        "read"
      ],
      "secrets_permissions": [
        "create"
      ],
      "services_permissions": [
        "read"
      ],
      "severities_permissions": [
        "read"
      ],
      "status_pages_permissions": [
        "read"
      ],
      "webhooks_permissions": [
        "read"
      ],
      "workflows_permissions": [
        "read"
      ],
      "updated_at": "2025-03-19T07:54:41.275-07:00",
      "created_at": "2025-03-19T07:54:41.275-07:00"
    }
  }
}

Overview

AlertEvents

AlertGroups

AlertRoutingRules

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