SSH

Read the current SSH session

GET
/game-servers/{slice}/ssh

Never returns a password — that is shown once, when the session is created. Read state to know what is going on:

stateMeaning
idleNo session. Start one.
activeA session is running; port and expires_at are set.
unsupportedThis node cannot do SSH — not running Meteorite, or SSH disabled in its config. Retrying will not help.
unprovisionedThe server is not built yet.
unknownThe node did not answer.

Authorization

orgApiKey game-servers.ssh.manage
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.ssh.manage

Path Parameters

slice*string

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

Formatuuid

Response Body

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/game-servers/497f6eca-6276-4993-bfeb-53cbbbba6f08/ssh"
{  "data": {    "state": "idle",    "host": "string",    "port": 0,    "username": "string",    "expires_at": "2019-08-24T14:15:22Z"  }}