Zum Inhalt springen

MCP

Alle MCP-Tools

Jedes Tool, das dein KI-Client über den ZapX MCP-Server aufrufen kann, mit Parametern, benötigter Berechtigung und Verhalten. Die Liste wird direkt aus dem Server erzeugt und ist dadurch immer aktuell.

224 Tools in 13 Gruppen · in jedem ZapX Pass enthalten

MCP einrichtenREST-API-Referenz
Endpunkthttps://zap-hosting.com/api/mcpJSONMarkdown für LLMs
Tool-Namen, Titel und Beschreibungen stehen auf Englisch, genau so, wie dein KI-Client sie vom Server bekommt. Tools mit „Bestätigung nötig“ laufen erst mit confirm: true. Dein KI-Client fragt dich vorher, ob er die Aktion ausführen soll.

224 von 224 Tools

Konto

Alle Dienste mit ID und Typ, Störungen und Wartungen sowie der Status laufender Vorgänge.

List All Services

list_account_services
Nur lesendStartpunkt

List 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, ...).

Berechtigung
Jede VerbindungDie Ergebnisse enthalten nur Services, die die Verbindung einsehen darf.
Freigabe beim Verbinden
Jede Verbindung

Parameter

Keine Parameter

List Incidents

list_incidents
Nur lesendStartpunkt

List 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.

Berechtigung
Jede VerbindungDie Ergebnisse enthalten nur Services, die die Verbindung einsehen darf.
Freigabe beim Verbinden
Jede Verbindung

Parameter

  • resolvedHoursintegeroptional

    min 0 · max 168

Get Operation Status

get_operation_status
Nur lesend

Poll the status of an async public API operation.

Berechtigung
Jede VerbindungDie Ergebnisse enthalten nur Services, die die Verbindung einsehen darf.
Freigabe beim Verbinden
Jede Verbindung

Parameter

  • operationIdstringPflicht

Gameserver

Status, Konsole, Starten und Stoppen, Einstellungen, Spielversion und Variante, Mods, Savegames, SFTP-Zugang und Neuinstallation.

List Game Servers

list_gameservers
Nur lesendStartpunkt

List gameservers accessible with the current credential. Prefer list_account_services for cross-product discovery.

Berechtigung
gameserver.view
Freigabe beim Verbinden
Services einsehen

Parameter

Keine Parameter

Get Game Server

get_gameserver
Nur lesendStartpunkt

Get one gameserver by ID.

Berechtigung
gameserver.view
Freigabe beim Verbinden
Services einsehen

Parameter

  • serviceIdstringPflicht

    ID of the Gameserver: the "id" field from list_account_services or list_gameservers (e.g. "cmabc123..."). The numericId shown in the panel (e.g. "180") is accepted too. IDs of other service types do not work here.

Get Game Server Live Status

get_gameserver_live_status
Nur lesendStartpunkt

Get live query status for a gameserver.

Berechtigung
gameserver.view
Freigabe beim Verbinden
Services einsehen

Parameter

  • serviceIdstringPflicht

    ID of the Gameserver: the "id" field from list_account_services or list_gameservers (e.g. "cmabc123..."). The numericId shown in the panel (e.g. "180") is accepted too. IDs of other service types do not work here.

Get Game Server Settings

get_gameserver_config
Nur lesend

Read editable gameserver configuration fields.

Berechtigung
gameserver.config.read
Freigabe beim Verbinden
Konfiguration lesen

Parameter

  • serviceIdstringPflicht

    ID of the Gameserver: the "id" field from list_account_services or list_gameservers (e.g. "cmabc123..."). The numericId shown in the panel (e.g. "180") is accepted too. IDs of other service types do not work here.

Update Game Server Settings

update_gameserver_config
DestruktivBestätigung nötig

Update editable gameserver configuration fields. Requires confirm=true.

Berechtigung
gameserver.config.write
Freigabe beim Verbinden
Konfiguration ändern

Parameter

  • serviceIdstringPflicht

    ID of the Gameserver: the "id" field from list_account_services or list_gameservers (e.g. "cmabc123..."). The numericId shown in the panel (e.g. "180") is accepted too. IDs of other service types do not work here.

  • changesRecord<string, string>Pflicht
  • confirmbooleanoptional

Get Game Server Console Logs

get_gameserver_console_logs
Nur lesend

Read a recent gameserver console log snapshot.

Berechtigung
gameserver.console.read
Freigabe beim Verbinden
Konsole & Logs

Parameter

  • serviceIdstringPflicht

    ID of the Gameserver: the "id" field from list_account_services or list_gameservers (e.g. "cmabc123..."). The numericId shown in the panel (e.g. "180") is accepted too. IDs of other service types do not work here.

  • linesintegeroptional

    Number of recent log lines to return, 1-200 (default 50). Values above 200 are rejected.

    > 0 · max 200

Restart Game Server

restart_gameserver
DestruktivBestätigung nötig

Restart a gameserver. Requires confirm=true because this is a power action.

Berechtigung
gameserver.restart
Freigabe beim Verbinden
Power-Aktionen

Parameter

  • serviceIdstringPflicht

    ID of the Gameserver: the "id" field from list_account_services or list_gameservers (e.g. "cmabc123..."). The numericId shown in the panel (e.g. "180") is accepted too. IDs of other service types do not work here.

  • confirmbooleanoptional

Start Game Server

start_gameserver
VeränderndBestätigung nötig

Start a gameserver. Requires confirm=true because this is a power action.

Berechtigung
gameserver.start
Freigabe beim Verbinden
Power-Aktionen

Parameter

  • serviceIdstringPflicht

    ID of the Gameserver: the "id" field from list_account_services or list_gameservers (e.g. "cmabc123..."). The numericId shown in the panel (e.g. "180") is accepted too. IDs of other service types do not work here.

  • confirmbooleanoptional

Stop Game Server

stop_gameserver
DestruktivBestätigung nötig

Stop a gameserver. Requires confirm=true because this is a power action.

Berechtigung
gameserver.stop
Freigabe beim Verbinden
Power-Aktionen

Parameter

  • serviceIdstringPflicht

    ID of the Gameserver: the "id" field from list_account_services or list_gameservers (e.g. "cmabc123..."). The numericId shown in the panel (e.g. "180") is accepted too. IDs of other service types do not work here.

  • confirmbooleanoptional

Send Game Server Console Command

send_gameserver_console_command
DestruktivBestätigung nötig

Send one console command to a running gameserver. Requires confirm=true.

Berechtigung
gameserver.console.write
Freigabe beim Verbinden
Konsole & Logs

Parameter

  • serviceIdstringPflicht

    ID of the Gameserver: the "id" field from list_account_services or list_gameservers (e.g. "cmabc123..."). The numericId shown in the panel (e.g. "180") is accepted too. IDs of other service types do not work here.

  • commandstringPflicht

    max length 500

  • confirmbooleanoptional

Get Game Server Activity

get_gameserver_activity
Nur lesend

Read recent gameserver activity logs.

Berechtigung
gameserver.activity.read
Freigabe beim Verbinden
Services einsehen

Parameter

  • serviceIdstringPflicht

    ID of the Gameserver: the "id" field from list_account_services or list_gameservers (e.g. "cmabc123..."). The numericId shown in the panel (e.g. "180") is accepted too. IDs of other service types do not work here.

  • limitintegeroptional

    > 0 · max 100

  • offsetintegeroptional

    min 0 · max 9007199254740991

Get Game Server Container Status

get_gameserver_container_status
Nur lesend

Get gameserver container and port reachability status.

Berechtigung
gameserver.view
Freigabe beim Verbinden
Services einsehen

Parameter

  • serviceIdstringPflicht

    ID of the Gameserver: the "id" field from list_account_services or list_gameservers (e.g. "cmabc123..."). The numericId shown in the panel (e.g. "180") is accepted too. IDs of other service types do not work here.

List Game Server Schedules

list_gameserver_schedules
Nur lesend

List the recurring schedules of a gameserver (restart, start, stop, console command, backup, wipe) with cron, timezone, next and last run. Only schedules whose action the credential may manage are listed.

Berechtigung
gameserver.view
Freigabe beim Verbinden
Services einsehen

Parameter

  • serviceIdstringPflicht

    ID of the Gameserver: the "id" field from list_account_services or list_gameservers (e.g. "cmabc123..."). The numericId shown in the panel (e.g. "180") is accepted too. IDs of other service types do not work here.

Create Game Server Schedule

create_gameserver_schedule
VeränderndBestätigung nötig

Create a recurring gameserver schedule. action: restart, start, stop, command (needs `command`, sent to the server console), backup (needs ZapX Pass Pro), wipe (only games with a wipe such as Rust, needs `wipe` options). Five-field cron evaluated in `timezone` (IANA, default UTC), at most every 5 minutes, max 20 schedules per server. To announce a restart, add a second command schedule a few minutes earlier (e.g. cron "55 3 * * *" with command "say Restart in 5 minutes"). Requires confirm=true.

Berechtigung
gameserver.backups.managegameserver.restartgameserver.startgameserver.stopgameserver.console.writegameserver.wipe
Freigabe beim Verbinden
Power-Aktionen, Konsole & Logs, Konfiguration ändern

Parameter

  • serviceIdstringPflicht

    ID of the Gameserver: the "id" field from list_account_services or list_gameservers (e.g. "cmabc123..."). The numericId shown in the panel (e.g. "180") is accepted too. IDs of other service types do not work here.

  • namestringPflicht

    max length 120

  • action"restart" | "backup" | "start" | "stop" | "command" | "wipe"Pflicht

  • cronstringPflicht

    Five-field cron, e.g. "0 4 * * *" = daily 04:00. At most every 5 minutes.

  • timezonestringoptional

    IANA zone the cron is evaluated in, e.g. "Europe/Berlin". Default UTC.

  • commandstringoptional

    Console command, required for action=command.

    max length 2000

  • wipeobjectoptional

    Wipe options, required for action=wipe (only games with a wipe, e.g. Rust).

  • wipe.kind"map" | "blueprints" | "full"optional

    Rust: map, blueprints or full.

  • wipe.backupFirstbooleanoptional

    Back up before wiping (default true).

  • wipe.seed"keep" | "random"optional

    Map seed: "keep" (default) or "random".

  • wipe.worldSizeintegeroptional

    min 1000 · max 6000

  • isActivebooleanoptional
  • confirmbooleanoptional

Update Game Server Schedule

update_gameserver_schedule
DestruktivBestätigung nötig

Update a gameserver schedule (name, action, cron, timezone, command, wipe options, isActive). isActive=false pauses it. The daily auto backup (isSystem) cannot be changed. Requires confirm=true.

Berechtigung
gameserver.backups.managegameserver.restartgameserver.startgameserver.stopgameserver.console.writegameserver.wipe
Freigabe beim Verbinden
Power-Aktionen, Konsole & Logs, Konfiguration ändern

Parameter

  • serviceIdstringPflicht

    ID of the Gameserver: the "id" field from list_account_services or list_gameservers (e.g. "cmabc123..."). The numericId shown in the panel (e.g. "180") is accepted too. IDs of other service types do not work here.

  • scheduleIdstringPflicht
  • namestringoptional

    max length 120

  • action"restart" | "backup" | "start" | "stop" | "command" | "wipe"optional

  • cronstringoptional

    Five-field cron, e.g. "0 4 * * *" = daily 04:00. At most every 5 minutes.

  • timezonestringoptional

    IANA zone the cron is evaluated in, e.g. "Europe/Berlin". Default UTC.

  • commandstringoptional

    Console command, required for action=command.

    max length 2000

  • wipeobjectoptional

    Wipe options, required for action=wipe (only games with a wipe, e.g. Rust).

  • wipe.kind"map" | "blueprints" | "full"optional

    Rust: map, blueprints or full.

  • wipe.backupFirstbooleanoptional

    Back up before wiping (default true).

  • wipe.seed"keep" | "random"optional

    Map seed: "keep" (default) or "random".

  • wipe.worldSizeintegeroptional

    min 1000 · max 6000

  • isActivebooleanoptional
  • confirmbooleanoptional

Delete Game Server Schedule

delete_gameserver_schedule
DestruktivBestätigung nötig

Delete a gameserver schedule. The daily auto backup (isSystem) cannot be deleted. Requires confirm=true.

Berechtigung
gameserver.backups.managegameserver.restartgameserver.startgameserver.stopgameserver.console.writegameserver.wipe
Freigabe beim Verbinden
Power-Aktionen, Konsole & Logs, Konfiguration ändern

Parameter

  • serviceIdstringPflicht

    ID of the Gameserver: the "id" field from list_account_services or list_gameservers (e.g. "cmabc123..."). The numericId shown in the panel (e.g. "180") is accepted too. IDs of other service types do not work here.

  • scheduleIdstringPflicht
  • confirmbooleanoptional

Wipe Game Server

wipe_gameserver
DestruktivBestätigung nötig

Wipe a gameserver now (games with a wipe such as Rust): kind map, blueprints or full. Backs up first unless backupFirst=false. Irreversible for the wiped data: state the effect and get an explicit yes first. Returns an operation (poll get_operation_status). For a recurring wipe use create_gameserver_schedule with action=wipe. Requires confirm=true.

Berechtigung
gameserver.wipe
Freigabe beim Verbinden
Vollzugriff

Parameter

  • serviceIdstringPflicht

    ID of the Gameserver: the "id" field from list_account_services or list_gameservers (e.g. "cmabc123..."). The numericId shown in the panel (e.g. "180") is accepted too. IDs of other service types do not work here.

  • kind"map" | "blueprints" | "full"Pflicht

    Rust: map, blueprints or full.

  • backupFirstbooleanoptional

    Back up before wiping (default true).

  • seed"keep" | "random" | integeroptional

    Map seed: "keep" (default), "random" or a fixed number.

  • worldSizeintegeroptional

    min 1000 · max 6000

  • confirmbooleanoptional

List Game Server Databases

list_gameserver_databases
Nur lesend

List the managed MySQL/MariaDB databases of a gameserver with host, port, database name, username, status and phpMyAdmin URL. Passwords are never returned: the owner sees them in the dashboard.

Berechtigung
gameserver.database.read
Freigabe beim Verbinden
Konfiguration lesen

Parameter

  • serviceIdstringPflicht

    ID of the Gameserver: the "id" field from list_account_services or list_gameservers (e.g. "cmabc123..."). The numericId shown in the panel (e.g. "180") is accepted too. IDs of other service types do not work here.

Create Game Server Database

create_gameserver_database
VeränderndBestätigung nötig

Create a managed MySQL/MariaDB database for a gameserver (max 5 per server, free). It is ready when its status turns active (list_gameserver_databases). The password is not returned: the owner reads it in the dashboard. Requires confirm=true.

Berechtigung
gameserver.database.write
Freigabe beim Verbinden
Konfiguration ändern

Parameter

  • serviceIdstringPflicht

    ID of the Gameserver: the "id" field from list_account_services or list_gameservers (e.g. "cmabc123..."). The numericId shown in the panel (e.g. "180") is accepted too. IDs of other service types do not work here.

  • namestringoptional

    Display label, e.g. "fivem". Optional.

    max length 40

  • confirmbooleanoptional

Delete Game Server Database

delete_gameserver_database
DestruktivBestätigung nötig

Permanently delete a gameserver database with all its tables and data (no undo). Get an explicit yes first. confirmationName must be the exact database name (field `database`). Requires confirm=true.

Berechtigung
gameserver.database.write
Freigabe beim Verbinden
Konfiguration ändern

Parameter

  • serviceIdstringPflicht

    ID of the Gameserver: the "id" field from list_account_services or list_gameservers (e.g. "cmabc123..."). The numericId shown in the panel (e.g. "180") is accepted too. IDs of other service types do not work here.

  • databaseIdstringPflicht
  • confirmationNamestringPflicht

    The exact database name (field `database` of list_gameserver_databases), as typed in the dashboard.

  • confirmbooleanoptional

Get Game Server External Access

get_gameserver_external_access
Nur lesend

Read gameserver external access details.

Berechtigung
gameserver.external-access.manage
Freigabe beim Verbinden
Vollzugriff

Parameter

  • serviceIdstringPflicht

    ID of the Gameserver: the "id" field from list_account_services or list_gameservers (e.g. "cmabc123..."). The numericId shown in the panel (e.g. "180") is accepted too. IDs of other service types do not work here.

Set Up Game Server External Access

ensure_gameserver_external_access
VeränderndBestätigung nötig

Ensure gameserver external access is provisioned. Requires confirm=true.

Berechtigung
gameserver.external-access.manage
Freigabe beim Verbinden
Vollzugriff

Parameter

  • serviceIdstringPflicht

    ID of the Gameserver: the "id" field from list_account_services or list_gameservers (e.g. "cmabc123..."). The numericId shown in the panel (e.g. "180") is accepted too. IDs of other service types do not work here.

  • confirmbooleanoptional

Rotate Game Server External Access Credentials

rotate_gameserver_external_access
DestruktivBestätigung nötig

Rotate gameserver external access credentials. Requires confirm=true.

Berechtigung
gameserver.external-access.manage
Freigabe beim Verbinden
Vollzugriff

Parameter

  • serviceIdstringPflicht

    ID of the Gameserver: the "id" field from list_account_services or list_gameservers (e.g. "cmabc123..."). The numericId shown in the panel (e.g. "180") is accepted too. IDs of other service types do not work here.

  • confirmbooleanoptional

Show Game Server External Access Credentials

reveal_gameserver_external_access
DestruktivBestätigung nötig

Reveal gameserver external access credentials. Requires confirm=true.

Berechtigung
gameserver.external-access.manage
Freigabe beim Verbinden
Vollzugriff

Parameter

  • serviceIdstringPflicht

    ID of the Gameserver: the "id" field from list_account_services or list_gameservers (e.g. "cmabc123..."). The numericId shown in the panel (e.g. "180") is accepted too. IDs of other service types do not work here.

  • confirmbooleanoptional

Reinstall Game Server

reinstall_gameserver
DestruktivBestätigung nötig

Reinstall a gameserver. Requires confirm=true.

Berechtigung
gameserver.reinstall
Freigabe beim Verbinden
Vollzugriff

Parameter

  • serviceIdstringPflicht

    ID of the Gameserver: the "id" field from list_account_services or list_gameservers (e.g. "cmabc123..."). The numericId shown in the panel (e.g. "180") is accepted too. IDs of other service types do not work here.

  • confirmbooleanoptional

Change Game Server Game Version

update_gameserver_version
DestruktivBestätigung nötig

Update gameserver game version. Requires confirm=true.

Berechtigung
gameserver.lifecycle.manage
Freigabe beim Verbinden
Konfiguration ändern

Parameter

  • serviceIdstringPflicht

    ID of the Gameserver: the "id" field from list_account_services or list_gameservers (e.g. "cmabc123..."). The numericId shown in the panel (e.g. "180") is accepted too. IDs of other service types do not work here.

  • targetVersionstringoptional
  • targetModpackVersionstringoptional
  • confirmbooleanoptional

Change Game Server Variant

update_gameserver_variant
DestruktivBestätigung nötig

Change gameserver variant. Requires confirm=true.

Berechtigung
gameserver.lifecycle.manage
Freigabe beim Verbinden
Konfiguration ändern

Parameter

  • serviceIdstringPflicht

    ID of the Gameserver: the "id" field from list_account_services or list_gameservers (e.g. "cmabc123..."). The numericId shown in the panel (e.g. "180") is accepted too. IDs of other service types do not work here.

  • variantIdstringPflicht
  • confirmbooleanoptional

List Game Server Save Games

list_gameserver_savegames
Nur lesend

List gameserver savegames.

Berechtigung
gameserver.savegames.read
Freigabe beim Verbinden
Konfiguration lesen

Parameter

  • serviceIdstringPflicht

    ID of the Gameserver: the "id" field from list_account_services or list_gameservers (e.g. "cmabc123..."). The numericId shown in the panel (e.g. "180") is accepted too. IDs of other service types do not work here.

  • pageintegeroptional

    > 0 · max 9007199254740991

  • limitintegeroptional

    > 0 · max 100

Delete Game Server Save Game

delete_gameserver_savegame
DestruktivBestätigung nötig

Delete a gameserver savegame. Requires confirm=true.

Berechtigung
gameserver.savegames.write
Freigabe beim Verbinden
Konfiguration ändern

Parameter

  • serviceIdstringPflicht

    ID of the Gameserver: the "id" field from list_account_services or list_gameservers (e.g. "cmabc123..."). The numericId shown in the panel (e.g. "180") is accepted too. IDs of other service types do not work here.

  • pathstringPflicht
  • confirmbooleanoptional

List Game Server Mods

list_gameserver_mods
Nur lesend

List installed mods (installedOnly=true) or search the gameserver's mod browser (e.g. CurseForge/Modrinth for Minecraft mod loaders, Thunderstore for Valheim, uMod for Rust with Oxide, ficsit for Satisfactory). Results carry provider, projectId and the installation state; install with install_gameserver_mod.

Berechtigung
gameserver.view
Freigabe beim Verbinden
Services einsehen

Parameter

  • serviceIdstringPflicht

    ID of the Gameserver: the "id" field from list_account_services or list_gameservers (e.g. "cmabc123..."). The numericId shown in the panel (e.g. "180") is accepted too. IDs of other service types do not work here.

  • querystringoptional
  • providerstringoptional
  • installedOnlybooleanoptional
  • offsetintegeroptional

    min 0 · max 9007199254740991

  • limitintegeroptional

    > 0 · max 48

  • sort"relevance" | "downloads" | "updated" | "newest"optional

Install or Update Game Server Mod

install_gameserver_mod
DestruktivBestätigung nötig

Install a mod from the gameserver's mod browser (find it with list_gameserver_mods: provider + projectId). Also updates, downgrades or repairs an installed mod: pass the versionId (see check_gameserver_addon_updates). Without versionId the newest compatible version is installed. Rust uMod plugins are mods with provider "umod" (set_gameserver_rust_framework to oxide first). The server must be stopped. Requires confirm=true. Returns an operation (get_operation_status) and the installationId.

Berechtigung
gameserver.mods.manage
Freigabe beim Verbinden
Konfiguration ändern

Parameter

  • serviceIdstringPflicht

    ID of the Gameserver: the "id" field from list_account_services or list_gameservers (e.g. "cmabc123..."). The numericId shown in the panel (e.g. "180") is accepted too. IDs of other service types do not work here.

  • provider"modrinth" | "curseforge" | "thunderstore" | "umod" | "beamng" | "ficsit" | "hangar"Pflicht

  • projectIdstringPflicht

    max length 200

  • versionIdstringoptional

    max length 200

  • titlestringoptional

    max length 200

  • resolveDependenciesbooleanoptional
  • confirmbooleanoptional

Remove Game Server Mod

uninstall_gameserver_mod
DestruktivBestätigung nötig

Remove an installed mod by its installationId (from list_gameserver_mods with installedOnly=true). Deletes the mod files. The server must be stopped. Requires confirm=true.

Berechtigung
gameserver.mods.manage
Freigabe beim Verbinden
Konfiguration ändern

Parameter

  • serviceIdstringPflicht

    ID of the Gameserver: the "id" field from list_account_services or list_gameservers (e.g. "cmabc123..."). The numericId shown in the panel (e.g. "180") is accepted too. IDs of other service types do not work here.

  • installationIdstringPflicht
  • confirmbooleanoptional

Check Game Server Mod and Plugin Updates

check_gameserver_addon_updates
Nur lesend

Check the installed mods (kind=mods) or plugins (kind=plugins) of a gameserver for newer versions. Install an update with install_gameserver_mod / install_gameserver_plugin and the reported versionId. refresh=true asks the providers again even for cached answers. Read-only.

Berechtigung
gameserver.view
Freigabe beim Verbinden
Services einsehen

Parameter

  • serviceIdstringPflicht

    ID of the Gameserver: the "id" field from list_account_services or list_gameservers (e.g. "cmabc123..."). The numericId shown in the panel (e.g. "180") is accepted too. IDs of other service types do not work here.

  • kind"mods" | "plugins"Pflicht

  • refreshbooleanoptional

List Game Server Plugins

list_gameserver_plugins
Nur lesend

List installed plugins (installedOnly=true) or search the plugin catalog (Modrinth, Hangar) of a Minecraft plugin server (Paper, Spigot, Purpur, Folia, Velocity, Waterfall), e.g. EssentialsX or LuckPerms. Results carry provider, projectId and the installation state. Page with offset/nextOffset.

Berechtigung
gameserver.view
Freigabe beim Verbinden
Services einsehen

Parameter

  • serviceIdstringPflicht

    ID of the Gameserver: the "id" field from list_account_services or list_gameservers (e.g. "cmabc123..."). The numericId shown in the panel (e.g. "180") is accepted too. IDs of other service types do not work here.

  • querystringoptional

    max length 200

  • provider"all" | "modrinth" | "hangar"optional

  • installedOnlybooleanoptional
  • offsetintegeroptional

    min 0 · max 9007199254740991

  • limitintegeroptional

    min 1 · max 48

  • sortstringoptional

    max length 40

Install or Update Game Server Plugin

install_gameserver_plugin
DestruktivBestätigung nötig

Install a plugin from list_gameserver_plugins (provider + projectId), with its required dependencies. With the versionId of an installed plugin it updates or downgrades it. The server must be stopped. Requires confirm=true. Returns an operation (get_operation_status) and the installationId.

Berechtigung
gameserver.plugins.manage
Freigabe beim Verbinden
Konfiguration ändern

Parameter

  • serviceIdstringPflicht

    ID of the Gameserver: the "id" field from list_account_services or list_gameservers (e.g. "cmabc123..."). The numericId shown in the panel (e.g. "180") is accepted too. IDs of other service types do not work here.

  • provider"modrinth" | "hangar"Pflicht

  • projectIdstringPflicht

    max length 200

  • versionIdstringoptional

    max length 200

  • titlestringoptional

    max length 200

  • resolveDependenciesbooleanoptional
  • confirmbooleanoptional

Remove Game Server Plugin

uninstall_gameserver_plugin
DestruktivBestätigung nötig

Remove an installed plugin by its installationId (from list_gameserver_plugins with installedOnly=true). Deletes the plugin jar; its config folder stays. The server must be stopped. Requires confirm=true.

Berechtigung
gameserver.plugins.manage
Freigabe beim Verbinden
Konfiguration ändern

Parameter

  • serviceIdstringPflicht

    ID of the Gameserver: the "id" field from list_account_services or list_gameservers (e.g. "cmabc123..."). The numericId shown in the panel (e.g. "180") is accepted too. IDs of other service types do not work here.

  • installationIdstringPflicht
  • confirmbooleanoptional

Get Rust Plugin Framework

get_gameserver_rust_framework
Nur lesend

Rust servers only: the configured plugin framework (vanilla, oxide = uMod, carbon), the one the running server uses and whether a restart is needed to apply it.

Berechtigung
gameserver.view
Freigabe beim Verbinden
Services einsehen

Parameter

  • serviceIdstringPflicht

    ID of the Gameserver: the "id" field from list_account_services or list_gameservers (e.g. "cmabc123..."). The numericId shown in the panel (e.g. "180") is accepted too. IDs of other service types do not work here.

Set Rust Plugin Framework

set_gameserver_rust_framework
DestruktivBestätigung nötig

Rust servers only: install or switch the plugin framework (oxide = Oxide/uMod, carbon = Carbon, vanilla = none). Applied on the next start/restart (restart_gameserver); world, cfg and plugin folders are kept. Then install uMod plugins with install_gameserver_mod (provider umod). Requires confirm=true.

Berechtigung
gameserver.plugins.manage
Freigabe beim Verbinden
Konfiguration ändern

Parameter

  • serviceIdstringPflicht

    ID of the Gameserver: the "id" field from list_account_services or list_gameservers (e.g. "cmabc123..."). The numericId shown in the panel (e.g. "180") is accepted too. IDs of other service types do not work here.

  • framework"vanilla" | "oxide" | "carbon"Pflicht

  • confirmbooleanoptional

List Minecraft Modpacks

list_gameserver_modpacks
Nur lesend

Minecraft servers only: search the modpack catalog (CurseForge, Modrinth, FTB, Technic) with search/provider/offset/limit. Pass modpackId to get that modpack's versions (versionId for install_gameserver_modpack) and a RAM hint.

Berechtigung
gameserver.view
Freigabe beim Verbinden
Services einsehen

Parameter

  • serviceIdstringPflicht

    ID of the Gameserver: the "id" field from list_account_services or list_gameservers (e.g. "cmabc123..."). The numericId shown in the panel (e.g. "180") is accepted too. IDs of other service types do not work here.

  • searchstringoptional

    max length 200

  • provider"all" | "modrinth" | "curseforge" | "ftb" | "technic"optional

  • offsetintegeroptional

    min 0 · max 100000

  • limitintegeroptional

    min 1 · max 100

  • modpackIdstringoptional

Install Minecraft Modpack

install_gameserver_modpack
DestruktivBestätigung nötig

Minecraft servers only: install a modpack (modpackId + versionId from list_gameserver_modpacks) like the panel library. The server type and Minecraft version follow the modpack and the server is reinstalled with it; other installed variants keep their data. To update the active modpack use update_gameserver_version with targetModpackVersion. Requires confirm=true.

Berechtigung
gameserver.lifecycle.manage
Freigabe beim Verbinden
Konfiguration ändern

Parameter

  • serviceIdstringPflicht

    ID of the Gameserver: the "id" field from list_account_services or list_gameservers (e.g. "cmabc123..."). The numericId shown in the panel (e.g. "180") is accepted too. IDs of other service types do not work here.

  • modpackIdstringPflicht
  • versionIdstringPflicht
  • confirmbooleanoptional

Get Game Server Steam Workshop

get_gameserver_workshop
Nur lesend

Steam workshop configuration of a gameserver whose game supports it (e.g. Garry's Mod, ARK, DayZ, Project Zomboid): item ids with titles and validation, the collection id, disabled items and whether changes wait for the next start.

Berechtigung
gameserver.view
Freigabe beim Verbinden
Services einsehen

Parameter

  • serviceIdstringPflicht

    ID of the Gameserver: the "id" field from list_account_services or list_gameservers (e.g. "cmabc123..."). The numericId shown in the panel (e.g. "180") is accepted too. IDs of other service types do not work here.

Update Game Server Steam Workshop

update_gameserver_workshop
DestruktivBestätigung nötig

Change the Steam workshop items of a gameserver: addItemIds / removeItemIds edit the current list, itemIds replaces it, collectionId sets or (null) removes the collection, disabledItemIds keeps items listed but inactive. Omitted fields stay as they are. Applied on the next start/restart. Requires confirm=true.

Berechtigung
gameserver.mods.manage
Freigabe beim Verbinden
Konfiguration ändern

Parameter

  • serviceIdstringPflicht

    ID of the Gameserver: the "id" field from list_account_services or list_gameservers (e.g. "cmabc123..."). The numericId shown in the panel (e.g. "180") is accepted too. IDs of other service types do not work here.

  • itemIdsstring[]optional

    max items 500

  • addItemIdsstring[]optional

    max items 200

  • removeItemIdsstring[]optional

    max items 500

  • collectionIdstringoptional

    pattern ^\d{1,20}$

  • disabledItemIdsstring[]optional

    max items 500

  • confirmbooleanoptional

vServer (VPS)

Starten und Stoppen, Konfiguration, Metriken, Traffic, DNS, Firewall, SSH-Keys, DDoS-Schutz, Zeitpläne, Rescue-Modus und Neuinstallation.

List VPS

list_vservers
Nur lesendStartpunkt

List VPS accessible with the current credential. Prefer list_account_services for cross-product discovery.

Berechtigung
vserver.view
Freigabe beim Verbinden
Services einsehen

Parameter

Keine Parameter

Get VPS

get_vserver
Nur lesendStartpunkt

Get one VPS by ID.

Berechtigung
vserver.view
Freigabe beim Verbinden
Services einsehen

Parameter

  • serviceIdstringPflicht

    ID 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 VPS Settings

get_vserver_config
Nur lesend

Read VPS configuration.

Berechtigung
vserver.config.read
Freigabe beim Verbinden
Konfiguration lesen

Parameter

  • serviceIdstringPflicht

    ID 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 VPS Settings

patch_vserver_config
DestruktivBestätigung nötig

Update VPS hostname, DNS, ballooning, or SSH password settings. Requires confirm=true.

Berechtigung
vserver.config.writevserver.access.manage
Freigabe beim Verbinden
Konfiguration ändern

Parameter

  • serviceIdstringPflicht

    ID 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.

  • hostnamestringoptional
  • dnsServerstringoptional
  • ballooningDisabledbooleanoptional
  • sshPasswordEnabledbooleanoptional
  • confirmbooleanoptional

Get VPS Activity

get_vserver_activity
Nur lesend

Read paginated VPS activity log entries.

Berechtigung
vserver.activity.read
Freigabe beim Verbinden
Services einsehen

Parameter

  • serviceIdstringPflicht

    ID 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.

  • limitintegeroptional

    min 1 · max 100

  • offsetintegeroptional

    min 0 · max 9007199254740991

Get VPS Traffic

get_vserver_traffic
Nur lesend

Read paginated VPS network traffic history.

Berechtigung
vserver.traffic.read
Freigabe beim Verbinden
Services einsehen

Parameter

  • serviceIdstringPflicht

    ID 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.

  • limitintegeroptional

    min 1 · max 100

  • offsetintegeroptional

    min 0 · max 9007199254740991

Get VPS DDoS Status

get_vserver_ddos_status
Nur lesend

Get 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.

Berechtigung
vserver.ddos.read
Freigabe beim Verbinden
Services einsehen

Parameter

  • serviceIdstringPflicht

    ID 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.

  • ipAddressstringoptional

List VPS DDoS Rules

list_vserver_ddos_rules
Nur lesend

List the DDoS filter rules learned for a VPS IP.

Berechtigung
vserver.ddos.read
Freigabe beim Verbinden
Services einsehen

Parameter

  • serviceIdstringPflicht

    ID 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.

  • ipAddressstringoptional

List VPS DDoS Incidents

list_vserver_ddos_incidents
Nur lesend

List inbound DDoS incidents against a VPS IP (paginated).

Berechtigung
vserver.ddos.read
Freigabe beim Verbinden
Services einsehen

Parameter

  • serviceIdstringPflicht

    ID 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.

  • ipAddressstringoptional
  • pageintegeroptional

    > 0 · max 9007199254740991

  • pageSizeintegeroptional

    > 0 · max 100

Get VPS DDoS Bandwidth

get_vserver_ddos_bandwidth
Nur lesend

Get DDoS pass/drop bandwidth statistics of a VPS IP. range: 10m, 1h (default), 1d or 1w.

Berechtigung
vserver.ddos.read
Freigabe beim Verbinden
Services einsehen

Parameter

  • serviceIdstringPflicht

    ID 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"optional

  • ipAddressstringoptional

List Outgoing DDoS Attacks from VPS

list_vserver_outgoing_ddos
Nur lesend

List outgoing DDoS attacks detected from a VPS and whether it is flagged for reinstall.

Berechtigung
vserver.ddos.read
Freigabe beim Verbinden
Services einsehen

Parameter

  • serviceIdstringPflicht

    ID 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.

Turn VPS DDoS Protection On or Off

toggle_vserver_ddos_protection
DestruktivBestätigung nötig

Switch DDoS protection of a VPS IP on or off (service owner only). Switching it off leaves the IP unfiltered. Requires confirm=true.

Berechtigung
vserver.ddos.manage
Freigabe beim Verbinden
Konfiguration ändern

Parameter

  • serviceIdstringPflicht

    ID 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.

  • ipAddressstringoptional
  • enabledbooleanoptional

    Target state (true = protected). Without it the current state is flipped.

  • confirmbooleanoptional

Get VPS DNS Settings

get_vserver_dns
Nur lesend

Read VPS DNS domains, subdomains, and favorite subdomain.

Berechtigung
vserver.config.read
Freigabe beim Verbinden
Konfiguration lesen

Parameter

  • serviceIdstringPflicht

    ID 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 Account SSH Keys

list_vserver_account_ssh_keys
Nur lesend

List SSH keys stored on the authenticated account.

Berechtigung
vserver.config.read
Freigabe beim Verbinden
Konfiguration lesen

Parameter

Keine Parameter

Create VPS Subdomain

create_vserver_subdomain
VeränderndBestätigung nötig

Create a subdomain that points at the VPS (free ZAP domain or one of the customer's domains). Requires confirm=true.

Berechtigung
vserver.config.write
Freigabe beim Verbinden
Konfiguration ändern

Parameter

  • serviceIdstringPflicht

    ID 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.

  • labelstringPflicht

    Subdomain label, e.g. `myserver` for myserver.<domain>.

  • domainIdstringoptional

    Domain from get_vserver_dns `domains[].id`; default `platform` (the free ZAP domain).

  • confirmbooleanoptional

Delete VPS Subdomain

delete_vserver_subdomain
DestruktivBestätigung nötig

Delete a subdomain of the VPS. Requires confirm=true.

Berechtigung
vserver.config.write
Freigabe beim Verbinden
Konfiguration ändern

Parameter

  • serviceIdstringPflicht

    ID 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.

  • subdomainIdstringPflicht

    Subdomain id from get_vserver_dns.

  • confirmbooleanoptional

Set VPS Favorite Subdomain

set_vserver_favorite_subdomain
DestruktivBestätigung nötig

Set or clear the favorite subdomain shown as the VPS address. Requires confirm=true.

Berechtigung
vserver.config.write
Freigabe beim Verbinden
Konfiguration ändern

Parameter

  • serviceIdstringPflicht

    ID 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.

  • subdomainIdstringoptional

    Subdomain id from get_vserver_dns; null or omitted clears the favorite.

  • confirmbooleanoptional

Get VPS Reverse DNS

get_vserver_reverse_dns
Nur lesend

Read the reverse DNS (PTR) entries of the VPS IPv4 addresses and IPv6 prefixes.

Berechtigung
vserver.config.read
Freigabe beim Verbinden
Konfiguration lesen

Parameter

  • serviceIdstringPflicht

    ID 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 VPS Reverse DNS

update_vserver_reverse_dns
DestruktivBestätigung nötig

Set or reset the reverse DNS (PTR) hostname of one VPS IP. The hostname must resolve to that IP. Requires confirm=true.

Berechtigung
vserver.config.write
Freigabe beim Verbinden
Konfiguration ändern

Parameter

  • serviceIdstringPflicht

    ID 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.

  • ipAddressIdstringoptional

    IPv4 entry from get_vserver_reverse_dns (`ipAddressId`). Pass this or ipv6PrefixAllocationId.

  • ipv6PrefixAllocationIdstringoptional

    IPv6 entry from get_vserver_reverse_dns (`ipv6PrefixAllocationId`).

  • hostnamestringoptional

    New PTR hostname (must resolve to the IP); empty or null resets it to the default.

  • confirmbooleanoptional

Update VPS Firewall Options

update_vserver_firewall_options
DestruktivBestätigung nötig

Turn 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.

Berechtigung
vserver.firewall.write
Freigabe beim Verbinden
Konfiguration ändern

Parameter

  • serviceIdstringPflicht

    ID 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.

  • enablebooleanPflicht

    Firewall on (true) or off (false).

  • policyIn"ACCEPT" | "DROP" | "REJECT"Pflicht

    Default policy for incoming traffic no rule matches.

  • policyOut"ACCEPT" | "DROP" | "REJECT"Pflicht

    Default policy for outgoing traffic no rule matches.

  • confirmbooleanoptional

Change VPS Firewall Rule

mutate_vserver_firewall_rule
DestruktivBestätigung nötig

Add, update, delete or move a VPS firewall rule (positions from get_vserver_firewall). add/update need type and ruleAction. Requires confirm=true.

Berechtigung
vserver.firewall.write
Freigabe beim Verbinden
Konfiguration ändern

Parameter

  • serviceIdstringPflicht

    ID 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"Pflicht

  • posintegeroptional

    update/delete/move: `pos` of the rule as returned by get_vserver_firewall.

    min 0 · max 9007199254740991

  • newPosintegeroptional

    move: 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"optional

    add/update: traffic direction.

  • ruleAction"ACCEPT" | "DROP" | "REJECT"optional

    add/update: what the rule does with matching traffic.

  • enablebooleanoptional

    add/update: rule active (default true).

  • macrostringoptional

    add/update: Proxmox firewall macro instead of proto/ports, e.g. SSH, HTTP, HTTPS, DNS, Ping.

  • protostringoptional

    add/update: protocol, e.g. tcp, udp, icmp, icmpv6.

  • sourcestringoptional

    add/update: source address, CIDR or +ipset_name (IP set of this VPS). Empty = any.

  • deststringoptional

    add/update: destination address, CIDR or +ipset_name. Empty = any.

  • sportstringoptional

    add/update: source port(s), e.g. 1024:65535.

  • dportstringoptional

    add/update: destination port(s), e.g. 22, 80,443 or 27015:27020.

  • commentstringoptional

    add/update: free text comment.

  • log"nolog" | "alert" | "crit" | "debug" | "emerg" | "err" | "info" | "notice" | "warning"optional

    add/update: log level (default nolog).

  • confirmbooleanoptional

Change VPS Firewall IP Set

mutate_vserver_firewall_ipset
DestruktivBestätigung nötig

Create or delete a VPS firewall IP set, or add/remove an address (cidr). Rules reference a set as +name. Requires confirm=true.

Berechtigung
vserver.firewall.write
Freigabe beim Verbinden
Konfiguration ändern

Parameter

  • serviceIdstringPflicht

    ID 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"Pflicht

  • namestringPflicht

    IP set name (letters, digits, - and _). Use it in rules as +name.

  • cidrstringoptional

    add_entry/remove_entry: IP address or CIDR, e.g. 203.0.113.7 or 198.51.100.0/24.

  • commentstringoptional

    add_entry: free text comment.

  • confirmbooleanoptional

List VPS SSH Keys

list_vserver_ssh_keys
Nur lesend

List the account SSH keys installed on one VPS.

Berechtigung
vserver.config.read
Freigabe beim Verbinden
Konfiguration lesen

Parameter

  • serviceIdstringPflicht

    ID 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.

Install SSH Key on VPS

add_vserver_ssh_key
VeränderndBestätigung nötig

Install an account SSH key (list_vserver_account_ssh_keys) on the VPS as root authorized key. Requires confirm=true.

Berechtigung
vserver.access.manage
Freigabe beim Verbinden
Vollzugriff

Parameter

  • serviceIdstringPflicht

    ID 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.

  • sshKeyIdstringPflicht

    Key id from list_vserver_account_ssh_keys.

  • confirmbooleanoptional

Remove SSH Key from VPS

remove_vserver_ssh_key
DestruktivBestätigung nötig

Remove an SSH key from the VPS (the key stays in the account). Requires confirm=true.

Berechtigung
vserver.access.manage
Freigabe beim Verbinden
Vollzugriff

Parameter

  • serviceIdstringPflicht

    ID 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.

  • sshKeyIdstringPflicht

    Key id from list_vserver_ssh_keys.

  • confirmbooleanoptional

Add Account SSH Key

create_vserver_account_ssh_key
VeränderndBestätigung nötig

Add a public SSH key to the account key store (then install it with add_vserver_ssh_key). Requires confirm=true.

Berechtigung
vserver.config.write
Freigabe beim Verbinden
Konfiguration ändern

Parameter

  • namestringPflicht
  • publicKeystringPflicht

    OpenSSH public key line (ssh-ed25519/ssh-rsa/ecdsa ...). Never pass a private key.

  • confirmbooleanoptional

Update Account SSH Key

update_vserver_account_ssh_key
DestruktivBestätigung nötig

Rename an account SSH key or replace its public key on every VPS it is installed on. Requires confirm=true.

Berechtigung
vserver.access.manage
Freigabe beim Verbinden
Vollzugriff

Parameter

  • keyIdstringPflicht

    Key id from list_vserver_account_ssh_keys.

  • namestringoptional
  • publicKeystringoptional

    Replaces the key on every VPS it is installed on.

  • confirmbooleanoptional

Delete Account SSH Key

delete_vserver_account_ssh_key
DestruktivBestätigung nötig

Delete an account SSH key and remove it from every VPS it is installed on. Requires confirm=true.

Berechtigung
vserver.access.manage
Freigabe beim Verbinden
Vollzugriff

Parameter

  • keyIdstringPflicht

    Key id from list_vserver_account_ssh_keys.

  • confirmbooleanoptional

List VPS ISO Images

list_vserver_isos
Nur lesend

List the ISO images that can be mounted on the VPS (ZAP library and own custom ISOs) and the mounted one.

Berechtigung
vserver.reinstall
Freigabe beim Verbinden
Vollzugriff

Parameter

  • serviceIdstringPflicht

    ID 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 ISO on VPS

mount_vserver_iso
VeränderndBestätigung nötig

Mount an ISO on the VPS (e.g. to install an own OS). Restart the VPS to boot from it. Requires confirm=true.

Berechtigung
vserver.reinstall
Freigabe beim Verbinden
Vollzugriff

Parameter

  • serviceIdstringPflicht

    ID 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.

  • isoIdstringoptional

    ISO id from list_vserver_isos `images[].id`.

  • volidstringoptional

    Alternative to isoId: the image's `volid` from list_vserver_isos.

  • applyHardwareProfilebooleanoptional

    Adapt the VM hardware to the ISO's OS (UEFI + TPM); default false. Set true for Windows 11 / UEFI-only ISOs.

  • attachDriverDiscbooleanoptional

    Attach the VirtIO driver disc (Windows installs).

  • bootFromIsobooleanoptional

    Boot from the ISO first; default true except driver/tool ISOs.

  • confirmbooleanoptional

Unmount ISO from VPS

unmount_vserver_iso
VeränderndBestätigung nötig

Eject the mounted ISO and boot from disk again. Requires confirm=true.

Berechtigung
vserver.reinstall
Freigabe beim Verbinden
Vollzugriff

Parameter

  • serviceIdstringPflicht

    ID 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.

  • confirmbooleanoptional

List Custom VPS ISOs

list_vserver_custom_isos
Nur lesend

List the customer's own imported ISO images for VPS.

Berechtigung
vserver.reinstall
Freigabe beim Verbinden
Vollzugriff

Parameter

  • serviceIdstringPflicht

    ID 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 Custom VPS ISO

import_vserver_custom_iso
VeränderndBestätigung nötig

Import an own ISO from a public URL into the VPS ISO library. Returns an operation. Requires confirm=true.

Berechtigung
vserver.reinstall
Freigabe beim Verbinden
Vollzugriff

Parameter

  • serviceIdstringPflicht

    ID 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.

  • displayNamestringPflicht
  • sourceUrlstringPflicht

    Public http(s) URL of the .iso file.

  • filenamestringoptional
  • osProfile"linux" | "windows"optional

    OS of the ISO, sets the hardware profile on mount.

  • confirmbooleanoptional

Delete Custom VPS ISO

delete_vserver_custom_iso
DestruktivBestätigung nötig

Delete an own imported ISO. Requires confirm=true.

Berechtigung
vserver.reinstall
Freigabe beim Verbinden
Vollzugriff

Parameter

  • serviceIdstringPflicht

    ID 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.

  • assetIdstringPflicht

    Custom ISO id from list_vserver_custom_isos.

  • confirmbooleanoptional

Get VPS Metrics

get_vserver_metrics
Nur lesend

Get 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.

Berechtigung
vserver.metrics.read
Freigabe beim Verbinden
Services einsehen

Parameter

  • serviceIdstringPflicht

    ID 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"optional

Get VPS Firewall Rules

get_vserver_firewall
Nur lesend

Read the VPS firewall configuration.

Berechtigung
vserver.firewall.read
Freigabe beim Verbinden
Konfiguration lesen

Parameter

  • serviceIdstringPflicht

    ID 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 VPS

start_vserver
VeränderndBestätigung nötig

Start a VPS. Requires confirm=true.

Berechtigung
vserver.power.start
Freigabe beim Verbinden
Power-Aktionen

Parameter

  • serviceIdstringPflicht

    ID 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.

  • confirmbooleanoptional

Stop VPS

stop_vserver
DestruktivBestätigung nötig

Stop a VPS. Requires confirm=true.

Berechtigung
vserver.power.stop
Freigabe beim Verbinden
Power-Aktionen

Parameter

  • serviceIdstringPflicht

    ID 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.

  • confirmbooleanoptional

Restart VPS

restart_vserver
DestruktivBestätigung nötig

Restart a VPS. Requires confirm=true.

Berechtigung
vserver.power.restart
Freigabe beim Verbinden
Power-Aktionen

Parameter

  • serviceIdstringPflicht

    ID 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.

  • confirmbooleanoptional

List VPS Schedules

list_vserver_schedules
Nur lesend

List recurring VPS schedules (restart, start, stop, guest-agent command) the credential may manage.

Berechtigung
vserver.view
Freigabe beim Verbinden
Services einsehen

Parameter

  • serviceIdstringPflicht

    ID 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 VPS Schedule

create_vserver_schedule
DestruktivBestätigung nötig

Create 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.

Berechtigung
vserver.power.restartvserver.power.startvserver.power.stopvserver.console.write
Freigabe beim Verbinden
Power-Aktionen

Parameter

  • serviceIdstringPflicht

    ID 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.

  • namestringPflicht
  • action"restart" | "start" | "stop" | "command"Pflicht

  • cronstringPflicht
  • timezonestringoptional
  • commandstringoptional
  • isActivebooleanoptional
  • confirmbooleanoptional

Update VPS Schedule

update_vserver_schedule
DestruktivBestätigung nötig

Update a VPS schedule (name, action, cron, timezone, command, isActive). Requires confirm=true.

Berechtigung
vserver.power.restartvserver.power.startvserver.power.stopvserver.console.write
Freigabe beim Verbinden
Power-Aktionen

Parameter

  • serviceIdstringPflicht

    ID 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.

  • scheduleIdstringPflicht
  • namestringoptional
  • action"restart" | "start" | "stop" | "command"optional

  • cronstringoptional
  • timezonestringoptional
  • commandstringoptional
  • isActivebooleanoptional
  • confirmbooleanoptional

Delete VPS Schedule

delete_vserver_schedule
DestruktivBestätigung nötig

Delete a VPS schedule. Requires confirm=true.

Berechtigung
vserver.power.restartvserver.power.startvserver.power.stopvserver.console.write
Freigabe beim Verbinden
Power-Aktionen

Parameter

  • serviceIdstringPflicht

    ID 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.

  • scheduleIdstringPflicht
  • confirmbooleanoptional

Enable VPS Rescue Mode

enable_vserver_rescue
DestruktivBestätigung nötig

Enable VPS rescue mode. Requires confirm=true.

Berechtigung
vserver.reinstall
Freigabe beim Verbinden
Vollzugriff

Parameter

  • serviceIdstringPflicht

    ID 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.

  • confirmbooleanoptional

Disable VPS Rescue Mode

disable_vserver_rescue
DestruktivBestätigung nötig

Disable VPS rescue mode. Requires confirm=true.

Berechtigung
vserver.reinstall
Freigabe beim Verbinden
Vollzugriff

Parameter

  • serviceIdstringPflicht

    ID 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.

  • confirmbooleanoptional

List VPS Reinstall Templates

list_vserver_reinstall_templates
Nur lesend

List available VPS reinstall templates. minDiskGb is the minimum disk in GB the template needs (null = none); templates above the VPS disk are rejected.

Berechtigung
vserver.reinstall
Freigabe beim Verbinden
Vollzugriff

Parameter

Keine Parameter

Reinstall VPS

reinstall_vserver
DestruktivBestätigung nötig

Reinstall a VPS. Requires confirm=true.

Berechtigung
vserver.reinstall
Freigabe beim Verbinden
Vollzugriff

Parameter

  • serviceIdstringPflicht

    ID 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.

  • templateIdstringoptional
  • confirmbooleanoptional

Dedicated Server

Power-Status, Hardware, Metriken, Traffic, Installation, eigene ISOs, Reverse-DNS, DDoS-Schutz, Fernwartung und Rescue-Modus.

List Dedicated Servers

list_dedicated_servers
Nur lesendStartpunkt

List dedicated servers accessible with the current credential. Prefer list_account_services for cross-product discovery.

Berechtigung
dedicated.view
Freigabe beim Verbinden
Services einsehen

Parameter

Keine Parameter

Get Dedicated Server

get_dedicated_server
Nur lesendStartpunkt

Get one dedicated server by ID.

Berechtigung
dedicated.view
Freigabe beim Verbinden
Services einsehen

Parameter

  • serviceIdstringPflicht

    ID 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 Server Power State

get_dedicated_power_state
Nur lesend

Get dedicated server hardware power state.

Berechtigung
dedicated.view
Freigabe beim Verbinden
Services einsehen

Parameter

  • serviceIdstringPflicht

    ID 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 Server Metrics

get_dedicated_metrics
Nur lesend

Get dedicated server hardware metrics for a timeframe.

Berechtigung
dedicated.metrics.read
Freigabe beim Verbinden
Services einsehen

Parameter

  • serviceIdstringPflicht

    ID 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"optional

Get Dedicated Server Hardware

get_dedicated_hardware
Nur lesend

Get dedicated server hardware inventory.

Berechtigung
dedicated.hardware.read
Freigabe beim Verbinden
Services einsehen

Parameter

  • serviceIdstringPflicht

    ID 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 Server Traffic

get_dedicated_traffic
Nur lesend

Get dedicated server traffic overview for a timeframe.

Berechtigung
dedicated.traffic.read
Freigabe beim Verbinden
Services einsehen

Parameter

  • serviceIdstringPflicht

    ID 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"optional

Get Dedicated Server Traffic Quota

get_dedicated_traffic_quota
Nur lesend

Get dedicated server traffic quota snapshot.

Berechtigung
dedicated.traffic.read
Freigabe beim Verbinden
Services einsehen

Parameter

  • serviceIdstringPflicht

    ID 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 Server Traffic History

get_dedicated_traffic_history
Nur lesend

Get dedicated server traffic history entries.

Berechtigung
dedicated.traffic.read
Freigabe beim Verbinden
Services einsehen

Parameter

  • serviceIdstringPflicht

    ID 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

  • offsetintegeroptional

    min 0 · max 9007199254740991

Get Dedicated Server Activity

get_dedicated_activity
Nur lesend

Read recent dedicated server activity logs.

Berechtigung
dedicated.activity.read
Freigabe beim Verbinden
Services einsehen

Parameter

  • serviceIdstringPflicht

    ID 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

  • offsetintegeroptional

    min 0 · max 9007199254740991

Get Dedicated Server Installation

get_dedicated_installation
Nur lesend

Get dedicated server installation status.

Berechtigung
dedicated.view
Freigabe beim Verbinden
Services einsehen

Parameter

  • serviceIdstringPflicht

    ID 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 Server Installation Progress

get_dedicated_installation_progress
Nur lesend

Get dedicated server installation progress and log.

Berechtigung
dedicated.view
Freigabe beim Verbinden
Services einsehen

Parameter

  • serviceIdstringPflicht

    ID 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 Server Installation Options

get_dedicated_installation_options
Nur lesend

List install media, reinstall, rescue, and custom ISO options.

Berechtigung
dedicated.installation.manage
Freigabe beim Verbinden
Vollzugriff

Parameter

  • serviceIdstringPflicht

    ID 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 Server Reverse DNS

get_dedicated_reverse_dns
Nur lesend

Read reverse DNS entries for a dedicated server.

Berechtigung
dedicated.network.read
Freigabe beim Verbinden
Services einsehen

Parameter

  • serviceIdstringPflicht

    ID 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 Server DDoS Status

get_dedicated_ddos_status
Nur lesend

Get DDoS protection status for a dedicated server.

Berechtigung
dedicated.ddos.read
Freigabe beim Verbinden
Services einsehen

Parameter

  • serviceIdstringPflicht

    ID 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.

  • ipAddressstringoptional

List Dedicated Server DDoS Rules

list_dedicated_ddos_rules
Nur lesend

List DDoS protection rules for a dedicated server.

Berechtigung
dedicated.ddos.read
Freigabe beim Verbinden
Services einsehen

Parameter

  • serviceIdstringPflicht

    ID 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.

  • ipAddressstringoptional

List Dedicated Server DDoS Incidents

list_dedicated_ddos_incidents
Nur lesend

List DDoS incidents for a dedicated server.

Berechtigung
dedicated.ddos.read
Freigabe beim Verbinden
Services einsehen

Parameter

  • serviceIdstringPflicht

    ID 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.

  • ipAddressstringoptional
  • pageintegeroptional

    > 0 · max 9007199254740991

  • pageSizeintegeroptional

    > 0 · max 100

Get Dedicated Server DDoS Bandwidth

get_dedicated_ddos_bandwidth
Nur lesend

Get DDoS bandwidth statistics for a dedicated server.

Berechtigung
dedicated.ddos.read
Freigabe beim Verbinden
Services einsehen

Parameter

  • serviceIdstringPflicht

    ID 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.

  • rangestringoptional
  • ipAddressstringoptional

Get Dedicated Server Remote Management

get_dedicated_remote_management
Nur lesend

Get dedicated server remote management session state.

Berechtigung
dedicated.remote_management.manage
Freigabe beim Verbinden
Vollzugriff

Parameter

  • serviceIdstringPflicht

    ID 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 Server Custom ISOs

list_dedicated_custom_isos
Nur lesend

List custom ISO assets available for a dedicated server.

Berechtigung
dedicated.installation.manage
Freigabe beim Verbinden
Vollzugriff

Parameter

  • serviceIdstringPflicht

    ID 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 Server Reinstall Templates

list_dedicated_reinstall_templates
Nur lesend

List the OS installation ISOs of the dedicated server catalog. They are not installed automatically: mount one and install it through remote management.

Berechtigung
dedicated.reinstall
Freigabe beim Verbinden
Vollzugriff

Parameter

Keine Parameter

Start Dedicated Server

start_dedicated_server
VeränderndBestätigung nötig

Start a dedicated server. Requires confirm=true.

Berechtigung
dedicated.power.start
Freigabe beim Verbinden
Power-Aktionen

Parameter

  • serviceIdstringPflicht

    ID 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.

  • confirmbooleanoptional

Stop Dedicated Server

stop_dedicated_server
DestruktivBestätigung nötig

Stop a dedicated server. Requires confirm=true.

Berechtigung
dedicated.power.stop
Freigabe beim Verbinden
Power-Aktionen

Parameter

  • serviceIdstringPflicht

    ID 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"optional

  • confirmbooleanoptional

Restart Dedicated Server

restart_dedicated_server
DestruktivBestätigung nötig

Restart a dedicated server. Requires confirm=true.

Berechtigung
dedicated.power.restart
Freigabe beim Verbinden
Power-Aktionen

Parameter

  • serviceIdstringPflicht

    ID 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"optional

  • confirmbooleanoptional

Reinstall Dedicated Server

reinstall_dedicated_server
DestruktivBestätigung nötig

Reset 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.

Berechtigung
dedicated.reinstall
Freigabe beim Verbinden
Vollzugriff

Parameter

  • serviceIdstringPflicht

    ID 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.

  • osTemplateIdstringoptional

    Optional catalog template id; only validated, nothing is installed (the reset only wipes the disks).

  • confirmbooleanoptional

Wipe Dedicated Server

wipe_dedicated_server
DestruktivBestätigung nötig

Wipe a dedicated server. Requires confirm=true.

Berechtigung
dedicated.reinstall
Freigabe beim Verbinden
Vollzugriff

Parameter

  • serviceIdstringPflicht

    ID 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.

  • confirmbooleanoptional

Update Dedicated Server Reverse DNS

update_dedicated_reverse_dns
DestruktivBestätigung nötig

Update reverse DNS for a dedicated server. Requires confirm=true.

Berechtigung
dedicated.network.write
Freigabe beim Verbinden
Konfiguration ändern

Parameter

  • serviceIdstringPflicht

    ID 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.

  • ipAddressIdstringoptional
  • ipv6PrefixAllocationIdstringoptional
  • hostnamestringoptional
  • confirmbooleanoptional

Refresh Dedicated Server Installation

refresh_dedicated_installation
VeränderndBestätigung nötig

Refresh dedicated server installation media and boot state. Requires confirm=true.

Berechtigung
dedicated.installation.manage
Freigabe beim Verbinden
Vollzugriff

Parameter

  • serviceIdstringPflicht

    ID 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.

  • confirmbooleanoptional

Mount Dedicated Server Install Media

mount_dedicated_install_media
VeränderndBestätigung nötig

Mount install media on a dedicated server. Requires confirm=true.

Berechtigung
dedicated.installation.manage
Freigabe beim Verbinden
Vollzugriff

Parameter

  • serviceIdstringPflicht

    ID 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.

  • templateIdstringPflicht
  • confirmbooleanoptional

Unmount Dedicated Server Install Media

unmount_dedicated_install_media
VeränderndBestätigung nötig

Unmount install media from a dedicated server. Requires confirm=true.

Berechtigung
dedicated.installation.manage
Freigabe beim Verbinden
Vollzugriff

Parameter

  • serviceIdstringPflicht

    ID 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.

  • confirmbooleanoptional

Set Dedicated Server Next Boot Device

set_dedicated_next_boot
VeränderndBestätigung nötig

Set the next boot device for a dedicated server. Requires confirm=true.

Berechtigung
dedicated.installation.manage
Freigabe beim Verbinden
Vollzugriff

Parameter

  • serviceIdstringPflicht

    ID 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"Pflicht

  • confirmbooleanoptional

Enable Dedicated Server Rescue Mode

enable_dedicated_rescue
DestruktivBestätigung nötig

Enable rescue mode on a dedicated server. Requires confirm=true.

Berechtigung
dedicated.rescue.manage
Freigabe beim Verbinden
Vollzugriff

Parameter

  • serviceIdstringPflicht

    ID 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.

  • templateIdstringPflicht
  • confirmbooleanoptional

Disable Dedicated Server Rescue Mode

disable_dedicated_rescue
DestruktivBestätigung nötig

Disable rescue mode on a dedicated server. Requires confirm=true.

Berechtigung
dedicated.rescue.manage
Freigabe beim Verbinden
Vollzugriff

Parameter

  • serviceIdstringPflicht

    ID 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.

  • confirmbooleanoptional

Activate Dedicated Server Remote Management

activate_dedicated_remote_management
VeränderndBestätigung nötig

Activate remote management for a dedicated server. Requires confirm=true.

Berechtigung
dedicated.remote_management.manage
Freigabe beim Verbinden
Vollzugriff

Parameter

  • serviceIdstringPflicht

    ID 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

  • confirmbooleanoptional

Extend Dedicated Server Remote Management

extend_dedicated_remote_management
VeränderndBestätigung nötig

Extend remote management for a dedicated server. Requires confirm=true.

Berechtigung
dedicated.remote_management.manage
Freigabe beim Verbinden
Vollzugriff

Parameter

  • serviceIdstringPflicht

    ID 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.

  • confirmbooleanoptional

Revoke Dedicated Server Remote Management

revoke_dedicated_remote_management
DestruktivBestätigung nötig

Revoke remote management for a dedicated server. Requires confirm=true.

Berechtigung
dedicated.remote_management.manage
Freigabe beim Verbinden
Vollzugriff

Parameter

  • serviceIdstringPflicht

    ID 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.

  • confirmbooleanoptional

Launch Dedicated Server Remote Management

launch_dedicated_remote_management
DestruktivBestätigung nötig

Issue a remote management launch URL for a dedicated server. Requires confirm=true.

Berechtigung
dedicated.remote_management.manage
Freigabe beim Verbinden
Vollzugriff

Parameter

  • serviceIdstringPflicht

    ID 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.

  • confirmbooleanoptional

Turn Dedicated Server DDoS Protection On or Off

toggle_dedicated_ddos_protection
DestruktivBestätigung nötig

Toggle DDoS protection for a dedicated server. Requires confirm=true.

Berechtigung
dedicated.ddos.manage
Freigabe beim Verbinden
Konfiguration ändern

Parameter

  • serviceIdstringPflicht

    ID 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.

  • ipAddressstringoptional
  • enabledbooleanoptional

    Target state (true = protected). Without it the current state is flipped.

  • confirmbooleanoptional

Import Dedicated Server Custom ISO

import_dedicated_custom_iso
VeränderndBestätigung nötig

Import a custom ISO for dedicated servers. Requires confirm=true.

Berechtigung
dedicated.installation.manage
Freigabe beim Verbinden
Vollzugriff

Parameter

  • serviceIdstringPflicht

    ID 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.

  • displayNamestringPflicht
  • sourceUrlstringPflicht

    format uri

  • filenamestringoptional
  • confirmbooleanoptional

Delete Dedicated Server Custom ISO

delete_dedicated_custom_iso
DestruktivBestätigung nötig

Delete a custom ISO asset. Requires confirm=true.

Berechtigung
dedicated.installation.manage
Freigabe beim Verbinden
Vollzugriff

Parameter

  • serviceIdstringPflicht

    ID 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.

  • assetIdstringPflicht
  • confirmbooleanoptional

Mount Dedicated Server Custom ISO

mount_dedicated_custom_iso
VeränderndBestätigung nötig

Mount a custom ISO on a dedicated server. Requires confirm=true.

Berechtigung
dedicated.installation.manage
Freigabe beim Verbinden
Vollzugriff

Parameter

  • serviceIdstringPflicht

    ID 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.

  • assetIdstringPflicht
  • confirmbooleanoptional

TeamSpeak-Server

Status, Starten und Stoppen, Einstellungen, Clients, Bans und Berechtigungsschlüssel.

List TeamSpeak Servers

list_teamspeak_servers
Nur lesendStartpunkt

List TeamSpeak servers accessible with the current credential. Prefer list_account_services for cross-product discovery.

Berechtigung
teamspeak.view
Freigabe beim Verbinden
Services einsehen

Parameter

Keine Parameter

Get TeamSpeak Server

get_teamspeak_server
Nur lesendStartpunkt

Get one TeamSpeak server by ID.

Berechtigung
teamspeak.view
Freigabe beim Verbinden
Services einsehen

Parameter

  • serviceIdstringPflicht

    ID 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 Settings

get_teamspeak_config
Nur lesend

Read TeamSpeak server configuration.

Berechtigung
teamspeak.config.read
Freigabe beim Verbinden
Konfiguration lesen

Parameter

  • serviceIdstringPflicht

    ID 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 Settings

update_teamspeak_config
DestruktivBestätigung nötig

Update TeamSpeak server configuration. Requires confirm=true.

Berechtigung
teamspeak.config.manage
Freigabe beim Verbinden
Konfiguration ändern

Parameter

  • serviceIdstringPflicht

    ID 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>Pflicht
  • confirmbooleanoptional

List TeamSpeak Privilege Keys

list_teamspeak_tokens
Nur lesend

List privilege tokens for a TeamSpeak server.

Berechtigung
teamspeak.tokens.manage
Freigabe beim Verbinden
TeamSpeak-Verwaltung

Parameter

  • serviceIdstringPflicht

    ID 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 Privilege Key

create_teamspeak_token
DestruktivBestätigung nötig

Create a TeamSpeak privilege token. Requires confirm=true.

Berechtigung
teamspeak.tokens.manage
Freigabe beim Verbinden
TeamSpeak-Verwaltung

Parameter

  • serviceIdstringPflicht

    ID 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.

  • descriptionstringoptional

    max length 100

  • confirmbooleanoptional

Start TeamSpeak Server

start_teamspeak_server
VeränderndBestätigung nötig

Start a TeamSpeak server. Requires confirm=true.

Berechtigung
teamspeak.power.start
Freigabe beim Verbinden
Power-Aktionen

Parameter

  • serviceIdstringPflicht

    ID 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.

  • confirmbooleanoptional

Stop TeamSpeak Server

stop_teamspeak_server
DestruktivBestätigung nötig

Stop a TeamSpeak server. Requires confirm=true.

Berechtigung
teamspeak.power.stop
Freigabe beim Verbinden
Power-Aktionen

Parameter

  • serviceIdstringPflicht

    ID 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.

  • confirmbooleanoptional

Restart TeamSpeak Server

restart_teamspeak_server
DestruktivBestätigung nötig

Restart a TeamSpeak server. Requires confirm=true.

Berechtigung
teamspeak.power.restart
Freigabe beim Verbinden
Power-Aktionen

Parameter

  • serviceIdstringPflicht

    ID 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.

  • confirmbooleanoptional

Get TeamSpeak Metrics

get_teamspeak_metrics
Nur lesend

Get TeamSpeak server metrics.

Berechtigung
teamspeak.metrics.read
Freigabe beim Verbinden
Services einsehen

Parameter

  • serviceIdstringPflicht

    ID 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 Connected Clients

list_teamspeak_clients
Nur lesend

List connected TeamSpeak clients.

Berechtigung
teamspeak.clients.manage
Freigabe beim Verbinden
TeamSpeak-Verwaltung

Parameter

  • serviceIdstringPflicht

    ID 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 Bans

list_teamspeak_bans
Nur lesend

List TeamSpeak server bans.

Berechtigung
teamspeak.bans.manage
Freigabe beim Verbinden
TeamSpeak-Verwaltung

Parameter

  • serviceIdstringPflicht

    ID 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 Ban

add_teamspeak_ban
VeränderndBestätigung nötig

Add a TeamSpeak ban. Requires confirm=true.

Berechtigung
teamspeak.bans.manage
Freigabe beim Verbinden
TeamSpeak-Verwaltung

Parameter

  • serviceIdstringPflicht

    ID 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.

  • ipstringoptional
  • uidstringoptional
  • namestringoptional
  • timenumberoptional
  • reasonstringoptional
  • confirmbooleanoptional

Delete TeamSpeak Ban

delete_teamspeak_ban
DestruktivBestätigung nötig

Delete a TeamSpeak ban. Requires confirm=true.

Berechtigung
teamspeak.bans.manage
Freigabe beim Verbinden
TeamSpeak-Verwaltung

Parameter

  • serviceIdstringPflicht

    ID 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.

  • banIdintegerPflicht

    > 0 · max 9007199254740991

  • confirmbooleanoptional

Delete TeamSpeak Privilege Key

delete_teamspeak_token
DestruktivBestätigung nötig

Delete a TeamSpeak privilege token. Requires confirm=true.

Berechtigung
teamspeak.tokens.manage
Freigabe beim Verbinden
TeamSpeak-Verwaltung

Parameter

  • serviceIdstringPflicht

    ID 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.

  • tokenstringPflicht
  • confirmbooleanoptional

Discord-Bots

Status, Konsole, Starten und Stoppen sowie die Aktivität deiner Discord-Bots.

List Discord Bots

list_discord_bots
Nur lesendStartpunkt

List Discord bots accessible with the current token.

Berechtigung
discord_bot.view
Freigabe beim Verbinden
Services einsehen

Parameter

Keine Parameter

Get Discord Bot

get_discord_bot
Nur lesendStartpunkt

Get Discord bot details.

Berechtigung
discord_bot.view
Freigabe beim Verbinden
Services einsehen

Parameter

  • serviceIdstringPflicht

    ID 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 Status

get_discord_bot_container_status
Nur lesend

Get Discord bot container and port reachability status.

Berechtigung
discord_bot.view
Freigabe beim Verbinden
Services einsehen

Parameter

  • serviceIdstringPflicht

    ID 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 Activity

get_discord_bot_activity
Nur lesend

Read recent Discord bot activity logs.

Berechtigung
discord_bot.view
Freigabe beim Verbinden
Services einsehen

Parameter

  • serviceIdstringPflicht

    ID 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.

  • limitintegeroptional

    min 1 · max 100

  • offsetintegeroptional

    min 0 · max 9007199254740991

Start Discord Bot

start_discord_bot
VeränderndBestätigung nötig

Start a Discord bot. Requires confirm=true.

Berechtigung
discord_bot.start
Freigabe beim Verbinden
Power-Aktionen

Parameter

  • serviceIdstringPflicht

    ID 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.

  • confirmbooleanoptional

Stop Discord Bot

stop_discord_bot
DestruktivBestätigung nötig

Stop a Discord bot. Requires confirm=true.

Berechtigung
discord_bot.stop
Freigabe beim Verbinden
Power-Aktionen

Parameter

  • serviceIdstringPflicht

    ID 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.

  • confirmbooleanoptional

Restart Discord Bot

restart_discord_bot
DestruktivBestätigung nötig

Restart a Discord bot. Requires confirm=true.

Berechtigung
discord_bot.restart
Freigabe beim Verbinden
Power-Aktionen

Parameter

  • serviceIdstringPflicht

    ID 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.

  • confirmbooleanoptional

Get Discord Bot Console Logs

get_discord_bot_console_logs
Nur lesend

Get recent Discord bot console log lines.

Berechtigung
discord_bot.console.read
Freigabe beim Verbinden
Konsole & Logs

Parameter

  • serviceIdstringPflicht

    ID 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.

  • linesintegeroptional

    Number of recent log lines to return, 1-200 (default 50). Values above 200 are rejected.

    > 0 · max 200

Send Discord Bot Console Command

send_discord_bot_console_command
DestruktivBestätigung nötig

Send a command to the Discord bot console. Requires confirm=true.

Berechtigung
discord_bot.console.write
Freigabe beim Verbinden
Konsole & Logs

Parameter

  • serviceIdstringPflicht

    ID 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.

  • commandstringPflicht

    max length 500

  • confirmbooleanoptional

Domains

Domains, DNS-Einträge, Nameserver, Parkseite und automatische Verlängerung.

List Domains

list_domains
Nur lesendStartpunkt

List domains accessible with the current credential (own and shared): name, status, dnsMode (managed = ZapX nameservers, external = own nameservers), auto-renew, expiry, nameservers. Read-only.

Berechtigung
domain.view
Freigabe beim Verbinden
Services einsehen

Parameter

Keine Parameter

Get Domain

get_domain
Nur lesend

Get one domain by ID. Read-only.

Berechtigung
domain.view
Freigabe beim Verbinden
Services einsehen

Parameter

  • domainIdstringPflicht

    Domain id (from list_domains or list_account_services).

Get Domain DNS Records

get_domain_dns_records
Nur lesendStartpunkt

List 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.

Berechtigung
domain.dns.read
Freigabe beim Verbinden
Konfiguration lesen

Parameter

  • domainIdstringPflicht

    Domain id (from list_domains or list_account_services).

Create Domain DNS Record

create_domain_dns_record
VeränderndBestätigung nötig

Create 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.

Berechtigung
domain.dns.write
Freigabe beim Verbinden
Domain-Verwaltung

Parameter

  • domainIdstringPflicht

    Domain id (from list_domains or list_account_services).

  • type"A" | "AAAA" | "CAA" | "CNAME" | "MX" | "NS" | "SRV" | "SSHFP" | "TLSA" | "TXT"Pflicht

    Record type.

  • namestringoptional

    Record name relative to the domain: '@' (default) for the domain itself, 'www', '_acme-challenge', ...

    max length 253

  • contentstringPflicht

    Record value (IP address, hostname, TXT text, ...).

    max length 4096

  • ttlintegeroptional

    TTL in seconds (default 3600, min 60).

    min 60 · max 9007199254740991

  • priorityintegeroptional

    MX/SRV priority.

    min 0 · max 65535

  • weightintegeroptional

    SRV weight.

    min 0 · max 65535

  • portintegeroptional

    SRV port.

    min 0 · max 65535

  • confirmbooleanoptional

    Must be true to apply the change.

Update Domain DNS Record

update_domain_dns_record
DestruktivBestätigung nötig

Replace 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.

Berechtigung
domain.dns.write
Freigabe beim Verbinden
Domain-Verwaltung

Parameter

  • domainIdstringPflicht

    Domain id (from list_domains or list_account_services).

  • recordIdstringPflicht

    Record id from get_domain_dns_records.

  • type"A" | "AAAA" | "CAA" | "CNAME" | "MX" | "NS" | "SRV" | "SSHFP" | "TLSA" | "TXT"Pflicht

    Record type.

  • namestringoptional

    Record name relative to the domain: '@' (default) for the domain itself, 'www', '_acme-challenge', ...

    max length 253

  • contentstringPflicht

    Record value (IP address, hostname, TXT text, ...).

    max length 4096

  • ttlintegeroptional

    TTL in seconds (default 3600, min 60).

    min 60 · max 9007199254740991

  • priorityintegeroptional

    MX/SRV priority.

    min 0 · max 65535

  • weightintegeroptional

    SRV weight.

    min 0 · max 65535

  • portintegeroptional

    SRV port.

    min 0 · max 65535

  • confirmbooleanoptional

    Must be true to apply the change.

Delete Domain DNS Record

delete_domain_dns_record
DestruktivBestätigung nötig

Delete 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.

Berechtigung
domain.dns.write
Freigabe beim Verbinden
Domain-Verwaltung

Parameter

  • domainIdstringPflicht

    Domain id (from list_domains or list_account_services).

  • recordIdstringPflicht

    Record id from get_domain_dns_records.

  • confirmbooleanoptional

    Must be true to apply the change.

Set Domain Parking Page

set_domain_parking_page
DestruktivBestätigung nötig

Switch 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.

Berechtigung
domain.dns.write
Freigabe beim Verbinden
Domain-Verwaltung

Parameter

  • domainIdstringPflicht

    Domain id (from list_domains or list_account_services).

  • enabledbooleanPflicht

    true = show the ZapX parking page, false = remove it.

  • confirmedReplaceRecordIdsstring[]optional

    Ids of the own records the previous call listed under `replace` (switching on only).

    max items 200

  • confirmbooleanoptional

    Must be true to apply the change.

Get Domain Nameservers

get_domain_nameservers
Nur lesend

Read the nameserver delegation of a domain (dnsMode managed/external and the nameservers). Read-only.

Berechtigung
domain.dns.read
Freigabe beim Verbinden
Konfiguration lesen

Parameter

  • domainIdstringPflicht

    Domain id (from list_domains or list_account_services).

Set Domain Nameservers

set_domain_nameservers
DestruktivBestätigung nötig

Change 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.

Berechtigung
domain.nameservers.write
Freigabe beim Verbinden
Domain-Verwaltung

Parameter

  • domainIdstringPflicht

    Domain id (from list_domains or list_account_services).

  • mode"managed" | "external"Pflicht

    managed = ZapX nameservers (DNS records editable here), external = own nameservers.

  • nameserversstring[]optional

    External nameserver hostnames (mode external only, 2-13 distinct).

    min items 2 · max items 13

  • confirmbooleanoptional

    Must be true to apply the change.

Get Domain Renewal Status

get_domain_renewal
Nur lesend

Read the renewal state of a domain (domain owner only): autoRenew, expiresAt, registrarStatus, scheduledDeletionAt, nextRenewalChargeAt. Read-only.

Berechtigung
domain.view
Freigabe beim Verbinden
Services einsehen

Parameter

  • domainIdstringPflicht

    Domain id (from list_domains or list_account_services).

Set Domain Auto-Renew

set_domain_auto_renew
DestruktivBestätigung nötig

Turn 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.

Berechtigung
domain.renewal.manage
Freigabe beim Verbinden
Domain-Verwaltung

Parameter

  • domainIdstringPflicht

    Domain id (from list_domains or list_account_services).

  • autoRenewbooleanPflicht

    false = the domain is not renewed (nor charged) at the end of its term and expires.

  • confirmbooleanoptional

    Must be true to apply the change.

Dateien

Dateien von Gameservern und Discord-Bots auflisten, lesen, schreiben, umbenennen und löschen.

List Discord Bot Files

list_discord_bot_files
Nur lesendStartpunkt

List files in a Discord bot directory.

Berechtigung
discord_bot.files.read
Freigabe beim Verbinden
Konfiguration lesen

Parameter

  • serviceIdstringPflicht

    ID 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.

  • pathstringoptional
  • includeFolderSizesbooleanoptional

Read Discord Bot File

read_discord_bot_file
Nur lesend

Read an editable text file from a Discord bot.

Berechtigung
discord_bot.files.read
Freigabe beim Verbinden
Konfiguration lesen

Parameter

  • serviceIdstringPflicht

    ID 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.

  • pathstringPflicht

Edit Discord Bot File

mutate_discord_bot_file
DestruktivBestätigung nötig

Create, rename, delete, or write Discord bot file content. Destructive actions require confirm=true.

Berechtigung
discord_bot.files.write
Freigabe beim Verbinden
Konfiguration ändern

Parameter

  • serviceIdstringPflicht

    ID 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"Pflicht

  • pathstringPflicht
  • contentstringoptional
  • expectedRevisionstringoptional

    `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.

  • newNamestringoptional
  • confirmbooleanoptional

List Game Server Files

list_gameserver_files
Nur lesendStartpunkt

List files in a gameserver directory.

Berechtigung
gameserver.files.read
Freigabe beim Verbinden
Konfiguration lesen

Parameter

  • serviceIdstringPflicht

    ID of the Gameserver: the "id" field from list_account_services or list_gameservers (e.g. "cmabc123..."). The numericId shown in the panel (e.g. "180") is accepted too. IDs of other service types do not work here.

  • pathstringoptional
  • scope"savegame" | "config" | "active"optional

    `savegame` restricts to savegame paths; `config`/`active` resolve paths from the game data root.

  • includeFolderSizesbooleanoptional

Read Game Server File

read_gameserver_file
Nur lesend

Read text content of a gameserver file.

Berechtigung
gameserver.files.read
Freigabe beim Verbinden
Konfiguration lesen

Parameter

  • serviceIdstringPflicht

    ID of the Gameserver: the "id" field from list_account_services or list_gameservers (e.g. "cmabc123..."). The numericId shown in the panel (e.g. "180") is accepted too. IDs of other service types do not work here.

  • pathstringPflicht
  • scope"savegame" | "config" | "active"optional

    `savegame` restricts to savegame paths; `config`/`active` resolve paths from the game data root.

Edit Game Server File

mutate_gameserver_file
DestruktivBestätigung nötig

Create, 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.

Berechtigung
gameserver.files.write
Freigabe beim Verbinden
Konfiguration ändern

Parameter

  • serviceIdstringPflicht

    ID of the Gameserver: the "id" field from list_account_services or list_gameservers (e.g. "cmabc123..."). The numericId shown in the panel (e.g. "180") is accepted too. IDs of other service types do not work here.

  • action"write" | "create_file" | "create_dir" | "rename" | "delete" | "move" | "copy"Pflicht

  • pathstringoptional

    File or folder to act on (required except for move/copy given `paths`). For move/copy: the single entry to transfer.

  • contentstringoptional
  • expectedRevisionstringoptional

    `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.

  • newNamestringoptional
  • pathsstring[]optional

    move/copy: several entries to transfer at once (overrides path).

    min items 1 · max items 100

  • destinationstringoptional

    move/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.

  • confirmbooleanoptional

One-Click-Apps (vServer und Dedicated)

App-Katalog (Pterodactyl, Nextcloud, n8n, ...), Installation, Start/Stopp/Neustart, Logs und Deinstallation; Gameserver in Pterodactyl legst du in dessen eigenem Panel an.

List VPS One-Click Apps

get_vserver_apps
Nur lesendStartpunkt

One-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.

Berechtigung
vserver.apps.read
Freigabe beim Verbinden
Konfiguration lesen

Parameter

  • serviceIdstringPflicht

    ID 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.

  • livebooleanoptional

    Ask the panel for the live status (slower; needs the manage permission), default the stored status.

Search VPS App Catalog

list_vserver_app_catalog
Nur lesend

Search the One-Click Apps catalog for a VPS (name, description, category, paged). Use the type with get_vserver_app_catalog_entry before installing.

Berechtigung
vserver.apps.read
Freigabe beim Verbinden
Konfiguration lesen

Parameter

  • serviceIdstringPflicht

    ID 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.

  • searchstringoptional

    Free text search over name, description and tags.

    max length 200

  • categorystringoptional

    max length 100

  • pageintegeroptional

    > 0 · max 9007199254740991

  • pageSizeintegeroptional

    > 0 · max 50

Get VPS App Catalog Entry

get_vserver_app_catalog_entry
Nur lesend

One 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).

Berechtigung
vserver.apps.read
Freigabe beim Verbinden
Konfiguration lesen

Parameter

  • serviceIdstringPflicht

    ID 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.

  • catalogTypestringPflicht

    max length 128

Get VPS App Logs

get_vserver_app_logs
Nur lesend

Recent container logs of an installed One-Click App on a VPS (secrets and login links removed). Read them before suggesting a restart.

Berechtigung
vserver.apps.read
Freigabe beim Verbinden
Konfiguration lesen

Parameter

  • serviceIdstringPflicht

    ID 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.

  • installationIdstringPflicht

    Installation id from get_vserver_apps / get_dedicated_apps.

    max length 64

  • linesintegeroptional

    min 50 · max 500

Install VPS One-Click App

install_vserver_app
VeränderndBestätigung nötig

Install 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.

Berechtigung
vserver.apps.manage
Freigabe beim Verbinden
Konfiguration ändern

Parameter

  • serviceIdstringPflicht

    ID 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.

  • catalogTypestringPflicht

    Catalog type from the app catalog.

    max length 128

  • displayNamestringPflicht

    min length 2 · max length 80

  • envValuesRecord<string, string>optional

    Non-secret catalog fields only (see the catalog entry's install.requiredCustomerEnvFields).

  • customEnvsobject[]optional

    max items 50

  • confirmbooleanoptional
  • withoutHostnamebooleanoptional

    Skip the default HTTPS zap.cloud address (only when the user wants no domain).

Start, Stop or Restart VPS App

manage_vserver_app
DestruktivBestätigung nötig

Start, stop or restart an installed One-Click App on a VPS. Requires confirm=true.

Berechtigung
vserver.apps.manage
Freigabe beim Verbinden
Konfiguration ändern

Parameter

  • serviceIdstringPflicht

    ID 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.

  • installationIdstringPflicht

    Installation id from get_vserver_apps / get_dedicated_apps.

    max length 64

  • action"start" | "stop" | "restart"Pflicht

  • confirmbooleanoptional

Uninstall VPS One-Click App

uninstall_vserver_app
DestruktivBestätigung nötig

Uninstall a One-Click App from a VPS. Keeps the app data unless deleteVolumes=true. Requires confirm=true.

Berechtigung
vserver.apps.manage
Freigabe beim Verbinden
Konfiguration ändern

Parameter

  • serviceIdstringPflicht

    ID 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.

  • installationIdstringPflicht

    Installation id from get_vserver_apps / get_dedicated_apps.

    max length 64

  • deleteVolumesbooleanoptional

    Also delete the app's persistent data (volumes). Only when the user explicitly asked for it; default keeps the data.

  • confirmbooleanoptional

Reinstall VPS One-Click App

reinstall_vserver_app
DestruktivBestätigung nötig

Reinstall a One-Click App on a VPS (redeploys it; keeps the data unless deleteVolumes=true). Requires confirm=true.

Berechtigung
vserver.apps.manage
Freigabe beim Verbinden
Konfiguration ändern

Parameter

  • serviceIdstringPflicht

    ID 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.

  • installationIdstringPflicht

    Installation id from get_vserver_apps / get_dedicated_apps.

    max length 64

  • deleteVolumesbooleanoptional

    Also delete the app's persistent data (volumes). Only when the user explicitly asked for it; default keeps the data.

  • confirmbooleanoptional

List Dedicated Server One-Click Apps

get_dedicated_apps
Nur lesendStartpunkt

One-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.

Berechtigung
dedicated.apps.read
Freigabe beim Verbinden
Konfiguration lesen

Parameter

  • serviceIdstringPflicht

    ID 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.

  • livebooleanoptional

    Ask the panel for the live status (slower; needs the manage permission), default the stored status.

Search Dedicated Server App Catalog

list_dedicated_app_catalog
Nur lesend

Search the One-Click Apps catalog for a dedicated server (name, description, category, paged). Use the type with get_dedicated_app_catalog_entry before installing.

Berechtigung
dedicated.apps.read
Freigabe beim Verbinden
Konfiguration lesen

Parameter

  • serviceIdstringPflicht

    ID 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.

  • searchstringoptional

    Free text search over name, description and tags.

    max length 200

  • categorystringoptional

    max length 100

  • pageintegeroptional

    > 0 · max 9007199254740991

  • pageSizeintegeroptional

    > 0 · max 50

Get Dedicated Server App Catalog Entry

get_dedicated_app_catalog_entry
Nur lesend

One 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).

Berechtigung
dedicated.apps.read
Freigabe beim Verbinden
Konfiguration lesen

Parameter

  • serviceIdstringPflicht

    ID 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.

  • catalogTypestringPflicht

    max length 128

Get Dedicated Server App Logs

get_dedicated_app_logs
Nur lesend

Recent container logs of an installed One-Click App on a dedicated server (secrets and login links removed). Read them before suggesting a restart.

Berechtigung
dedicated.apps.read
Freigabe beim Verbinden
Konfiguration lesen

Parameter

  • serviceIdstringPflicht

    ID 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.

  • installationIdstringPflicht

    Installation id from get_vserver_apps / get_dedicated_apps.

    max length 64

  • linesintegeroptional

    min 50 · max 500

Install Dedicated Server One-Click App

install_dedicated_app
VeränderndBestätigung nötig

Install 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.

Berechtigung
dedicated.apps.manage
Freigabe beim Verbinden
Konfiguration ändern

Parameter

  • serviceIdstringPflicht

    ID 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.

  • catalogTypestringPflicht

    Catalog type from the app catalog.

    max length 128

  • displayNamestringPflicht

    min length 2 · max length 80

  • envValuesRecord<string, string>optional

    Non-secret catalog fields only (see the catalog entry's install.requiredCustomerEnvFields).

  • customEnvsobject[]optional

    max items 50

  • confirmbooleanoptional

Start, Stop or Restart Dedicated Server App

manage_dedicated_app
DestruktivBestätigung nötig

Start, stop or restart an installed One-Click App on a dedicated server. Requires confirm=true.

Berechtigung
dedicated.apps.manage
Freigabe beim Verbinden
Konfiguration ändern

Parameter

  • serviceIdstringPflicht

    ID 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.

  • installationIdstringPflicht

    Installation id from get_vserver_apps / get_dedicated_apps.

    max length 64

  • action"start" | "stop" | "restart"Pflicht

  • confirmbooleanoptional

Uninstall Dedicated Server One-Click App

uninstall_dedicated_app
DestruktivBestätigung nötig

Uninstall a One-Click App from a dedicated server. Keeps the app data unless deleteVolumes=true. Requires confirm=true.

Berechtigung
dedicated.apps.manage
Freigabe beim Verbinden
Konfiguration ändern

Parameter

  • serviceIdstringPflicht

    ID 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.

  • installationIdstringPflicht

    Installation id from get_vserver_apps / get_dedicated_apps.

    max length 64

  • deleteVolumesbooleanoptional

    Also delete the app's persistent data (volumes). Only when the user explicitly asked for it; default keeps the data.

  • confirmbooleanoptional

Reinstall Dedicated Server One-Click App

reinstall_dedicated_app
DestruktivBestätigung nötig

Reinstall a One-Click App on a dedicated server (redeploys it; keeps the data unless deleteVolumes=true). Requires confirm=true.

Berechtigung
dedicated.apps.manage
Freigabe beim Verbinden
Konfiguration ändern

Parameter

  • serviceIdstringPflicht

    ID 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.

  • installationIdstringPflicht

    Installation id from get_vserver_apps / get_dedicated_apps.

    max length 64

  • deleteVolumesbooleanoptional

    Also delete the app's persistent data (volumes). Only when the user explicitly asked for it; default keeps the data.

  • confirmbooleanoptional

Backups und Snapshots

Backups und Snapshots anlegen, wiederherstellen und löschen.

List Game Server Backups

list_gameserver_backups
Nur lesendStartpunkt

List gameserver backups.

Berechtigung
gameserver.backups.read
Freigabe beim Verbinden
Konfiguration lesen

Parameter

  • serviceIdstringPflicht

    ID of the Gameserver: the "id" field from list_account_services or list_gameservers (e.g. "cmabc123..."). The numericId shown in the panel (e.g. "180") is accepted too. IDs of other service types do not work here.

Create Game Server Backup

create_gameserver_backup
DestruktivBestätigung nötig

Create a gameserver backup. Requires confirm=true.

Berechtigung
gameserver.backups.manage
Freigabe beim Verbinden
Konfiguration ändern

Parameter

  • serviceIdstringPflicht

    ID of the Gameserver: the "id" field from list_account_services or list_gameservers (e.g. "cmabc123..."). The numericId shown in the panel (e.g. "180") is accepted too. IDs of other service types do not work here.

  • namestringoptional

    max length 120

  • confirmbooleanoptional

Delete Game Server Backup

delete_gameserver_backup
DestruktivBestätigung nötig

Delete a gameserver backup. Requires confirm=true.

Berechtigung
gameserver.backups.manage
Freigabe beim Verbinden
Konfiguration ändern

Parameter

  • serviceIdstringPflicht

    ID of the Gameserver: the "id" field from list_account_services or list_gameservers (e.g. "cmabc123..."). The numericId shown in the panel (e.g. "180") is accepted too. IDs of other service types do not work here.

  • backupIdstringPflicht
  • confirmbooleanoptional

Restore Game Server Backup

restore_gameserver_backup
DestruktivBestätigung nötig

Restore a gameserver backup. Requires confirm=true.

Berechtigung
gameserver.backups.manage
Freigabe beim Verbinden
Konfiguration ändern

Parameter

  • serviceIdstringPflicht

    ID of the Gameserver: the "id" field from list_account_services or list_gameservers (e.g. "cmabc123..."). The numericId shown in the panel (e.g. "180") is accepted too. IDs of other service types do not work here.

  • backupIdstringPflicht
  • confirmbooleanoptional

List VPS Backups

list_vserver_backups
Nur lesendStartpunkt

List VPS backups.

Berechtigung
vserver.backups.read
Freigabe beim Verbinden
Konfiguration lesen

Parameter

  • serviceIdstringPflicht

    ID 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 VPS Snapshots

list_vserver_snapshots
Nur lesend

List VPS VM snapshots.

Berechtigung
vserver.backups.read
Freigabe beim Verbinden
Konfiguration lesen

Parameter

  • serviceIdstringPflicht

    ID 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 VPS Snapshot

create_vserver_snapshot
VeränderndBestätigung nötig

Create a VPS VM snapshot. Requires confirm=true.

Berechtigung
vserver.backups.manage
Freigabe beim Verbinden
Konfiguration ändern

Parameter

  • serviceIdstringPflicht

    ID 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.

  • namestringPflicht
  • descriptionstringoptional
  • includeRambooleanoptional
  • confirmbooleanoptional

Delete VPS Snapshot

delete_vserver_snapshot
DestruktivBestätigung nötig

Delete a VPS VM snapshot. Requires confirm=true.

Berechtigung
vserver.backups.manage
Freigabe beim Verbinden
Konfiguration ändern

Parameter

  • serviceIdstringPflicht

    ID 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.

  • namestringPflicht
  • confirmbooleanoptional

Roll Back VPS to Snapshot

rollback_vserver_snapshot
DestruktivBestätigung nötig

Roll back a VPS to a named snapshot. Requires confirm=true.

Berechtigung
vserver.backups.manage
Freigabe beim Verbinden
Konfiguration ändern

Parameter

  • serviceIdstringPflicht

    ID 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.

  • namestringPflicht
  • confirmbooleanoptional

Create VPS Backup

create_vserver_backup
VeränderndBestätigung nötig

Create a VPS backup. Requires confirm=true.

Berechtigung
vserver.backups.manage
Freigabe beim Verbinden
Konfiguration ändern

Parameter

  • serviceIdstringPflicht

    ID 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.

  • notesstringoptional

    max length 500

  • confirmbooleanoptional

Delete VPS Backup

delete_vserver_backup
DestruktivBestätigung nötig

Delete a VPS backup. Requires confirm=true.

Berechtigung
vserver.backups.manage
Freigabe beim Verbinden
Konfiguration ändern

Parameter

  • serviceIdstringPflicht

    ID 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.

  • backupIdstringPflicht
  • confirmbooleanoptional

Restore VPS Backup

restore_vserver_backup
DestruktivBestätigung nötig

Restore a VPS backup. Requires confirm=true.

Berechtigung
vserver.backups.manage
Freigabe beim Verbinden
Konfiguration ändern

Parameter

  • serviceIdstringPflicht

    ID 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.

  • backupIdstringPflicht
  • confirmbooleanoptional

Tarifwechsel

Upgrades und Downgrades mit Preisvorschau, ausgeführt erst nach deiner ausdrücklichen Bestätigung.

Get Game Server Plan Change Options

get_gameserver_plan_change_options
Nur lesendStartpunktNicht im ChatGPT- und Claude-Connector

List 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.

Bestellungen und Tarifwechsel sind in den Connectoren aus den App-Verzeichnissen von ChatGPT und Claude ausgeblendet. In Claude Code, Cursor und mit API-Schlüssel steht das Tool zur Verfügung.

Berechtigung
gameserver.plan_change
Freigabe beim Verbinden
Plan-Änderungen

Parameter

  • serviceIdstringPflicht

    ID of the Gameserver: the "id" field from list_account_services or list_gameservers (e.g. "cmabc123..."). The numericId shown in the panel (e.g. "180") is accepted too. IDs of other service types do not work here.

Preview Game Server Plan Change

preview_gameserver_plan_change
Nur lesendNicht im ChatGPT- und Claude-Connector

Return 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.

Bestellungen und Tarifwechsel sind in den Connectoren aus den App-Verzeichnissen von ChatGPT und Claude ausgeblendet. In Claude Code, Cursor und mit API-Schlüssel steht das Tool zur Verfügung.

Berechtigung
gameserver.plan_change
Freigabe beim Verbinden
Plan-Änderungen

Parameter

  • serviceIdstringPflicht

    ID of the Gameserver: the "id" field from list_account_services or list_gameservers (e.g. "cmabc123..."). The numericId shown in the panel (e.g. "180") is accepted too. IDs of other service types do not work here.

  • targetobjectoptional
  • target.pricingMode"package" | "custom"optional

  • target.targetPackageKeystringoptional
  • target.ramMbintegeroptional

    > 0 · max 9007199254740991

  • target.cpuMillisintegeroptional

    > 0 · max 9007199254740991

  • target.diskMbintegeroptional

    > 0 · max 9007199254740991

  • target.slotsintegeroptional

    > 0 · max 9007199254740991

  • target.dedicatedIpbooleanoptional
  • target.premiumCpubooleanoptional

    Premium 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.targetRegionIdstringoptional
  • target.targetBillingIntervalCountintegeroptional

    > 0 · max 9007199254740991

  • couponCodestringoptional

    Optional 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 Game Server Plan Change

apply_gameserver_plan_change
DestruktivBestätigung nötigNicht im ChatGPT- und Claude-Connector

Execute 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.

Bestellungen und Tarifwechsel sind in den Connectoren aus den App-Verzeichnissen von ChatGPT und Claude ausgeblendet. In Claude Code, Cursor und mit API-Schlüssel steht das Tool zur Verfügung.

Berechtigung
gameserver.plan_change
Freigabe beim Verbinden
Plan-Änderungen

Parameter

  • serviceIdstringPflicht

    ID of the Gameserver: the "id" field from list_account_services or list_gameservers (e.g. "cmabc123..."). The numericId shown in the panel (e.g. "180") is accepted too. IDs of other service types do not work here.

  • targetobjectoptional
  • target.pricingMode"package" | "custom"optional

  • target.targetPackageKeystringoptional
  • target.ramMbintegeroptional

    > 0 · max 9007199254740991

  • target.cpuMillisintegeroptional

    > 0 · max 9007199254740991

  • target.diskMbintegeroptional

    > 0 · max 9007199254740991

  • target.slotsintegeroptional

    > 0 · max 9007199254740991

  • target.dedicatedIpbooleanoptional
  • target.premiumCpubooleanoptional

    Premium 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.targetRegionIdstringoptional
  • target.targetBillingIntervalCountintegeroptional

    > 0 · max 9007199254740991

  • couponCodestringoptional

    Optional 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

  • confirmtruePflicht
  • userExplicitlyConfirmedtruePflicht
  • previewConfirmationNoncestringPflicht
  • requestImmediateStartbooleanoptional

    Express 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 VPS Plan Change Options

get_vserver_plan_change_options
Nur lesend

List 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.

Berechtigung
vserver.plan_change
Freigabe beim Verbinden
Plan-Änderungen

Parameter

  • serviceIdstringPflicht

    ID 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 VPS Plan Change

preview_vserver_plan_change
Nur lesend

Return 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.

Berechtigung
vserver.plan_change
Freigabe beim Verbinden
Plan-Änderungen

Parameter

  • serviceIdstringPflicht

    ID 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.

  • targetobjectoptional
  • target.pricingMode"package" | "custom"optional

    Set "custom" to change cores, memoryMb, diskGb or bandwidthMbps on a package VPS (otherwise the request is rejected); use targetPackageKey to switch package.

  • target.targetPackageKeystringoptional
  • target.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.additionalIpCountintegeroptional

    min 0 · max 9007199254740991

  • target.targetBillingIntervalCountintegeroptional

    > 0 · max 9007199254740991

  • couponCodestringoptional

    Optional 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 VPS Plan Change

apply_vserver_plan_change
DestruktivBestätigung nötig

Execute 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.

Berechtigung
vserver.plan_change
Freigabe beim Verbinden
Plan-Änderungen

Parameter

  • serviceIdstringPflicht

    ID 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.

  • targetobjectoptional
  • target.pricingMode"package" | "custom"optional

    Set "custom" to change cores, memoryMb, diskGb or bandwidthMbps on a package VPS (otherwise the request is rejected); use targetPackageKey to switch package.

  • target.targetPackageKeystringoptional
  • target.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.additionalIpCountintegeroptional

    min 0 · max 9007199254740991

  • target.targetBillingIntervalCountintegeroptional

    > 0 · max 9007199254740991

  • couponCodestringoptional

    Optional 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

  • confirmtruePflicht
  • userExplicitlyConfirmedtruePflicht
  • previewConfirmationNoncestringPflicht
  • requestImmediateStartbooleanoptional

    Express 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 Options

get_teamspeak_plan_change_options
Nur lesendNicht im ChatGPT- und Claude-Connector

List available TeamSpeak plan-change options and constraints for a service. Use preview_teamspeak_plan_change for the full change overview with pricing before applying.

Bestellungen und Tarifwechsel sind in den Connectoren aus den App-Verzeichnissen von ChatGPT und Claude ausgeblendet. In Claude Code, Cursor und mit API-Schlüssel steht das Tool zur Verfügung.

Berechtigung
teamspeak.plan_change
Freigabe beim Verbinden
Plan-Änderungen

Parameter

  • serviceIdstringPflicht

    ID 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 Change

preview_teamspeak_plan_change
Nur lesendNicht im ChatGPT- und Claude-Connector

Return 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.

Bestellungen und Tarifwechsel sind in den Connectoren aus den App-Verzeichnissen von ChatGPT und Claude ausgeblendet. In Claude Code, Cursor und mit API-Schlüssel steht das Tool zur Verfügung.

Berechtigung
teamspeak.plan_change
Freigabe beim Verbinden
Plan-Änderungen

Parameter

  • serviceIdstringPflicht

    ID 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.

  • targetobjectoptional
  • target.pricingMode"package" | "custom"optional

    Set "custom" to change slots on a package TeamSpeak server (otherwise the request is rejected); use targetPackageKey to switch package.

  • target.targetPackageKeystringoptional
  • target.slotsintegeroptional

    > 0 · max 9007199254740991

  • target.hasAdvertisementbooleanoptional
  • target.targetBillingIntervalCountintegeroptional

    > 0 · max 9007199254740991

  • couponCodestringoptional

    Optional 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 Change

apply_teamspeak_plan_change
DestruktivBestätigung nötigNicht im ChatGPT- und Claude-Connector

Execute 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.

Bestellungen und Tarifwechsel sind in den Connectoren aus den App-Verzeichnissen von ChatGPT und Claude ausgeblendet. In Claude Code, Cursor und mit API-Schlüssel steht das Tool zur Verfügung.

Berechtigung
teamspeak.plan_change
Freigabe beim Verbinden
Plan-Änderungen

Parameter

  • serviceIdstringPflicht

    ID 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.

  • targetobjectoptional
  • target.pricingMode"package" | "custom"optional

    Set "custom" to change slots on a package TeamSpeak server (otherwise the request is rejected); use targetPackageKey to switch package.

  • target.targetPackageKeystringoptional
  • target.slotsintegeroptional

    > 0 · max 9007199254740991

  • target.hasAdvertisementbooleanoptional
  • target.targetBillingIntervalCountintegeroptional

    > 0 · max 9007199254740991

  • couponCodestringoptional

    Optional 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

  • confirmtruePflicht
  • userExplicitlyConfirmedtruePflicht
  • previewConfirmationNoncestringPflicht
  • requestImmediateStartbooleanoptional

    Express 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 Server Plan Change Options

get_dedicated_plan_change_options
Nur lesendNicht im ChatGPT- und Claude-Connector

List 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.

Bestellungen und Tarifwechsel sind in den Connectoren aus den App-Verzeichnissen von ChatGPT und Claude ausgeblendet. In Claude Code, Cursor und mit API-Schlüssel steht das Tool zur Verfügung.

Berechtigung
dedicated.plan_change
Freigabe beim Verbinden
Plan-Änderungen

Parameter

  • serviceIdstringPflicht

    ID 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 Server Plan Change

preview_dedicated_plan_change
Nur lesendNicht im ChatGPT- und Claude-Connector

Return 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.

Bestellungen und Tarifwechsel sind in den Connectoren aus den App-Verzeichnissen von ChatGPT und Claude ausgeblendet. In Claude Code, Cursor und mit API-Schlüssel steht das Tool zur Verfügung.

Berechtigung
dedicated.plan_change
Freigabe beim Verbinden
Plan-Änderungen

Parameter

  • serviceIdstringPflicht

    ID 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.

  • targetobjectoptional
  • target.additionalIpCountintegeroptional

    min 0 · max 9007199254740991

  • target.releaseIpAssignmentIdsstring[]optional
  • couponCodestringoptional

    Optional 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 Server Plan Change

apply_dedicated_plan_change
DestruktivBestätigung nötigNicht im ChatGPT- und Claude-Connector

Execute 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.

Bestellungen und Tarifwechsel sind in den Connectoren aus den App-Verzeichnissen von ChatGPT und Claude ausgeblendet. In Claude Code, Cursor und mit API-Schlüssel steht das Tool zur Verfügung.

Berechtigung
dedicated.plan_change
Freigabe beim Verbinden
Plan-Änderungen

Parameter

  • serviceIdstringPflicht

    ID 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.

  • targetobjectoptional
  • target.additionalIpCountintegeroptional

    min 0 · max 9007199254740991

  • target.releaseIpAssignmentIdsstring[]optional
  • couponCodestringoptional

    Optional 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

  • confirmtruePflicht
  • userExplicitlyConfirmedtruePflicht
  • previewConfirmationNoncestringPflicht
  • requestImmediateStartbooleanoptional

    Express 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 Status

get_plan_change_status
Nur lesendStartpunkt

Poll the status of a service plan change by change ID after a confirmed apply_* call (billing commit, queue, and infrastructure apply).

Berechtigung
gameserver.plan_changevserver.plan_changeteamspeak.plan_changededicated.plan_change
Freigabe beim Verbinden
Plan-Änderungen

Parameter

  • changeIdstringPflicht

Bestellen

Bestellbare Produkte, Tarife, Regionen, Spiele und ISO-Images sowie die Preisvorschau einer Bestellung.

List Orderable Products

list_orderable_products
Nur lesendStartpunktNicht im ChatGPT- und Claude-Connector

List 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.

Bestellungen und Tarifwechsel sind in den Connectoren aus den App-Verzeichnissen von ChatGPT und Claude ausgeblendet. In Claude Code, Cursor und mit API-Schlüssel steht das Tool zur Verfügung.

Berechtigung
orders.view
Freigabe beim Verbinden
Bestellkatalog & Vorschau

Parameter

Keine Parameter

List Orderable Plans

list_orderable_plans
Nur lesendNicht im ChatGPT- und Claude-Connector

List 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.

Bestellungen und Tarifwechsel sind in den Connectoren aus den App-Verzeichnissen von ChatGPT und Claude ausgeblendet. In Claude Code, Cursor und mit API-Schlüssel steht das Tool zur Verfügung.

Berechtigung
orders.view
Freigabe beim Verbinden
Bestellkatalog & Vorschau

Parameter

  • productSlugstringPflicht

    Product slug from list_orderable_products, e.g. the productSlug field of a product.

List Regions for an Orderable Product

list_orderable_product_regions
Nur lesendNicht im ChatGPT- und Claude-Connector

List 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.

Bestellungen und Tarifwechsel sind in den Connectoren aus den App-Verzeichnissen von ChatGPT und Claude ausgeblendet. In Claude Code, Cursor und mit API-Schlüssel steht das Tool zur Verfügung.

Berechtigung
orders.view
Freigabe beim Verbinden
Bestellkatalog & Vorschau

Parameter

  • productSlugstringPflicht

    Product slug from list_orderable_products, e.g. the productSlug field of a product.

List Order Regions

list_order_regions
Nur lesendNicht im ChatGPT- und Claude-Connector

List 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.

Bestellungen und Tarifwechsel sind in den Connectoren aus den App-Verzeichnissen von ChatGPT und Claude ausgeblendet. In Claude Code, Cursor und mit API-Schlüssel steht das Tool zur Verfügung.

Berechtigung
orders.view
Freigabe beim Verbinden
Bestellkatalog & Vorschau

Parameter

Keine Parameter

List Orderable Games

list_orderable_games
Nur lesendNicht im ChatGPT- und Claude-Connector

List 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.

Bestellungen und Tarifwechsel sind in den Connectoren aus den App-Verzeichnissen von ChatGPT und Claude ausgeblendet. In Claude Code, Cursor und mit API-Schlüssel steht das Tool zur Verfügung.

Berechtigung
orders.view
Freigabe beim Verbinden
Bestellkatalog & Vorschau

Parameter

Keine Parameter

List ISO Images for VPS Orders

list_vserver_order_isos
Nur lesendNicht im ChatGPT- und Claude-Connector

List 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.

Bestellungen und Tarifwechsel sind in den Connectoren aus den App-Verzeichnissen von ChatGPT und Claude ausgeblendet. In Claude Code, Cursor und mit API-Schlüssel steht das Tool zur Verfügung.

Berechtigung
orders.view
Freigabe beim Verbinden
Bestellkatalog & Vorschau

Parameter

Keine Parameter

Preview Order Price

preview_order
Nur lesendStartpunktNicht im ChatGPT- und Claude-Connector

Preview 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.

Bestellungen und Tarifwechsel sind in den Connectoren aus den App-Verzeichnissen von ChatGPT und Claude ausgeblendet. In Claude Code, Cursor und mit API-Schlüssel steht das Tool zur Verfügung.

Berechtigung
orders.view
Freigabe beim Verbinden
Bestellkatalog & Vorschau

Parameter

  • productSlugstringPflicht

    Product slug from list_orderable_products.

  • billingCycleSlug"3-day" | "monthly" | "quarterly" | "semi-annual" | "annual"Pflicht

    Billing cycle: 3-day, monthly, quarterly, semi-annual or annual.

  • planSlugstringoptional

    Plan slug from list_orderable_plans (products with fixed plans).

  • gameSlugstringoptional

    Game slug from list_orderable_games (gameservers).

  • regionSlugstringoptional

    Region slug from list_orderable_product_regions (products with region choice).

  • resourceConfigRecord<string, number>optional

    Resource values for configurable products, keyed as listed by list_orderable_plans.

  • optionsobjectoptional
  • options.couponCodestringoptional
  • options.dedicatedIpCountintegeroptional

    min 0 · max 9007199254740991

  • options.domainAttachmentobjectoptional
  • configurationRecord<string, any>optional

    Product-specific configuration, same shape as the REST order body.

  • domainsobject[]optional

Get Order Status

get_order_status
Nur lesendNicht im ChatGPT- und Claude-Connector

Status 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.

Bestellungen und Tarifwechsel sind in den Connectoren aus den App-Verzeichnissen von ChatGPT und Claude ausgeblendet. In Claude Code, Cursor und mit API-Schlüssel steht das Tool zur Verfügung.

Berechtigung
orders.view
Freigabe beim Verbinden
Bestellkatalog & Vorschau

Parameter

  • orderIdstringPflicht

    orderId returned by create_order (or an order id from the dashboard).

Place Paid Order

create_order
VeränderndBestätigung nötigNicht im ChatGPT- und Claude-Connector

Place 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.

Bestellungen und Tarifwechsel sind in den Connectoren aus den App-Verzeichnissen von ChatGPT und Claude ausgeblendet. In Claude Code, Cursor und mit API-Schlüssel steht das Tool zur Verfügung.

Berechtigung
orders.create
Freigabe beim Verbinden
Bestellen (kostenpflichtig)

Parameter

  • confirmationCodestringPflicht

    confirmation.confirmationCode from preview_order. It stands for exactly the previewed order; nothing else can be ordered with it.

  • confirmtruePflicht

    Must be true. Same confirm=true every state-changing MCP tool requires; set it only together with userExplicitlyConfirmed=true.

  • userExplicitlyConfirmedbooleanPflicht

    true only after the user explicitly agreed to this order and its price in the conversation (e.g. replied "yes" to the shown confirmation.chargeSummary).

  • requestImmediateStartbooleanoptional

    true 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.

Feedback

Dein KI-Client meldet Fehler oder fehlende Funktionen der MCP-Tools direkt an uns.

Send Feedback About This Connector

report_mcp_feedback
VeränderndStartpunkt

Report 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.

Berechtigung
Jede Verbindung
Freigabe beim Verbinden
Jede Verbindung

Parameter

  • kind"bug" | "missing_capability" | "unclear_tool_description" | "improvement"Pflicht

  • summarystringPflicht

    One sentence: what went wrong or what is missing.

    min length 5 · max length 200

  • detailsstringoptional

    What you tried, what you expected and what happened (error text). No secrets or file contents.

    max length 4000

  • relatedToolstringoptional

    Name of the tool the report is about, if any (e.g. get_gameserver).

    max length 100

  • exampleArgsRecord<string, any>optional

    Optional arguments of the failing call, without secrets.