Get a role

GET

/roles/{roleId}

const url = 'https://example.com/api/v1/roles/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0';
const options = {
  method: 'GET',
  headers: {cookie: '__Host-shardkeep_session=<__Host-shardkeep_session>'}
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url https://example.com/api/v1/roles/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0 \
  --cookie __Host-shardkeep_session=<__Host-shardkeep_session>

Authorizations

sessionCookie
bearerToken

Parameters

Path Parameters

roleId

required

string format: uuid

Responses

200

The role.

application/json

object

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

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

401

Not signed in, or the credentials are invalid.

application/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.

application/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"
}

404

Not found, or not visible to you.

application/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"
}

Shardkeep is free software under the AGPL-3.0. Minecraft is a trademark of Mojang AB; Shardkeep is not affiliated with or endorsed by Mojang or Microsoft.