Start a backup
Returns 201 with a record whose is_successful is false: the archive
does not exist yet. The node builds it in the background and reports
completion, so poll the backup until that flag flips.
Refused with 422 when every slot already holds a backup
(reason: limit_reached) or the server has no slots (reason: no_slots),
and with 409 while another backup of the server is still being taken
(reason: in_progress). Free a slot by deleting a backup in the portal;
this API cannot delete one, and a backup created here never rotates an
old one out. Only the portal's own automatic backups, and a customer
confirming it in the portal, replace the oldest backup.
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.
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
application/json
curl -X POST "https://example.com/game-servers/497f6eca-6276-4993-bfeb-53cbbbba6f08/backups" \ -H "Content-Type: application/json" \ -d '{}'{ "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"}