Get the network

GET

/network

curl --request GET \
  --url https://example.com/api/v1/network \
  --cookie __Host-shardkeep_session=<__Host-shardkeep_session>

Any signed-in user. network_not_set_up before it is.

Authorizations

• sessionCookie
• bearerToken

Responses

200

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

Example^generated

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

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

404

Not found, or not visible to you.

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