List server software and versions

GET

/software

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

Any signed-in user. Lists the templates (vanilla, paper, purpur) and their supported versions, newest first: Minecraft releases from 1.18 and the year-numbered releases from 26.1. Versions come from the synced catalog snapshot. Before the first catalog sync (or when the Controller never syncs), they come from the artifacts already in the cache, and fromCache is true.

Authorizations

sessionCookie
bearerToken

Responses

200

The templates and their versions.

application/json

object

items

required

Array<object>

object

template

required

string

Allowed values: vanilla paper purpur folia velocity

versions

required

Supported versions, newest first.

Array<string>

fromCache

required

True when no catalog snapshot is available yet, and the versions are those of cached artifacts.

boolean

Example

{
  "items": [
    {
      "template": "vanilla"
    }
  ]
}

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.