Skip to content
Shardkeep

Set the network up

POST
/network
curl --request POST \
  --url https://example.com/api/v1/network \
  --header 'Content-Type: application/json' \
  --cookie __Host-shardkeep_session=<__Host-shardkeep_session> \
  --data '{ "name": "example", "description": "example", "address": "example", "port": 25565 }'

For Controllers whose first administrator was created on the command line. Global administrators only.

Authorizations

Section titled “Authorizations”

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json
object
name
required
string
>= 1 characters <= 64 characters
description
string
<= 500 characters
address

The host name or IP address players connect to, without a port.

string
<= 253 characters
port
integer
default: 25565 >= 1 <= 65535

Responses

Section titled “Responses”

201

Section titled “201”

The network.

Media typeapplication/json
object
name
required
string
description
required
string
hasLogo
required
boolean
address
required
string
port
required
integer
joinAddress
required

What players type, with the port when it is not 25565; empty without an address.

string
lobbyServerIds
required
Array<string>
proxyServerId

The network’s proxy; absent until it is created.

string format: uuid
updatedAt
required
string format: date-time
Examplegenerated
{
  "name": "example",
  "description": "example",
  "hasLogo": true,
  "address": "example",
  "port": 1,
  "joinAddress": "example",
  "lobbyServerIds": [
    "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0"
  ],
  "proxyServerId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
  "updatedAt": "2026-04-15T12:00:00Z"
}

400

Section titled “400”

The request is 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"
}

401

Section titled “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

Section titled “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"
}

409

Section titled “409”

Clashes with existing data or state.

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

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.