List roles

GET

/roles

curl --request GET \
  --url https://example.com/api/v1/roles \
  --cookie __Host-shardkeep_session=<__Host-shardkeep_session>

Authorizations

• sessionCookie
• bearerToken

Responses

200

Built-in roles first, then custom roles by name.

Media typeapplication/json

object

items

required

Array<object>

object

id

required

string format: uuid

name

required

string

description

required

string

builtin

required

Built-in roles can be assigned but not changed.

boolean

permissions

required

Array<string>

Allowed values: servers.read servers.create servers.start servers.stop servers.delete servers.console servers.command servers.update files.read files.write files.delete plugins.read plugins.install plugins.update plugins.delete nodes.read nodes.manage backups.read backups.create backups.restore

createdAt

required

string format: date-time

Example

{
  "items": [
    {
      "permissions": [
        "servers.read"
      ]
    }
  ]
}

401

Not signed in, or the credentials are invalid.

Media typeapplication/problem+json

An RFC 9457 problem with a machine-readable code.

object

type

required

string

title

required

string

status

required

integer

detail

string

code

required

Stable machine-readable error code.

string

Example

{
  "type": "about:blank",
  "title": "Conflict",
  "status": 409,
  "code": "conflict"
}

403

Signed in, but not allowed.

Media typeapplication/problem+json

An RFC 9457 problem with a machine-readable code.

object

type

required

string

title

required

string

status

required

integer

detail

string

code

required

Stable machine-readable error code.

string

Example

{
  "type": "about:blank",
  "title": "Conflict",
  "status": 409,
  "code": "conflict"
}