What you may do

GET

/me/permissions

const url = 'https://example.com/api/v1/me/permissions';
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/me/permissions \
  --cookie __Host-shardkeep_session=<__Host-shardkeep_session>

Your effective permissions, by scope, for deciding what to offer. An API token restricted to some permissions gets only those, and never acts as a global administrator. The API still checks every request.

Authorizations

sessionCookie
bearerToken

Responses

200

Your effective permissions.

application/json

Effective permissions by scope. A permission is allowed on a server when it is in global, under the server’s team, or under the server itself; creating a server needs it in global or under the team. A team or server lists only what global does not already hold. Node permissions take effect only in global.

object

globalAdmin

required

Acts as a global administrator, which allows everything.

boolean

global

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

teams

required

Array<object>

object

teamId

required

string format: uuid

name

required

string

permissions

required

Array<string>

servers

required

Array<object>

object

serverId

required

string format: uuid

permissions

required

Array<string>

Example

{
  "global": [
    "servers.read"
  ],
  "teams": [
    {
      "permissions": [
        "servers.read"
      ]
    }
  ],
  "servers": [
    {
      "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"
}

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.