Start an SSH session
The password is returned exactly once, here. We do not store it, so there is nowhere to look it up afterwards.
Posting again while a session is running returns that session's details,
password included, rather than issuing a new one — which is how a caller
that lost the password recovers without dropping open connections.
created tells the two apart, and the status is 201 only for a genuinely
new session.
ttl_seconds is a request, not a guarantee: the node clamps it to its own
bounds. Read expires_at for what you actually got.
Authorization
orgApiKey game-servers.ssh.manageAn 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
The server's UUID, as returned by the list endpoint.
uuidRequest Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
application/json
application/json
application/json
application/json
application/json
application/json
curl -X POST "https://example.com/game-servers/497f6eca-6276-4993-bfeb-53cbbbba6f08/ssh" \ -H "Content-Type: application/json" \ -d '{}'{ "data": { "host": "string", "port": 0, "username": "string", "password": "string", "expires_at": "2019-08-24T14:15:22Z", "created": true }, "message": "string"}