Stop the SSH session

Tears the sidecar down and drops any open connections. Idempotent — safe to call whether or not a session is running, so a cleanup path need not check first.

A DELETE rather than a flag on the POST deliberately: the daemon reads a POST body that omits enabled as disable, so keeping the two on separate verbs means no request can tear a session down by accident.

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`

curl -X DELETE "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"  },  "message": "string"}

Authorization

Path Parameters

Response Body

200application/json

401application/json

403application/json

404application/json

429application/json

502application/json

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`