List gameservers accessible with the current credential. Prefer list_account_services for cross-product discovery.
- Uprawnienie
gameserver.view- Przyznawane przy łączeniu
- Przeglądaj usługi
Get one gameserver by ID.
- Uprawnienie
gameserver.view- Przyznawane przy łączeniu
- Przeglądaj usługi
Get live query status for a gameserver.
- Uprawnienie
gameserver.view- Przyznawane przy łączeniu
- Przeglądaj usługi
Read editable gameserver configuration fields.
- Uprawnienie
gameserver.config.read- Przyznawane przy łączeniu
- Odczytaj konfigurację
Update editable gameserver configuration fields. Requires confirm=true.
- Uprawnienie
gameserver.config.write- Przyznawane przy łączeniu
- Zmień konfigurację
Parametry
serviceIdstringwymagany
ID of the Gameserver: the "id" field from list_account_services or list_gameservers (e.g. "cmabc123..."). The numericId shown in the panel (e.g. "180") is accepted too. IDs of other service types do not work here.
changesRecord<string, string>wymagany
confirmbooleanopcjonalny
get_gameserver_console_logsTylko odczyt
Read a recent gameserver console log snapshot.
- Uprawnienie
gameserver.console.read- Przyznawane przy łączeniu
- Konsola i logi
Parametry
serviceIdstringwymagany
ID of the Gameserver: the "id" field from list_account_services or list_gameservers (e.g. "cmabc123..."). The numericId shown in the panel (e.g. "180") is accepted too. IDs of other service types do not work here.
linesintegeropcjonalny
Number of recent log lines to return, 1-200 (default 50). Values above 200 are rejected.
> 0 · max 200
Restart a gameserver. Requires confirm=true because this is a power action.
- Uprawnienie
gameserver.restart- Przyznawane przy łączeniu
- Operacje zasilania
Start a gameserver. Requires confirm=true because this is a power action.
- Uprawnienie
gameserver.start- Przyznawane przy łączeniu
- Operacje zasilania
Stop a gameserver. Requires confirm=true because this is a power action.
- Uprawnienie
gameserver.stop- Przyznawane przy łączeniu
- Operacje zasilania
Send one console command to a running gameserver. Requires confirm=true.
- Uprawnienie
gameserver.console.write- Przyznawane przy łączeniu
- Konsola i logi
Read recent gameserver activity logs.
- Uprawnienie
gameserver.activity.read- Przyznawane przy łączeniu
- Przeglądaj usługi
Parametry
serviceIdstringwymagany
ID of the Gameserver: the "id" field from list_account_services or list_gameservers (e.g. "cmabc123..."). The numericId shown in the panel (e.g. "180") is accepted too. IDs of other service types do not work here.
limitintegeropcjonalny
> 0 · max 100
offsetintegeropcjonalny
min 0 · max 9007199254740991
get_gameserver_container_statusTylko odczyt
Get gameserver container and port reachability status.
- Uprawnienie
gameserver.view- Przyznawane przy łączeniu
- Przeglądaj usługi
list_gameserver_schedulesTylko odczyt
List the recurring schedules of a gameserver (restart, start, stop, console command, backup, wipe) with cron, timezone, next and last run. Only schedules whose action the credential may manage are listed.
- Uprawnienie
gameserver.view- Przyznawane przy łączeniu
- Przeglądaj usługi
Create a recurring gameserver schedule. action: restart, start, stop, command (needs `command`, sent to the server console), backup (needs ZapX Pass Pro), wipe (only games with a wipe such as Rust, needs `wipe` options). Five-field cron evaluated in `timezone` (IANA, default UTC), at most every 5 minutes, max 20 schedules per server. To announce a restart, add a second command schedule a few minutes earlier (e.g. cron "55 3 * * *" with command "say Restart in 5 minutes"). Requires confirm=true.
- Uprawnienie
gameserver.backups.managegameserver.restartgameserver.startgameserver.stopgameserver.console.writegameserver.wipe- Przyznawane przy łączeniu
- Operacje zasilania, Konsola i logi, Zmień konfigurację
Parametry
serviceIdstringwymagany
ID of the Gameserver: the "id" field from list_account_services or list_gameservers (e.g. "cmabc123..."). The numericId shown in the panel (e.g. "180") is accepted too. IDs of other service types do not work here.
namestringwymagany
max length 120
action"restart" | "backup" | "start" | "stop" | "command" | "wipe"wymagany
cronstringwymagany
Five-field cron, e.g. "0 4 * * *" = daily 04:00. At most every 5 minutes.
timezonestringopcjonalny
IANA zone the cron is evaluated in, e.g. "Europe/Berlin". Default UTC.
commandstringopcjonalny
Console command, required for action=command.
max length 2000
wipeobjectopcjonalny
Wipe options, required for action=wipe (only games with a wipe, e.g. Rust).
wipe.kind"map" | "blueprints" | "full"opcjonalny
Rust: map, blueprints or full.
wipe.backupFirstbooleanopcjonalny
Back up before wiping (default true).
wipe.seed"keep" | "random"opcjonalny
Map seed: "keep" (default) or "random".
wipe.worldSizeintegeropcjonalny
min 1000 · max 6000
isActivebooleanopcjonalny
confirmbooleanopcjonalny
Update a gameserver schedule (name, action, cron, timezone, command, wipe options, isActive). isActive=false pauses it. The daily auto backup (isSystem) cannot be changed. Requires confirm=true.
- Uprawnienie
gameserver.backups.managegameserver.restartgameserver.startgameserver.stopgameserver.console.writegameserver.wipe- Przyznawane przy łączeniu
- Operacje zasilania, Konsola i logi, Zmień konfigurację
Parametry
serviceIdstringwymagany
ID of the Gameserver: the "id" field from list_account_services or list_gameservers (e.g. "cmabc123..."). The numericId shown in the panel (e.g. "180") is accepted too. IDs of other service types do not work here.
scheduleIdstringwymagany
namestringopcjonalny
max length 120
action"restart" | "backup" | "start" | "stop" | "command" | "wipe"opcjonalny
cronstringopcjonalny
Five-field cron, e.g. "0 4 * * *" = daily 04:00. At most every 5 minutes.
timezonestringopcjonalny
IANA zone the cron is evaluated in, e.g. "Europe/Berlin". Default UTC.
commandstringopcjonalny
Console command, required for action=command.
max length 2000
wipeobjectopcjonalny
Wipe options, required for action=wipe (only games with a wipe, e.g. Rust).
wipe.kind"map" | "blueprints" | "full"opcjonalny
Rust: map, blueprints or full.
wipe.backupFirstbooleanopcjonalny
Back up before wiping (default true).
wipe.seed"keep" | "random"opcjonalny
Map seed: "keep" (default) or "random".
wipe.worldSizeintegeropcjonalny
min 1000 · max 6000
isActivebooleanopcjonalny
confirmbooleanopcjonalny
Delete a gameserver schedule. The daily auto backup (isSystem) cannot be deleted. Requires confirm=true.
- Uprawnienie
gameserver.backups.managegameserver.restartgameserver.startgameserver.stopgameserver.console.writegameserver.wipe- Przyznawane przy łączeniu
- Operacje zasilania, Konsola i logi, Zmień konfigurację
Wipe a gameserver now (games with a wipe such as Rust): kind map, blueprints or full. Backs up first unless backupFirst=false. Irreversible for the wiped data: state the effect and get an explicit yes first. Returns an operation (poll get_operation_status). For a recurring wipe use create_gameserver_schedule with action=wipe. Requires confirm=true.
- Uprawnienie
gameserver.wipe- Przyznawane przy łączeniu
- Pełny dostęp
Parametry
serviceIdstringwymagany
ID of the Gameserver: the "id" field from list_account_services or list_gameservers (e.g. "cmabc123..."). The numericId shown in the panel (e.g. "180") is accepted too. IDs of other service types do not work here.
kind"map" | "blueprints" | "full"wymagany
Rust: map, blueprints or full.
backupFirstbooleanopcjonalny
Back up before wiping (default true).
seed"keep" | "random" | integeropcjonalny
Map seed: "keep" (default), "random" or a fixed number.
worldSizeintegeropcjonalny
min 1000 · max 6000
confirmbooleanopcjonalny
list_gameserver_databasesTylko odczyt
List the managed MySQL/MariaDB databases of a gameserver with host, port, database name, username, status and phpMyAdmin URL. Passwords are never returned: the owner sees them in the dashboard.
- Uprawnienie
gameserver.database.read- Przyznawane przy łączeniu
- Odczytaj konfigurację
Create a managed MySQL/MariaDB database for a gameserver (max 5 per server, free). It is ready when its status turns active (list_gameserver_databases). The password is not returned: the owner reads it in the dashboard. Requires confirm=true.
- Uprawnienie
gameserver.database.write- Przyznawane przy łączeniu
- Zmień konfigurację
Parametry
serviceIdstringwymagany
ID of the Gameserver: the "id" field from list_account_services or list_gameservers (e.g. "cmabc123..."). The numericId shown in the panel (e.g. "180") is accepted too. IDs of other service types do not work here.
namestringopcjonalny
Display label, e.g. "fivem". Optional.
max length 40
confirmbooleanopcjonalny
Permanently delete a gameserver database with all its tables and data (no undo). Get an explicit yes first. confirmationName must be the exact database name (field `database`). Requires confirm=true.
- Uprawnienie
gameserver.database.write- Przyznawane przy łączeniu
- Zmień konfigurację
Parametry
serviceIdstringwymagany
ID of the Gameserver: the "id" field from list_account_services or list_gameservers (e.g. "cmabc123..."). The numericId shown in the panel (e.g. "180") is accepted too. IDs of other service types do not work here.
databaseIdstringwymagany
confirmationNamestringwymagany
The exact database name (field `database` of list_gameserver_databases), as typed in the dashboard.
confirmbooleanopcjonalny
get_gameserver_external_accessTylko odczyt
Read gameserver external access details.
- Uprawnienie
gameserver.external-access.manage- Przyznawane przy łączeniu
- Pełny dostęp
Ensure gameserver external access is provisioned. Requires confirm=true.
- Uprawnienie
gameserver.external-access.manage- Przyznawane przy łączeniu
- Pełny dostęp
Rotate gameserver external access credentials. Requires confirm=true.
- Uprawnienie
gameserver.external-access.manage- Przyznawane przy łączeniu
- Pełny dostęp
Reveal gameserver external access credentials. Requires confirm=true.
- Uprawnienie
gameserver.external-access.manage- Przyznawane przy łączeniu
- Pełny dostęp
Reinstall a gameserver. Requires confirm=true.
- Uprawnienie
gameserver.reinstall- Przyznawane przy łączeniu
- Pełny dostęp
Update gameserver game version. Requires confirm=true.
- Uprawnienie
gameserver.lifecycle.manage- Przyznawane przy łączeniu
- Zmień konfigurację
Parametry
serviceIdstringwymagany
ID of the Gameserver: the "id" field from list_account_services or list_gameservers (e.g. "cmabc123..."). The numericId shown in the panel (e.g. "180") is accepted too. IDs of other service types do not work here.
targetVersionstringopcjonalny
targetModpackVersionstringopcjonalny
confirmbooleanopcjonalny
Change gameserver variant. Requires confirm=true.
- Uprawnienie
gameserver.lifecycle.manage- Przyznawane przy łączeniu
- Zmień konfigurację
list_gameserver_savegamesTylko odczyt
List gameserver savegames.
- Uprawnienie
gameserver.savegames.read- Przyznawane przy łączeniu
- Odczytaj konfigurację
Parametry
serviceIdstringwymagany
ID of the Gameserver: the "id" field from list_account_services or list_gameservers (e.g. "cmabc123..."). The numericId shown in the panel (e.g. "180") is accepted too. IDs of other service types do not work here.
pageintegeropcjonalny
> 0 · max 9007199254740991
limitintegeropcjonalny
> 0 · max 100
Delete a gameserver savegame. Requires confirm=true.
- Uprawnienie
gameserver.savegames.write- Przyznawane przy łączeniu
- Zmień konfigurację
List installed mods (installedOnly=true) or search the gameserver's mod browser (e.g. CurseForge/Modrinth for Minecraft mod loaders, Thunderstore for Valheim, uMod for Rust with Oxide, ficsit for Satisfactory). Results carry provider, projectId and the installation state; install with install_gameserver_mod.
- Uprawnienie
gameserver.view- Przyznawane przy łączeniu
- Przeglądaj usługi
Parametry
serviceIdstringwymagany
ID of the Gameserver: the "id" field from list_account_services or list_gameservers (e.g. "cmabc123..."). The numericId shown in the panel (e.g. "180") is accepted too. IDs of other service types do not work here.
querystringopcjonalny
providerstringopcjonalny
installedOnlybooleanopcjonalny
offsetintegeropcjonalny
min 0 · max 9007199254740991
limitintegeropcjonalny
> 0 · max 48
sort"relevance" | "downloads" | "updated" | "newest"opcjonalny
Install a mod from the gameserver's mod browser (find it with list_gameserver_mods: provider + projectId). Also updates, downgrades or repairs an installed mod: pass the versionId (see check_gameserver_addon_updates). Without versionId the newest compatible version is installed. Rust uMod plugins are mods with provider "umod" (set_gameserver_rust_framework to oxide first). The server must be stopped. Requires confirm=true. Returns an operation (get_operation_status) and the installationId.
- Uprawnienie
gameserver.mods.manage- Przyznawane przy łączeniu
- Zmień konfigurację
Parametry
serviceIdstringwymagany
ID of the Gameserver: the "id" field from list_account_services or list_gameservers (e.g. "cmabc123..."). The numericId shown in the panel (e.g. "180") is accepted too. IDs of other service types do not work here.
provider"modrinth" | "curseforge" | "thunderstore" | "umod" | "beamng" | "ficsit" | "hangar"wymagany
projectIdstringwymagany
max length 200
versionIdstringopcjonalny
max length 200
titlestringopcjonalny
max length 200
resolveDependenciesbooleanopcjonalny
confirmbooleanopcjonalny
Remove an installed mod by its installationId (from list_gameserver_mods with installedOnly=true). Deletes the mod files. The server must be stopped. Requires confirm=true.
- Uprawnienie
gameserver.mods.manage- Przyznawane przy łączeniu
- Zmień konfigurację
Parametry
serviceIdstringwymagany
ID of the Gameserver: the "id" field from list_account_services or list_gameservers (e.g. "cmabc123..."). The numericId shown in the panel (e.g. "180") is accepted too. IDs of other service types do not work here.
installationIdstringwymagany
confirmbooleanopcjonalny
check_gameserver_addon_updatesTylko odczyt
Check the installed mods (kind=mods) or plugins (kind=plugins) of a gameserver for newer versions. Install an update with install_gameserver_mod / install_gameserver_plugin and the reported versionId. refresh=true asks the providers again even for cached answers. Read-only.
- Uprawnienie
gameserver.view- Przyznawane przy łączeniu
- Przeglądaj usługi
Parametry
serviceIdstringwymagany
ID of the Gameserver: the "id" field from list_account_services or list_gameservers (e.g. "cmabc123..."). The numericId shown in the panel (e.g. "180") is accepted too. IDs of other service types do not work here.
kind"mods" | "plugins"wymagany
refreshbooleanopcjonalny
List installed plugins (installedOnly=true) or search the plugin catalog (Modrinth, Hangar) of a Minecraft plugin server (Paper, Spigot, Purpur, Folia, Velocity, Waterfall), e.g. EssentialsX or LuckPerms. Results carry provider, projectId and the installation state. Page with offset/nextOffset.
- Uprawnienie
gameserver.view- Przyznawane przy łączeniu
- Przeglądaj usługi
Parametry
serviceIdstringwymagany
ID of the Gameserver: the "id" field from list_account_services or list_gameservers (e.g. "cmabc123..."). The numericId shown in the panel (e.g. "180") is accepted too. IDs of other service types do not work here.
querystringopcjonalny
max length 200
provider"all" | "modrinth" | "hangar"opcjonalny
installedOnlybooleanopcjonalny
offsetintegeropcjonalny
min 0 · max 9007199254740991
limitintegeropcjonalny
min 1 · max 48
sortstringopcjonalny
max length 40
Install a plugin from list_gameserver_plugins (provider + projectId), with its required dependencies. With the versionId of an installed plugin it updates or downgrades it. The server must be stopped. Requires confirm=true. Returns an operation (get_operation_status) and the installationId.
- Uprawnienie
gameserver.plugins.manage- Przyznawane przy łączeniu
- Zmień konfigurację
Parametry
serviceIdstringwymagany
ID of the Gameserver: the "id" field from list_account_services or list_gameservers (e.g. "cmabc123..."). The numericId shown in the panel (e.g. "180") is accepted too. IDs of other service types do not work here.
provider"modrinth" | "hangar"wymagany
projectIdstringwymagany
max length 200
versionIdstringopcjonalny
max length 200
titlestringopcjonalny
max length 200
resolveDependenciesbooleanopcjonalny
confirmbooleanopcjonalny
Remove an installed plugin by its installationId (from list_gameserver_plugins with installedOnly=true). Deletes the plugin jar; its config folder stays. The server must be stopped. Requires confirm=true.
- Uprawnienie
gameserver.plugins.manage- Przyznawane przy łączeniu
- Zmień konfigurację
Parametry
serviceIdstringwymagany
ID of the Gameserver: the "id" field from list_account_services or list_gameservers (e.g. "cmabc123..."). The numericId shown in the panel (e.g. "180") is accepted too. IDs of other service types do not work here.
installationIdstringwymagany
confirmbooleanopcjonalny
get_gameserver_rust_frameworkTylko odczyt
Rust servers only: the configured plugin framework (vanilla, oxide = uMod, carbon), the one the running server uses and whether a restart is needed to apply it.
- Uprawnienie
gameserver.view- Przyznawane przy łączeniu
- Przeglądaj usługi
Rust servers only: install or switch the plugin framework (oxide = Oxide/uMod, carbon = Carbon, vanilla = none). Applied on the next start/restart (restart_gameserver); world, cfg and plugin folders are kept. Then install uMod plugins with install_gameserver_mod (provider umod). Requires confirm=true.
- Uprawnienie
gameserver.plugins.manage- Przyznawane przy łączeniu
- Zmień konfigurację
Parametry
serviceIdstringwymagany
ID of the Gameserver: the "id" field from list_account_services or list_gameservers (e.g. "cmabc123..."). The numericId shown in the panel (e.g. "180") is accepted too. IDs of other service types do not work here.
framework"vanilla" | "oxide" | "carbon"wymagany
confirmbooleanopcjonalny
Minecraft servers only: search the modpack catalog (CurseForge, Modrinth, FTB, Technic) with search/provider/offset/limit. Pass modpackId to get that modpack's versions (versionId for install_gameserver_modpack) and a RAM hint.
- Uprawnienie
gameserver.view- Przyznawane przy łączeniu
- Przeglądaj usługi
Parametry
serviceIdstringwymagany
ID of the Gameserver: the "id" field from list_account_services or list_gameservers (e.g. "cmabc123..."). The numericId shown in the panel (e.g. "180") is accepted too. IDs of other service types do not work here.
searchstringopcjonalny
max length 200
provider"all" | "modrinth" | "curseforge" | "ftb" | "technic"opcjonalny
offsetintegeropcjonalny
min 0 · max 100000
limitintegeropcjonalny
min 1 · max 100
modpackIdstringopcjonalny
Minecraft servers only: install a modpack (modpackId + versionId from list_gameserver_modpacks) like the panel library. The server type and Minecraft version follow the modpack and the server is reinstalled with it; other installed variants keep their data. To update the active modpack use update_gameserver_version with targetModpackVersion. Requires confirm=true.
- Uprawnienie
gameserver.lifecycle.manage- Przyznawane przy łączeniu
- Zmień konfigurację
Steam workshop configuration of a gameserver whose game supports it (e.g. Garry's Mod, ARK, DayZ, Project Zomboid): item ids with titles and validation, the collection id, disabled items and whether changes wait for the next start.
- Uprawnienie
gameserver.view- Przyznawane przy łączeniu
- Przeglądaj usługi
Change the Steam workshop items of a gameserver: addItemIds / removeItemIds edit the current list, itemIds replaces it, collectionId sets or (null) removes the collection, disabledItemIds keeps items listed but inactive. Omitted fields stay as they are. Applied on the next start/restart. Requires confirm=true.
- Uprawnienie
gameserver.mods.manage- Przyznawane przy łączeniu
- Zmień konfigurację
Parametry
serviceIdstringwymagany
ID of the Gameserver: the "id" field from list_account_services or list_gameservers (e.g. "cmabc123..."). The numericId shown in the panel (e.g. "180") is accepted too. IDs of other service types do not work here.
itemIdsstring[]opcjonalny
max items 500
addItemIdsstring[]opcjonalny
max items 200
removeItemIdsstring[]opcjonalny
max items 500
collectionIdstringopcjonalny
pattern ^\d{1,20}$
disabledItemIdsstring[]opcjonalny
max items 500
confirmbooleanopcjonalny