Compress entries into an archive
Creates one archive in root holding every named entry.
The node names the archive after the moment it was made, so the created entry is returned alongside the acknowledgement — it is the only way to learn that name.
Archiving a large directory takes minutes and holds the request open for the duration.
Authorization
orgApiKey game-servers.files.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.files.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
curl -X POST "https://example.com/game-servers/497f6eca-6276-4993-bfeb-53cbbbba6f08/files/compress" \ -H "Content-Type: application/json" \ -d '{ "files": [ "string" ] }'{ "ok": true, "message": "string", "archive": { "name": "server.properties", "path": "/plugins/server.properties", "is_file": true, "is_symlink": true, "size": 0, "mode": "-rw-r--r--", "mode_bits": "0644", "mimetype": "string", "modified_at": "2019-08-24T14:15:22Z" }}