Mods

Search the catalogue

GET
/game-servers/{slice}/mods/search

Searches the game's catalogue. On Minecraft, results are narrowed to the server's loader and Minecraft version, so everything returned would run on it. Each result's id is what install takes.

DayZ search needs the Steam Workshop API, and answers 503 when it is unavailable; installing by a known Workshop id still works.

Authorization

orgApiKey game-servers.mods.read
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.read

Path Parameters

slice*string

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

Formatuuid

Query Parameters

q?string

What to search for. Empty lists the most popular.

Lengthlength <= 255
page?integer
Range1 <= value <= 1000
Default1
per_page?integer
Range1 <= value <= 50
Default20

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/game-servers/497f6eca-6276-4993-bfeb-53cbbbba6f08/mods/search"
{  "data": [    {      "id": "string",      "name": "string",      "summary": "string",      "author": "string",      "latest_version": "string",      "downloads": 0,      "subscribers": 0,      "url": "string",      "thumbnail": "string"    }  ],  "meta": {    "manager": "arma-reforger",    "catalogue": "bohemia-workshop",    "restart_required_to_apply": true,    "total": 0,    "page": 0,    "per_page": 0  }}