Delete a role - Rootly

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
- GET
  List roles
- POST
  Creates a role
- GET
  Retrieves a role
- PUT
  Update a role
- DEL
  Delete a role
ScheduleRotationActiveDays
ScheduleRotationUsers
ScheduleRotations
Schedules
Shifts
Secrets
Services
Severities
StatusPageTemplates
StatusPages
SubStatuses
Teams
UserNotificationRules
Users
WebhooksDeliveries
WebhooksEndpoints

DELETE

roles

{id}

curl --request DELETE \
  --url https://api.rootly.com/v1/roles/%7Bid%7D \
  --header 'Authorization: Bearer REPLACE_BEARER_TOKEN'

{
  "data": {
    "id": "96fb76f5-01db-4df3-8cd5-c56cb7b8b966",
    "type": "roles",
    "attributes": {
      "team_id": 379,
      "name": "Role 5",
      "slug": "role-5",
      "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": "2b3860fc-74f4-409c-a941-16a08d0dbb84",
      "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-11T19:14:49.185-07:00",
      "created_at": "2025-03-11T19:14:49.023-07:00"
    }
  }
}

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

string

required

Response

200

application/vnd.api+json

role deleted

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?

List schedule rotation active daysList schedule rotation active days

curl --request DELETE \
  --url https://api.rootly.com/v1/roles/%7Bid%7D \
  --header 'Authorization: Bearer REPLACE_BEARER_TOKEN'

{
  "data": {
    "id": "96fb76f5-01db-4df3-8cd5-c56cb7b8b966",
    "type": "roles",
    "attributes": {
      "team_id": 379,
      "name": "Role 5",
      "slug": "role-5",
      "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": "2b3860fc-74f4-409c-a941-16a08d0dbb84",
      "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-11T19:14:49.185-07:00",
      "created_at": "2025-03-11T19:14:49.023-07:00"
    }
  }
}