SSH
Read the current SSH session
Never returns a password — that is shown once, when the session is
created. Read state to know what is going on:
state | Meaning |
|---|---|
idle | No session. Start one. |
active | A session is running; port and expires_at are set. |
unsupported | This node cannot do SSH — not running Meteorite, or SSH disabled in its config. Retrying will not help. |
unprovisioned | The server is not built yet. |
unknown | The node did not answer. |
Authorization
orgApiKey game-servers.ssh.manageAuthorizationBearer <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.
Format
uuidResponse 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" }}