Restore a backup over the server
This is destructive and cannot be undone. With the default
truncate: true the server's data directory is emptied before the archive
is unpacked, so anything written since the backup is gone. false unpacks
over the top, leaving files the archive does not mention.
The server must be stopped; the node refuses otherwise, which arrives
as a 502 because it is the node's answer rather than a problem with the
request.
Only a finished backup can be restored — is_successful must be true.
The response means accepted, not restored. The node reports completion minutes later; watch the server's own status.
Authorization
orgApiKey game-servers.backups.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.backups.manage
Path Parameters
The server's UUID, as returned by the list endpoint.
uuidThe backup'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/backups/497f6eca-6276-4993-bfeb-53cbbbba6f08/restore" \ -H "Content-Type: application/json" \ -d '{}'{ "data": { "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f", "truncate": true }, "message": "string"}