Hoppa till innehållet

MCP

Alla MCP-verktyg

Varje verktyg som din AI-klient kan anropa via ZapX MCP-server, med parametrar, nödvändig behörighet och beteende. Listan genereras direkt från servern och är därför alltid aktuell.

224 verktyg i 13 grupper · ingår i alla ZapX Pass

Konfigurera MCPREST API-referens
Endpointhttps://zap-hosting.com/api/mcpJSONMarkdown för LLM:er
Verktygens namn, titlar och beskrivningar är på engelska, precis som din AI-klient får dem från servern. Verktyg märkta ”Kräver bekräftelse” körs bara med confirm: true. Din AI-klient frågar dig innan den utför åtgärden.

224 av 224 verktyg

Konto

Alla tjänster med id och typ, driftstörningar och underhåll samt status för pågående åtgärder.

List All Services

list_account_services
Endast läsningStartpunkt

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

Behörighet
Alla anslutningarResultaten innehåller bara tjänster som anslutningen får visa.
Beviljas vid anslutning
Alla anslutningar

Parametrar

Inga parametrar

List Incidents

list_incidents
Endast läsningStartpunkt

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.

Behörighet
Alla anslutningarResultaten innehåller bara tjänster som anslutningen får visa.
Beviljas vid anslutning
Alla anslutningar

Parametrar

  • resolvedHoursintegervalfri

    min 0 · max 168

Get Operation Status

get_operation_status
Endast läsning

Poll the status of an async public API operation.

Behörighet
Alla anslutningarResultaten innehåller bara tjänster som anslutningen får visa.
Beviljas vid anslutning
Alla anslutningar

Parametrar

  • operationIdstringobligatorisk

Spelservrar

Status, konsol, starta och stoppa, inställningar, spelversion och variant, moddar, sparfiler, SFTP-åtkomst och ominstallation.

List Game Servers

list_gameservers
Endast läsningStartpunkt

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

Behörighet
gameserver.view
Beviljas vid anslutning
Visa tjänster

Parametrar

Inga parametrar

Get Game Server

get_gameserver
Endast läsningStartpunkt

Get one gameserver by ID.

Behörighet
gameserver.view
Beviljas vid anslutning
Visa tjänster

Parametrar

  • serviceIdstringobligatorisk

    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
Endast läsningStartpunkt

Get live query status for a gameserver.

Behörighet
gameserver.view
Beviljas vid anslutning
Visa tjänster

Parametrar

  • serviceIdstringobligatorisk

    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
Endast läsning

Read editable gameserver configuration fields.

Behörighet
gameserver.config.read
Beviljas vid anslutning
Läs konfiguration

Parametrar

  • serviceIdstringobligatorisk

    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
DestruktivtKräver bekräftelse

Update editable gameserver configuration fields. Requires confirm=true.

Behörighet
gameserver.config.write
Beviljas vid anslutning
Ändra konfiguration

Parametrar

  • serviceIdstringobligatorisk

    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>obligatorisk
  • confirmbooleanvalfri

Get Game Server Console Logs

get_gameserver_console_logs
Endast läsning

Read a recent gameserver console log snapshot.

Behörighet
gameserver.console.read
Beviljas vid anslutning
Konsol och loggar

Parametrar

  • serviceIdstringobligatorisk

    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.

  • linesintegervalfri

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

    > 0 · max 200

Restart Game Server

restart_gameserver
DestruktivtKräver bekräftelse

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

Behörighet
gameserver.restart
Beviljas vid anslutning
Strömåtgärder

Parametrar

  • serviceIdstringobligatorisk

    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.

  • confirmbooleanvalfri

Start Game Server

start_gameserver
Ändrar dataKräver bekräftelse

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

Behörighet
gameserver.start
Beviljas vid anslutning
Strömåtgärder

Parametrar

  • serviceIdstringobligatorisk

    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.

  • confirmbooleanvalfri

Stop Game Server

stop_gameserver
DestruktivtKräver bekräftelse

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

Behörighet
gameserver.stop
Beviljas vid anslutning
Strömåtgärder

Parametrar

  • serviceIdstringobligatorisk

    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.

  • confirmbooleanvalfri

Send Game Server Console Command

send_gameserver_console_command
DestruktivtKräver bekräftelse

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

Behörighet
gameserver.console.write
Beviljas vid anslutning
Konsol och loggar

Parametrar

  • serviceIdstringobligatorisk

    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.

  • commandstringobligatorisk

    max length 500

  • confirmbooleanvalfri

Get Game Server Activity

get_gameserver_activity
Endast läsning

Read recent gameserver activity logs.

Behörighet
gameserver.activity.read
Beviljas vid anslutning
Visa tjänster

Parametrar

  • serviceIdstringobligatorisk

    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.

  • limitintegervalfri

    > 0 · max 100

  • offsetintegervalfri

    min 0 · max 9007199254740991

Get Game Server Container Status

get_gameserver_container_status
Endast läsning

Get gameserver container and port reachability status.

Behörighet
gameserver.view
Beviljas vid anslutning
Visa tjänster

Parametrar

  • serviceIdstringobligatorisk

    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
Endast läsning

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.

Behörighet
gameserver.view
Beviljas vid anslutning
Visa tjänster

Parametrar

  • serviceIdstringobligatorisk

    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
Ändrar dataKräver bekräftelse

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.

Behörighet
gameserver.backups.managegameserver.restartgameserver.startgameserver.stopgameserver.console.writegameserver.wipe
Beviljas vid anslutning
Strömåtgärder, Konsol och loggar, Ändra konfiguration

Parametrar

  • serviceIdstringobligatorisk

    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.

  • namestringobligatorisk

    max length 120

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

  • cronstringobligatorisk

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

  • timezonestringvalfri

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

  • commandstringvalfri

    Console command, required for action=command.

    max length 2000

  • wipeobjectvalfri

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

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

    Rust: map, blueprints or full.

  • wipe.backupFirstbooleanvalfri

    Back up before wiping (default true).

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

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

  • wipe.worldSizeintegervalfri

    min 1000 · max 6000

  • isActivebooleanvalfri
  • confirmbooleanvalfri

Update Game Server Schedule

update_gameserver_schedule
DestruktivtKräver bekräftelse

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.

Behörighet
gameserver.backups.managegameserver.restartgameserver.startgameserver.stopgameserver.console.writegameserver.wipe
Beviljas vid anslutning
Strömåtgärder, Konsol och loggar, Ändra konfiguration

Parametrar

  • serviceIdstringobligatorisk

    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.

  • scheduleIdstringobligatorisk
  • namestringvalfri

    max length 120

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

  • cronstringvalfri

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

  • timezonestringvalfri

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

  • commandstringvalfri

    Console command, required for action=command.

    max length 2000

  • wipeobjectvalfri

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

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

    Rust: map, blueprints or full.

  • wipe.backupFirstbooleanvalfri

    Back up before wiping (default true).

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

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

  • wipe.worldSizeintegervalfri

    min 1000 · max 6000

  • isActivebooleanvalfri
  • confirmbooleanvalfri

Delete Game Server Schedule

delete_gameserver_schedule
DestruktivtKräver bekräftelse

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

Behörighet
gameserver.backups.managegameserver.restartgameserver.startgameserver.stopgameserver.console.writegameserver.wipe
Beviljas vid anslutning
Strömåtgärder, Konsol och loggar, Ändra konfiguration

Parametrar

  • serviceIdstringobligatorisk

    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.

  • scheduleIdstringobligatorisk
  • confirmbooleanvalfri

Wipe Game Server

wipe_gameserver
DestruktivtKräver bekräftelse

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.

Behörighet
gameserver.wipe
Beviljas vid anslutning
Full åtkomst

Parametrar

  • serviceIdstringobligatorisk

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

    Rust: map, blueprints or full.

  • backupFirstbooleanvalfri

    Back up before wiping (default true).

  • seed"keep" | "random" | integervalfri

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

  • worldSizeintegervalfri

    min 1000 · max 6000

  • confirmbooleanvalfri

List Game Server Databases

list_gameserver_databases
Endast läsning

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.

Behörighet
gameserver.database.read
Beviljas vid anslutning
Läs konfiguration

Parametrar

  • serviceIdstringobligatorisk

    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
Ändrar dataKräver bekräftelse

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.

Behörighet
gameserver.database.write
Beviljas vid anslutning
Ändra konfiguration

Parametrar

  • serviceIdstringobligatorisk

    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.

  • namestringvalfri

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

    max length 40

  • confirmbooleanvalfri

Delete Game Server Database

delete_gameserver_database
DestruktivtKräver bekräftelse

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.

Behörighet
gameserver.database.write
Beviljas vid anslutning
Ändra konfiguration

Parametrar

  • serviceIdstringobligatorisk

    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.

  • databaseIdstringobligatorisk
  • confirmationNamestringobligatorisk

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

  • confirmbooleanvalfri

Get Game Server External Access

get_gameserver_external_access
Endast läsning

Read gameserver external access details.

Behörighet
gameserver.external-access.manage
Beviljas vid anslutning
Full åtkomst

Parametrar

  • serviceIdstringobligatorisk

    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
Ändrar dataKräver bekräftelse

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

Behörighet
gameserver.external-access.manage
Beviljas vid anslutning
Full åtkomst

Parametrar

  • serviceIdstringobligatorisk

    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.

  • confirmbooleanvalfri

Rotate Game Server External Access Credentials

rotate_gameserver_external_access
DestruktivtKräver bekräftelse

Rotate gameserver external access credentials. Requires confirm=true.

Behörighet
gameserver.external-access.manage
Beviljas vid anslutning
Full åtkomst

Parametrar

  • serviceIdstringobligatorisk

    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.

  • confirmbooleanvalfri

Show Game Server External Access Credentials

reveal_gameserver_external_access
DestruktivtKräver bekräftelse

Reveal gameserver external access credentials. Requires confirm=true.

Behörighet
gameserver.external-access.manage
Beviljas vid anslutning
Full åtkomst

Parametrar

  • serviceIdstringobligatorisk

    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.

  • confirmbooleanvalfri

Reinstall Game Server

reinstall_gameserver
DestruktivtKräver bekräftelse

Reinstall a gameserver. Requires confirm=true.

Behörighet
gameserver.reinstall
Beviljas vid anslutning
Full åtkomst

Parametrar

  • serviceIdstringobligatorisk

    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.

  • confirmbooleanvalfri

Change Game Server Game Version

update_gameserver_version
DestruktivtKräver bekräftelse

Update gameserver game version. Requires confirm=true.

Behörighet
gameserver.lifecycle.manage
Beviljas vid anslutning
Ändra konfiguration

Parametrar

  • serviceIdstringobligatorisk

    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.

  • targetVersionstringvalfri
  • targetModpackVersionstringvalfri
  • confirmbooleanvalfri

Change Game Server Variant

update_gameserver_variant
DestruktivtKräver bekräftelse

Change gameserver variant. Requires confirm=true.

Behörighet
gameserver.lifecycle.manage
Beviljas vid anslutning
Ändra konfiguration

Parametrar

  • serviceIdstringobligatorisk

    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.

  • variantIdstringobligatorisk
  • confirmbooleanvalfri

List Game Server Save Games

list_gameserver_savegames
Endast läsning

List gameserver savegames.

Behörighet
gameserver.savegames.read
Beviljas vid anslutning
Läs konfiguration

Parametrar

  • serviceIdstringobligatorisk

    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.

  • pageintegervalfri

    > 0 · max 9007199254740991

  • limitintegervalfri

    > 0 · max 100

Delete Game Server Save Game

delete_gameserver_savegame
DestruktivtKräver bekräftelse

Delete a gameserver savegame. Requires confirm=true.

Behörighet
gameserver.savegames.write
Beviljas vid anslutning
Ändra konfiguration

Parametrar

  • serviceIdstringobligatorisk

    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.

  • pathstringobligatorisk
  • confirmbooleanvalfri

List Game Server Mods

list_gameserver_mods
Endast läsning

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.

Behörighet
gameserver.view
Beviljas vid anslutning
Visa tjänster

Parametrar

  • serviceIdstringobligatorisk

    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.

  • querystringvalfri
  • providerstringvalfri
  • installedOnlybooleanvalfri
  • offsetintegervalfri

    min 0 · max 9007199254740991

  • limitintegervalfri

    > 0 · max 48

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

Install or Update Game Server Mod

install_gameserver_mod
DestruktivtKräver bekräftelse

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.

Behörighet
gameserver.mods.manage
Beviljas vid anslutning
Ändra konfiguration

Parametrar

  • serviceIdstringobligatorisk

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

  • projectIdstringobligatorisk

    max length 200

  • versionIdstringvalfri

    max length 200

  • titlestringvalfri

    max length 200

  • resolveDependenciesbooleanvalfri
  • confirmbooleanvalfri

Remove Game Server Mod

uninstall_gameserver_mod
DestruktivtKräver bekräftelse

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.

Behörighet
gameserver.mods.manage
Beviljas vid anslutning
Ändra konfiguration

Parametrar

  • serviceIdstringobligatorisk

    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.

  • installationIdstringobligatorisk
  • confirmbooleanvalfri

Check Game Server Mod and Plugin Updates

check_gameserver_addon_updates
Endast läsning

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.

Behörighet
gameserver.view
Beviljas vid anslutning
Visa tjänster

Parametrar

  • serviceIdstringobligatorisk

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

  • refreshbooleanvalfri

List Game Server Plugins

list_gameserver_plugins
Endast läsning

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.

Behörighet
gameserver.view
Beviljas vid anslutning
Visa tjänster

Parametrar

  • serviceIdstringobligatorisk

    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.

  • querystringvalfri

    max length 200

  • provider"all" | "modrinth" | "hangar"valfri

  • installedOnlybooleanvalfri
  • offsetintegervalfri

    min 0 · max 9007199254740991

  • limitintegervalfri

    min 1 · max 48

  • sortstringvalfri

    max length 40

Install or Update Game Server Plugin

install_gameserver_plugin
DestruktivtKräver bekräftelse

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.

Behörighet
gameserver.plugins.manage
Beviljas vid anslutning
Ändra konfiguration

Parametrar

  • serviceIdstringobligatorisk

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

  • projectIdstringobligatorisk

    max length 200

  • versionIdstringvalfri

    max length 200

  • titlestringvalfri

    max length 200

  • resolveDependenciesbooleanvalfri
  • confirmbooleanvalfri

Remove Game Server Plugin

uninstall_gameserver_plugin
DestruktivtKräver bekräftelse

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.

Behörighet
gameserver.plugins.manage
Beviljas vid anslutning
Ändra konfiguration

Parametrar

  • serviceIdstringobligatorisk

    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.

  • installationIdstringobligatorisk
  • confirmbooleanvalfri

Get Rust Plugin Framework

get_gameserver_rust_framework
Endast läsning

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.

Behörighet
gameserver.view
Beviljas vid anslutning
Visa tjänster

Parametrar

  • serviceIdstringobligatorisk

    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
DestruktivtKräver bekräftelse

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.

Behörighet
gameserver.plugins.manage
Beviljas vid anslutning
Ändra konfiguration

Parametrar

  • serviceIdstringobligatorisk

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

  • confirmbooleanvalfri

List Minecraft Modpacks

list_gameserver_modpacks
Endast läsning

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.

Behörighet
gameserver.view
Beviljas vid anslutning
Visa tjänster

Parametrar

  • serviceIdstringobligatorisk

    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.

  • searchstringvalfri

    max length 200

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

  • offsetintegervalfri

    min 0 · max 100000

  • limitintegervalfri

    min 1 · max 100

  • modpackIdstringvalfri

Install Minecraft Modpack

install_gameserver_modpack
DestruktivtKräver bekräftelse

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.

Behörighet
gameserver.lifecycle.manage
Beviljas vid anslutning
Ändra konfiguration

Parametrar

  • serviceIdstringobligatorisk

    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.

  • modpackIdstringobligatorisk
  • versionIdstringobligatorisk
  • confirmbooleanvalfri

Get Game Server Steam Workshop

get_gameserver_workshop
Endast läsning

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.

Behörighet
gameserver.view
Beviljas vid anslutning
Visa tjänster

Parametrar

  • serviceIdstringobligatorisk

    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
DestruktivtKräver bekräftelse

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.

Behörighet
gameserver.mods.manage
Beviljas vid anslutning
Ändra konfiguration

Parametrar

  • serviceIdstringobligatorisk

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

    max items 500

  • addItemIdsstring[]valfri

    max items 200

  • removeItemIdsstring[]valfri

    max items 500

  • collectionIdstringvalfri

    pattern ^\d{1,20}$

  • disabledItemIdsstring[]valfri

    max items 500

  • confirmbooleanvalfri

VPS

Starta och stoppa, konfiguration, mätvärden, trafik, DNS, brandvägg, SSH-nycklar, DDoS-skydd, scheman, rescue-läge och ominstallation.

List VPS

list_vservers
Endast läsningStartpunkt

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

Behörighet
vserver.view
Beviljas vid anslutning
Visa tjänster

Parametrar

Inga parametrar

Get VPS

get_vserver
Endast läsningStartpunkt

Get one VPS by ID.

Behörighet
vserver.view
Beviljas vid anslutning
Visa tjänster

Parametrar

  • serviceIdstringobligatorisk

    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
Endast läsning

Read VPS configuration.

Behörighet
vserver.config.read
Beviljas vid anslutning
Läs konfiguration

Parametrar

  • serviceIdstringobligatorisk

    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
DestruktivtKräver bekräftelse

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

Behörighet
vserver.config.writevserver.access.manage
Beviljas vid anslutning
Ändra konfiguration

Parametrar

  • serviceIdstringobligatorisk

    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.

  • hostnamestringvalfri
  • dnsServerstringvalfri
  • ballooningDisabledbooleanvalfri
  • sshPasswordEnabledbooleanvalfri
  • confirmbooleanvalfri

Get VPS Activity

get_vserver_activity
Endast läsning

Read paginated VPS activity log entries.

Behörighet
vserver.activity.read
Beviljas vid anslutning
Visa tjänster

Parametrar

  • serviceIdstringobligatorisk

    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.

  • limitintegervalfri

    min 1 · max 100

  • offsetintegervalfri

    min 0 · max 9007199254740991

Get VPS Traffic

get_vserver_traffic
Endast läsning

Read paginated VPS network traffic history.

Behörighet
vserver.traffic.read
Beviljas vid anslutning
Visa tjänster

Parametrar

  • serviceIdstringobligatorisk

    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.

  • limitintegervalfri

    min 1 · max 100

  • offsetintegervalfri

    min 0 · max 9007199254740991

Get VPS DDoS Status

get_vserver_ddos_status
Endast läsning

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.

Behörighet
vserver.ddos.read
Beviljas vid anslutning
Visa tjänster

Parametrar

  • serviceIdstringobligatorisk

    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.

  • ipAddressstringvalfri

List VPS DDoS Rules

list_vserver_ddos_rules
Endast läsning

List the DDoS filter rules learned for a VPS IP.

Behörighet
vserver.ddos.read
Beviljas vid anslutning
Visa tjänster

Parametrar

  • serviceIdstringobligatorisk

    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.

  • ipAddressstringvalfri

List VPS DDoS Incidents

list_vserver_ddos_incidents
Endast läsning

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

Behörighet
vserver.ddos.read
Beviljas vid anslutning
Visa tjänster

Parametrar

  • serviceIdstringobligatorisk

    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.

  • ipAddressstringvalfri
  • pageintegervalfri

    > 0 · max 9007199254740991

  • pageSizeintegervalfri

    > 0 · max 100

Get VPS DDoS Bandwidth

get_vserver_ddos_bandwidth
Endast läsning

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

Behörighet
vserver.ddos.read
Beviljas vid anslutning
Visa tjänster

Parametrar

  • serviceIdstringobligatorisk

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

  • ipAddressstringvalfri

List Outgoing DDoS Attacks from VPS

list_vserver_outgoing_ddos
Endast läsning

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

Behörighet
vserver.ddos.read
Beviljas vid anslutning
Visa tjänster

Parametrar

  • serviceIdstringobligatorisk

    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
DestruktivtKräver bekräftelse

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

Behörighet
vserver.ddos.manage
Beviljas vid anslutning
Ändra konfiguration

Parametrar

  • serviceIdstringobligatorisk

    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.

  • ipAddressstringvalfri
  • enabledbooleanvalfri

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

  • confirmbooleanvalfri

Get VPS DNS Settings

get_vserver_dns
Endast läsning

Read VPS DNS domains, subdomains, and favorite subdomain.

Behörighet
vserver.config.read
Beviljas vid anslutning
Läs konfiguration

Parametrar

  • serviceIdstringobligatorisk

    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
Endast läsning

List SSH keys stored on the authenticated account.

Behörighet
vserver.config.read
Beviljas vid anslutning
Läs konfiguration

Parametrar

Inga parametrar

Create VPS Subdomain

create_vserver_subdomain
Ändrar dataKräver bekräftelse

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

Behörighet
vserver.config.write
Beviljas vid anslutning
Ändra konfiguration

Parametrar

  • serviceIdstringobligatorisk

    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.

  • labelstringobligatorisk

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

  • domainIdstringvalfri

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

  • confirmbooleanvalfri

Delete VPS Subdomain

delete_vserver_subdomain
DestruktivtKräver bekräftelse

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

Behörighet
vserver.config.write
Beviljas vid anslutning
Ändra konfiguration

Parametrar

  • serviceIdstringobligatorisk

    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.

  • subdomainIdstringobligatorisk

    Subdomain id from get_vserver_dns.

  • confirmbooleanvalfri

Set VPS Favorite Subdomain

set_vserver_favorite_subdomain
DestruktivtKräver bekräftelse

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

Behörighet
vserver.config.write
Beviljas vid anslutning
Ändra konfiguration

Parametrar

  • serviceIdstringobligatorisk

    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.

  • subdomainIdstringvalfri

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

  • confirmbooleanvalfri

Get VPS Reverse DNS

get_vserver_reverse_dns
Endast läsning

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

Behörighet
vserver.config.read
Beviljas vid anslutning
Läs konfiguration

Parametrar

  • serviceIdstringobligatorisk

    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
DestruktivtKräver bekräftelse

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

Behörighet
vserver.config.write
Beviljas vid anslutning
Ändra konfiguration

Parametrar

  • serviceIdstringobligatorisk

    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.

  • ipAddressIdstringvalfri

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

  • ipv6PrefixAllocationIdstringvalfri

    IPv6 entry from get_vserver_reverse_dns (`ipv6PrefixAllocationId`).

  • hostnamestringvalfri

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

  • confirmbooleanvalfri

Update VPS Firewall Options

update_vserver_firewall_options
DestruktivtKräver bekräftelse

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.

Behörighet
vserver.firewall.write
Beviljas vid anslutning
Ändra konfiguration

Parametrar

  • serviceIdstringobligatorisk

    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.

  • enablebooleanobligatorisk

    Firewall on (true) or off (false).

  • policyIn"ACCEPT" | "DROP" | "REJECT"obligatorisk

    Default policy for incoming traffic no rule matches.

  • policyOut"ACCEPT" | "DROP" | "REJECT"obligatorisk

    Default policy for outgoing traffic no rule matches.

  • confirmbooleanvalfri

Change VPS Firewall Rule

mutate_vserver_firewall_rule
DestruktivtKräver bekräftelse

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

Behörighet
vserver.firewall.write
Beviljas vid anslutning
Ändra konfiguration

Parametrar

  • serviceIdstringobligatorisk

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

  • posintegervalfri

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

    min 0 · max 9007199254740991

  • newPosintegervalfri

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

    add/update: traffic direction.

  • ruleAction"ACCEPT" | "DROP" | "REJECT"valfri

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

  • enablebooleanvalfri

    add/update: rule active (default true).

  • macrostringvalfri

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

  • protostringvalfri

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

  • sourcestringvalfri

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

  • deststringvalfri

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

  • sportstringvalfri

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

  • dportstringvalfri

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

  • commentstringvalfri

    add/update: free text comment.

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

    add/update: log level (default nolog).

  • confirmbooleanvalfri

Change VPS Firewall IP Set

mutate_vserver_firewall_ipset
DestruktivtKräver bekräftelse

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

Behörighet
vserver.firewall.write
Beviljas vid anslutning
Ändra konfiguration

Parametrar

  • serviceIdstringobligatorisk

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

  • namestringobligatorisk

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

  • cidrstringvalfri

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

  • commentstringvalfri

    add_entry: free text comment.

  • confirmbooleanvalfri

List VPS SSH Keys

list_vserver_ssh_keys
Endast läsning

List the account SSH keys installed on one VPS.

Behörighet
vserver.config.read
Beviljas vid anslutning
Läs konfiguration

Parametrar

  • serviceIdstringobligatorisk

    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
Ändrar dataKräver bekräftelse

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

Behörighet
vserver.access.manage
Beviljas vid anslutning
Full åtkomst

Parametrar

  • serviceIdstringobligatorisk

    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.

  • sshKeyIdstringobligatorisk

    Key id from list_vserver_account_ssh_keys.

  • confirmbooleanvalfri

Remove SSH Key from VPS

remove_vserver_ssh_key
DestruktivtKräver bekräftelse

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

Behörighet
vserver.access.manage
Beviljas vid anslutning
Full åtkomst

Parametrar

  • serviceIdstringobligatorisk

    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.

  • sshKeyIdstringobligatorisk

    Key id from list_vserver_ssh_keys.

  • confirmbooleanvalfri

Add Account SSH Key

create_vserver_account_ssh_key
Ändrar dataKräver bekräftelse

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

Behörighet
vserver.config.write
Beviljas vid anslutning
Ändra konfiguration

Parametrar

  • namestringobligatorisk
  • publicKeystringobligatorisk

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

  • confirmbooleanvalfri

Update Account SSH Key

update_vserver_account_ssh_key
DestruktivtKräver bekräftelse

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

Behörighet
vserver.access.manage
Beviljas vid anslutning
Full åtkomst

Parametrar

  • keyIdstringobligatorisk

    Key id from list_vserver_account_ssh_keys.

  • namestringvalfri
  • publicKeystringvalfri

    Replaces the key on every VPS it is installed on.

  • confirmbooleanvalfri

Delete Account SSH Key

delete_vserver_account_ssh_key
DestruktivtKräver bekräftelse

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

Behörighet
vserver.access.manage
Beviljas vid anslutning
Full åtkomst

Parametrar

  • keyIdstringobligatorisk

    Key id from list_vserver_account_ssh_keys.

  • confirmbooleanvalfri

List VPS ISO Images

list_vserver_isos
Endast läsning

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

Behörighet
vserver.reinstall
Beviljas vid anslutning
Full åtkomst

Parametrar

  • serviceIdstringobligatorisk

    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
Ändrar dataKräver bekräftelse

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

Behörighet
vserver.reinstall
Beviljas vid anslutning
Full åtkomst

Parametrar

  • serviceIdstringobligatorisk

    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.

  • isoIdstringvalfri

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

  • volidstringvalfri

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

  • applyHardwareProfilebooleanvalfri

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

  • attachDriverDiscbooleanvalfri

    Attach the VirtIO driver disc (Windows installs).

  • bootFromIsobooleanvalfri

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

  • confirmbooleanvalfri

Unmount ISO from VPS

unmount_vserver_iso
Ändrar dataKräver bekräftelse

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

Behörighet
vserver.reinstall
Beviljas vid anslutning
Full åtkomst

Parametrar

  • serviceIdstringobligatorisk

    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.

  • confirmbooleanvalfri

List Custom VPS ISOs

list_vserver_custom_isos
Endast läsning

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

Behörighet
vserver.reinstall
Beviljas vid anslutning
Full åtkomst

Parametrar

  • serviceIdstringobligatorisk

    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
Ändrar dataKräver bekräftelse

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

Behörighet
vserver.reinstall
Beviljas vid anslutning
Full åtkomst

Parametrar

  • serviceIdstringobligatorisk

    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.

  • displayNamestringobligatorisk
  • sourceUrlstringobligatorisk

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

  • filenamestringvalfri
  • osProfile"linux" | "windows"valfri

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

  • confirmbooleanvalfri

Delete Custom VPS ISO

delete_vserver_custom_iso
DestruktivtKräver bekräftelse

Delete an own imported ISO. Requires confirm=true.

Behörighet
vserver.reinstall
Beviljas vid anslutning
Full åtkomst

Parametrar

  • serviceIdstringobligatorisk

    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.

  • assetIdstringobligatorisk

    Custom ISO id from list_vserver_custom_isos.

  • confirmbooleanvalfri

Get VPS Metrics

get_vserver_metrics
Endast läsning

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.

Behörighet
vserver.metrics.read
Beviljas vid anslutning
Visa tjänster

Parametrar

  • serviceIdstringobligatorisk

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

Get VPS Firewall Rules

get_vserver_firewall
Endast läsning

Read the VPS firewall configuration.

Behörighet
vserver.firewall.read
Beviljas vid anslutning
Läs konfiguration

Parametrar

  • serviceIdstringobligatorisk

    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
Ändrar dataKräver bekräftelse

Start a VPS. Requires confirm=true.

Behörighet
vserver.power.start
Beviljas vid anslutning
Strömåtgärder

Parametrar

  • serviceIdstringobligatorisk

    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.

  • confirmbooleanvalfri

Stop VPS

stop_vserver
DestruktivtKräver bekräftelse

Stop a VPS. Requires confirm=true.

Behörighet
vserver.power.stop
Beviljas vid anslutning
Strömåtgärder

Parametrar

  • serviceIdstringobligatorisk

    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.

  • confirmbooleanvalfri

Restart VPS

restart_vserver
DestruktivtKräver bekräftelse

Restart a VPS. Requires confirm=true.

Behörighet
vserver.power.restart
Beviljas vid anslutning
Strömåtgärder

Parametrar

  • serviceIdstringobligatorisk

    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.

  • confirmbooleanvalfri

List VPS Schedules

list_vserver_schedules
Endast läsning

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

Behörighet
vserver.view
Beviljas vid anslutning
Visa tjänster

Parametrar

  • serviceIdstringobligatorisk

    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
DestruktivtKräver bekräftelse

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.

Behörighet
vserver.power.restartvserver.power.startvserver.power.stopvserver.console.write
Beviljas vid anslutning
Strömåtgärder

Parametrar

  • serviceIdstringobligatorisk

    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.

  • namestringobligatorisk
  • action"restart" | "start" | "stop" | "command"obligatorisk

  • cronstringobligatorisk
  • timezonestringvalfri
  • commandstringvalfri
  • isActivebooleanvalfri
  • confirmbooleanvalfri

Update VPS Schedule

update_vserver_schedule
DestruktivtKräver bekräftelse

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

Behörighet
vserver.power.restartvserver.power.startvserver.power.stopvserver.console.write
Beviljas vid anslutning
Strömåtgärder

Parametrar

  • serviceIdstringobligatorisk

    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.

  • scheduleIdstringobligatorisk
  • namestringvalfri
  • action"restart" | "start" | "stop" | "command"valfri

  • cronstringvalfri
  • timezonestringvalfri
  • commandstringvalfri
  • isActivebooleanvalfri
  • confirmbooleanvalfri

Delete VPS Schedule

delete_vserver_schedule
DestruktivtKräver bekräftelse

Delete a VPS schedule. Requires confirm=true.

Behörighet
vserver.power.restartvserver.power.startvserver.power.stopvserver.console.write
Beviljas vid anslutning
Strömåtgärder

Parametrar

  • serviceIdstringobligatorisk

    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.

  • scheduleIdstringobligatorisk
  • confirmbooleanvalfri

Enable VPS Rescue Mode

enable_vserver_rescue
DestruktivtKräver bekräftelse

Enable VPS rescue mode. Requires confirm=true.

Behörighet
vserver.reinstall
Beviljas vid anslutning
Full åtkomst

Parametrar

  • serviceIdstringobligatorisk

    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.

  • confirmbooleanvalfri

Disable VPS Rescue Mode

disable_vserver_rescue
DestruktivtKräver bekräftelse

Disable VPS rescue mode. Requires confirm=true.

Behörighet
vserver.reinstall
Beviljas vid anslutning
Full åtkomst

Parametrar

  • serviceIdstringobligatorisk

    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.

  • confirmbooleanvalfri

List VPS Reinstall Templates

list_vserver_reinstall_templates
Endast läsning

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

Behörighet
vserver.reinstall
Beviljas vid anslutning
Full åtkomst

Parametrar

Inga parametrar

Reinstall VPS

reinstall_vserver
DestruktivtKräver bekräftelse

Reinstall a VPS. Requires confirm=true.

Behörighet
vserver.reinstall
Beviljas vid anslutning
Full åtkomst

Parametrar

  • serviceIdstringobligatorisk

    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.

  • templateIdstringvalfri
  • confirmbooleanvalfri

Dedikerade servrar

Strömstatus, hårdvara, mätvärden, trafik, installation, egna ISO-filer, omvänd DNS, DDoS-skydd, fjärrhantering och rescue-läge.

List Dedicated Servers

list_dedicated_servers
Endast läsningStartpunkt

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

Behörighet
dedicated.view
Beviljas vid anslutning
Visa tjänster

Parametrar

Inga parametrar

Get Dedicated Server

get_dedicated_server
Endast läsningStartpunkt

Get one dedicated server by ID.

Behörighet
dedicated.view
Beviljas vid anslutning
Visa tjänster

Parametrar

  • serviceIdstringobligatorisk

    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
Endast läsning

Get dedicated server hardware power state.

Behörighet
dedicated.view
Beviljas vid anslutning
Visa tjänster

Parametrar

  • serviceIdstringobligatorisk

    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
Endast läsning

Get dedicated server hardware metrics for a timeframe.

Behörighet
dedicated.metrics.read
Beviljas vid anslutning
Visa tjänster

Parametrar

  • serviceIdstringobligatorisk

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

Get Dedicated Server Hardware

get_dedicated_hardware
Endast läsning

Get dedicated server hardware inventory.

Behörighet
dedicated.hardware.read
Beviljas vid anslutning
Visa tjänster

Parametrar

  • serviceIdstringobligatorisk

    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
Endast läsning

Get dedicated server traffic overview for a timeframe.

Behörighet
dedicated.traffic.read
Beviljas vid anslutning
Visa tjänster

Parametrar

  • serviceIdstringobligatorisk

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

Get Dedicated Server Traffic Quota

get_dedicated_traffic_quota
Endast läsning

Get dedicated server traffic quota snapshot.

Behörighet
dedicated.traffic.read
Beviljas vid anslutning
Visa tjänster

Parametrar

  • serviceIdstringobligatorisk

    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
Endast läsning

Get dedicated server traffic history entries.

Behörighet
dedicated.traffic.read
Beviljas vid anslutning
Visa tjänster

Parametrar

  • serviceIdstringobligatorisk

    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.

  • limitintegervalfri

    > 0 · max 9007199254740991

  • offsetintegervalfri

    min 0 · max 9007199254740991

Get Dedicated Server Activity

get_dedicated_activity
Endast läsning

Read recent dedicated server activity logs.

Behörighet
dedicated.activity.read
Beviljas vid anslutning
Visa tjänster

Parametrar

  • serviceIdstringobligatorisk

    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.

  • limitintegervalfri

    > 0 · max 9007199254740991

  • offsetintegervalfri

    min 0 · max 9007199254740991

Get Dedicated Server Installation

get_dedicated_installation
Endast läsning

Get dedicated server installation status.

Behörighet
dedicated.view
Beviljas vid anslutning
Visa tjänster

Parametrar

  • serviceIdstringobligatorisk

    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
Endast läsning

Get dedicated server installation progress and log.

Behörighet
dedicated.view
Beviljas vid anslutning
Visa tjänster

Parametrar

  • serviceIdstringobligatorisk

    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
Endast läsning

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

Behörighet
dedicated.installation.manage
Beviljas vid anslutning
Full åtkomst

Parametrar

  • serviceIdstringobligatorisk

    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
Endast läsning

Read reverse DNS entries for a dedicated server.

Behörighet
dedicated.network.read
Beviljas vid anslutning
Visa tjänster

Parametrar

  • serviceIdstringobligatorisk

    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
Endast läsning

Get DDoS protection status for a dedicated server.

Behörighet
dedicated.ddos.read
Beviljas vid anslutning
Visa tjänster

Parametrar

  • serviceIdstringobligatorisk

    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.

  • ipAddressstringvalfri

List Dedicated Server DDoS Rules

list_dedicated_ddos_rules
Endast läsning

List DDoS protection rules for a dedicated server.

Behörighet
dedicated.ddos.read
Beviljas vid anslutning
Visa tjänster

Parametrar

  • serviceIdstringobligatorisk

    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.

  • ipAddressstringvalfri

List Dedicated Server DDoS Incidents

list_dedicated_ddos_incidents
Endast läsning

List DDoS incidents for a dedicated server.

Behörighet
dedicated.ddos.read
Beviljas vid anslutning
Visa tjänster

Parametrar

  • serviceIdstringobligatorisk

    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.

  • ipAddressstringvalfri
  • pageintegervalfri

    > 0 · max 9007199254740991

  • pageSizeintegervalfri

    > 0 · max 100

Get Dedicated Server DDoS Bandwidth

get_dedicated_ddos_bandwidth
Endast läsning

Get DDoS bandwidth statistics for a dedicated server.

Behörighet
dedicated.ddos.read
Beviljas vid anslutning
Visa tjänster

Parametrar

  • serviceIdstringobligatorisk

    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.

  • rangestringvalfri
  • ipAddressstringvalfri

Get Dedicated Server Remote Management

get_dedicated_remote_management
Endast läsning

Get dedicated server remote management session state.

Behörighet
dedicated.remote_management.manage
Beviljas vid anslutning
Full åtkomst

Parametrar

  • serviceIdstringobligatorisk

    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
Endast läsning

List custom ISO assets available for a dedicated server.

Behörighet
dedicated.installation.manage
Beviljas vid anslutning
Full åtkomst

Parametrar

  • serviceIdstringobligatorisk

    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
Endast läsning

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

Behörighet
dedicated.reinstall
Beviljas vid anslutning
Full åtkomst

Parametrar

Inga parametrar

Start Dedicated Server

start_dedicated_server
Ändrar dataKräver bekräftelse

Start a dedicated server. Requires confirm=true.

Behörighet
dedicated.power.start
Beviljas vid anslutning
Strömåtgärder

Parametrar

  • serviceIdstringobligatorisk

    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.

  • confirmbooleanvalfri

Stop Dedicated Server

stop_dedicated_server
DestruktivtKräver bekräftelse

Stop a dedicated server. Requires confirm=true.

Behörighet
dedicated.power.stop
Beviljas vid anslutning
Strömåtgärder

Parametrar

  • serviceIdstringobligatorisk

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

  • confirmbooleanvalfri

Restart Dedicated Server

restart_dedicated_server
DestruktivtKräver bekräftelse

Restart a dedicated server. Requires confirm=true.

Behörighet
dedicated.power.restart
Beviljas vid anslutning
Strömåtgärder

Parametrar

  • serviceIdstringobligatorisk

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

  • confirmbooleanvalfri

Reinstall Dedicated Server

reinstall_dedicated_server
DestruktivtKräver bekräftelse

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.

Behörighet
dedicated.reinstall
Beviljas vid anslutning
Full åtkomst

Parametrar

  • serviceIdstringobligatorisk

    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.

  • osTemplateIdstringvalfri

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

  • confirmbooleanvalfri

Wipe Dedicated Server

wipe_dedicated_server
DestruktivtKräver bekräftelse

Wipe a dedicated server. Requires confirm=true.

Behörighet
dedicated.reinstall
Beviljas vid anslutning
Full åtkomst

Parametrar

  • serviceIdstringobligatorisk

    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.

  • confirmbooleanvalfri

Update Dedicated Server Reverse DNS

update_dedicated_reverse_dns
DestruktivtKräver bekräftelse

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

Behörighet
dedicated.network.write
Beviljas vid anslutning
Ändra konfiguration

Parametrar

  • serviceIdstringobligatorisk

    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.

  • ipAddressIdstringvalfri
  • ipv6PrefixAllocationIdstringvalfri
  • hostnamestringvalfri
  • confirmbooleanvalfri

Refresh Dedicated Server Installation

refresh_dedicated_installation
Ändrar dataKräver bekräftelse

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

Behörighet
dedicated.installation.manage
Beviljas vid anslutning
Full åtkomst

Parametrar

  • serviceIdstringobligatorisk

    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.

  • confirmbooleanvalfri

Mount Dedicated Server Install Media

mount_dedicated_install_media
Ändrar dataKräver bekräftelse

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

Behörighet
dedicated.installation.manage
Beviljas vid anslutning
Full åtkomst

Parametrar

  • serviceIdstringobligatorisk

    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.

  • templateIdstringobligatorisk
  • confirmbooleanvalfri

Unmount Dedicated Server Install Media

unmount_dedicated_install_media
Ändrar dataKräver bekräftelse

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

Behörighet
dedicated.installation.manage
Beviljas vid anslutning
Full åtkomst

Parametrar

  • serviceIdstringobligatorisk

    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.

  • confirmbooleanvalfri

Set Dedicated Server Next Boot Device

set_dedicated_next_boot
Ändrar dataKräver bekräftelse

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

Behörighet
dedicated.installation.manage
Beviljas vid anslutning
Full åtkomst

Parametrar

  • serviceIdstringobligatorisk

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

  • confirmbooleanvalfri

Enable Dedicated Server Rescue Mode

enable_dedicated_rescue
DestruktivtKräver bekräftelse

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

Behörighet
dedicated.rescue.manage
Beviljas vid anslutning
Full åtkomst

Parametrar

  • serviceIdstringobligatorisk

    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.

  • templateIdstringobligatorisk
  • confirmbooleanvalfri

Disable Dedicated Server Rescue Mode

disable_dedicated_rescue
DestruktivtKräver bekräftelse

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

Behörighet
dedicated.rescue.manage
Beviljas vid anslutning
Full åtkomst

Parametrar

  • serviceIdstringobligatorisk

    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.

  • confirmbooleanvalfri

Activate Dedicated Server Remote Management

activate_dedicated_remote_management
Ändrar dataKräver bekräftelse

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

Behörighet
dedicated.remote_management.manage
Beviljas vid anslutning
Full åtkomst

Parametrar

  • serviceIdstringobligatorisk

    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.

  • durationHoursintegervalfri

    > 0 · max 9007199254740991

  • confirmbooleanvalfri

Extend Dedicated Server Remote Management

extend_dedicated_remote_management
Ändrar dataKräver bekräftelse

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

Behörighet
dedicated.remote_management.manage
Beviljas vid anslutning
Full åtkomst

Parametrar

  • serviceIdstringobligatorisk

    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.

  • confirmbooleanvalfri

Revoke Dedicated Server Remote Management

revoke_dedicated_remote_management
DestruktivtKräver bekräftelse

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

Behörighet
dedicated.remote_management.manage
Beviljas vid anslutning
Full åtkomst

Parametrar

  • serviceIdstringobligatorisk

    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.

  • confirmbooleanvalfri

Launch Dedicated Server Remote Management

launch_dedicated_remote_management
DestruktivtKräver bekräftelse

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

Behörighet
dedicated.remote_management.manage
Beviljas vid anslutning
Full åtkomst

Parametrar

  • serviceIdstringobligatorisk

    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.

  • confirmbooleanvalfri

Turn Dedicated Server DDoS Protection On or Off

toggle_dedicated_ddos_protection
DestruktivtKräver bekräftelse

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

Behörighet
dedicated.ddos.manage
Beviljas vid anslutning
Ändra konfiguration

Parametrar

  • serviceIdstringobligatorisk

    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.

  • ipAddressstringvalfri
  • enabledbooleanvalfri

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

  • confirmbooleanvalfri

Import Dedicated Server Custom ISO

import_dedicated_custom_iso
Ändrar dataKräver bekräftelse

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

Behörighet
dedicated.installation.manage
Beviljas vid anslutning
Full åtkomst

Parametrar

  • serviceIdstringobligatorisk

    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.

  • displayNamestringobligatorisk
  • sourceUrlstringobligatorisk

    format uri

  • filenamestringvalfri
  • confirmbooleanvalfri

Delete Dedicated Server Custom ISO

delete_dedicated_custom_iso
DestruktivtKräver bekräftelse

Delete a custom ISO asset. Requires confirm=true.

Behörighet
dedicated.installation.manage
Beviljas vid anslutning
Full åtkomst

Parametrar

  • serviceIdstringobligatorisk

    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.

  • assetIdstringobligatorisk
  • confirmbooleanvalfri

Mount Dedicated Server Custom ISO

mount_dedicated_custom_iso
Ändrar dataKräver bekräftelse

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

Behörighet
dedicated.installation.manage
Beviljas vid anslutning
Full åtkomst

Parametrar

  • serviceIdstringobligatorisk

    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.

  • assetIdstringobligatorisk
  • confirmbooleanvalfri

TeamSpeak-servrar

Status, starta och stoppa, inställningar, klienter, bannlysningar och privilege keys.

List TeamSpeak Servers

list_teamspeak_servers
Endast läsningStartpunkt

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

Behörighet
teamspeak.view
Beviljas vid anslutning
Visa tjänster

Parametrar

Inga parametrar

Get TeamSpeak Server

get_teamspeak_server
Endast läsningStartpunkt

Get one TeamSpeak server by ID.

Behörighet
teamspeak.view
Beviljas vid anslutning
Visa tjänster

Parametrar

  • serviceIdstringobligatorisk

    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
Endast läsning

Read TeamSpeak server configuration.

Behörighet
teamspeak.config.read
Beviljas vid anslutning
Läs konfiguration

Parametrar

  • serviceIdstringobligatorisk

    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
DestruktivtKräver bekräftelse

Update TeamSpeak server configuration. Requires confirm=true.

Behörighet
teamspeak.config.manage
Beviljas vid anslutning
Ändra konfiguration

Parametrar

  • serviceIdstringobligatorisk

    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>obligatorisk
  • confirmbooleanvalfri

List TeamSpeak Privilege Keys

list_teamspeak_tokens
Endast läsning

List privilege tokens for a TeamSpeak server.

Behörighet
teamspeak.tokens.manage
Beviljas vid anslutning
TeamSpeak-hantering

Parametrar

  • serviceIdstringobligatorisk

    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
DestruktivtKräver bekräftelse

Create a TeamSpeak privilege token. Requires confirm=true.

Behörighet
teamspeak.tokens.manage
Beviljas vid anslutning
TeamSpeak-hantering

Parametrar

  • serviceIdstringobligatorisk

    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.

  • descriptionstringvalfri

    max length 100

  • confirmbooleanvalfri

Start TeamSpeak Server

start_teamspeak_server
Ändrar dataKräver bekräftelse

Start a TeamSpeak server. Requires confirm=true.

Behörighet
teamspeak.power.start
Beviljas vid anslutning
Strömåtgärder

Parametrar

  • serviceIdstringobligatorisk

    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.

  • confirmbooleanvalfri

Stop TeamSpeak Server

stop_teamspeak_server
DestruktivtKräver bekräftelse

Stop a TeamSpeak server. Requires confirm=true.

Behörighet
teamspeak.power.stop
Beviljas vid anslutning
Strömåtgärder

Parametrar

  • serviceIdstringobligatorisk

    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.

  • confirmbooleanvalfri

Restart TeamSpeak Server

restart_teamspeak_server
DestruktivtKräver bekräftelse

Restart a TeamSpeak server. Requires confirm=true.

Behörighet
teamspeak.power.restart
Beviljas vid anslutning
Strömåtgärder

Parametrar

  • serviceIdstringobligatorisk

    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.

  • confirmbooleanvalfri

Get TeamSpeak Metrics

get_teamspeak_metrics
Endast läsning

Get TeamSpeak server metrics.

Behörighet
teamspeak.metrics.read
Beviljas vid anslutning
Visa tjänster

Parametrar

  • serviceIdstringobligatorisk

    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
Endast läsning

List connected TeamSpeak clients.

Behörighet
teamspeak.clients.manage
Beviljas vid anslutning
TeamSpeak-hantering

Parametrar

  • serviceIdstringobligatorisk

    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
Endast läsning

List TeamSpeak server bans.

Behörighet
teamspeak.bans.manage
Beviljas vid anslutning
TeamSpeak-hantering

Parametrar

  • serviceIdstringobligatorisk

    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
Ändrar dataKräver bekräftelse

Add a TeamSpeak ban. Requires confirm=true.

Behörighet
teamspeak.bans.manage
Beviljas vid anslutning
TeamSpeak-hantering

Parametrar

  • serviceIdstringobligatorisk

    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.

  • ipstringvalfri
  • uidstringvalfri
  • namestringvalfri
  • timenumbervalfri
  • reasonstringvalfri
  • confirmbooleanvalfri

Delete TeamSpeak Ban

delete_teamspeak_ban
DestruktivtKräver bekräftelse

Delete a TeamSpeak ban. Requires confirm=true.

Behörighet
teamspeak.bans.manage
Beviljas vid anslutning
TeamSpeak-hantering

Parametrar

  • serviceIdstringobligatorisk

    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.

  • banIdintegerobligatorisk

    > 0 · max 9007199254740991

  • confirmbooleanvalfri

Delete TeamSpeak Privilege Key

delete_teamspeak_token
DestruktivtKräver bekräftelse

Delete a TeamSpeak privilege token. Requires confirm=true.

Behörighet
teamspeak.tokens.manage
Beviljas vid anslutning
TeamSpeak-hantering

Parametrar

  • serviceIdstringobligatorisk

    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.

  • tokenstringobligatorisk
  • confirmbooleanvalfri

Discord-bottar

Status, konsol, starta och stoppa samt aktiviteten för dina Discord-bottar.

List Discord Bots

list_discord_bots
Endast läsningStartpunkt

List Discord bots accessible with the current token.

Behörighet
discord_bot.view
Beviljas vid anslutning
Visa tjänster

Parametrar

Inga parametrar

Get Discord Bot

get_discord_bot
Endast läsningStartpunkt

Get Discord bot details.

Behörighet
discord_bot.view
Beviljas vid anslutning
Visa tjänster

Parametrar

  • serviceIdstringobligatorisk

    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
Endast läsning

Get Discord bot container and port reachability status.

Behörighet
discord_bot.view
Beviljas vid anslutning
Visa tjänster

Parametrar

  • serviceIdstringobligatorisk

    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
Endast läsning

Read recent Discord bot activity logs.

Behörighet
discord_bot.view
Beviljas vid anslutning
Visa tjänster

Parametrar

  • serviceIdstringobligatorisk

    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.

  • limitintegervalfri

    min 1 · max 100

  • offsetintegervalfri

    min 0 · max 9007199254740991

Start Discord Bot

start_discord_bot
Ändrar dataKräver bekräftelse

Start a Discord bot. Requires confirm=true.

Behörighet
discord_bot.start
Beviljas vid anslutning
Strömåtgärder

Parametrar

  • serviceIdstringobligatorisk

    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.

  • confirmbooleanvalfri

Stop Discord Bot

stop_discord_bot
DestruktivtKräver bekräftelse

Stop a Discord bot. Requires confirm=true.

Behörighet
discord_bot.stop
Beviljas vid anslutning
Strömåtgärder

Parametrar

  • serviceIdstringobligatorisk

    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.

  • confirmbooleanvalfri

Restart Discord Bot

restart_discord_bot
DestruktivtKräver bekräftelse

Restart a Discord bot. Requires confirm=true.

Behörighet
discord_bot.restart
Beviljas vid anslutning
Strömåtgärder

Parametrar

  • serviceIdstringobligatorisk

    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.

  • confirmbooleanvalfri

Get Discord Bot Console Logs

get_discord_bot_console_logs
Endast läsning

Get recent Discord bot console log lines.

Behörighet
discord_bot.console.read
Beviljas vid anslutning
Konsol och loggar

Parametrar

  • serviceIdstringobligatorisk

    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.

  • linesintegervalfri

    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
DestruktivtKräver bekräftelse

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

Behörighet
discord_bot.console.write
Beviljas vid anslutning
Konsol och loggar

Parametrar

  • serviceIdstringobligatorisk

    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.

  • commandstringobligatorisk

    max length 500

  • confirmbooleanvalfri

Domäner

Domäner, DNS-poster, namnservrar, parkeringssida och automatisk förnyelse.

List Domains

list_domains
Endast läsningStartpunkt

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.

Behörighet
domain.view
Beviljas vid anslutning
Visa tjänster

Parametrar

Inga parametrar

Get Domain

get_domain
Endast läsning

Get one domain by ID. Read-only.

Behörighet
domain.view
Beviljas vid anslutning
Visa tjänster

Parametrar

  • domainIdstringobligatorisk

    Domain id (from list_domains or list_account_services).

Get Domain DNS Records

get_domain_dns_records
Endast läsningStartpunkt

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.

Behörighet
domain.dns.read
Beviljas vid anslutning
Läs konfiguration

Parametrar

  • domainIdstringobligatorisk

    Domain id (from list_domains or list_account_services).

Create Domain DNS Record

create_domain_dns_record
Ändrar dataKräver bekräftelse

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.

Behörighet
domain.dns.write
Beviljas vid anslutning
Domänhantering

Parametrar

  • domainIdstringobligatorisk

    Domain id (from list_domains or list_account_services).

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

    Record type.

  • namestringvalfri

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

    max length 253

  • contentstringobligatorisk

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

    max length 4096

  • ttlintegervalfri

    TTL in seconds (default 3600, min 60).

    min 60 · max 9007199254740991

  • priorityintegervalfri

    MX/SRV priority.

    min 0 · max 65535

  • weightintegervalfri

    SRV weight.

    min 0 · max 65535

  • portintegervalfri

    SRV port.

    min 0 · max 65535

  • confirmbooleanvalfri

    Must be true to apply the change.

Update Domain DNS Record

update_domain_dns_record
DestruktivtKräver bekräftelse

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.

Behörighet
domain.dns.write
Beviljas vid anslutning
Domänhantering

Parametrar

  • domainIdstringobligatorisk

    Domain id (from list_domains or list_account_services).

  • recordIdstringobligatorisk

    Record id from get_domain_dns_records.

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

    Record type.

  • namestringvalfri

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

    max length 253

  • contentstringobligatorisk

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

    max length 4096

  • ttlintegervalfri

    TTL in seconds (default 3600, min 60).

    min 60 · max 9007199254740991

  • priorityintegervalfri

    MX/SRV priority.

    min 0 · max 65535

  • weightintegervalfri

    SRV weight.

    min 0 · max 65535

  • portintegervalfri

    SRV port.

    min 0 · max 65535

  • confirmbooleanvalfri

    Must be true to apply the change.

Delete Domain DNS Record

delete_domain_dns_record
DestruktivtKräver bekräftelse

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.

Behörighet
domain.dns.write
Beviljas vid anslutning
Domänhantering

Parametrar

  • domainIdstringobligatorisk

    Domain id (from list_domains or list_account_services).

  • recordIdstringobligatorisk

    Record id from get_domain_dns_records.

  • confirmbooleanvalfri

    Must be true to apply the change.

Set Domain Parking Page

set_domain_parking_page
DestruktivtKräver bekräftelse

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.

Behörighet
domain.dns.write
Beviljas vid anslutning
Domänhantering

Parametrar

  • domainIdstringobligatorisk

    Domain id (from list_domains or list_account_services).

  • enabledbooleanobligatorisk

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

  • confirmedReplaceRecordIdsstring[]valfri

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

    max items 200

  • confirmbooleanvalfri

    Must be true to apply the change.

Get Domain Nameservers

get_domain_nameservers
Endast läsning

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

Behörighet
domain.dns.read
Beviljas vid anslutning
Läs konfiguration

Parametrar

  • domainIdstringobligatorisk

    Domain id (from list_domains or list_account_services).

Set Domain Nameservers

set_domain_nameservers
DestruktivtKräver bekräftelse

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.

Behörighet
domain.nameservers.write
Beviljas vid anslutning
Domänhantering

Parametrar

  • domainIdstringobligatorisk

    Domain id (from list_domains or list_account_services).

  • mode"managed" | "external"obligatorisk

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

  • nameserversstring[]valfri

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

    min items 2 · max items 13

  • confirmbooleanvalfri

    Must be true to apply the change.

Get Domain Renewal Status

get_domain_renewal
Endast läsning

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

Behörighet
domain.view
Beviljas vid anslutning
Visa tjänster

Parametrar

  • domainIdstringobligatorisk

    Domain id (from list_domains or list_account_services).

Set Domain Auto-Renew

set_domain_auto_renew
DestruktivtKräver bekräftelse

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.

Behörighet
domain.renewal.manage
Beviljas vid anslutning
Domänhantering

Parametrar

  • domainIdstringobligatorisk

    Domain id (from list_domains or list_account_services).

  • autoRenewbooleanobligatorisk

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

  • confirmbooleanvalfri

    Must be true to apply the change.

Filer

Lista, läsa, skriva, byta namn på och ta bort filer på spelservrar och Discord-bottar.

List Discord Bot Files

list_discord_bot_files
Endast läsningStartpunkt

List files in a Discord bot directory.

Behörighet
discord_bot.files.read
Beviljas vid anslutning
Läs konfiguration

Parametrar

  • serviceIdstringobligatorisk

    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.

  • pathstringvalfri
  • includeFolderSizesbooleanvalfri

Read Discord Bot File

read_discord_bot_file
Endast läsning

Read an editable text file from a Discord bot.

Behörighet
discord_bot.files.read
Beviljas vid anslutning
Läs konfiguration

Parametrar

  • serviceIdstringobligatorisk

    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.

  • pathstringobligatorisk

Edit Discord Bot File

mutate_discord_bot_file
DestruktivtKräver bekräftelse

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

Behörighet
discord_bot.files.write
Beviljas vid anslutning
Ändra konfiguration

Parametrar

  • serviceIdstringobligatorisk

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

  • pathstringobligatorisk
  • contentstringvalfri
  • expectedRevisionstringvalfri

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

  • newNamestringvalfri
  • confirmbooleanvalfri

List Game Server Files

list_gameserver_files
Endast läsningStartpunkt

List files in a gameserver directory.

Behörighet
gameserver.files.read
Beviljas vid anslutning
Läs konfiguration

Parametrar

  • serviceIdstringobligatorisk

    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.

  • pathstringvalfri
  • scope"savegame" | "config" | "active"valfri

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

  • includeFolderSizesbooleanvalfri

Read Game Server File

read_gameserver_file
Endast läsning

Read text content of a gameserver file.

Behörighet
gameserver.files.read
Beviljas vid anslutning
Läs konfiguration

Parametrar

  • serviceIdstringobligatorisk

    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.

  • pathstringobligatorisk
  • scope"savegame" | "config" | "active"valfri

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

Edit Game Server File

mutate_gameserver_file
DestruktivtKräver bekräftelse

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.

Behörighet
gameserver.files.write
Beviljas vid anslutning
Ändra konfiguration

Parametrar

  • serviceIdstringobligatorisk

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

  • pathstringvalfri

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

  • contentstringvalfri
  • expectedRevisionstringvalfri

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

  • newNamestringvalfri
  • pathsstring[]valfri

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

    min items 1 · max items 100

  • destinationstringvalfri

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

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

  • confirmbooleanvalfri

Appar med ett klick (VPS och dedikerade)

Appkatalog (Pterodactyl, Nextcloud, n8n, ...), installation, start/stopp/omstart, loggar och avinstallation; spelservrar i Pterodactyl skapas i dess egen panel.

List VPS One-Click Apps

get_vserver_apps
Endast läsningStartpunkt

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.

Behörighet
vserver.apps.read
Beviljas vid anslutning
Läs konfiguration

Parametrar

  • serviceIdstringobligatorisk

    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.

  • livebooleanvalfri

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

Search VPS App Catalog

list_vserver_app_catalog
Endast läsning

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

Behörighet
vserver.apps.read
Beviljas vid anslutning
Läs konfiguration

Parametrar

  • serviceIdstringobligatorisk

    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.

  • searchstringvalfri

    Free text search over name, description and tags.

    max length 200

  • categorystringvalfri

    max length 100

  • pageintegervalfri

    > 0 · max 9007199254740991

  • pageSizeintegervalfri

    > 0 · max 50

Get VPS App Catalog Entry

get_vserver_app_catalog_entry
Endast läsning

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

Behörighet
vserver.apps.read
Beviljas vid anslutning
Läs konfiguration

Parametrar

  • serviceIdstringobligatorisk

    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.

  • catalogTypestringobligatorisk

    max length 128

Get VPS App Logs

get_vserver_app_logs
Endast läsning

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

Behörighet
vserver.apps.read
Beviljas vid anslutning
Läs konfiguration

Parametrar

  • serviceIdstringobligatorisk

    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.

  • installationIdstringobligatorisk

    Installation id from get_vserver_apps / get_dedicated_apps.

    max length 64

  • linesintegervalfri

    min 50 · max 500

Install VPS One-Click App

install_vserver_app
Ändrar dataKräver bekräftelse

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.

Behörighet
vserver.apps.manage
Beviljas vid anslutning
Ändra konfiguration

Parametrar

  • serviceIdstringobligatorisk

    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.

  • catalogTypestringobligatorisk

    Catalog type from the app catalog.

    max length 128

  • displayNamestringobligatorisk

    min length 2 · max length 80

  • envValuesRecord<string, string>valfri

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

  • customEnvsobject[]valfri

    max items 50

  • confirmbooleanvalfri
  • withoutHostnamebooleanvalfri

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

Start, Stop or Restart VPS App

manage_vserver_app
DestruktivtKräver bekräftelse

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

Behörighet
vserver.apps.manage
Beviljas vid anslutning
Ändra konfiguration

Parametrar

  • serviceIdstringobligatorisk

    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.

  • installationIdstringobligatorisk

    Installation id from get_vserver_apps / get_dedicated_apps.

    max length 64

  • action"start" | "stop" | "restart"obligatorisk

  • confirmbooleanvalfri

Uninstall VPS One-Click App

uninstall_vserver_app
DestruktivtKräver bekräftelse

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

Behörighet
vserver.apps.manage
Beviljas vid anslutning
Ändra konfiguration

Parametrar

  • serviceIdstringobligatorisk

    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.

  • installationIdstringobligatorisk

    Installation id from get_vserver_apps / get_dedicated_apps.

    max length 64

  • deleteVolumesbooleanvalfri

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

  • confirmbooleanvalfri

Reinstall VPS One-Click App

reinstall_vserver_app
DestruktivtKräver bekräftelse

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

Behörighet
vserver.apps.manage
Beviljas vid anslutning
Ändra konfiguration

Parametrar

  • serviceIdstringobligatorisk

    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.

  • installationIdstringobligatorisk

    Installation id from get_vserver_apps / get_dedicated_apps.

    max length 64

  • deleteVolumesbooleanvalfri

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

  • confirmbooleanvalfri

List Dedicated Server One-Click Apps

get_dedicated_apps
Endast läsningStartpunkt

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.

Behörighet
dedicated.apps.read
Beviljas vid anslutning
Läs konfiguration

Parametrar

  • serviceIdstringobligatorisk

    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.

  • livebooleanvalfri

    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
Endast läsning

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.

Behörighet
dedicated.apps.read
Beviljas vid anslutning
Läs konfiguration

Parametrar

  • serviceIdstringobligatorisk

    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.

  • searchstringvalfri

    Free text search over name, description and tags.

    max length 200

  • categorystringvalfri

    max length 100

  • pageintegervalfri

    > 0 · max 9007199254740991

  • pageSizeintegervalfri

    > 0 · max 50

Get Dedicated Server App Catalog Entry

get_dedicated_app_catalog_entry
Endast läsning

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

Behörighet
dedicated.apps.read
Beviljas vid anslutning
Läs konfiguration

Parametrar

  • serviceIdstringobligatorisk

    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.

  • catalogTypestringobligatorisk

    max length 128

Get Dedicated Server App Logs

get_dedicated_app_logs
Endast läsning

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

Behörighet
dedicated.apps.read
Beviljas vid anslutning
Läs konfiguration

Parametrar

  • serviceIdstringobligatorisk

    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.

  • installationIdstringobligatorisk

    Installation id from get_vserver_apps / get_dedicated_apps.

    max length 64

  • linesintegervalfri

    min 50 · max 500

Install Dedicated Server One-Click App

install_dedicated_app
Ändrar dataKräver bekräftelse

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.

Behörighet
dedicated.apps.manage
Beviljas vid anslutning
Ändra konfiguration

Parametrar

  • serviceIdstringobligatorisk

    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.

  • catalogTypestringobligatorisk

    Catalog type from the app catalog.

    max length 128

  • displayNamestringobligatorisk

    min length 2 · max length 80

  • envValuesRecord<string, string>valfri

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

  • customEnvsobject[]valfri

    max items 50

  • confirmbooleanvalfri

Start, Stop or Restart Dedicated Server App

manage_dedicated_app
DestruktivtKräver bekräftelse

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

Behörighet
dedicated.apps.manage
Beviljas vid anslutning
Ändra konfiguration

Parametrar

  • serviceIdstringobligatorisk

    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.

  • installationIdstringobligatorisk

    Installation id from get_vserver_apps / get_dedicated_apps.

    max length 64

  • action"start" | "stop" | "restart"obligatorisk

  • confirmbooleanvalfri

Uninstall Dedicated Server One-Click App

uninstall_dedicated_app
DestruktivtKräver bekräftelse

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

Behörighet
dedicated.apps.manage
Beviljas vid anslutning
Ändra konfiguration

Parametrar

  • serviceIdstringobligatorisk

    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.

  • installationIdstringobligatorisk

    Installation id from get_vserver_apps / get_dedicated_apps.

    max length 64

  • deleteVolumesbooleanvalfri

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

  • confirmbooleanvalfri

Reinstall Dedicated Server One-Click App

reinstall_dedicated_app
DestruktivtKräver bekräftelse

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

Behörighet
dedicated.apps.manage
Beviljas vid anslutning
Ändra konfiguration

Parametrar

  • serviceIdstringobligatorisk

    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.

  • installationIdstringobligatorisk

    Installation id from get_vserver_apps / get_dedicated_apps.

    max length 64

  • deleteVolumesbooleanvalfri

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

  • confirmbooleanvalfri

Säkerhetskopior och snapshots

Skapa, återställa och ta bort säkerhetskopior och snapshots.

List Game Server Backups

list_gameserver_backups
Endast läsningStartpunkt

List gameserver backups.

Behörighet
gameserver.backups.read
Beviljas vid anslutning
Läs konfiguration

Parametrar

  • serviceIdstringobligatorisk

    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
DestruktivtKräver bekräftelse

Create a gameserver backup. Requires confirm=true.

Behörighet
gameserver.backups.manage
Beviljas vid anslutning
Ändra konfiguration

Parametrar

  • serviceIdstringobligatorisk

    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.

  • namestringvalfri

    max length 120

  • confirmbooleanvalfri

Delete Game Server Backup

delete_gameserver_backup
DestruktivtKräver bekräftelse

Delete a gameserver backup. Requires confirm=true.

Behörighet
gameserver.backups.manage
Beviljas vid anslutning
Ändra konfiguration

Parametrar

  • serviceIdstringobligatorisk

    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.

  • backupIdstringobligatorisk
  • confirmbooleanvalfri

Restore Game Server Backup

restore_gameserver_backup
DestruktivtKräver bekräftelse

Restore a gameserver backup. Requires confirm=true.

Behörighet
gameserver.backups.manage
Beviljas vid anslutning
Ändra konfiguration

Parametrar

  • serviceIdstringobligatorisk

    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.

  • backupIdstringobligatorisk
  • confirmbooleanvalfri

List VPS Backups

list_vserver_backups
Endast läsningStartpunkt

List VPS backups.

Behörighet
vserver.backups.read
Beviljas vid anslutning
Läs konfiguration

Parametrar

  • serviceIdstringobligatorisk

    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
Endast läsning

List VPS VM snapshots.

Behörighet
vserver.backups.read
Beviljas vid anslutning
Läs konfiguration

Parametrar

  • serviceIdstringobligatorisk

    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
Ändrar dataKräver bekräftelse

Create a VPS VM snapshot. Requires confirm=true.

Behörighet
vserver.backups.manage
Beviljas vid anslutning
Ändra konfiguration

Parametrar

  • serviceIdstringobligatorisk

    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.

  • namestringobligatorisk
  • descriptionstringvalfri
  • includeRambooleanvalfri
  • confirmbooleanvalfri

Delete VPS Snapshot

delete_vserver_snapshot
DestruktivtKräver bekräftelse

Delete a VPS VM snapshot. Requires confirm=true.

Behörighet
vserver.backups.manage
Beviljas vid anslutning
Ändra konfiguration

Parametrar

  • serviceIdstringobligatorisk

    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.

  • namestringobligatorisk
  • confirmbooleanvalfri

Roll Back VPS to Snapshot

rollback_vserver_snapshot
DestruktivtKräver bekräftelse

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

Behörighet
vserver.backups.manage
Beviljas vid anslutning
Ändra konfiguration

Parametrar

  • serviceIdstringobligatorisk

    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.

  • namestringobligatorisk
  • confirmbooleanvalfri

Create VPS Backup

create_vserver_backup
Ändrar dataKräver bekräftelse

Create a VPS backup. Requires confirm=true.

Behörighet
vserver.backups.manage
Beviljas vid anslutning
Ändra konfiguration

Parametrar

  • serviceIdstringobligatorisk

    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.

  • notesstringvalfri

    max length 500

  • confirmbooleanvalfri

Delete VPS Backup

delete_vserver_backup
DestruktivtKräver bekräftelse

Delete a VPS backup. Requires confirm=true.

Behörighet
vserver.backups.manage
Beviljas vid anslutning
Ändra konfiguration

Parametrar

  • serviceIdstringobligatorisk

    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.

  • backupIdstringobligatorisk
  • confirmbooleanvalfri

Restore VPS Backup

restore_vserver_backup
DestruktivtKräver bekräftelse

Restore a VPS backup. Requires confirm=true.

Behörighet
vserver.backups.manage
Beviljas vid anslutning
Ändra konfiguration

Parametrar

  • serviceIdstringobligatorisk

    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.

  • backupIdstringobligatorisk
  • confirmbooleanvalfri

Planbyten

Uppgraderingar och nedgraderingar med prisförhandsvisning, som bara genomförs efter din uttryckliga bekräftelse.

Get Game Server Plan Change Options

get_gameserver_plan_change_options
Endast läsningStartpunktInte i ChatGPT- och Claude-connectorn

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.

Beställningar och planbyten är dolda i connectorerna från ChatGPT:s och Claudes appkataloger. I Claude Code, Cursor och med en API-nyckel är verktyget tillgängligt.

Behörighet
gameserver.plan_change
Beviljas vid anslutning
Planändringar

Parametrar

  • serviceIdstringobligatorisk

    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
Endast läsningInte i ChatGPT- och Claude-connectorn

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.

Beställningar och planbyten är dolda i connectorerna från ChatGPT:s och Claudes appkataloger. I Claude Code, Cursor och med en API-nyckel är verktyget tillgängligt.

Behörighet
gameserver.plan_change
Beviljas vid anslutning
Planändringar

Parametrar

  • serviceIdstringobligatorisk

    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.

  • targetobjectvalfri
  • target.pricingMode"package" | "custom"valfri

  • target.targetPackageKeystringvalfri
  • target.ramMbintegervalfri

    > 0 · max 9007199254740991

  • target.cpuMillisintegervalfri

    > 0 · max 9007199254740991

  • target.diskMbintegervalfri

    > 0 · max 9007199254740991

  • target.slotsintegervalfri

    > 0 · max 9007199254740991

  • target.dedicatedIpbooleanvalfri
  • target.premiumCpubooleanvalfri

    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.targetRegionIdstringvalfri
  • target.targetBillingIntervalCountintegervalfri

    > 0 · max 9007199254740991

  • couponCodestringvalfri

    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
DestruktivtKräver bekräftelseInte i ChatGPT- och Claude-connectorn

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.

Beställningar och planbyten är dolda i connectorerna från ChatGPT:s och Claudes appkataloger. I Claude Code, Cursor och med en API-nyckel är verktyget tillgängligt.

Behörighet
gameserver.plan_change
Beviljas vid anslutning
Planändringar

Parametrar

  • serviceIdstringobligatorisk

    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.

  • targetobjectvalfri
  • target.pricingMode"package" | "custom"valfri

  • target.targetPackageKeystringvalfri
  • target.ramMbintegervalfri

    > 0 · max 9007199254740991

  • target.cpuMillisintegervalfri

    > 0 · max 9007199254740991

  • target.diskMbintegervalfri

    > 0 · max 9007199254740991

  • target.slotsintegervalfri

    > 0 · max 9007199254740991

  • target.dedicatedIpbooleanvalfri
  • target.premiumCpubooleanvalfri

    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.targetRegionIdstringvalfri
  • target.targetBillingIntervalCountintegervalfri

    > 0 · max 9007199254740991

  • couponCodestringvalfri

    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

  • confirmtrueobligatorisk
  • userExplicitlyConfirmedtrueobligatorisk
  • previewConfirmationNoncestringobligatorisk
  • requestImmediateStartbooleanvalfri

    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
Endast läsning

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.

Behörighet
vserver.plan_change
Beviljas vid anslutning
Planändringar

Parametrar

  • serviceIdstringobligatorisk

    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
Endast läsning

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.

Behörighet
vserver.plan_change
Beviljas vid anslutning
Planändringar

Parametrar

  • serviceIdstringobligatorisk

    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.

  • targetobjectvalfri
  • target.pricingMode"package" | "custom"valfri

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

  • target.targetPackageKeystringvalfri
  • target.coresintegervalfri

    > 0 · max 9007199254740991

  • target.memoryMbintegervalfri

    > 0 · max 9007199254740991

  • target.diskGbintegervalfri

    > 0 · max 9007199254740991

  • target.bandwidthMbpsintegervalfri

    > 0 · max 9007199254740991

  • target.memoryintegervalfri

    > 0 · max 9007199254740991

  • target.diskintegervalfri

    > 0 · max 9007199254740991

  • target.bandwidthintegervalfri

    > 0 · max 9007199254740991

  • target.additionalIpCountintegervalfri

    min 0 · max 9007199254740991

  • target.targetBillingIntervalCountintegervalfri

    > 0 · max 9007199254740991

  • couponCodestringvalfri

    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
DestruktivtKräver bekräftelse

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.

Behörighet
vserver.plan_change
Beviljas vid anslutning
Planändringar

Parametrar

  • serviceIdstringobligatorisk

    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.

  • targetobjectvalfri
  • target.pricingMode"package" | "custom"valfri

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

  • target.targetPackageKeystringvalfri
  • target.coresintegervalfri

    > 0 · max 9007199254740991

  • target.memoryMbintegervalfri

    > 0 · max 9007199254740991

  • target.diskGbintegervalfri

    > 0 · max 9007199254740991

  • target.bandwidthMbpsintegervalfri

    > 0 · max 9007199254740991

  • target.memoryintegervalfri

    > 0 · max 9007199254740991

  • target.diskintegervalfri

    > 0 · max 9007199254740991

  • target.bandwidthintegervalfri

    > 0 · max 9007199254740991

  • target.additionalIpCountintegervalfri

    min 0 · max 9007199254740991

  • target.targetBillingIntervalCountintegervalfri

    > 0 · max 9007199254740991

  • couponCodestringvalfri

    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

  • confirmtrueobligatorisk
  • userExplicitlyConfirmedtrueobligatorisk
  • previewConfirmationNoncestringobligatorisk
  • requestImmediateStartbooleanvalfri

    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
Endast läsningInte i ChatGPT- och Claude-connectorn

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.

Beställningar och planbyten är dolda i connectorerna från ChatGPT:s och Claudes appkataloger. I Claude Code, Cursor och med en API-nyckel är verktyget tillgängligt.

Behörighet
teamspeak.plan_change
Beviljas vid anslutning
Planändringar

Parametrar

  • serviceIdstringobligatorisk

    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
Endast läsningInte i ChatGPT- och Claude-connectorn

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.

Beställningar och planbyten är dolda i connectorerna från ChatGPT:s och Claudes appkataloger. I Claude Code, Cursor och med en API-nyckel är verktyget tillgängligt.

Behörighet
teamspeak.plan_change
Beviljas vid anslutning
Planändringar

Parametrar

  • serviceIdstringobligatorisk

    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.

  • targetobjectvalfri
  • target.pricingMode"package" | "custom"valfri

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

  • target.targetPackageKeystringvalfri
  • target.slotsintegervalfri

    > 0 · max 9007199254740991

  • target.hasAdvertisementbooleanvalfri
  • target.targetBillingIntervalCountintegervalfri

    > 0 · max 9007199254740991

  • couponCodestringvalfri

    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
DestruktivtKräver bekräftelseInte i ChatGPT- och Claude-connectorn

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.

Beställningar och planbyten är dolda i connectorerna från ChatGPT:s och Claudes appkataloger. I Claude Code, Cursor och med en API-nyckel är verktyget tillgängligt.

Behörighet
teamspeak.plan_change
Beviljas vid anslutning
Planändringar

Parametrar

  • serviceIdstringobligatorisk

    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.

  • targetobjectvalfri
  • target.pricingMode"package" | "custom"valfri

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

  • target.targetPackageKeystringvalfri
  • target.slotsintegervalfri

    > 0 · max 9007199254740991

  • target.hasAdvertisementbooleanvalfri
  • target.targetBillingIntervalCountintegervalfri

    > 0 · max 9007199254740991

  • couponCodestringvalfri

    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

  • confirmtrueobligatorisk
  • userExplicitlyConfirmedtrueobligatorisk
  • previewConfirmationNoncestringobligatorisk
  • requestImmediateStartbooleanvalfri

    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
Endast läsningInte i ChatGPT- och Claude-connectorn

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.

Beställningar och planbyten är dolda i connectorerna från ChatGPT:s och Claudes appkataloger. I Claude Code, Cursor och med en API-nyckel är verktyget tillgängligt.

Behörighet
dedicated.plan_change
Beviljas vid anslutning
Planändringar

Parametrar

  • serviceIdstringobligatorisk

    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
Endast läsningInte i ChatGPT- och Claude-connectorn

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.

Beställningar och planbyten är dolda i connectorerna från ChatGPT:s och Claudes appkataloger. I Claude Code, Cursor och med en API-nyckel är verktyget tillgängligt.

Behörighet
dedicated.plan_change
Beviljas vid anslutning
Planändringar

Parametrar

  • serviceIdstringobligatorisk

    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.

  • targetobjectvalfri
  • target.additionalIpCountintegervalfri

    min 0 · max 9007199254740991

  • target.releaseIpAssignmentIdsstring[]valfri
  • couponCodestringvalfri

    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
DestruktivtKräver bekräftelseInte i ChatGPT- och Claude-connectorn

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.

Beställningar och planbyten är dolda i connectorerna från ChatGPT:s och Claudes appkataloger. I Claude Code, Cursor och med en API-nyckel är verktyget tillgängligt.

Behörighet
dedicated.plan_change
Beviljas vid anslutning
Planändringar

Parametrar

  • serviceIdstringobligatorisk

    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.

  • targetobjectvalfri
  • target.additionalIpCountintegervalfri

    min 0 · max 9007199254740991

  • target.releaseIpAssignmentIdsstring[]valfri
  • couponCodestringvalfri

    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

  • confirmtrueobligatorisk
  • userExplicitlyConfirmedtrueobligatorisk
  • previewConfirmationNoncestringobligatorisk
  • requestImmediateStartbooleanvalfri

    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
Endast läsningStartpunkt

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

Behörighet
gameserver.plan_changevserver.plan_changeteamspeak.plan_changededicated.plan_change
Beviljas vid anslutning
Planändringar

Parametrar

  • changeIdstringobligatorisk

Beställning

Beställningsbara produkter, planer, regioner, spel och ISO-avbilder samt prisförhandsvisning av en beställning.

List Orderable Products

list_orderable_products
Endast läsningStartpunktInte i ChatGPT- och Claude-connectorn

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.

Beställningar och planbyten är dolda i connectorerna från ChatGPT:s och Claudes appkataloger. I Claude Code, Cursor och med en API-nyckel är verktyget tillgängligt.

Behörighet
orders.view
Beviljas vid anslutning
Beställningskatalog och förhandsvisning

Parametrar

Inga parametrar

List Orderable Plans

list_orderable_plans
Endast läsningInte i ChatGPT- och Claude-connectorn

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.

Beställningar och planbyten är dolda i connectorerna från ChatGPT:s och Claudes appkataloger. I Claude Code, Cursor och med en API-nyckel är verktyget tillgängligt.

Behörighet
orders.view
Beviljas vid anslutning
Beställningskatalog och förhandsvisning

Parametrar

  • productSlugstringobligatorisk

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

List Regions for an Orderable Product

list_orderable_product_regions
Endast läsningInte i ChatGPT- och Claude-connectorn

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.

Beställningar och planbyten är dolda i connectorerna från ChatGPT:s och Claudes appkataloger. I Claude Code, Cursor och med en API-nyckel är verktyget tillgängligt.

Behörighet
orders.view
Beviljas vid anslutning
Beställningskatalog och förhandsvisning

Parametrar

  • productSlugstringobligatorisk

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

List Order Regions

list_order_regions
Endast läsningInte i ChatGPT- och Claude-connectorn

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.

Beställningar och planbyten är dolda i connectorerna från ChatGPT:s och Claudes appkataloger. I Claude Code, Cursor och med en API-nyckel är verktyget tillgängligt.

Behörighet
orders.view
Beviljas vid anslutning
Beställningskatalog och förhandsvisning

Parametrar

Inga parametrar

List Orderable Games

list_orderable_games
Endast läsningInte i ChatGPT- och Claude-connectorn

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.

Beställningar och planbyten är dolda i connectorerna från ChatGPT:s och Claudes appkataloger. I Claude Code, Cursor och med en API-nyckel är verktyget tillgängligt.

Behörighet
orders.view
Beviljas vid anslutning
Beställningskatalog och förhandsvisning

Parametrar

Inga parametrar

List ISO Images for VPS Orders

list_vserver_order_isos
Endast läsningInte i ChatGPT- och Claude-connectorn

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.

Beställningar och planbyten är dolda i connectorerna från ChatGPT:s och Claudes appkataloger. I Claude Code, Cursor och med en API-nyckel är verktyget tillgängligt.

Behörighet
orders.view
Beviljas vid anslutning
Beställningskatalog och förhandsvisning

Parametrar

Inga parametrar

Preview Order Price

preview_order
Endast läsningStartpunktInte i ChatGPT- och Claude-connectorn

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.

Beställningar och planbyten är dolda i connectorerna från ChatGPT:s och Claudes appkataloger. I Claude Code, Cursor och med en API-nyckel är verktyget tillgängligt.

Behörighet
orders.view
Beviljas vid anslutning
Beställningskatalog och förhandsvisning

Parametrar

  • productSlugstringobligatorisk

    Product slug from list_orderable_products.

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

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

  • planSlugstringvalfri

    Plan slug from list_orderable_plans (products with fixed plans).

  • gameSlugstringvalfri

    Game slug from list_orderable_games (gameservers).

  • regionSlugstringvalfri

    Region slug from list_orderable_product_regions (products with region choice).

  • resourceConfigRecord<string, number>valfri

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

  • optionsobjectvalfri
  • options.couponCodestringvalfri
  • options.dedicatedIpCountintegervalfri

    min 0 · max 9007199254740991

  • options.domainAttachmentobjectvalfri
  • configurationRecord<string, any>valfri

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

  • domainsobject[]valfri

Get Order Status

get_order_status
Endast läsningInte i ChatGPT- och Claude-connectorn

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.

Beställningar och planbyten är dolda i connectorerna från ChatGPT:s och Claudes appkataloger. I Claude Code, Cursor och med en API-nyckel är verktyget tillgängligt.

Behörighet
orders.view
Beviljas vid anslutning
Beställningskatalog och förhandsvisning

Parametrar

  • orderIdstringobligatorisk

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

Place Paid Order

create_order
Ändrar dataKräver bekräftelseInte i ChatGPT- och Claude-connectorn

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.

Beställningar och planbyten är dolda i connectorerna från ChatGPT:s och Claudes appkataloger. I Claude Code, Cursor och med en API-nyckel är verktyget tillgängligt.

Behörighet
orders.create
Beviljas vid anslutning
Beställ (mot betalning)

Parametrar

  • confirmationCodestringobligatorisk

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

  • confirmtrueobligatorisk

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

  • userExplicitlyConfirmedbooleanobligatorisk

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

  • requestImmediateStartbooleanvalfri

    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

Din AI-klient rapporterar buggar eller saknade funktioner i MCP-verktygen direkt till oss.

Send Feedback About This Connector

report_mcp_feedback
Ändrar dataStartpunkt

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.

Behörighet
Alla anslutningar
Beviljas vid anslutning
Alla anslutningar

Parametrar

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

  • summarystringobligatorisk

    One sentence: what went wrong or what is missing.

    min length 5 · max length 200

  • detailsstringvalfri

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

    max length 4000

  • relatedToolstringvalfri

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

    max length 100

  • exampleArgsRecord<string, any>valfri

    Optional arguments of the failing call, without secrets.