Toggle a backup's lock
Toggles — it does not set. Read is_locked on the response to know
where you landed.
A locked completed backup cannot be deleted in the portal until it is unlocked. (This API cannot delete backups at all.)
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.
uuidResponse Body
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/lock"{ "data": { "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f", "name": "string", "source": "manual", "is_successful": true, "is_locked": true, "bytes": 0, "checksum": "string", "ignored_files": "string", "created_at": "2019-08-24T14:15:22Z", "completed_at": "2019-08-24T14:15:22Z" }, "message": "string"}Restore a backup over the server POST
This is destructive and cannot be undone. With the default truncate: true the server's data directory is emptied…
Get a direct download URL for the archive GET
The URL points at the node and carries a short-lived token of its own, so the transfer never passes through this API…