Client API: Game Shield

Join addresses on the platform's join domain: names, branding and custom domains.

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.

POST /api/v1/gameproxy/availability

Claim check on the write primary so create/delete races cannot lie.

application/json (required)

POST /api/v1/gameproxy/name-suggestions

application/json (required)

GET /api/v1/gameproxy/policy

Storefront-facing effective policy (auto-provision + base domain).

GET /api/v1/gameproxy/routes

The user's game routes, each with custom_domain: the answer GET /gameproxy/routes/{id}/custom-domain gives for it, read for the whole list at once. A route bound to a server another account holds shows no custom domain, since that one belongs to the server's account.

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

POST /api/v1/gameproxy/routes

A join address on the platform's domain for one of the account's own servers.

upstream_service_id names a service the account holds and has not ended. Another account's service, a brand customer's and an unknown id all answer 404 Server not found before anything is created. upstream_port may name another port that server answers on (422 lists them). upstream_host answers 422: a server hosted elsewhere is an External Server. org_id answers 422, since a brand's join addresses come with that brand's orders. base_domain must be a join domain the platform offers (422 lists them), and is the platform's own when left out. The rules live in check_customer_route because the admin console's route create shares RouteCreate and is not held to them.

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

application/json (required)

PATCH /api/v1/gameproxy/routes/{route_id}

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

application/json (required)

GET /api/v1/gameproxy/routes/{route_id}/custom-domain

Vanity CNAME state for this route's join address.

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

POST /api/v1/gameproxy/routes/{route_id}/custom-domain

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

application/json (required)

PATCH /api/v1/gameproxy/routes/{route_id}/custom-domain

Show the vanity hostname, or the hosted one, in the public server list.

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

application/json (required)

DELETE /api/v1/gameproxy/routes/{route_id}/custom-domain

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

POST /api/v1/gameproxy/routes/{route_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>.