Mods

Enable or disable a mod

POST
/game-servers/{slice}/mods/toggle

Sets a mod to the state named rather than flipping it, so a retried request cannot undo itself. A disabled mod stays installed and does not load.

Authorization

orgApiKey game-servers.mods.manage
AuthorizationBearer <token>

An 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

slice*string

The server's UUID, as returned by the list endpoint.

Formatuuid

Request 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/toggle" \  -H "Content-Type: application/json" \  -d '{    "id": "string",    "enabled": true  }'
{  "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"}