Set the scenario rotation
Arma Reforger only. Replaces the rotation: the list you send is the list that is kept, in that order.
A scenario can be given by id alone. Its name and group are then
filled in from the server's scenario list; an id that list does not
know keeps the id as its name.
What happens to the server:
- Nothing restarts. The rotation takes effect when the current match ends; each move after that is a server restart, so players are disconnected while it comes back.
- If the scenario the server is on is in the list, it carries on from
there. If it is not,
SCENARIO_IDis set to the first entry, which the server loads on its next start. mode: statickeeps the list for later and leaves the server on its current scenario.- A game mode with no end, such as Game Master, never finishes a match and so never moves on.
order: random never plays the same scenario twice in a row, unless
the list has only one.
Authorization
orgApiKey game-servers.settings.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.settings.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 PUT "https://example.com/game-servers/497f6eca-6276-4993-bfeb-53cbbbba6f08/scenario-rotation" \ -H "Content-Type: application/json" \ -d '{ "mode": "dynamic", "order": "sequential", "scenarios": [ { "id": "{ECC61978EDCC2B5A}Missions/23_Campaign.conf" }, { "id": "{C41618FD18E9D714}Missions/23_Campaign_Arland.conf" }, { "id": "{DAA03C6E6099D50F}Missions/24_CombatOps.conf" } ] }'{ "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" }, "message": "string"}