Install a mod
Installs a mod by its catalogue id and, unless with_dependencies is
false, every required dependency the server does not already have. Each
dependency is listed in the response with whether it was added.
- Reforger: refused when the mod or one of its dependencies would put
two addons with the same package name on the server — the engine then
loads no mods at all.
versionpins a published version. - DayZ: refused when the item is not a DayZ Workshop item. Dependencies go ahead of the mod in load order. No version pinning; the server always downloads the latest on boot.
- Minecraft: the newest release compatible with the server's loader
and version, or the Modrinth version id given as
version. Installing another version of an installed project replaces it. - Rust: always the latest release, loaded live. Installing an installed plugin updates it.
Refused with 409 on Reforger and DayZ when the mod is already installed.
Authorization
orgApiKey game-servers.mods.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.mods.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/mods/install" \ -H "Content-Type: application/json" \ -d '{ "id": "string" }'{ "data": { "mod": { "id": "string", "catalogue_id": "string", "name": "string", "version": "string", "enabled": true, "managed": true, "url": "string" }, "dependencies": [ { "id": "string", "name": "string", "added": true } ], "restart_required": true, "warnings": [ "string" ] }, "meta": { "manager": "arma-reforger", "catalogue": "bohemia-workshop", "restart_required_to_apply": true }, "message": "string"}