About this Controller

GET

/system

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

Any signed-in user. The Controller’s version, and the Agent image that matches it, for enrolling Nodes: the release image of the same version, or what the operator set with -agent-image (for development builds).

Authorizations

sessionCookie
bearerToken

Responses

200

About this Controller.

application/json

object

version

required

string

agentImage

required

The Agent image to start on a new Node.

string

Example

{
  "version": "1.14.0",
  "agentImage": "registry.gitlab.com/shardkeep/shardkeep/agent:1.14.0"
}

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.