Files

Get a direct download URL

GET
/game-servers/{slice}/files/download

Mints a short-lived URL pointing at the server's node, which you then GET yourself. Nothing is proxied through the API.

That is the point of it: a multi-gigabyte world archive streamed through here would hold a request worker open for the whole transfer, while the node can already serve it directly. Use this for anything the inline read refuses.

The URL carries its own credential and needs no Authorization header. Treat it as a secret for its lifetime — anyone holding it can fetch that file.

Authorization

orgApiKey game-servers.files.read
AuthorizationBearer <token>

An organisation API key, prefixed tbk_. Create one under Organisation to API keys; the plaintext is shown once.

The scopes listed on each operation are the abilities the key must carry. They are not OAuth scopes and are not negotiated per request.

In: header

Scope: game-servers.files.read

Path Parameters

slice*string

The server's UUID, as returned by the list endpoint.

Formatuuid

Query Parameters

file*string

Absolute path from the server root. A .. segment is refused rather than resolved — whether /a/link/../b means /b depends on whether link is a symlink, which only the node knows.

Lengthlength <= 1024

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/game-servers/497f6eca-6276-4993-bfeb-53cbbbba6f08/files/download?file=%2Fserver.properties"
{  "data": {    "url": "http://example.com",    "expires_at": "2019-08-24T14:15:22Z"  }}