Naar de inhoud springen

MCP

Alle MCP-tools

Elke tool die je AI-client via de ZapX MCP-server kan aanroepen, met parameters, benodigde rechten en gedrag. De lijst wordt rechtstreeks uit de server gegenereerd en is daardoor altijd actueel.

224 tools in 13 groepen · inbegrepen bij elke ZapX Pass

MCP instellenREST API-referentie
Endpointhttps://zap-hosting.com/api/mcpJSONMarkdown voor LLM's
Toolnamen, titels en beschrijvingen staan in het Engels, precies zoals je AI-client ze van de server krijgt. Tools met ‘Bevestiging nodig’ worden pas uitgevoerd met confirm: true. Je AI-client vraagt je eerst of hij de actie mag uitvoeren.

224 van 224 tools

Account

Alle diensten met ID en type, storingen en onderhoud, en de status van lopende acties.

List All Services

list_account_services
Alleen lezenStartpunt

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

Recht
Elke verbindingDe resultaten bevatten alleen services die de verbinding mag bekijken.
Toegekend bij verbinden
Elke verbinding

Parameters

Geen parameters

List Incidents

list_incidents
Alleen lezenStartpunt

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.

Recht
Elke verbindingDe resultaten bevatten alleen services die de verbinding mag bekijken.
Toegekend bij verbinden
Elke verbinding

Parameters

  • resolvedHoursintegeroptioneel

    min 0 · max 168

Get Operation Status

get_operation_status
Alleen lezen

Poll the status of an async public API operation.

Recht
Elke verbindingDe resultaten bevatten alleen services die de verbinding mag bekijken.
Toegekend bij verbinden
Elke verbinding

Parameters

  • operationIdstringverplicht

Gameservers

Status, console, starten en stoppen, instellingen, gameversie en variant, mods, savegames, SFTP-toegang en herinstallatie.

List Game Servers

list_gameservers
Alleen lezenStartpunt

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

Recht
gameserver.view
Toegekend bij verbinden
Services bekijken

Parameters

Geen parameters

Get Game Server

get_gameserver
Alleen lezenStartpunt

Get one gameserver by ID.

Recht
gameserver.view
Toegekend bij verbinden
Services bekijken

Parameters

  • serviceIdstringverplicht

    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
Alleen lezenStartpunt

Get live query status for a gameserver.

Recht
gameserver.view
Toegekend bij verbinden
Services bekijken

Parameters

  • serviceIdstringverplicht

    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
Alleen lezen

Read editable gameserver configuration fields.

Recht
gameserver.config.read
Toegekend bij verbinden
Configuratie lezen

Parameters

  • serviceIdstringverplicht

    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
DestructiefBevestiging nodig

Update editable gameserver configuration fields. Requires confirm=true.

Recht
gameserver.config.write
Toegekend bij verbinden
Configuratie wijzigen

Parameters

  • serviceIdstringverplicht

    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>verplicht
  • confirmbooleanoptioneel

Get Game Server Console Logs

get_gameserver_console_logs
Alleen lezen

Read a recent gameserver console log snapshot.

Recht
gameserver.console.read
Toegekend bij verbinden
Console en logs

Parameters

  • serviceIdstringverplicht

    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.

  • linesintegeroptioneel

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

    > 0 · max 200

Restart Game Server

restart_gameserver
DestructiefBevestiging nodig

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

Recht
gameserver.restart
Toegekend bij verbinden
Power-acties

Parameters

  • serviceIdstringverplicht

    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.

  • confirmbooleanoptioneel

Start Game Server

start_gameserver
Wijzigt gegevensBevestiging nodig

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

Recht
gameserver.start
Toegekend bij verbinden
Power-acties

Parameters

  • serviceIdstringverplicht

    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.

  • confirmbooleanoptioneel

Stop Game Server

stop_gameserver
DestructiefBevestiging nodig

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

Recht
gameserver.stop
Toegekend bij verbinden
Power-acties

Parameters

  • serviceIdstringverplicht

    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.

  • confirmbooleanoptioneel

Send Game Server Console Command

send_gameserver_console_command
DestructiefBevestiging nodig

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

Recht
gameserver.console.write
Toegekend bij verbinden
Console en logs

Parameters

  • serviceIdstringverplicht

    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.

  • commandstringverplicht

    max length 500

  • confirmbooleanoptioneel

Get Game Server Activity

get_gameserver_activity
Alleen lezen

Read recent gameserver activity logs.

Recht
gameserver.activity.read
Toegekend bij verbinden
Services bekijken

Parameters

  • serviceIdstringverplicht

    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.

  • limitintegeroptioneel

    > 0 · max 100

  • offsetintegeroptioneel

    min 0 · max 9007199254740991

Get Game Server Container Status

get_gameserver_container_status
Alleen lezen

Get gameserver container and port reachability status.

Recht
gameserver.view
Toegekend bij verbinden
Services bekijken

Parameters

  • serviceIdstringverplicht

    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
Alleen lezen

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.

Recht
gameserver.view
Toegekend bij verbinden
Services bekijken

Parameters

  • serviceIdstringverplicht

    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
Wijzigt gegevensBevestiging nodig

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.

Recht
gameserver.backups.managegameserver.restartgameserver.startgameserver.stopgameserver.console.writegameserver.wipe
Toegekend bij verbinden
Power-acties, Console en logs, Configuratie wijzigen

Parameters

  • serviceIdstringverplicht

    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.

  • namestringverplicht

    max length 120

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

  • cronstringverplicht

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

  • timezonestringoptioneel

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

  • commandstringoptioneel

    Console command, required for action=command.

    max length 2000

  • wipeobjectoptioneel

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

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

    Rust: map, blueprints or full.

  • wipe.backupFirstbooleanoptioneel

    Back up before wiping (default true).

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

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

  • wipe.worldSizeintegeroptioneel

    min 1000 · max 6000

  • isActivebooleanoptioneel
  • confirmbooleanoptioneel

Update Game Server Schedule

update_gameserver_schedule
DestructiefBevestiging nodig

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.

Recht
gameserver.backups.managegameserver.restartgameserver.startgameserver.stopgameserver.console.writegameserver.wipe
Toegekend bij verbinden
Power-acties, Console en logs, Configuratie wijzigen

Parameters

  • serviceIdstringverplicht

    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.

  • scheduleIdstringverplicht
  • namestringoptioneel

    max length 120

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

  • cronstringoptioneel

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

  • timezonestringoptioneel

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

  • commandstringoptioneel

    Console command, required for action=command.

    max length 2000

  • wipeobjectoptioneel

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

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

    Rust: map, blueprints or full.

  • wipe.backupFirstbooleanoptioneel

    Back up before wiping (default true).

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

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

  • wipe.worldSizeintegeroptioneel

    min 1000 · max 6000

  • isActivebooleanoptioneel
  • confirmbooleanoptioneel

Delete Game Server Schedule

delete_gameserver_schedule
DestructiefBevestiging nodig

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

Recht
gameserver.backups.managegameserver.restartgameserver.startgameserver.stopgameserver.console.writegameserver.wipe
Toegekend bij verbinden
Power-acties, Console en logs, Configuratie wijzigen

Parameters

  • serviceIdstringverplicht

    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.

  • scheduleIdstringverplicht
  • confirmbooleanoptioneel

Wipe Game Server

wipe_gameserver
DestructiefBevestiging nodig

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.

Recht
gameserver.wipe
Toegekend bij verbinden
Volledige toegang

Parameters

  • serviceIdstringverplicht

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

    Rust: map, blueprints or full.

  • backupFirstbooleanoptioneel

    Back up before wiping (default true).

  • seed"keep" | "random" | integeroptioneel

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

  • worldSizeintegeroptioneel

    min 1000 · max 6000

  • confirmbooleanoptioneel

List Game Server Databases

list_gameserver_databases
Alleen lezen

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.

Recht
gameserver.database.read
Toegekend bij verbinden
Configuratie lezen

Parameters

  • serviceIdstringverplicht

    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
Wijzigt gegevensBevestiging nodig

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.

Recht
gameserver.database.write
Toegekend bij verbinden
Configuratie wijzigen

Parameters

  • serviceIdstringverplicht

    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.

  • namestringoptioneel

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

    max length 40

  • confirmbooleanoptioneel

Delete Game Server Database

delete_gameserver_database
DestructiefBevestiging nodig

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.

Recht
gameserver.database.write
Toegekend bij verbinden
Configuratie wijzigen

Parameters

  • serviceIdstringverplicht

    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.

  • databaseIdstringverplicht
  • confirmationNamestringverplicht

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

  • confirmbooleanoptioneel

Get Game Server External Access

get_gameserver_external_access
Alleen lezen

Read gameserver external access details.

Recht
gameserver.external-access.manage
Toegekend bij verbinden
Volledige toegang

Parameters

  • serviceIdstringverplicht

    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
Wijzigt gegevensBevestiging nodig

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

Recht
gameserver.external-access.manage
Toegekend bij verbinden
Volledige toegang

Parameters

  • serviceIdstringverplicht

    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.

  • confirmbooleanoptioneel

Rotate Game Server External Access Credentials

rotate_gameserver_external_access
DestructiefBevestiging nodig

Rotate gameserver external access credentials. Requires confirm=true.

Recht
gameserver.external-access.manage
Toegekend bij verbinden
Volledige toegang

Parameters

  • serviceIdstringverplicht

    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.

  • confirmbooleanoptioneel

Show Game Server External Access Credentials

reveal_gameserver_external_access
DestructiefBevestiging nodig

Reveal gameserver external access credentials. Requires confirm=true.

Recht
gameserver.external-access.manage
Toegekend bij verbinden
Volledige toegang

Parameters

  • serviceIdstringverplicht

    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.

  • confirmbooleanoptioneel

Reinstall Game Server

reinstall_gameserver
DestructiefBevestiging nodig

Reinstall a gameserver. Requires confirm=true.

Recht
gameserver.reinstall
Toegekend bij verbinden
Volledige toegang

Parameters

  • serviceIdstringverplicht

    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.

  • confirmbooleanoptioneel

Change Game Server Game Version

update_gameserver_version
DestructiefBevestiging nodig

Update gameserver game version. Requires confirm=true.

Recht
gameserver.lifecycle.manage
Toegekend bij verbinden
Configuratie wijzigen

Parameters

  • serviceIdstringverplicht

    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.

  • targetVersionstringoptioneel
  • targetModpackVersionstringoptioneel
  • confirmbooleanoptioneel

Change Game Server Variant

update_gameserver_variant
DestructiefBevestiging nodig

Change gameserver variant. Requires confirm=true.

Recht
gameserver.lifecycle.manage
Toegekend bij verbinden
Configuratie wijzigen

Parameters

  • serviceIdstringverplicht

    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.

  • variantIdstringverplicht
  • confirmbooleanoptioneel

List Game Server Save Games

list_gameserver_savegames
Alleen lezen

List gameserver savegames.

Recht
gameserver.savegames.read
Toegekend bij verbinden
Configuratie lezen

Parameters

  • serviceIdstringverplicht

    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.

  • pageintegeroptioneel

    > 0 · max 9007199254740991

  • limitintegeroptioneel

    > 0 · max 100

Delete Game Server Save Game

delete_gameserver_savegame
DestructiefBevestiging nodig

Delete a gameserver savegame. Requires confirm=true.

Recht
gameserver.savegames.write
Toegekend bij verbinden
Configuratie wijzigen

Parameters

  • serviceIdstringverplicht

    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.

  • pathstringverplicht
  • confirmbooleanoptioneel

List Game Server Mods

list_gameserver_mods
Alleen lezen

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.

Recht
gameserver.view
Toegekend bij verbinden
Services bekijken

Parameters

  • serviceIdstringverplicht

    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.

  • querystringoptioneel
  • providerstringoptioneel
  • installedOnlybooleanoptioneel
  • offsetintegeroptioneel

    min 0 · max 9007199254740991

  • limitintegeroptioneel

    > 0 · max 48

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

Install or Update Game Server Mod

install_gameserver_mod
DestructiefBevestiging nodig

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.

Recht
gameserver.mods.manage
Toegekend bij verbinden
Configuratie wijzigen

Parameters

  • serviceIdstringverplicht

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

  • projectIdstringverplicht

    max length 200

  • versionIdstringoptioneel

    max length 200

  • titlestringoptioneel

    max length 200

  • resolveDependenciesbooleanoptioneel
  • confirmbooleanoptioneel

Remove Game Server Mod

uninstall_gameserver_mod
DestructiefBevestiging nodig

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.

Recht
gameserver.mods.manage
Toegekend bij verbinden
Configuratie wijzigen

Parameters

  • serviceIdstringverplicht

    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.

  • installationIdstringverplicht
  • confirmbooleanoptioneel

Check Game Server Mod and Plugin Updates

check_gameserver_addon_updates
Alleen lezen

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.

Recht
gameserver.view
Toegekend bij verbinden
Services bekijken

Parameters

  • serviceIdstringverplicht

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

  • refreshbooleanoptioneel

List Game Server Plugins

list_gameserver_plugins
Alleen lezen

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.

Recht
gameserver.view
Toegekend bij verbinden
Services bekijken

Parameters

  • serviceIdstringverplicht

    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.

  • querystringoptioneel

    max length 200

  • provider"all" | "modrinth" | "hangar"optioneel

  • installedOnlybooleanoptioneel
  • offsetintegeroptioneel

    min 0 · max 9007199254740991

  • limitintegeroptioneel

    min 1 · max 48

  • sortstringoptioneel

    max length 40

Install or Update Game Server Plugin

install_gameserver_plugin
DestructiefBevestiging nodig

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.

Recht
gameserver.plugins.manage
Toegekend bij verbinden
Configuratie wijzigen

Parameters

  • serviceIdstringverplicht

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

  • projectIdstringverplicht

    max length 200

  • versionIdstringoptioneel

    max length 200

  • titlestringoptioneel

    max length 200

  • resolveDependenciesbooleanoptioneel
  • confirmbooleanoptioneel

Remove Game Server Plugin

uninstall_gameserver_plugin
DestructiefBevestiging nodig

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.

Recht
gameserver.plugins.manage
Toegekend bij verbinden
Configuratie wijzigen

Parameters

  • serviceIdstringverplicht

    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.

  • installationIdstringverplicht
  • confirmbooleanoptioneel

Get Rust Plugin Framework

get_gameserver_rust_framework
Alleen lezen

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.

Recht
gameserver.view
Toegekend bij verbinden
Services bekijken

Parameters

  • serviceIdstringverplicht

    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
DestructiefBevestiging nodig

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.

Recht
gameserver.plugins.manage
Toegekend bij verbinden
Configuratie wijzigen

Parameters

  • serviceIdstringverplicht

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

  • confirmbooleanoptioneel

List Minecraft Modpacks

list_gameserver_modpacks
Alleen lezen

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.

Recht
gameserver.view
Toegekend bij verbinden
Services bekijken

Parameters

  • serviceIdstringverplicht

    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.

  • searchstringoptioneel

    max length 200

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

  • offsetintegeroptioneel

    min 0 · max 100000

  • limitintegeroptioneel

    min 1 · max 100

  • modpackIdstringoptioneel

Install Minecraft Modpack

install_gameserver_modpack
DestructiefBevestiging nodig

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.

Recht
gameserver.lifecycle.manage
Toegekend bij verbinden
Configuratie wijzigen

Parameters

  • serviceIdstringverplicht

    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.

  • modpackIdstringverplicht
  • versionIdstringverplicht
  • confirmbooleanoptioneel

Get Game Server Steam Workshop

get_gameserver_workshop
Alleen lezen

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.

Recht
gameserver.view
Toegekend bij verbinden
Services bekijken

Parameters

  • serviceIdstringverplicht

    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
DestructiefBevestiging nodig

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.

Recht
gameserver.mods.manage
Toegekend bij verbinden
Configuratie wijzigen

Parameters

  • serviceIdstringverplicht

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

    max items 500

  • addItemIdsstring[]optioneel

    max items 200

  • removeItemIdsstring[]optioneel

    max items 500

  • collectionIdstringoptioneel

    pattern ^\d{1,20}$

  • disabledItemIdsstring[]optioneel

    max items 500

  • confirmbooleanoptioneel

VPS

Starten en stoppen, configuratie, statistieken, verkeer, DNS, firewall, SSH-sleutels, DDoS-bescherming, planningen, rescue-modus en herinstallatie.

List VPS

list_vservers
Alleen lezenStartpunt

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

Recht
vserver.view
Toegekend bij verbinden
Services bekijken

Parameters

Geen parameters

Get VPS

get_vserver
Alleen lezenStartpunt

Get one VPS by ID.

Recht
vserver.view
Toegekend bij verbinden
Services bekijken

Parameters

  • serviceIdstringverplicht

    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
Alleen lezen

Read VPS configuration.

Recht
vserver.config.read
Toegekend bij verbinden
Configuratie lezen

Parameters

  • serviceIdstringverplicht

    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
DestructiefBevestiging nodig

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

Recht
vserver.config.writevserver.access.manage
Toegekend bij verbinden
Configuratie wijzigen

Parameters

  • serviceIdstringverplicht

    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.

  • hostnamestringoptioneel
  • dnsServerstringoptioneel
  • ballooningDisabledbooleanoptioneel
  • sshPasswordEnabledbooleanoptioneel
  • confirmbooleanoptioneel

Get VPS Activity

get_vserver_activity
Alleen lezen

Read paginated VPS activity log entries.

Recht
vserver.activity.read
Toegekend bij verbinden
Services bekijken

Parameters

  • serviceIdstringverplicht

    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.

  • limitintegeroptioneel

    min 1 · max 100

  • offsetintegeroptioneel

    min 0 · max 9007199254740991

Get VPS Traffic

get_vserver_traffic
Alleen lezen

Read paginated VPS network traffic history.

Recht
vserver.traffic.read
Toegekend bij verbinden
Services bekijken

Parameters

  • serviceIdstringverplicht

    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.

  • limitintegeroptioneel

    min 1 · max 100

  • offsetintegeroptioneel

    min 0 · max 9007199254740991

Get VPS DDoS Status

get_vserver_ddos_status
Alleen lezen

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.

Recht
vserver.ddos.read
Toegekend bij verbinden
Services bekijken

Parameters

  • serviceIdstringverplicht

    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.

  • ipAddressstringoptioneel

List VPS DDoS Rules

list_vserver_ddos_rules
Alleen lezen

List the DDoS filter rules learned for a VPS IP.

Recht
vserver.ddos.read
Toegekend bij verbinden
Services bekijken

Parameters

  • serviceIdstringverplicht

    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.

  • ipAddressstringoptioneel

List VPS DDoS Incidents

list_vserver_ddos_incidents
Alleen lezen

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

Recht
vserver.ddos.read
Toegekend bij verbinden
Services bekijken

Parameters

  • serviceIdstringverplicht

    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.

  • ipAddressstringoptioneel
  • pageintegeroptioneel

    > 0 · max 9007199254740991

  • pageSizeintegeroptioneel

    > 0 · max 100

Get VPS DDoS Bandwidth

get_vserver_ddos_bandwidth
Alleen lezen

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

Recht
vserver.ddos.read
Toegekend bij verbinden
Services bekijken

Parameters

  • serviceIdstringverplicht

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

  • ipAddressstringoptioneel

List Outgoing DDoS Attacks from VPS

list_vserver_outgoing_ddos
Alleen lezen

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

Recht
vserver.ddos.read
Toegekend bij verbinden
Services bekijken

Parameters

  • serviceIdstringverplicht

    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
DestructiefBevestiging nodig

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

Recht
vserver.ddos.manage
Toegekend bij verbinden
Configuratie wijzigen

Parameters

  • serviceIdstringverplicht

    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.

  • ipAddressstringoptioneel
  • enabledbooleanoptioneel

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

  • confirmbooleanoptioneel

Get VPS DNS Settings

get_vserver_dns
Alleen lezen

Read VPS DNS domains, subdomains, and favorite subdomain.

Recht
vserver.config.read
Toegekend bij verbinden
Configuratie lezen

Parameters

  • serviceIdstringverplicht

    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
Alleen lezen

List SSH keys stored on the authenticated account.

Recht
vserver.config.read
Toegekend bij verbinden
Configuratie lezen

Parameters

Geen parameters

Create VPS Subdomain

create_vserver_subdomain
Wijzigt gegevensBevestiging nodig

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

Recht
vserver.config.write
Toegekend bij verbinden
Configuratie wijzigen

Parameters

  • serviceIdstringverplicht

    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.

  • labelstringverplicht

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

  • domainIdstringoptioneel

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

  • confirmbooleanoptioneel

Delete VPS Subdomain

delete_vserver_subdomain
DestructiefBevestiging nodig

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

Recht
vserver.config.write
Toegekend bij verbinden
Configuratie wijzigen

Parameters

  • serviceIdstringverplicht

    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.

  • subdomainIdstringverplicht

    Subdomain id from get_vserver_dns.

  • confirmbooleanoptioneel

Set VPS Favorite Subdomain

set_vserver_favorite_subdomain
DestructiefBevestiging nodig

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

Recht
vserver.config.write
Toegekend bij verbinden
Configuratie wijzigen

Parameters

  • serviceIdstringverplicht

    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.

  • subdomainIdstringoptioneel

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

  • confirmbooleanoptioneel

Get VPS Reverse DNS

get_vserver_reverse_dns
Alleen lezen

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

Recht
vserver.config.read
Toegekend bij verbinden
Configuratie lezen

Parameters

  • serviceIdstringverplicht

    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
DestructiefBevestiging nodig

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

Recht
vserver.config.write
Toegekend bij verbinden
Configuratie wijzigen

Parameters

  • serviceIdstringverplicht

    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.

  • ipAddressIdstringoptioneel

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

  • ipv6PrefixAllocationIdstringoptioneel

    IPv6 entry from get_vserver_reverse_dns (`ipv6PrefixAllocationId`).

  • hostnamestringoptioneel

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

  • confirmbooleanoptioneel

Update VPS Firewall Options

update_vserver_firewall_options
DestructiefBevestiging nodig

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.

Recht
vserver.firewall.write
Toegekend bij verbinden
Configuratie wijzigen

Parameters

  • serviceIdstringverplicht

    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.

  • enablebooleanverplicht

    Firewall on (true) or off (false).

  • policyIn"ACCEPT" | "DROP" | "REJECT"verplicht

    Default policy for incoming traffic no rule matches.

  • policyOut"ACCEPT" | "DROP" | "REJECT"verplicht

    Default policy for outgoing traffic no rule matches.

  • confirmbooleanoptioneel

Change VPS Firewall Rule

mutate_vserver_firewall_rule
DestructiefBevestiging nodig

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

Recht
vserver.firewall.write
Toegekend bij verbinden
Configuratie wijzigen

Parameters

  • serviceIdstringverplicht

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

  • posintegeroptioneel

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

    min 0 · max 9007199254740991

  • newPosintegeroptioneel

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

    add/update: traffic direction.

  • ruleAction"ACCEPT" | "DROP" | "REJECT"optioneel

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

  • enablebooleanoptioneel

    add/update: rule active (default true).

  • macrostringoptioneel

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

  • protostringoptioneel

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

  • sourcestringoptioneel

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

  • deststringoptioneel

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

  • sportstringoptioneel

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

  • dportstringoptioneel

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

  • commentstringoptioneel

    add/update: free text comment.

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

    add/update: log level (default nolog).

  • confirmbooleanoptioneel

Change VPS Firewall IP Set

mutate_vserver_firewall_ipset
DestructiefBevestiging nodig

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

Recht
vserver.firewall.write
Toegekend bij verbinden
Configuratie wijzigen

Parameters

  • serviceIdstringverplicht

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

  • namestringverplicht

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

  • cidrstringoptioneel

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

  • commentstringoptioneel

    add_entry: free text comment.

  • confirmbooleanoptioneel

List VPS SSH Keys

list_vserver_ssh_keys
Alleen lezen

List the account SSH keys installed on one VPS.

Recht
vserver.config.read
Toegekend bij verbinden
Configuratie lezen

Parameters

  • serviceIdstringverplicht

    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
Wijzigt gegevensBevestiging nodig

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

Recht
vserver.access.manage
Toegekend bij verbinden
Volledige toegang

Parameters

  • serviceIdstringverplicht

    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.

  • sshKeyIdstringverplicht

    Key id from list_vserver_account_ssh_keys.

  • confirmbooleanoptioneel

Remove SSH Key from VPS

remove_vserver_ssh_key
DestructiefBevestiging nodig

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

Recht
vserver.access.manage
Toegekend bij verbinden
Volledige toegang

Parameters

  • serviceIdstringverplicht

    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.

  • sshKeyIdstringverplicht

    Key id from list_vserver_ssh_keys.

  • confirmbooleanoptioneel

Add Account SSH Key

create_vserver_account_ssh_key
Wijzigt gegevensBevestiging nodig

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

Recht
vserver.config.write
Toegekend bij verbinden
Configuratie wijzigen

Parameters

  • namestringverplicht
  • publicKeystringverplicht

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

  • confirmbooleanoptioneel

Update Account SSH Key

update_vserver_account_ssh_key
DestructiefBevestiging nodig

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

Recht
vserver.access.manage
Toegekend bij verbinden
Volledige toegang

Parameters

  • keyIdstringverplicht

    Key id from list_vserver_account_ssh_keys.

  • namestringoptioneel
  • publicKeystringoptioneel

    Replaces the key on every VPS it is installed on.

  • confirmbooleanoptioneel

Delete Account SSH Key

delete_vserver_account_ssh_key
DestructiefBevestiging nodig

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

Recht
vserver.access.manage
Toegekend bij verbinden
Volledige toegang

Parameters

  • keyIdstringverplicht

    Key id from list_vserver_account_ssh_keys.

  • confirmbooleanoptioneel

List VPS ISO Images

list_vserver_isos
Alleen lezen

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

Recht
vserver.reinstall
Toegekend bij verbinden
Volledige toegang

Parameters

  • serviceIdstringverplicht

    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
Wijzigt gegevensBevestiging nodig

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

Recht
vserver.reinstall
Toegekend bij verbinden
Volledige toegang

Parameters

  • serviceIdstringverplicht

    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.

  • isoIdstringoptioneel

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

  • volidstringoptioneel

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

  • applyHardwareProfilebooleanoptioneel

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

  • attachDriverDiscbooleanoptioneel

    Attach the VirtIO driver disc (Windows installs).

  • bootFromIsobooleanoptioneel

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

  • confirmbooleanoptioneel

Unmount ISO from VPS

unmount_vserver_iso
Wijzigt gegevensBevestiging nodig

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

Recht
vserver.reinstall
Toegekend bij verbinden
Volledige toegang

Parameters

  • serviceIdstringverplicht

    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.

  • confirmbooleanoptioneel

List Custom VPS ISOs

list_vserver_custom_isos
Alleen lezen

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

Recht
vserver.reinstall
Toegekend bij verbinden
Volledige toegang

Parameters

  • serviceIdstringverplicht

    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
Wijzigt gegevensBevestiging nodig

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

Recht
vserver.reinstall
Toegekend bij verbinden
Volledige toegang

Parameters

  • serviceIdstringverplicht

    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.

  • displayNamestringverplicht
  • sourceUrlstringverplicht

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

  • filenamestringoptioneel
  • osProfile"linux" | "windows"optioneel

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

  • confirmbooleanoptioneel

Delete Custom VPS ISO

delete_vserver_custom_iso
DestructiefBevestiging nodig

Delete an own imported ISO. Requires confirm=true.

Recht
vserver.reinstall
Toegekend bij verbinden
Volledige toegang

Parameters

  • serviceIdstringverplicht

    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.

  • assetIdstringverplicht

    Custom ISO id from list_vserver_custom_isos.

  • confirmbooleanoptioneel

Get VPS Metrics

get_vserver_metrics
Alleen lezen

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.

Recht
vserver.metrics.read
Toegekend bij verbinden
Services bekijken

Parameters

  • serviceIdstringverplicht

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

Get VPS Firewall Rules

get_vserver_firewall
Alleen lezen

Read the VPS firewall configuration.

Recht
vserver.firewall.read
Toegekend bij verbinden
Configuratie lezen

Parameters

  • serviceIdstringverplicht

    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
Wijzigt gegevensBevestiging nodig

Start a VPS. Requires confirm=true.

Recht
vserver.power.start
Toegekend bij verbinden
Power-acties

Parameters

  • serviceIdstringverplicht

    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.

  • confirmbooleanoptioneel

Stop VPS

stop_vserver
DestructiefBevestiging nodig

Stop a VPS. Requires confirm=true.

Recht
vserver.power.stop
Toegekend bij verbinden
Power-acties

Parameters

  • serviceIdstringverplicht

    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.

  • confirmbooleanoptioneel

Restart VPS

restart_vserver
DestructiefBevestiging nodig

Restart a VPS. Requires confirm=true.

Recht
vserver.power.restart
Toegekend bij verbinden
Power-acties

Parameters

  • serviceIdstringverplicht

    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.

  • confirmbooleanoptioneel

List VPS Schedules

list_vserver_schedules
Alleen lezen

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

Recht
vserver.view
Toegekend bij verbinden
Services bekijken

Parameters

  • serviceIdstringverplicht

    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
DestructiefBevestiging nodig

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.

Recht
vserver.power.restartvserver.power.startvserver.power.stopvserver.console.write
Toegekend bij verbinden
Power-acties

Parameters

  • serviceIdstringverplicht

    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.

  • namestringverplicht
  • action"restart" | "start" | "stop" | "command"verplicht

  • cronstringverplicht
  • timezonestringoptioneel
  • commandstringoptioneel
  • isActivebooleanoptioneel
  • confirmbooleanoptioneel

Update VPS Schedule

update_vserver_schedule
DestructiefBevestiging nodig

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

Recht
vserver.power.restartvserver.power.startvserver.power.stopvserver.console.write
Toegekend bij verbinden
Power-acties

Parameters

  • serviceIdstringverplicht

    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.

  • scheduleIdstringverplicht
  • namestringoptioneel
  • action"restart" | "start" | "stop" | "command"optioneel

  • cronstringoptioneel
  • timezonestringoptioneel
  • commandstringoptioneel
  • isActivebooleanoptioneel
  • confirmbooleanoptioneel

Delete VPS Schedule

delete_vserver_schedule
DestructiefBevestiging nodig

Delete a VPS schedule. Requires confirm=true.

Recht
vserver.power.restartvserver.power.startvserver.power.stopvserver.console.write
Toegekend bij verbinden
Power-acties

Parameters

  • serviceIdstringverplicht

    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.

  • scheduleIdstringverplicht
  • confirmbooleanoptioneel

Enable VPS Rescue Mode

enable_vserver_rescue
DestructiefBevestiging nodig

Enable VPS rescue mode. Requires confirm=true.

Recht
vserver.reinstall
Toegekend bij verbinden
Volledige toegang

Parameters

  • serviceIdstringverplicht

    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.

  • confirmbooleanoptioneel

Disable VPS Rescue Mode

disable_vserver_rescue
DestructiefBevestiging nodig

Disable VPS rescue mode. Requires confirm=true.

Recht
vserver.reinstall
Toegekend bij verbinden
Volledige toegang

Parameters

  • serviceIdstringverplicht

    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.

  • confirmbooleanoptioneel

List VPS Reinstall Templates

list_vserver_reinstall_templates
Alleen lezen

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

Recht
vserver.reinstall
Toegekend bij verbinden
Volledige toegang

Parameters

Geen parameters

Reinstall VPS

reinstall_vserver
DestructiefBevestiging nodig

Reinstall a VPS. Requires confirm=true.

Recht
vserver.reinstall
Toegekend bij verbinden
Volledige toegang

Parameters

  • serviceIdstringverplicht

    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.

  • templateIdstringoptioneel
  • confirmbooleanoptioneel

Dedicated servers

Stroomstatus, hardware, statistieken, verkeer, installatie, eigen ISO's, reverse DNS, DDoS-bescherming, beheer op afstand en rescue-modus.

List Dedicated Servers

list_dedicated_servers
Alleen lezenStartpunt

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

Recht
dedicated.view
Toegekend bij verbinden
Services bekijken

Parameters

Geen parameters

Get Dedicated Server

get_dedicated_server
Alleen lezenStartpunt

Get one dedicated server by ID.

Recht
dedicated.view
Toegekend bij verbinden
Services bekijken

Parameters

  • serviceIdstringverplicht

    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
Alleen lezen

Get dedicated server hardware power state.

Recht
dedicated.view
Toegekend bij verbinden
Services bekijken

Parameters

  • serviceIdstringverplicht

    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
Alleen lezen

Get dedicated server hardware metrics for a timeframe.

Recht
dedicated.metrics.read
Toegekend bij verbinden
Services bekijken

Parameters

  • serviceIdstringverplicht

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

Get Dedicated Server Hardware

get_dedicated_hardware
Alleen lezen

Get dedicated server hardware inventory.

Recht
dedicated.hardware.read
Toegekend bij verbinden
Services bekijken

Parameters

  • serviceIdstringverplicht

    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
Alleen lezen

Get dedicated server traffic overview for a timeframe.

Recht
dedicated.traffic.read
Toegekend bij verbinden
Services bekijken

Parameters

  • serviceIdstringverplicht

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

Get Dedicated Server Traffic Quota

get_dedicated_traffic_quota
Alleen lezen

Get dedicated server traffic quota snapshot.

Recht
dedicated.traffic.read
Toegekend bij verbinden
Services bekijken

Parameters

  • serviceIdstringverplicht

    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
Alleen lezen

Get dedicated server traffic history entries.

Recht
dedicated.traffic.read
Toegekend bij verbinden
Services bekijken

Parameters

  • serviceIdstringverplicht

    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.

  • limitintegeroptioneel

    > 0 · max 9007199254740991

  • offsetintegeroptioneel

    min 0 · max 9007199254740991

Get Dedicated Server Activity

get_dedicated_activity
Alleen lezen

Read recent dedicated server activity logs.

Recht
dedicated.activity.read
Toegekend bij verbinden
Services bekijken

Parameters

  • serviceIdstringverplicht

    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.

  • limitintegeroptioneel

    > 0 · max 9007199254740991

  • offsetintegeroptioneel

    min 0 · max 9007199254740991

Get Dedicated Server Installation

get_dedicated_installation
Alleen lezen

Get dedicated server installation status.

Recht
dedicated.view
Toegekend bij verbinden
Services bekijken

Parameters

  • serviceIdstringverplicht

    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
Alleen lezen

Get dedicated server installation progress and log.

Recht
dedicated.view
Toegekend bij verbinden
Services bekijken

Parameters

  • serviceIdstringverplicht

    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
Alleen lezen

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

Recht
dedicated.installation.manage
Toegekend bij verbinden
Volledige toegang

Parameters

  • serviceIdstringverplicht

    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
Alleen lezen

Read reverse DNS entries for a dedicated server.

Recht
dedicated.network.read
Toegekend bij verbinden
Services bekijken

Parameters

  • serviceIdstringverplicht

    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
Alleen lezen

Get DDoS protection status for a dedicated server.

Recht
dedicated.ddos.read
Toegekend bij verbinden
Services bekijken

Parameters

  • serviceIdstringverplicht

    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.

  • ipAddressstringoptioneel

List Dedicated Server DDoS Rules

list_dedicated_ddos_rules
Alleen lezen

List DDoS protection rules for a dedicated server.

Recht
dedicated.ddos.read
Toegekend bij verbinden
Services bekijken

Parameters

  • serviceIdstringverplicht

    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.

  • ipAddressstringoptioneel

List Dedicated Server DDoS Incidents

list_dedicated_ddos_incidents
Alleen lezen

List DDoS incidents for a dedicated server.

Recht
dedicated.ddos.read
Toegekend bij verbinden
Services bekijken

Parameters

  • serviceIdstringverplicht

    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.

  • ipAddressstringoptioneel
  • pageintegeroptioneel

    > 0 · max 9007199254740991

  • pageSizeintegeroptioneel

    > 0 · max 100

Get Dedicated Server DDoS Bandwidth

get_dedicated_ddos_bandwidth
Alleen lezen

Get DDoS bandwidth statistics for a dedicated server.

Recht
dedicated.ddos.read
Toegekend bij verbinden
Services bekijken

Parameters

  • serviceIdstringverplicht

    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.

  • rangestringoptioneel
  • ipAddressstringoptioneel

Get Dedicated Server Remote Management

get_dedicated_remote_management
Alleen lezen

Get dedicated server remote management session state.

Recht
dedicated.remote_management.manage
Toegekend bij verbinden
Volledige toegang

Parameters

  • serviceIdstringverplicht

    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
Alleen lezen

List custom ISO assets available for a dedicated server.

Recht
dedicated.installation.manage
Toegekend bij verbinden
Volledige toegang

Parameters

  • serviceIdstringverplicht

    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
Alleen lezen

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

Recht
dedicated.reinstall
Toegekend bij verbinden
Volledige toegang

Parameters

Geen parameters

Start Dedicated Server

start_dedicated_server
Wijzigt gegevensBevestiging nodig

Start a dedicated server. Requires confirm=true.

Recht
dedicated.power.start
Toegekend bij verbinden
Power-acties

Parameters

  • serviceIdstringverplicht

    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.

  • confirmbooleanoptioneel

Stop Dedicated Server

stop_dedicated_server
DestructiefBevestiging nodig

Stop a dedicated server. Requires confirm=true.

Recht
dedicated.power.stop
Toegekend bij verbinden
Power-acties

Parameters

  • serviceIdstringverplicht

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

  • confirmbooleanoptioneel

Restart Dedicated Server

restart_dedicated_server
DestructiefBevestiging nodig

Restart a dedicated server. Requires confirm=true.

Recht
dedicated.power.restart
Toegekend bij verbinden
Power-acties

Parameters

  • serviceIdstringverplicht

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

  • confirmbooleanoptioneel

Reinstall Dedicated Server

reinstall_dedicated_server
DestructiefBevestiging nodig

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.

Recht
dedicated.reinstall
Toegekend bij verbinden
Volledige toegang

Parameters

  • serviceIdstringverplicht

    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.

  • osTemplateIdstringoptioneel

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

  • confirmbooleanoptioneel

Wipe Dedicated Server

wipe_dedicated_server
DestructiefBevestiging nodig

Wipe a dedicated server. Requires confirm=true.

Recht
dedicated.reinstall
Toegekend bij verbinden
Volledige toegang

Parameters

  • serviceIdstringverplicht

    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.

  • confirmbooleanoptioneel

Update Dedicated Server Reverse DNS

update_dedicated_reverse_dns
DestructiefBevestiging nodig

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

Recht
dedicated.network.write
Toegekend bij verbinden
Configuratie wijzigen

Parameters

  • serviceIdstringverplicht

    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.

  • ipAddressIdstringoptioneel
  • ipv6PrefixAllocationIdstringoptioneel
  • hostnamestringoptioneel
  • confirmbooleanoptioneel

Refresh Dedicated Server Installation

refresh_dedicated_installation
Wijzigt gegevensBevestiging nodig

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

Recht
dedicated.installation.manage
Toegekend bij verbinden
Volledige toegang

Parameters

  • serviceIdstringverplicht

    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.

  • confirmbooleanoptioneel

Mount Dedicated Server Install Media

mount_dedicated_install_media
Wijzigt gegevensBevestiging nodig

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

Recht
dedicated.installation.manage
Toegekend bij verbinden
Volledige toegang

Parameters

  • serviceIdstringverplicht

    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.

  • templateIdstringverplicht
  • confirmbooleanoptioneel

Unmount Dedicated Server Install Media

unmount_dedicated_install_media
Wijzigt gegevensBevestiging nodig

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

Recht
dedicated.installation.manage
Toegekend bij verbinden
Volledige toegang

Parameters

  • serviceIdstringverplicht

    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.

  • confirmbooleanoptioneel

Set Dedicated Server Next Boot Device

set_dedicated_next_boot
Wijzigt gegevensBevestiging nodig

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

Recht
dedicated.installation.manage
Toegekend bij verbinden
Volledige toegang

Parameters

  • serviceIdstringverplicht

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

  • confirmbooleanoptioneel

Enable Dedicated Server Rescue Mode

enable_dedicated_rescue
DestructiefBevestiging nodig

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

Recht
dedicated.rescue.manage
Toegekend bij verbinden
Volledige toegang

Parameters

  • serviceIdstringverplicht

    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.

  • templateIdstringverplicht
  • confirmbooleanoptioneel

Disable Dedicated Server Rescue Mode

disable_dedicated_rescue
DestructiefBevestiging nodig

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

Recht
dedicated.rescue.manage
Toegekend bij verbinden
Volledige toegang

Parameters

  • serviceIdstringverplicht

    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.

  • confirmbooleanoptioneel

Activate Dedicated Server Remote Management

activate_dedicated_remote_management
Wijzigt gegevensBevestiging nodig

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

Recht
dedicated.remote_management.manage
Toegekend bij verbinden
Volledige toegang

Parameters

  • serviceIdstringverplicht

    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.

  • durationHoursintegeroptioneel

    > 0 · max 9007199254740991

  • confirmbooleanoptioneel

Extend Dedicated Server Remote Management

extend_dedicated_remote_management
Wijzigt gegevensBevestiging nodig

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

Recht
dedicated.remote_management.manage
Toegekend bij verbinden
Volledige toegang

Parameters

  • serviceIdstringverplicht

    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.

  • confirmbooleanoptioneel

Revoke Dedicated Server Remote Management

revoke_dedicated_remote_management
DestructiefBevestiging nodig

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

Recht
dedicated.remote_management.manage
Toegekend bij verbinden
Volledige toegang

Parameters

  • serviceIdstringverplicht

    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.

  • confirmbooleanoptioneel

Launch Dedicated Server Remote Management

launch_dedicated_remote_management
DestructiefBevestiging nodig

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

Recht
dedicated.remote_management.manage
Toegekend bij verbinden
Volledige toegang

Parameters

  • serviceIdstringverplicht

    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.

  • confirmbooleanoptioneel

Turn Dedicated Server DDoS Protection On or Off

toggle_dedicated_ddos_protection
DestructiefBevestiging nodig

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

Recht
dedicated.ddos.manage
Toegekend bij verbinden
Configuratie wijzigen

Parameters

  • serviceIdstringverplicht

    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.

  • ipAddressstringoptioneel
  • enabledbooleanoptioneel

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

  • confirmbooleanoptioneel

Import Dedicated Server Custom ISO

import_dedicated_custom_iso
Wijzigt gegevensBevestiging nodig

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

Recht
dedicated.installation.manage
Toegekend bij verbinden
Volledige toegang

Parameters

  • serviceIdstringverplicht

    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.

  • displayNamestringverplicht
  • sourceUrlstringverplicht

    format uri

  • filenamestringoptioneel
  • confirmbooleanoptioneel

Delete Dedicated Server Custom ISO

delete_dedicated_custom_iso
DestructiefBevestiging nodig

Delete a custom ISO asset. Requires confirm=true.

Recht
dedicated.installation.manage
Toegekend bij verbinden
Volledige toegang

Parameters

  • serviceIdstringverplicht

    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.

  • assetIdstringverplicht
  • confirmbooleanoptioneel

Mount Dedicated Server Custom ISO

mount_dedicated_custom_iso
Wijzigt gegevensBevestiging nodig

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

Recht
dedicated.installation.manage
Toegekend bij verbinden
Volledige toegang

Parameters

  • serviceIdstringverplicht

    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.

  • assetIdstringverplicht
  • confirmbooleanoptioneel

TeamSpeak-servers

Status, starten en stoppen, instellingen, clients, bans en privilege keys.

List TeamSpeak Servers

list_teamspeak_servers
Alleen lezenStartpunt

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

Recht
teamspeak.view
Toegekend bij verbinden
Services bekijken

Parameters

Geen parameters

Get TeamSpeak Server

get_teamspeak_server
Alleen lezenStartpunt

Get one TeamSpeak server by ID.

Recht
teamspeak.view
Toegekend bij verbinden
Services bekijken

Parameters

  • serviceIdstringverplicht

    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
Alleen lezen

Read TeamSpeak server configuration.

Recht
teamspeak.config.read
Toegekend bij verbinden
Configuratie lezen

Parameters

  • serviceIdstringverplicht

    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
DestructiefBevestiging nodig

Update TeamSpeak server configuration. Requires confirm=true.

Recht
teamspeak.config.manage
Toegekend bij verbinden
Configuratie wijzigen

Parameters

  • serviceIdstringverplicht

    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>verplicht
  • confirmbooleanoptioneel

List TeamSpeak Privilege Keys

list_teamspeak_tokens
Alleen lezen

List privilege tokens for a TeamSpeak server.

Recht
teamspeak.tokens.manage
Toegekend bij verbinden
TeamSpeak-beheer

Parameters

  • serviceIdstringverplicht

    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
DestructiefBevestiging nodig

Create a TeamSpeak privilege token. Requires confirm=true.

Recht
teamspeak.tokens.manage
Toegekend bij verbinden
TeamSpeak-beheer

Parameters

  • serviceIdstringverplicht

    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.

  • descriptionstringoptioneel

    max length 100

  • confirmbooleanoptioneel

Start TeamSpeak Server

start_teamspeak_server
Wijzigt gegevensBevestiging nodig

Start a TeamSpeak server. Requires confirm=true.

Recht
teamspeak.power.start
Toegekend bij verbinden
Power-acties

Parameters

  • serviceIdstringverplicht

    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.

  • confirmbooleanoptioneel

Stop TeamSpeak Server

stop_teamspeak_server
DestructiefBevestiging nodig

Stop a TeamSpeak server. Requires confirm=true.

Recht
teamspeak.power.stop
Toegekend bij verbinden
Power-acties

Parameters

  • serviceIdstringverplicht

    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.

  • confirmbooleanoptioneel

Restart TeamSpeak Server

restart_teamspeak_server
DestructiefBevestiging nodig

Restart a TeamSpeak server. Requires confirm=true.

Recht
teamspeak.power.restart
Toegekend bij verbinden
Power-acties

Parameters

  • serviceIdstringverplicht

    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.

  • confirmbooleanoptioneel

Get TeamSpeak Metrics

get_teamspeak_metrics
Alleen lezen

Get TeamSpeak server metrics.

Recht
teamspeak.metrics.read
Toegekend bij verbinden
Services bekijken

Parameters

  • serviceIdstringverplicht

    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
Alleen lezen

List connected TeamSpeak clients.

Recht
teamspeak.clients.manage
Toegekend bij verbinden
TeamSpeak-beheer

Parameters

  • serviceIdstringverplicht

    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
Alleen lezen

List TeamSpeak server bans.

Recht
teamspeak.bans.manage
Toegekend bij verbinden
TeamSpeak-beheer

Parameters

  • serviceIdstringverplicht

    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
Wijzigt gegevensBevestiging nodig

Add a TeamSpeak ban. Requires confirm=true.

Recht
teamspeak.bans.manage
Toegekend bij verbinden
TeamSpeak-beheer

Parameters

  • serviceIdstringverplicht

    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.

  • ipstringoptioneel
  • uidstringoptioneel
  • namestringoptioneel
  • timenumberoptioneel
  • reasonstringoptioneel
  • confirmbooleanoptioneel

Delete TeamSpeak Ban

delete_teamspeak_ban
DestructiefBevestiging nodig

Delete a TeamSpeak ban. Requires confirm=true.

Recht
teamspeak.bans.manage
Toegekend bij verbinden
TeamSpeak-beheer

Parameters

  • serviceIdstringverplicht

    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.

  • banIdintegerverplicht

    > 0 · max 9007199254740991

  • confirmbooleanoptioneel

Delete TeamSpeak Privilege Key

delete_teamspeak_token
DestructiefBevestiging nodig

Delete a TeamSpeak privilege token. Requires confirm=true.

Recht
teamspeak.tokens.manage
Toegekend bij verbinden
TeamSpeak-beheer

Parameters

  • serviceIdstringverplicht

    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.

  • tokenstringverplicht
  • confirmbooleanoptioneel

Discord-bots

Status, console, starten en stoppen en de activiteit van je Discord-bots.

List Discord Bots

list_discord_bots
Alleen lezenStartpunt

List Discord bots accessible with the current token.

Recht
discord_bot.view
Toegekend bij verbinden
Services bekijken

Parameters

Geen parameters

Get Discord Bot

get_discord_bot
Alleen lezenStartpunt

Get Discord bot details.

Recht
discord_bot.view
Toegekend bij verbinden
Services bekijken

Parameters

  • serviceIdstringverplicht

    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
Alleen lezen

Get Discord bot container and port reachability status.

Recht
discord_bot.view
Toegekend bij verbinden
Services bekijken

Parameters

  • serviceIdstringverplicht

    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
Alleen lezen

Read recent Discord bot activity logs.

Recht
discord_bot.view
Toegekend bij verbinden
Services bekijken

Parameters

  • serviceIdstringverplicht

    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.

  • limitintegeroptioneel

    min 1 · max 100

  • offsetintegeroptioneel

    min 0 · max 9007199254740991

Start Discord Bot

start_discord_bot
Wijzigt gegevensBevestiging nodig

Start a Discord bot. Requires confirm=true.

Recht
discord_bot.start
Toegekend bij verbinden
Power-acties

Parameters

  • serviceIdstringverplicht

    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.

  • confirmbooleanoptioneel

Stop Discord Bot

stop_discord_bot
DestructiefBevestiging nodig

Stop a Discord bot. Requires confirm=true.

Recht
discord_bot.stop
Toegekend bij verbinden
Power-acties

Parameters

  • serviceIdstringverplicht

    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.

  • confirmbooleanoptioneel

Restart Discord Bot

restart_discord_bot
DestructiefBevestiging nodig

Restart a Discord bot. Requires confirm=true.

Recht
discord_bot.restart
Toegekend bij verbinden
Power-acties

Parameters

  • serviceIdstringverplicht

    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.

  • confirmbooleanoptioneel

Get Discord Bot Console Logs

get_discord_bot_console_logs
Alleen lezen

Get recent Discord bot console log lines.

Recht
discord_bot.console.read
Toegekend bij verbinden
Console en logs

Parameters

  • serviceIdstringverplicht

    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.

  • linesintegeroptioneel

    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
DestructiefBevestiging nodig

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

Recht
discord_bot.console.write
Toegekend bij verbinden
Console en logs

Parameters

  • serviceIdstringverplicht

    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.

  • commandstringverplicht

    max length 500

  • confirmbooleanoptioneel

Domeinen

Domeinen, DNS-records, nameservers, parkeerpagina en automatische verlenging.

List Domains

list_domains
Alleen lezenStartpunt

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.

Recht
domain.view
Toegekend bij verbinden
Services bekijken

Parameters

Geen parameters

Get Domain

get_domain
Alleen lezen

Get one domain by ID. Read-only.

Recht
domain.view
Toegekend bij verbinden
Services bekijken

Parameters

  • domainIdstringverplicht

    Domain id (from list_domains or list_account_services).

Get Domain DNS Records

get_domain_dns_records
Alleen lezenStartpunt

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.

Recht
domain.dns.read
Toegekend bij verbinden
Configuratie lezen

Parameters

  • domainIdstringverplicht

    Domain id (from list_domains or list_account_services).

Create Domain DNS Record

create_domain_dns_record
Wijzigt gegevensBevestiging nodig

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.

Recht
domain.dns.write
Toegekend bij verbinden
Domeinbeheer

Parameters

  • domainIdstringverplicht

    Domain id (from list_domains or list_account_services).

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

    Record type.

  • namestringoptioneel

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

    max length 253

  • contentstringverplicht

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

    max length 4096

  • ttlintegeroptioneel

    TTL in seconds (default 3600, min 60).

    min 60 · max 9007199254740991

  • priorityintegeroptioneel

    MX/SRV priority.

    min 0 · max 65535

  • weightintegeroptioneel

    SRV weight.

    min 0 · max 65535

  • portintegeroptioneel

    SRV port.

    min 0 · max 65535

  • confirmbooleanoptioneel

    Must be true to apply the change.

Update Domain DNS Record

update_domain_dns_record
DestructiefBevestiging nodig

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.

Recht
domain.dns.write
Toegekend bij verbinden
Domeinbeheer

Parameters

  • domainIdstringverplicht

    Domain id (from list_domains or list_account_services).

  • recordIdstringverplicht

    Record id from get_domain_dns_records.

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

    Record type.

  • namestringoptioneel

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

    max length 253

  • contentstringverplicht

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

    max length 4096

  • ttlintegeroptioneel

    TTL in seconds (default 3600, min 60).

    min 60 · max 9007199254740991

  • priorityintegeroptioneel

    MX/SRV priority.

    min 0 · max 65535

  • weightintegeroptioneel

    SRV weight.

    min 0 · max 65535

  • portintegeroptioneel

    SRV port.

    min 0 · max 65535

  • confirmbooleanoptioneel

    Must be true to apply the change.

Delete Domain DNS Record

delete_domain_dns_record
DestructiefBevestiging nodig

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.

Recht
domain.dns.write
Toegekend bij verbinden
Domeinbeheer

Parameters

  • domainIdstringverplicht

    Domain id (from list_domains or list_account_services).

  • recordIdstringverplicht

    Record id from get_domain_dns_records.

  • confirmbooleanoptioneel

    Must be true to apply the change.

Set Domain Parking Page

set_domain_parking_page
DestructiefBevestiging nodig

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.

Recht
domain.dns.write
Toegekend bij verbinden
Domeinbeheer

Parameters

  • domainIdstringverplicht

    Domain id (from list_domains or list_account_services).

  • enabledbooleanverplicht

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

  • confirmedReplaceRecordIdsstring[]optioneel

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

    max items 200

  • confirmbooleanoptioneel

    Must be true to apply the change.

Get Domain Nameservers

get_domain_nameservers
Alleen lezen

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

Recht
domain.dns.read
Toegekend bij verbinden
Configuratie lezen

Parameters

  • domainIdstringverplicht

    Domain id (from list_domains or list_account_services).

Set Domain Nameservers

set_domain_nameservers
DestructiefBevestiging nodig

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.

Recht
domain.nameservers.write
Toegekend bij verbinden
Domeinbeheer

Parameters

  • domainIdstringverplicht

    Domain id (from list_domains or list_account_services).

  • mode"managed" | "external"verplicht

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

  • nameserversstring[]optioneel

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

    min items 2 · max items 13

  • confirmbooleanoptioneel

    Must be true to apply the change.

Get Domain Renewal Status

get_domain_renewal
Alleen lezen

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

Recht
domain.view
Toegekend bij verbinden
Services bekijken

Parameters

  • domainIdstringverplicht

    Domain id (from list_domains or list_account_services).

Set Domain Auto-Renew

set_domain_auto_renew
DestructiefBevestiging nodig

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.

Recht
domain.renewal.manage
Toegekend bij verbinden
Domeinbeheer

Parameters

  • domainIdstringverplicht

    Domain id (from list_domains or list_account_services).

  • autoRenewbooleanverplicht

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

  • confirmbooleanoptioneel

    Must be true to apply the change.

Bestanden

Bestanden van gameservers en Discord-bots weergeven, lezen, schrijven, hernoemen en verwijderen.

List Discord Bot Files

list_discord_bot_files
Alleen lezenStartpunt

List files in a Discord bot directory.

Recht
discord_bot.files.read
Toegekend bij verbinden
Configuratie lezen

Parameters

  • serviceIdstringverplicht

    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.

  • pathstringoptioneel
  • includeFolderSizesbooleanoptioneel

Read Discord Bot File

read_discord_bot_file
Alleen lezen

Read an editable text file from a Discord bot.

Recht
discord_bot.files.read
Toegekend bij verbinden
Configuratie lezen

Parameters

  • serviceIdstringverplicht

    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.

  • pathstringverplicht

Edit Discord Bot File

mutate_discord_bot_file
DestructiefBevestiging nodig

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

Recht
discord_bot.files.write
Toegekend bij verbinden
Configuratie wijzigen

Parameters

  • serviceIdstringverplicht

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

  • pathstringverplicht
  • contentstringoptioneel
  • expectedRevisionstringoptioneel

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

  • newNamestringoptioneel
  • confirmbooleanoptioneel

List Game Server Files

list_gameserver_files
Alleen lezenStartpunt

List files in a gameserver directory.

Recht
gameserver.files.read
Toegekend bij verbinden
Configuratie lezen

Parameters

  • serviceIdstringverplicht

    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.

  • pathstringoptioneel
  • scope"savegame" | "config" | "active"optioneel

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

  • includeFolderSizesbooleanoptioneel

Read Game Server File

read_gameserver_file
Alleen lezen

Read text content of a gameserver file.

Recht
gameserver.files.read
Toegekend bij verbinden
Configuratie lezen

Parameters

  • serviceIdstringverplicht

    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.

  • pathstringverplicht
  • scope"savegame" | "config" | "active"optioneel

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

Edit Game Server File

mutate_gameserver_file
DestructiefBevestiging nodig

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.

Recht
gameserver.files.write
Toegekend bij verbinden
Configuratie wijzigen

Parameters

  • serviceIdstringverplicht

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

  • pathstringoptioneel

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

  • contentstringoptioneel
  • expectedRevisionstringoptioneel

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

  • newNamestringoptioneel
  • pathsstring[]optioneel

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

    min items 1 · max items 100

  • destinationstringoptioneel

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

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

  • confirmbooleanoptioneel

One-click-apps (VPS en dedicated)

App-catalogus (Pterodactyl, Nextcloud, n8n, ...), installeren, starten/stoppen/herstarten, logs en verwijderen; gameservers binnen Pterodactyl maak je aan in het eigen paneel.

List VPS One-Click Apps

get_vserver_apps
Alleen lezenStartpunt

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.

Recht
vserver.apps.read
Toegekend bij verbinden
Configuratie lezen

Parameters

  • serviceIdstringverplicht

    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.

  • livebooleanoptioneel

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

Search VPS App Catalog

list_vserver_app_catalog
Alleen lezen

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

Recht
vserver.apps.read
Toegekend bij verbinden
Configuratie lezen

Parameters

  • serviceIdstringverplicht

    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.

  • searchstringoptioneel

    Free text search over name, description and tags.

    max length 200

  • categorystringoptioneel

    max length 100

  • pageintegeroptioneel

    > 0 · max 9007199254740991

  • pageSizeintegeroptioneel

    > 0 · max 50

Get VPS App Catalog Entry

get_vserver_app_catalog_entry
Alleen lezen

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

Recht
vserver.apps.read
Toegekend bij verbinden
Configuratie lezen

Parameters

  • serviceIdstringverplicht

    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.

  • catalogTypestringverplicht

    max length 128

Get VPS App Logs

get_vserver_app_logs
Alleen lezen

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

Recht
vserver.apps.read
Toegekend bij verbinden
Configuratie lezen

Parameters

  • serviceIdstringverplicht

    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.

  • installationIdstringverplicht

    Installation id from get_vserver_apps / get_dedicated_apps.

    max length 64

  • linesintegeroptioneel

    min 50 · max 500

Install VPS One-Click App

install_vserver_app
Wijzigt gegevensBevestiging nodig

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.

Recht
vserver.apps.manage
Toegekend bij verbinden
Configuratie wijzigen

Parameters

  • serviceIdstringverplicht

    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.

  • catalogTypestringverplicht

    Catalog type from the app catalog.

    max length 128

  • displayNamestringverplicht

    min length 2 · max length 80

  • envValuesRecord<string, string>optioneel

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

  • customEnvsobject[]optioneel

    max items 50

  • confirmbooleanoptioneel
  • withoutHostnamebooleanoptioneel

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

Start, Stop or Restart VPS App

manage_vserver_app
DestructiefBevestiging nodig

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

Recht
vserver.apps.manage
Toegekend bij verbinden
Configuratie wijzigen

Parameters

  • serviceIdstringverplicht

    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.

  • installationIdstringverplicht

    Installation id from get_vserver_apps / get_dedicated_apps.

    max length 64

  • action"start" | "stop" | "restart"verplicht

  • confirmbooleanoptioneel

Uninstall VPS One-Click App

uninstall_vserver_app
DestructiefBevestiging nodig

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

Recht
vserver.apps.manage
Toegekend bij verbinden
Configuratie wijzigen

Parameters

  • serviceIdstringverplicht

    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.

  • installationIdstringverplicht

    Installation id from get_vserver_apps / get_dedicated_apps.

    max length 64

  • deleteVolumesbooleanoptioneel

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

  • confirmbooleanoptioneel

Reinstall VPS One-Click App

reinstall_vserver_app
DestructiefBevestiging nodig

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

Recht
vserver.apps.manage
Toegekend bij verbinden
Configuratie wijzigen

Parameters

  • serviceIdstringverplicht

    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.

  • installationIdstringverplicht

    Installation id from get_vserver_apps / get_dedicated_apps.

    max length 64

  • deleteVolumesbooleanoptioneel

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

  • confirmbooleanoptioneel

List Dedicated Server One-Click Apps

get_dedicated_apps
Alleen lezenStartpunt

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.

Recht
dedicated.apps.read
Toegekend bij verbinden
Configuratie lezen

Parameters

  • serviceIdstringverplicht

    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.

  • livebooleanoptioneel

    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
Alleen lezen

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.

Recht
dedicated.apps.read
Toegekend bij verbinden
Configuratie lezen

Parameters

  • serviceIdstringverplicht

    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.

  • searchstringoptioneel

    Free text search over name, description and tags.

    max length 200

  • categorystringoptioneel

    max length 100

  • pageintegeroptioneel

    > 0 · max 9007199254740991

  • pageSizeintegeroptioneel

    > 0 · max 50

Get Dedicated Server App Catalog Entry

get_dedicated_app_catalog_entry
Alleen lezen

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

Recht
dedicated.apps.read
Toegekend bij verbinden
Configuratie lezen

Parameters

  • serviceIdstringverplicht

    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.

  • catalogTypestringverplicht

    max length 128

Get Dedicated Server App Logs

get_dedicated_app_logs
Alleen lezen

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

Recht
dedicated.apps.read
Toegekend bij verbinden
Configuratie lezen

Parameters

  • serviceIdstringverplicht

    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.

  • installationIdstringverplicht

    Installation id from get_vserver_apps / get_dedicated_apps.

    max length 64

  • linesintegeroptioneel

    min 50 · max 500

Install Dedicated Server One-Click App

install_dedicated_app
Wijzigt gegevensBevestiging nodig

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.

Recht
dedicated.apps.manage
Toegekend bij verbinden
Configuratie wijzigen

Parameters

  • serviceIdstringverplicht

    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.

  • catalogTypestringverplicht

    Catalog type from the app catalog.

    max length 128

  • displayNamestringverplicht

    min length 2 · max length 80

  • envValuesRecord<string, string>optioneel

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

  • customEnvsobject[]optioneel

    max items 50

  • confirmbooleanoptioneel

Start, Stop or Restart Dedicated Server App

manage_dedicated_app
DestructiefBevestiging nodig

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

Recht
dedicated.apps.manage
Toegekend bij verbinden
Configuratie wijzigen

Parameters

  • serviceIdstringverplicht

    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.

  • installationIdstringverplicht

    Installation id from get_vserver_apps / get_dedicated_apps.

    max length 64

  • action"start" | "stop" | "restart"verplicht

  • confirmbooleanoptioneel

Uninstall Dedicated Server One-Click App

uninstall_dedicated_app
DestructiefBevestiging nodig

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

Recht
dedicated.apps.manage
Toegekend bij verbinden
Configuratie wijzigen

Parameters

  • serviceIdstringverplicht

    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.

  • installationIdstringverplicht

    Installation id from get_vserver_apps / get_dedicated_apps.

    max length 64

  • deleteVolumesbooleanoptioneel

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

  • confirmbooleanoptioneel

Reinstall Dedicated Server One-Click App

reinstall_dedicated_app
DestructiefBevestiging nodig

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

Recht
dedicated.apps.manage
Toegekend bij verbinden
Configuratie wijzigen

Parameters

  • serviceIdstringverplicht

    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.

  • installationIdstringverplicht

    Installation id from get_vserver_apps / get_dedicated_apps.

    max length 64

  • deleteVolumesbooleanoptioneel

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

  • confirmbooleanoptioneel

Back-ups en snapshots

Back-ups en snapshots aanmaken, terugzetten en verwijderen.

List Game Server Backups

list_gameserver_backups
Alleen lezenStartpunt

List gameserver backups.

Recht
gameserver.backups.read
Toegekend bij verbinden
Configuratie lezen

Parameters

  • serviceIdstringverplicht

    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
DestructiefBevestiging nodig

Create a gameserver backup. Requires confirm=true.

Recht
gameserver.backups.manage
Toegekend bij verbinden
Configuratie wijzigen

Parameters

  • serviceIdstringverplicht

    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.

  • namestringoptioneel

    max length 120

  • confirmbooleanoptioneel

Delete Game Server Backup

delete_gameserver_backup
DestructiefBevestiging nodig

Delete a gameserver backup. Requires confirm=true.

Recht
gameserver.backups.manage
Toegekend bij verbinden
Configuratie wijzigen

Parameters

  • serviceIdstringverplicht

    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.

  • backupIdstringverplicht
  • confirmbooleanoptioneel

Restore Game Server Backup

restore_gameserver_backup
DestructiefBevestiging nodig

Restore a gameserver backup. Requires confirm=true.

Recht
gameserver.backups.manage
Toegekend bij verbinden
Configuratie wijzigen

Parameters

  • serviceIdstringverplicht

    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.

  • backupIdstringverplicht
  • confirmbooleanoptioneel

List VPS Backups

list_vserver_backups
Alleen lezenStartpunt

List VPS backups.

Recht
vserver.backups.read
Toegekend bij verbinden
Configuratie lezen

Parameters

  • serviceIdstringverplicht

    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
Alleen lezen

List VPS VM snapshots.

Recht
vserver.backups.read
Toegekend bij verbinden
Configuratie lezen

Parameters

  • serviceIdstringverplicht

    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
Wijzigt gegevensBevestiging nodig

Create a VPS VM snapshot. Requires confirm=true.

Recht
vserver.backups.manage
Toegekend bij verbinden
Configuratie wijzigen

Parameters

  • serviceIdstringverplicht

    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.

  • namestringverplicht
  • descriptionstringoptioneel
  • includeRambooleanoptioneel
  • confirmbooleanoptioneel

Delete VPS Snapshot

delete_vserver_snapshot
DestructiefBevestiging nodig

Delete a VPS VM snapshot. Requires confirm=true.

Recht
vserver.backups.manage
Toegekend bij verbinden
Configuratie wijzigen

Parameters

  • serviceIdstringverplicht

    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.

  • namestringverplicht
  • confirmbooleanoptioneel

Roll Back VPS to Snapshot

rollback_vserver_snapshot
DestructiefBevestiging nodig

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

Recht
vserver.backups.manage
Toegekend bij verbinden
Configuratie wijzigen

Parameters

  • serviceIdstringverplicht

    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.

  • namestringverplicht
  • confirmbooleanoptioneel

Create VPS Backup

create_vserver_backup
Wijzigt gegevensBevestiging nodig

Create a VPS backup. Requires confirm=true.

Recht
vserver.backups.manage
Toegekend bij verbinden
Configuratie wijzigen

Parameters

  • serviceIdstringverplicht

    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.

  • notesstringoptioneel

    max length 500

  • confirmbooleanoptioneel

Delete VPS Backup

delete_vserver_backup
DestructiefBevestiging nodig

Delete a VPS backup. Requires confirm=true.

Recht
vserver.backups.manage
Toegekend bij verbinden
Configuratie wijzigen

Parameters

  • serviceIdstringverplicht

    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.

  • backupIdstringverplicht
  • confirmbooleanoptioneel

Restore VPS Backup

restore_vserver_backup
DestructiefBevestiging nodig

Restore a VPS backup. Requires confirm=true.

Recht
vserver.backups.manage
Toegekend bij verbinden
Configuratie wijzigen

Parameters

  • serviceIdstringverplicht

    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.

  • backupIdstringverplicht
  • confirmbooleanoptioneel

Pakketwijzigingen

Upgrades en downgrades met prijsvoorbeeld, pas uitgevoerd na je uitdrukkelijke bevestiging.

Get Game Server Plan Change Options

get_gameserver_plan_change_options
Alleen lezenStartpuntNiet in de ChatGPT- en Claude-connector

List available gameserver plan-change targets (packages and custom constraints) for a service. Use preview_gameserver_plan_change for the full change overview with pricing before applying.

Bestellingen en pakketwijzigingen zijn verborgen in de connectors uit de app-directory's van ChatGPT en Claude. In Claude Code, Cursor en met een API-sleutel is de tool beschikbaar.

Recht
gameserver.plan_change
Toegekend bij verbinden
Planwijzigingen

Parameters

  • serviceIdstringverplicht

    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
Alleen lezenNiet in de ChatGPT- en Claude-connector

Return a read-only overview of the planned gameserver package/configuration change: current vs. target resources, pricing (recurring old/new, delta, immediate charges or credits, billing period), blockers, migration requirements, and a one-time previewConfirmationNonce when allowed. Read-only. Never call apply_* in the same assistant turn. After preview, you MUST send a user-visible message that includes old price, new price, delta, and immediate charge or credit from confirmation.pricingSummary. Then STOP and wait for an explicit user reply (for example 'Ja') in a NEW turn. A user request like 'upgrade to 3 GB' only authorizes preview, not apply. Pass couponCode only when the user gave you a coupon code for this upgrade (never guess or invent one): an accepted code is shown as pricing.couponCode / pricing.couponDiscountCents and is already subtracted from the immediate charge; a refused code makes the preview not allowed with coupon.error -- tell the user why and preview again without the code if they want to continue.

Bestellingen en pakketwijzigingen zijn verborgen in de connectors uit de app-directory's van ChatGPT en Claude. In Claude Code, Cursor en met een API-sleutel is de tool beschikbaar.

Recht
gameserver.plan_change
Toegekend bij verbinden
Planwijzigingen

Parameters

  • serviceIdstringverplicht

    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.

  • targetobjectoptioneel
  • target.pricingMode"package" | "custom"optioneel

  • target.targetPackageKeystringoptioneel
  • target.ramMbintegeroptioneel

    > 0 · max 9007199254740991

  • target.cpuMillisintegeroptioneel

    > 0 · max 9007199254740991

  • target.diskMbintegeroptioneel

    > 0 · max 9007199254740991

  • target.slotsintegeroptioneel

    > 0 · max 9007199254740991

  • target.dedicatedIpbooleanoptioneel
  • target.premiumCpubooleanoptioneel

    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.targetRegionIdstringoptioneel
  • target.targetBillingIntervalCountintegeroptioneel

    > 0 · max 9007199254740991

  • couponCodestringoptioneel

    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
DestructiefBevestiging nodigNiet in de ChatGPT- en Claude-connector

Execute a gameserver upgrade or downgrade after the user has explicitly confirmed a matching preview_gameserver_plan_change result. NEVER call in the same turn as preview_*. Requires confirm=true, userExplicitlyConfirmed=true, and previewConfirmationNonce from the matching preview_* result, plus the same target and the same couponCode as that preview (omit couponCode if the preview had none). Only call after the user explicitly confirmed the exact pricing summary you showed. When the preview has requiresImmediateStartRequest: true (paid upgrade), also tell the user they ask ZAP-Hosting to start the upgrade right away and owe compensation for the days used if they withdraw the upgrade within 14 days; pass requestImmediateStart=true only if they expressly agreed to that. If apply returns PREVIEW_CONFIRMATION_TOO_EARLY, wait until details.earliestApplyAt (or confirmation.earliestApplyAt from preview) and call apply again; this short safety delay needs no explanation to the user. Triggers billing and infrastructure changes.

Bestellingen en pakketwijzigingen zijn verborgen in de connectors uit de app-directory's van ChatGPT en Claude. In Claude Code, Cursor en met een API-sleutel is de tool beschikbaar.

Recht
gameserver.plan_change
Toegekend bij verbinden
Planwijzigingen

Parameters

  • serviceIdstringverplicht

    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.

  • targetobjectoptioneel
  • target.pricingMode"package" | "custom"optioneel

  • target.targetPackageKeystringoptioneel
  • target.ramMbintegeroptioneel

    > 0 · max 9007199254740991

  • target.cpuMillisintegeroptioneel

    > 0 · max 9007199254740991

  • target.diskMbintegeroptioneel

    > 0 · max 9007199254740991

  • target.slotsintegeroptioneel

    > 0 · max 9007199254740991

  • target.dedicatedIpbooleanoptioneel
  • target.premiumCpubooleanoptioneel

    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.targetRegionIdstringoptioneel
  • target.targetBillingIntervalCountintegeroptioneel

    > 0 · max 9007199254740991

  • couponCodestringoptioneel

    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

  • confirmtrueverplicht
  • userExplicitlyConfirmedtrueverplicht
  • previewConfirmationNoncestringverplicht
  • requestImmediateStartbooleanoptioneel

    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
Alleen lezen

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.

Recht
vserver.plan_change
Toegekend bij verbinden
Planwijzigingen

Parameters

  • serviceIdstringverplicht

    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
Alleen lezen

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.

Recht
vserver.plan_change
Toegekend bij verbinden
Planwijzigingen

Parameters

  • serviceIdstringverplicht

    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.

  • targetobjectoptioneel
  • target.pricingMode"package" | "custom"optioneel

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

  • target.targetPackageKeystringoptioneel
  • target.coresintegeroptioneel

    > 0 · max 9007199254740991

  • target.memoryMbintegeroptioneel

    > 0 · max 9007199254740991

  • target.diskGbintegeroptioneel

    > 0 · max 9007199254740991

  • target.bandwidthMbpsintegeroptioneel

    > 0 · max 9007199254740991

  • target.memoryintegeroptioneel

    > 0 · max 9007199254740991

  • target.diskintegeroptioneel

    > 0 · max 9007199254740991

  • target.bandwidthintegeroptioneel

    > 0 · max 9007199254740991

  • target.additionalIpCountintegeroptioneel

    min 0 · max 9007199254740991

  • target.targetBillingIntervalCountintegeroptioneel

    > 0 · max 9007199254740991

  • couponCodestringoptioneel

    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
DestructiefBevestiging nodig

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.

Recht
vserver.plan_change
Toegekend bij verbinden
Planwijzigingen

Parameters

  • serviceIdstringverplicht

    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.

  • targetobjectoptioneel
  • target.pricingMode"package" | "custom"optioneel

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

  • target.targetPackageKeystringoptioneel
  • target.coresintegeroptioneel

    > 0 · max 9007199254740991

  • target.memoryMbintegeroptioneel

    > 0 · max 9007199254740991

  • target.diskGbintegeroptioneel

    > 0 · max 9007199254740991

  • target.bandwidthMbpsintegeroptioneel

    > 0 · max 9007199254740991

  • target.memoryintegeroptioneel

    > 0 · max 9007199254740991

  • target.diskintegeroptioneel

    > 0 · max 9007199254740991

  • target.bandwidthintegeroptioneel

    > 0 · max 9007199254740991

  • target.additionalIpCountintegeroptioneel

    min 0 · max 9007199254740991

  • target.targetBillingIntervalCountintegeroptioneel

    > 0 · max 9007199254740991

  • couponCodestringoptioneel

    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

  • confirmtrueverplicht
  • userExplicitlyConfirmedtrueverplicht
  • previewConfirmationNoncestringverplicht
  • requestImmediateStartbooleanoptioneel

    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
Alleen lezenNiet in de ChatGPT- en Claude-connector

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

Bestellingen en pakketwijzigingen zijn verborgen in de connectors uit de app-directory's van ChatGPT en Claude. In Claude Code, Cursor en met een API-sleutel is de tool beschikbaar.

Recht
teamspeak.plan_change
Toegekend bij verbinden
Planwijzigingen

Parameters

  • serviceIdstringverplicht

    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
Alleen lezenNiet in de ChatGPT- en Claude-connector

Return a read-only overview of the planned TeamSpeak slot/billing change: current vs. target configuration, pricing (recurring old/new, delta, immediate charges or credits, billing period), blockers, and a one-time previewConfirmationNonce when allowed. Read-only. Never call apply_* in the same assistant turn. After preview, you MUST send a user-visible message that includes old price, new price, delta, and immediate charge or credit from confirmation.pricingSummary. Then STOP and wait for an explicit user reply (for example 'Ja') in a NEW turn. A user request like 'upgrade to 3 GB' only authorizes preview, not apply. Pass couponCode only when the user gave you a coupon code for this upgrade (never guess or invent one): an accepted code is shown as pricing.couponCode / pricing.couponDiscountCents and is already subtracted from the immediate charge; a refused code makes the preview not allowed with coupon.error -- tell the user why and preview again without the code if they want to continue.

Bestellingen en pakketwijzigingen zijn verborgen in de connectors uit de app-directory's van ChatGPT en Claude. In Claude Code, Cursor en met een API-sleutel is de tool beschikbaar.

Recht
teamspeak.plan_change
Toegekend bij verbinden
Planwijzigingen

Parameters

  • serviceIdstringverplicht

    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.

  • targetobjectoptioneel
  • target.pricingMode"package" | "custom"optioneel

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

  • target.targetPackageKeystringoptioneel
  • target.slotsintegeroptioneel

    > 0 · max 9007199254740991

  • target.hasAdvertisementbooleanoptioneel
  • target.targetBillingIntervalCountintegeroptioneel

    > 0 · max 9007199254740991

  • couponCodestringoptioneel

    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
DestructiefBevestiging nodigNiet in de ChatGPT- en Claude-connector

Execute a TeamSpeak upgrade or downgrade after the user has explicitly confirmed a matching preview_teamspeak_plan_change result. NEVER call in the same turn as preview_*. Requires confirm=true, userExplicitlyConfirmed=true, and previewConfirmationNonce from the matching preview_* result, plus the same target and the same couponCode as that preview (omit couponCode if the preview had none). Only call after the user explicitly confirmed the exact pricing summary you showed. When the preview has requiresImmediateStartRequest: true (paid upgrade), also tell the user they ask ZAP-Hosting to start the upgrade right away and owe compensation for the days used if they withdraw the upgrade within 14 days; pass requestImmediateStart=true only if they expressly agreed to that. If apply returns PREVIEW_CONFIRMATION_TOO_EARLY, wait until details.earliestApplyAt (or confirmation.earliestApplyAt from preview) and call apply again; this short safety delay needs no explanation to the user. Triggers billing and infrastructure changes.

Bestellingen en pakketwijzigingen zijn verborgen in de connectors uit de app-directory's van ChatGPT en Claude. In Claude Code, Cursor en met een API-sleutel is de tool beschikbaar.

Recht
teamspeak.plan_change
Toegekend bij verbinden
Planwijzigingen

Parameters

  • serviceIdstringverplicht

    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.

  • targetobjectoptioneel
  • target.pricingMode"package" | "custom"optioneel

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

  • target.targetPackageKeystringoptioneel
  • target.slotsintegeroptioneel

    > 0 · max 9007199254740991

  • target.hasAdvertisementbooleanoptioneel
  • target.targetBillingIntervalCountintegeroptioneel

    > 0 · max 9007199254740991

  • couponCodestringoptioneel

    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

  • confirmtrueverplicht
  • userExplicitlyConfirmedtrueverplicht
  • previewConfirmationNoncestringverplicht
  • requestImmediateStartbooleanoptioneel

    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
Alleen lezenNiet in de ChatGPT- en Claude-connector

List available dedicated-server IP plan-change options and constraints for a service. Hardware changes are not supported. Use preview_dedicated_plan_change for the full change overview with pricing before applying.

Bestellingen en pakketwijzigingen zijn verborgen in de connectors uit de app-directory's van ChatGPT en Claude. In Claude Code, Cursor en met een API-sleutel is de tool beschikbaar.

Recht
dedicated.plan_change
Toegekend bij verbinden
Planwijzigingen

Parameters

  • serviceIdstringverplicht

    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
Alleen lezenNiet in de ChatGPT- en Claude-connector

Return a read-only overview of the planned dedicated-server additional IPv4 count change: current vs. target IP configuration, pricing (recurring old/new, delta, immediate charges or credits, billing period), blockers, releasable assignments, and a one-time previewConfirmationNonce when allowed. Read-only. Never call apply_* in the same assistant turn. After preview, you MUST send a user-visible message that includes old price, new price, delta, and immediate charge or credit from confirmation.pricingSummary. Then STOP and wait for an explicit user reply (for example 'Ja') in a NEW turn. A user request like 'upgrade to 3 GB' only authorizes preview, not apply. Pass couponCode only when the user gave you a coupon code for this upgrade (never guess or invent one): an accepted code is shown as pricing.couponCode / pricing.couponDiscountCents and is already subtracted from the immediate charge; a refused code makes the preview not allowed with coupon.error -- tell the user why and preview again without the code if they want to continue.

Bestellingen en pakketwijzigingen zijn verborgen in de connectors uit de app-directory's van ChatGPT en Claude. In Claude Code, Cursor en met een API-sleutel is de tool beschikbaar.

Recht
dedicated.plan_change
Toegekend bij verbinden
Planwijzigingen

Parameters

  • serviceIdstringverplicht

    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.

  • targetobjectoptioneel
  • target.additionalIpCountintegeroptioneel

    min 0 · max 9007199254740991

  • target.releaseIpAssignmentIdsstring[]optioneel
  • couponCodestringoptioneel

    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
DestructiefBevestiging nodigNiet in de ChatGPT- en Claude-connector

Execute a dedicated-server additional IPv4 upgrade or downgrade after the user has explicitly confirmed a matching preview_dedicated_plan_change result. Downgrades require releaseIpAssignmentIds. NEVER call in the same turn as preview_*. Requires confirm=true, userExplicitlyConfirmed=true, and previewConfirmationNonce from the matching preview_* result, plus the same target and the same couponCode as that preview (omit couponCode if the preview had none). Only call after the user explicitly confirmed the exact pricing summary you showed. When the preview has requiresImmediateStartRequest: true (paid upgrade), also tell the user they ask ZAP-Hosting to start the upgrade right away and owe compensation for the days used if they withdraw the upgrade within 14 days; pass requestImmediateStart=true only if they expressly agreed to that. If apply returns PREVIEW_CONFIRMATION_TOO_EARLY, wait until details.earliestApplyAt (or confirmation.earliestApplyAt from preview) and call apply again; this short safety delay needs no explanation to the user. Triggers billing and infrastructure changes.

Bestellingen en pakketwijzigingen zijn verborgen in de connectors uit de app-directory's van ChatGPT en Claude. In Claude Code, Cursor en met een API-sleutel is de tool beschikbaar.

Recht
dedicated.plan_change
Toegekend bij verbinden
Planwijzigingen

Parameters

  • serviceIdstringverplicht

    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.

  • targetobjectoptioneel
  • target.additionalIpCountintegeroptioneel

    min 0 · max 9007199254740991

  • target.releaseIpAssignmentIdsstring[]optioneel
  • couponCodestringoptioneel

    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

  • confirmtrueverplicht
  • userExplicitlyConfirmedtrueverplicht
  • previewConfirmationNoncestringverplicht
  • requestImmediateStartbooleanoptioneel

    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
Alleen lezenStartpunt

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

Recht
gameserver.plan_changevserver.plan_changeteamspeak.plan_changededicated.plan_change
Toegekend bij verbinden
Planwijzigingen

Parameters

  • changeIdstringverplicht

Bestellen

Bestelbare producten, pakketten, regio's, games en ISO-images, plus het prijsvoorbeeld van een bestelling.

List Orderable Products

list_orderable_products
Alleen lezenStartpuntNiet in de ChatGPT- en Claude-connector

List the products that can be ordered (catalog, read-only). Read-only catalog: nothing is ordered or charged. To order, price the configuration with preview_order first.

Bestellingen en pakketwijzigingen zijn verborgen in de connectors uit de app-directory's van ChatGPT en Claude. In Claude Code, Cursor en met een API-sleutel is de tool beschikbaar.

Recht
orders.view
Toegekend bij verbinden
Bestelcatalogus en voorbeeldberekening

Parameters

Geen parameters

List Orderable Plans

list_orderable_plans
Alleen lezenNiet in de ChatGPT- en Claude-connector

List the plans, billing cycles, prices and resource options of one orderable product (catalog, read-only). Read-only catalog: nothing is ordered or charged. To order, price the configuration with preview_order first.

Bestellingen en pakketwijzigingen zijn verborgen in de connectors uit de app-directory's van ChatGPT en Claude. In Claude Code, Cursor en met een API-sleutel is de tool beschikbaar.

Recht
orders.view
Toegekend bij verbinden
Bestelcatalogus en voorbeeldberekening

Parameters

  • productSlugstringverplicht

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

List Regions for an Orderable Product

list_orderable_product_regions
Alleen lezenNiet in de ChatGPT- en Claude-connector

List the regions in which one orderable product can be ordered (catalog, read-only). Read-only catalog: nothing is ordered or charged. To order, price the configuration with preview_order first.

Bestellingen en pakketwijzigingen zijn verborgen in de connectors uit de app-directory's van ChatGPT en Claude. In Claude Code, Cursor en met een API-sleutel is de tool beschikbaar.

Recht
orders.view
Toegekend bij verbinden
Bestelcatalogus en voorbeeldberekening

Parameters

  • productSlugstringverplicht

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

List Order Regions

list_order_regions
Alleen lezenNiet in de ChatGPT- en Claude-connector

List all regions that are used by orderable products (catalog, read-only). Read-only catalog: nothing is ordered or charged. To order, price the configuration with preview_order first.

Bestellingen en pakketwijzigingen zijn verborgen in de connectors uit de app-directory's van ChatGPT en Claude. In Claude Code, Cursor en met een API-sleutel is de tool beschikbaar.

Recht
orders.view
Toegekend bij verbinden
Bestelcatalogus en voorbeeldberekening

Parameters

Geen parameters

List Orderable Games

list_orderable_games
Alleen lezenNiet in de ChatGPT- en Claude-connector

List the games for which a gameserver can be ordered (catalog, read-only). Read-only catalog: nothing is ordered or charged. To order, price the configuration with preview_order first.

Bestellingen en pakketwijzigingen zijn verborgen in de connectors uit de app-directory's van ChatGPT en Claude. In Claude Code, Cursor en met een API-sleutel is de tool beschikbaar.

Recht
orders.view
Toegekend bij verbinden
Bestelcatalogus en voorbeeldberekening

Parameters

Geen parameters

List ISO Images for VPS Orders

list_vserver_order_isos
Alleen lezenNiet in de ChatGPT- en Claude-connector

List the catalog ISO images a VPS can be ordered with, per region (catalog, read-only). Read-only catalog: nothing is ordered or charged. To order, price the configuration with preview_order first.

Bestellingen en pakketwijzigingen zijn verborgen in de connectors uit de app-directory's van ChatGPT en Claude. In Claude Code, Cursor en met een API-sleutel is de tool beschikbaar.

Recht
orders.view
Toegekend bij verbinden
Bestelcatalogus en voorbeeldberekening

Parameters

Geen parameters

Preview Order Price

preview_order
Alleen lezenStartpuntNiet in de ChatGPT- en Claude-connector

Preview an order: checks the combination of product, plan, billing cycle, region and options, and returns the price breakdown and any blockingReasons. Nothing is ordered, reserved or charged. When this connection may order (permission orders.create) and the order is allowed, it also returns confirmation (confirmationCode, chargeSummary, valid 10 minutes) for create_order; otherwise ordering.reason says why not.

Bestellingen en pakketwijzigingen zijn verborgen in de connectors uit de app-directory's van ChatGPT en Claude. In Claude Code, Cursor en met een API-sleutel is de tool beschikbaar.

Recht
orders.view
Toegekend bij verbinden
Bestelcatalogus en voorbeeldberekening

Parameters

  • productSlugstringverplicht

    Product slug from list_orderable_products.

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

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

  • planSlugstringoptioneel

    Plan slug from list_orderable_plans (products with fixed plans).

  • gameSlugstringoptioneel

    Game slug from list_orderable_games (gameservers).

  • regionSlugstringoptioneel

    Region slug from list_orderable_product_regions (products with region choice).

  • resourceConfigRecord<string, number>optioneel

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

  • optionsobjectoptioneel
  • options.couponCodestringoptioneel
  • options.dedicatedIpCountintegeroptioneel

    min 0 · max 9007199254740991

  • options.domainAttachmentobjectoptioneel
  • configurationRecord<string, any>optioneel

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

  • domainsobject[]optioneel

Get Order Status

get_order_status
Alleen lezenNiet in de ChatGPT- en Claude-connector

Status of one order of this account (payment, items, the services it created). Use it after create_order to follow the setup, or to check whether an order went through before ordering again. Read-only.

Bestellingen en pakketwijzigingen zijn verborgen in de connectors uit de app-directory's van ChatGPT en Claude. In Claude Code, Cursor en met een API-sleutel is de tool beschikbaar.

Recht
orders.view
Toegekend bij verbinden
Bestelcatalogus en voorbeeldberekening

Parameters

  • orderIdstringverplicht

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

Place Paid Order

create_order
Wijzigt gegevensBevestiging nodigNiet in de ChatGPT- en Claude-connector

Place a PAID order that preview_order priced, using its confirmation.confirmationCode. Charges the payment method saved in the user's ZapX account and creates a subscription that renews until cancelled. Requires confirm=true and userExplicitlyConfirmed=true. Only call this after showing the user confirmation.chargeSummary and getting their explicit yes to this exact order; never on your own initiative. The code orders exactly the previewed configuration; to change anything, run preview_order again. Refused when the price changed since the preview, without a saved payment method, or above the daily limit of orders through the MCP. Retrying with the same code never orders twice. If the bank asks for a confirmation (3-D Secure), the result contains paymentActionUrl for the user.

Bestellingen en pakketwijzigingen zijn verborgen in de connectors uit de app-directory's van ChatGPT en Claude. In Claude Code, Cursor en met een API-sleutel is de tool beschikbaar.

Recht
orders.create
Toegekend bij verbinden
Bestellen (tegen betaling)

Parameters

  • confirmationCodestringverplicht

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

  • confirmtrueverplicht

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

  • userExplicitlyConfirmedbooleanverplicht

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

  • requestImmediateStartbooleanoptioneel

    true only if the user also expressly agreed to confirmation.immediateStartNotice (start right away, compensation for used days on withdrawal). Required for most paid orders; without it the order is refused with WITHDRAWAL_EARLY_START_REQUIRED.

Feedback

Je AI-client meldt bugs of ontbrekende functies van de MCP-tools rechtstreeks bij ons.

Send Feedback About This Connector

report_mcp_feedback
Wijzigt gegevensStartpunt

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.

Recht
Elke verbinding
Toegekend bij verbinden
Elke verbinding

Parameters

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

  • summarystringverplicht

    One sentence: what went wrong or what is missing.

    min length 5 · max length 200

  • detailsstringoptioneel

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

    max length 4000

  • relatedToolstringoptioneel

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

    max length 100

  • exampleArgsRecord<string, any>optioneel

    Optional arguments of the failing call, without secrets.