Overview

Each page carries the full request and response schema and a Try it panel that sends a real request to the live API with whatever key you paste in.

Servers

Requires game-servers.read, or game-servers.manage to act.

• GET /game-servers — list your game servers
• GET /game-servers/{id} — read one server with live state
• POST /game-servers/{id}/power — start, stop, restart or kill
• POST /game-servers/{id}/command — send a console command
• GET /game-servers/{id}/logs — read recent console output
• POST /game-servers/{id}/socket — websocket credentials for the console and file tail

Files

Requires game-servers.files.read, or game-servers.files.manage to write — see Files for how paths, large transfers and remote downloads work.

• GET …/files — list a directory
• GET …/files/stat — read one entry's metadata
• GET …/files/contents — read a file
• PUT …/files/contents — write a file
• PUT …/files/rename — rename or move entries
• POST …/files/copy — copy an entry beside itself
• POST …/files/delete — delete entries
• POST …/files/compress — compress into an archive
• POST …/files/decompress — extract an archive
• POST …/files/create-folder — create a directory
• POST …/files/chmod — change permissions

Transfers and remote downloads

• GET …/files/download — get a direct download URL
• GET …/files/upload — get a direct upload URL
• POST …/files/pull — download a URL onto the server
• GET …/files/pull — list downloads in flight
• DELETE …/files/pull/{identifier} — cancel a download

Backups

Requires game-servers.backups.read, or game-servers.backups.manage to write. Everything here finishes on the node after the response — see the notes on each page. There is no delete: backups are removed in the portal only, so a leaked key always leaves a server's restore points behind.

• GET …/backups — list backups
• GET …/backups/{backup} — poll one backup
• POST …/backups — start a backup
• POST …/backups/{backup}/restore — restore over the server
• POST …/backups/{backup}/lock — toggle the lock
• GET …/backups/{backup}/download — get a direct download URL

SSH

Requires game-servers.ssh.manage. Grants a shell on a container mounting the server's data directory — see WebSockets for the lighter-weight ways to watch a server.

• GET …/ssh — read the current session
• POST …/ssh — start a session
• DELETE …/ssh — stop the session

Mods

Requires game-servers.mods.read, or game-servers.mods.manage to change what loads. One contract across every game with a mod manager — Arma Reforger, DayZ, Minecraft and Rust — with meta.manager on each response naming the one that answered, and so what an id looks like.

Except on Rust, where Oxide hot-loads, a change only takes effect on the next start: each one reports restart_required, and restarting is POST …/power.

• GET …/mods — list what is installed
• GET …/mods/search — search the game's catalogue
• POST …/mods/install — install a mod and its required dependencies
• POST …/mods/toggle — enable or disable one, keeping it installed
• POST …/mods/uninstall — remove one

Settings

Requires game-servers.settings.read, or game-servers.settings.manage to write. Two kinds, one ability pair: the egg's startup variables (player cap, server name, the switches the panel exposes) and the game's own settings files through the schema-driven editor.

Both write all-or-nothing, and both refuse a value by name rather than dropping it: a variable that is unknown or not editable, a setting the game locks, a port the server does not own. Passwords read back empty — they can be set, not read — and a save can carry the hashes from the read to be refused if someone changed a file in between.

• GET …/startup — read the startup command and every variable, with its rules
• PUT …/startup — change variables
• GET …/settings — read the settings schema with current values
• PUT …/settings — change settings
• GET …/scenarios — Arma Reforger: the scenarios the server can run
• GET …/scenario-rotation — Arma Reforger: read the scenario rotation
• PUT …/scenario-rotation — Arma Reforger: set the rotation; see Scenario rotation