Client API: External Servers

Put a server you host yourself behind Game Shield: connection, tests and branding.

Base URL: https://api.coritan.com/api/v1. Paths below are complete.

To try these requests in the browser, open the interactive Client API reference.

GET /api/v1/client/external-servers

Authentication: an access token, sent as Authorization: Bearer <token>.

GET /api/v1/client/external-servers/regions

Regions a new or existing external server can be served from.

Authentication: an access token, sent as Authorization: Bearer <token>.

GET /api/v1/client/external-servers/{service_id}

Authentication: an access token, sent as Authorization: Bearer <token>.

PATCH /api/v1/client/external-servers/{service_id}

Change where players are forwarded, how, and through which region.

Send only the fields to change. For a Java server, bedrock_bridge and geyser_port control Geyser, which lets Bedrock players join at the same join name: a geyser_port turns it on at that port, bedrock_bridge: true alone uses port 19132, and geyser_port: null or bedrock_bridge: false turns it off. The port must differ from the Java port and be between 1024 and 65535, and a Bedrock server takes none. A refusal answers 422 with the reason in detail.errors. The reply is the server, with geyser set to what Geyser answered when a Geyser or address change just ran a check, and null otherwise.

Authentication: an access token, sent as Authorization: Bearer <token>.

application/json (required)

GET /api/v1/client/external-servers/{service_id}/custom-domain

Authentication: an access token, sent as Authorization: Bearer <token>.

POST /api/v1/client/external-servers/{service_id}/custom-domain

Authentication: an access token, sent as Authorization: Bearer <token>.

application/json (required)

PATCH /api/v1/client/external-servers/{service_id}/custom-domain

Show the vanity hostname, or the hosted one, in the public server list. This is the same switch the org portal has, for platform-direct customers.

Authentication: an access token, sent as Authorization: Bearer <token>.

application/json (required)

DELETE /api/v1/client/external-servers/{service_id}/custom-domain

Authentication: an access token, sent as Authorization: Bearer <token>.

POST /api/v1/client/external-servers/{service_id}/custom-domain/verify

Check the CNAME now rather than waiting for the next maintenance pass.

Authentication: an access token, sent as Authorization: Bearer <token>.

POST /api/v1/client/external-servers/{service_id}/test

Status-ping the backend now and record the answer.

Returns probe (what the Java or Bedrock server answered), state (online or offline) and geyser. geyser is null for a server with no Geyser port. Otherwise it is {reachable, transport, message}: reachable is true when Geyser answered the edge's NetherNet status request, transport is nethernet or raknet (null when nothing answered), and message says what to fix when it is not reachable. A Geyser that does not answer does not change state.

Authentication: an access token, sent as Authorization: Bearer <token>.