Skip to main content
GET
List role permissions

Authorizations

Authorization
string
header
required

Your API key, sent as a bearer token. Create one in the control panel under API Keys, give it only the permissions the integration needs, and copy it when it is created. It cannot be shown again. Each key is restricted to one owned team. The key determines the team for every request.

Response

The whole set, as a JSON array. There is no envelope and no paging.

key
string
required

The key a route is mapped to, and what a role stores.

Example:

"server.power"

name
string
required

The name shown to customers.

Example:

"Control power"

description
string
required

A sentence saying what holding it lets a member do, shown under the name in the role editor.

Example:

"Start, stop, restart and shut a server down."

group
string
required

Which section of the role editor shows it.

Example:

"Servers"

requires
string[]
required

The permissions this one is useless without.

Example:
sensitive
boolean
required

The handful that destroy data, hand over the guest entirely, or spend the account's money, so the editor can say so on the row.

Example:

false

Example: