MCP
Every tool your AI client can call through the ZapX MCP server, with parameters, required permission and behaviour. The list is generated straight from the server, so it is always up to date.
224 tools in 13 groups ยท included in every ZapX Pass
224 of 224 tools
All services with id and type, outages and maintenance, and the status of running operations.
list_account_servicesList all accessible services (gameservers, VPS, dedicated servers, TeamSpeak servers, Discord bots, and domains) in one normalized response. Prefer this for discovery. Pass a service's "id" to the tools of its type (gameserver ids to gameserver tools, VPS ids to vserver tools, ...).
No parameters
list_incidentsList open, planned and recently resolved outages and maintenance that affect services accessible with the current credential. Each incident names the affected services (type, id, name; same ids as list_account_services); affectsAllServices marks platform-wide incidents. resolvedHours (0-168, default 24) controls how far back resolved incidents are included. Read-only.
resolvedHoursintegeroptionalmin 0 ยท max 168
get_operation_statusPoll the status of an async public API operation.
operationIdstringrequiredStatus, console, start and stop, settings, game version and variant, mods, savegames, SFTP access and reinstall.
list_gameserversList gameservers accessible with the current credential. Prefer list_account_services for cross-product discovery.
gameserver.viewNo parameters
get_gameserverGet one gameserver by ID.
gameserver.viewserviceIdstringrequiredID 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.
get_gameserver_live_statusGet live query status for a gameserver.
gameserver.viewserviceIdstringrequiredID 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.
get_gameserver_configRead editable gameserver configuration fields.
gameserver.config.readserviceIdstringrequiredID 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.
update_gameserver_configUpdate editable gameserver configuration fields. Requires confirm=true.
gameserver.config.writeserviceIdstringrequiredID 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>requiredconfirmbooleanoptionalget_gameserver_console_logsRead a recent gameserver console log snapshot.
gameserver.console.readserviceIdstringrequiredID 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.
linesintegeroptionalNumber of recent log lines to return, 1-200 (default 50). Values above 200 are rejected.
> 0 ยท max 200
restart_gameserverRestart a gameserver. Requires confirm=true because this is a power action.
gameserver.restartserviceIdstringrequiredID 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.
confirmbooleanoptionalstart_gameserverStart a gameserver. Requires confirm=true because this is a power action.
gameserver.startserviceIdstringrequiredID 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.
confirmbooleanoptionalstop_gameserverStop a gameserver. Requires confirm=true because this is a power action.
gameserver.stopserviceIdstringrequiredID 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.
confirmbooleanoptionalsend_gameserver_console_commandSend one console command to a running gameserver. Requires confirm=true.
gameserver.console.writeserviceIdstringrequiredID 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.
commandstringrequiredmax length 500
confirmbooleanoptionalget_gameserver_activityRead recent gameserver activity logs.
gameserver.activity.readserviceIdstringrequiredID 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.
limitintegeroptional> 0 ยท max 100
offsetintegeroptionalmin 0 ยท max 9007199254740991
get_gameserver_container_statusGet gameserver container and port reachability status.
gameserver.viewserviceIdstringrequiredID 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.
list_gameserver_schedulesList 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.
gameserver.viewserviceIdstringrequiredID 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.
create_gameserver_scheduleCreate 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.
gameserver.backups.managegameserver.restartgameserver.startgameserver.stopgameserver.console.writegameserver.wipeserviceIdstringrequiredID 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.
namestringrequiredmax length 120
action"restart" | "backup" | "start" | "stop" | "command" | "wipe"requiredcronstringrequiredFive-field cron, e.g. "0 4 * * *" = daily 04:00. At most every 5 minutes.
timezonestringoptionalIANA zone the cron is evaluated in, e.g. "Europe/Berlin". Default UTC.
commandstringoptionalConsole command, required for action=command.
max length 2000
wipeobjectoptionalWipe options, required for action=wipe (only games with a wipe, e.g. Rust).
wipe.kind"map" | "blueprints" | "full"optionalRust: map, blueprints or full.
wipe.backupFirstbooleanoptionalBack up before wiping (default true).
wipe.seed"keep" | "random"optionalMap seed: "keep" (default) or "random".
wipe.worldSizeintegeroptionalmin 1000 ยท max 6000
isActivebooleanoptionalconfirmbooleanoptionalupdate_gameserver_scheduleUpdate 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.
gameserver.backups.managegameserver.restartgameserver.startgameserver.stopgameserver.console.writegameserver.wipeserviceIdstringrequiredID 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.
scheduleIdstringrequirednamestringoptionalmax length 120
action"restart" | "backup" | "start" | "stop" | "command" | "wipe"optionalcronstringoptionalFive-field cron, e.g. "0 4 * * *" = daily 04:00. At most every 5 minutes.
timezonestringoptionalIANA zone the cron is evaluated in, e.g. "Europe/Berlin". Default UTC.
commandstringoptionalConsole command, required for action=command.
max length 2000
wipeobjectoptionalWipe options, required for action=wipe (only games with a wipe, e.g. Rust).
wipe.kind"map" | "blueprints" | "full"optionalRust: map, blueprints or full.
wipe.backupFirstbooleanoptionalBack up before wiping (default true).
wipe.seed"keep" | "random"optionalMap seed: "keep" (default) or "random".
wipe.worldSizeintegeroptionalmin 1000 ยท max 6000
isActivebooleanoptionalconfirmbooleanoptionaldelete_gameserver_scheduleDelete a gameserver schedule. The daily auto backup (isSystem) cannot be deleted. Requires confirm=true.
gameserver.backups.managegameserver.restartgameserver.startgameserver.stopgameserver.console.writegameserver.wipeserviceIdstringrequiredID 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.
scheduleIdstringrequiredconfirmbooleanoptionalwipe_gameserverWipe 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.
gameserver.wipeserviceIdstringrequiredID 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"requiredRust: map, blueprints or full.
backupFirstbooleanoptionalBack up before wiping (default true).
seed"keep" | "random" | integeroptionalMap seed: "keep" (default), "random" or a fixed number.
worldSizeintegeroptionalmin 1000 ยท max 6000
confirmbooleanoptionallist_gameserver_databasesList 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.
gameserver.database.readserviceIdstringrequiredID 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.
create_gameserver_databaseCreate 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.
gameserver.database.writeserviceIdstringrequiredID 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.
namestringoptionalDisplay label, e.g. "fivem". Optional.
max length 40
confirmbooleanoptionaldelete_gameserver_databasePermanently 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.
gameserver.database.writeserviceIdstringrequiredID 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.
databaseIdstringrequiredconfirmationNamestringrequiredThe exact database name (field `database` of list_gameserver_databases), as typed in the dashboard.
confirmbooleanoptionalget_gameserver_external_accessRead gameserver external access details.
gameserver.external-access.manageserviceIdstringrequiredID 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.
ensure_gameserver_external_accessEnsure gameserver external access is provisioned. Requires confirm=true.
gameserver.external-access.manageserviceIdstringrequiredID 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.
confirmbooleanoptionalrotate_gameserver_external_accessRotate gameserver external access credentials. Requires confirm=true.
gameserver.external-access.manageserviceIdstringrequiredID 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.
confirmbooleanoptionalreveal_gameserver_external_accessReveal gameserver external access credentials. Requires confirm=true.
gameserver.external-access.manageserviceIdstringrequiredID 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.
confirmbooleanoptionalreinstall_gameserverReinstall a gameserver. Requires confirm=true.
gameserver.reinstallserviceIdstringrequiredID 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.
confirmbooleanoptionalupdate_gameserver_versionUpdate gameserver game version. Requires confirm=true.
gameserver.lifecycle.manageserviceIdstringrequiredID 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.
targetVersionstringoptionaltargetModpackVersionstringoptionalconfirmbooleanoptionalupdate_gameserver_variantChange gameserver variant. Requires confirm=true.
gameserver.lifecycle.manageserviceIdstringrequiredID 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.
variantIdstringrequiredconfirmbooleanoptionallist_gameserver_savegamesList gameserver savegames.
gameserver.savegames.readserviceIdstringrequiredID 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.
pageintegeroptional> 0 ยท max 9007199254740991
limitintegeroptional> 0 ยท max 100
delete_gameserver_savegameDelete a gameserver savegame. Requires confirm=true.
gameserver.savegames.writeserviceIdstringrequiredID 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.
pathstringrequiredconfirmbooleanoptionallist_gameserver_modsList 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.
gameserver.viewserviceIdstringrequiredID 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.
querystringoptionalproviderstringoptionalinstalledOnlybooleanoptionaloffsetintegeroptionalmin 0 ยท max 9007199254740991
limitintegeroptional> 0 ยท max 48
sort"relevance" | "downloads" | "updated" | "newest"optionalinstall_gameserver_modInstall 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.
gameserver.mods.manageserviceIdstringrequiredID 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"requiredprojectIdstringrequiredmax length 200
versionIdstringoptionalmax length 200
titlestringoptionalmax length 200
resolveDependenciesbooleanoptionalconfirmbooleanoptionaluninstall_gameserver_modRemove 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.
gameserver.mods.manageserviceIdstringrequiredID 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.
installationIdstringrequiredconfirmbooleanoptionalcheck_gameserver_addon_updatesCheck 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.
gameserver.viewserviceIdstringrequiredID 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"requiredrefreshbooleanoptionallist_gameserver_pluginsList 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.
gameserver.viewserviceIdstringrequiredID 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.
querystringoptionalmax length 200
provider"all" | "modrinth" | "hangar"optionalinstalledOnlybooleanoptionaloffsetintegeroptionalmin 0 ยท max 9007199254740991
limitintegeroptionalmin 1 ยท max 48
sortstringoptionalmax length 40
install_gameserver_pluginInstall 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.
gameserver.plugins.manageserviceIdstringrequiredID 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"requiredprojectIdstringrequiredmax length 200
versionIdstringoptionalmax length 200
titlestringoptionalmax length 200
resolveDependenciesbooleanoptionalconfirmbooleanoptionaluninstall_gameserver_pluginRemove 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.
gameserver.plugins.manageserviceIdstringrequiredID 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.
installationIdstringrequiredconfirmbooleanoptionalget_gameserver_rust_frameworkRust 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.
gameserver.viewserviceIdstringrequiredID 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.
set_gameserver_rust_frameworkRust 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.
gameserver.plugins.manageserviceIdstringrequiredID 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"requiredconfirmbooleanoptionallist_gameserver_modpacksMinecraft 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.
gameserver.viewserviceIdstringrequiredID 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.
searchstringoptionalmax length 200
provider"all" | "modrinth" | "curseforge" | "ftb" | "technic"optionaloffsetintegeroptionalmin 0 ยท max 100000
limitintegeroptionalmin 1 ยท max 100
modpackIdstringoptionalinstall_gameserver_modpackMinecraft 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.
gameserver.lifecycle.manageserviceIdstringrequiredID 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.
modpackIdstringrequiredversionIdstringrequiredconfirmbooleanoptionalget_gameserver_workshopSteam 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.
gameserver.viewserviceIdstringrequiredID 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.
update_gameserver_workshopChange 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.
gameserver.mods.manageserviceIdstringrequiredID 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[]optionalmax items 500
addItemIdsstring[]optionalmax items 200
removeItemIdsstring[]optionalmax items 500
collectionIdstringoptionalpattern ^\d{1,20}$
disabledItemIdsstring[]optionalmax items 500
confirmbooleanoptionalStart and stop, configuration, metrics, traffic, DNS, firewall, SSH keys, DDoS protection, schedules, rescue mode and reinstall.
list_vserversList VPS accessible with the current credential. Prefer list_account_services for cross-product discovery.
vserver.viewNo parameters
get_vserverGet one VPS by ID.
vserver.viewserviceIdstringrequiredID of the VPS: the "id" field from list_account_services or list_vservers (e.g. "cmabc123..."). The numericId shown in the panel (e.g. "180") is accepted too. IDs of other service types do not work here.
get_vserver_configRead VPS configuration.
vserver.config.readserviceIdstringrequiredID of the VPS: the "id" field from list_account_services or list_vservers (e.g. "cmabc123..."). The numericId shown in the panel (e.g. "180") is accepted too. IDs of other service types do not work here.
patch_vserver_configUpdate VPS hostname, DNS, ballooning, or SSH password settings. Requires confirm=true.
vserver.config.writevserver.access.manageserviceIdstringrequiredID of the VPS: the "id" field from list_account_services or list_vservers (e.g. "cmabc123..."). The numericId shown in the panel (e.g. "180") is accepted too. IDs of other service types do not work here.
hostnamestringoptionaldnsServerstringoptionalballooningDisabledbooleanoptionalsshPasswordEnabledbooleanoptionalconfirmbooleanoptionalget_vserver_activityRead paginated VPS activity log entries.
vserver.activity.readserviceIdstringrequiredID of the VPS: the "id" field from list_account_services or list_vservers (e.g. "cmabc123..."). The numericId shown in the panel (e.g. "180") is accepted too. IDs of other service types do not work here.
limitintegeroptionalmin 1 ยท max 100
offsetintegeroptionalmin 0 ยท max 9007199254740991
get_vserver_trafficRead paginated VPS network traffic history.
vserver.traffic.readserviceIdstringrequiredID of the VPS: the "id" field from list_account_services or list_vservers (e.g. "cmabc123..."). The numericId shown in the panel (e.g. "180") is accepted too. IDs of other service types do not work here.
limitintegeroptionalmin 1 ยท max 100
offsetintegeroptionalmin 0 ยท max 9007199254740991
get_vserver_ddos_statusGet DDoS protection status of a VPS (read-only). Optional ipAddress selects an assigned address. Not every location has DDoS protection: there the answer is ddosProtectionAvailable=false, and the other vserver DDoS tools have no data either, so check this first.
vserver.ddos.readserviceIdstringrequiredID of the VPS: the "id" field from list_account_services or list_vservers (e.g. "cmabc123..."). The numericId shown in the panel (e.g. "180") is accepted too. IDs of other service types do not work here.
ipAddressstringoptionallist_vserver_ddos_rulesList the DDoS filter rules learned for a VPS IP.
vserver.ddos.readserviceIdstringrequiredID of the VPS: the "id" field from list_account_services or list_vservers (e.g. "cmabc123..."). The numericId shown in the panel (e.g. "180") is accepted too. IDs of other service types do not work here.
ipAddressstringoptionallist_vserver_ddos_incidentsList inbound DDoS incidents against a VPS IP (paginated).
vserver.ddos.readserviceIdstringrequiredID of the VPS: the "id" field from list_account_services or list_vservers (e.g. "cmabc123..."). The numericId shown in the panel (e.g. "180") is accepted too. IDs of other service types do not work here.
ipAddressstringoptionalpageintegeroptional> 0 ยท max 9007199254740991
pageSizeintegeroptional> 0 ยท max 100
get_vserver_ddos_bandwidthGet DDoS pass/drop bandwidth statistics of a VPS IP. range: 10m, 1h (default), 1d or 1w.
vserver.ddos.readserviceIdstringrequiredID of the VPS: the "id" field from list_account_services or list_vservers (e.g. "cmabc123..."). The numericId shown in the panel (e.g. "180") is accepted too. IDs of other service types do not work here.
range"10m" | "1h" | "1d" | "1w"optionalipAddressstringoptionallist_vserver_outgoing_ddosList outgoing DDoS attacks detected from a VPS and whether it is flagged for reinstall.
vserver.ddos.readserviceIdstringrequiredID of the VPS: the "id" field from list_account_services or list_vservers (e.g. "cmabc123..."). The numericId shown in the panel (e.g. "180") is accepted too. IDs of other service types do not work here.
toggle_vserver_ddos_protectionSwitch DDoS protection of a VPS IP on or off (service owner only). Switching it off leaves the IP unfiltered. Requires confirm=true.
vserver.ddos.manageserviceIdstringrequiredID of the VPS: the "id" field from list_account_services or list_vservers (e.g. "cmabc123..."). The numericId shown in the panel (e.g. "180") is accepted too. IDs of other service types do not work here.
ipAddressstringoptionalenabledbooleanoptionalTarget state (true = protected). Without it the current state is flipped.
confirmbooleanoptionalget_vserver_dnsRead VPS DNS domains, subdomains, and favorite subdomain.
vserver.config.readserviceIdstringrequiredID of the VPS: the "id" field from list_account_services or list_vservers (e.g. "cmabc123..."). The numericId shown in the panel (e.g. "180") is accepted too. IDs of other service types do not work here.
list_vserver_account_ssh_keysList SSH keys stored on the authenticated account.
vserver.config.readNo parameters
create_vserver_subdomainCreate a subdomain that points at the VPS (free ZAP domain or one of the customer's domains). Requires confirm=true.
vserver.config.writeserviceIdstringrequiredID of the VPS: the "id" field from list_account_services or list_vservers (e.g. "cmabc123..."). The numericId shown in the panel (e.g. "180") is accepted too. IDs of other service types do not work here.
labelstringrequiredSubdomain label, e.g. `myserver` for myserver.<domain>.
domainIdstringoptionalDomain from get_vserver_dns `domains[].id`; default `platform` (the free ZAP domain).
confirmbooleanoptionaldelete_vserver_subdomainDelete a subdomain of the VPS. Requires confirm=true.
vserver.config.writeserviceIdstringrequiredID of the VPS: the "id" field from list_account_services or list_vservers (e.g. "cmabc123..."). The numericId shown in the panel (e.g. "180") is accepted too. IDs of other service types do not work here.
subdomainIdstringrequiredSubdomain id from get_vserver_dns.
confirmbooleanoptionalset_vserver_favorite_subdomainSet or clear the favorite subdomain shown as the VPS address. Requires confirm=true.
vserver.config.writeserviceIdstringrequiredID of the VPS: the "id" field from list_account_services or list_vservers (e.g. "cmabc123..."). The numericId shown in the panel (e.g. "180") is accepted too. IDs of other service types do not work here.
subdomainIdstringoptionalSubdomain id from get_vserver_dns; null or omitted clears the favorite.
confirmbooleanoptionalget_vserver_reverse_dnsRead the reverse DNS (PTR) entries of the VPS IPv4 addresses and IPv6 prefixes.
vserver.config.readserviceIdstringrequiredID of the VPS: the "id" field from list_account_services or list_vservers (e.g. "cmabc123..."). The numericId shown in the panel (e.g. "180") is accepted too. IDs of other service types do not work here.
update_vserver_reverse_dnsSet or reset the reverse DNS (PTR) hostname of one VPS IP. The hostname must resolve to that IP. Requires confirm=true.
vserver.config.writeserviceIdstringrequiredID of the VPS: the "id" field from list_account_services or list_vservers (e.g. "cmabc123..."). The numericId shown in the panel (e.g. "180") is accepted too. IDs of other service types do not work here.
ipAddressIdstringoptionalIPv4 entry from get_vserver_reverse_dns (`ipAddressId`). Pass this or ipv6PrefixAllocationId.
ipv6PrefixAllocationIdstringoptionalIPv6 entry from get_vserver_reverse_dns (`ipv6PrefixAllocationId`).
hostnamestringoptionalNew PTR hostname (must resolve to the IP); empty or null resets it to the default.
confirmbooleanoptionalupdate_vserver_firewall_optionsTurn the VPS firewall on or off and set the default in/out policies. A DROP policy without allow rules locks out SSH. Requires confirm=true.
vserver.firewall.writeserviceIdstringrequiredID of the VPS: the "id" field from list_account_services or list_vservers (e.g. "cmabc123..."). The numericId shown in the panel (e.g. "180") is accepted too. IDs of other service types do not work here.
enablebooleanrequiredFirewall on (true) or off (false).
policyIn"ACCEPT" | "DROP" | "REJECT"requiredDefault policy for incoming traffic no rule matches.
policyOut"ACCEPT" | "DROP" | "REJECT"requiredDefault policy for outgoing traffic no rule matches.
confirmbooleanoptionalmutate_vserver_firewall_ruleAdd, update, delete or move a VPS firewall rule (positions from get_vserver_firewall). add/update need type and ruleAction. Requires confirm=true.
vserver.firewall.writeserviceIdstringrequiredID of the VPS: the "id" field from list_account_services or list_vservers (e.g. "cmabc123..."). The numericId shown in the panel (e.g. "180") is accepted too. IDs of other service types do not work here.
action"add" | "update" | "delete" | "move"requiredposintegeroptionalupdate/delete/move: `pos` of the rule as returned by get_vserver_firewall.
min 0 ยท max 9007199254740991
newPosintegeroptionalmove: target position. add: optional insert position; default is after the existing customer rules (lowest priority, first match wins), so pass newPos to place a rule above an earlier ACCEPT.
min 0 ยท max 9007199254740991
type"in" | "out"optionaladd/update: traffic direction.
ruleAction"ACCEPT" | "DROP" | "REJECT"optionaladd/update: what the rule does with matching traffic.
enablebooleanoptionaladd/update: rule active (default true).
macrostringoptionaladd/update: Proxmox firewall macro instead of proto/ports, e.g. SSH, HTTP, HTTPS, DNS, Ping.
protostringoptionaladd/update: protocol, e.g. tcp, udp, icmp, icmpv6.
sourcestringoptionaladd/update: source address, CIDR or +ipset_name (IP set of this VPS). Empty = any.
deststringoptionaladd/update: destination address, CIDR or +ipset_name. Empty = any.
sportstringoptionaladd/update: source port(s), e.g. 1024:65535.
dportstringoptionaladd/update: destination port(s), e.g. 22, 80,443 or 27015:27020.
commentstringoptionaladd/update: free text comment.
log"nolog" | "alert" | "crit" | "debug" | "emerg" | "err" | "info" | "notice" | "warning"optionaladd/update: log level (default nolog).
confirmbooleanoptionalmutate_vserver_firewall_ipsetCreate or delete a VPS firewall IP set, or add/remove an address (cidr). Rules reference a set as +name. Requires confirm=true.
vserver.firewall.writeserviceIdstringrequiredID of the VPS: the "id" field from list_account_services or list_vservers (e.g. "cmabc123..."). The numericId shown in the panel (e.g. "180") is accepted too. IDs of other service types do not work here.
action"create" | "delete" | "add_entry" | "remove_entry"requirednamestringrequiredIP set name (letters, digits, - and _). Use it in rules as +name.
cidrstringoptionaladd_entry/remove_entry: IP address or CIDR, e.g. 203.0.113.7 or 198.51.100.0/24.
commentstringoptionaladd_entry: free text comment.
confirmbooleanoptionallist_vserver_ssh_keysList the account SSH keys installed on one VPS.
vserver.config.readserviceIdstringrequiredID of the VPS: the "id" field from list_account_services or list_vservers (e.g. "cmabc123..."). The numericId shown in the panel (e.g. "180") is accepted too. IDs of other service types do not work here.
add_vserver_ssh_keyInstall an account SSH key (list_vserver_account_ssh_keys) on the VPS as root authorized key. Requires confirm=true.
vserver.access.manageserviceIdstringrequiredID of the VPS: the "id" field from list_account_services or list_vservers (e.g. "cmabc123..."). The numericId shown in the panel (e.g. "180") is accepted too. IDs of other service types do not work here.
sshKeyIdstringrequiredKey id from list_vserver_account_ssh_keys.
confirmbooleanoptionalremove_vserver_ssh_keyRemove an SSH key from the VPS (the key stays in the account). Requires confirm=true.
vserver.access.manageserviceIdstringrequiredID of the VPS: the "id" field from list_account_services or list_vservers (e.g. "cmabc123..."). The numericId shown in the panel (e.g. "180") is accepted too. IDs of other service types do not work here.
sshKeyIdstringrequiredKey id from list_vserver_ssh_keys.
confirmbooleanoptionalcreate_vserver_account_ssh_keyAdd a public SSH key to the account key store (then install it with add_vserver_ssh_key). Requires confirm=true.
vserver.config.writenamestringrequiredpublicKeystringrequiredOpenSSH public key line (ssh-ed25519/ssh-rsa/ecdsa ...). Never pass a private key.
confirmbooleanoptionalupdate_vserver_account_ssh_keyRename an account SSH key or replace its public key on every VPS it is installed on. Requires confirm=true.
vserver.access.managekeyIdstringrequiredKey id from list_vserver_account_ssh_keys.
namestringoptionalpublicKeystringoptionalReplaces the key on every VPS it is installed on.
confirmbooleanoptionaldelete_vserver_account_ssh_keyDelete an account SSH key and remove it from every VPS it is installed on. Requires confirm=true.
vserver.access.managekeyIdstringrequiredKey id from list_vserver_account_ssh_keys.
confirmbooleanoptionallist_vserver_isosList the ISO images that can be mounted on the VPS (ZAP library and own custom ISOs) and the mounted one.
vserver.reinstallserviceIdstringrequiredID of the VPS: the "id" field from list_account_services or list_vservers (e.g. "cmabc123..."). The numericId shown in the panel (e.g. "180") is accepted too. IDs of other service types do not work here.
mount_vserver_isoMount an ISO on the VPS (e.g. to install an own OS). Restart the VPS to boot from it. Requires confirm=true.
vserver.reinstallserviceIdstringrequiredID of the VPS: the "id" field from list_account_services or list_vservers (e.g. "cmabc123..."). The numericId shown in the panel (e.g. "180") is accepted too. IDs of other service types do not work here.
isoIdstringoptionalISO id from list_vserver_isos `images[].id`.
volidstringoptionalAlternative to isoId: the image's `volid` from list_vserver_isos.
applyHardwareProfilebooleanoptionalAdapt the VM hardware to the ISO's OS (UEFI + TPM); default false. Set true for Windows 11 / UEFI-only ISOs.
attachDriverDiscbooleanoptionalAttach the VirtIO driver disc (Windows installs).
bootFromIsobooleanoptionalBoot from the ISO first; default true except driver/tool ISOs.
confirmbooleanoptionalunmount_vserver_isoEject the mounted ISO and boot from disk again. Requires confirm=true.
vserver.reinstallserviceIdstringrequiredID of the VPS: the "id" field from list_account_services or list_vservers (e.g. "cmabc123..."). The numericId shown in the panel (e.g. "180") is accepted too. IDs of other service types do not work here.
confirmbooleanoptionallist_vserver_custom_isosList the customer's own imported ISO images for VPS.
vserver.reinstallserviceIdstringrequiredID of the VPS: the "id" field from list_account_services or list_vservers (e.g. "cmabc123..."). The numericId shown in the panel (e.g. "180") is accepted too. IDs of other service types do not work here.
import_vserver_custom_isoImport an own ISO from a public URL into the VPS ISO library. Returns an operation. Requires confirm=true.
vserver.reinstallserviceIdstringrequiredID of the VPS: the "id" field from list_account_services or list_vservers (e.g. "cmabc123..."). The numericId shown in the panel (e.g. "180") is accepted too. IDs of other service types do not work here.
displayNamestringrequiredsourceUrlstringrequiredPublic http(s) URL of the .iso file.
filenamestringoptionalosProfile"linux" | "windows"optionalOS of the ISO, sets the hardware profile on mount.
confirmbooleanoptionaldelete_vserver_custom_isoDelete an own imported ISO. Requires confirm=true.
vserver.reinstallserviceIdstringrequiredID of the VPS: the "id" field from list_account_services or list_vservers (e.g. "cmabc123..."). The numericId shown in the panel (e.g. "180") is accepted too. IDs of other service types do not work here.
assetIdstringrequiredCustom ISO id from list_vserver_custom_isos.
confirmbooleanoptionalget_vserver_metricsGet VPS metrics for a timeframe. Each point is a Proxmox RRD average: `netInBytes`, `netOutBytes`, `diskReadBytes` and `diskWriteBytes` are average bytes per second over the point's step (not byte volumes; multiply by the gap between consecutive `time` values to get a volume), `cpuPercent` is the CPU usage in percent and `memoryUsedMb`/`memoryMaxMb` are MiB. `time` is a Unix timestamp in seconds. `points` is empty only when the VPS is not running. If the host of a running VPS does not return monitoring data (ZapX retries once), the call fails with HTTP 503 `vserver_metrics_unavailable` (MCP: an error result saying the metrics are temporarily unavailable) instead of returning an empty list: that does not mean the VPS is idle, retry later.
vserver.metrics.readserviceIdstringrequiredID of the VPS: the "id" field from list_account_services or list_vservers (e.g. "cmabc123..."). The numericId shown in the panel (e.g. "180") is accepted too. IDs of other service types do not work here.
timeframe"hour" | "day" | "week" | "month"optionalget_vserver_firewallRead the VPS firewall configuration.
vserver.firewall.readserviceIdstringrequiredID of the VPS: the "id" field from list_account_services or list_vservers (e.g. "cmabc123..."). The numericId shown in the panel (e.g. "180") is accepted too. IDs of other service types do not work here.
start_vserverStart a VPS. Requires confirm=true.
vserver.power.startserviceIdstringrequiredID of the VPS: the "id" field from list_account_services or list_vservers (e.g. "cmabc123..."). The numericId shown in the panel (e.g. "180") is accepted too. IDs of other service types do not work here.
confirmbooleanoptionalstop_vserverStop a VPS. Requires confirm=true.
vserver.power.stopserviceIdstringrequiredID of the VPS: the "id" field from list_account_services or list_vservers (e.g. "cmabc123..."). The numericId shown in the panel (e.g. "180") is accepted too. IDs of other service types do not work here.
confirmbooleanoptionalrestart_vserverRestart a VPS. Requires confirm=true.
vserver.power.restartserviceIdstringrequiredID of the VPS: the "id" field from list_account_services or list_vservers (e.g. "cmabc123..."). The numericId shown in the panel (e.g. "180") is accepted too. IDs of other service types do not work here.
confirmbooleanoptionallist_vserver_schedulesList recurring VPS schedules (restart, start, stop, guest-agent command) the credential may manage.
vserver.viewserviceIdstringrequiredID of the VPS: the "id" field from list_account_services or list_vservers (e.g. "cmabc123..."). The numericId shown in the panel (e.g. "180") is accepted too. IDs of other service types do not work here.
create_vserver_scheduleCreate a recurring VPS schedule: action restart, start, stop or command (runs `command` through the QEMU guest agent). Five-field cron, evaluated in `timezone` (IANA, default UTC), at most every 5 minutes. Requires confirm=true.
vserver.power.restartvserver.power.startvserver.power.stopvserver.console.writeserviceIdstringrequiredID of the VPS: the "id" field from list_account_services or list_vservers (e.g. "cmabc123..."). The numericId shown in the panel (e.g. "180") is accepted too. IDs of other service types do not work here.
namestringrequiredaction"restart" | "start" | "stop" | "command"requiredcronstringrequiredtimezonestringoptionalcommandstringoptionalisActivebooleanoptionalconfirmbooleanoptionalupdate_vserver_scheduleUpdate a VPS schedule (name, action, cron, timezone, command, isActive). Requires confirm=true.
vserver.power.restartvserver.power.startvserver.power.stopvserver.console.writeserviceIdstringrequiredID of the VPS: the "id" field from list_account_services or list_vservers (e.g. "cmabc123..."). The numericId shown in the panel (e.g. "180") is accepted too. IDs of other service types do not work here.
scheduleIdstringrequirednamestringoptionalaction"restart" | "start" | "stop" | "command"optionalcronstringoptionaltimezonestringoptionalcommandstringoptionalisActivebooleanoptionalconfirmbooleanoptionaldelete_vserver_scheduleDelete a VPS schedule. Requires confirm=true.
vserver.power.restartvserver.power.startvserver.power.stopvserver.console.writeserviceIdstringrequiredID of the VPS: the "id" field from list_account_services or list_vservers (e.g. "cmabc123..."). The numericId shown in the panel (e.g. "180") is accepted too. IDs of other service types do not work here.
scheduleIdstringrequiredconfirmbooleanoptionalenable_vserver_rescueEnable VPS rescue mode. Requires confirm=true.
vserver.reinstallserviceIdstringrequiredID of the VPS: the "id" field from list_account_services or list_vservers (e.g. "cmabc123..."). The numericId shown in the panel (e.g. "180") is accepted too. IDs of other service types do not work here.
confirmbooleanoptionaldisable_vserver_rescueDisable VPS rescue mode. Requires confirm=true.
vserver.reinstallserviceIdstringrequiredID of the VPS: the "id" field from list_account_services or list_vservers (e.g. "cmabc123..."). The numericId shown in the panel (e.g. "180") is accepted too. IDs of other service types do not work here.
confirmbooleanoptionallist_vserver_reinstall_templatesList available VPS reinstall templates. minDiskGb is the minimum disk in GB the template needs (null = none); templates above the VPS disk are rejected.
vserver.reinstallNo parameters
reinstall_vserverReinstall a VPS. Requires confirm=true.
vserver.reinstallserviceIdstringrequiredID of the VPS: the "id" field from list_account_services or list_vservers (e.g. "cmabc123..."). The numericId shown in the panel (e.g. "180") is accepted too. IDs of other service types do not work here.
templateIdstringoptionalconfirmbooleanoptionalPower state, hardware, metrics, traffic, installation, custom ISOs, reverse DNS, DDoS protection, remote management and rescue mode.
list_dedicated_serversList dedicated servers accessible with the current credential. Prefer list_account_services for cross-product discovery.
dedicated.viewNo parameters
get_dedicated_serverGet one dedicated server by ID.
dedicated.viewserviceIdstringrequiredID of the Dedicated server: the "id" field from list_account_services or list_dedicated_servers (e.g. "cmabc123..."). The numericId shown in the panel (e.g. "180") is accepted too. IDs of other service types do not work here.
get_dedicated_power_stateGet dedicated server hardware power state.
dedicated.viewserviceIdstringrequiredID of the Dedicated server: the "id" field from list_account_services or list_dedicated_servers (e.g. "cmabc123..."). The numericId shown in the panel (e.g. "180") is accepted too. IDs of other service types do not work here.
get_dedicated_metricsGet dedicated server hardware metrics for a timeframe.
dedicated.metrics.readserviceIdstringrequiredID of the Dedicated server: the "id" field from list_account_services or list_dedicated_servers (e.g. "cmabc123..."). The numericId shown in the panel (e.g. "180") is accepted too. IDs of other service types do not work here.
range"1h" | "6h" | "24h" | "7d" | "30d"optionalget_dedicated_hardwareGet dedicated server hardware inventory.
dedicated.hardware.readserviceIdstringrequiredID of the Dedicated server: the "id" field from list_account_services or list_dedicated_servers (e.g. "cmabc123..."). The numericId shown in the panel (e.g. "180") is accepted too. IDs of other service types do not work here.
get_dedicated_trafficGet dedicated server traffic overview for a timeframe.
dedicated.traffic.readserviceIdstringrequiredID of the Dedicated server: the "id" field from list_account_services or list_dedicated_servers (e.g. "cmabc123..."). The numericId shown in the panel (e.g. "180") is accepted too. IDs of other service types do not work here.
range"1h" | "6h" | "24h" | "7d" | "30d"optionalget_dedicated_traffic_quotaGet dedicated server traffic quota snapshot.
dedicated.traffic.readserviceIdstringrequiredID of the Dedicated server: the "id" field from list_account_services or list_dedicated_servers (e.g. "cmabc123..."). The numericId shown in the panel (e.g. "180") is accepted too. IDs of other service types do not work here.
get_dedicated_traffic_historyGet dedicated server traffic history entries.
dedicated.traffic.readserviceIdstringrequiredID of the Dedicated server: the "id" field from list_account_services or list_dedicated_servers (e.g. "cmabc123..."). The numericId shown in the panel (e.g. "180") is accepted too. IDs of other service types do not work here.
limitintegeroptional> 0 ยท max 9007199254740991
offsetintegeroptionalmin 0 ยท max 9007199254740991
get_dedicated_activityRead recent dedicated server activity logs.
dedicated.activity.readserviceIdstringrequiredID of the Dedicated server: the "id" field from list_account_services or list_dedicated_servers (e.g. "cmabc123..."). The numericId shown in the panel (e.g. "180") is accepted too. IDs of other service types do not work here.
limitintegeroptional> 0 ยท max 9007199254740991
offsetintegeroptionalmin 0 ยท max 9007199254740991
get_dedicated_installationGet dedicated server installation status.
dedicated.viewserviceIdstringrequiredID of the Dedicated server: the "id" field from list_account_services or list_dedicated_servers (e.g. "cmabc123..."). The numericId shown in the panel (e.g. "180") is accepted too. IDs of other service types do not work here.
get_dedicated_installation_progressGet dedicated server installation progress and log.
dedicated.viewserviceIdstringrequiredID of the Dedicated server: the "id" field from list_account_services or list_dedicated_servers (e.g. "cmabc123..."). The numericId shown in the panel (e.g. "180") is accepted too. IDs of other service types do not work here.
get_dedicated_installation_optionsList install media, reinstall, rescue, and custom ISO options.
dedicated.installation.manageserviceIdstringrequiredID of the Dedicated server: the "id" field from list_account_services or list_dedicated_servers (e.g. "cmabc123..."). The numericId shown in the panel (e.g. "180") is accepted too. IDs of other service types do not work here.
get_dedicated_reverse_dnsRead reverse DNS entries for a dedicated server.
dedicated.network.readserviceIdstringrequiredID of the Dedicated server: the "id" field from list_account_services or list_dedicated_servers (e.g. "cmabc123..."). The numericId shown in the panel (e.g. "180") is accepted too. IDs of other service types do not work here.
get_dedicated_ddos_statusGet DDoS protection status for a dedicated server.
dedicated.ddos.readserviceIdstringrequiredID of the Dedicated server: the "id" field from list_account_services or list_dedicated_servers (e.g. "cmabc123..."). The numericId shown in the panel (e.g. "180") is accepted too. IDs of other service types do not work here.
ipAddressstringoptionallist_dedicated_ddos_rulesList DDoS protection rules for a dedicated server.
dedicated.ddos.readserviceIdstringrequiredID of the Dedicated server: the "id" field from list_account_services or list_dedicated_servers (e.g. "cmabc123..."). The numericId shown in the panel (e.g. "180") is accepted too. IDs of other service types do not work here.
ipAddressstringoptionallist_dedicated_ddos_incidentsList DDoS incidents for a dedicated server.
dedicated.ddos.readserviceIdstringrequiredID of the Dedicated server: the "id" field from list_account_services or list_dedicated_servers (e.g. "cmabc123..."). The numericId shown in the panel (e.g. "180") is accepted too. IDs of other service types do not work here.
ipAddressstringoptionalpageintegeroptional> 0 ยท max 9007199254740991
pageSizeintegeroptional> 0 ยท max 100
get_dedicated_ddos_bandwidthGet DDoS bandwidth statistics for a dedicated server.
dedicated.ddos.readserviceIdstringrequiredID of the Dedicated server: the "id" field from list_account_services or list_dedicated_servers (e.g. "cmabc123..."). The numericId shown in the panel (e.g. "180") is accepted too. IDs of other service types do not work here.
rangestringoptionalipAddressstringoptionalget_dedicated_remote_managementGet dedicated server remote management session state.
dedicated.remote_management.manageserviceIdstringrequiredID of the Dedicated server: the "id" field from list_account_services or list_dedicated_servers (e.g. "cmabc123..."). The numericId shown in the panel (e.g. "180") is accepted too. IDs of other service types do not work here.
list_dedicated_custom_isosList custom ISO assets available for a dedicated server.
dedicated.installation.manageserviceIdstringrequiredID of the Dedicated server: the "id" field from list_account_services or list_dedicated_servers (e.g. "cmabc123..."). The numericId shown in the panel (e.g. "180") is accepted too. IDs of other service types do not work here.
list_dedicated_reinstall_templatesList the OS installation ISOs of the dedicated server catalog. They are not installed automatically: mount one and install it through remote management.
dedicated.reinstallNo parameters
start_dedicated_serverStart a dedicated server. Requires confirm=true.
dedicated.power.startserviceIdstringrequiredID of the Dedicated server: the "id" field from list_account_services or list_dedicated_servers (e.g. "cmabc123..."). The numericId shown in the panel (e.g. "180") is accepted too. IDs of other service types do not work here.
confirmbooleanoptionalstop_dedicated_serverStop a dedicated server. Requires confirm=true.
dedicated.power.stopserviceIdstringrequiredID of the Dedicated server: the "id" field from list_account_services or list_dedicated_servers (e.g. "cmabc123..."). The numericId shown in the panel (e.g. "180") is accepted too. IDs of other service types do not work here.
mode"gracefulShutdown" | "forceShutdown"optionalconfirmbooleanoptionalrestart_dedicated_serverRestart a dedicated server. Requires confirm=true.
dedicated.power.restartserviceIdstringrequiredID of the Dedicated server: the "id" field from list_account_services or list_dedicated_servers (e.g. "cmabc123..."). The numericId shown in the panel (e.g. "180") is accepted too. IDs of other service types do not work here.
mode"gracefulRestart" | "forceRestart" | "powerCycle"optionalconfirmbooleanoptionalreinstall_dedicated_serverReset a dedicated server: wipes all disks and installs NO operating system (osTemplateId is only validated, not installed). Mount a catalog ISO afterwards to install an OS. Requires confirm=true.
dedicated.reinstallserviceIdstringrequiredID of the Dedicated server: the "id" field from list_account_services or list_dedicated_servers (e.g. "cmabc123..."). The numericId shown in the panel (e.g. "180") is accepted too. IDs of other service types do not work here.
osTemplateIdstringoptionalOptional catalog template id; only validated, nothing is installed (the reset only wipes the disks).
confirmbooleanoptionalwipe_dedicated_serverWipe a dedicated server. Requires confirm=true.
dedicated.reinstallserviceIdstringrequiredID of the Dedicated server: the "id" field from list_account_services or list_dedicated_servers (e.g. "cmabc123..."). The numericId shown in the panel (e.g. "180") is accepted too. IDs of other service types do not work here.
confirmbooleanoptionalupdate_dedicated_reverse_dnsUpdate reverse DNS for a dedicated server. Requires confirm=true.
dedicated.network.writeserviceIdstringrequiredID of the Dedicated server: the "id" field from list_account_services or list_dedicated_servers (e.g. "cmabc123..."). The numericId shown in the panel (e.g. "180") is accepted too. IDs of other service types do not work here.
ipAddressIdstringoptionalipv6PrefixAllocationIdstringoptionalhostnamestringoptionalconfirmbooleanoptionalrefresh_dedicated_installationRefresh dedicated server installation media and boot state. Requires confirm=true.
dedicated.installation.manageserviceIdstringrequiredID of the Dedicated server: the "id" field from list_account_services or list_dedicated_servers (e.g. "cmabc123..."). The numericId shown in the panel (e.g. "180") is accepted too. IDs of other service types do not work here.
confirmbooleanoptionalmount_dedicated_install_mediaMount install media on a dedicated server. Requires confirm=true.
dedicated.installation.manageserviceIdstringrequiredID of the Dedicated server: the "id" field from list_account_services or list_dedicated_servers (e.g. "cmabc123..."). The numericId shown in the panel (e.g. "180") is accepted too. IDs of other service types do not work here.
templateIdstringrequiredconfirmbooleanoptionalunmount_dedicated_install_mediaUnmount install media from a dedicated server. Requires confirm=true.
dedicated.installation.manageserviceIdstringrequiredID of the Dedicated server: the "id" field from list_account_services or list_dedicated_servers (e.g. "cmabc123..."). The numericId shown in the panel (e.g. "180") is accepted too. IDs of other service types do not work here.
confirmbooleanoptionalset_dedicated_next_bootSet the next boot device for a dedicated server. Requires confirm=true.
dedicated.installation.manageserviceIdstringrequiredID of the Dedicated server: the "id" field from list_account_services or list_dedicated_servers (e.g. "cmabc123..."). The numericId shown in the panel (e.g. "180") is accepted too. IDs of other service types do not work here.
device"disk" | "virtual_media"requiredconfirmbooleanoptionalenable_dedicated_rescueEnable rescue mode on a dedicated server. Requires confirm=true.
dedicated.rescue.manageserviceIdstringrequiredID of the Dedicated server: the "id" field from list_account_services or list_dedicated_servers (e.g. "cmabc123..."). The numericId shown in the panel (e.g. "180") is accepted too. IDs of other service types do not work here.
templateIdstringrequiredconfirmbooleanoptionaldisable_dedicated_rescueDisable rescue mode on a dedicated server. Requires confirm=true.
dedicated.rescue.manageserviceIdstringrequiredID of the Dedicated server: the "id" field from list_account_services or list_dedicated_servers (e.g. "cmabc123..."). The numericId shown in the panel (e.g. "180") is accepted too. IDs of other service types do not work here.
confirmbooleanoptionalactivate_dedicated_remote_managementActivate remote management for a dedicated server. Requires confirm=true.
dedicated.remote_management.manageserviceIdstringrequiredID of the Dedicated server: the "id" field from list_account_services or list_dedicated_servers (e.g. "cmabc123..."). The numericId shown in the panel (e.g. "180") is accepted too. IDs of other service types do not work here.
durationHoursintegeroptional> 0 ยท max 9007199254740991
confirmbooleanoptionalextend_dedicated_remote_managementExtend remote management for a dedicated server. Requires confirm=true.
dedicated.remote_management.manageserviceIdstringrequiredID of the Dedicated server: the "id" field from list_account_services or list_dedicated_servers (e.g. "cmabc123..."). The numericId shown in the panel (e.g. "180") is accepted too. IDs of other service types do not work here.
confirmbooleanoptionalrevoke_dedicated_remote_managementRevoke remote management for a dedicated server. Requires confirm=true.
dedicated.remote_management.manageserviceIdstringrequiredID of the Dedicated server: the "id" field from list_account_services or list_dedicated_servers (e.g. "cmabc123..."). The numericId shown in the panel (e.g. "180") is accepted too. IDs of other service types do not work here.
confirmbooleanoptionallaunch_dedicated_remote_managementIssue a remote management launch URL for a dedicated server. Requires confirm=true.
dedicated.remote_management.manageserviceIdstringrequiredID of the Dedicated server: the "id" field from list_account_services or list_dedicated_servers (e.g. "cmabc123..."). The numericId shown in the panel (e.g. "180") is accepted too. IDs of other service types do not work here.
confirmbooleanoptionaltoggle_dedicated_ddos_protectionToggle DDoS protection for a dedicated server. Requires confirm=true.
dedicated.ddos.manageserviceIdstringrequiredID of the Dedicated server: the "id" field from list_account_services or list_dedicated_servers (e.g. "cmabc123..."). The numericId shown in the panel (e.g. "180") is accepted too. IDs of other service types do not work here.
ipAddressstringoptionalenabledbooleanoptionalTarget state (true = protected). Without it the current state is flipped.
confirmbooleanoptionalimport_dedicated_custom_isoImport a custom ISO for dedicated servers. Requires confirm=true.
dedicated.installation.manageserviceIdstringrequiredID of the Dedicated server: the "id" field from list_account_services or list_dedicated_servers (e.g. "cmabc123..."). The numericId shown in the panel (e.g. "180") is accepted too. IDs of other service types do not work here.
displayNamestringrequiredsourceUrlstringrequiredformat uri
filenamestringoptionalconfirmbooleanoptionaldelete_dedicated_custom_isoDelete a custom ISO asset. Requires confirm=true.
dedicated.installation.manageserviceIdstringrequiredID of the Dedicated server: the "id" field from list_account_services or list_dedicated_servers (e.g. "cmabc123..."). The numericId shown in the panel (e.g. "180") is accepted too. IDs of other service types do not work here.
assetIdstringrequiredconfirmbooleanoptionalmount_dedicated_custom_isoMount a custom ISO on a dedicated server. Requires confirm=true.
dedicated.installation.manageserviceIdstringrequiredID of the Dedicated server: the "id" field from list_account_services or list_dedicated_servers (e.g. "cmabc123..."). The numericId shown in the panel (e.g. "180") is accepted too. IDs of other service types do not work here.
assetIdstringrequiredconfirmbooleanoptionalStatus, start and stop, settings, clients, bans and privilege keys.
list_teamspeak_serversList TeamSpeak servers accessible with the current credential. Prefer list_account_services for cross-product discovery.
teamspeak.viewNo parameters
get_teamspeak_serverGet one TeamSpeak server by ID.
teamspeak.viewserviceIdstringrequiredID of the TeamSpeak server: the "id" field from list_account_services or list_teamspeak_servers (e.g. "cmabc123..."). The numericId shown in the panel (e.g. "180") is accepted too. IDs of other service types do not work here.
get_teamspeak_configRead TeamSpeak server configuration.
teamspeak.config.readserviceIdstringrequiredID of the TeamSpeak server: the "id" field from list_account_services or list_teamspeak_servers (e.g. "cmabc123..."). The numericId shown in the panel (e.g. "180") is accepted too. IDs of other service types do not work here.
update_teamspeak_configUpdate TeamSpeak server configuration. Requires confirm=true.
teamspeak.config.manageserviceIdstringrequiredID of the TeamSpeak server: the "id" field from list_account_services or list_teamspeak_servers (e.g. "cmabc123..."). The numericId shown in the panel (e.g. "180") is accepted too. IDs of other service types do not work here.
propertiesRecord<string, string | number>requiredconfirmbooleanoptionallist_teamspeak_tokensList privilege tokens for a TeamSpeak server.
teamspeak.tokens.manageserviceIdstringrequiredID of the TeamSpeak server: the "id" field from list_account_services or list_teamspeak_servers (e.g. "cmabc123..."). The numericId shown in the panel (e.g. "180") is accepted too. IDs of other service types do not work here.
create_teamspeak_tokenCreate a TeamSpeak privilege token. Requires confirm=true.
teamspeak.tokens.manageserviceIdstringrequiredID of the TeamSpeak server: the "id" field from list_account_services or list_teamspeak_servers (e.g. "cmabc123..."). The numericId shown in the panel (e.g. "180") is accepted too. IDs of other service types do not work here.
descriptionstringoptionalmax length 100
confirmbooleanoptionalstart_teamspeak_serverStart a TeamSpeak server. Requires confirm=true.
teamspeak.power.startserviceIdstringrequiredID of the TeamSpeak server: the "id" field from list_account_services or list_teamspeak_servers (e.g. "cmabc123..."). The numericId shown in the panel (e.g. "180") is accepted too. IDs of other service types do not work here.
confirmbooleanoptionalstop_teamspeak_serverStop a TeamSpeak server. Requires confirm=true.
teamspeak.power.stopserviceIdstringrequiredID of the TeamSpeak server: the "id" field from list_account_services or list_teamspeak_servers (e.g. "cmabc123..."). The numericId shown in the panel (e.g. "180") is accepted too. IDs of other service types do not work here.
confirmbooleanoptionalrestart_teamspeak_serverRestart a TeamSpeak server. Requires confirm=true.
teamspeak.power.restartserviceIdstringrequiredID of the TeamSpeak server: the "id" field from list_account_services or list_teamspeak_servers (e.g. "cmabc123..."). The numericId shown in the panel (e.g. "180") is accepted too. IDs of other service types do not work here.
confirmbooleanoptionalget_teamspeak_metricsGet TeamSpeak server metrics.
teamspeak.metrics.readserviceIdstringrequiredID of the TeamSpeak server: the "id" field from list_account_services or list_teamspeak_servers (e.g. "cmabc123..."). The numericId shown in the panel (e.g. "180") is accepted too. IDs of other service types do not work here.
list_teamspeak_clientsList connected TeamSpeak clients.
teamspeak.clients.manageserviceIdstringrequiredID of the TeamSpeak server: the "id" field from list_account_services or list_teamspeak_servers (e.g. "cmabc123..."). The numericId shown in the panel (e.g. "180") is accepted too. IDs of other service types do not work here.
list_teamspeak_bansList TeamSpeak server bans.
teamspeak.bans.manageserviceIdstringrequiredID of the TeamSpeak server: the "id" field from list_account_services or list_teamspeak_servers (e.g. "cmabc123..."). The numericId shown in the panel (e.g. "180") is accepted too. IDs of other service types do not work here.
add_teamspeak_banAdd a TeamSpeak ban. Requires confirm=true.
teamspeak.bans.manageserviceIdstringrequiredID of the TeamSpeak server: the "id" field from list_account_services or list_teamspeak_servers (e.g. "cmabc123..."). The numericId shown in the panel (e.g. "180") is accepted too. IDs of other service types do not work here.
ipstringoptionaluidstringoptionalnamestringoptionaltimenumberoptionalreasonstringoptionalconfirmbooleanoptionaldelete_teamspeak_banDelete a TeamSpeak ban. Requires confirm=true.
teamspeak.bans.manageserviceIdstringrequiredID of the TeamSpeak server: the "id" field from list_account_services or list_teamspeak_servers (e.g. "cmabc123..."). The numericId shown in the panel (e.g. "180") is accepted too. IDs of other service types do not work here.
banIdintegerrequired> 0 ยท max 9007199254740991
confirmbooleanoptionaldelete_teamspeak_tokenDelete a TeamSpeak privilege token. Requires confirm=true.
teamspeak.tokens.manageserviceIdstringrequiredID of the TeamSpeak server: the "id" field from list_account_services or list_teamspeak_servers (e.g. "cmabc123..."). The numericId shown in the panel (e.g. "180") is accepted too. IDs of other service types do not work here.
tokenstringrequiredconfirmbooleanoptionalStatus, console, start and stop and the activity of your Discord bots.
list_discord_botsList Discord bots accessible with the current token.
discord_bot.viewNo parameters
get_discord_botGet Discord bot details.
discord_bot.viewserviceIdstringrequiredID of the Discord bot: the "id" field from list_account_services or list_discord_bots (e.g. "cmabc123..."). The numericId shown in the panel (e.g. "180") is accepted too. IDs of other service types do not work here.
get_discord_bot_container_statusGet Discord bot container and port reachability status.
discord_bot.viewserviceIdstringrequiredID of the Discord bot: the "id" field from list_account_services or list_discord_bots (e.g. "cmabc123..."). The numericId shown in the panel (e.g. "180") is accepted too. IDs of other service types do not work here.
get_discord_bot_activityRead recent Discord bot activity logs.
discord_bot.viewserviceIdstringrequiredID of the Discord bot: the "id" field from list_account_services or list_discord_bots (e.g. "cmabc123..."). The numericId shown in the panel (e.g. "180") is accepted too. IDs of other service types do not work here.
limitintegeroptionalmin 1 ยท max 100
offsetintegeroptionalmin 0 ยท max 9007199254740991
start_discord_botStart a Discord bot. Requires confirm=true.
discord_bot.startserviceIdstringrequiredID of the Discord bot: the "id" field from list_account_services or list_discord_bots (e.g. "cmabc123..."). The numericId shown in the panel (e.g. "180") is accepted too. IDs of other service types do not work here.
confirmbooleanoptionalstop_discord_botStop a Discord bot. Requires confirm=true.
discord_bot.stopserviceIdstringrequiredID of the Discord bot: the "id" field from list_account_services or list_discord_bots (e.g. "cmabc123..."). The numericId shown in the panel (e.g. "180") is accepted too. IDs of other service types do not work here.
confirmbooleanoptionalrestart_discord_botRestart a Discord bot. Requires confirm=true.
discord_bot.restartserviceIdstringrequiredID of the Discord bot: the "id" field from list_account_services or list_discord_bots (e.g. "cmabc123..."). The numericId shown in the panel (e.g. "180") is accepted too. IDs of other service types do not work here.
confirmbooleanoptionalget_discord_bot_console_logsGet recent Discord bot console log lines.
discord_bot.console.readserviceIdstringrequiredID of the Discord bot: the "id" field from list_account_services or list_discord_bots (e.g. "cmabc123..."). The numericId shown in the panel (e.g. "180") is accepted too. IDs of other service types do not work here.
linesintegeroptionalNumber of recent log lines to return, 1-200 (default 50). Values above 200 are rejected.
> 0 ยท max 200
send_discord_bot_console_commandSend a command to the Discord bot console. Requires confirm=true.
discord_bot.console.writeserviceIdstringrequiredID of the Discord bot: the "id" field from list_account_services or list_discord_bots (e.g. "cmabc123..."). The numericId shown in the panel (e.g. "180") is accepted too. IDs of other service types do not work here.
commandstringrequiredmax length 500
confirmbooleanoptionalDomains, DNS records, nameservers, parking page and auto-renewal.
list_domainsList domains accessible with the current credential (own and shared): name, status, dnsMode (managed = ZapX nameservers, external = own nameservers), auto-renew, expiry, nameservers. Read-only.
domain.viewNo parameters
get_domainGet one domain by ID. Read-only.
domain.viewdomainIdstringrequiredDomain id (from list_domains or list_account_services).
get_domain_dns_recordsList the DNS records of a domain (id, name, type, content, ttl, priority/weight/port, linkedService) plus the parking page state. mode managed or cloudflare-protected = records are editable with the DNS tools; read-only = the domain uses external nameservers, manage its records there. Records with linkedService belong to a server link or One-Click Apps and cannot be changed here. Read-only.
domain.dns.readdomainIdstringrequiredDomain id (from list_domains or list_account_services).
create_domain_dns_recordCreate a DNS record on a domain with ZapX nameservers (or an active Cloudflare protection). name is relative to the domain ('@' = the domain itself). MX needs priority, SRV needs priority, weight and port. Requires confirm=true.
domain.dns.writedomainIdstringrequiredDomain id (from list_domains or list_account_services).
type"A" | "AAAA" | "CAA" | "CNAME" | "MX" | "NS" | "SRV" | "SSHFP" | "TLSA" | "TXT"requiredRecord type.
namestringoptionalRecord name relative to the domain: '@' (default) for the domain itself, 'www', '_acme-challenge', ...
max length 253
contentstringrequiredRecord value (IP address, hostname, TXT text, ...).
max length 4096
ttlintegeroptionalTTL in seconds (default 3600, min 60).
min 60 ยท max 9007199254740991
priorityintegeroptionalMX/SRV priority.
min 0 ยท max 65535
weightintegeroptionalSRV weight.
min 0 ยท max 65535
portintegeroptionalSRV port.
min 0 ยท max 65535
confirmbooleanoptionalMust be true to apply the change.
update_domain_dns_recordReplace a DNS record (name, content, ttl, priority/weight/port). The record type cannot change: delete the record and create a new one instead. Requires confirm=true.
domain.dns.writedomainIdstringrequiredDomain id (from list_domains or list_account_services).
recordIdstringrequiredRecord id from get_domain_dns_records.
type"A" | "AAAA" | "CAA" | "CNAME" | "MX" | "NS" | "SRV" | "SSHFP" | "TLSA" | "TXT"requiredRecord type.
namestringoptionalRecord name relative to the domain: '@' (default) for the domain itself, 'www', '_acme-challenge', ...
max length 253
contentstringrequiredRecord value (IP address, hostname, TXT text, ...).
max length 4096
ttlintegeroptionalTTL in seconds (default 3600, min 60).
min 60 ยท max 9007199254740991
priorityintegeroptionalMX/SRV priority.
min 0 ยท max 65535
weightintegeroptionalSRV weight.
min 0 ยท max 65535
portintegeroptionalSRV port.
min 0 ยท max 65535
confirmbooleanoptionalMust be true to apply the change.
delete_domain_dns_recordDelete a DNS record of a domain. The domain's own NS records on '@' and records of server links / One-Click Apps cannot be deleted. Requires confirm=true.
domain.dns.writedomainIdstringrequiredDomain id (from list_domains or list_account_services).
recordIdstringrequiredRecord id from get_domain_dns_records.
confirmbooleanoptionalMust be true to apply the change.
set_domain_parking_pageSwitch the ZapX parking page of a domain with ZapX nameservers on or off (A records on '@', 'www' and '*'). If switching on would replace own records, nothing is written and the result lists them under replace with needsConfirmation=true; call again with their ids in confirmedReplaceRecordIds. Requires confirm=true.
domain.dns.writedomainIdstringrequiredDomain id (from list_domains or list_account_services).
enabledbooleanrequiredtrue = show the ZapX parking page, false = remove it.
confirmedReplaceRecordIdsstring[]optionalIds of the own records the previous call listed under `replace` (switching on only).
max items 200
confirmbooleanoptionalMust be true to apply the change.
get_domain_nameserversRead the nameserver delegation of a domain (dnsMode managed/external and the nameservers). Read-only.
domain.dns.readdomainIdstringrequiredDomain id (from list_domains or list_account_services).
set_domain_nameserversChange the nameservers of a domain at the registrar (domain owner only). mode managed = back to the ZapX nameservers; mode external = own nameservers (2-13 distinct hostnames that resolve). Switching to external nameservers means the DNS records at ZapX no longer answer for the domain. Requires confirm=true.
domain.nameservers.writedomainIdstringrequiredDomain id (from list_domains or list_account_services).
mode"managed" | "external"requiredmanaged = ZapX nameservers (DNS records editable here), external = own nameservers.
nameserversstring[]optionalExternal nameserver hostnames (mode external only, 2-13 distinct).
min items 2 ยท max items 13
confirmbooleanoptionalMust be true to apply the change.
get_domain_renewalRead the renewal state of a domain (domain owner only): autoRenew, expiresAt, registrarStatus, scheduledDeletionAt, nextRenewalChargeAt. Read-only.
domain.viewdomainIdstringrequiredDomain id (from list_domains or list_account_services).
set_domain_auto_renewTurn auto-renew of a domain on or off (domain owner only). With auto-renew off the domain is neither renewed nor charged at the end of its term and expires. Requires confirm=true.
domain.renewal.managedomainIdstringrequiredDomain id (from list_domains or list_account_services).
autoRenewbooleanrequiredfalse = the domain is not renewed (nor charged) at the end of its term and expires.
confirmbooleanoptionalMust be true to apply the change.
List, read, write, rename and delete files of game servers and Discord bots.
list_discord_bot_filesList files in a Discord bot directory.
discord_bot.files.readserviceIdstringrequiredID of the Discord bot: the "id" field from list_account_services or list_discord_bots (e.g. "cmabc123..."). The numericId shown in the panel (e.g. "180") is accepted too. IDs of other service types do not work here.
pathstringoptionalincludeFolderSizesbooleanoptionalread_discord_bot_fileRead an editable text file from a Discord bot.
discord_bot.files.readserviceIdstringrequiredID of the Discord bot: the "id" field from list_account_services or list_discord_bots (e.g. "cmabc123..."). The numericId shown in the panel (e.g. "180") is accepted too. IDs of other service types do not work here.
pathstringrequiredmutate_discord_bot_fileCreate, rename, delete, or write Discord bot file content. Destructive actions require confirm=true.
discord_bot.files.writeserviceIdstringrequiredID of the Discord bot: the "id" field from list_account_services or list_discord_bots (e.g. "cmabc123..."). The numericId shown in the panel (e.g. "180") is accepted too. IDs of other service types do not work here.
action"write" | "create_file" | "create_dir" | "rename" | "delete"requiredpathstringrequiredcontentstringoptionalexpectedRevisionstringoptional`revision` returned when the file was read. With action `write` the write is refused (409 file_changed) when the file changed since; re-read and retry.
newNamestringoptionalconfirmbooleanoptionallist_gameserver_filesList files in a gameserver directory.
gameserver.files.readserviceIdstringrequiredID 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.
pathstringoptionalscope"savegame" | "config" | "active"optional`savegame` restricts to savegame paths; `config`/`active` resolve paths from the game data root.
includeFolderSizesbooleanoptionalread_gameserver_fileRead text content of a gameserver file.
gameserver.files.readserviceIdstringrequiredID 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.
pathstringrequiredscope"savegame" | "config" | "active"optional`savegame` restricts to savegame paths; `config`/`active` resolve paths from the game data root.
mutate_gameserver_fileCreate, write, rename, delete, move or copy a gameserver file or folder. move/copy put entries into an existing destination folder and never overwrite. Destructive actions (write, rename, delete, move) require confirm=true.
gameserver.files.writeserviceIdstringrequiredID 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.
action"write" | "create_file" | "create_dir" | "rename" | "delete" | "move" | "copy"requiredpathstringoptionalFile or folder to act on (required except for move/copy given `paths`). For move/copy: the single entry to transfer.
contentstringoptionalexpectedRevisionstringoptional`revision` returned when the file was read. With action `write` the write is refused (409 file_changed) when the file changed since; re-read and retry.
newNamestringoptionalpathsstring[]optionalmove/copy: several entries to transfer at once (overrides path).
min items 1 ยท max items 100
destinationstringoptionalmove/copy: existing folder the entries go into, keeping their names. Nothing is overwritten: a taken name or a missing folder refuses the request.
scope"savegame" | "config" | "active"optional`savegame` restricts to savegame paths; `config`/`active` resolve paths from the game data root.
confirmbooleanoptionalApp catalog (Pterodactyl, Nextcloud, n8n, ...), install, start/stop/restart, logs and uninstall; game servers inside Pterodactyl are created in its own panel.
get_vserver_appsOne-Click Apps (Coolify apps such as Pterodactyl, Nextcloud, n8n, Uptime Kuma) on a VPS: setup status, installed apps with status and access URL, whether apps can be installed. No passwords are returned. live=true asks the panel for the current status.
vserver.apps.readserviceIdstringrequiredID of the VPS: the "id" field from list_account_services or list_vservers (e.g. "cmabc123..."). The numericId shown in the panel (e.g. "180") is accepted too. IDs of other service types do not work here.
livebooleanoptionalAsk the panel for the live status (slower; needs the manage permission), default the stored status.
list_vserver_app_catalogSearch the One-Click Apps catalog for a VPS (name, description, category, paged). Use the type with get_vserver_app_catalog_entry before installing.
vserver.apps.readserviceIdstringrequiredID of the VPS: the "id" field from list_account_services or list_vservers (e.g. "cmabc123..."). The numericId shown in the panel (e.g. "180") is accepted too. IDs of other service types do not work here.
searchstringoptionalFree text search over name, description and tags.
max length 200
categorystringoptionalmax length 100
pageintegeroptional> 0 ยท max 9007199254740991
pageSizeintegeroptional> 0 ยท max 50
get_vserver_app_catalog_entryOne catalog app with its install fields and install guidance (which values to ask the user for; apps that need a secret can only be installed in the dashboard).
vserver.apps.readserviceIdstringrequiredID of the VPS: the "id" field from list_account_services or list_vservers (e.g. "cmabc123..."). The numericId shown in the panel (e.g. "180") is accepted too. IDs of other service types do not work here.
catalogTypestringrequiredmax length 128
get_vserver_app_logsRecent container logs of an installed One-Click App on a VPS (secrets and login links removed). Read them before suggesting a restart.
vserver.apps.readserviceIdstringrequiredID of the VPS: the "id" field from list_account_services or list_vservers (e.g. "cmabc123..."). The numericId shown in the panel (e.g. "180") is accepted too. IDs of other service types do not work here.
installationIdstringrequiredInstallation id from get_vserver_apps / get_dedicated_apps.
max length 64
linesintegeroptionalmin 50 ยท max 500
install_vserver_appInstall a One-Click App on a VPS (queued, takes a few minutes; check with get_vserver_apps). Follow the catalog entry's install guidance first. Requires confirm=true.
vserver.apps.manageserviceIdstringrequiredID of the VPS: the "id" field from list_account_services or list_vservers (e.g. "cmabc123..."). The numericId shown in the panel (e.g. "180") is accepted too. IDs of other service types do not work here.
catalogTypestringrequiredCatalog type from the app catalog.
max length 128
displayNamestringrequiredmin length 2 ยท max length 80
envValuesRecord<string, string>optionalNon-secret catalog fields only (see the catalog entry's install.requiredCustomerEnvFields).
customEnvsobject[]optionalmax items 50
confirmbooleanoptionalwithoutHostnamebooleanoptionalSkip the default HTTPS zap.cloud address (only when the user wants no domain).
manage_vserver_appStart, stop or restart an installed One-Click App on a VPS. Requires confirm=true.
vserver.apps.manageserviceIdstringrequiredID of the VPS: the "id" field from list_account_services or list_vservers (e.g. "cmabc123..."). The numericId shown in the panel (e.g. "180") is accepted too. IDs of other service types do not work here.
installationIdstringrequiredInstallation id from get_vserver_apps / get_dedicated_apps.
max length 64
action"start" | "stop" | "restart"requiredconfirmbooleanoptionaluninstall_vserver_appUninstall a One-Click App from a VPS. Keeps the app data unless deleteVolumes=true. Requires confirm=true.
vserver.apps.manageserviceIdstringrequiredID of the VPS: the "id" field from list_account_services or list_vservers (e.g. "cmabc123..."). The numericId shown in the panel (e.g. "180") is accepted too. IDs of other service types do not work here.
installationIdstringrequiredInstallation id from get_vserver_apps / get_dedicated_apps.
max length 64
deleteVolumesbooleanoptionalAlso delete the app's persistent data (volumes). Only when the user explicitly asked for it; default keeps the data.
confirmbooleanoptionalreinstall_vserver_appReinstall a One-Click App on a VPS (redeploys it; keeps the data unless deleteVolumes=true). Requires confirm=true.
vserver.apps.manageserviceIdstringrequiredID of the VPS: the "id" field from list_account_services or list_vservers (e.g. "cmabc123..."). The numericId shown in the panel (e.g. "180") is accepted too. IDs of other service types do not work here.
installationIdstringrequiredInstallation id from get_vserver_apps / get_dedicated_apps.
max length 64
deleteVolumesbooleanoptionalAlso delete the app's persistent data (volumes). Only when the user explicitly asked for it; default keeps the data.
confirmbooleanoptionalget_dedicated_appsOne-Click Apps (Coolify apps such as Pterodactyl, Nextcloud, n8n, Uptime Kuma) on a dedicated server: setup status, installed apps with status and access URL, whether apps can be installed. No passwords are returned. live=true asks the panel for the current status.
dedicated.apps.readserviceIdstringrequiredID of the Dedicated server: the "id" field from list_account_services or list_dedicated_servers (e.g. "cmabc123..."). The numericId shown in the panel (e.g. "180") is accepted too. IDs of other service types do not work here.
livebooleanoptionalAsk the panel for the live status (slower; needs the manage permission), default the stored status.
list_dedicated_app_catalogSearch the One-Click Apps catalog for a dedicated server (name, description, category, paged). Use the type with get_dedicated_app_catalog_entry before installing.
dedicated.apps.readserviceIdstringrequiredID of the Dedicated server: the "id" field from list_account_services or list_dedicated_servers (e.g. "cmabc123..."). The numericId shown in the panel (e.g. "180") is accepted too. IDs of other service types do not work here.
searchstringoptionalFree text search over name, description and tags.
max length 200
categorystringoptionalmax length 100
pageintegeroptional> 0 ยท max 9007199254740991
pageSizeintegeroptional> 0 ยท max 50
get_dedicated_app_catalog_entryOne catalog app with its install fields and install guidance (which values to ask the user for; apps that need a secret can only be installed in the dashboard).
dedicated.apps.readserviceIdstringrequiredID of the Dedicated server: the "id" field from list_account_services or list_dedicated_servers (e.g. "cmabc123..."). The numericId shown in the panel (e.g. "180") is accepted too. IDs of other service types do not work here.
catalogTypestringrequiredmax length 128
get_dedicated_app_logsRecent container logs of an installed One-Click App on a dedicated server (secrets and login links removed). Read them before suggesting a restart.
dedicated.apps.readserviceIdstringrequiredID of the Dedicated server: the "id" field from list_account_services or list_dedicated_servers (e.g. "cmabc123..."). The numericId shown in the panel (e.g. "180") is accepted too. IDs of other service types do not work here.
installationIdstringrequiredInstallation id from get_vserver_apps / get_dedicated_apps.
max length 64
linesintegeroptionalmin 50 ยท max 500
install_dedicated_appInstall a One-Click App on a dedicated server (queued, takes a few minutes; check with get_dedicated_apps). Follow the catalog entry's install guidance first. Requires confirm=true.
dedicated.apps.manageserviceIdstringrequiredID of the Dedicated server: the "id" field from list_account_services or list_dedicated_servers (e.g. "cmabc123..."). The numericId shown in the panel (e.g. "180") is accepted too. IDs of other service types do not work here.
catalogTypestringrequiredCatalog type from the app catalog.
max length 128
displayNamestringrequiredmin length 2 ยท max length 80
envValuesRecord<string, string>optionalNon-secret catalog fields only (see the catalog entry's install.requiredCustomerEnvFields).
customEnvsobject[]optionalmax items 50
confirmbooleanoptionalmanage_dedicated_appStart, stop or restart an installed One-Click App on a dedicated server. Requires confirm=true.
dedicated.apps.manageserviceIdstringrequiredID of the Dedicated server: the "id" field from list_account_services or list_dedicated_servers (e.g. "cmabc123..."). The numericId shown in the panel (e.g. "180") is accepted too. IDs of other service types do not work here.
installationIdstringrequiredInstallation id from get_vserver_apps / get_dedicated_apps.
max length 64
action"start" | "stop" | "restart"requiredconfirmbooleanoptionaluninstall_dedicated_appUninstall a One-Click App from a dedicated server. Keeps the app data unless deleteVolumes=true. Requires confirm=true.
dedicated.apps.manageserviceIdstringrequiredID of the Dedicated server: the "id" field from list_account_services or list_dedicated_servers (e.g. "cmabc123..."). The numericId shown in the panel (e.g. "180") is accepted too. IDs of other service types do not work here.
installationIdstringrequiredInstallation id from get_vserver_apps / get_dedicated_apps.
max length 64
deleteVolumesbooleanoptionalAlso delete the app's persistent data (volumes). Only when the user explicitly asked for it; default keeps the data.
confirmbooleanoptionalreinstall_dedicated_appReinstall a One-Click App on a dedicated server (redeploys it; keeps the data unless deleteVolumes=true). Requires confirm=true.
dedicated.apps.manageserviceIdstringrequiredID of the Dedicated server: the "id" field from list_account_services or list_dedicated_servers (e.g. "cmabc123..."). The numericId shown in the panel (e.g. "180") is accepted too. IDs of other service types do not work here.
installationIdstringrequiredInstallation id from get_vserver_apps / get_dedicated_apps.
max length 64
deleteVolumesbooleanoptionalAlso delete the app's persistent data (volumes). Only when the user explicitly asked for it; default keeps the data.
confirmbooleanoptionalCreate, restore and delete backups and snapshots.
list_gameserver_backupsList gameserver backups.
gameserver.backups.readserviceIdstringrequiredID 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.
create_gameserver_backupCreate a gameserver backup. Requires confirm=true.
gameserver.backups.manageserviceIdstringrequiredID 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.
namestringoptionalmax length 120
confirmbooleanoptionaldelete_gameserver_backupDelete a gameserver backup. Requires confirm=true.
gameserver.backups.manageserviceIdstringrequiredID 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.
backupIdstringrequiredconfirmbooleanoptionalrestore_gameserver_backupRestore a gameserver backup. Requires confirm=true.
gameserver.backups.manageserviceIdstringrequiredID 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.
backupIdstringrequiredconfirmbooleanoptionallist_vserver_backupsList VPS backups.
vserver.backups.readserviceIdstringrequiredID of the VPS: the "id" field from list_account_services or list_vservers (e.g. "cmabc123..."). The numericId shown in the panel (e.g. "180") is accepted too. IDs of other service types do not work here.
list_vserver_snapshotsList VPS VM snapshots.
vserver.backups.readserviceIdstringrequiredID of the VPS: the "id" field from list_account_services or list_vservers (e.g. "cmabc123..."). The numericId shown in the panel (e.g. "180") is accepted too. IDs of other service types do not work here.
create_vserver_snapshotCreate a VPS VM snapshot. Requires confirm=true.
vserver.backups.manageserviceIdstringrequiredID of the VPS: the "id" field from list_account_services or list_vservers (e.g. "cmabc123..."). The numericId shown in the panel (e.g. "180") is accepted too. IDs of other service types do not work here.
namestringrequireddescriptionstringoptionalincludeRambooleanoptionalconfirmbooleanoptionaldelete_vserver_snapshotDelete a VPS VM snapshot. Requires confirm=true.
vserver.backups.manageserviceIdstringrequiredID of the VPS: the "id" field from list_account_services or list_vservers (e.g. "cmabc123..."). The numericId shown in the panel (e.g. "180") is accepted too. IDs of other service types do not work here.
namestringrequiredconfirmbooleanoptionalrollback_vserver_snapshotRoll back a VPS to a named snapshot. Requires confirm=true.
vserver.backups.manageserviceIdstringrequiredID of the VPS: the "id" field from list_account_services or list_vservers (e.g. "cmabc123..."). The numericId shown in the panel (e.g. "180") is accepted too. IDs of other service types do not work here.
namestringrequiredconfirmbooleanoptionalcreate_vserver_backupCreate a VPS backup. Requires confirm=true.
vserver.backups.manageserviceIdstringrequiredID of the VPS: the "id" field from list_account_services or list_vservers (e.g. "cmabc123..."). The numericId shown in the panel (e.g. "180") is accepted too. IDs of other service types do not work here.
notesstringoptionalmax length 500
confirmbooleanoptionaldelete_vserver_backupDelete a VPS backup. Requires confirm=true.
vserver.backups.manageserviceIdstringrequiredID of the VPS: the "id" field from list_account_services or list_vservers (e.g. "cmabc123..."). The numericId shown in the panel (e.g. "180") is accepted too. IDs of other service types do not work here.
backupIdstringrequiredconfirmbooleanoptionalrestore_vserver_backupRestore a VPS backup. Requires confirm=true.
vserver.backups.manageserviceIdstringrequiredID of the VPS: the "id" field from list_account_services or list_vservers (e.g. "cmabc123..."). The numericId shown in the panel (e.g. "180") is accepted too. IDs of other service types do not work here.
backupIdstringrequiredconfirmbooleanoptionalUpgrades and downgrades with a price preview, applied only after your explicit confirmation.
get_gameserver_plan_change_optionsList available gameserver plan-change targets (packages and custom constraints) for a service. Use preview_gameserver_plan_change for the full change overview with pricing before applying.
Ordering and plan changes are hidden in the connectors from the ChatGPT and Claude app directories. The tool is available in Claude Code, Cursor and with an API key.
gameserver.plan_changeserviceIdstringrequiredID 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.
preview_gameserver_plan_changeReturn a read-only overview of the planned gameserver package/configuration change: current vs. target resources, pricing (recurring old/new, delta, immediate charges or credits, billing period), blockers, migration requirements, and a one-time previewConfirmationNonce when allowed. Read-only. Never call apply_* in the same assistant turn. After preview, you MUST send a user-visible message that includes old price, new price, delta, and immediate charge or credit from confirmation.pricingSummary. Then STOP and wait for an explicit user reply (for example 'Ja') in a NEW turn. A user request like 'upgrade to 3 GB' only authorizes preview, not apply. Pass couponCode only when the user gave you a coupon code for this upgrade (never guess or invent one): an accepted code is shown as pricing.couponCode / pricing.couponDiscountCents and is already subtracted from the immediate charge; a refused code makes the preview not allowed with coupon.error -- tell the user why and preview again without the code if they want to continue.
Ordering and plan changes are hidden in the connectors from the ChatGPT and Claude app directories. The tool is available in Claude Code, Cursor and with an API key.
gameserver.plan_changeserviceIdstringrequiredID 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.
targetobjectoptionaltarget.pricingMode"package" | "custom"optionaltarget.targetPackageKeystringoptionaltarget.ramMbintegeroptional> 0 ยท max 9007199254740991
target.cpuMillisintegeroptional> 0 ยท max 9007199254740991
target.diskMbintegeroptional> 0 ยท max 9007199254740991
target.slotsintegeroptional> 0 ยท max 9007199254740991
target.dedicatedIpbooleanoptionaltarget.premiumCpubooleanoptionalPremium CPU option (higher CPU priority under load, +66 % on the gameserver price). Omit to keep the booked value; only offered when plan-change-options capabilities.supportsPremiumCpu is true.
target.targetRegionIdstringoptionaltarget.targetBillingIntervalCountintegeroptional> 0 ยท max 9007199254740991
couponCodestringoptionalOptional shop coupon code the user typed for this upgrade. Only pass a code the user explicitly gave you in this conversation; never guess, invent, reuse from elsewhere or try codes. It only reduces the amount charged now for an upgrade (pricing.couponDiscountCents, coupon.error when refused). Apply must send exactly the same couponCode as the preview whose nonce it uses.
max length 100
apply_gameserver_plan_changeExecute a gameserver upgrade or downgrade after the user has explicitly confirmed a matching preview_gameserver_plan_change result. NEVER call in the same turn as preview_*. Requires confirm=true, userExplicitlyConfirmed=true, and previewConfirmationNonce from the matching preview_* result, plus the same target and the same couponCode as that preview (omit couponCode if the preview had none). Only call after the user explicitly confirmed the exact pricing summary you showed. When the preview has requiresImmediateStartRequest: true (paid upgrade), also tell the user they ask ZAP-Hosting to start the upgrade right away and owe compensation for the days used if they withdraw the upgrade within 14 days; pass requestImmediateStart=true only if they expressly agreed to that. If apply returns PREVIEW_CONFIRMATION_TOO_EARLY, wait until details.earliestApplyAt (or confirmation.earliestApplyAt from preview) and call apply again; this short safety delay needs no explanation to the user. Triggers billing and infrastructure changes.
Ordering and plan changes are hidden in the connectors from the ChatGPT and Claude app directories. The tool is available in Claude Code, Cursor and with an API key.
gameserver.plan_changeserviceIdstringrequiredID 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.
targetobjectoptionaltarget.pricingMode"package" | "custom"optionaltarget.targetPackageKeystringoptionaltarget.ramMbintegeroptional> 0 ยท max 9007199254740991
target.cpuMillisintegeroptional> 0 ยท max 9007199254740991
target.diskMbintegeroptional> 0 ยท max 9007199254740991
target.slotsintegeroptional> 0 ยท max 9007199254740991
target.dedicatedIpbooleanoptionaltarget.premiumCpubooleanoptionalPremium CPU option (higher CPU priority under load, +66 % on the gameserver price). Omit to keep the booked value; only offered when plan-change-options capabilities.supportsPremiumCpu is true.
target.targetRegionIdstringoptionaltarget.targetBillingIntervalCountintegeroptional> 0 ยท max 9007199254740991
couponCodestringoptionalOptional shop coupon code the user typed for this upgrade. Only pass a code the user explicitly gave you in this conversation; never guess, invent, reuse from elsewhere or try codes. It only reduces the amount charged now for an upgrade (pricing.couponDiscountCents, coupon.error when refused). Apply must send exactly the same couponCode as the preview whose nonce it uses.
max length 100
confirmtruerequireduserExplicitlyConfirmedtruerequiredpreviewConfirmationNoncestringrequiredrequestImmediateStartbooleanoptionalExpress request of the user to start the upgraded service right away (ยง 357a (2) BGB): they owe compensation for the days used if they later withdraw the upgrade. Set true ONLY when the user expressly agreed to exactly that in this conversation after you told them; never set it on your own. Required for a paid upgrade when the preview says requiresImmediateStartRequest: true, otherwise apply is refused with PLAN_CHANGE_EARLY_START_REQUIRED and nothing is charged. Ignored for downgrades and free changes.
get_vserver_plan_change_optionsList the packages a VPS (vServer) can be upgraded or downgraded to (plan-change targets and custom resource constraints such as CPU cores, RAM and disk). Start here when the user wants a bigger or smaller VPS. Use preview_vserver_plan_change for the full change overview with pricing before applying.
vserver.plan_changeserviceIdstringrequiredID of the VPS: the "id" field from list_account_services or list_vservers (e.g. "cmabc123..."). The numericId shown in the panel (e.g. "180") is accepted too. IDs of other service types do not work here.
preview_vserver_plan_changeReturn a read-only overview of the planned VPS package/configuration change: current vs. target resources, pricing (recurring old/new, delta, immediate charges or credits, billing period), blockers, migration requirements, and a one-time previewConfirmationNonce when allowed. Read-only. Never call apply_* in the same assistant turn. After preview, you MUST send a user-visible message that includes old price, new price, delta, and immediate charge or credit from confirmation.pricingSummary. Then STOP and wait for an explicit user reply (for example 'Ja') in a NEW turn. A user request like 'upgrade to 3 GB' only authorizes preview, not apply. Pass couponCode only when the user gave you a coupon code for this upgrade (never guess or invent one): an accepted code is shown as pricing.couponCode / pricing.couponDiscountCents and is already subtracted from the immediate charge; a refused code makes the preview not allowed with coupon.error -- tell the user why and preview again without the code if they want to continue.
vserver.plan_changeserviceIdstringrequiredID of the VPS: the "id" field from list_account_services or list_vservers (e.g. "cmabc123..."). The numericId shown in the panel (e.g. "180") is accepted too. IDs of other service types do not work here.
targetobjectoptionaltarget.pricingMode"package" | "custom"optionalSet "custom" to change cores, memoryMb, diskGb or bandwidthMbps on a package VPS (otherwise the request is rejected); use targetPackageKey to switch package.
target.targetPackageKeystringoptionaltarget.coresintegeroptional> 0 ยท max 9007199254740991
target.memoryMbintegeroptional> 0 ยท max 9007199254740991
target.diskGbintegeroptional> 0 ยท max 9007199254740991
target.bandwidthMbpsintegeroptional> 0 ยท max 9007199254740991
target.memoryintegeroptional> 0 ยท max 9007199254740991
target.diskintegeroptional> 0 ยท max 9007199254740991
target.bandwidthintegeroptional> 0 ยท max 9007199254740991
target.additionalIpCountintegeroptionalmin 0 ยท max 9007199254740991
target.targetBillingIntervalCountintegeroptional> 0 ยท max 9007199254740991
couponCodestringoptionalOptional shop coupon code the user typed for this upgrade. Only pass a code the user explicitly gave you in this conversation; never guess, invent, reuse from elsewhere or try codes. It only reduces the amount charged now for an upgrade (pricing.couponDiscountCents, coupon.error when refused). Apply must send exactly the same couponCode as the preview whose nonce it uses.
max length 100
apply_vserver_plan_changeExecute a VPS upgrade or downgrade after the user has explicitly confirmed a matching preview_vserver_plan_change result. NEVER call in the same turn as preview_*. Requires confirm=true, userExplicitlyConfirmed=true, and previewConfirmationNonce from the matching preview_* result, plus the same target and the same couponCode as that preview (omit couponCode if the preview had none). Only call after the user explicitly confirmed the exact pricing summary you showed. When the preview has requiresImmediateStartRequest: true (paid upgrade), also tell the user they ask ZAP-Hosting to start the upgrade right away and owe compensation for the days used if they withdraw the upgrade within 14 days; pass requestImmediateStart=true only if they expressly agreed to that. If apply returns PREVIEW_CONFIRMATION_TOO_EARLY, wait until details.earliestApplyAt (or confirmation.earliestApplyAt from preview) and call apply again; this short safety delay needs no explanation to the user. Triggers billing and infrastructure changes.
vserver.plan_changeserviceIdstringrequiredID of the VPS: the "id" field from list_account_services or list_vservers (e.g. "cmabc123..."). The numericId shown in the panel (e.g. "180") is accepted too. IDs of other service types do not work here.
targetobjectoptionaltarget.pricingMode"package" | "custom"optionalSet "custom" to change cores, memoryMb, diskGb or bandwidthMbps on a package VPS (otherwise the request is rejected); use targetPackageKey to switch package.
target.targetPackageKeystringoptionaltarget.coresintegeroptional> 0 ยท max 9007199254740991
target.memoryMbintegeroptional> 0 ยท max 9007199254740991
target.diskGbintegeroptional> 0 ยท max 9007199254740991
target.bandwidthMbpsintegeroptional> 0 ยท max 9007199254740991
target.memoryintegeroptional> 0 ยท max 9007199254740991
target.diskintegeroptional> 0 ยท max 9007199254740991
target.bandwidthintegeroptional> 0 ยท max 9007199254740991
target.additionalIpCountintegeroptionalmin 0 ยท max 9007199254740991
target.targetBillingIntervalCountintegeroptional> 0 ยท max 9007199254740991
couponCodestringoptionalOptional shop coupon code the user typed for this upgrade. Only pass a code the user explicitly gave you in this conversation; never guess, invent, reuse from elsewhere or try codes. It only reduces the amount charged now for an upgrade (pricing.couponDiscountCents, coupon.error when refused). Apply must send exactly the same couponCode as the preview whose nonce it uses.
max length 100
confirmtruerequireduserExplicitlyConfirmedtruerequiredpreviewConfirmationNoncestringrequiredrequestImmediateStartbooleanoptionalExpress request of the user to start the upgraded service right away (ยง 357a (2) BGB): they owe compensation for the days used if they later withdraw the upgrade. Set true ONLY when the user expressly agreed to exactly that in this conversation after you told them; never set it on your own. Required for a paid upgrade when the preview says requiresImmediateStartRequest: true, otherwise apply is refused with PLAN_CHANGE_EARLY_START_REQUIRED and nothing is charged. Ignored for downgrades and free changes.
get_teamspeak_plan_change_optionsList available TeamSpeak plan-change options and constraints for a service. Use preview_teamspeak_plan_change for the full change overview with pricing before applying.
Ordering and plan changes are hidden in the connectors from the ChatGPT and Claude app directories. The tool is available in Claude Code, Cursor and with an API key.
teamspeak.plan_changeserviceIdstringrequiredID of the TeamSpeak server: the "id" field from list_account_services or list_teamspeak_servers (e.g. "cmabc123..."). The numericId shown in the panel (e.g. "180") is accepted too. IDs of other service types do not work here.
preview_teamspeak_plan_changeReturn a read-only overview of the planned TeamSpeak slot/billing change: current vs. target configuration, pricing (recurring old/new, delta, immediate charges or credits, billing period), blockers, and a one-time previewConfirmationNonce when allowed. Read-only. Never call apply_* in the same assistant turn. After preview, you MUST send a user-visible message that includes old price, new price, delta, and immediate charge or credit from confirmation.pricingSummary. Then STOP and wait for an explicit user reply (for example 'Ja') in a NEW turn. A user request like 'upgrade to 3 GB' only authorizes preview, not apply. Pass couponCode only when the user gave you a coupon code for this upgrade (never guess or invent one): an accepted code is shown as pricing.couponCode / pricing.couponDiscountCents and is already subtracted from the immediate charge; a refused code makes the preview not allowed with coupon.error -- tell the user why and preview again without the code if they want to continue.
Ordering and plan changes are hidden in the connectors from the ChatGPT and Claude app directories. The tool is available in Claude Code, Cursor and with an API key.
teamspeak.plan_changeserviceIdstringrequiredID of the TeamSpeak server: the "id" field from list_account_services or list_teamspeak_servers (e.g. "cmabc123..."). The numericId shown in the panel (e.g. "180") is accepted too. IDs of other service types do not work here.
targetobjectoptionaltarget.pricingMode"package" | "custom"optionalSet "custom" to change slots on a package TeamSpeak server (otherwise the request is rejected); use targetPackageKey to switch package.
target.targetPackageKeystringoptionaltarget.slotsintegeroptional> 0 ยท max 9007199254740991
target.hasAdvertisementbooleanoptionaltarget.targetBillingIntervalCountintegeroptional> 0 ยท max 9007199254740991
couponCodestringoptionalOptional shop coupon code the user typed for this upgrade. Only pass a code the user explicitly gave you in this conversation; never guess, invent, reuse from elsewhere or try codes. It only reduces the amount charged now for an upgrade (pricing.couponDiscountCents, coupon.error when refused). Apply must send exactly the same couponCode as the preview whose nonce it uses.
max length 100
apply_teamspeak_plan_changeExecute a TeamSpeak upgrade or downgrade after the user has explicitly confirmed a matching preview_teamspeak_plan_change result. NEVER call in the same turn as preview_*. Requires confirm=true, userExplicitlyConfirmed=true, and previewConfirmationNonce from the matching preview_* result, plus the same target and the same couponCode as that preview (omit couponCode if the preview had none). Only call after the user explicitly confirmed the exact pricing summary you showed. When the preview has requiresImmediateStartRequest: true (paid upgrade), also tell the user they ask ZAP-Hosting to start the upgrade right away and owe compensation for the days used if they withdraw the upgrade within 14 days; pass requestImmediateStart=true only if they expressly agreed to that. If apply returns PREVIEW_CONFIRMATION_TOO_EARLY, wait until details.earliestApplyAt (or confirmation.earliestApplyAt from preview) and call apply again; this short safety delay needs no explanation to the user. Triggers billing and infrastructure changes.
Ordering and plan changes are hidden in the connectors from the ChatGPT and Claude app directories. The tool is available in Claude Code, Cursor and with an API key.
teamspeak.plan_changeserviceIdstringrequiredID of the TeamSpeak server: the "id" field from list_account_services or list_teamspeak_servers (e.g. "cmabc123..."). The numericId shown in the panel (e.g. "180") is accepted too. IDs of other service types do not work here.
targetobjectoptionaltarget.pricingMode"package" | "custom"optionalSet "custom" to change slots on a package TeamSpeak server (otherwise the request is rejected); use targetPackageKey to switch package.
target.targetPackageKeystringoptionaltarget.slotsintegeroptional> 0 ยท max 9007199254740991
target.hasAdvertisementbooleanoptionaltarget.targetBillingIntervalCountintegeroptional> 0 ยท max 9007199254740991
couponCodestringoptionalOptional shop coupon code the user typed for this upgrade. Only pass a code the user explicitly gave you in this conversation; never guess, invent, reuse from elsewhere or try codes. It only reduces the amount charged now for an upgrade (pricing.couponDiscountCents, coupon.error when refused). Apply must send exactly the same couponCode as the preview whose nonce it uses.
max length 100
confirmtruerequireduserExplicitlyConfirmedtruerequiredpreviewConfirmationNoncestringrequiredrequestImmediateStartbooleanoptionalExpress request of the user to start the upgraded service right away (ยง 357a (2) BGB): they owe compensation for the days used if they later withdraw the upgrade. Set true ONLY when the user expressly agreed to exactly that in this conversation after you told them; never set it on your own. Required for a paid upgrade when the preview says requiresImmediateStartRequest: true, otherwise apply is refused with PLAN_CHANGE_EARLY_START_REQUIRED and nothing is charged. Ignored for downgrades and free changes.
get_dedicated_plan_change_optionsList available dedicated-server IP plan-change options and constraints for a service. Hardware changes are not supported. Use preview_dedicated_plan_change for the full change overview with pricing before applying.
Ordering and plan changes are hidden in the connectors from the ChatGPT and Claude app directories. The tool is available in Claude Code, Cursor and with an API key.
dedicated.plan_changeserviceIdstringrequiredID of the Dedicated server: the "id" field from list_account_services or list_dedicated_servers (e.g. "cmabc123..."). The numericId shown in the panel (e.g. "180") is accepted too. IDs of other service types do not work here.
preview_dedicated_plan_changeReturn a read-only overview of the planned dedicated-server additional IPv4 count change: current vs. target IP configuration, pricing (recurring old/new, delta, immediate charges or credits, billing period), blockers, releasable assignments, and a one-time previewConfirmationNonce when allowed. Read-only. Never call apply_* in the same assistant turn. After preview, you MUST send a user-visible message that includes old price, new price, delta, and immediate charge or credit from confirmation.pricingSummary. Then STOP and wait for an explicit user reply (for example 'Ja') in a NEW turn. A user request like 'upgrade to 3 GB' only authorizes preview, not apply. Pass couponCode only when the user gave you a coupon code for this upgrade (never guess or invent one): an accepted code is shown as pricing.couponCode / pricing.couponDiscountCents and is already subtracted from the immediate charge; a refused code makes the preview not allowed with coupon.error -- tell the user why and preview again without the code if they want to continue.
Ordering and plan changes are hidden in the connectors from the ChatGPT and Claude app directories. The tool is available in Claude Code, Cursor and with an API key.
dedicated.plan_changeserviceIdstringrequiredID of the Dedicated server: the "id" field from list_account_services or list_dedicated_servers (e.g. "cmabc123..."). The numericId shown in the panel (e.g. "180") is accepted too. IDs of other service types do not work here.
targetobjectoptionaltarget.additionalIpCountintegeroptionalmin 0 ยท max 9007199254740991
target.releaseIpAssignmentIdsstring[]optionalcouponCodestringoptionalOptional shop coupon code the user typed for this upgrade. Only pass a code the user explicitly gave you in this conversation; never guess, invent, reuse from elsewhere or try codes. It only reduces the amount charged now for an upgrade (pricing.couponDiscountCents, coupon.error when refused). Apply must send exactly the same couponCode as the preview whose nonce it uses.
max length 100
apply_dedicated_plan_changeExecute a dedicated-server additional IPv4 upgrade or downgrade after the user has explicitly confirmed a matching preview_dedicated_plan_change result. Downgrades require releaseIpAssignmentIds. NEVER call in the same turn as preview_*. Requires confirm=true, userExplicitlyConfirmed=true, and previewConfirmationNonce from the matching preview_* result, plus the same target and the same couponCode as that preview (omit couponCode if the preview had none). Only call after the user explicitly confirmed the exact pricing summary you showed. When the preview has requiresImmediateStartRequest: true (paid upgrade), also tell the user they ask ZAP-Hosting to start the upgrade right away and owe compensation for the days used if they withdraw the upgrade within 14 days; pass requestImmediateStart=true only if they expressly agreed to that. If apply returns PREVIEW_CONFIRMATION_TOO_EARLY, wait until details.earliestApplyAt (or confirmation.earliestApplyAt from preview) and call apply again; this short safety delay needs no explanation to the user. Triggers billing and infrastructure changes.
Ordering and plan changes are hidden in the connectors from the ChatGPT and Claude app directories. The tool is available in Claude Code, Cursor and with an API key.
dedicated.plan_changeserviceIdstringrequiredID of the Dedicated server: the "id" field from list_account_services or list_dedicated_servers (e.g. "cmabc123..."). The numericId shown in the panel (e.g. "180") is accepted too. IDs of other service types do not work here.
targetobjectoptionaltarget.additionalIpCountintegeroptionalmin 0 ยท max 9007199254740991
target.releaseIpAssignmentIdsstring[]optionalcouponCodestringoptionalOptional shop coupon code the user typed for this upgrade. Only pass a code the user explicitly gave you in this conversation; never guess, invent, reuse from elsewhere or try codes. It only reduces the amount charged now for an upgrade (pricing.couponDiscountCents, coupon.error when refused). Apply must send exactly the same couponCode as the preview whose nonce it uses.
max length 100
confirmtruerequireduserExplicitlyConfirmedtruerequiredpreviewConfirmationNoncestringrequiredrequestImmediateStartbooleanoptionalExpress request of the user to start the upgraded service right away (ยง 357a (2) BGB): they owe compensation for the days used if they later withdraw the upgrade. Set true ONLY when the user expressly agreed to exactly that in this conversation after you told them; never set it on your own. Required for a paid upgrade when the preview says requiresImmediateStartRequest: true, otherwise apply is refused with PLAN_CHANGE_EARLY_START_REQUIRED and nothing is charged. Ignored for downgrades and free changes.
get_plan_change_statusPoll the status of a service plan change by change ID after a confirmed apply_* call (billing commit, queue, and infrastructure apply).
gameserver.plan_changevserver.plan_changeteamspeak.plan_changededicated.plan_changechangeIdstringrequiredOrderable products, plans, regions, games and ISO images, plus the price preview of an order.
list_orderable_productsList the products that can be ordered (catalog, read-only). Read-only catalog: nothing is ordered or charged. To order, price the configuration with preview_order first.
Ordering and plan changes are hidden in the connectors from the ChatGPT and Claude app directories. The tool is available in Claude Code, Cursor and with an API key.
orders.viewNo parameters
list_orderable_plansList the plans, billing cycles, prices and resource options of one orderable product (catalog, read-only). Read-only catalog: nothing is ordered or charged. To order, price the configuration with preview_order first.
Ordering and plan changes are hidden in the connectors from the ChatGPT and Claude app directories. The tool is available in Claude Code, Cursor and with an API key.
orders.viewproductSlugstringrequiredProduct slug from list_orderable_products, e.g. the productSlug field of a product.
list_orderable_product_regionsList the regions in which one orderable product can be ordered (catalog, read-only). Read-only catalog: nothing is ordered or charged. To order, price the configuration with preview_order first.
Ordering and plan changes are hidden in the connectors from the ChatGPT and Claude app directories. The tool is available in Claude Code, Cursor and with an API key.
orders.viewproductSlugstringrequiredProduct slug from list_orderable_products, e.g. the productSlug field of a product.
list_order_regionsList all regions that are used by orderable products (catalog, read-only). Read-only catalog: nothing is ordered or charged. To order, price the configuration with preview_order first.
Ordering and plan changes are hidden in the connectors from the ChatGPT and Claude app directories. The tool is available in Claude Code, Cursor and with an API key.
orders.viewNo parameters
list_orderable_gamesList the games for which a gameserver can be ordered (catalog, read-only). Read-only catalog: nothing is ordered or charged. To order, price the configuration with preview_order first.
Ordering and plan changes are hidden in the connectors from the ChatGPT and Claude app directories. The tool is available in Claude Code, Cursor and with an API key.
orders.viewNo parameters
list_vserver_order_isosList the catalog ISO images a VPS can be ordered with, per region (catalog, read-only). Read-only catalog: nothing is ordered or charged. To order, price the configuration with preview_order first.
Ordering and plan changes are hidden in the connectors from the ChatGPT and Claude app directories. The tool is available in Claude Code, Cursor and with an API key.
orders.viewNo parameters
preview_orderPreview an order: checks the combination of product, plan, billing cycle, region and options, and returns the price breakdown and any blockingReasons. Nothing is ordered, reserved or charged. When this connection may order (permission orders.create) and the order is allowed, it also returns confirmation (confirmationCode, chargeSummary, valid 10 minutes) for create_order; otherwise ordering.reason says why not.
Ordering and plan changes are hidden in the connectors from the ChatGPT and Claude app directories. The tool is available in Claude Code, Cursor and with an API key.
orders.viewproductSlugstringrequiredProduct slug from list_orderable_products.
billingCycleSlug"3-day" | "monthly" | "quarterly" | "semi-annual" | "annual"requiredBilling cycle: 3-day, monthly, quarterly, semi-annual or annual.
planSlugstringoptionalPlan slug from list_orderable_plans (products with fixed plans).
gameSlugstringoptionalGame slug from list_orderable_games (gameservers).
regionSlugstringoptionalRegion slug from list_orderable_product_regions (products with region choice).
resourceConfigRecord<string, number>optionalResource values for configurable products, keyed as listed by list_orderable_plans.
optionsobjectoptionaloptions.couponCodestringoptionaloptions.dedicatedIpCountintegeroptionalmin 0 ยท max 9007199254740991
options.domainAttachmentobjectoptionalconfigurationRecord<string, any>optionalProduct-specific configuration, same shape as the REST order body.
domainsobject[]optionalget_order_statusStatus of one order of this account (payment, items, the services it created). Use it after create_order to follow the setup, or to check whether an order went through before ordering again. Read-only.
Ordering and plan changes are hidden in the connectors from the ChatGPT and Claude app directories. The tool is available in Claude Code, Cursor and with an API key.
orders.vieworderIdstringrequiredorderId returned by create_order (or an order id from the dashboard).
create_orderPlace a PAID order that preview_order priced, using its confirmation.confirmationCode. Charges the payment method saved in the user's ZapX account and creates a subscription that renews until cancelled. Requires confirm=true and userExplicitlyConfirmed=true. Only call this after showing the user confirmation.chargeSummary and getting their explicit yes to this exact order; never on your own initiative. The code orders exactly the previewed configuration; to change anything, run preview_order again. Refused when the price changed since the preview, without a saved payment method, or above the daily limit of orders through the MCP. Retrying with the same code never orders twice. If the bank asks for a confirmation (3-D Secure), the result contains paymentActionUrl for the user.
Ordering and plan changes are hidden in the connectors from the ChatGPT and Claude app directories. The tool is available in Claude Code, Cursor and with an API key.
orders.createconfirmationCodestringrequiredconfirmation.confirmationCode from preview_order. It stands for exactly the previewed order; nothing else can be ordered with it.
confirmtruerequiredMust be true. Same confirm=true every state-changing MCP tool requires; set it only together with userExplicitlyConfirmed=true.
userExplicitlyConfirmedbooleanrequiredtrue only after the user explicitly agreed to this order and its price in the conversation (e.g. replied "yes" to the shown confirmation.chargeSummary).
requestImmediateStartbooleanoptionaltrue only if the user also expressly agreed to confirmation.immediateStartNotice (start right away, compensation for used days on withdrawal). Required for most paid orders; without it the order is refused with WITHDRAWAL_EARLY_START_REQUIRED.
Your AI client reports bugs or missing features of the MCP tools straight to us.
report_mcp_feedbackReport a problem with THIS MCP server (ZAP-Hosting / ZapX) to its developers. Use it only after a real problem with these tools: kind=bug when a tool failed or returned something wrong although the input looked right; kind=missing_capability when the user asked for something no tool here can do; kind=unclear_tool_description when a tool's description or parameters misled you; kind=improvement for a concrete suggestion that would have made the task easier. Do NOT use it for the user's own support requests (problems with their server, billing, orders): the user opens a support ticket for those. Never include passwords, tokens, API keys, file contents, personal data or other secrets in summary, details or exampleArgs. Nothing is changed on any service. The result only confirms that the report was received; do not tell the user it was fixed.
kind"bug" | "missing_capability" | "unclear_tool_description" | "improvement"requiredsummarystringrequiredOne sentence: what went wrong or what is missing.
min length 5 ยท max length 200
detailsstringoptionalWhat you tried, what you expected and what happened (error text). No secrets or file contents.
max length 4000
relatedToolstringoptionalName of the tool the report is about, if any (e.g. get_gameserver).
max length 100
exampleArgsRecord<string, any>optionalOptional arguments of the failing call, without secrets.