Settings

Read the scenario rotation

GET
/game-servers/{slice}/scenario-rotation

Arma Reforger only. How the server chooses its scenario.

  • mode: static — one scenario, the SCENARIO_ID startup variable. This is what every server is until a rotation is saved.
  • mode: dynamic — when a match ends, the server restarts on another scenario from scenarios.

current_scenario_id is the scenario the server is on. For a rotation played in order, next_scenario_id is the one a match end moves to; for a random rotation it is null, because the next scenario is drawn when the match ends.

Authorization

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

Path Parameters

slice*string

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

Formatuuid

Response Body

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/scenario-rotation"
{  "data": {    "mode": "static",    "order": "sequential",    "scenarios": [      {        "id": "{ECC61978EDCC2B5A}Missions/23_Campaign.conf",        "name": "Conflict - Everon",        "group": "Base game"      }    ],    "current_scenario_id": "string",    "next_scenario_id": "string",    "last_rotated_at": "2019-08-24T14:15:22Z"  }}