Vai al contenuto

MCP

Tutti gli strumenti MCP

Ogni strumento che il tuo client IA può richiamare tramite il server MCP di ZapX, con parametri, autorizzazione necessaria e comportamento. L’elenco viene generato direttamente dal server ed è quindi sempre aggiornato.

224 strumenti in 13 gruppi · inclusi in ogni ZapX Pass

Configura MCPRiferimento API REST
Endpointhttps://zap-hosting.com/api/mcpJSONMarkdown per LLM
Nomi, titoli e descrizioni degli strumenti sono in inglese, esattamente come li riceve il tuo client IA dal server. Gli strumenti con «Conferma necessaria» vengono eseguiti solo con confirm: true. Il tuo client IA ti chiede prima di eseguire l’azione.

224 di 224 strumenti

Account

Tutti i servizi con ID e tipo, guasti e manutenzioni e lo stato delle operazioni in corso.

List All Services

list_account_services
Sola letturaPunto di partenza

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

Autorizzazione
Qualsiasi connessioneI risultati includono solo i servizi che la connessione può visualizzare.
Concessa alla connessione
Qualsiasi connessione

Parametri

Nessun parametro

List Incidents

list_incidents
Sola letturaPunto di partenza

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.

Autorizzazione
Qualsiasi connessioneI risultati includono solo i servizi che la connessione può visualizzare.
Concessa alla connessione
Qualsiasi connessione

Parametri

  • resolvedHoursintegerfacoltativo

    min 0 · max 168

Get Operation Status

get_operation_status
Sola lettura

Poll the status of an async public API operation.

Autorizzazione
Qualsiasi connessioneI risultati includono solo i servizi che la connessione può visualizzare.
Concessa alla connessione
Qualsiasi connessione

Parametri

  • operationIdstringobbligatorio

Server di gioco

Stato, console, avvio e arresto, impostazioni, versione e variante del gioco, mod, salvataggi, accesso SFTP e reinstallazione.

List Game Servers

list_gameservers
Sola letturaPunto di partenza

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

Autorizzazione
gameserver.view
Concessa alla connessione
Visualizza i servizi

Parametri

Nessun parametro

Get Game Server

get_gameserver
Sola letturaPunto di partenza

Get one gameserver by ID.

Autorizzazione
gameserver.view
Concessa alla connessione
Visualizza i servizi

Parametri

  • serviceIdstringobbligatorio

    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
Sola letturaPunto di partenza

Get live query status for a gameserver.

Autorizzazione
gameserver.view
Concessa alla connessione
Visualizza i servizi

Parametri

  • serviceIdstringobbligatorio

    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
Sola lettura

Read editable gameserver configuration fields.

Autorizzazione
gameserver.config.read
Concessa alla connessione
Visualizza configurazione

Parametri

  • serviceIdstringobbligatorio

    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
DistruttivoConferma necessaria

Update editable gameserver configuration fields. Requires confirm=true.

Autorizzazione
gameserver.config.write
Concessa alla connessione
Modifica configurazione

Parametri

  • serviceIdstringobbligatorio

    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>obbligatorio
  • confirmbooleanfacoltativo

Get Game Server Console Logs

get_gameserver_console_logs
Sola lettura

Read a recent gameserver console log snapshot.

Autorizzazione
gameserver.console.read
Concessa alla connessione
Console e log

Parametri

  • serviceIdstringobbligatorio

    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.

  • linesintegerfacoltativo

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

    > 0 · max 200

Restart Game Server

restart_gameserver
DistruttivoConferma necessaria

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

Autorizzazione
gameserver.restart
Concessa alla connessione
Azioni di alimentazione

Parametri

  • serviceIdstringobbligatorio

    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.

  • confirmbooleanfacoltativo

Start Game Server

start_gameserver
Modifica datiConferma necessaria

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

Autorizzazione
gameserver.start
Concessa alla connessione
Azioni di alimentazione

Parametri

  • serviceIdstringobbligatorio

    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.

  • confirmbooleanfacoltativo

Stop Game Server

stop_gameserver
DistruttivoConferma necessaria

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

Autorizzazione
gameserver.stop
Concessa alla connessione
Azioni di alimentazione

Parametri

  • serviceIdstringobbligatorio

    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.

  • confirmbooleanfacoltativo

Send Game Server Console Command

send_gameserver_console_command
DistruttivoConferma necessaria

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

Autorizzazione
gameserver.console.write
Concessa alla connessione
Console e log

Parametri

  • serviceIdstringobbligatorio

    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.

  • commandstringobbligatorio

    max length 500

  • confirmbooleanfacoltativo

Get Game Server Activity

get_gameserver_activity
Sola lettura

Read recent gameserver activity logs.

Autorizzazione
gameserver.activity.read
Concessa alla connessione
Visualizza i servizi

Parametri

  • serviceIdstringobbligatorio

    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.

  • limitintegerfacoltativo

    > 0 · max 100

  • offsetintegerfacoltativo

    min 0 · max 9007199254740991

Get Game Server Container Status

get_gameserver_container_status
Sola lettura

Get gameserver container and port reachability status.

Autorizzazione
gameserver.view
Concessa alla connessione
Visualizza i servizi

Parametri

  • serviceIdstringobbligatorio

    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
Sola lettura

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.

Autorizzazione
gameserver.view
Concessa alla connessione
Visualizza i servizi

Parametri

  • serviceIdstringobbligatorio

    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
Modifica datiConferma necessaria

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.

Autorizzazione
gameserver.backups.managegameserver.restartgameserver.startgameserver.stopgameserver.console.writegameserver.wipe
Concessa alla connessione
Azioni di alimentazione, Console e log, Modifica configurazione

Parametri

  • serviceIdstringobbligatorio

    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.

  • namestringobbligatorio

    max length 120

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

  • cronstringobbligatorio

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

  • timezonestringfacoltativo

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

  • commandstringfacoltativo

    Console command, required for action=command.

    max length 2000

  • wipeobjectfacoltativo

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

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

    Rust: map, blueprints or full.

  • wipe.backupFirstbooleanfacoltativo

    Back up before wiping (default true).

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

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

  • wipe.worldSizeintegerfacoltativo

    min 1000 · max 6000

  • isActivebooleanfacoltativo
  • confirmbooleanfacoltativo

Update Game Server Schedule

update_gameserver_schedule
DistruttivoConferma necessaria

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.

Autorizzazione
gameserver.backups.managegameserver.restartgameserver.startgameserver.stopgameserver.console.writegameserver.wipe
Concessa alla connessione
Azioni di alimentazione, Console e log, Modifica configurazione

Parametri

  • serviceIdstringobbligatorio

    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.

  • scheduleIdstringobbligatorio
  • namestringfacoltativo

    max length 120

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

  • cronstringfacoltativo

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

  • timezonestringfacoltativo

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

  • commandstringfacoltativo

    Console command, required for action=command.

    max length 2000

  • wipeobjectfacoltativo

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

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

    Rust: map, blueprints or full.

  • wipe.backupFirstbooleanfacoltativo

    Back up before wiping (default true).

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

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

  • wipe.worldSizeintegerfacoltativo

    min 1000 · max 6000

  • isActivebooleanfacoltativo
  • confirmbooleanfacoltativo

Delete Game Server Schedule

delete_gameserver_schedule
DistruttivoConferma necessaria

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

Autorizzazione
gameserver.backups.managegameserver.restartgameserver.startgameserver.stopgameserver.console.writegameserver.wipe
Concessa alla connessione
Azioni di alimentazione, Console e log, Modifica configurazione

Parametri

  • serviceIdstringobbligatorio

    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.

  • scheduleIdstringobbligatorio
  • confirmbooleanfacoltativo

Wipe Game Server

wipe_gameserver
DistruttivoConferma necessaria

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.

Autorizzazione
gameserver.wipe
Concessa alla connessione
Accesso completo

Parametri

  • serviceIdstringobbligatorio

    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"obbligatorio

    Rust: map, blueprints or full.

  • backupFirstbooleanfacoltativo

    Back up before wiping (default true).

  • seed"keep" | "random" | integerfacoltativo

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

  • worldSizeintegerfacoltativo

    min 1000 · max 6000

  • confirmbooleanfacoltativo

List Game Server Databases

list_gameserver_databases
Sola lettura

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.

Autorizzazione
gameserver.database.read
Concessa alla connessione
Visualizza configurazione

Parametri

  • serviceIdstringobbligatorio

    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
Modifica datiConferma necessaria

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.

Autorizzazione
gameserver.database.write
Concessa alla connessione
Modifica configurazione

Parametri

  • serviceIdstringobbligatorio

    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.

  • namestringfacoltativo

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

    max length 40

  • confirmbooleanfacoltativo

Delete Game Server Database

delete_gameserver_database
DistruttivoConferma necessaria

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.

Autorizzazione
gameserver.database.write
Concessa alla connessione
Modifica configurazione

Parametri

  • serviceIdstringobbligatorio

    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.

  • databaseIdstringobbligatorio
  • confirmationNamestringobbligatorio

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

  • confirmbooleanfacoltativo

Get Game Server External Access

get_gameserver_external_access
Sola lettura

Read gameserver external access details.

Autorizzazione
gameserver.external-access.manage
Concessa alla connessione
Accesso completo

Parametri

  • serviceIdstringobbligatorio

    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
Modifica datiConferma necessaria

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

Autorizzazione
gameserver.external-access.manage
Concessa alla connessione
Accesso completo

Parametri

  • serviceIdstringobbligatorio

    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.

  • confirmbooleanfacoltativo

Rotate Game Server External Access Credentials

rotate_gameserver_external_access
DistruttivoConferma necessaria

Rotate gameserver external access credentials. Requires confirm=true.

Autorizzazione
gameserver.external-access.manage
Concessa alla connessione
Accesso completo

Parametri

  • serviceIdstringobbligatorio

    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.

  • confirmbooleanfacoltativo

Show Game Server External Access Credentials

reveal_gameserver_external_access
DistruttivoConferma necessaria

Reveal gameserver external access credentials. Requires confirm=true.

Autorizzazione
gameserver.external-access.manage
Concessa alla connessione
Accesso completo

Parametri

  • serviceIdstringobbligatorio

    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.

  • confirmbooleanfacoltativo

Reinstall Game Server

reinstall_gameserver
DistruttivoConferma necessaria

Reinstall a gameserver. Requires confirm=true.

Autorizzazione
gameserver.reinstall
Concessa alla connessione
Accesso completo

Parametri

  • serviceIdstringobbligatorio

    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.

  • confirmbooleanfacoltativo

Change Game Server Game Version

update_gameserver_version
DistruttivoConferma necessaria

Update gameserver game version. Requires confirm=true.

Autorizzazione
gameserver.lifecycle.manage
Concessa alla connessione
Modifica configurazione

Parametri

  • serviceIdstringobbligatorio

    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.

  • targetVersionstringfacoltativo
  • targetModpackVersionstringfacoltativo
  • confirmbooleanfacoltativo

Change Game Server Variant

update_gameserver_variant
DistruttivoConferma necessaria

Change gameserver variant. Requires confirm=true.

Autorizzazione
gameserver.lifecycle.manage
Concessa alla connessione
Modifica configurazione

Parametri

  • serviceIdstringobbligatorio

    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.

  • variantIdstringobbligatorio
  • confirmbooleanfacoltativo

List Game Server Save Games

list_gameserver_savegames
Sola lettura

List gameserver savegames.

Autorizzazione
gameserver.savegames.read
Concessa alla connessione
Visualizza configurazione

Parametri

  • serviceIdstringobbligatorio

    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.

  • pageintegerfacoltativo

    > 0 · max 9007199254740991

  • limitintegerfacoltativo

    > 0 · max 100

Delete Game Server Save Game

delete_gameserver_savegame
DistruttivoConferma necessaria

Delete a gameserver savegame. Requires confirm=true.

Autorizzazione
gameserver.savegames.write
Concessa alla connessione
Modifica configurazione

Parametri

  • serviceIdstringobbligatorio

    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.

  • pathstringobbligatorio
  • confirmbooleanfacoltativo

List Game Server Mods

list_gameserver_mods
Sola lettura

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.

Autorizzazione
gameserver.view
Concessa alla connessione
Visualizza i servizi

Parametri

  • serviceIdstringobbligatorio

    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.

  • querystringfacoltativo
  • providerstringfacoltativo
  • installedOnlybooleanfacoltativo
  • offsetintegerfacoltativo

    min 0 · max 9007199254740991

  • limitintegerfacoltativo

    > 0 · max 48

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

Install or Update Game Server Mod

install_gameserver_mod
DistruttivoConferma necessaria

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.

Autorizzazione
gameserver.mods.manage
Concessa alla connessione
Modifica configurazione

Parametri

  • serviceIdstringobbligatorio

    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"obbligatorio

  • projectIdstringobbligatorio

    max length 200

  • versionIdstringfacoltativo

    max length 200

  • titlestringfacoltativo

    max length 200

  • resolveDependenciesbooleanfacoltativo
  • confirmbooleanfacoltativo

Remove Game Server Mod

uninstall_gameserver_mod
DistruttivoConferma necessaria

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.

Autorizzazione
gameserver.mods.manage
Concessa alla connessione
Modifica configurazione

Parametri

  • serviceIdstringobbligatorio

    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.

  • installationIdstringobbligatorio
  • confirmbooleanfacoltativo

Check Game Server Mod and Plugin Updates

check_gameserver_addon_updates
Sola lettura

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.

Autorizzazione
gameserver.view
Concessa alla connessione
Visualizza i servizi

Parametri

  • serviceIdstringobbligatorio

    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"obbligatorio

  • refreshbooleanfacoltativo

List Game Server Plugins

list_gameserver_plugins
Sola lettura

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.

Autorizzazione
gameserver.view
Concessa alla connessione
Visualizza i servizi

Parametri

  • serviceIdstringobbligatorio

    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.

  • querystringfacoltativo

    max length 200

  • provider"all" | "modrinth" | "hangar"facoltativo

  • installedOnlybooleanfacoltativo
  • offsetintegerfacoltativo

    min 0 · max 9007199254740991

  • limitintegerfacoltativo

    min 1 · max 48

  • sortstringfacoltativo

    max length 40

Install or Update Game Server Plugin

install_gameserver_plugin
DistruttivoConferma necessaria

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.

Autorizzazione
gameserver.plugins.manage
Concessa alla connessione
Modifica configurazione

Parametri

  • serviceIdstringobbligatorio

    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"obbligatorio

  • projectIdstringobbligatorio

    max length 200

  • versionIdstringfacoltativo

    max length 200

  • titlestringfacoltativo

    max length 200

  • resolveDependenciesbooleanfacoltativo
  • confirmbooleanfacoltativo

Remove Game Server Plugin

uninstall_gameserver_plugin
DistruttivoConferma necessaria

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.

Autorizzazione
gameserver.plugins.manage
Concessa alla connessione
Modifica configurazione

Parametri

  • serviceIdstringobbligatorio

    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.

  • installationIdstringobbligatorio
  • confirmbooleanfacoltativo

Get Rust Plugin Framework

get_gameserver_rust_framework
Sola lettura

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.

Autorizzazione
gameserver.view
Concessa alla connessione
Visualizza i servizi

Parametri

  • serviceIdstringobbligatorio

    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
DistruttivoConferma necessaria

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.

Autorizzazione
gameserver.plugins.manage
Concessa alla connessione
Modifica configurazione

Parametri

  • serviceIdstringobbligatorio

    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"obbligatorio

  • confirmbooleanfacoltativo

List Minecraft Modpacks

list_gameserver_modpacks
Sola lettura

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.

Autorizzazione
gameserver.view
Concessa alla connessione
Visualizza i servizi

Parametri

  • serviceIdstringobbligatorio

    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.

  • searchstringfacoltativo

    max length 200

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

  • offsetintegerfacoltativo

    min 0 · max 100000

  • limitintegerfacoltativo

    min 1 · max 100

  • modpackIdstringfacoltativo

Install Minecraft Modpack

install_gameserver_modpack
DistruttivoConferma necessaria

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.

Autorizzazione
gameserver.lifecycle.manage
Concessa alla connessione
Modifica configurazione

Parametri

  • serviceIdstringobbligatorio

    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.

  • modpackIdstringobbligatorio
  • versionIdstringobbligatorio
  • confirmbooleanfacoltativo

Get Game Server Steam Workshop

get_gameserver_workshop
Sola lettura

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.

Autorizzazione
gameserver.view
Concessa alla connessione
Visualizza i servizi

Parametri

  • serviceIdstringobbligatorio

    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
DistruttivoConferma necessaria

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.

Autorizzazione
gameserver.mods.manage
Concessa alla connessione
Modifica configurazione

Parametri

  • serviceIdstringobbligatorio

    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[]facoltativo

    max items 500

  • addItemIdsstring[]facoltativo

    max items 200

  • removeItemIdsstring[]facoltativo

    max items 500

  • collectionIdstringfacoltativo

    pattern ^\d{1,20}$

  • disabledItemIdsstring[]facoltativo

    max items 500

  • confirmbooleanfacoltativo

VPS

Avvio e arresto, configurazione, metriche, traffico, DNS, firewall, chiavi SSH, protezione DDoS, pianificazioni, modalità rescue e reinstallazione.

List VPS

list_vservers
Sola letturaPunto di partenza

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

Autorizzazione
vserver.view
Concessa alla connessione
Visualizza i servizi

Parametri

Nessun parametro

Get VPS

get_vserver
Sola letturaPunto di partenza

Get one VPS by ID.

Autorizzazione
vserver.view
Concessa alla connessione
Visualizza i servizi

Parametri

  • serviceIdstringobbligatorio

    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
Sola lettura

Read VPS configuration.

Autorizzazione
vserver.config.read
Concessa alla connessione
Visualizza configurazione

Parametri

  • serviceIdstringobbligatorio

    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
DistruttivoConferma necessaria

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

Autorizzazione
vserver.config.writevserver.access.manage
Concessa alla connessione
Modifica configurazione

Parametri

  • serviceIdstringobbligatorio

    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.

  • hostnamestringfacoltativo
  • dnsServerstringfacoltativo
  • ballooningDisabledbooleanfacoltativo
  • sshPasswordEnabledbooleanfacoltativo
  • confirmbooleanfacoltativo

Get VPS Activity

get_vserver_activity
Sola lettura

Read paginated VPS activity log entries.

Autorizzazione
vserver.activity.read
Concessa alla connessione
Visualizza i servizi

Parametri

  • serviceIdstringobbligatorio

    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.

  • limitintegerfacoltativo

    min 1 · max 100

  • offsetintegerfacoltativo

    min 0 · max 9007199254740991

Get VPS Traffic

get_vserver_traffic
Sola lettura

Read paginated VPS network traffic history.

Autorizzazione
vserver.traffic.read
Concessa alla connessione
Visualizza i servizi

Parametri

  • serviceIdstringobbligatorio

    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.

  • limitintegerfacoltativo

    min 1 · max 100

  • offsetintegerfacoltativo

    min 0 · max 9007199254740991

Get VPS DDoS Status

get_vserver_ddos_status
Sola lettura

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.

Autorizzazione
vserver.ddos.read
Concessa alla connessione
Visualizza i servizi

Parametri

  • serviceIdstringobbligatorio

    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.

  • ipAddressstringfacoltativo

List VPS DDoS Rules

list_vserver_ddos_rules
Sola lettura

List the DDoS filter rules learned for a VPS IP.

Autorizzazione
vserver.ddos.read
Concessa alla connessione
Visualizza i servizi

Parametri

  • serviceIdstringobbligatorio

    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.

  • ipAddressstringfacoltativo

List VPS DDoS Incidents

list_vserver_ddos_incidents
Sola lettura

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

Autorizzazione
vserver.ddos.read
Concessa alla connessione
Visualizza i servizi

Parametri

  • serviceIdstringobbligatorio

    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.

  • ipAddressstringfacoltativo
  • pageintegerfacoltativo

    > 0 · max 9007199254740991

  • pageSizeintegerfacoltativo

    > 0 · max 100

Get VPS DDoS Bandwidth

get_vserver_ddos_bandwidth
Sola lettura

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

Autorizzazione
vserver.ddos.read
Concessa alla connessione
Visualizza i servizi

Parametri

  • serviceIdstringobbligatorio

    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"facoltativo

  • ipAddressstringfacoltativo

List Outgoing DDoS Attacks from VPS

list_vserver_outgoing_ddos
Sola lettura

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

Autorizzazione
vserver.ddos.read
Concessa alla connessione
Visualizza i servizi

Parametri

  • serviceIdstringobbligatorio

    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
DistruttivoConferma necessaria

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

Autorizzazione
vserver.ddos.manage
Concessa alla connessione
Modifica configurazione

Parametri

  • serviceIdstringobbligatorio

    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.

  • ipAddressstringfacoltativo
  • enabledbooleanfacoltativo

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

  • confirmbooleanfacoltativo

Get VPS DNS Settings

get_vserver_dns
Sola lettura

Read VPS DNS domains, subdomains, and favorite subdomain.

Autorizzazione
vserver.config.read
Concessa alla connessione
Visualizza configurazione

Parametri

  • serviceIdstringobbligatorio

    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
Sola lettura

List SSH keys stored on the authenticated account.

Autorizzazione
vserver.config.read
Concessa alla connessione
Visualizza configurazione

Parametri

Nessun parametro

Create VPS Subdomain

create_vserver_subdomain
Modifica datiConferma necessaria

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

Autorizzazione
vserver.config.write
Concessa alla connessione
Modifica configurazione

Parametri

  • serviceIdstringobbligatorio

    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.

  • labelstringobbligatorio

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

  • domainIdstringfacoltativo

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

  • confirmbooleanfacoltativo

Delete VPS Subdomain

delete_vserver_subdomain
DistruttivoConferma necessaria

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

Autorizzazione
vserver.config.write
Concessa alla connessione
Modifica configurazione

Parametri

  • serviceIdstringobbligatorio

    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.

  • subdomainIdstringobbligatorio

    Subdomain id from get_vserver_dns.

  • confirmbooleanfacoltativo

Set VPS Favorite Subdomain

set_vserver_favorite_subdomain
DistruttivoConferma necessaria

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

Autorizzazione
vserver.config.write
Concessa alla connessione
Modifica configurazione

Parametri

  • serviceIdstringobbligatorio

    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.

  • subdomainIdstringfacoltativo

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

  • confirmbooleanfacoltativo

Get VPS Reverse DNS

get_vserver_reverse_dns
Sola lettura

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

Autorizzazione
vserver.config.read
Concessa alla connessione
Visualizza configurazione

Parametri

  • serviceIdstringobbligatorio

    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
DistruttivoConferma necessaria

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

Autorizzazione
vserver.config.write
Concessa alla connessione
Modifica configurazione

Parametri

  • serviceIdstringobbligatorio

    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.

  • ipAddressIdstringfacoltativo

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

  • ipv6PrefixAllocationIdstringfacoltativo

    IPv6 entry from get_vserver_reverse_dns (`ipv6PrefixAllocationId`).

  • hostnamestringfacoltativo

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

  • confirmbooleanfacoltativo

Update VPS Firewall Options

update_vserver_firewall_options
DistruttivoConferma necessaria

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.

Autorizzazione
vserver.firewall.write
Concessa alla connessione
Modifica configurazione

Parametri

  • serviceIdstringobbligatorio

    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.

  • enablebooleanobbligatorio

    Firewall on (true) or off (false).

  • policyIn"ACCEPT" | "DROP" | "REJECT"obbligatorio

    Default policy for incoming traffic no rule matches.

  • policyOut"ACCEPT" | "DROP" | "REJECT"obbligatorio

    Default policy for outgoing traffic no rule matches.

  • confirmbooleanfacoltativo

Change VPS Firewall Rule

mutate_vserver_firewall_rule
DistruttivoConferma necessaria

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

Autorizzazione
vserver.firewall.write
Concessa alla connessione
Modifica configurazione

Parametri

  • serviceIdstringobbligatorio

    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"obbligatorio

  • posintegerfacoltativo

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

    min 0 · max 9007199254740991

  • newPosintegerfacoltativo

    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"facoltativo

    add/update: traffic direction.

  • ruleAction"ACCEPT" | "DROP" | "REJECT"facoltativo

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

  • enablebooleanfacoltativo

    add/update: rule active (default true).

  • macrostringfacoltativo

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

  • protostringfacoltativo

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

  • sourcestringfacoltativo

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

  • deststringfacoltativo

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

  • sportstringfacoltativo

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

  • dportstringfacoltativo

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

  • commentstringfacoltativo

    add/update: free text comment.

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

    add/update: log level (default nolog).

  • confirmbooleanfacoltativo

Change VPS Firewall IP Set

mutate_vserver_firewall_ipset
DistruttivoConferma necessaria

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

Autorizzazione
vserver.firewall.write
Concessa alla connessione
Modifica configurazione

Parametri

  • serviceIdstringobbligatorio

    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"obbligatorio

  • namestringobbligatorio

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

  • cidrstringfacoltativo

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

  • commentstringfacoltativo

    add_entry: free text comment.

  • confirmbooleanfacoltativo

List VPS SSH Keys

list_vserver_ssh_keys
Sola lettura

List the account SSH keys installed on one VPS.

Autorizzazione
vserver.config.read
Concessa alla connessione
Visualizza configurazione

Parametri

  • serviceIdstringobbligatorio

    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
Modifica datiConferma necessaria

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

Autorizzazione
vserver.access.manage
Concessa alla connessione
Accesso completo

Parametri

  • serviceIdstringobbligatorio

    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.

  • sshKeyIdstringobbligatorio

    Key id from list_vserver_account_ssh_keys.

  • confirmbooleanfacoltativo

Remove SSH Key from VPS

remove_vserver_ssh_key
DistruttivoConferma necessaria

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

Autorizzazione
vserver.access.manage
Concessa alla connessione
Accesso completo

Parametri

  • serviceIdstringobbligatorio

    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.

  • sshKeyIdstringobbligatorio

    Key id from list_vserver_ssh_keys.

  • confirmbooleanfacoltativo

Add Account SSH Key

create_vserver_account_ssh_key
Modifica datiConferma necessaria

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

Autorizzazione
vserver.config.write
Concessa alla connessione
Modifica configurazione

Parametri

  • namestringobbligatorio
  • publicKeystringobbligatorio

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

  • confirmbooleanfacoltativo

Update Account SSH Key

update_vserver_account_ssh_key
DistruttivoConferma necessaria

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

Autorizzazione
vserver.access.manage
Concessa alla connessione
Accesso completo

Parametri

  • keyIdstringobbligatorio

    Key id from list_vserver_account_ssh_keys.

  • namestringfacoltativo
  • publicKeystringfacoltativo

    Replaces the key on every VPS it is installed on.

  • confirmbooleanfacoltativo

Delete Account SSH Key

delete_vserver_account_ssh_key
DistruttivoConferma necessaria

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

Autorizzazione
vserver.access.manage
Concessa alla connessione
Accesso completo

Parametri

  • keyIdstringobbligatorio

    Key id from list_vserver_account_ssh_keys.

  • confirmbooleanfacoltativo

List VPS ISO Images

list_vserver_isos
Sola lettura

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

Autorizzazione
vserver.reinstall
Concessa alla connessione
Accesso completo

Parametri

  • serviceIdstringobbligatorio

    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
Modifica datiConferma necessaria

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

Autorizzazione
vserver.reinstall
Concessa alla connessione
Accesso completo

Parametri

  • serviceIdstringobbligatorio

    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.

  • isoIdstringfacoltativo

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

  • volidstringfacoltativo

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

  • applyHardwareProfilebooleanfacoltativo

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

  • attachDriverDiscbooleanfacoltativo

    Attach the VirtIO driver disc (Windows installs).

  • bootFromIsobooleanfacoltativo

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

  • confirmbooleanfacoltativo

Unmount ISO from VPS

unmount_vserver_iso
Modifica datiConferma necessaria

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

Autorizzazione
vserver.reinstall
Concessa alla connessione
Accesso completo

Parametri

  • serviceIdstringobbligatorio

    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.

  • confirmbooleanfacoltativo

List Custom VPS ISOs

list_vserver_custom_isos
Sola lettura

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

Autorizzazione
vserver.reinstall
Concessa alla connessione
Accesso completo

Parametri

  • serviceIdstringobbligatorio

    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
Modifica datiConferma necessaria

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

Autorizzazione
vserver.reinstall
Concessa alla connessione
Accesso completo

Parametri

  • serviceIdstringobbligatorio

    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.

  • displayNamestringobbligatorio
  • sourceUrlstringobbligatorio

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

  • filenamestringfacoltativo
  • osProfile"linux" | "windows"facoltativo

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

  • confirmbooleanfacoltativo

Delete Custom VPS ISO

delete_vserver_custom_iso
DistruttivoConferma necessaria

Delete an own imported ISO. Requires confirm=true.

Autorizzazione
vserver.reinstall
Concessa alla connessione
Accesso completo

Parametri

  • serviceIdstringobbligatorio

    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.

  • assetIdstringobbligatorio

    Custom ISO id from list_vserver_custom_isos.

  • confirmbooleanfacoltativo

Get VPS Metrics

get_vserver_metrics
Sola lettura

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.

Autorizzazione
vserver.metrics.read
Concessa alla connessione
Visualizza i servizi

Parametri

  • serviceIdstringobbligatorio

    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"facoltativo

Get VPS Firewall Rules

get_vserver_firewall
Sola lettura

Read the VPS firewall configuration.

Autorizzazione
vserver.firewall.read
Concessa alla connessione
Visualizza configurazione

Parametri

  • serviceIdstringobbligatorio

    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
Modifica datiConferma necessaria

Start a VPS. Requires confirm=true.

Autorizzazione
vserver.power.start
Concessa alla connessione
Azioni di alimentazione

Parametri

  • serviceIdstringobbligatorio

    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.

  • confirmbooleanfacoltativo

Stop VPS

stop_vserver
DistruttivoConferma necessaria

Stop a VPS. Requires confirm=true.

Autorizzazione
vserver.power.stop
Concessa alla connessione
Azioni di alimentazione

Parametri

  • serviceIdstringobbligatorio

    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.

  • confirmbooleanfacoltativo

Restart VPS

restart_vserver
DistruttivoConferma necessaria

Restart a VPS. Requires confirm=true.

Autorizzazione
vserver.power.restart
Concessa alla connessione
Azioni di alimentazione

Parametri

  • serviceIdstringobbligatorio

    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.

  • confirmbooleanfacoltativo

List VPS Schedules

list_vserver_schedules
Sola lettura

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

Autorizzazione
vserver.view
Concessa alla connessione
Visualizza i servizi

Parametri

  • serviceIdstringobbligatorio

    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
DistruttivoConferma necessaria

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.

Autorizzazione
vserver.power.restartvserver.power.startvserver.power.stopvserver.console.write
Concessa alla connessione
Azioni di alimentazione

Parametri

  • serviceIdstringobbligatorio

    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.

  • namestringobbligatorio
  • action"restart" | "start" | "stop" | "command"obbligatorio

  • cronstringobbligatorio
  • timezonestringfacoltativo
  • commandstringfacoltativo
  • isActivebooleanfacoltativo
  • confirmbooleanfacoltativo

Update VPS Schedule

update_vserver_schedule
DistruttivoConferma necessaria

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

Autorizzazione
vserver.power.restartvserver.power.startvserver.power.stopvserver.console.write
Concessa alla connessione
Azioni di alimentazione

Parametri

  • serviceIdstringobbligatorio

    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.

  • scheduleIdstringobbligatorio
  • namestringfacoltativo
  • action"restart" | "start" | "stop" | "command"facoltativo

  • cronstringfacoltativo
  • timezonestringfacoltativo
  • commandstringfacoltativo
  • isActivebooleanfacoltativo
  • confirmbooleanfacoltativo

Delete VPS Schedule

delete_vserver_schedule
DistruttivoConferma necessaria

Delete a VPS schedule. Requires confirm=true.

Autorizzazione
vserver.power.restartvserver.power.startvserver.power.stopvserver.console.write
Concessa alla connessione
Azioni di alimentazione

Parametri

  • serviceIdstringobbligatorio

    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.

  • scheduleIdstringobbligatorio
  • confirmbooleanfacoltativo

Enable VPS Rescue Mode

enable_vserver_rescue
DistruttivoConferma necessaria

Enable VPS rescue mode. Requires confirm=true.

Autorizzazione
vserver.reinstall
Concessa alla connessione
Accesso completo

Parametri

  • serviceIdstringobbligatorio

    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.

  • confirmbooleanfacoltativo

Disable VPS Rescue Mode

disable_vserver_rescue
DistruttivoConferma necessaria

Disable VPS rescue mode. Requires confirm=true.

Autorizzazione
vserver.reinstall
Concessa alla connessione
Accesso completo

Parametri

  • serviceIdstringobbligatorio

    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.

  • confirmbooleanfacoltativo

List VPS Reinstall Templates

list_vserver_reinstall_templates
Sola lettura

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

Autorizzazione
vserver.reinstall
Concessa alla connessione
Accesso completo

Parametri

Nessun parametro

Reinstall VPS

reinstall_vserver
DistruttivoConferma necessaria

Reinstall a VPS. Requires confirm=true.

Autorizzazione
vserver.reinstall
Concessa alla connessione
Accesso completo

Parametri

  • serviceIdstringobbligatorio

    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.

  • templateIdstringfacoltativo
  • confirmbooleanfacoltativo

Server dedicati

Stato di alimentazione, hardware, metriche, traffico, installazione, ISO personalizzate, DNS inverso, protezione DDoS, gestione remota e modalità rescue.

List Dedicated Servers

list_dedicated_servers
Sola letturaPunto di partenza

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

Autorizzazione
dedicated.view
Concessa alla connessione
Visualizza i servizi

Parametri

Nessun parametro

Get Dedicated Server

get_dedicated_server
Sola letturaPunto di partenza

Get one dedicated server by ID.

Autorizzazione
dedicated.view
Concessa alla connessione
Visualizza i servizi

Parametri

  • serviceIdstringobbligatorio

    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
Sola lettura

Get dedicated server hardware power state.

Autorizzazione
dedicated.view
Concessa alla connessione
Visualizza i servizi

Parametri

  • serviceIdstringobbligatorio

    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
Sola lettura

Get dedicated server hardware metrics for a timeframe.

Autorizzazione
dedicated.metrics.read
Concessa alla connessione
Visualizza i servizi

Parametri

  • serviceIdstringobbligatorio

    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"facoltativo

Get Dedicated Server Hardware

get_dedicated_hardware
Sola lettura

Get dedicated server hardware inventory.

Autorizzazione
dedicated.hardware.read
Concessa alla connessione
Visualizza i servizi

Parametri

  • serviceIdstringobbligatorio

    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
Sola lettura

Get dedicated server traffic overview for a timeframe.

Autorizzazione
dedicated.traffic.read
Concessa alla connessione
Visualizza i servizi

Parametri

  • serviceIdstringobbligatorio

    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"facoltativo

Get Dedicated Server Traffic Quota

get_dedicated_traffic_quota
Sola lettura

Get dedicated server traffic quota snapshot.

Autorizzazione
dedicated.traffic.read
Concessa alla connessione
Visualizza i servizi

Parametri

  • serviceIdstringobbligatorio

    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
Sola lettura

Get dedicated server traffic history entries.

Autorizzazione
dedicated.traffic.read
Concessa alla connessione
Visualizza i servizi

Parametri

  • serviceIdstringobbligatorio

    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.

  • limitintegerfacoltativo

    > 0 · max 9007199254740991

  • offsetintegerfacoltativo

    min 0 · max 9007199254740991

Get Dedicated Server Activity

get_dedicated_activity
Sola lettura

Read recent dedicated server activity logs.

Autorizzazione
dedicated.activity.read
Concessa alla connessione
Visualizza i servizi

Parametri

  • serviceIdstringobbligatorio

    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.

  • limitintegerfacoltativo

    > 0 · max 9007199254740991

  • offsetintegerfacoltativo

    min 0 · max 9007199254740991

Get Dedicated Server Installation

get_dedicated_installation
Sola lettura

Get dedicated server installation status.

Autorizzazione
dedicated.view
Concessa alla connessione
Visualizza i servizi

Parametri

  • serviceIdstringobbligatorio

    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
Sola lettura

Get dedicated server installation progress and log.

Autorizzazione
dedicated.view
Concessa alla connessione
Visualizza i servizi

Parametri

  • serviceIdstringobbligatorio

    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
Sola lettura

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

Autorizzazione
dedicated.installation.manage
Concessa alla connessione
Accesso completo

Parametri

  • serviceIdstringobbligatorio

    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
Sola lettura

Read reverse DNS entries for a dedicated server.

Autorizzazione
dedicated.network.read
Concessa alla connessione
Visualizza i servizi

Parametri

  • serviceIdstringobbligatorio

    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
Sola lettura

Get DDoS protection status for a dedicated server.

Autorizzazione
dedicated.ddos.read
Concessa alla connessione
Visualizza i servizi

Parametri

  • serviceIdstringobbligatorio

    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.

  • ipAddressstringfacoltativo

List Dedicated Server DDoS Rules

list_dedicated_ddos_rules
Sola lettura

List DDoS protection rules for a dedicated server.

Autorizzazione
dedicated.ddos.read
Concessa alla connessione
Visualizza i servizi

Parametri

  • serviceIdstringobbligatorio

    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.

  • ipAddressstringfacoltativo

List Dedicated Server DDoS Incidents

list_dedicated_ddos_incidents
Sola lettura

List DDoS incidents for a dedicated server.

Autorizzazione
dedicated.ddos.read
Concessa alla connessione
Visualizza i servizi

Parametri

  • serviceIdstringobbligatorio

    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.

  • ipAddressstringfacoltativo
  • pageintegerfacoltativo

    > 0 · max 9007199254740991

  • pageSizeintegerfacoltativo

    > 0 · max 100

Get Dedicated Server DDoS Bandwidth

get_dedicated_ddos_bandwidth
Sola lettura

Get DDoS bandwidth statistics for a dedicated server.

Autorizzazione
dedicated.ddos.read
Concessa alla connessione
Visualizza i servizi

Parametri

  • serviceIdstringobbligatorio

    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.

  • rangestringfacoltativo
  • ipAddressstringfacoltativo

Get Dedicated Server Remote Management

get_dedicated_remote_management
Sola lettura

Get dedicated server remote management session state.

Autorizzazione
dedicated.remote_management.manage
Concessa alla connessione
Accesso completo

Parametri

  • serviceIdstringobbligatorio

    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
Sola lettura

List custom ISO assets available for a dedicated server.

Autorizzazione
dedicated.installation.manage
Concessa alla connessione
Accesso completo

Parametri

  • serviceIdstringobbligatorio

    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
Sola lettura

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

Autorizzazione
dedicated.reinstall
Concessa alla connessione
Accesso completo

Parametri

Nessun parametro

Start Dedicated Server

start_dedicated_server
Modifica datiConferma necessaria

Start a dedicated server. Requires confirm=true.

Autorizzazione
dedicated.power.start
Concessa alla connessione
Azioni di alimentazione

Parametri

  • serviceIdstringobbligatorio

    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.

  • confirmbooleanfacoltativo

Stop Dedicated Server

stop_dedicated_server
DistruttivoConferma necessaria

Stop a dedicated server. Requires confirm=true.

Autorizzazione
dedicated.power.stop
Concessa alla connessione
Azioni di alimentazione

Parametri

  • serviceIdstringobbligatorio

    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"facoltativo

  • confirmbooleanfacoltativo

Restart Dedicated Server

restart_dedicated_server
DistruttivoConferma necessaria

Restart a dedicated server. Requires confirm=true.

Autorizzazione
dedicated.power.restart
Concessa alla connessione
Azioni di alimentazione

Parametri

  • serviceIdstringobbligatorio

    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"facoltativo

  • confirmbooleanfacoltativo

Reinstall Dedicated Server

reinstall_dedicated_server
DistruttivoConferma necessaria

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.

Autorizzazione
dedicated.reinstall
Concessa alla connessione
Accesso completo

Parametri

  • serviceIdstringobbligatorio

    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.

  • osTemplateIdstringfacoltativo

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

  • confirmbooleanfacoltativo

Wipe Dedicated Server

wipe_dedicated_server
DistruttivoConferma necessaria

Wipe a dedicated server. Requires confirm=true.

Autorizzazione
dedicated.reinstall
Concessa alla connessione
Accesso completo

Parametri

  • serviceIdstringobbligatorio

    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.

  • confirmbooleanfacoltativo

Update Dedicated Server Reverse DNS

update_dedicated_reverse_dns
DistruttivoConferma necessaria

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

Autorizzazione
dedicated.network.write
Concessa alla connessione
Modifica configurazione

Parametri

  • serviceIdstringobbligatorio

    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.

  • ipAddressIdstringfacoltativo
  • ipv6PrefixAllocationIdstringfacoltativo
  • hostnamestringfacoltativo
  • confirmbooleanfacoltativo

Refresh Dedicated Server Installation

refresh_dedicated_installation
Modifica datiConferma necessaria

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

Autorizzazione
dedicated.installation.manage
Concessa alla connessione
Accesso completo

Parametri

  • serviceIdstringobbligatorio

    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.

  • confirmbooleanfacoltativo

Mount Dedicated Server Install Media

mount_dedicated_install_media
Modifica datiConferma necessaria

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

Autorizzazione
dedicated.installation.manage
Concessa alla connessione
Accesso completo

Parametri

  • serviceIdstringobbligatorio

    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.

  • templateIdstringobbligatorio
  • confirmbooleanfacoltativo

Unmount Dedicated Server Install Media

unmount_dedicated_install_media
Modifica datiConferma necessaria

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

Autorizzazione
dedicated.installation.manage
Concessa alla connessione
Accesso completo

Parametri

  • serviceIdstringobbligatorio

    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.

  • confirmbooleanfacoltativo

Set Dedicated Server Next Boot Device

set_dedicated_next_boot
Modifica datiConferma necessaria

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

Autorizzazione
dedicated.installation.manage
Concessa alla connessione
Accesso completo

Parametri

  • serviceIdstringobbligatorio

    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"obbligatorio

  • confirmbooleanfacoltativo

Enable Dedicated Server Rescue Mode

enable_dedicated_rescue
DistruttivoConferma necessaria

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

Autorizzazione
dedicated.rescue.manage
Concessa alla connessione
Accesso completo

Parametri

  • serviceIdstringobbligatorio

    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.

  • templateIdstringobbligatorio
  • confirmbooleanfacoltativo

Disable Dedicated Server Rescue Mode

disable_dedicated_rescue
DistruttivoConferma necessaria

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

Autorizzazione
dedicated.rescue.manage
Concessa alla connessione
Accesso completo

Parametri

  • serviceIdstringobbligatorio

    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.

  • confirmbooleanfacoltativo

Activate Dedicated Server Remote Management

activate_dedicated_remote_management
Modifica datiConferma necessaria

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

Autorizzazione
dedicated.remote_management.manage
Concessa alla connessione
Accesso completo

Parametri

  • serviceIdstringobbligatorio

    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.

  • durationHoursintegerfacoltativo

    > 0 · max 9007199254740991

  • confirmbooleanfacoltativo

Extend Dedicated Server Remote Management

extend_dedicated_remote_management
Modifica datiConferma necessaria

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

Autorizzazione
dedicated.remote_management.manage
Concessa alla connessione
Accesso completo

Parametri

  • serviceIdstringobbligatorio

    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.

  • confirmbooleanfacoltativo

Revoke Dedicated Server Remote Management

revoke_dedicated_remote_management
DistruttivoConferma necessaria

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

Autorizzazione
dedicated.remote_management.manage
Concessa alla connessione
Accesso completo

Parametri

  • serviceIdstringobbligatorio

    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.

  • confirmbooleanfacoltativo

Launch Dedicated Server Remote Management

launch_dedicated_remote_management
DistruttivoConferma necessaria

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

Autorizzazione
dedicated.remote_management.manage
Concessa alla connessione
Accesso completo

Parametri

  • serviceIdstringobbligatorio

    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.

  • confirmbooleanfacoltativo

Turn Dedicated Server DDoS Protection On or Off

toggle_dedicated_ddos_protection
DistruttivoConferma necessaria

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

Autorizzazione
dedicated.ddos.manage
Concessa alla connessione
Modifica configurazione

Parametri

  • serviceIdstringobbligatorio

    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.

  • ipAddressstringfacoltativo
  • enabledbooleanfacoltativo

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

  • confirmbooleanfacoltativo

Import Dedicated Server Custom ISO

import_dedicated_custom_iso
Modifica datiConferma necessaria

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

Autorizzazione
dedicated.installation.manage
Concessa alla connessione
Accesso completo

Parametri

  • serviceIdstringobbligatorio

    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.

  • displayNamestringobbligatorio
  • sourceUrlstringobbligatorio

    format uri

  • filenamestringfacoltativo
  • confirmbooleanfacoltativo

Delete Dedicated Server Custom ISO

delete_dedicated_custom_iso
DistruttivoConferma necessaria

Delete a custom ISO asset. Requires confirm=true.

Autorizzazione
dedicated.installation.manage
Concessa alla connessione
Accesso completo

Parametri

  • serviceIdstringobbligatorio

    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.

  • assetIdstringobbligatorio
  • confirmbooleanfacoltativo

Mount Dedicated Server Custom ISO

mount_dedicated_custom_iso
Modifica datiConferma necessaria

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

Autorizzazione
dedicated.installation.manage
Concessa alla connessione
Accesso completo

Parametri

  • serviceIdstringobbligatorio

    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.

  • assetIdstringobbligatorio
  • confirmbooleanfacoltativo

Server TeamSpeak

Stato, avvio e arresto, impostazioni, client, ban e chiavi di privilegio.

List TeamSpeak Servers

list_teamspeak_servers
Sola letturaPunto di partenza

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

Autorizzazione
teamspeak.view
Concessa alla connessione
Visualizza i servizi

Parametri

Nessun parametro

Get TeamSpeak Server

get_teamspeak_server
Sola letturaPunto di partenza

Get one TeamSpeak server by ID.

Autorizzazione
teamspeak.view
Concessa alla connessione
Visualizza i servizi

Parametri

  • serviceIdstringobbligatorio

    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
Sola lettura

Read TeamSpeak server configuration.

Autorizzazione
teamspeak.config.read
Concessa alla connessione
Visualizza configurazione

Parametri

  • serviceIdstringobbligatorio

    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
DistruttivoConferma necessaria

Update TeamSpeak server configuration. Requires confirm=true.

Autorizzazione
teamspeak.config.manage
Concessa alla connessione
Modifica configurazione

Parametri

  • serviceIdstringobbligatorio

    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>obbligatorio
  • confirmbooleanfacoltativo

List TeamSpeak Privilege Keys

list_teamspeak_tokens
Sola lettura

List privilege tokens for a TeamSpeak server.

Autorizzazione
teamspeak.tokens.manage
Concessa alla connessione
Gestione TeamSpeak

Parametri

  • serviceIdstringobbligatorio

    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
DistruttivoConferma necessaria

Create a TeamSpeak privilege token. Requires confirm=true.

Autorizzazione
teamspeak.tokens.manage
Concessa alla connessione
Gestione TeamSpeak

Parametri

  • serviceIdstringobbligatorio

    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.

  • descriptionstringfacoltativo

    max length 100

  • confirmbooleanfacoltativo

Start TeamSpeak Server

start_teamspeak_server
Modifica datiConferma necessaria

Start a TeamSpeak server. Requires confirm=true.

Autorizzazione
teamspeak.power.start
Concessa alla connessione
Azioni di alimentazione

Parametri

  • serviceIdstringobbligatorio

    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.

  • confirmbooleanfacoltativo

Stop TeamSpeak Server

stop_teamspeak_server
DistruttivoConferma necessaria

Stop a TeamSpeak server. Requires confirm=true.

Autorizzazione
teamspeak.power.stop
Concessa alla connessione
Azioni di alimentazione

Parametri

  • serviceIdstringobbligatorio

    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.

  • confirmbooleanfacoltativo

Restart TeamSpeak Server

restart_teamspeak_server
DistruttivoConferma necessaria

Restart a TeamSpeak server. Requires confirm=true.

Autorizzazione
teamspeak.power.restart
Concessa alla connessione
Azioni di alimentazione

Parametri

  • serviceIdstringobbligatorio

    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.

  • confirmbooleanfacoltativo

Get TeamSpeak Metrics

get_teamspeak_metrics
Sola lettura

Get TeamSpeak server metrics.

Autorizzazione
teamspeak.metrics.read
Concessa alla connessione
Visualizza i servizi

Parametri

  • serviceIdstringobbligatorio

    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
Sola lettura

List connected TeamSpeak clients.

Autorizzazione
teamspeak.clients.manage
Concessa alla connessione
Gestione TeamSpeak

Parametri

  • serviceIdstringobbligatorio

    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
Sola lettura

List TeamSpeak server bans.

Autorizzazione
teamspeak.bans.manage
Concessa alla connessione
Gestione TeamSpeak

Parametri

  • serviceIdstringobbligatorio

    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
Modifica datiConferma necessaria

Add a TeamSpeak ban. Requires confirm=true.

Autorizzazione
teamspeak.bans.manage
Concessa alla connessione
Gestione TeamSpeak

Parametri

  • serviceIdstringobbligatorio

    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.

  • ipstringfacoltativo
  • uidstringfacoltativo
  • namestringfacoltativo
  • timenumberfacoltativo
  • reasonstringfacoltativo
  • confirmbooleanfacoltativo

Delete TeamSpeak Ban

delete_teamspeak_ban
DistruttivoConferma necessaria

Delete a TeamSpeak ban. Requires confirm=true.

Autorizzazione
teamspeak.bans.manage
Concessa alla connessione
Gestione TeamSpeak

Parametri

  • serviceIdstringobbligatorio

    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.

  • banIdintegerobbligatorio

    > 0 · max 9007199254740991

  • confirmbooleanfacoltativo

Delete TeamSpeak Privilege Key

delete_teamspeak_token
DistruttivoConferma necessaria

Delete a TeamSpeak privilege token. Requires confirm=true.

Autorizzazione
teamspeak.tokens.manage
Concessa alla connessione
Gestione TeamSpeak

Parametri

  • serviceIdstringobbligatorio

    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.

  • tokenstringobbligatorio
  • confirmbooleanfacoltativo

Bot Discord

Stato, console, avvio e arresto e l’attività dei tuoi bot Discord.

List Discord Bots

list_discord_bots
Sola letturaPunto di partenza

List Discord bots accessible with the current token.

Autorizzazione
discord_bot.view
Concessa alla connessione
Visualizza i servizi

Parametri

Nessun parametro

Get Discord Bot

get_discord_bot
Sola letturaPunto di partenza

Get Discord bot details.

Autorizzazione
discord_bot.view
Concessa alla connessione
Visualizza i servizi

Parametri

  • serviceIdstringobbligatorio

    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
Sola lettura

Get Discord bot container and port reachability status.

Autorizzazione
discord_bot.view
Concessa alla connessione
Visualizza i servizi

Parametri

  • serviceIdstringobbligatorio

    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
Sola lettura

Read recent Discord bot activity logs.

Autorizzazione
discord_bot.view
Concessa alla connessione
Visualizza i servizi

Parametri

  • serviceIdstringobbligatorio

    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.

  • limitintegerfacoltativo

    min 1 · max 100

  • offsetintegerfacoltativo

    min 0 · max 9007199254740991

Start Discord Bot

start_discord_bot
Modifica datiConferma necessaria

Start a Discord bot. Requires confirm=true.

Autorizzazione
discord_bot.start
Concessa alla connessione
Azioni di alimentazione

Parametri

  • serviceIdstringobbligatorio

    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.

  • confirmbooleanfacoltativo

Stop Discord Bot

stop_discord_bot
DistruttivoConferma necessaria

Stop a Discord bot. Requires confirm=true.

Autorizzazione
discord_bot.stop
Concessa alla connessione
Azioni di alimentazione

Parametri

  • serviceIdstringobbligatorio

    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.

  • confirmbooleanfacoltativo

Restart Discord Bot

restart_discord_bot
DistruttivoConferma necessaria

Restart a Discord bot. Requires confirm=true.

Autorizzazione
discord_bot.restart
Concessa alla connessione
Azioni di alimentazione

Parametri

  • serviceIdstringobbligatorio

    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.

  • confirmbooleanfacoltativo

Get Discord Bot Console Logs

get_discord_bot_console_logs
Sola lettura

Get recent Discord bot console log lines.

Autorizzazione
discord_bot.console.read
Concessa alla connessione
Console e log

Parametri

  • serviceIdstringobbligatorio

    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.

  • linesintegerfacoltativo

    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
DistruttivoConferma necessaria

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

Autorizzazione
discord_bot.console.write
Concessa alla connessione
Console e log

Parametri

  • serviceIdstringobbligatorio

    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.

  • commandstringobbligatorio

    max length 500

  • confirmbooleanfacoltativo

Domini

Domini, record DNS, nameserver, pagina di parcheggio e rinnovo automatico.

List Domains

list_domains
Sola letturaPunto di partenza

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.

Autorizzazione
domain.view
Concessa alla connessione
Visualizza i servizi

Parametri

Nessun parametro

Get Domain

get_domain
Sola lettura

Get one domain by ID. Read-only.

Autorizzazione
domain.view
Concessa alla connessione
Visualizza i servizi

Parametri

  • domainIdstringobbligatorio

    Domain id (from list_domains or list_account_services).

Get Domain DNS Records

get_domain_dns_records
Sola letturaPunto di partenza

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.

Autorizzazione
domain.dns.read
Concessa alla connessione
Visualizza configurazione

Parametri

  • domainIdstringobbligatorio

    Domain id (from list_domains or list_account_services).

Create Domain DNS Record

create_domain_dns_record
Modifica datiConferma necessaria

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.

Autorizzazione
domain.dns.write
Concessa alla connessione
Gestione domini

Parametri

  • domainIdstringobbligatorio

    Domain id (from list_domains or list_account_services).

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

    Record type.

  • namestringfacoltativo

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

    max length 253

  • contentstringobbligatorio

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

    max length 4096

  • ttlintegerfacoltativo

    TTL in seconds (default 3600, min 60).

    min 60 · max 9007199254740991

  • priorityintegerfacoltativo

    MX/SRV priority.

    min 0 · max 65535

  • weightintegerfacoltativo

    SRV weight.

    min 0 · max 65535

  • portintegerfacoltativo

    SRV port.

    min 0 · max 65535

  • confirmbooleanfacoltativo

    Must be true to apply the change.

Update Domain DNS Record

update_domain_dns_record
DistruttivoConferma necessaria

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.

Autorizzazione
domain.dns.write
Concessa alla connessione
Gestione domini

Parametri

  • domainIdstringobbligatorio

    Domain id (from list_domains or list_account_services).

  • recordIdstringobbligatorio

    Record id from get_domain_dns_records.

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

    Record type.

  • namestringfacoltativo

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

    max length 253

  • contentstringobbligatorio

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

    max length 4096

  • ttlintegerfacoltativo

    TTL in seconds (default 3600, min 60).

    min 60 · max 9007199254740991

  • priorityintegerfacoltativo

    MX/SRV priority.

    min 0 · max 65535

  • weightintegerfacoltativo

    SRV weight.

    min 0 · max 65535

  • portintegerfacoltativo

    SRV port.

    min 0 · max 65535

  • confirmbooleanfacoltativo

    Must be true to apply the change.

Delete Domain DNS Record

delete_domain_dns_record
DistruttivoConferma necessaria

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.

Autorizzazione
domain.dns.write
Concessa alla connessione
Gestione domini

Parametri

  • domainIdstringobbligatorio

    Domain id (from list_domains or list_account_services).

  • recordIdstringobbligatorio

    Record id from get_domain_dns_records.

  • confirmbooleanfacoltativo

    Must be true to apply the change.

Set Domain Parking Page

set_domain_parking_page
DistruttivoConferma necessaria

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.

Autorizzazione
domain.dns.write
Concessa alla connessione
Gestione domini

Parametri

  • domainIdstringobbligatorio

    Domain id (from list_domains or list_account_services).

  • enabledbooleanobbligatorio

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

  • confirmedReplaceRecordIdsstring[]facoltativo

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

    max items 200

  • confirmbooleanfacoltativo

    Must be true to apply the change.

Get Domain Nameservers

get_domain_nameservers
Sola lettura

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

Autorizzazione
domain.dns.read
Concessa alla connessione
Visualizza configurazione

Parametri

  • domainIdstringobbligatorio

    Domain id (from list_domains or list_account_services).

Set Domain Nameservers

set_domain_nameservers
DistruttivoConferma necessaria

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.

Autorizzazione
domain.nameservers.write
Concessa alla connessione
Gestione domini

Parametri

  • domainIdstringobbligatorio

    Domain id (from list_domains or list_account_services).

  • mode"managed" | "external"obbligatorio

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

  • nameserversstring[]facoltativo

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

    min items 2 · max items 13

  • confirmbooleanfacoltativo

    Must be true to apply the change.

Get Domain Renewal Status

get_domain_renewal
Sola lettura

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

Autorizzazione
domain.view
Concessa alla connessione
Visualizza i servizi

Parametri

  • domainIdstringobbligatorio

    Domain id (from list_domains or list_account_services).

Set Domain Auto-Renew

set_domain_auto_renew
DistruttivoConferma necessaria

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.

Autorizzazione
domain.renewal.manage
Concessa alla connessione
Gestione domini

Parametri

  • domainIdstringobbligatorio

    Domain id (from list_domains or list_account_services).

  • autoRenewbooleanobbligatorio

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

  • confirmbooleanfacoltativo

    Must be true to apply the change.

File

Elencare, leggere, scrivere, rinominare ed eliminare i file di server di gioco e bot Discord.

List Discord Bot Files

list_discord_bot_files
Sola letturaPunto di partenza

List files in a Discord bot directory.

Autorizzazione
discord_bot.files.read
Concessa alla connessione
Visualizza configurazione

Parametri

  • serviceIdstringobbligatorio

    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.

  • pathstringfacoltativo
  • includeFolderSizesbooleanfacoltativo

Read Discord Bot File

read_discord_bot_file
Sola lettura

Read an editable text file from a Discord bot.

Autorizzazione
discord_bot.files.read
Concessa alla connessione
Visualizza configurazione

Parametri

  • serviceIdstringobbligatorio

    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.

  • pathstringobbligatorio

Edit Discord Bot File

mutate_discord_bot_file
DistruttivoConferma necessaria

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

Autorizzazione
discord_bot.files.write
Concessa alla connessione
Modifica configurazione

Parametri

  • serviceIdstringobbligatorio

    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"obbligatorio

  • pathstringobbligatorio
  • contentstringfacoltativo
  • expectedRevisionstringfacoltativo

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

  • newNamestringfacoltativo
  • confirmbooleanfacoltativo

List Game Server Files

list_gameserver_files
Sola letturaPunto di partenza

List files in a gameserver directory.

Autorizzazione
gameserver.files.read
Concessa alla connessione
Visualizza configurazione

Parametri

  • serviceIdstringobbligatorio

    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.

  • pathstringfacoltativo
  • scope"savegame" | "config" | "active"facoltativo

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

  • includeFolderSizesbooleanfacoltativo

Read Game Server File

read_gameserver_file
Sola lettura

Read text content of a gameserver file.

Autorizzazione
gameserver.files.read
Concessa alla connessione
Visualizza configurazione

Parametri

  • serviceIdstringobbligatorio

    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.

  • pathstringobbligatorio
  • scope"savegame" | "config" | "active"facoltativo

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

Edit Game Server File

mutate_gameserver_file
DistruttivoConferma necessaria

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.

Autorizzazione
gameserver.files.write
Concessa alla connessione
Modifica configurazione

Parametri

  • serviceIdstringobbligatorio

    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"obbligatorio

  • pathstringfacoltativo

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

  • contentstringfacoltativo
  • expectedRevisionstringfacoltativo

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

  • newNamestringfacoltativo
  • pathsstring[]facoltativo

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

    min items 1 · max items 100

  • destinationstringfacoltativo

    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"facoltativo

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

  • confirmbooleanfacoltativo

App con un clic (VPS e dedicati)

Catalogo di app (Pterodactyl, Nextcloud, n8n, ...), installazione, avvio/arresto/riavvio, log e disinstallazione; i server di gioco in Pterodactyl si creano nel suo pannello.

List VPS One-Click Apps

get_vserver_apps
Sola letturaPunto di partenza

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.

Autorizzazione
vserver.apps.read
Concessa alla connessione
Visualizza configurazione

Parametri

  • serviceIdstringobbligatorio

    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.

  • livebooleanfacoltativo

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

Search VPS App Catalog

list_vserver_app_catalog
Sola lettura

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

Autorizzazione
vserver.apps.read
Concessa alla connessione
Visualizza configurazione

Parametri

  • serviceIdstringobbligatorio

    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.

  • searchstringfacoltativo

    Free text search over name, description and tags.

    max length 200

  • categorystringfacoltativo

    max length 100

  • pageintegerfacoltativo

    > 0 · max 9007199254740991

  • pageSizeintegerfacoltativo

    > 0 · max 50

Get VPS App Catalog Entry

get_vserver_app_catalog_entry
Sola lettura

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

Autorizzazione
vserver.apps.read
Concessa alla connessione
Visualizza configurazione

Parametri

  • serviceIdstringobbligatorio

    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.

  • catalogTypestringobbligatorio

    max length 128

Get VPS App Logs

get_vserver_app_logs
Sola lettura

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

Autorizzazione
vserver.apps.read
Concessa alla connessione
Visualizza configurazione

Parametri

  • serviceIdstringobbligatorio

    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.

  • installationIdstringobbligatorio

    Installation id from get_vserver_apps / get_dedicated_apps.

    max length 64

  • linesintegerfacoltativo

    min 50 · max 500

Install VPS One-Click App

install_vserver_app
Modifica datiConferma necessaria

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.

Autorizzazione
vserver.apps.manage
Concessa alla connessione
Modifica configurazione

Parametri

  • serviceIdstringobbligatorio

    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.

  • catalogTypestringobbligatorio

    Catalog type from the app catalog.

    max length 128

  • displayNamestringobbligatorio

    min length 2 · max length 80

  • envValuesRecord<string, string>facoltativo

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

  • customEnvsobject[]facoltativo

    max items 50

  • confirmbooleanfacoltativo
  • withoutHostnamebooleanfacoltativo

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

Start, Stop or Restart VPS App

manage_vserver_app
DistruttivoConferma necessaria

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

Autorizzazione
vserver.apps.manage
Concessa alla connessione
Modifica configurazione

Parametri

  • serviceIdstringobbligatorio

    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.

  • installationIdstringobbligatorio

    Installation id from get_vserver_apps / get_dedicated_apps.

    max length 64

  • action"start" | "stop" | "restart"obbligatorio

  • confirmbooleanfacoltativo

Uninstall VPS One-Click App

uninstall_vserver_app
DistruttivoConferma necessaria

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

Autorizzazione
vserver.apps.manage
Concessa alla connessione
Modifica configurazione

Parametri

  • serviceIdstringobbligatorio

    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.

  • installationIdstringobbligatorio

    Installation id from get_vserver_apps / get_dedicated_apps.

    max length 64

  • deleteVolumesbooleanfacoltativo

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

  • confirmbooleanfacoltativo

Reinstall VPS One-Click App

reinstall_vserver_app
DistruttivoConferma necessaria

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

Autorizzazione
vserver.apps.manage
Concessa alla connessione
Modifica configurazione

Parametri

  • serviceIdstringobbligatorio

    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.

  • installationIdstringobbligatorio

    Installation id from get_vserver_apps / get_dedicated_apps.

    max length 64

  • deleteVolumesbooleanfacoltativo

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

  • confirmbooleanfacoltativo

List Dedicated Server One-Click Apps

get_dedicated_apps
Sola letturaPunto di partenza

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.

Autorizzazione
dedicated.apps.read
Concessa alla connessione
Visualizza configurazione

Parametri

  • serviceIdstringobbligatorio

    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.

  • livebooleanfacoltativo

    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
Sola lettura

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.

Autorizzazione
dedicated.apps.read
Concessa alla connessione
Visualizza configurazione

Parametri

  • serviceIdstringobbligatorio

    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.

  • searchstringfacoltativo

    Free text search over name, description and tags.

    max length 200

  • categorystringfacoltativo

    max length 100

  • pageintegerfacoltativo

    > 0 · max 9007199254740991

  • pageSizeintegerfacoltativo

    > 0 · max 50

Get Dedicated Server App Catalog Entry

get_dedicated_app_catalog_entry
Sola lettura

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

Autorizzazione
dedicated.apps.read
Concessa alla connessione
Visualizza configurazione

Parametri

  • serviceIdstringobbligatorio

    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.

  • catalogTypestringobbligatorio

    max length 128

Get Dedicated Server App Logs

get_dedicated_app_logs
Sola lettura

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

Autorizzazione
dedicated.apps.read
Concessa alla connessione
Visualizza configurazione

Parametri

  • serviceIdstringobbligatorio

    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.

  • installationIdstringobbligatorio

    Installation id from get_vserver_apps / get_dedicated_apps.

    max length 64

  • linesintegerfacoltativo

    min 50 · max 500

Install Dedicated Server One-Click App

install_dedicated_app
Modifica datiConferma necessaria

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.

Autorizzazione
dedicated.apps.manage
Concessa alla connessione
Modifica configurazione

Parametri

  • serviceIdstringobbligatorio

    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.

  • catalogTypestringobbligatorio

    Catalog type from the app catalog.

    max length 128

  • displayNamestringobbligatorio

    min length 2 · max length 80

  • envValuesRecord<string, string>facoltativo

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

  • customEnvsobject[]facoltativo

    max items 50

  • confirmbooleanfacoltativo

Start, Stop or Restart Dedicated Server App

manage_dedicated_app
DistruttivoConferma necessaria

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

Autorizzazione
dedicated.apps.manage
Concessa alla connessione
Modifica configurazione

Parametri

  • serviceIdstringobbligatorio

    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.

  • installationIdstringobbligatorio

    Installation id from get_vserver_apps / get_dedicated_apps.

    max length 64

  • action"start" | "stop" | "restart"obbligatorio

  • confirmbooleanfacoltativo

Uninstall Dedicated Server One-Click App

uninstall_dedicated_app
DistruttivoConferma necessaria

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

Autorizzazione
dedicated.apps.manage
Concessa alla connessione
Modifica configurazione

Parametri

  • serviceIdstringobbligatorio

    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.

  • installationIdstringobbligatorio

    Installation id from get_vserver_apps / get_dedicated_apps.

    max length 64

  • deleteVolumesbooleanfacoltativo

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

  • confirmbooleanfacoltativo

Reinstall Dedicated Server One-Click App

reinstall_dedicated_app
DistruttivoConferma necessaria

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

Autorizzazione
dedicated.apps.manage
Concessa alla connessione
Modifica configurazione

Parametri

  • serviceIdstringobbligatorio

    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.

  • installationIdstringobbligatorio

    Installation id from get_vserver_apps / get_dedicated_apps.

    max length 64

  • deleteVolumesbooleanfacoltativo

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

  • confirmbooleanfacoltativo

Backup e snapshot

Creare, ripristinare ed eliminare backup e snapshot.

List Game Server Backups

list_gameserver_backups
Sola letturaPunto di partenza

List gameserver backups.

Autorizzazione
gameserver.backups.read
Concessa alla connessione
Visualizza configurazione

Parametri

  • serviceIdstringobbligatorio

    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
DistruttivoConferma necessaria

Create a gameserver backup. Requires confirm=true.

Autorizzazione
gameserver.backups.manage
Concessa alla connessione
Modifica configurazione

Parametri

  • serviceIdstringobbligatorio

    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.

  • namestringfacoltativo

    max length 120

  • confirmbooleanfacoltativo

Delete Game Server Backup

delete_gameserver_backup
DistruttivoConferma necessaria

Delete a gameserver backup. Requires confirm=true.

Autorizzazione
gameserver.backups.manage
Concessa alla connessione
Modifica configurazione

Parametri

  • serviceIdstringobbligatorio

    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.

  • backupIdstringobbligatorio
  • confirmbooleanfacoltativo

Restore Game Server Backup

restore_gameserver_backup
DistruttivoConferma necessaria

Restore a gameserver backup. Requires confirm=true.

Autorizzazione
gameserver.backups.manage
Concessa alla connessione
Modifica configurazione

Parametri

  • serviceIdstringobbligatorio

    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.

  • backupIdstringobbligatorio
  • confirmbooleanfacoltativo

List VPS Backups

list_vserver_backups
Sola letturaPunto di partenza

List VPS backups.

Autorizzazione
vserver.backups.read
Concessa alla connessione
Visualizza configurazione

Parametri

  • serviceIdstringobbligatorio

    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
Sola lettura

List VPS VM snapshots.

Autorizzazione
vserver.backups.read
Concessa alla connessione
Visualizza configurazione

Parametri

  • serviceIdstringobbligatorio

    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
Modifica datiConferma necessaria

Create a VPS VM snapshot. Requires confirm=true.

Autorizzazione
vserver.backups.manage
Concessa alla connessione
Modifica configurazione

Parametri

  • serviceIdstringobbligatorio

    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.

  • namestringobbligatorio
  • descriptionstringfacoltativo
  • includeRambooleanfacoltativo
  • confirmbooleanfacoltativo

Delete VPS Snapshot

delete_vserver_snapshot
DistruttivoConferma necessaria

Delete a VPS VM snapshot. Requires confirm=true.

Autorizzazione
vserver.backups.manage
Concessa alla connessione
Modifica configurazione

Parametri

  • serviceIdstringobbligatorio

    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.

  • namestringobbligatorio
  • confirmbooleanfacoltativo

Roll Back VPS to Snapshot

rollback_vserver_snapshot
DistruttivoConferma necessaria

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

Autorizzazione
vserver.backups.manage
Concessa alla connessione
Modifica configurazione

Parametri

  • serviceIdstringobbligatorio

    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.

  • namestringobbligatorio
  • confirmbooleanfacoltativo

Create VPS Backup

create_vserver_backup
Modifica datiConferma necessaria

Create a VPS backup. Requires confirm=true.

Autorizzazione
vserver.backups.manage
Concessa alla connessione
Modifica configurazione

Parametri

  • serviceIdstringobbligatorio

    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.

  • notesstringfacoltativo

    max length 500

  • confirmbooleanfacoltativo

Delete VPS Backup

delete_vserver_backup
DistruttivoConferma necessaria

Delete a VPS backup. Requires confirm=true.

Autorizzazione
vserver.backups.manage
Concessa alla connessione
Modifica configurazione

Parametri

  • serviceIdstringobbligatorio

    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.

  • backupIdstringobbligatorio
  • confirmbooleanfacoltativo

Restore VPS Backup

restore_vserver_backup
DistruttivoConferma necessaria

Restore a VPS backup. Requires confirm=true.

Autorizzazione
vserver.backups.manage
Concessa alla connessione
Modifica configurazione

Parametri

  • serviceIdstringobbligatorio

    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.

  • backupIdstringobbligatorio
  • confirmbooleanfacoltativo

Cambi di piano

Upgrade e downgrade con anteprima del prezzo, applicati solo dopo la tua conferma esplicita.

Get Game Server Plan Change Options

get_gameserver_plan_change_options
Sola letturaPunto di partenzaNon presente nei connettori di ChatGPT e Claude

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.

Ordini e cambi di piano sono nascosti nei connettori delle directory di app di ChatGPT e Claude. In Claude Code, Cursor e con una chiave API lo strumento è disponibile.

Autorizzazione
gameserver.plan_change
Concessa alla connessione
Modifiche al piano

Parametri

  • serviceIdstringobbligatorio

    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
Sola letturaNon presente nei connettori di ChatGPT e Claude

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.

Ordini e cambi di piano sono nascosti nei connettori delle directory di app di ChatGPT e Claude. In Claude Code, Cursor e con una chiave API lo strumento è disponibile.

Autorizzazione
gameserver.plan_change
Concessa alla connessione
Modifiche al piano

Parametri

  • serviceIdstringobbligatorio

    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.

  • targetobjectfacoltativo
  • target.pricingMode"package" | "custom"facoltativo

  • target.targetPackageKeystringfacoltativo
  • target.ramMbintegerfacoltativo

    > 0 · max 9007199254740991

  • target.cpuMillisintegerfacoltativo

    > 0 · max 9007199254740991

  • target.diskMbintegerfacoltativo

    > 0 · max 9007199254740991

  • target.slotsintegerfacoltativo

    > 0 · max 9007199254740991

  • target.dedicatedIpbooleanfacoltativo
  • target.premiumCpubooleanfacoltativo

    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.targetRegionIdstringfacoltativo
  • target.targetBillingIntervalCountintegerfacoltativo

    > 0 · max 9007199254740991

  • couponCodestringfacoltativo

    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
DistruttivoConferma necessariaNon presente nei connettori di ChatGPT e Claude

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.

Ordini e cambi di piano sono nascosti nei connettori delle directory di app di ChatGPT e Claude. In Claude Code, Cursor e con una chiave API lo strumento è disponibile.

Autorizzazione
gameserver.plan_change
Concessa alla connessione
Modifiche al piano

Parametri

  • serviceIdstringobbligatorio

    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.

  • targetobjectfacoltativo
  • target.pricingMode"package" | "custom"facoltativo

  • target.targetPackageKeystringfacoltativo
  • target.ramMbintegerfacoltativo

    > 0 · max 9007199254740991

  • target.cpuMillisintegerfacoltativo

    > 0 · max 9007199254740991

  • target.diskMbintegerfacoltativo

    > 0 · max 9007199254740991

  • target.slotsintegerfacoltativo

    > 0 · max 9007199254740991

  • target.dedicatedIpbooleanfacoltativo
  • target.premiumCpubooleanfacoltativo

    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.targetRegionIdstringfacoltativo
  • target.targetBillingIntervalCountintegerfacoltativo

    > 0 · max 9007199254740991

  • couponCodestringfacoltativo

    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

  • confirmtrueobbligatorio
  • userExplicitlyConfirmedtrueobbligatorio
  • previewConfirmationNoncestringobbligatorio
  • requestImmediateStartbooleanfacoltativo

    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
Sola lettura

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.

Autorizzazione
vserver.plan_change
Concessa alla connessione
Modifiche al piano

Parametri

  • serviceIdstringobbligatorio

    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
Sola lettura

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.

Autorizzazione
vserver.plan_change
Concessa alla connessione
Modifiche al piano

Parametri

  • serviceIdstringobbligatorio

    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.

  • targetobjectfacoltativo
  • target.pricingMode"package" | "custom"facoltativo

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

  • target.targetPackageKeystringfacoltativo
  • target.coresintegerfacoltativo

    > 0 · max 9007199254740991

  • target.memoryMbintegerfacoltativo

    > 0 · max 9007199254740991

  • target.diskGbintegerfacoltativo

    > 0 · max 9007199254740991

  • target.bandwidthMbpsintegerfacoltativo

    > 0 · max 9007199254740991

  • target.memoryintegerfacoltativo

    > 0 · max 9007199254740991

  • target.diskintegerfacoltativo

    > 0 · max 9007199254740991

  • target.bandwidthintegerfacoltativo

    > 0 · max 9007199254740991

  • target.additionalIpCountintegerfacoltativo

    min 0 · max 9007199254740991

  • target.targetBillingIntervalCountintegerfacoltativo

    > 0 · max 9007199254740991

  • couponCodestringfacoltativo

    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
DistruttivoConferma necessaria

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.

Autorizzazione
vserver.plan_change
Concessa alla connessione
Modifiche al piano

Parametri

  • serviceIdstringobbligatorio

    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.

  • targetobjectfacoltativo
  • target.pricingMode"package" | "custom"facoltativo

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

  • target.targetPackageKeystringfacoltativo
  • target.coresintegerfacoltativo

    > 0 · max 9007199254740991

  • target.memoryMbintegerfacoltativo

    > 0 · max 9007199254740991

  • target.diskGbintegerfacoltativo

    > 0 · max 9007199254740991

  • target.bandwidthMbpsintegerfacoltativo

    > 0 · max 9007199254740991

  • target.memoryintegerfacoltativo

    > 0 · max 9007199254740991

  • target.diskintegerfacoltativo

    > 0 · max 9007199254740991

  • target.bandwidthintegerfacoltativo

    > 0 · max 9007199254740991

  • target.additionalIpCountintegerfacoltativo

    min 0 · max 9007199254740991

  • target.targetBillingIntervalCountintegerfacoltativo

    > 0 · max 9007199254740991

  • couponCodestringfacoltativo

    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

  • confirmtrueobbligatorio
  • userExplicitlyConfirmedtrueobbligatorio
  • previewConfirmationNoncestringobbligatorio
  • requestImmediateStartbooleanfacoltativo

    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
Sola letturaNon presente nei connettori di ChatGPT e Claude

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.

Ordini e cambi di piano sono nascosti nei connettori delle directory di app di ChatGPT e Claude. In Claude Code, Cursor e con una chiave API lo strumento è disponibile.

Autorizzazione
teamspeak.plan_change
Concessa alla connessione
Modifiche al piano

Parametri

  • serviceIdstringobbligatorio

    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
Sola letturaNon presente nei connettori di ChatGPT e Claude

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.

Ordini e cambi di piano sono nascosti nei connettori delle directory di app di ChatGPT e Claude. In Claude Code, Cursor e con una chiave API lo strumento è disponibile.

Autorizzazione
teamspeak.plan_change
Concessa alla connessione
Modifiche al piano

Parametri

  • serviceIdstringobbligatorio

    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.

  • targetobjectfacoltativo
  • target.pricingMode"package" | "custom"facoltativo

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

  • target.targetPackageKeystringfacoltativo
  • target.slotsintegerfacoltativo

    > 0 · max 9007199254740991

  • target.hasAdvertisementbooleanfacoltativo
  • target.targetBillingIntervalCountintegerfacoltativo

    > 0 · max 9007199254740991

  • couponCodestringfacoltativo

    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
DistruttivoConferma necessariaNon presente nei connettori di ChatGPT e Claude

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.

Ordini e cambi di piano sono nascosti nei connettori delle directory di app di ChatGPT e Claude. In Claude Code, Cursor e con una chiave API lo strumento è disponibile.

Autorizzazione
teamspeak.plan_change
Concessa alla connessione
Modifiche al piano

Parametri

  • serviceIdstringobbligatorio

    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.

  • targetobjectfacoltativo
  • target.pricingMode"package" | "custom"facoltativo

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

  • target.targetPackageKeystringfacoltativo
  • target.slotsintegerfacoltativo

    > 0 · max 9007199254740991

  • target.hasAdvertisementbooleanfacoltativo
  • target.targetBillingIntervalCountintegerfacoltativo

    > 0 · max 9007199254740991

  • couponCodestringfacoltativo

    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

  • confirmtrueobbligatorio
  • userExplicitlyConfirmedtrueobbligatorio
  • previewConfirmationNoncestringobbligatorio
  • requestImmediateStartbooleanfacoltativo

    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
Sola letturaNon presente nei connettori di ChatGPT e Claude

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.

Ordini e cambi di piano sono nascosti nei connettori delle directory di app di ChatGPT e Claude. In Claude Code, Cursor e con una chiave API lo strumento è disponibile.

Autorizzazione
dedicated.plan_change
Concessa alla connessione
Modifiche al piano

Parametri

  • serviceIdstringobbligatorio

    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
Sola letturaNon presente nei connettori di ChatGPT e Claude

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.

Ordini e cambi di piano sono nascosti nei connettori delle directory di app di ChatGPT e Claude. In Claude Code, Cursor e con una chiave API lo strumento è disponibile.

Autorizzazione
dedicated.plan_change
Concessa alla connessione
Modifiche al piano

Parametri

  • serviceIdstringobbligatorio

    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.

  • targetobjectfacoltativo
  • target.additionalIpCountintegerfacoltativo

    min 0 · max 9007199254740991

  • target.releaseIpAssignmentIdsstring[]facoltativo
  • couponCodestringfacoltativo

    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
DistruttivoConferma necessariaNon presente nei connettori di ChatGPT e Claude

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.

Ordini e cambi di piano sono nascosti nei connettori delle directory di app di ChatGPT e Claude. In Claude Code, Cursor e con una chiave API lo strumento è disponibile.

Autorizzazione
dedicated.plan_change
Concessa alla connessione
Modifiche al piano

Parametri

  • serviceIdstringobbligatorio

    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.

  • targetobjectfacoltativo
  • target.additionalIpCountintegerfacoltativo

    min 0 · max 9007199254740991

  • target.releaseIpAssignmentIdsstring[]facoltativo
  • couponCodestringfacoltativo

    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

  • confirmtrueobbligatorio
  • userExplicitlyConfirmedtrueobbligatorio
  • previewConfirmationNoncestringobbligatorio
  • requestImmediateStartbooleanfacoltativo

    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
Sola letturaPunto di partenza

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

Autorizzazione
gameserver.plan_changevserver.plan_changeteamspeak.plan_changededicated.plan_change
Concessa alla connessione
Modifiche al piano

Parametri

  • changeIdstringobbligatorio

Ordini

Prodotti, piani, regioni, giochi e immagini ISO ordinabili, più l’anteprima del prezzo di un ordine.

List Orderable Products

list_orderable_products
Sola letturaPunto di partenzaNon presente nei connettori di ChatGPT e Claude

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.

Ordini e cambi di piano sono nascosti nei connettori delle directory di app di ChatGPT e Claude. In Claude Code, Cursor e con una chiave API lo strumento è disponibile.

Autorizzazione
orders.view
Concessa alla connessione
Catalogo ordini e anteprima

Parametri

Nessun parametro

List Orderable Plans

list_orderable_plans
Sola letturaNon presente nei connettori di ChatGPT e Claude

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.

Ordini e cambi di piano sono nascosti nei connettori delle directory di app di ChatGPT e Claude. In Claude Code, Cursor e con una chiave API lo strumento è disponibile.

Autorizzazione
orders.view
Concessa alla connessione
Catalogo ordini e anteprima

Parametri

  • productSlugstringobbligatorio

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

List Regions for an Orderable Product

list_orderable_product_regions
Sola letturaNon presente nei connettori di ChatGPT e Claude

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.

Ordini e cambi di piano sono nascosti nei connettori delle directory di app di ChatGPT e Claude. In Claude Code, Cursor e con una chiave API lo strumento è disponibile.

Autorizzazione
orders.view
Concessa alla connessione
Catalogo ordini e anteprima

Parametri

  • productSlugstringobbligatorio

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

List Order Regions

list_order_regions
Sola letturaNon presente nei connettori di ChatGPT e Claude

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.

Ordini e cambi di piano sono nascosti nei connettori delle directory di app di ChatGPT e Claude. In Claude Code, Cursor e con una chiave API lo strumento è disponibile.

Autorizzazione
orders.view
Concessa alla connessione
Catalogo ordini e anteprima

Parametri

Nessun parametro

List Orderable Games

list_orderable_games
Sola letturaNon presente nei connettori di ChatGPT e Claude

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.

Ordini e cambi di piano sono nascosti nei connettori delle directory di app di ChatGPT e Claude. In Claude Code, Cursor e con una chiave API lo strumento è disponibile.

Autorizzazione
orders.view
Concessa alla connessione
Catalogo ordini e anteprima

Parametri

Nessun parametro

List ISO Images for VPS Orders

list_vserver_order_isos
Sola letturaNon presente nei connettori di ChatGPT e Claude

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.

Ordini e cambi di piano sono nascosti nei connettori delle directory di app di ChatGPT e Claude. In Claude Code, Cursor e con una chiave API lo strumento è disponibile.

Autorizzazione
orders.view
Concessa alla connessione
Catalogo ordini e anteprima

Parametri

Nessun parametro

Preview Order Price

preview_order
Sola letturaPunto di partenzaNon presente nei connettori di ChatGPT e Claude

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.

Ordini e cambi di piano sono nascosti nei connettori delle directory di app di ChatGPT e Claude. In Claude Code, Cursor e con una chiave API lo strumento è disponibile.

Autorizzazione
orders.view
Concessa alla connessione
Catalogo ordini e anteprima

Parametri

  • productSlugstringobbligatorio

    Product slug from list_orderable_products.

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

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

  • planSlugstringfacoltativo

    Plan slug from list_orderable_plans (products with fixed plans).

  • gameSlugstringfacoltativo

    Game slug from list_orderable_games (gameservers).

  • regionSlugstringfacoltativo

    Region slug from list_orderable_product_regions (products with region choice).

  • resourceConfigRecord<string, number>facoltativo

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

  • optionsobjectfacoltativo
  • options.couponCodestringfacoltativo
  • options.dedicatedIpCountintegerfacoltativo

    min 0 · max 9007199254740991

  • options.domainAttachmentobjectfacoltativo
  • configurationRecord<string, any>facoltativo

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

  • domainsobject[]facoltativo

Get Order Status

get_order_status
Sola letturaNon presente nei connettori di ChatGPT e Claude

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.

Ordini e cambi di piano sono nascosti nei connettori delle directory di app di ChatGPT e Claude. In Claude Code, Cursor e con una chiave API lo strumento è disponibile.

Autorizzazione
orders.view
Concessa alla connessione
Catalogo ordini e anteprima

Parametri

  • orderIdstringobbligatorio

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

Place Paid Order

create_order
Modifica datiConferma necessariaNon presente nei connettori di ChatGPT e Claude

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.

Ordini e cambi di piano sono nascosti nei connettori delle directory di app di ChatGPT e Claude. In Claude Code, Cursor e con una chiave API lo strumento è disponibile.

Autorizzazione
orders.create
Concessa alla connessione
Effettuare ordini (a pagamento)

Parametri

  • confirmationCodestringobbligatorio

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

  • confirmtrueobbligatorio

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

  • userExplicitlyConfirmedbooleanobbligatorio

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

  • requestImmediateStartbooleanfacoltativo

    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

Il tuo client IA ci segnala direttamente bug o funzioni mancanti degli strumenti MCP.

Send Feedback About This Connector

report_mcp_feedback
Modifica datiPunto di partenza

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.

Autorizzazione
Qualsiasi connessione
Concessa alla connessione
Qualsiasi connessione

Parametri

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

  • summarystringobbligatorio

    One sentence: what went wrong or what is missing.

    min length 5 · max length 200

  • detailsstringfacoltativo

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

    max length 4000

  • relatedToolstringfacoltativo

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

    max length 100

  • exampleArgsRecord<string, any>facoltativo

    Optional arguments of the failing call, without secrets.