v12

latestOpenAPI 3.0.3raw.githubusercontent.com2026-06-1811583196.1 KB
Roles

Create custom role

Create a custom role bundling a set of permissions at either account or project scope.

Get the list of valid permission strings from List Permissions.

post/api/v1/roles

Request body

namestring required
slugstring required
descriptionstring
scope'account' | 'project' required
permissionsstring[] required

Example request

{
  "name": "Custom Operator",
  "slug": "custom-operator",
  "permissions": [
    "vm.view",
    "vm.create",
    "volume.view"
  ]
}

Response

Role created

successboolean

Example response

{
  "data": {
    "name": "Operator",
    "slug": "operator"
  }
}