List a server's backups
Newest first. meta.limit is the server's backup slots — 0 means
the server has no backups at all — and is published so a caller can
tell before it is refused rather than after. meta.used is how many
slots are held: stored backups, plus one still being taken. A failed
backup stays listed for a while but holds no slot, so meta.count can
be larger than meta.used.
The portal backs every server that holds a slot up automatically, on
meta.frequency, and replaces the oldest unlocked backup once the
slots are full. Lock a backup to keep it out of that rotation.
Backups cannot be deleted through this API. Removing one is done in the portal, so a leaked key can never destroy a server's restore points.
Authorization
orgApiKey game-servers.backups.readAn 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.read
Path Parameters
The server's UUID, as returned by the list endpoint.
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/backups"{ "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" } ], "meta": { "count": 0, "limit": 0, "used": 0, "frequency": "six_hours", "next_backup_at": "2019-08-24T14:15:22Z" }}