Aller au contenu

MCP

Tous les outils MCP

Chaque outil que ton client IA peut appeler via le serveur MCP ZapX, avec ses paramètres, l’autorisation requise et son comportement. La liste est générée directement à partir du serveur et reste donc toujours à jour.

224 outils dans 13 groupes · inclus dans chaque ZapX Pass

Endpointhttps://zap-hosting.com/api/mcpJSONMarkdown pour les LLM
Les noms, titres et descriptions des outils sont en anglais, exactement comme ton client IA les reçoit du serveur. Les outils marqués « Confirmation requise » ne s’exécutent qu’avec confirm: true. Ton client IA te demande ton accord avant d’effectuer l’action.

224 outils sur 224

Compte

Tous les services avec leur ID et leur type, les incidents et maintenances, et le statut des opérations en cours.

List All Services

list_account_services
Lecture seulePoint de départ

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

Autorisation
Toute connexionLes résultats ne contiennent que les services que la connexion peut consulter.
Accordée lors de la connexion
Toute connexion

Paramètres

Aucun paramètre

List Incidents

list_incidents
Lecture seulePoint de départ

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.

Autorisation
Toute connexionLes résultats ne contiennent que les services que la connexion peut consulter.
Accordée lors de la connexion
Toute connexion

Paramètres

  • resolvedHoursintegerfacultatif

    min 0 · max 168

Get Operation Status

get_operation_status
Lecture seule

Poll the status of an async public API operation.

Autorisation
Toute connexionLes résultats ne contiennent que les services que la connexion peut consulter.
Accordée lors de la connexion
Toute connexion

Paramètres

  • operationIdstringobligatoire

Serveurs de jeu

Statut, console, démarrage et arrêt, paramètres, version et variante du jeu, mods, sauvegardes de partie, accès SFTP et réinstallation.

List Game Servers

list_gameservers
Lecture seulePoint de départ

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

Autorisation
gameserver.view
Accordée lors de la connexion
Consulter les services

Paramètres

Aucun paramètre

Get Game Server

get_gameserver
Lecture seulePoint de départ

Get one gameserver by ID.

Autorisation
gameserver.view
Accordée lors de la connexion
Consulter les services

Paramètres

  • serviceIdstringobligatoire

    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
Lecture seulePoint de départ

Get live query status for a gameserver.

Autorisation
gameserver.view
Accordée lors de la connexion
Consulter les services

Paramètres

  • serviceIdstringobligatoire

    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
Lecture seule

Read editable gameserver configuration fields.

Autorisation
gameserver.config.read
Accordée lors de la connexion
Lire la configuration

Paramètres

  • serviceIdstringobligatoire

    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
DestructifConfirmation requise

Update editable gameserver configuration fields. Requires confirm=true.

Autorisation
gameserver.config.write
Accordée lors de la connexion
Modifier la configuration

Paramètres

  • serviceIdstringobligatoire

    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>obligatoire
  • confirmbooleanfacultatif

Get Game Server Console Logs

get_gameserver_console_logs
Lecture seule

Read a recent gameserver console log snapshot.

Autorisation
gameserver.console.read
Accordée lors de la connexion
Console et journaux

Paramètres

  • serviceIdstringobligatoire

    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.

  • linesintegerfacultatif

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

    > 0 · max 200

Restart Game Server

restart_gameserver
DestructifConfirmation requise

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

Autorisation
gameserver.restart
Accordée lors de la connexion
Actions Power

Paramètres

  • serviceIdstringobligatoire

    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.

  • confirmbooleanfacultatif

Start Game Server

start_gameserver
Modifie des donnéesConfirmation requise

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

Autorisation
gameserver.start
Accordée lors de la connexion
Actions Power

Paramètres

  • serviceIdstringobligatoire

    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.

  • confirmbooleanfacultatif

Stop Game Server

stop_gameserver
DestructifConfirmation requise

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

Autorisation
gameserver.stop
Accordée lors de la connexion
Actions Power

Paramètres

  • serviceIdstringobligatoire

    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.

  • confirmbooleanfacultatif

Send Game Server Console Command

send_gameserver_console_command
DestructifConfirmation requise

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

Autorisation
gameserver.console.write
Accordée lors de la connexion
Console et journaux

Paramètres

  • serviceIdstringobligatoire

    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.

  • commandstringobligatoire

    max length 500

  • confirmbooleanfacultatif

Get Game Server Activity

get_gameserver_activity
Lecture seule

Read recent gameserver activity logs.

Autorisation
gameserver.activity.read
Accordée lors de la connexion
Consulter les services

Paramètres

  • serviceIdstringobligatoire

    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.

  • limitintegerfacultatif

    > 0 · max 100

  • offsetintegerfacultatif

    min 0 · max 9007199254740991

Get Game Server Container Status

get_gameserver_container_status
Lecture seule

Get gameserver container and port reachability status.

Autorisation
gameserver.view
Accordée lors de la connexion
Consulter les services

Paramètres

  • serviceIdstringobligatoire

    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
Lecture seule

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.

Autorisation
gameserver.view
Accordée lors de la connexion
Consulter les services

Paramètres

  • serviceIdstringobligatoire

    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
Modifie des donnéesConfirmation requise

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.

Autorisation
gameserver.backups.managegameserver.restartgameserver.startgameserver.stopgameserver.console.writegameserver.wipe
Accordée lors de la connexion
Actions Power, Console et journaux, Modifier la configuration

Paramètres

  • serviceIdstringobligatoire

    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.

  • namestringobligatoire

    max length 120

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

  • cronstringobligatoire

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

  • timezonestringfacultatif

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

  • commandstringfacultatif

    Console command, required for action=command.

    max length 2000

  • wipeobjectfacultatif

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

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

    Rust: map, blueprints or full.

  • wipe.backupFirstbooleanfacultatif

    Back up before wiping (default true).

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

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

  • wipe.worldSizeintegerfacultatif

    min 1000 · max 6000

  • isActivebooleanfacultatif
  • confirmbooleanfacultatif

Update Game Server Schedule

update_gameserver_schedule
DestructifConfirmation requise

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.

Autorisation
gameserver.backups.managegameserver.restartgameserver.startgameserver.stopgameserver.console.writegameserver.wipe
Accordée lors de la connexion
Actions Power, Console et journaux, Modifier la configuration

Paramètres

  • serviceIdstringobligatoire

    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.

  • scheduleIdstringobligatoire
  • namestringfacultatif

    max length 120

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

  • cronstringfacultatif

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

  • timezonestringfacultatif

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

  • commandstringfacultatif

    Console command, required for action=command.

    max length 2000

  • wipeobjectfacultatif

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

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

    Rust: map, blueprints or full.

  • wipe.backupFirstbooleanfacultatif

    Back up before wiping (default true).

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

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

  • wipe.worldSizeintegerfacultatif

    min 1000 · max 6000

  • isActivebooleanfacultatif
  • confirmbooleanfacultatif

Delete Game Server Schedule

delete_gameserver_schedule
DestructifConfirmation requise

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

Autorisation
gameserver.backups.managegameserver.restartgameserver.startgameserver.stopgameserver.console.writegameserver.wipe
Accordée lors de la connexion
Actions Power, Console et journaux, Modifier la configuration

Paramètres

  • serviceIdstringobligatoire

    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.

  • scheduleIdstringobligatoire
  • confirmbooleanfacultatif

Wipe Game Server

wipe_gameserver
DestructifConfirmation requise

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.

Autorisation
gameserver.wipe
Accordée lors de la connexion
Accès complet

Paramètres

  • serviceIdstringobligatoire

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

    Rust: map, blueprints or full.

  • backupFirstbooleanfacultatif

    Back up before wiping (default true).

  • seed"keep" | "random" | integerfacultatif

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

  • worldSizeintegerfacultatif

    min 1000 · max 6000

  • confirmbooleanfacultatif

List Game Server Databases

list_gameserver_databases
Lecture seule

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.

Autorisation
gameserver.database.read
Accordée lors de la connexion
Lire la configuration

Paramètres

  • serviceIdstringobligatoire

    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
Modifie des donnéesConfirmation requise

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.

Autorisation
gameserver.database.write
Accordée lors de la connexion
Modifier la configuration

Paramètres

  • serviceIdstringobligatoire

    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.

  • namestringfacultatif

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

    max length 40

  • confirmbooleanfacultatif

Delete Game Server Database

delete_gameserver_database
DestructifConfirmation requise

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.

Autorisation
gameserver.database.write
Accordée lors de la connexion
Modifier la configuration

Paramètres

  • serviceIdstringobligatoire

    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.

  • databaseIdstringobligatoire
  • confirmationNamestringobligatoire

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

  • confirmbooleanfacultatif

Get Game Server External Access

get_gameserver_external_access
Lecture seule

Read gameserver external access details.

Autorisation
gameserver.external-access.manage
Accordée lors de la connexion
Accès complet

Paramètres

  • serviceIdstringobligatoire

    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
Modifie des donnéesConfirmation requise

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

Autorisation
gameserver.external-access.manage
Accordée lors de la connexion
Accès complet

Paramètres

  • serviceIdstringobligatoire

    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.

  • confirmbooleanfacultatif

Rotate Game Server External Access Credentials

rotate_gameserver_external_access
DestructifConfirmation requise

Rotate gameserver external access credentials. Requires confirm=true.

Autorisation
gameserver.external-access.manage
Accordée lors de la connexion
Accès complet

Paramètres

  • serviceIdstringobligatoire

    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.

  • confirmbooleanfacultatif

Show Game Server External Access Credentials

reveal_gameserver_external_access
DestructifConfirmation requise

Reveal gameserver external access credentials. Requires confirm=true.

Autorisation
gameserver.external-access.manage
Accordée lors de la connexion
Accès complet

Paramètres

  • serviceIdstringobligatoire

    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.

  • confirmbooleanfacultatif

Reinstall Game Server

reinstall_gameserver
DestructifConfirmation requise

Reinstall a gameserver. Requires confirm=true.

Autorisation
gameserver.reinstall
Accordée lors de la connexion
Accès complet

Paramètres

  • serviceIdstringobligatoire

    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.

  • confirmbooleanfacultatif

Change Game Server Game Version

update_gameserver_version
DestructifConfirmation requise

Update gameserver game version. Requires confirm=true.

Autorisation
gameserver.lifecycle.manage
Accordée lors de la connexion
Modifier la configuration

Paramètres

  • serviceIdstringobligatoire

    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.

  • targetVersionstringfacultatif
  • targetModpackVersionstringfacultatif
  • confirmbooleanfacultatif

Change Game Server Variant

update_gameserver_variant
DestructifConfirmation requise

Change gameserver variant. Requires confirm=true.

Autorisation
gameserver.lifecycle.manage
Accordée lors de la connexion
Modifier la configuration

Paramètres

  • serviceIdstringobligatoire

    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.

  • variantIdstringobligatoire
  • confirmbooleanfacultatif

List Game Server Save Games

list_gameserver_savegames
Lecture seule

List gameserver savegames.

Autorisation
gameserver.savegames.read
Accordée lors de la connexion
Lire la configuration

Paramètres

  • serviceIdstringobligatoire

    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.

  • pageintegerfacultatif

    > 0 · max 9007199254740991

  • limitintegerfacultatif

    > 0 · max 100

Delete Game Server Save Game

delete_gameserver_savegame
DestructifConfirmation requise

Delete a gameserver savegame. Requires confirm=true.

Autorisation
gameserver.savegames.write
Accordée lors de la connexion
Modifier la configuration

Paramètres

  • serviceIdstringobligatoire

    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.

  • pathstringobligatoire
  • confirmbooleanfacultatif

List Game Server Mods

list_gameserver_mods
Lecture seule

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.

Autorisation
gameserver.view
Accordée lors de la connexion
Consulter les services

Paramètres

  • serviceIdstringobligatoire

    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.

  • querystringfacultatif
  • providerstringfacultatif
  • installedOnlybooleanfacultatif
  • offsetintegerfacultatif

    min 0 · max 9007199254740991

  • limitintegerfacultatif

    > 0 · max 48

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

DestructifConfirmation requise

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.

Autorisation
gameserver.mods.manage
Accordée lors de la connexion
Modifier la configuration

Paramètres

  • serviceIdstringobligatoire

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

  • projectIdstringobligatoire

    max length 200

  • versionIdstringfacultatif

    max length 200

  • titlestringfacultatif

    max length 200

  • resolveDependenciesbooleanfacultatif
  • confirmbooleanfacultatif

Remove Game Server Mod

uninstall_gameserver_mod
DestructifConfirmation requise

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.

Autorisation
gameserver.mods.manage
Accordée lors de la connexion
Modifier la configuration

Paramètres

  • serviceIdstringobligatoire

    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.

  • installationIdstringobligatoire
  • confirmbooleanfacultatif

Check Game Server Mod and Plugin Updates

check_gameserver_addon_updates
Lecture seule

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.

Autorisation
gameserver.view
Accordée lors de la connexion
Consulter les services

Paramètres

  • serviceIdstringobligatoire

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

  • refreshbooleanfacultatif

List Game Server Plugins

list_gameserver_plugins
Lecture seule

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.

Autorisation
gameserver.view
Accordée lors de la connexion
Consulter les services

Paramètres

  • serviceIdstringobligatoire

    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.

  • querystringfacultatif

    max length 200

  • provider"all" | "modrinth" | "hangar"facultatif

  • installedOnlybooleanfacultatif
  • offsetintegerfacultatif

    min 0 · max 9007199254740991

  • limitintegerfacultatif

    min 1 · max 48

  • sortstringfacultatif

    max length 40

Install or Update Game Server Plugin

install_gameserver_plugin
DestructifConfirmation requise

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.

Autorisation
gameserver.plugins.manage
Accordée lors de la connexion
Modifier la configuration

Paramètres

  • serviceIdstringobligatoire

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

  • projectIdstringobligatoire

    max length 200

  • versionIdstringfacultatif

    max length 200

  • titlestringfacultatif

    max length 200

  • resolveDependenciesbooleanfacultatif
  • confirmbooleanfacultatif

Remove Game Server Plugin

uninstall_gameserver_plugin
DestructifConfirmation requise

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.

Autorisation
gameserver.plugins.manage
Accordée lors de la connexion
Modifier la configuration

Paramètres

  • serviceIdstringobligatoire

    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.

  • installationIdstringobligatoire
  • confirmbooleanfacultatif

Get Rust Plugin Framework

get_gameserver_rust_framework
Lecture seule

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.

Autorisation
gameserver.view
Accordée lors de la connexion
Consulter les services

Paramètres

  • serviceIdstringobligatoire

    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
DestructifConfirmation requise

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.

Autorisation
gameserver.plugins.manage
Accordée lors de la connexion
Modifier la configuration

Paramètres

  • serviceIdstringobligatoire

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

  • confirmbooleanfacultatif

List Minecraft Modpacks

list_gameserver_modpacks
Lecture seule

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.

Autorisation
gameserver.view
Accordée lors de la connexion
Consulter les services

Paramètres

  • serviceIdstringobligatoire

    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.

  • searchstringfacultatif

    max length 200

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

  • offsetintegerfacultatif

    min 0 · max 100000

  • limitintegerfacultatif

    min 1 · max 100

  • modpackIdstringfacultatif

Install Minecraft Modpack

install_gameserver_modpack
DestructifConfirmation requise

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.

Autorisation
gameserver.lifecycle.manage
Accordée lors de la connexion
Modifier la configuration

Paramètres

  • serviceIdstringobligatoire

    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.

  • modpackIdstringobligatoire
  • versionIdstringobligatoire
  • confirmbooleanfacultatif

Get Game Server Steam Workshop

get_gameserver_workshop
Lecture seule

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.

Autorisation
gameserver.view
Accordée lors de la connexion
Consulter les services

Paramètres

  • serviceIdstringobligatoire

    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
DestructifConfirmation requise

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.

Autorisation
gameserver.mods.manage
Accordée lors de la connexion
Modifier la configuration

Paramètres

  • serviceIdstringobligatoire

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

    max items 500

  • addItemIdsstring[]facultatif

    max items 200

  • removeItemIdsstring[]facultatif

    max items 500

  • collectionIdstringfacultatif

    pattern ^\d{1,20}$

  • disabledItemIdsstring[]facultatif

    max items 500

  • confirmbooleanfacultatif

VPS

Démarrage et arrêt, configuration, métriques, trafic, DNS, pare-feu, clés SSH, protection DDoS, tâches planifiées, mode rescue et réinstallation.

List VPS

list_vservers
Lecture seulePoint de départ

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

Autorisation
vserver.view
Accordée lors de la connexion
Consulter les services

Paramètres

Aucun paramètre

Get VPS

get_vserver
Lecture seulePoint de départ

Get one VPS by ID.

Autorisation
vserver.view
Accordée lors de la connexion
Consulter les services

Paramètres

  • serviceIdstringobligatoire

    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
Lecture seule

Read VPS configuration.

Autorisation
vserver.config.read
Accordée lors de la connexion
Lire la configuration

Paramètres

  • serviceIdstringobligatoire

    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
DestructifConfirmation requise

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

Autorisation
vserver.config.writevserver.access.manage
Accordée lors de la connexion
Modifier la configuration

Paramètres

  • serviceIdstringobligatoire

    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.

  • hostnamestringfacultatif
  • dnsServerstringfacultatif
  • ballooningDisabledbooleanfacultatif
  • sshPasswordEnabledbooleanfacultatif
  • confirmbooleanfacultatif

Get VPS Activity

get_vserver_activity
Lecture seule

Read paginated VPS activity log entries.

Autorisation
vserver.activity.read
Accordée lors de la connexion
Consulter les services

Paramètres

  • serviceIdstringobligatoire

    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.

  • limitintegerfacultatif

    min 1 · max 100

  • offsetintegerfacultatif

    min 0 · max 9007199254740991

Get VPS Traffic

get_vserver_traffic
Lecture seule

Read paginated VPS network traffic history.

Autorisation
vserver.traffic.read
Accordée lors de la connexion
Consulter les services

Paramètres

  • serviceIdstringobligatoire

    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.

  • limitintegerfacultatif

    min 1 · max 100

  • offsetintegerfacultatif

    min 0 · max 9007199254740991

Get VPS DDoS Status

get_vserver_ddos_status
Lecture seule

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.

Autorisation
vserver.ddos.read
Accordée lors de la connexion
Consulter les services

Paramètres

  • serviceIdstringobligatoire

    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.

  • ipAddressstringfacultatif

List VPS DDoS Rules

list_vserver_ddos_rules
Lecture seule

List the DDoS filter rules learned for a VPS IP.

Autorisation
vserver.ddos.read
Accordée lors de la connexion
Consulter les services

Paramètres

  • serviceIdstringobligatoire

    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.

  • ipAddressstringfacultatif

List VPS DDoS Incidents

list_vserver_ddos_incidents
Lecture seule

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

Autorisation
vserver.ddos.read
Accordée lors de la connexion
Consulter les services

Paramètres

  • serviceIdstringobligatoire

    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.

  • ipAddressstringfacultatif
  • pageintegerfacultatif

    > 0 · max 9007199254740991

  • pageSizeintegerfacultatif

    > 0 · max 100

Get VPS DDoS Bandwidth

get_vserver_ddos_bandwidth
Lecture seule

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

Autorisation
vserver.ddos.read
Accordée lors de la connexion
Consulter les services

Paramètres

  • serviceIdstringobligatoire

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

  • ipAddressstringfacultatif

List Outgoing DDoS Attacks from VPS

list_vserver_outgoing_ddos
Lecture seule

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

Autorisation
vserver.ddos.read
Accordée lors de la connexion
Consulter les services

Paramètres

  • serviceIdstringobligatoire

    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
DestructifConfirmation requise

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

Autorisation
vserver.ddos.manage
Accordée lors de la connexion
Modifier la configuration

Paramètres

  • serviceIdstringobligatoire

    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.

  • ipAddressstringfacultatif
  • enabledbooleanfacultatif

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

  • confirmbooleanfacultatif

Get VPS DNS Settings

get_vserver_dns
Lecture seule

Read VPS DNS domains, subdomains, and favorite subdomain.

Autorisation
vserver.config.read
Accordée lors de la connexion
Lire la configuration

Paramètres

  • serviceIdstringobligatoire

    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
Lecture seule

List SSH keys stored on the authenticated account.

Autorisation
vserver.config.read
Accordée lors de la connexion
Lire la configuration

Paramètres

Aucun paramètre

Create VPS Subdomain

create_vserver_subdomain
Modifie des donnéesConfirmation requise

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

Autorisation
vserver.config.write
Accordée lors de la connexion
Modifier la configuration

Paramètres

  • serviceIdstringobligatoire

    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.

  • labelstringobligatoire

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

  • domainIdstringfacultatif

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

  • confirmbooleanfacultatif

Delete VPS Subdomain

delete_vserver_subdomain
DestructifConfirmation requise

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

Autorisation
vserver.config.write
Accordée lors de la connexion
Modifier la configuration

Paramètres

  • serviceIdstringobligatoire

    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.

  • subdomainIdstringobligatoire

    Subdomain id from get_vserver_dns.

  • confirmbooleanfacultatif

Set VPS Favorite Subdomain

set_vserver_favorite_subdomain
DestructifConfirmation requise

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

Autorisation
vserver.config.write
Accordée lors de la connexion
Modifier la configuration

Paramètres

  • serviceIdstringobligatoire

    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.

  • subdomainIdstringfacultatif

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

  • confirmbooleanfacultatif

Get VPS Reverse DNS

get_vserver_reverse_dns
Lecture seule

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

Autorisation
vserver.config.read
Accordée lors de la connexion
Lire la configuration

Paramètres

  • serviceIdstringobligatoire

    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
DestructifConfirmation requise

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

Autorisation
vserver.config.write
Accordée lors de la connexion
Modifier la configuration

Paramètres

  • serviceIdstringobligatoire

    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.

  • ipAddressIdstringfacultatif

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

  • ipv6PrefixAllocationIdstringfacultatif

    IPv6 entry from get_vserver_reverse_dns (`ipv6PrefixAllocationId`).

  • hostnamestringfacultatif

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

  • confirmbooleanfacultatif

Update VPS Firewall Options

update_vserver_firewall_options
DestructifConfirmation requise

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.

Autorisation
vserver.firewall.write
Accordée lors de la connexion
Modifier la configuration

Paramètres

  • serviceIdstringobligatoire

    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.

  • enablebooleanobligatoire

    Firewall on (true) or off (false).

  • policyIn"ACCEPT" | "DROP" | "REJECT"obligatoire

    Default policy for incoming traffic no rule matches.

  • policyOut"ACCEPT" | "DROP" | "REJECT"obligatoire

    Default policy for outgoing traffic no rule matches.

  • confirmbooleanfacultatif

Change VPS Firewall Rule

mutate_vserver_firewall_rule
DestructifConfirmation requise

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

Autorisation
vserver.firewall.write
Accordée lors de la connexion
Modifier la configuration

Paramètres

  • serviceIdstringobligatoire

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

  • posintegerfacultatif

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

    min 0 · max 9007199254740991

  • newPosintegerfacultatif

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

    add/update: traffic direction.

  • ruleAction"ACCEPT" | "DROP" | "REJECT"facultatif

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

  • enablebooleanfacultatif

    add/update: rule active (default true).

  • macrostringfacultatif

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

  • protostringfacultatif

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

  • sourcestringfacultatif

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

  • deststringfacultatif

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

  • sportstringfacultatif

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

  • dportstringfacultatif

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

  • commentstringfacultatif

    add/update: free text comment.

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

    add/update: log level (default nolog).

  • confirmbooleanfacultatif

Change VPS Firewall IP Set

mutate_vserver_firewall_ipset
DestructifConfirmation requise

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

Autorisation
vserver.firewall.write
Accordée lors de la connexion
Modifier la configuration

Paramètres

  • serviceIdstringobligatoire

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

  • namestringobligatoire

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

  • cidrstringfacultatif

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

  • commentstringfacultatif

    add_entry: free text comment.

  • confirmbooleanfacultatif

List VPS SSH Keys

list_vserver_ssh_keys
Lecture seule

List the account SSH keys installed on one VPS.

Autorisation
vserver.config.read
Accordée lors de la connexion
Lire la configuration

Paramètres

  • serviceIdstringobligatoire

    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
Modifie des donnéesConfirmation requise

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

Autorisation
vserver.access.manage
Accordée lors de la connexion
Accès complet

Paramètres

  • serviceIdstringobligatoire

    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.

  • sshKeyIdstringobligatoire

    Key id from list_vserver_account_ssh_keys.

  • confirmbooleanfacultatif

Remove SSH Key from VPS

remove_vserver_ssh_key
DestructifConfirmation requise

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

Autorisation
vserver.access.manage
Accordée lors de la connexion
Accès complet

Paramètres

  • serviceIdstringobligatoire

    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.

  • sshKeyIdstringobligatoire

    Key id from list_vserver_ssh_keys.

  • confirmbooleanfacultatif

Add Account SSH Key

create_vserver_account_ssh_key
Modifie des donnéesConfirmation requise

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

Autorisation
vserver.config.write
Accordée lors de la connexion
Modifier la configuration

Paramètres

  • namestringobligatoire
  • publicKeystringobligatoire

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

  • confirmbooleanfacultatif

Update Account SSH Key

update_vserver_account_ssh_key
DestructifConfirmation requise

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

Autorisation
vserver.access.manage
Accordée lors de la connexion
Accès complet

Paramètres

  • keyIdstringobligatoire

    Key id from list_vserver_account_ssh_keys.

  • namestringfacultatif
  • publicKeystringfacultatif

    Replaces the key on every VPS it is installed on.

  • confirmbooleanfacultatif

Delete Account SSH Key

delete_vserver_account_ssh_key
DestructifConfirmation requise

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

Autorisation
vserver.access.manage
Accordée lors de la connexion
Accès complet

Paramètres

  • keyIdstringobligatoire

    Key id from list_vserver_account_ssh_keys.

  • confirmbooleanfacultatif

List VPS ISO Images

list_vserver_isos
Lecture seule

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

Autorisation
vserver.reinstall
Accordée lors de la connexion
Accès complet

Paramètres

  • serviceIdstringobligatoire

    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
Modifie des donnéesConfirmation requise

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

Autorisation
vserver.reinstall
Accordée lors de la connexion
Accès complet

Paramètres

  • serviceIdstringobligatoire

    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.

  • isoIdstringfacultatif

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

  • volidstringfacultatif

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

  • applyHardwareProfilebooleanfacultatif

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

  • attachDriverDiscbooleanfacultatif

    Attach the VirtIO driver disc (Windows installs).

  • bootFromIsobooleanfacultatif

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

  • confirmbooleanfacultatif

Unmount ISO from VPS

unmount_vserver_iso
Modifie des donnéesConfirmation requise

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

Autorisation
vserver.reinstall
Accordée lors de la connexion
Accès complet

Paramètres

  • serviceIdstringobligatoire

    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.

  • confirmbooleanfacultatif

List Custom VPS ISOs

list_vserver_custom_isos
Lecture seule

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

Autorisation
vserver.reinstall
Accordée lors de la connexion
Accès complet

Paramètres

  • serviceIdstringobligatoire

    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
Modifie des donnéesConfirmation requise

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

Autorisation
vserver.reinstall
Accordée lors de la connexion
Accès complet

Paramètres

  • serviceIdstringobligatoire

    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.

  • displayNamestringobligatoire
  • sourceUrlstringobligatoire

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

  • filenamestringfacultatif
  • osProfile"linux" | "windows"facultatif

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

  • confirmbooleanfacultatif

Delete Custom VPS ISO

delete_vserver_custom_iso
DestructifConfirmation requise

Delete an own imported ISO. Requires confirm=true.

Autorisation
vserver.reinstall
Accordée lors de la connexion
Accès complet

Paramètres

  • serviceIdstringobligatoire

    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.

  • assetIdstringobligatoire

    Custom ISO id from list_vserver_custom_isos.

  • confirmbooleanfacultatif

Get VPS Metrics

get_vserver_metrics
Lecture seule

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.

Autorisation
vserver.metrics.read
Accordée lors de la connexion
Consulter les services

Paramètres

  • serviceIdstringobligatoire

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

Get VPS Firewall Rules

get_vserver_firewall
Lecture seule

Read the VPS firewall configuration.

Autorisation
vserver.firewall.read
Accordée lors de la connexion
Lire la configuration

Paramètres

  • serviceIdstringobligatoire

    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
Modifie des donnéesConfirmation requise

Start a VPS. Requires confirm=true.

Autorisation
vserver.power.start
Accordée lors de la connexion
Actions Power

Paramètres

  • serviceIdstringobligatoire

    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.

  • confirmbooleanfacultatif

Stop VPS

stop_vserver
DestructifConfirmation requise

Stop a VPS. Requires confirm=true.

Autorisation
vserver.power.stop
Accordée lors de la connexion
Actions Power

Paramètres

  • serviceIdstringobligatoire

    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.

  • confirmbooleanfacultatif

Restart VPS

restart_vserver
DestructifConfirmation requise

Restart a VPS. Requires confirm=true.

Autorisation
vserver.power.restart
Accordée lors de la connexion
Actions Power

Paramètres

  • serviceIdstringobligatoire

    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.

  • confirmbooleanfacultatif

List VPS Schedules

list_vserver_schedules
Lecture seule

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

Autorisation
vserver.view
Accordée lors de la connexion
Consulter les services

Paramètres

  • serviceIdstringobligatoire

    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
DestructifConfirmation requise

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.

Autorisation
vserver.power.restartvserver.power.startvserver.power.stopvserver.console.write
Accordée lors de la connexion
Actions Power

Paramètres

  • serviceIdstringobligatoire

    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.

  • namestringobligatoire
  • action"restart" | "start" | "stop" | "command"obligatoire

  • cronstringobligatoire
  • timezonestringfacultatif
  • commandstringfacultatif
  • isActivebooleanfacultatif
  • confirmbooleanfacultatif

Update VPS Schedule

update_vserver_schedule
DestructifConfirmation requise

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

Autorisation
vserver.power.restartvserver.power.startvserver.power.stopvserver.console.write
Accordée lors de la connexion
Actions Power

Paramètres

  • serviceIdstringobligatoire

    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.

  • scheduleIdstringobligatoire
  • namestringfacultatif
  • action"restart" | "start" | "stop" | "command"facultatif

  • cronstringfacultatif
  • timezonestringfacultatif
  • commandstringfacultatif
  • isActivebooleanfacultatif
  • confirmbooleanfacultatif

Delete VPS Schedule

delete_vserver_schedule
DestructifConfirmation requise

Delete a VPS schedule. Requires confirm=true.

Autorisation
vserver.power.restartvserver.power.startvserver.power.stopvserver.console.write
Accordée lors de la connexion
Actions Power

Paramètres

  • serviceIdstringobligatoire

    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.

  • scheduleIdstringobligatoire
  • confirmbooleanfacultatif

Enable VPS Rescue Mode

enable_vserver_rescue
DestructifConfirmation requise

Enable VPS rescue mode. Requires confirm=true.

Autorisation
vserver.reinstall
Accordée lors de la connexion
Accès complet

Paramètres

  • serviceIdstringobligatoire

    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.

  • confirmbooleanfacultatif

Disable VPS Rescue Mode

disable_vserver_rescue
DestructifConfirmation requise

Disable VPS rescue mode. Requires confirm=true.

Autorisation
vserver.reinstall
Accordée lors de la connexion
Accès complet

Paramètres

  • serviceIdstringobligatoire

    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.

  • confirmbooleanfacultatif

List VPS Reinstall Templates

list_vserver_reinstall_templates
Lecture seule

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

Autorisation
vserver.reinstall
Accordée lors de la connexion
Accès complet

Paramètres

Aucun paramètre

Reinstall VPS

reinstall_vserver
DestructifConfirmation requise

Reinstall a VPS. Requires confirm=true.

Autorisation
vserver.reinstall
Accordée lors de la connexion
Accès complet

Paramètres

  • serviceIdstringobligatoire

    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.

  • templateIdstringfacultatif
  • confirmbooleanfacultatif

Serveurs dédiés

État d’alimentation, matériel, métriques, trafic, installation, ISO personnalisées, DNS inverse, protection DDoS, gestion à distance et mode rescue.

List Dedicated Servers

list_dedicated_servers
Lecture seulePoint de départ

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

Autorisation
dedicated.view
Accordée lors de la connexion
Consulter les services

Paramètres

Aucun paramètre

Get Dedicated Server

get_dedicated_server
Lecture seulePoint de départ

Get one dedicated server by ID.

Autorisation
dedicated.view
Accordée lors de la connexion
Consulter les services

Paramètres

  • serviceIdstringobligatoire

    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
Lecture seule

Get dedicated server hardware power state.

Autorisation
dedicated.view
Accordée lors de la connexion
Consulter les services

Paramètres

  • serviceIdstringobligatoire

    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
Lecture seule

Get dedicated server hardware metrics for a timeframe.

Autorisation
dedicated.metrics.read
Accordée lors de la connexion
Consulter les services

Paramètres

  • serviceIdstringobligatoire

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

Get Dedicated Server Hardware

get_dedicated_hardware
Lecture seule

Get dedicated server hardware inventory.

Autorisation
dedicated.hardware.read
Accordée lors de la connexion
Consulter les services

Paramètres

  • serviceIdstringobligatoire

    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
Lecture seule

Get dedicated server traffic overview for a timeframe.

Autorisation
dedicated.traffic.read
Accordée lors de la connexion
Consulter les services

Paramètres

  • serviceIdstringobligatoire

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

Get Dedicated Server Traffic Quota

get_dedicated_traffic_quota
Lecture seule

Get dedicated server traffic quota snapshot.

Autorisation
dedicated.traffic.read
Accordée lors de la connexion
Consulter les services

Paramètres

  • serviceIdstringobligatoire

    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
Lecture seule

Get dedicated server traffic history entries.

Autorisation
dedicated.traffic.read
Accordée lors de la connexion
Consulter les services

Paramètres

  • serviceIdstringobligatoire

    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.

  • limitintegerfacultatif

    > 0 · max 9007199254740991

  • offsetintegerfacultatif

    min 0 · max 9007199254740991

Get Dedicated Server Activity

get_dedicated_activity
Lecture seule

Read recent dedicated server activity logs.

Autorisation
dedicated.activity.read
Accordée lors de la connexion
Consulter les services

Paramètres

  • serviceIdstringobligatoire

    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.

  • limitintegerfacultatif

    > 0 · max 9007199254740991

  • offsetintegerfacultatif

    min 0 · max 9007199254740991

Get Dedicated Server Installation

get_dedicated_installation
Lecture seule

Get dedicated server installation status.

Autorisation
dedicated.view
Accordée lors de la connexion
Consulter les services

Paramètres

  • serviceIdstringobligatoire

    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
Lecture seule

Get dedicated server installation progress and log.

Autorisation
dedicated.view
Accordée lors de la connexion
Consulter les services

Paramètres

  • serviceIdstringobligatoire

    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
Lecture seule

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

Autorisation
dedicated.installation.manage
Accordée lors de la connexion
Accès complet

Paramètres

  • serviceIdstringobligatoire

    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
Lecture seule

Read reverse DNS entries for a dedicated server.

Autorisation
dedicated.network.read
Accordée lors de la connexion
Consulter les services

Paramètres

  • serviceIdstringobligatoire

    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
Lecture seule

Get DDoS protection status for a dedicated server.

Autorisation
dedicated.ddos.read
Accordée lors de la connexion
Consulter les services

Paramètres

  • serviceIdstringobligatoire

    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.

  • ipAddressstringfacultatif

List Dedicated Server DDoS Rules

list_dedicated_ddos_rules
Lecture seule

List DDoS protection rules for a dedicated server.

Autorisation
dedicated.ddos.read
Accordée lors de la connexion
Consulter les services

Paramètres

  • serviceIdstringobligatoire

    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.

  • ipAddressstringfacultatif

List Dedicated Server DDoS Incidents

list_dedicated_ddos_incidents
Lecture seule

List DDoS incidents for a dedicated server.

Autorisation
dedicated.ddos.read
Accordée lors de la connexion
Consulter les services

Paramètres

  • serviceIdstringobligatoire

    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.

  • ipAddressstringfacultatif
  • pageintegerfacultatif

    > 0 · max 9007199254740991

  • pageSizeintegerfacultatif

    > 0 · max 100

Get Dedicated Server DDoS Bandwidth

get_dedicated_ddos_bandwidth
Lecture seule

Get DDoS bandwidth statistics for a dedicated server.

Autorisation
dedicated.ddos.read
Accordée lors de la connexion
Consulter les services

Paramètres

  • serviceIdstringobligatoire

    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.

  • rangestringfacultatif
  • ipAddressstringfacultatif

Get Dedicated Server Remote Management

get_dedicated_remote_management
Lecture seule

Get dedicated server remote management session state.

Autorisation
dedicated.remote_management.manage
Accordée lors de la connexion
Accès complet

Paramètres

  • serviceIdstringobligatoire

    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
Lecture seule

List custom ISO assets available for a dedicated server.

Autorisation
dedicated.installation.manage
Accordée lors de la connexion
Accès complet

Paramètres

  • serviceIdstringobligatoire

    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
Lecture seule

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

Autorisation
dedicated.reinstall
Accordée lors de la connexion
Accès complet

Paramètres

Aucun paramètre

Start Dedicated Server

start_dedicated_server
Modifie des donnéesConfirmation requise

Start a dedicated server. Requires confirm=true.

Autorisation
dedicated.power.start
Accordée lors de la connexion
Actions Power

Paramètres

  • serviceIdstringobligatoire

    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.

  • confirmbooleanfacultatif

Stop Dedicated Server

stop_dedicated_server
DestructifConfirmation requise

Stop a dedicated server. Requires confirm=true.

Autorisation
dedicated.power.stop
Accordée lors de la connexion
Actions Power

Paramètres

  • serviceIdstringobligatoire

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

  • confirmbooleanfacultatif

Restart Dedicated Server

restart_dedicated_server
DestructifConfirmation requise

Restart a dedicated server. Requires confirm=true.

Autorisation
dedicated.power.restart
Accordée lors de la connexion
Actions Power

Paramètres

  • serviceIdstringobligatoire

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

  • confirmbooleanfacultatif

Reinstall Dedicated Server

reinstall_dedicated_server
DestructifConfirmation requise

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.

Autorisation
dedicated.reinstall
Accordée lors de la connexion
Accès complet

Paramètres

  • serviceIdstringobligatoire

    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.

  • osTemplateIdstringfacultatif

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

  • confirmbooleanfacultatif

Wipe Dedicated Server

wipe_dedicated_server
DestructifConfirmation requise

Wipe a dedicated server. Requires confirm=true.

Autorisation
dedicated.reinstall
Accordée lors de la connexion
Accès complet

Paramètres

  • serviceIdstringobligatoire

    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.

  • confirmbooleanfacultatif

Update Dedicated Server Reverse DNS

update_dedicated_reverse_dns
DestructifConfirmation requise

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

Autorisation
dedicated.network.write
Accordée lors de la connexion
Modifier la configuration

Paramètres

  • serviceIdstringobligatoire

    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.

  • ipAddressIdstringfacultatif
  • ipv6PrefixAllocationIdstringfacultatif
  • hostnamestringfacultatif
  • confirmbooleanfacultatif

Refresh Dedicated Server Installation

refresh_dedicated_installation
Modifie des donnéesConfirmation requise

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

Autorisation
dedicated.installation.manage
Accordée lors de la connexion
Accès complet

Paramètres

  • serviceIdstringobligatoire

    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.

  • confirmbooleanfacultatif

Mount Dedicated Server Install Media

mount_dedicated_install_media
Modifie des donnéesConfirmation requise

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

Autorisation
dedicated.installation.manage
Accordée lors de la connexion
Accès complet

Paramètres

  • serviceIdstringobligatoire

    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.

  • templateIdstringobligatoire
  • confirmbooleanfacultatif

Unmount Dedicated Server Install Media

unmount_dedicated_install_media
Modifie des donnéesConfirmation requise

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

Autorisation
dedicated.installation.manage
Accordée lors de la connexion
Accès complet

Paramètres

  • serviceIdstringobligatoire

    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.

  • confirmbooleanfacultatif
Modifie des donnéesConfirmation requise

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

Autorisation
dedicated.installation.manage
Accordée lors de la connexion
Accès complet

Paramètres

  • serviceIdstringobligatoire

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

  • confirmbooleanfacultatif
DestructifConfirmation requise

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

Autorisation
dedicated.rescue.manage
Accordée lors de la connexion
Accès complet

Paramètres

  • serviceIdstringobligatoire

    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.

  • templateIdstringobligatoire
  • confirmbooleanfacultatif
DestructifConfirmation requise

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

Autorisation
dedicated.rescue.manage
Accordée lors de la connexion
Accès complet

Paramètres

  • serviceIdstringobligatoire

    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.

  • confirmbooleanfacultatif

Activate Dedicated Server Remote Management

activate_dedicated_remote_management
Modifie des donnéesConfirmation requise

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

Autorisation
dedicated.remote_management.manage
Accordée lors de la connexion
Accès complet

Paramètres

  • serviceIdstringobligatoire

    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.

  • durationHoursintegerfacultatif

    > 0 · max 9007199254740991

  • confirmbooleanfacultatif

Extend Dedicated Server Remote Management

extend_dedicated_remote_management
Modifie des donnéesConfirmation requise

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

Autorisation
dedicated.remote_management.manage
Accordée lors de la connexion
Accès complet

Paramètres

  • serviceIdstringobligatoire

    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.

  • confirmbooleanfacultatif

Revoke Dedicated Server Remote Management

revoke_dedicated_remote_management
DestructifConfirmation requise

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

Autorisation
dedicated.remote_management.manage
Accordée lors de la connexion
Accès complet

Paramètres

  • serviceIdstringobligatoire

    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.

  • confirmbooleanfacultatif

Launch Dedicated Server Remote Management

launch_dedicated_remote_management
DestructifConfirmation requise

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

Autorisation
dedicated.remote_management.manage
Accordée lors de la connexion
Accès complet

Paramètres

  • serviceIdstringobligatoire

    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.

  • confirmbooleanfacultatif

Turn Dedicated Server DDoS Protection On or Off

toggle_dedicated_ddos_protection
DestructifConfirmation requise

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

Autorisation
dedicated.ddos.manage
Accordée lors de la connexion
Modifier la configuration

Paramètres

  • serviceIdstringobligatoire

    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.

  • ipAddressstringfacultatif
  • enabledbooleanfacultatif

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

  • confirmbooleanfacultatif

Import Dedicated Server Custom ISO

import_dedicated_custom_iso
Modifie des donnéesConfirmation requise

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

Autorisation
dedicated.installation.manage
Accordée lors de la connexion
Accès complet

Paramètres

  • serviceIdstringobligatoire

    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.

  • displayNamestringobligatoire
  • sourceUrlstringobligatoire

    format uri

  • filenamestringfacultatif
  • confirmbooleanfacultatif

Delete Dedicated Server Custom ISO

delete_dedicated_custom_iso
DestructifConfirmation requise

Delete a custom ISO asset. Requires confirm=true.

Autorisation
dedicated.installation.manage
Accordée lors de la connexion
Accès complet

Paramètres

  • serviceIdstringobligatoire

    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.

  • assetIdstringobligatoire
  • confirmbooleanfacultatif

Mount Dedicated Server Custom ISO

mount_dedicated_custom_iso
Modifie des donnéesConfirmation requise

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

Autorisation
dedicated.installation.manage
Accordée lors de la connexion
Accès complet

Paramètres

  • serviceIdstringobligatoire

    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.

  • assetIdstringobligatoire
  • confirmbooleanfacultatif

Serveurs TeamSpeak

Statut, démarrage et arrêt, paramètres, clients, bannissements et clés de privilège.

List TeamSpeak Servers

list_teamspeak_servers
Lecture seulePoint de départ

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

Autorisation
teamspeak.view
Accordée lors de la connexion
Consulter les services

Paramètres

Aucun paramètre

Get TeamSpeak Server

get_teamspeak_server
Lecture seulePoint de départ

Get one TeamSpeak server by ID.

Autorisation
teamspeak.view
Accordée lors de la connexion
Consulter les services

Paramètres

  • serviceIdstringobligatoire

    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
Lecture seule

Read TeamSpeak server configuration.

Autorisation
teamspeak.config.read
Accordée lors de la connexion
Lire la configuration

Paramètres

  • serviceIdstringobligatoire

    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
DestructifConfirmation requise

Update TeamSpeak server configuration. Requires confirm=true.

Autorisation
teamspeak.config.manage
Accordée lors de la connexion
Modifier la configuration

Paramètres

  • serviceIdstringobligatoire

    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>obligatoire
  • confirmbooleanfacultatif

List TeamSpeak Privilege Keys

list_teamspeak_tokens
Lecture seule

List privilege tokens for a TeamSpeak server.

Autorisation
teamspeak.tokens.manage
Accordée lors de la connexion
Gestion de TeamSpeak

Paramètres

  • serviceIdstringobligatoire

    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
DestructifConfirmation requise

Create a TeamSpeak privilege token. Requires confirm=true.

Autorisation
teamspeak.tokens.manage
Accordée lors de la connexion
Gestion de TeamSpeak

Paramètres

  • serviceIdstringobligatoire

    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.

  • descriptionstringfacultatif

    max length 100

  • confirmbooleanfacultatif

Start TeamSpeak Server

start_teamspeak_server
Modifie des donnéesConfirmation requise

Start a TeamSpeak server. Requires confirm=true.

Autorisation
teamspeak.power.start
Accordée lors de la connexion
Actions Power

Paramètres

  • serviceIdstringobligatoire

    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.

  • confirmbooleanfacultatif

Stop TeamSpeak Server

stop_teamspeak_server
DestructifConfirmation requise

Stop a TeamSpeak server. Requires confirm=true.

Autorisation
teamspeak.power.stop
Accordée lors de la connexion
Actions Power

Paramètres

  • serviceIdstringobligatoire

    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.

  • confirmbooleanfacultatif

Restart TeamSpeak Server

restart_teamspeak_server
DestructifConfirmation requise

Restart a TeamSpeak server. Requires confirm=true.

Autorisation
teamspeak.power.restart
Accordée lors de la connexion
Actions Power

Paramètres

  • serviceIdstringobligatoire

    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.

  • confirmbooleanfacultatif

Get TeamSpeak Metrics

get_teamspeak_metrics
Lecture seule

Get TeamSpeak server metrics.

Autorisation
teamspeak.metrics.read
Accordée lors de la connexion
Consulter les services

Paramètres

  • serviceIdstringobligatoire

    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
Lecture seule

List connected TeamSpeak clients.

Autorisation
teamspeak.clients.manage
Accordée lors de la connexion
Gestion de TeamSpeak

Paramètres

  • serviceIdstringobligatoire

    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
Lecture seule

List TeamSpeak server bans.

Autorisation
teamspeak.bans.manage
Accordée lors de la connexion
Gestion de TeamSpeak

Paramètres

  • serviceIdstringobligatoire

    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
Modifie des donnéesConfirmation requise

Add a TeamSpeak ban. Requires confirm=true.

Autorisation
teamspeak.bans.manage
Accordée lors de la connexion
Gestion de TeamSpeak

Paramètres

  • serviceIdstringobligatoire

    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.

  • ipstringfacultatif
  • uidstringfacultatif
  • namestringfacultatif
  • timenumberfacultatif
  • reasonstringfacultatif
  • confirmbooleanfacultatif

Delete TeamSpeak Ban

delete_teamspeak_ban
DestructifConfirmation requise

Delete a TeamSpeak ban. Requires confirm=true.

Autorisation
teamspeak.bans.manage
Accordée lors de la connexion
Gestion de TeamSpeak

Paramètres

  • serviceIdstringobligatoire

    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.

  • banIdintegerobligatoire

    > 0 · max 9007199254740991

  • confirmbooleanfacultatif

Delete TeamSpeak Privilege Key

delete_teamspeak_token
DestructifConfirmation requise

Delete a TeamSpeak privilege token. Requires confirm=true.

Autorisation
teamspeak.tokens.manage
Accordée lors de la connexion
Gestion de TeamSpeak

Paramètres

  • serviceIdstringobligatoire

    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.

  • tokenstringobligatoire
  • confirmbooleanfacultatif

Bots Discord

Statut, console, démarrage et arrêt et l’activité de tes bots Discord.

List Discord Bots

list_discord_bots
Lecture seulePoint de départ

List Discord bots accessible with the current token.

Autorisation
discord_bot.view
Accordée lors de la connexion
Consulter les services

Paramètres

Aucun paramètre

Get Discord Bot

get_discord_bot
Lecture seulePoint de départ

Get Discord bot details.

Autorisation
discord_bot.view
Accordée lors de la connexion
Consulter les services

Paramètres

  • serviceIdstringobligatoire

    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
Lecture seule

Get Discord bot container and port reachability status.

Autorisation
discord_bot.view
Accordée lors de la connexion
Consulter les services

Paramètres

  • serviceIdstringobligatoire

    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
Lecture seule

Read recent Discord bot activity logs.

Autorisation
discord_bot.view
Accordée lors de la connexion
Consulter les services

Paramètres

  • serviceIdstringobligatoire

    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.

  • limitintegerfacultatif

    min 1 · max 100

  • offsetintegerfacultatif

    min 0 · max 9007199254740991

Start Discord Bot

start_discord_bot
Modifie des donnéesConfirmation requise

Start a Discord bot. Requires confirm=true.

Autorisation
discord_bot.start
Accordée lors de la connexion
Actions Power

Paramètres

  • serviceIdstringobligatoire

    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.

  • confirmbooleanfacultatif

Stop Discord Bot

stop_discord_bot
DestructifConfirmation requise

Stop a Discord bot. Requires confirm=true.

Autorisation
discord_bot.stop
Accordée lors de la connexion
Actions Power

Paramètres

  • serviceIdstringobligatoire

    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.

  • confirmbooleanfacultatif

Restart Discord Bot

restart_discord_bot
DestructifConfirmation requise

Restart a Discord bot. Requires confirm=true.

Autorisation
discord_bot.restart
Accordée lors de la connexion
Actions Power

Paramètres

  • serviceIdstringobligatoire

    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.

  • confirmbooleanfacultatif

Get Discord Bot Console Logs

get_discord_bot_console_logs
Lecture seule

Get recent Discord bot console log lines.

Autorisation
discord_bot.console.read
Accordée lors de la connexion
Console et journaux

Paramètres

  • serviceIdstringobligatoire

    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.

  • linesintegerfacultatif

    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
DestructifConfirmation requise

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

Autorisation
discord_bot.console.write
Accordée lors de la connexion
Console et journaux

Paramètres

  • serviceIdstringobligatoire

    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.

  • commandstringobligatoire

    max length 500

  • confirmbooleanfacultatif

Domaines

Domaines, enregistrements DNS, serveurs de noms, page de parking et renouvellement automatique.

List Domains

list_domains
Lecture seulePoint de départ

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.

Autorisation
domain.view
Accordée lors de la connexion
Consulter les services

Paramètres

Aucun paramètre

Get Domain

get_domain
Lecture seule

Get one domain by ID. Read-only.

Autorisation
domain.view
Accordée lors de la connexion
Consulter les services

Paramètres

  • domainIdstringobligatoire

    Domain id (from list_domains or list_account_services).

Get Domain DNS Records

get_domain_dns_records
Lecture seulePoint de départ

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.

Autorisation
domain.dns.read
Accordée lors de la connexion
Lire la configuration

Paramètres

  • domainIdstringobligatoire

    Domain id (from list_domains or list_account_services).

Create Domain DNS Record

create_domain_dns_record
Modifie des donnéesConfirmation requise

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.

Autorisation
domain.dns.write
Accordée lors de la connexion
Gestion des domaines

Paramètres

  • domainIdstringobligatoire

    Domain id (from list_domains or list_account_services).

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

    Record type.

  • namestringfacultatif

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

    max length 253

  • contentstringobligatoire

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

    max length 4096

  • ttlintegerfacultatif

    TTL in seconds (default 3600, min 60).

    min 60 · max 9007199254740991

  • priorityintegerfacultatif

    MX/SRV priority.

    min 0 · max 65535

  • weightintegerfacultatif

    SRV weight.

    min 0 · max 65535

  • portintegerfacultatif

    SRV port.

    min 0 · max 65535

  • confirmbooleanfacultatif

    Must be true to apply the change.

Update Domain DNS Record

update_domain_dns_record
DestructifConfirmation requise

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.

Autorisation
domain.dns.write
Accordée lors de la connexion
Gestion des domaines

Paramètres

  • domainIdstringobligatoire

    Domain id (from list_domains or list_account_services).

  • recordIdstringobligatoire

    Record id from get_domain_dns_records.

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

    Record type.

  • namestringfacultatif

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

    max length 253

  • contentstringobligatoire

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

    max length 4096

  • ttlintegerfacultatif

    TTL in seconds (default 3600, min 60).

    min 60 · max 9007199254740991

  • priorityintegerfacultatif

    MX/SRV priority.

    min 0 · max 65535

  • weightintegerfacultatif

    SRV weight.

    min 0 · max 65535

  • portintegerfacultatif

    SRV port.

    min 0 · max 65535

  • confirmbooleanfacultatif

    Must be true to apply the change.

Delete Domain DNS Record

delete_domain_dns_record
DestructifConfirmation requise

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.

Autorisation
domain.dns.write
Accordée lors de la connexion
Gestion des domaines

Paramètres

  • domainIdstringobligatoire

    Domain id (from list_domains or list_account_services).

  • recordIdstringobligatoire

    Record id from get_domain_dns_records.

  • confirmbooleanfacultatif

    Must be true to apply the change.

Set Domain Parking Page

set_domain_parking_page
DestructifConfirmation requise

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.

Autorisation
domain.dns.write
Accordée lors de la connexion
Gestion des domaines

Paramètres

  • domainIdstringobligatoire

    Domain id (from list_domains or list_account_services).

  • enabledbooleanobligatoire

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

  • confirmedReplaceRecordIdsstring[]facultatif

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

    max items 200

  • confirmbooleanfacultatif

    Must be true to apply the change.

Get Domain Nameservers

get_domain_nameservers
Lecture seule

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

Autorisation
domain.dns.read
Accordée lors de la connexion
Lire la configuration

Paramètres

  • domainIdstringobligatoire

    Domain id (from list_domains or list_account_services).

Set Domain Nameservers

set_domain_nameservers
DestructifConfirmation requise

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.

Autorisation
domain.nameservers.write
Accordée lors de la connexion
Gestion des domaines

Paramètres

  • domainIdstringobligatoire

    Domain id (from list_domains or list_account_services).

  • mode"managed" | "external"obligatoire

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

  • nameserversstring[]facultatif

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

    min items 2 · max items 13

  • confirmbooleanfacultatif

    Must be true to apply the change.

Get Domain Renewal Status

get_domain_renewal
Lecture seule

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

Autorisation
domain.view
Accordée lors de la connexion
Consulter les services

Paramètres

  • domainIdstringobligatoire

    Domain id (from list_domains or list_account_services).

Set Domain Auto-Renew

set_domain_auto_renew
DestructifConfirmation requise

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.

Autorisation
domain.renewal.manage
Accordée lors de la connexion
Gestion des domaines

Paramètres

  • domainIdstringobligatoire

    Domain id (from list_domains or list_account_services).

  • autoRenewbooleanobligatoire

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

  • confirmbooleanfacultatif

    Must be true to apply the change.

Fichiers

Lister, lire, écrire, renommer et supprimer les fichiers des serveurs de jeu et des bots Discord.

List Discord Bot Files

list_discord_bot_files
Lecture seulePoint de départ

List files in a Discord bot directory.

Autorisation
discord_bot.files.read
Accordée lors de la connexion
Lire la configuration

Paramètres

  • serviceIdstringobligatoire

    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.

  • pathstringfacultatif
  • includeFolderSizesbooleanfacultatif

Read Discord Bot File

read_discord_bot_file
Lecture seule

Read an editable text file from a Discord bot.

Autorisation
discord_bot.files.read
Accordée lors de la connexion
Lire la configuration

Paramètres

  • serviceIdstringobligatoire

    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.

  • pathstringobligatoire

Edit Discord Bot File

mutate_discord_bot_file
DestructifConfirmation requise

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

Autorisation
discord_bot.files.write
Accordée lors de la connexion
Modifier la configuration

Paramètres

  • serviceIdstringobligatoire

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

  • pathstringobligatoire
  • contentstringfacultatif
  • expectedRevisionstringfacultatif

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

  • newNamestringfacultatif
  • confirmbooleanfacultatif

List Game Server Files

list_gameserver_files
Lecture seulePoint de départ

List files in a gameserver directory.

Autorisation
gameserver.files.read
Accordée lors de la connexion
Lire la configuration

Paramètres

  • serviceIdstringobligatoire

    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.

  • pathstringfacultatif
  • scope"savegame" | "config" | "active"facultatif

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

  • includeFolderSizesbooleanfacultatif

Read Game Server File

read_gameserver_file
Lecture seule

Read text content of a gameserver file.

Autorisation
gameserver.files.read
Accordée lors de la connexion
Lire la configuration

Paramètres

  • serviceIdstringobligatoire

    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.

  • pathstringobligatoire
  • scope"savegame" | "config" | "active"facultatif

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

Edit Game Server File

mutate_gameserver_file
DestructifConfirmation requise

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.

Autorisation
gameserver.files.write
Accordée lors de la connexion
Modifier la configuration

Paramètres

  • serviceIdstringobligatoire

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

  • pathstringfacultatif

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

  • contentstringfacultatif
  • expectedRevisionstringfacultatif

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

  • newNamestringfacultatif
  • pathsstring[]facultatif

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

    min items 1 · max items 100

  • destinationstringfacultatif

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

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

  • confirmbooleanfacultatif

Apps en un clic (VPS et dédiés)

Catalogue d'apps (Pterodactyl, Nextcloud, n8n, ...), installation, démarrage/arrêt/redémarrage, journaux et désinstallation ; les serveurs de jeux dans Pterodactyl se créent dans son propre panel.

List VPS One-Click Apps

get_vserver_apps
Lecture seulePoint de départ

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.

Autorisation
vserver.apps.read
Accordée lors de la connexion
Lire la configuration

Paramètres

  • serviceIdstringobligatoire

    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.

  • livebooleanfacultatif

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

Search VPS App Catalog

list_vserver_app_catalog
Lecture seule

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

Autorisation
vserver.apps.read
Accordée lors de la connexion
Lire la configuration

Paramètres

  • serviceIdstringobligatoire

    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.

  • searchstringfacultatif

    Free text search over name, description and tags.

    max length 200

  • categorystringfacultatif

    max length 100

  • pageintegerfacultatif

    > 0 · max 9007199254740991

  • pageSizeintegerfacultatif

    > 0 · max 50

Get VPS App Catalog Entry

get_vserver_app_catalog_entry
Lecture seule

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

Autorisation
vserver.apps.read
Accordée lors de la connexion
Lire la configuration

Paramètres

  • serviceIdstringobligatoire

    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.

  • catalogTypestringobligatoire

    max length 128

Get VPS App Logs

get_vserver_app_logs
Lecture seule

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

Autorisation
vserver.apps.read
Accordée lors de la connexion
Lire la configuration

Paramètres

  • serviceIdstringobligatoire

    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.

  • installationIdstringobligatoire

    Installation id from get_vserver_apps / get_dedicated_apps.

    max length 64

  • linesintegerfacultatif

    min 50 · max 500

Install VPS One-Click App

install_vserver_app
Modifie des donnéesConfirmation requise

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.

Autorisation
vserver.apps.manage
Accordée lors de la connexion
Modifier la configuration

Paramètres

  • serviceIdstringobligatoire

    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.

  • catalogTypestringobligatoire

    Catalog type from the app catalog.

    max length 128

  • displayNamestringobligatoire

    min length 2 · max length 80

  • envValuesRecord<string, string>facultatif

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

  • customEnvsobject[]facultatif

    max items 50

  • confirmbooleanfacultatif
  • withoutHostnamebooleanfacultatif

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

DestructifConfirmation requise

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

Autorisation
vserver.apps.manage
Accordée lors de la connexion
Modifier la configuration

Paramètres

  • serviceIdstringobligatoire

    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.

  • installationIdstringobligatoire

    Installation id from get_vserver_apps / get_dedicated_apps.

    max length 64

  • action"start" | "stop" | "restart"obligatoire

  • confirmbooleanfacultatif

Uninstall VPS One-Click App

uninstall_vserver_app
DestructifConfirmation requise

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

Autorisation
vserver.apps.manage
Accordée lors de la connexion
Modifier la configuration

Paramètres

  • serviceIdstringobligatoire

    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.

  • installationIdstringobligatoire

    Installation id from get_vserver_apps / get_dedicated_apps.

    max length 64

  • deleteVolumesbooleanfacultatif

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

  • confirmbooleanfacultatif

Reinstall VPS One-Click App

reinstall_vserver_app
DestructifConfirmation requise

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

Autorisation
vserver.apps.manage
Accordée lors de la connexion
Modifier la configuration

Paramètres

  • serviceIdstringobligatoire

    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.

  • installationIdstringobligatoire

    Installation id from get_vserver_apps / get_dedicated_apps.

    max length 64

  • deleteVolumesbooleanfacultatif

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

  • confirmbooleanfacultatif
Lecture seulePoint de départ

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.

Autorisation
dedicated.apps.read
Accordée lors de la connexion
Lire la configuration

Paramètres

  • serviceIdstringobligatoire

    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.

  • livebooleanfacultatif

    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
Lecture seule

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.

Autorisation
dedicated.apps.read
Accordée lors de la connexion
Lire la configuration

Paramètres

  • serviceIdstringobligatoire

    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.

  • searchstringfacultatif

    Free text search over name, description and tags.

    max length 200

  • categorystringfacultatif

    max length 100

  • pageintegerfacultatif

    > 0 · max 9007199254740991

  • pageSizeintegerfacultatif

    > 0 · max 50

Get Dedicated Server App Catalog Entry

get_dedicated_app_catalog_entry
Lecture seule

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

Autorisation
dedicated.apps.read
Accordée lors de la connexion
Lire la configuration

Paramètres

  • serviceIdstringobligatoire

    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.

  • catalogTypestringobligatoire

    max length 128

Get Dedicated Server App Logs

get_dedicated_app_logs
Lecture seule

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

Autorisation
dedicated.apps.read
Accordée lors de la connexion
Lire la configuration

Paramètres

  • serviceIdstringobligatoire

    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.

  • installationIdstringobligatoire

    Installation id from get_vserver_apps / get_dedicated_apps.

    max length 64

  • linesintegerfacultatif

    min 50 · max 500

Modifie des donnéesConfirmation requise

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.

Autorisation
dedicated.apps.manage
Accordée lors de la connexion
Modifier la configuration

Paramètres

  • serviceIdstringobligatoire

    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.

  • catalogTypestringobligatoire

    Catalog type from the app catalog.

    max length 128

  • displayNamestringobligatoire

    min length 2 · max length 80

  • envValuesRecord<string, string>facultatif

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

  • customEnvsobject[]facultatif

    max items 50

  • confirmbooleanfacultatif
DestructifConfirmation requise

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

Autorisation
dedicated.apps.manage
Accordée lors de la connexion
Modifier la configuration

Paramètres

  • serviceIdstringobligatoire

    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.

  • installationIdstringobligatoire

    Installation id from get_vserver_apps / get_dedicated_apps.

    max length 64

  • action"start" | "stop" | "restart"obligatoire

  • confirmbooleanfacultatif
DestructifConfirmation requise

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

Autorisation
dedicated.apps.manage
Accordée lors de la connexion
Modifier la configuration

Paramètres

  • serviceIdstringobligatoire

    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.

  • installationIdstringobligatoire

    Installation id from get_vserver_apps / get_dedicated_apps.

    max length 64

  • deleteVolumesbooleanfacultatif

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

  • confirmbooleanfacultatif
DestructifConfirmation requise

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

Autorisation
dedicated.apps.manage
Accordée lors de la connexion
Modifier la configuration

Paramètres

  • serviceIdstringobligatoire

    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.

  • installationIdstringobligatoire

    Installation id from get_vserver_apps / get_dedicated_apps.

    max length 64

  • deleteVolumesbooleanfacultatif

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

  • confirmbooleanfacultatif

Sauvegardes et snapshots

Créer, restaurer et supprimer des sauvegardes et des snapshots.

List Game Server Backups

list_gameserver_backups
Lecture seulePoint de départ

List gameserver backups.

Autorisation
gameserver.backups.read
Accordée lors de la connexion
Lire la configuration

Paramètres

  • serviceIdstringobligatoire

    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
DestructifConfirmation requise

Create a gameserver backup. Requires confirm=true.

Autorisation
gameserver.backups.manage
Accordée lors de la connexion
Modifier la configuration

Paramètres

  • serviceIdstringobligatoire

    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.

  • namestringfacultatif

    max length 120

  • confirmbooleanfacultatif

Delete Game Server Backup

delete_gameserver_backup
DestructifConfirmation requise

Delete a gameserver backup. Requires confirm=true.

Autorisation
gameserver.backups.manage
Accordée lors de la connexion
Modifier la configuration

Paramètres

  • serviceIdstringobligatoire

    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.

  • backupIdstringobligatoire
  • confirmbooleanfacultatif

Restore Game Server Backup

restore_gameserver_backup
DestructifConfirmation requise

Restore a gameserver backup. Requires confirm=true.

Autorisation
gameserver.backups.manage
Accordée lors de la connexion
Modifier la configuration

Paramètres

  • serviceIdstringobligatoire

    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.

  • backupIdstringobligatoire
  • confirmbooleanfacultatif

List VPS Backups

list_vserver_backups
Lecture seulePoint de départ

List VPS backups.

Autorisation
vserver.backups.read
Accordée lors de la connexion
Lire la configuration

Paramètres

  • serviceIdstringobligatoire

    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
Lecture seule

List VPS VM snapshots.

Autorisation
vserver.backups.read
Accordée lors de la connexion
Lire la configuration

Paramètres

  • serviceIdstringobligatoire

    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
Modifie des donnéesConfirmation requise

Create a VPS VM snapshot. Requires confirm=true.

Autorisation
vserver.backups.manage
Accordée lors de la connexion
Modifier la configuration

Paramètres

  • serviceIdstringobligatoire

    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.

  • namestringobligatoire
  • descriptionstringfacultatif
  • includeRambooleanfacultatif
  • confirmbooleanfacultatif

Delete VPS Snapshot

delete_vserver_snapshot
DestructifConfirmation requise

Delete a VPS VM snapshot. Requires confirm=true.

Autorisation
vserver.backups.manage
Accordée lors de la connexion
Modifier la configuration

Paramètres

  • serviceIdstringobligatoire

    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.

  • namestringobligatoire
  • confirmbooleanfacultatif

Roll Back VPS to Snapshot

rollback_vserver_snapshot
DestructifConfirmation requise

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

Autorisation
vserver.backups.manage
Accordée lors de la connexion
Modifier la configuration

Paramètres

  • serviceIdstringobligatoire

    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.

  • namestringobligatoire
  • confirmbooleanfacultatif

Create VPS Backup

create_vserver_backup
Modifie des donnéesConfirmation requise

Create a VPS backup. Requires confirm=true.

Autorisation
vserver.backups.manage
Accordée lors de la connexion
Modifier la configuration

Paramètres

  • serviceIdstringobligatoire

    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.

  • notesstringfacultatif

    max length 500

  • confirmbooleanfacultatif

Delete VPS Backup

delete_vserver_backup
DestructifConfirmation requise

Delete a VPS backup. Requires confirm=true.

Autorisation
vserver.backups.manage
Accordée lors de la connexion
Modifier la configuration

Paramètres

  • serviceIdstringobligatoire

    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.

  • backupIdstringobligatoire
  • confirmbooleanfacultatif

Restore VPS Backup

restore_vserver_backup
DestructifConfirmation requise

Restore a VPS backup. Requires confirm=true.

Autorisation
vserver.backups.manage
Accordée lors de la connexion
Modifier la configuration

Paramètres

  • serviceIdstringobligatoire

    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.

  • backupIdstringobligatoire
  • confirmbooleanfacultatif

Changements d’offre

Montées et descentes en gamme avec aperçu du prix, appliquées uniquement après ta confirmation explicite.

Get Game Server Plan Change Options

get_gameserver_plan_change_options
Lecture seulePoint de départAbsent des connecteurs ChatGPT et 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.

Les commandes et les changements d’offre sont masqués dans les connecteurs des annuaires d’apps de ChatGPT et Claude. L’outil est disponible dans Claude Code, Cursor et avec une clé API.

Autorisation
gameserver.plan_change
Accordée lors de la connexion
Modifications du forfait

Paramètres

  • serviceIdstringobligatoire

    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
Lecture seuleAbsent des connecteurs ChatGPT et 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.

Les commandes et les changements d’offre sont masqués dans les connecteurs des annuaires d’apps de ChatGPT et Claude. L’outil est disponible dans Claude Code, Cursor et avec une clé API.

Autorisation
gameserver.plan_change
Accordée lors de la connexion
Modifications du forfait

Paramètres

  • serviceIdstringobligatoire

    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.

  • targetobjectfacultatif
  • target.pricingMode"package" | "custom"facultatif

  • target.targetPackageKeystringfacultatif
  • target.ramMbintegerfacultatif

    > 0 · max 9007199254740991

  • target.cpuMillisintegerfacultatif

    > 0 · max 9007199254740991

  • target.diskMbintegerfacultatif

    > 0 · max 9007199254740991

  • target.slotsintegerfacultatif

    > 0 · max 9007199254740991

  • target.dedicatedIpbooleanfacultatif
  • target.premiumCpubooleanfacultatif

    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.targetRegionIdstringfacultatif
  • target.targetBillingIntervalCountintegerfacultatif

    > 0 · max 9007199254740991

  • couponCodestringfacultatif

    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
DestructifConfirmation requiseAbsent des connecteurs ChatGPT et 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.

Les commandes et les changements d’offre sont masqués dans les connecteurs des annuaires d’apps de ChatGPT et Claude. L’outil est disponible dans Claude Code, Cursor et avec une clé API.

Autorisation
gameserver.plan_change
Accordée lors de la connexion
Modifications du forfait

Paramètres

  • serviceIdstringobligatoire

    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.

  • targetobjectfacultatif
  • target.pricingMode"package" | "custom"facultatif

  • target.targetPackageKeystringfacultatif
  • target.ramMbintegerfacultatif

    > 0 · max 9007199254740991

  • target.cpuMillisintegerfacultatif

    > 0 · max 9007199254740991

  • target.diskMbintegerfacultatif

    > 0 · max 9007199254740991

  • target.slotsintegerfacultatif

    > 0 · max 9007199254740991

  • target.dedicatedIpbooleanfacultatif
  • target.premiumCpubooleanfacultatif

    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.targetRegionIdstringfacultatif
  • target.targetBillingIntervalCountintegerfacultatif

    > 0 · max 9007199254740991

  • couponCodestringfacultatif

    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

  • confirmtrueobligatoire
  • userExplicitlyConfirmedtrueobligatoire
  • previewConfirmationNoncestringobligatoire
  • requestImmediateStartbooleanfacultatif

    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
Lecture seule

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.

Autorisation
vserver.plan_change
Accordée lors de la connexion
Modifications du forfait

Paramètres

  • serviceIdstringobligatoire

    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
Lecture seule

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.

Autorisation
vserver.plan_change
Accordée lors de la connexion
Modifications du forfait

Paramètres

  • serviceIdstringobligatoire

    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.

  • targetobjectfacultatif
  • target.pricingMode"package" | "custom"facultatif

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

  • target.targetPackageKeystringfacultatif
  • target.coresintegerfacultatif

    > 0 · max 9007199254740991

  • target.memoryMbintegerfacultatif

    > 0 · max 9007199254740991

  • target.diskGbintegerfacultatif

    > 0 · max 9007199254740991

  • target.bandwidthMbpsintegerfacultatif

    > 0 · max 9007199254740991

  • target.memoryintegerfacultatif

    > 0 · max 9007199254740991

  • target.diskintegerfacultatif

    > 0 · max 9007199254740991

  • target.bandwidthintegerfacultatif

    > 0 · max 9007199254740991

  • target.additionalIpCountintegerfacultatif

    min 0 · max 9007199254740991

  • target.targetBillingIntervalCountintegerfacultatif

    > 0 · max 9007199254740991

  • couponCodestringfacultatif

    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
DestructifConfirmation requise

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.

Autorisation
vserver.plan_change
Accordée lors de la connexion
Modifications du forfait

Paramètres

  • serviceIdstringobligatoire

    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.

  • targetobjectfacultatif
  • target.pricingMode"package" | "custom"facultatif

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

  • target.targetPackageKeystringfacultatif
  • target.coresintegerfacultatif

    > 0 · max 9007199254740991

  • target.memoryMbintegerfacultatif

    > 0 · max 9007199254740991

  • target.diskGbintegerfacultatif

    > 0 · max 9007199254740991

  • target.bandwidthMbpsintegerfacultatif

    > 0 · max 9007199254740991

  • target.memoryintegerfacultatif

    > 0 · max 9007199254740991

  • target.diskintegerfacultatif

    > 0 · max 9007199254740991

  • target.bandwidthintegerfacultatif

    > 0 · max 9007199254740991

  • target.additionalIpCountintegerfacultatif

    min 0 · max 9007199254740991

  • target.targetBillingIntervalCountintegerfacultatif

    > 0 · max 9007199254740991

  • couponCodestringfacultatif

    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

  • confirmtrueobligatoire
  • userExplicitlyConfirmedtrueobligatoire
  • previewConfirmationNoncestringobligatoire
  • requestImmediateStartbooleanfacultatif

    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
Lecture seuleAbsent des connecteurs ChatGPT et 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.

Les commandes et les changements d’offre sont masqués dans les connecteurs des annuaires d’apps de ChatGPT et Claude. L’outil est disponible dans Claude Code, Cursor et avec une clé API.

Autorisation
teamspeak.plan_change
Accordée lors de la connexion
Modifications du forfait

Paramètres

  • serviceIdstringobligatoire

    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
Lecture seuleAbsent des connecteurs ChatGPT et 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.

Les commandes et les changements d’offre sont masqués dans les connecteurs des annuaires d’apps de ChatGPT et Claude. L’outil est disponible dans Claude Code, Cursor et avec une clé API.

Autorisation
teamspeak.plan_change
Accordée lors de la connexion
Modifications du forfait

Paramètres

  • serviceIdstringobligatoire

    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.

  • targetobjectfacultatif
  • target.pricingMode"package" | "custom"facultatif

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

  • target.targetPackageKeystringfacultatif
  • target.slotsintegerfacultatif

    > 0 · max 9007199254740991

  • target.hasAdvertisementbooleanfacultatif
  • target.targetBillingIntervalCountintegerfacultatif

    > 0 · max 9007199254740991

  • couponCodestringfacultatif

    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
DestructifConfirmation requiseAbsent des connecteurs ChatGPT et 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.

Les commandes et les changements d’offre sont masqués dans les connecteurs des annuaires d’apps de ChatGPT et Claude. L’outil est disponible dans Claude Code, Cursor et avec une clé API.

Autorisation
teamspeak.plan_change
Accordée lors de la connexion
Modifications du forfait

Paramètres

  • serviceIdstringobligatoire

    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.

  • targetobjectfacultatif
  • target.pricingMode"package" | "custom"facultatif

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

  • target.targetPackageKeystringfacultatif
  • target.slotsintegerfacultatif

    > 0 · max 9007199254740991

  • target.hasAdvertisementbooleanfacultatif
  • target.targetBillingIntervalCountintegerfacultatif

    > 0 · max 9007199254740991

  • couponCodestringfacultatif

    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

  • confirmtrueobligatoire
  • userExplicitlyConfirmedtrueobligatoire
  • previewConfirmationNoncestringobligatoire
  • requestImmediateStartbooleanfacultatif

    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
Lecture seuleAbsent des connecteurs ChatGPT et 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.

Les commandes et les changements d’offre sont masqués dans les connecteurs des annuaires d’apps de ChatGPT et Claude. L’outil est disponible dans Claude Code, Cursor et avec une clé API.

Autorisation
dedicated.plan_change
Accordée lors de la connexion
Modifications du forfait

Paramètres

  • serviceIdstringobligatoire

    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
Lecture seuleAbsent des connecteurs ChatGPT et 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.

Les commandes et les changements d’offre sont masqués dans les connecteurs des annuaires d’apps de ChatGPT et Claude. L’outil est disponible dans Claude Code, Cursor et avec une clé API.

Autorisation
dedicated.plan_change
Accordée lors de la connexion
Modifications du forfait

Paramètres

  • serviceIdstringobligatoire

    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.

  • targetobjectfacultatif
  • target.additionalIpCountintegerfacultatif

    min 0 · max 9007199254740991

  • target.releaseIpAssignmentIdsstring[]facultatif
  • couponCodestringfacultatif

    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
DestructifConfirmation requiseAbsent des connecteurs ChatGPT et 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.

Les commandes et les changements d’offre sont masqués dans les connecteurs des annuaires d’apps de ChatGPT et Claude. L’outil est disponible dans Claude Code, Cursor et avec une clé API.

Autorisation
dedicated.plan_change
Accordée lors de la connexion
Modifications du forfait

Paramètres

  • serviceIdstringobligatoire

    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.

  • targetobjectfacultatif
  • target.additionalIpCountintegerfacultatif

    min 0 · max 9007199254740991

  • target.releaseIpAssignmentIdsstring[]facultatif
  • couponCodestringfacultatif

    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

  • confirmtrueobligatoire
  • userExplicitlyConfirmedtrueobligatoire
  • previewConfirmationNoncestringobligatoire
  • requestImmediateStartbooleanfacultatif

    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
Lecture seulePoint de départ

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

Autorisation
gameserver.plan_changevserver.plan_changeteamspeak.plan_changededicated.plan_change
Accordée lors de la connexion
Modifications du forfait

Paramètres

  • changeIdstringobligatoire

Commandes

Produits, offres, régions, jeux et images ISO disponibles, ainsi que l’aperçu du prix d’une commande.

List Orderable Products

list_orderable_products
Lecture seulePoint de départAbsent des connecteurs ChatGPT et 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.

Les commandes et les changements d’offre sont masqués dans les connecteurs des annuaires d’apps de ChatGPT et Claude. L’outil est disponible dans Claude Code, Cursor et avec une clé API.

Autorisation
orders.view
Accordée lors de la connexion
Catalogue de commande et aperçu

Paramètres

Aucun paramètre

List Orderable Plans

list_orderable_plans
Lecture seuleAbsent des connecteurs ChatGPT et 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.

Les commandes et les changements d’offre sont masqués dans les connecteurs des annuaires d’apps de ChatGPT et Claude. L’outil est disponible dans Claude Code, Cursor et avec une clé API.

Autorisation
orders.view
Accordée lors de la connexion
Catalogue de commande et aperçu

Paramètres

  • productSlugstringobligatoire

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

List Regions for an Orderable Product

list_orderable_product_regions
Lecture seuleAbsent des connecteurs ChatGPT et 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.

Les commandes et les changements d’offre sont masqués dans les connecteurs des annuaires d’apps de ChatGPT et Claude. L’outil est disponible dans Claude Code, Cursor et avec une clé API.

Autorisation
orders.view
Accordée lors de la connexion
Catalogue de commande et aperçu

Paramètres

  • productSlugstringobligatoire

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

List Order Regions

list_order_regions
Lecture seuleAbsent des connecteurs ChatGPT et 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.

Les commandes et les changements d’offre sont masqués dans les connecteurs des annuaires d’apps de ChatGPT et Claude. L’outil est disponible dans Claude Code, Cursor et avec une clé API.

Autorisation
orders.view
Accordée lors de la connexion
Catalogue de commande et aperçu

Paramètres

Aucun paramètre

List Orderable Games

list_orderable_games
Lecture seuleAbsent des connecteurs ChatGPT et 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.

Les commandes et les changements d’offre sont masqués dans les connecteurs des annuaires d’apps de ChatGPT et Claude. L’outil est disponible dans Claude Code, Cursor et avec une clé API.

Autorisation
orders.view
Accordée lors de la connexion
Catalogue de commande et aperçu

Paramètres

Aucun paramètre

List ISO Images for VPS Orders

list_vserver_order_isos
Lecture seuleAbsent des connecteurs ChatGPT et 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.

Les commandes et les changements d’offre sont masqués dans les connecteurs des annuaires d’apps de ChatGPT et Claude. L’outil est disponible dans Claude Code, Cursor et avec une clé API.

Autorisation
orders.view
Accordée lors de la connexion
Catalogue de commande et aperçu

Paramètres

Aucun paramètre

Lecture seulePoint de départAbsent des connecteurs ChatGPT et 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.

Les commandes et les changements d’offre sont masqués dans les connecteurs des annuaires d’apps de ChatGPT et Claude. L’outil est disponible dans Claude Code, Cursor et avec une clé API.

Autorisation
orders.view
Accordée lors de la connexion
Catalogue de commande et aperçu

Paramètres

  • productSlugstringobligatoire

    Product slug from list_orderable_products.

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

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

  • planSlugstringfacultatif

    Plan slug from list_orderable_plans (products with fixed plans).

  • gameSlugstringfacultatif

    Game slug from list_orderable_games (gameservers).

  • regionSlugstringfacultatif

    Region slug from list_orderable_product_regions (products with region choice).

  • resourceConfigRecord<string, number>facultatif

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

  • optionsobjectfacultatif
  • options.couponCodestringfacultatif
  • options.dedicatedIpCountintegerfacultatif

    min 0 · max 9007199254740991

  • options.domainAttachmentobjectfacultatif
  • configurationRecord<string, any>facultatif

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

  • domainsobject[]facultatif

Get Order Status

get_order_status
Lecture seuleAbsent des connecteurs ChatGPT et 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.

Les commandes et les changements d’offre sont masqués dans les connecteurs des annuaires d’apps de ChatGPT et Claude. L’outil est disponible dans Claude Code, Cursor et avec une clé API.

Autorisation
orders.view
Accordée lors de la connexion
Catalogue de commande et aperçu

Paramètres

  • orderIdstringobligatoire

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

Place Paid Order

create_order
Modifie des donnéesConfirmation requiseAbsent des connecteurs ChatGPT et 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.

Les commandes et les changements d’offre sont masqués dans les connecteurs des annuaires d’apps de ChatGPT et Claude. L’outil est disponible dans Claude Code, Cursor et avec une clé API.

Autorisation
orders.create
Accordée lors de la connexion
Commander (payant)

Paramètres

  • confirmationCodestringobligatoire

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

  • confirmtrueobligatoire

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

  • userExplicitlyConfirmedbooleanobligatoire

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

  • requestImmediateStartbooleanfacultatif

    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.

Retours

Ton client IA nous signale directement les bugs ou fonctions manquantes des outils MCP.

Modifie des donnéesPoint de départ

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.

Autorisation
Toute connexion
Accordée lors de la connexion
Toute connexion

Paramètres

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

  • summarystringobligatoire

    One sentence: what went wrong or what is missing.

    min length 5 · max length 200

  • detailsstringfacultatif

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

    max length 4000

  • relatedToolstringfacultatif

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

    max length 100

  • exampleArgsRecord<string, any>facultatif

    Optional arguments of the failing call, without secrets.