Ir para o conteúdo

MCP

Todas as ferramentas MCP

Cada ferramenta que seu cliente de IA pode usar pelo servidor MCP da ZapX, com parâmetros, permissão necessária e comportamento. A lista é gerada direto do servidor, por isso está sempre atualizada.

224 ferramentas em 13 grupos · incluídas em todo ZapX Pass

Endpointhttps://zap-hosting.com/api/mcpJSONMarkdown para LLMs
Nomes, títulos e descrições das ferramentas estão em inglês, exatamente como seu cliente de IA os recebe do servidor. Ferramentas marcadas com “Exige confirmação” só rodam com confirm: true. Seu cliente de IA pergunta antes de executar a ação.

224 de 224 ferramentas

Conta

Todos os serviços com ID e tipo, falhas e manutenções e o status de operações em andamento.

List All Services

list_account_services
Somente leituraPonto de partida

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

Permissão
Qualquer conexãoOs resultados incluem apenas os serviços que a conexão pode ver.
Concedida ao conectar
Qualquer conexão

Parâmetros

Sem parâmetros

List Incidents

list_incidents
Somente leituraPonto de partida

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.

Permissão
Qualquer conexãoOs resultados incluem apenas os serviços que a conexão pode ver.
Concedida ao conectar
Qualquer conexão

Parâmetros

  • resolvedHoursintegeropcional

    min 0 · max 168

Get Operation Status

get_operation_status
Somente leitura

Poll the status of an async public API operation.

Permissão
Qualquer conexãoOs resultados incluem apenas os serviços que a conexão pode ver.
Concedida ao conectar
Qualquer conexão

Parâmetros

  • operationIdstringobrigatório

Servidores de jogos

Status, console, iniciar e parar, configurações, versão e variante do jogo, mods, saves, acesso SFTP e reinstalação.

List Game Servers

list_gameservers
Somente leituraPonto de partida

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

Permissão
gameserver.view
Concedida ao conectar
Consultar serviços

Parâmetros

Sem parâmetros

Get Game Server

get_gameserver
Somente leituraPonto de partida

Get one gameserver by ID.

Permissão
gameserver.view
Concedida ao conectar
Consultar serviços

Parâmetros

  • serviceIdstringobrigatório

    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
Somente leituraPonto de partida

Get live query status for a gameserver.

Permissão
gameserver.view
Concedida ao conectar
Consultar serviços

Parâmetros

  • serviceIdstringobrigatório

    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
Somente leitura

Read editable gameserver configuration fields.

Permissão
gameserver.config.read
Concedida ao conectar
Ler configuração

Parâmetros

  • serviceIdstringobrigatório

    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
DestrutivaExige confirmação

Update editable gameserver configuration fields. Requires confirm=true.

Permissão
gameserver.config.write
Concedida ao conectar
Alterar configuração

Parâmetros

  • serviceIdstringobrigatório

    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>obrigatório
  • confirmbooleanopcional

Get Game Server Console Logs

get_gameserver_console_logs
Somente leitura

Read a recent gameserver console log snapshot.

Permissão
gameserver.console.read
Concedida ao conectar
Console e logs

Parâmetros

  • serviceIdstringobrigatório

    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.

  • linesintegeropcional

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

    > 0 · max 200

Restart Game Server

restart_gameserver
DestrutivaExige confirmação

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

Permissão
gameserver.restart
Concedida ao conectar
Ações de energia

Parâmetros

  • serviceIdstringobrigatório

    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.

  • confirmbooleanopcional

Start Game Server

start_gameserver
Altera dadosExige confirmação

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

Permissão
gameserver.start
Concedida ao conectar
Ações de energia

Parâmetros

  • serviceIdstringobrigatório

    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.

  • confirmbooleanopcional

Stop Game Server

stop_gameserver
DestrutivaExige confirmação

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

Permissão
gameserver.stop
Concedida ao conectar
Ações de energia

Parâmetros

  • serviceIdstringobrigatório

    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.

  • confirmbooleanopcional

Send Game Server Console Command

send_gameserver_console_command
DestrutivaExige confirmação

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

Permissão
gameserver.console.write
Concedida ao conectar
Console e logs

Parâmetros

  • serviceIdstringobrigatório

    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.

  • commandstringobrigatório

    max length 500

  • confirmbooleanopcional

Get Game Server Activity

get_gameserver_activity
Somente leitura

Read recent gameserver activity logs.

Permissão
gameserver.activity.read
Concedida ao conectar
Consultar serviços

Parâmetros

  • serviceIdstringobrigatório

    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.

  • limitintegeropcional

    > 0 · max 100

  • offsetintegeropcional

    min 0 · max 9007199254740991

Get Game Server Container Status

get_gameserver_container_status
Somente leitura

Get gameserver container and port reachability status.

Permissão
gameserver.view
Concedida ao conectar
Consultar serviços

Parâmetros

  • serviceIdstringobrigatório

    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
Somente leitura

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.

Permissão
gameserver.view
Concedida ao conectar
Consultar serviços

Parâmetros

  • serviceIdstringobrigatório

    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
Altera dadosExige confirmação

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.

Permissão
gameserver.backups.managegameserver.restartgameserver.startgameserver.stopgameserver.console.writegameserver.wipe
Concedida ao conectar
Ações de energia, Console e logs, Alterar configuração

Parâmetros

  • serviceIdstringobrigatório

    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.

  • namestringobrigatório

    max length 120

  • action"restart" | "backup" | "start" | "stop" | "command" | "wipe"obrigatório

  • cronstringobrigatório

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

  • timezonestringopcional

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

  • commandstringopcional

    Console command, required for action=command.

    max length 2000

  • wipeobjectopcional

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

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

    Rust: map, blueprints or full.

  • wipe.backupFirstbooleanopcional

    Back up before wiping (default true).

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

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

  • wipe.worldSizeintegeropcional

    min 1000 · max 6000

  • isActivebooleanopcional
  • confirmbooleanopcional

Update Game Server Schedule

update_gameserver_schedule
DestrutivaExige confirmação

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.

Permissão
gameserver.backups.managegameserver.restartgameserver.startgameserver.stopgameserver.console.writegameserver.wipe
Concedida ao conectar
Ações de energia, Console e logs, Alterar configuração

Parâmetros

  • serviceIdstringobrigatório

    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.

  • scheduleIdstringobrigatório
  • namestringopcional

    max length 120

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

  • cronstringopcional

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

  • timezonestringopcional

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

  • commandstringopcional

    Console command, required for action=command.

    max length 2000

  • wipeobjectopcional

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

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

    Rust: map, blueprints or full.

  • wipe.backupFirstbooleanopcional

    Back up before wiping (default true).

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

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

  • wipe.worldSizeintegeropcional

    min 1000 · max 6000

  • isActivebooleanopcional
  • confirmbooleanopcional

Delete Game Server Schedule

delete_gameserver_schedule
DestrutivaExige confirmação

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

Permissão
gameserver.backups.managegameserver.restartgameserver.startgameserver.stopgameserver.console.writegameserver.wipe
Concedida ao conectar
Ações de energia, Console e logs, Alterar configuração

Parâmetros

  • serviceIdstringobrigatório

    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.

  • scheduleIdstringobrigatório
  • confirmbooleanopcional

Wipe Game Server

wipe_gameserver
DestrutivaExige confirmação

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.

Permissão
gameserver.wipe
Concedida ao conectar
Acesso total

Parâmetros

  • serviceIdstringobrigatório

    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"obrigatório

    Rust: map, blueprints or full.

  • backupFirstbooleanopcional

    Back up before wiping (default true).

  • seed"keep" | "random" | integeropcional

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

  • worldSizeintegeropcional

    min 1000 · max 6000

  • confirmbooleanopcional

List Game Server Databases

list_gameserver_databases
Somente leitura

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.

Permissão
gameserver.database.read
Concedida ao conectar
Ler configuração

Parâmetros

  • serviceIdstringobrigatório

    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
Altera dadosExige confirmação

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.

Permissão
gameserver.database.write
Concedida ao conectar
Alterar configuração

Parâmetros

  • serviceIdstringobrigatório

    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.

  • namestringopcional

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

    max length 40

  • confirmbooleanopcional

Delete Game Server Database

delete_gameserver_database
DestrutivaExige confirmação

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.

Permissão
gameserver.database.write
Concedida ao conectar
Alterar configuração

Parâmetros

  • serviceIdstringobrigatório

    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.

  • databaseIdstringobrigatório
  • confirmationNamestringobrigatório

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

  • confirmbooleanopcional

Get Game Server External Access

get_gameserver_external_access
Somente leitura

Read gameserver external access details.

Permissão
gameserver.external-access.manage
Concedida ao conectar
Acesso total

Parâmetros

  • serviceIdstringobrigatório

    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
Altera dadosExige confirmação

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

Permissão
gameserver.external-access.manage
Concedida ao conectar
Acesso total

Parâmetros

  • serviceIdstringobrigatório

    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.

  • confirmbooleanopcional

Rotate Game Server External Access Credentials

rotate_gameserver_external_access
DestrutivaExige confirmação

Rotate gameserver external access credentials. Requires confirm=true.

Permissão
gameserver.external-access.manage
Concedida ao conectar
Acesso total

Parâmetros

  • serviceIdstringobrigatório

    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.

  • confirmbooleanopcional

Show Game Server External Access Credentials

reveal_gameserver_external_access
DestrutivaExige confirmação

Reveal gameserver external access credentials. Requires confirm=true.

Permissão
gameserver.external-access.manage
Concedida ao conectar
Acesso total

Parâmetros

  • serviceIdstringobrigatório

    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.

  • confirmbooleanopcional

Reinstall Game Server

reinstall_gameserver
DestrutivaExige confirmação

Reinstall a gameserver. Requires confirm=true.

Permissão
gameserver.reinstall
Concedida ao conectar
Acesso total

Parâmetros

  • serviceIdstringobrigatório

    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.

  • confirmbooleanopcional

Change Game Server Game Version

update_gameserver_version
DestrutivaExige confirmação

Update gameserver game version. Requires confirm=true.

Permissão
gameserver.lifecycle.manage
Concedida ao conectar
Alterar configuração

Parâmetros

  • serviceIdstringobrigatório

    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.

  • targetVersionstringopcional
  • targetModpackVersionstringopcional
  • confirmbooleanopcional

Change Game Server Variant

update_gameserver_variant
DestrutivaExige confirmação

Change gameserver variant. Requires confirm=true.

Permissão
gameserver.lifecycle.manage
Concedida ao conectar
Alterar configuração

Parâmetros

  • serviceIdstringobrigatório

    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.

  • variantIdstringobrigatório
  • confirmbooleanopcional

List Game Server Save Games

list_gameserver_savegames
Somente leitura

List gameserver savegames.

Permissão
gameserver.savegames.read
Concedida ao conectar
Ler configuração

Parâmetros

  • serviceIdstringobrigatório

    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.

  • pageintegeropcional

    > 0 · max 9007199254740991

  • limitintegeropcional

    > 0 · max 100

Delete Game Server Save Game

delete_gameserver_savegame
DestrutivaExige confirmação

Delete a gameserver savegame. Requires confirm=true.

Permissão
gameserver.savegames.write
Concedida ao conectar
Alterar configuração

Parâmetros

  • serviceIdstringobrigatório

    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.

  • pathstringobrigatório
  • confirmbooleanopcional

List Game Server Mods

list_gameserver_mods
Somente leitura

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.

Permissão
gameserver.view
Concedida ao conectar
Consultar serviços

Parâmetros

  • serviceIdstringobrigatório

    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.

  • querystringopcional
  • providerstringopcional
  • installedOnlybooleanopcional
  • offsetintegeropcional

    min 0 · max 9007199254740991

  • limitintegeropcional

    > 0 · max 48

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

DestrutivaExige confirmação

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.

Permissão
gameserver.mods.manage
Concedida ao conectar
Alterar configuração

Parâmetros

  • serviceIdstringobrigatório

    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"obrigatório

  • projectIdstringobrigatório

    max length 200

  • versionIdstringopcional

    max length 200

  • titlestringopcional

    max length 200

  • resolveDependenciesbooleanopcional
  • confirmbooleanopcional

Remove Game Server Mod

uninstall_gameserver_mod
DestrutivaExige confirmação

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.

Permissão
gameserver.mods.manage
Concedida ao conectar
Alterar configuração

Parâmetros

  • serviceIdstringobrigatório

    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.

  • installationIdstringobrigatório
  • confirmbooleanopcional

Check Game Server Mod and Plugin Updates

check_gameserver_addon_updates
Somente leitura

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.

Permissão
gameserver.view
Concedida ao conectar
Consultar serviços

Parâmetros

  • serviceIdstringobrigatório

    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"obrigatório

  • refreshbooleanopcional

List Game Server Plugins

list_gameserver_plugins
Somente leitura

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.

Permissão
gameserver.view
Concedida ao conectar
Consultar serviços

Parâmetros

  • serviceIdstringobrigatório

    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.

  • querystringopcional

    max length 200

  • provider"all" | "modrinth" | "hangar"opcional

  • installedOnlybooleanopcional
  • offsetintegeropcional

    min 0 · max 9007199254740991

  • limitintegeropcional

    min 1 · max 48

  • sortstringopcional

    max length 40

Install or Update Game Server Plugin

install_gameserver_plugin
DestrutivaExige confirmação

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.

Permissão
gameserver.plugins.manage
Concedida ao conectar
Alterar configuração

Parâmetros

  • serviceIdstringobrigatório

    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"obrigatório

  • projectIdstringobrigatório

    max length 200

  • versionIdstringopcional

    max length 200

  • titlestringopcional

    max length 200

  • resolveDependenciesbooleanopcional
  • confirmbooleanopcional

Remove Game Server Plugin

uninstall_gameserver_plugin
DestrutivaExige confirmação

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.

Permissão
gameserver.plugins.manage
Concedida ao conectar
Alterar configuração

Parâmetros

  • serviceIdstringobrigatório

    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.

  • installationIdstringobrigatório
  • confirmbooleanopcional

Get Rust Plugin Framework

get_gameserver_rust_framework
Somente leitura

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.

Permissão
gameserver.view
Concedida ao conectar
Consultar serviços

Parâmetros

  • serviceIdstringobrigatório

    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
DestrutivaExige confirmação

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.

Permissão
gameserver.plugins.manage
Concedida ao conectar
Alterar configuração

Parâmetros

  • serviceIdstringobrigatório

    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"obrigatório

  • confirmbooleanopcional

List Minecraft Modpacks

list_gameserver_modpacks
Somente leitura

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.

Permissão
gameserver.view
Concedida ao conectar
Consultar serviços

Parâmetros

  • serviceIdstringobrigatório

    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.

  • searchstringopcional

    max length 200

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

  • offsetintegeropcional

    min 0 · max 100000

  • limitintegeropcional

    min 1 · max 100

  • modpackIdstringopcional

Install Minecraft Modpack

install_gameserver_modpack
DestrutivaExige confirmação

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.

Permissão
gameserver.lifecycle.manage
Concedida ao conectar
Alterar configuração

Parâmetros

  • serviceIdstringobrigatório

    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.

  • modpackIdstringobrigatório
  • versionIdstringobrigatório
  • confirmbooleanopcional

Get Game Server Steam Workshop

get_gameserver_workshop
Somente leitura

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.

Permissão
gameserver.view
Concedida ao conectar
Consultar serviços

Parâmetros

  • serviceIdstringobrigatório

    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
DestrutivaExige confirmação

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.

Permissão
gameserver.mods.manage
Concedida ao conectar
Alterar configuração

Parâmetros

  • serviceIdstringobrigatório

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

    max items 500

  • addItemIdsstring[]opcional

    max items 200

  • removeItemIdsstring[]opcional

    max items 500

  • collectionIdstringopcional

    pattern ^\d{1,20}$

  • disabledItemIdsstring[]opcional

    max items 500

  • confirmbooleanopcional

VPS

Iniciar e parar, configuração, métricas, tráfego, DNS, firewall, chaves SSH, proteção DDoS, agendamentos, modo de resgate e reinstalação.

List VPS

list_vservers
Somente leituraPonto de partida

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

Permissão
vserver.view
Concedida ao conectar
Consultar serviços

Parâmetros

Sem parâmetros

Get VPS

get_vserver
Somente leituraPonto de partida

Get one VPS by ID.

Permissão
vserver.view
Concedida ao conectar
Consultar serviços

Parâmetros

  • serviceIdstringobrigatório

    ID of the VPS: the "id" field from list_account_services or list_vservers (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
Somente leitura

Read VPS configuration.

Permissão
vserver.config.read
Concedida ao conectar
Ler configuração

Parâmetros

  • serviceIdstringobrigatório

    ID of the VPS: the "id" field from list_account_services or list_vservers (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
DestrutivaExige confirmação

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

Permissão
vserver.config.writevserver.access.manage
Concedida ao conectar
Alterar configuração

Parâmetros

  • serviceIdstringobrigatório

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

  • hostnamestringopcional
  • dnsServerstringopcional
  • ballooningDisabledbooleanopcional
  • sshPasswordEnabledbooleanopcional
  • confirmbooleanopcional

Get VPS Activity

get_vserver_activity
Somente leitura

Read paginated VPS activity log entries.

Permissão
vserver.activity.read
Concedida ao conectar
Consultar serviços

Parâmetros

  • serviceIdstringobrigatório

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

  • limitintegeropcional

    min 1 · max 100

  • offsetintegeropcional

    min 0 · max 9007199254740991

Get VPS Traffic

get_vserver_traffic
Somente leitura

Read paginated VPS network traffic history.

Permissão
vserver.traffic.read
Concedida ao conectar
Consultar serviços

Parâmetros

  • serviceIdstringobrigatório

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

  • limitintegeropcional

    min 1 · max 100

  • offsetintegeropcional

    min 0 · max 9007199254740991

Get VPS DDoS Status

get_vserver_ddos_status
Somente leitura

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.

Permissão
vserver.ddos.read
Concedida ao conectar
Consultar serviços

Parâmetros

  • serviceIdstringobrigatório

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

  • ipAddressstringopcional

List VPS DDoS Rules

list_vserver_ddos_rules
Somente leitura

List the DDoS filter rules learned for a VPS IP.

Permissão
vserver.ddos.read
Concedida ao conectar
Consultar serviços

Parâmetros

  • serviceIdstringobrigatório

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

  • ipAddressstringopcional

List VPS DDoS Incidents

list_vserver_ddos_incidents
Somente leitura

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

Permissão
vserver.ddos.read
Concedida ao conectar
Consultar serviços

Parâmetros

  • serviceIdstringobrigatório

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

  • ipAddressstringopcional
  • pageintegeropcional

    > 0 · max 9007199254740991

  • pageSizeintegeropcional

    > 0 · max 100

Get VPS DDoS Bandwidth

get_vserver_ddos_bandwidth
Somente leitura

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

Permissão
vserver.ddos.read
Concedida ao conectar
Consultar serviços

Parâmetros

  • serviceIdstringobrigatório

    ID of the VPS: the "id" field from list_account_services or list_vservers (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"opcional

  • ipAddressstringopcional

List Outgoing DDoS Attacks from VPS

list_vserver_outgoing_ddos
Somente leitura

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

Permissão
vserver.ddos.read
Concedida ao conectar
Consultar serviços

Parâmetros

  • serviceIdstringobrigatório

    ID of the VPS: the "id" field from list_account_services or list_vservers (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
DestrutivaExige confirmação

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

Permissão
vserver.ddos.manage
Concedida ao conectar
Alterar configuração

Parâmetros

  • serviceIdstringobrigatório

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

  • ipAddressstringopcional
  • enabledbooleanopcional

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

  • confirmbooleanopcional

Get VPS DNS Settings

get_vserver_dns
Somente leitura

Read VPS DNS domains, subdomains, and favorite subdomain.

Permissão
vserver.config.read
Concedida ao conectar
Ler configuração

Parâmetros

  • serviceIdstringobrigatório

    ID of the VPS: the "id" field from list_account_services or list_vservers (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
Somente leitura

List SSH keys stored on the authenticated account.

Permissão
vserver.config.read
Concedida ao conectar
Ler configuração

Parâmetros

Sem parâmetros

Create VPS Subdomain

create_vserver_subdomain
Altera dadosExige confirmação

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

Permissão
vserver.config.write
Concedida ao conectar
Alterar configuração

Parâmetros

  • serviceIdstringobrigatório

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

  • labelstringobrigatório

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

  • domainIdstringopcional

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

  • confirmbooleanopcional

Delete VPS Subdomain

delete_vserver_subdomain
DestrutivaExige confirmação

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

Permissão
vserver.config.write
Concedida ao conectar
Alterar configuração

Parâmetros

  • serviceIdstringobrigatório

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

  • subdomainIdstringobrigatório

    Subdomain id from get_vserver_dns.

  • confirmbooleanopcional

Set VPS Favorite Subdomain

set_vserver_favorite_subdomain
DestrutivaExige confirmação

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

Permissão
vserver.config.write
Concedida ao conectar
Alterar configuração

Parâmetros

  • serviceIdstringobrigatório

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

  • subdomainIdstringopcional

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

  • confirmbooleanopcional

Get VPS Reverse DNS

get_vserver_reverse_dns
Somente leitura

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

Permissão
vserver.config.read
Concedida ao conectar
Ler configuração

Parâmetros

  • serviceIdstringobrigatório

    ID of the VPS: the "id" field from list_account_services or list_vservers (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
DestrutivaExige confirmação

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

Permissão
vserver.config.write
Concedida ao conectar
Alterar configuração

Parâmetros

  • serviceIdstringobrigatório

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

  • ipAddressIdstringopcional

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

  • ipv6PrefixAllocationIdstringopcional

    IPv6 entry from get_vserver_reverse_dns (`ipv6PrefixAllocationId`).

  • hostnamestringopcional

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

  • confirmbooleanopcional

Update VPS Firewall Options

update_vserver_firewall_options
DestrutivaExige confirmação

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.

Permissão
vserver.firewall.write
Concedida ao conectar
Alterar configuração

Parâmetros

  • serviceIdstringobrigatório

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

  • enablebooleanobrigatório

    Firewall on (true) or off (false).

  • policyIn"ACCEPT" | "DROP" | "REJECT"obrigatório

    Default policy for incoming traffic no rule matches.

  • policyOut"ACCEPT" | "DROP" | "REJECT"obrigatório

    Default policy for outgoing traffic no rule matches.

  • confirmbooleanopcional

Change VPS Firewall Rule

mutate_vserver_firewall_rule
DestrutivaExige confirmação

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

Permissão
vserver.firewall.write
Concedida ao conectar
Alterar configuração

Parâmetros

  • serviceIdstringobrigatório

    ID of the VPS: the "id" field from list_account_services or list_vservers (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"obrigatório

  • posintegeropcional

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

    min 0 · max 9007199254740991

  • newPosintegeropcional

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

    add/update: traffic direction.

  • ruleAction"ACCEPT" | "DROP" | "REJECT"opcional

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

  • enablebooleanopcional

    add/update: rule active (default true).

  • macrostringopcional

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

  • protostringopcional

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

  • sourcestringopcional

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

  • deststringopcional

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

  • sportstringopcional

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

  • dportstringopcional

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

  • commentstringopcional

    add/update: free text comment.

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

    add/update: log level (default nolog).

  • confirmbooleanopcional

Change VPS Firewall IP Set

mutate_vserver_firewall_ipset
DestrutivaExige confirmação

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

Permissão
vserver.firewall.write
Concedida ao conectar
Alterar configuração

Parâmetros

  • serviceIdstringobrigatório

    ID of the VPS: the "id" field from list_account_services or list_vservers (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"obrigatório

  • namestringobrigatório

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

  • cidrstringopcional

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

  • commentstringopcional

    add_entry: free text comment.

  • confirmbooleanopcional

List VPS SSH Keys

list_vserver_ssh_keys
Somente leitura

List the account SSH keys installed on one VPS.

Permissão
vserver.config.read
Concedida ao conectar
Ler configuração

Parâmetros

  • serviceIdstringobrigatório

    ID of the VPS: the "id" field from list_account_services or list_vservers (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
Altera dadosExige confirmação

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

Permissão
vserver.access.manage
Concedida ao conectar
Acesso total

Parâmetros

  • serviceIdstringobrigatório

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

  • sshKeyIdstringobrigatório

    Key id from list_vserver_account_ssh_keys.

  • confirmbooleanopcional

Remove SSH Key from VPS

remove_vserver_ssh_key
DestrutivaExige confirmação

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

Permissão
vserver.access.manage
Concedida ao conectar
Acesso total

Parâmetros

  • serviceIdstringobrigatório

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

  • sshKeyIdstringobrigatório

    Key id from list_vserver_ssh_keys.

  • confirmbooleanopcional

Add Account SSH Key

create_vserver_account_ssh_key
Altera dadosExige confirmação

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

Permissão
vserver.config.write
Concedida ao conectar
Alterar configuração

Parâmetros

  • namestringobrigatório
  • publicKeystringobrigatório

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

  • confirmbooleanopcional

Update Account SSH Key

update_vserver_account_ssh_key
DestrutivaExige confirmação

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

Permissão
vserver.access.manage
Concedida ao conectar
Acesso total

Parâmetros

  • keyIdstringobrigatório

    Key id from list_vserver_account_ssh_keys.

  • namestringopcional
  • publicKeystringopcional

    Replaces the key on every VPS it is installed on.

  • confirmbooleanopcional

Delete Account SSH Key

delete_vserver_account_ssh_key
DestrutivaExige confirmação

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

Permissão
vserver.access.manage
Concedida ao conectar
Acesso total

Parâmetros

  • keyIdstringobrigatório

    Key id from list_vserver_account_ssh_keys.

  • confirmbooleanopcional

List VPS ISO Images

list_vserver_isos
Somente leitura

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

Permissão
vserver.reinstall
Concedida ao conectar
Acesso total

Parâmetros

  • serviceIdstringobrigatório

    ID of the VPS: the "id" field from list_account_services or list_vservers (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
Altera dadosExige confirmação

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

Permissão
vserver.reinstall
Concedida ao conectar
Acesso total

Parâmetros

  • serviceIdstringobrigatório

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

  • isoIdstringopcional

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

  • volidstringopcional

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

  • applyHardwareProfilebooleanopcional

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

  • attachDriverDiscbooleanopcional

    Attach the VirtIO driver disc (Windows installs).

  • bootFromIsobooleanopcional

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

  • confirmbooleanopcional

Unmount ISO from VPS

unmount_vserver_iso
Altera dadosExige confirmação

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

Permissão
vserver.reinstall
Concedida ao conectar
Acesso total

Parâmetros

  • serviceIdstringobrigatório

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

  • confirmbooleanopcional

List Custom VPS ISOs

list_vserver_custom_isos
Somente leitura

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

Permissão
vserver.reinstall
Concedida ao conectar
Acesso total

Parâmetros

  • serviceIdstringobrigatório

    ID of the VPS: the "id" field from list_account_services or list_vservers (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
Altera dadosExige confirmação

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

Permissão
vserver.reinstall
Concedida ao conectar
Acesso total

Parâmetros

  • serviceIdstringobrigatório

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

  • displayNamestringobrigatório
  • sourceUrlstringobrigatório

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

  • filenamestringopcional
  • osProfile"linux" | "windows"opcional

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

  • confirmbooleanopcional

Delete Custom VPS ISO

delete_vserver_custom_iso
DestrutivaExige confirmação

Delete an own imported ISO. Requires confirm=true.

Permissão
vserver.reinstall
Concedida ao conectar
Acesso total

Parâmetros

  • serviceIdstringobrigatório

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

  • assetIdstringobrigatório

    Custom ISO id from list_vserver_custom_isos.

  • confirmbooleanopcional

Get VPS Metrics

get_vserver_metrics
Somente leitura

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.

Permissão
vserver.metrics.read
Concedida ao conectar
Consultar serviços

Parâmetros

  • serviceIdstringobrigatório

    ID of the VPS: the "id" field from list_account_services or list_vservers (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"opcional

Get VPS Firewall Rules

get_vserver_firewall
Somente leitura

Read the VPS firewall configuration.

Permissão
vserver.firewall.read
Concedida ao conectar
Ler configuração

Parâmetros

  • serviceIdstringobrigatório

    ID of the VPS: the "id" field from list_account_services or list_vservers (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
Altera dadosExige confirmação

Start a VPS. Requires confirm=true.

Permissão
vserver.power.start
Concedida ao conectar
Ações de energia

Parâmetros

  • serviceIdstringobrigatório

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

  • confirmbooleanopcional

Stop VPS

stop_vserver
DestrutivaExige confirmação

Stop a VPS. Requires confirm=true.

Permissão
vserver.power.stop
Concedida ao conectar
Ações de energia

Parâmetros

  • serviceIdstringobrigatório

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

  • confirmbooleanopcional

Restart VPS

restart_vserver
DestrutivaExige confirmação

Restart a VPS. Requires confirm=true.

Permissão
vserver.power.restart
Concedida ao conectar
Ações de energia

Parâmetros

  • serviceIdstringobrigatório

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

  • confirmbooleanopcional

List VPS Schedules

list_vserver_schedules
Somente leitura

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

Permissão
vserver.view
Concedida ao conectar
Consultar serviços

Parâmetros

  • serviceIdstringobrigatório

    ID of the VPS: the "id" field from list_account_services or list_vservers (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
DestrutivaExige confirmação

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.

Permissão
vserver.power.restartvserver.power.startvserver.power.stopvserver.console.write
Concedida ao conectar
Ações de energia

Parâmetros

  • serviceIdstringobrigatório

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

  • namestringobrigatório
  • action"restart" | "start" | "stop" | "command"obrigatório

  • cronstringobrigatório
  • timezonestringopcional
  • commandstringopcional
  • isActivebooleanopcional
  • confirmbooleanopcional

Update VPS Schedule

update_vserver_schedule
DestrutivaExige confirmação

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

Permissão
vserver.power.restartvserver.power.startvserver.power.stopvserver.console.write
Concedida ao conectar
Ações de energia

Parâmetros

  • serviceIdstringobrigatório

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

  • scheduleIdstringobrigatório
  • namestringopcional
  • action"restart" | "start" | "stop" | "command"opcional

  • cronstringopcional
  • timezonestringopcional
  • commandstringopcional
  • isActivebooleanopcional
  • confirmbooleanopcional

Delete VPS Schedule

delete_vserver_schedule
DestrutivaExige confirmação

Delete a VPS schedule. Requires confirm=true.

Permissão
vserver.power.restartvserver.power.startvserver.power.stopvserver.console.write
Concedida ao conectar
Ações de energia

Parâmetros

  • serviceIdstringobrigatório

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

  • scheduleIdstringobrigatório
  • confirmbooleanopcional

Enable VPS Rescue Mode

enable_vserver_rescue
DestrutivaExige confirmação

Enable VPS rescue mode. Requires confirm=true.

Permissão
vserver.reinstall
Concedida ao conectar
Acesso total

Parâmetros

  • serviceIdstringobrigatório

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

  • confirmbooleanopcional

Disable VPS Rescue Mode

disable_vserver_rescue
DestrutivaExige confirmação

Disable VPS rescue mode. Requires confirm=true.

Permissão
vserver.reinstall
Concedida ao conectar
Acesso total

Parâmetros

  • serviceIdstringobrigatório

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

  • confirmbooleanopcional

List VPS Reinstall Templates

list_vserver_reinstall_templates
Somente leitura

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

Permissão
vserver.reinstall
Concedida ao conectar
Acesso total

Parâmetros

Sem parâmetros

Reinstall VPS

reinstall_vserver
DestrutivaExige confirmação

Reinstall a VPS. Requires confirm=true.

Permissão
vserver.reinstall
Concedida ao conectar
Acesso total

Parâmetros

  • serviceIdstringobrigatório

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

  • templateIdstringopcional
  • confirmbooleanopcional

Servidores dedicados

Estado de energia, hardware, métricas, tráfego, instalação, ISOs próprias, DNS reverso, proteção DDoS, gerenciamento remoto e modo de resgate.

List Dedicated Servers

list_dedicated_servers
Somente leituraPonto de partida

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

Permissão
dedicated.view
Concedida ao conectar
Consultar serviços

Parâmetros

Sem parâmetros

Get Dedicated Server

get_dedicated_server
Somente leituraPonto de partida

Get one dedicated server by ID.

Permissão
dedicated.view
Concedida ao conectar
Consultar serviços

Parâmetros

  • serviceIdstringobrigatório

    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
Somente leitura

Get dedicated server hardware power state.

Permissão
dedicated.view
Concedida ao conectar
Consultar serviços

Parâmetros

  • serviceIdstringobrigatório

    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
Somente leitura

Get dedicated server hardware metrics for a timeframe.

Permissão
dedicated.metrics.read
Concedida ao conectar
Consultar serviços

Parâmetros

  • serviceIdstringobrigatório

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

Get Dedicated Server Hardware

get_dedicated_hardware
Somente leitura

Get dedicated server hardware inventory.

Permissão
dedicated.hardware.read
Concedida ao conectar
Consultar serviços

Parâmetros

  • serviceIdstringobrigatório

    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
Somente leitura

Get dedicated server traffic overview for a timeframe.

Permissão
dedicated.traffic.read
Concedida ao conectar
Consultar serviços

Parâmetros

  • serviceIdstringobrigatório

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

Get Dedicated Server Traffic Quota

get_dedicated_traffic_quota
Somente leitura

Get dedicated server traffic quota snapshot.

Permissão
dedicated.traffic.read
Concedida ao conectar
Consultar serviços

Parâmetros

  • serviceIdstringobrigatório

    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
Somente leitura

Get dedicated server traffic history entries.

Permissão
dedicated.traffic.read
Concedida ao conectar
Consultar serviços

Parâmetros

  • serviceIdstringobrigatório

    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.

  • limitintegeropcional

    > 0 · max 9007199254740991

  • offsetintegeropcional

    min 0 · max 9007199254740991

Get Dedicated Server Activity

get_dedicated_activity
Somente leitura

Read recent dedicated server activity logs.

Permissão
dedicated.activity.read
Concedida ao conectar
Consultar serviços

Parâmetros

  • serviceIdstringobrigatório

    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.

  • limitintegeropcional

    > 0 · max 9007199254740991

  • offsetintegeropcional

    min 0 · max 9007199254740991

Get Dedicated Server Installation

get_dedicated_installation
Somente leitura

Get dedicated server installation status.

Permissão
dedicated.view
Concedida ao conectar
Consultar serviços

Parâmetros

  • serviceIdstringobrigatório

    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
Somente leitura

Get dedicated server installation progress and log.

Permissão
dedicated.view
Concedida ao conectar
Consultar serviços

Parâmetros

  • serviceIdstringobrigatório

    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
Somente leitura

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

Permissão
dedicated.installation.manage
Concedida ao conectar
Acesso total

Parâmetros

  • serviceIdstringobrigatório

    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
Somente leitura

Read reverse DNS entries for a dedicated server.

Permissão
dedicated.network.read
Concedida ao conectar
Consultar serviços

Parâmetros

  • serviceIdstringobrigatório

    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
Somente leitura

Get DDoS protection status for a dedicated server.

Permissão
dedicated.ddos.read
Concedida ao conectar
Consultar serviços

Parâmetros

  • serviceIdstringobrigatório

    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.

  • ipAddressstringopcional

List Dedicated Server DDoS Rules

list_dedicated_ddos_rules
Somente leitura

List DDoS protection rules for a dedicated server.

Permissão
dedicated.ddos.read
Concedida ao conectar
Consultar serviços

Parâmetros

  • serviceIdstringobrigatório

    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.

  • ipAddressstringopcional

List Dedicated Server DDoS Incidents

list_dedicated_ddos_incidents
Somente leitura

List DDoS incidents for a dedicated server.

Permissão
dedicated.ddos.read
Concedida ao conectar
Consultar serviços

Parâmetros

  • serviceIdstringobrigatório

    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.

  • ipAddressstringopcional
  • pageintegeropcional

    > 0 · max 9007199254740991

  • pageSizeintegeropcional

    > 0 · max 100

Get Dedicated Server DDoS Bandwidth

get_dedicated_ddos_bandwidth
Somente leitura

Get DDoS bandwidth statistics for a dedicated server.

Permissão
dedicated.ddos.read
Concedida ao conectar
Consultar serviços

Parâmetros

  • serviceIdstringobrigatório

    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.

  • rangestringopcional
  • ipAddressstringopcional

Get Dedicated Server Remote Management

get_dedicated_remote_management
Somente leitura

Get dedicated server remote management session state.

Permissão
dedicated.remote_management.manage
Concedida ao conectar
Acesso total

Parâmetros

  • serviceIdstringobrigatório

    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
Somente leitura

List custom ISO assets available for a dedicated server.

Permissão
dedicated.installation.manage
Concedida ao conectar
Acesso total

Parâmetros

  • serviceIdstringobrigatório

    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
Somente leitura

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

Permissão
dedicated.reinstall
Concedida ao conectar
Acesso total

Parâmetros

Sem parâmetros

Start Dedicated Server

start_dedicated_server
Altera dadosExige confirmação

Start a dedicated server. Requires confirm=true.

Permissão
dedicated.power.start
Concedida ao conectar
Ações de energia

Parâmetros

  • serviceIdstringobrigatório

    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.

  • confirmbooleanopcional

Stop Dedicated Server

stop_dedicated_server
DestrutivaExige confirmação

Stop a dedicated server. Requires confirm=true.

Permissão
dedicated.power.stop
Concedida ao conectar
Ações de energia

Parâmetros

  • serviceIdstringobrigatório

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

  • confirmbooleanopcional

Restart Dedicated Server

restart_dedicated_server
DestrutivaExige confirmação

Restart a dedicated server. Requires confirm=true.

Permissão
dedicated.power.restart
Concedida ao conectar
Ações de energia

Parâmetros

  • serviceIdstringobrigatório

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

  • confirmbooleanopcional

Reinstall Dedicated Server

reinstall_dedicated_server
DestrutivaExige confirmação

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.

Permissão
dedicated.reinstall
Concedida ao conectar
Acesso total

Parâmetros

  • serviceIdstringobrigatório

    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.

  • osTemplateIdstringopcional

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

  • confirmbooleanopcional

Wipe Dedicated Server

wipe_dedicated_server
DestrutivaExige confirmação

Wipe a dedicated server. Requires confirm=true.

Permissão
dedicated.reinstall
Concedida ao conectar
Acesso total

Parâmetros

  • serviceIdstringobrigatório

    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.

  • confirmbooleanopcional

Update Dedicated Server Reverse DNS

update_dedicated_reverse_dns
DestrutivaExige confirmação

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

Permissão
dedicated.network.write
Concedida ao conectar
Alterar configuração

Parâmetros

  • serviceIdstringobrigatório

    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.

  • ipAddressIdstringopcional
  • ipv6PrefixAllocationIdstringopcional
  • hostnamestringopcional
  • confirmbooleanopcional

Refresh Dedicated Server Installation

refresh_dedicated_installation
Altera dadosExige confirmação

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

Permissão
dedicated.installation.manage
Concedida ao conectar
Acesso total

Parâmetros

  • serviceIdstringobrigatório

    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.

  • confirmbooleanopcional

Mount Dedicated Server Install Media

mount_dedicated_install_media
Altera dadosExige confirmação

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

Permissão
dedicated.installation.manage
Concedida ao conectar
Acesso total

Parâmetros

  • serviceIdstringobrigatório

    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.

  • templateIdstringobrigatório
  • confirmbooleanopcional

Unmount Dedicated Server Install Media

unmount_dedicated_install_media
Altera dadosExige confirmação

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

Permissão
dedicated.installation.manage
Concedida ao conectar
Acesso total

Parâmetros

  • serviceIdstringobrigatório

    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.

  • confirmbooleanopcional
Altera dadosExige confirmação

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

Permissão
dedicated.installation.manage
Concedida ao conectar
Acesso total

Parâmetros

  • serviceIdstringobrigatório

    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"obrigatório

  • confirmbooleanopcional
DestrutivaExige confirmação

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

Permissão
dedicated.rescue.manage
Concedida ao conectar
Acesso total

Parâmetros

  • serviceIdstringobrigatório

    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.

  • templateIdstringobrigatório
  • confirmbooleanopcional
DestrutivaExige confirmação

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

Permissão
dedicated.rescue.manage
Concedida ao conectar
Acesso total

Parâmetros

  • serviceIdstringobrigatório

    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.

  • confirmbooleanopcional

Activate Dedicated Server Remote Management

activate_dedicated_remote_management
Altera dadosExige confirmação

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

Permissão
dedicated.remote_management.manage
Concedida ao conectar
Acesso total

Parâmetros

  • serviceIdstringobrigatório

    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.

  • durationHoursintegeropcional

    > 0 · max 9007199254740991

  • confirmbooleanopcional

Extend Dedicated Server Remote Management

extend_dedicated_remote_management
Altera dadosExige confirmação

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

Permissão
dedicated.remote_management.manage
Concedida ao conectar
Acesso total

Parâmetros

  • serviceIdstringobrigatório

    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.

  • confirmbooleanopcional

Revoke Dedicated Server Remote Management

revoke_dedicated_remote_management
DestrutivaExige confirmação

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

Permissão
dedicated.remote_management.manage
Concedida ao conectar
Acesso total

Parâmetros

  • serviceIdstringobrigatório

    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.

  • confirmbooleanopcional

Launch Dedicated Server Remote Management

launch_dedicated_remote_management
DestrutivaExige confirmação

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

Permissão
dedicated.remote_management.manage
Concedida ao conectar
Acesso total

Parâmetros

  • serviceIdstringobrigatório

    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.

  • confirmbooleanopcional

Turn Dedicated Server DDoS Protection On or Off

toggle_dedicated_ddos_protection
DestrutivaExige confirmação

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

Permissão
dedicated.ddos.manage
Concedida ao conectar
Alterar configuração

Parâmetros

  • serviceIdstringobrigatório

    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.

  • ipAddressstringopcional
  • enabledbooleanopcional

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

  • confirmbooleanopcional

Import Dedicated Server Custom ISO

import_dedicated_custom_iso
Altera dadosExige confirmação

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

Permissão
dedicated.installation.manage
Concedida ao conectar
Acesso total

Parâmetros

  • serviceIdstringobrigatório

    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.

  • displayNamestringobrigatório
  • sourceUrlstringobrigatório

    format uri

  • filenamestringopcional
  • confirmbooleanopcional

Delete Dedicated Server Custom ISO

delete_dedicated_custom_iso
DestrutivaExige confirmação

Delete a custom ISO asset. Requires confirm=true.

Permissão
dedicated.installation.manage
Concedida ao conectar
Acesso total

Parâmetros

  • serviceIdstringobrigatório

    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.

  • assetIdstringobrigatório
  • confirmbooleanopcional

Mount Dedicated Server Custom ISO

mount_dedicated_custom_iso
Altera dadosExige confirmação

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

Permissão
dedicated.installation.manage
Concedida ao conectar
Acesso total

Parâmetros

  • serviceIdstringobrigatório

    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.

  • assetIdstringobrigatório
  • confirmbooleanopcional

Servidores TeamSpeak

Status, iniciar e parar, configurações, clientes, banimentos e chaves de privilégio.

List TeamSpeak Servers

list_teamspeak_servers
Somente leituraPonto de partida

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

Permissão
teamspeak.view
Concedida ao conectar
Consultar serviços

Parâmetros

Sem parâmetros

Get TeamSpeak Server

get_teamspeak_server
Somente leituraPonto de partida

Get one TeamSpeak server by ID.

Permissão
teamspeak.view
Concedida ao conectar
Consultar serviços

Parâmetros

  • serviceIdstringobrigatório

    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
Somente leitura

Read TeamSpeak server configuration.

Permissão
teamspeak.config.read
Concedida ao conectar
Ler configuração

Parâmetros

  • serviceIdstringobrigatório

    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
DestrutivaExige confirmação

Update TeamSpeak server configuration. Requires confirm=true.

Permissão
teamspeak.config.manage
Concedida ao conectar
Alterar configuração

Parâmetros

  • serviceIdstringobrigatório

    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>obrigatório
  • confirmbooleanopcional

List TeamSpeak Privilege Keys

list_teamspeak_tokens
Somente leitura

List privilege tokens for a TeamSpeak server.

Permissão
teamspeak.tokens.manage
Concedida ao conectar
Gestão do TeamSpeak

Parâmetros

  • serviceIdstringobrigatório

    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
DestrutivaExige confirmação

Create a TeamSpeak privilege token. Requires confirm=true.

Permissão
teamspeak.tokens.manage
Concedida ao conectar
Gestão do TeamSpeak

Parâmetros

  • serviceIdstringobrigatório

    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.

  • descriptionstringopcional

    max length 100

  • confirmbooleanopcional

Start TeamSpeak Server

start_teamspeak_server
Altera dadosExige confirmação

Start a TeamSpeak server. Requires confirm=true.

Permissão
teamspeak.power.start
Concedida ao conectar
Ações de energia

Parâmetros

  • serviceIdstringobrigatório

    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.

  • confirmbooleanopcional

Stop TeamSpeak Server

stop_teamspeak_server
DestrutivaExige confirmação

Stop a TeamSpeak server. Requires confirm=true.

Permissão
teamspeak.power.stop
Concedida ao conectar
Ações de energia

Parâmetros

  • serviceIdstringobrigatório

    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.

  • confirmbooleanopcional

Restart TeamSpeak Server

restart_teamspeak_server
DestrutivaExige confirmação

Restart a TeamSpeak server. Requires confirm=true.

Permissão
teamspeak.power.restart
Concedida ao conectar
Ações de energia

Parâmetros

  • serviceIdstringobrigatório

    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.

  • confirmbooleanopcional

Get TeamSpeak Metrics

get_teamspeak_metrics
Somente leitura

Get TeamSpeak server metrics.

Permissão
teamspeak.metrics.read
Concedida ao conectar
Consultar serviços

Parâmetros

  • serviceIdstringobrigatório

    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
Somente leitura

List connected TeamSpeak clients.

Permissão
teamspeak.clients.manage
Concedida ao conectar
Gestão do TeamSpeak

Parâmetros

  • serviceIdstringobrigatório

    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
Somente leitura

List TeamSpeak server bans.

Permissão
teamspeak.bans.manage
Concedida ao conectar
Gestão do TeamSpeak

Parâmetros

  • serviceIdstringobrigatório

    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
Altera dadosExige confirmação

Add a TeamSpeak ban. Requires confirm=true.

Permissão
teamspeak.bans.manage
Concedida ao conectar
Gestão do TeamSpeak

Parâmetros

  • serviceIdstringobrigatório

    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.

  • ipstringopcional
  • uidstringopcional
  • namestringopcional
  • timenumberopcional
  • reasonstringopcional
  • confirmbooleanopcional

Delete TeamSpeak Ban

delete_teamspeak_ban
DestrutivaExige confirmação

Delete a TeamSpeak ban. Requires confirm=true.

Permissão
teamspeak.bans.manage
Concedida ao conectar
Gestão do TeamSpeak

Parâmetros

  • serviceIdstringobrigatório

    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.

  • banIdintegerobrigatório

    > 0 · max 9007199254740991

  • confirmbooleanopcional

Delete TeamSpeak Privilege Key

delete_teamspeak_token
DestrutivaExige confirmação

Delete a TeamSpeak privilege token. Requires confirm=true.

Permissão
teamspeak.tokens.manage
Concedida ao conectar
Gestão do TeamSpeak

Parâmetros

  • serviceIdstringobrigatório

    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.

  • tokenstringobrigatório
  • confirmbooleanopcional

Bots do Discord

Status, console, iniciar e parar e a atividade dos seus bots do Discord.

List Discord Bots

list_discord_bots
Somente leituraPonto de partida

List Discord bots accessible with the current token.

Permissão
discord_bot.view
Concedida ao conectar
Consultar serviços

Parâmetros

Sem parâmetros

Get Discord Bot

get_discord_bot
Somente leituraPonto de partida

Get Discord bot details.

Permissão
discord_bot.view
Concedida ao conectar
Consultar serviços

Parâmetros

  • serviceIdstringobrigatório

    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
Somente leitura

Get Discord bot container and port reachability status.

Permissão
discord_bot.view
Concedida ao conectar
Consultar serviços

Parâmetros

  • serviceIdstringobrigatório

    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
Somente leitura

Read recent Discord bot activity logs.

Permissão
discord_bot.view
Concedida ao conectar
Consultar serviços

Parâmetros

  • serviceIdstringobrigatório

    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.

  • limitintegeropcional

    min 1 · max 100

  • offsetintegeropcional

    min 0 · max 9007199254740991

Start Discord Bot

start_discord_bot
Altera dadosExige confirmação

Start a Discord bot. Requires confirm=true.

Permissão
discord_bot.start
Concedida ao conectar
Ações de energia

Parâmetros

  • serviceIdstringobrigatório

    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.

  • confirmbooleanopcional

Stop Discord Bot

stop_discord_bot
DestrutivaExige confirmação

Stop a Discord bot. Requires confirm=true.

Permissão
discord_bot.stop
Concedida ao conectar
Ações de energia

Parâmetros

  • serviceIdstringobrigatório

    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.

  • confirmbooleanopcional

Restart Discord Bot

restart_discord_bot
DestrutivaExige confirmação

Restart a Discord bot. Requires confirm=true.

Permissão
discord_bot.restart
Concedida ao conectar
Ações de energia

Parâmetros

  • serviceIdstringobrigatório

    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.

  • confirmbooleanopcional

Get Discord Bot Console Logs

get_discord_bot_console_logs
Somente leitura

Get recent Discord bot console log lines.

Permissão
discord_bot.console.read
Concedida ao conectar
Console e logs

Parâmetros

  • serviceIdstringobrigatório

    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.

  • linesintegeropcional

    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
DestrutivaExige confirmação

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

Permissão
discord_bot.console.write
Concedida ao conectar
Console e logs

Parâmetros

  • serviceIdstringobrigatório

    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.

  • commandstringobrigatório

    max length 500

  • confirmbooleanopcional

Domínios

Domínios, registros DNS, nameservers, página de estacionamento e renovação automática.

List Domains

list_domains
Somente leituraPonto de partida

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.

Permissão
domain.view
Concedida ao conectar
Consultar serviços

Parâmetros

Sem parâmetros

Get Domain

get_domain
Somente leitura

Get one domain by ID. Read-only.

Permissão
domain.view
Concedida ao conectar
Consultar serviços

Parâmetros

  • domainIdstringobrigatório

    Domain id (from list_domains or list_account_services).

Get Domain DNS Records

get_domain_dns_records
Somente leituraPonto de partida

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.

Permissão
domain.dns.read
Concedida ao conectar
Ler configuração

Parâmetros

  • domainIdstringobrigatório

    Domain id (from list_domains or list_account_services).

Create Domain DNS Record

create_domain_dns_record
Altera dadosExige confirmação

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.

Permissão
domain.dns.write
Concedida ao conectar
Gerenciamento de domínios

Parâmetros

  • domainIdstringobrigatório

    Domain id (from list_domains or list_account_services).

  • type"A" | "AAAA" | "CAA" | "CNAME" | "MX" | "NS" | "SRV" | "SSHFP" | "TLSA" | "TXT"obrigatório

    Record type.

  • namestringopcional

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

    max length 253

  • contentstringobrigatório

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

    max length 4096

  • ttlintegeropcional

    TTL in seconds (default 3600, min 60).

    min 60 · max 9007199254740991

  • priorityintegeropcional

    MX/SRV priority.

    min 0 · max 65535

  • weightintegeropcional

    SRV weight.

    min 0 · max 65535

  • portintegeropcional

    SRV port.

    min 0 · max 65535

  • confirmbooleanopcional

    Must be true to apply the change.

Update Domain DNS Record

update_domain_dns_record
DestrutivaExige confirmação

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.

Permissão
domain.dns.write
Concedida ao conectar
Gerenciamento de domínios

Parâmetros

  • domainIdstringobrigatório

    Domain id (from list_domains or list_account_services).

  • recordIdstringobrigatório

    Record id from get_domain_dns_records.

  • type"A" | "AAAA" | "CAA" | "CNAME" | "MX" | "NS" | "SRV" | "SSHFP" | "TLSA" | "TXT"obrigatório

    Record type.

  • namestringopcional

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

    max length 253

  • contentstringobrigatório

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

    max length 4096

  • ttlintegeropcional

    TTL in seconds (default 3600, min 60).

    min 60 · max 9007199254740991

  • priorityintegeropcional

    MX/SRV priority.

    min 0 · max 65535

  • weightintegeropcional

    SRV weight.

    min 0 · max 65535

  • portintegeropcional

    SRV port.

    min 0 · max 65535

  • confirmbooleanopcional

    Must be true to apply the change.

Delete Domain DNS Record

delete_domain_dns_record
DestrutivaExige confirmação

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.

Permissão
domain.dns.write
Concedida ao conectar
Gerenciamento de domínios

Parâmetros

  • domainIdstringobrigatório

    Domain id (from list_domains or list_account_services).

  • recordIdstringobrigatório

    Record id from get_domain_dns_records.

  • confirmbooleanopcional

    Must be true to apply the change.

Set Domain Parking Page

set_domain_parking_page
DestrutivaExige confirmação

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.

Permissão
domain.dns.write
Concedida ao conectar
Gerenciamento de domínios

Parâmetros

  • domainIdstringobrigatório

    Domain id (from list_domains or list_account_services).

  • enabledbooleanobrigatório

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

  • confirmedReplaceRecordIdsstring[]opcional

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

    max items 200

  • confirmbooleanopcional

    Must be true to apply the change.

Get Domain Nameservers

get_domain_nameservers
Somente leitura

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

Permissão
domain.dns.read
Concedida ao conectar
Ler configuração

Parâmetros

  • domainIdstringobrigatório

    Domain id (from list_domains or list_account_services).

Set Domain Nameservers

set_domain_nameservers
DestrutivaExige confirmação

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.

Permissão
domain.nameservers.write
Concedida ao conectar
Gerenciamento de domínios

Parâmetros

  • domainIdstringobrigatório

    Domain id (from list_domains or list_account_services).

  • mode"managed" | "external"obrigatório

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

  • nameserversstring[]opcional

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

    min items 2 · max items 13

  • confirmbooleanopcional

    Must be true to apply the change.

Get Domain Renewal Status

get_domain_renewal
Somente leitura

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

Permissão
domain.view
Concedida ao conectar
Consultar serviços

Parâmetros

  • domainIdstringobrigatório

    Domain id (from list_domains or list_account_services).

Set Domain Auto-Renew

set_domain_auto_renew
DestrutivaExige confirmação

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.

Permissão
domain.renewal.manage
Concedida ao conectar
Gerenciamento de domínios

Parâmetros

  • domainIdstringobrigatório

    Domain id (from list_domains or list_account_services).

  • autoRenewbooleanobrigatório

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

  • confirmbooleanopcional

    Must be true to apply the change.

Arquivos

Listar, ler, gravar, renomear e excluir arquivos de servidores de jogos e bots do Discord.

List Discord Bot Files

list_discord_bot_files
Somente leituraPonto de partida

List files in a Discord bot directory.

Permissão
discord_bot.files.read
Concedida ao conectar
Ler configuração

Parâmetros

  • serviceIdstringobrigatório

    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.

  • pathstringopcional
  • includeFolderSizesbooleanopcional

Read Discord Bot File

read_discord_bot_file
Somente leitura

Read an editable text file from a Discord bot.

Permissão
discord_bot.files.read
Concedida ao conectar
Ler configuração

Parâmetros

  • serviceIdstringobrigatório

    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.

  • pathstringobrigatório

Edit Discord Bot File

mutate_discord_bot_file
DestrutivaExige confirmação

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

Permissão
discord_bot.files.write
Concedida ao conectar
Alterar configuração

Parâmetros

  • serviceIdstringobrigatório

    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"obrigatório

  • pathstringobrigatório
  • contentstringopcional
  • expectedRevisionstringopcional

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

  • newNamestringopcional
  • confirmbooleanopcional

List Game Server Files

list_gameserver_files
Somente leituraPonto de partida

List files in a gameserver directory.

Permissão
gameserver.files.read
Concedida ao conectar
Ler configuração

Parâmetros

  • serviceIdstringobrigatório

    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.

  • pathstringopcional
  • scope"savegame" | "config" | "active"opcional

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

  • includeFolderSizesbooleanopcional

Read Game Server File

read_gameserver_file
Somente leitura

Read text content of a gameserver file.

Permissão
gameserver.files.read
Concedida ao conectar
Ler configuração

Parâmetros

  • serviceIdstringobrigatório

    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.

  • pathstringobrigatório
  • scope"savegame" | "config" | "active"opcional

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

Edit Game Server File

mutate_gameserver_file
DestrutivaExige confirmação

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.

Permissão
gameserver.files.write
Concedida ao conectar
Alterar configuração

Parâmetros

  • serviceIdstringobrigatório

    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"obrigatório

  • pathstringopcional

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

  • contentstringopcional
  • expectedRevisionstringopcional

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

  • newNamestringopcional
  • pathsstring[]opcional

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

    min items 1 · max items 100

  • destinationstringopcional

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

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

  • confirmbooleanopcional

Apps com um clique (VPS e dedicados)

Catálogo de apps (Pterodactyl, Nextcloud, n8n, ...), instalação, iniciar/parar/reiniciar, logs e desinstalação; os servidores de jogos no Pterodactyl são criados no próprio painel.

List VPS One-Click Apps

get_vserver_apps
Somente leituraPonto de partida

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.

Permissão
vserver.apps.read
Concedida ao conectar
Ler configuração

Parâmetros

  • serviceIdstringobrigatório

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

  • livebooleanopcional

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

Search VPS App Catalog

list_vserver_app_catalog
Somente leitura

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

Permissão
vserver.apps.read
Concedida ao conectar
Ler configuração

Parâmetros

  • serviceIdstringobrigatório

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

  • searchstringopcional

    Free text search over name, description and tags.

    max length 200

  • categorystringopcional

    max length 100

  • pageintegeropcional

    > 0 · max 9007199254740991

  • pageSizeintegeropcional

    > 0 · max 50

Get VPS App Catalog Entry

get_vserver_app_catalog_entry
Somente leitura

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

Permissão
vserver.apps.read
Concedida ao conectar
Ler configuração

Parâmetros

  • serviceIdstringobrigatório

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

  • catalogTypestringobrigatório

    max length 128

Get VPS App Logs

get_vserver_app_logs
Somente leitura

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

Permissão
vserver.apps.read
Concedida ao conectar
Ler configuração

Parâmetros

  • serviceIdstringobrigatório

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

  • installationIdstringobrigatório

    Installation id from get_vserver_apps / get_dedicated_apps.

    max length 64

  • linesintegeropcional

    min 50 · max 500

Install VPS One-Click App

install_vserver_app
Altera dadosExige confirmação

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.

Permissão
vserver.apps.manage
Concedida ao conectar
Alterar configuração

Parâmetros

  • serviceIdstringobrigatório

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

  • catalogTypestringobrigatório

    Catalog type from the app catalog.

    max length 128

  • displayNamestringobrigatório

    min length 2 · max length 80

  • envValuesRecord<string, string>opcional

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

  • customEnvsobject[]opcional

    max items 50

  • confirmbooleanopcional
  • withoutHostnamebooleanopcional

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

DestrutivaExige confirmação

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

Permissão
vserver.apps.manage
Concedida ao conectar
Alterar configuração

Parâmetros

  • serviceIdstringobrigatório

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

  • installationIdstringobrigatório

    Installation id from get_vserver_apps / get_dedicated_apps.

    max length 64

  • action"start" | "stop" | "restart"obrigatório

  • confirmbooleanopcional

Uninstall VPS One-Click App

uninstall_vserver_app
DestrutivaExige confirmação

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

Permissão
vserver.apps.manage
Concedida ao conectar
Alterar configuração

Parâmetros

  • serviceIdstringobrigatório

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

  • installationIdstringobrigatório

    Installation id from get_vserver_apps / get_dedicated_apps.

    max length 64

  • deleteVolumesbooleanopcional

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

  • confirmbooleanopcional

Reinstall VPS One-Click App

reinstall_vserver_app
DestrutivaExige confirmação

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

Permissão
vserver.apps.manage
Concedida ao conectar
Alterar configuração

Parâmetros

  • serviceIdstringobrigatório

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

  • installationIdstringobrigatório

    Installation id from get_vserver_apps / get_dedicated_apps.

    max length 64

  • deleteVolumesbooleanopcional

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

  • confirmbooleanopcional
Somente leituraPonto de partida

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.

Permissão
dedicated.apps.read
Concedida ao conectar
Ler configuração

Parâmetros

  • serviceIdstringobrigatório

    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.

  • livebooleanopcional

    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
Somente leitura

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.

Permissão
dedicated.apps.read
Concedida ao conectar
Ler configuração

Parâmetros

  • serviceIdstringobrigatório

    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.

  • searchstringopcional

    Free text search over name, description and tags.

    max length 200

  • categorystringopcional

    max length 100

  • pageintegeropcional

    > 0 · max 9007199254740991

  • pageSizeintegeropcional

    > 0 · max 50

Get Dedicated Server App Catalog Entry

get_dedicated_app_catalog_entry
Somente leitura

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

Permissão
dedicated.apps.read
Concedida ao conectar
Ler configuração

Parâmetros

  • serviceIdstringobrigatório

    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.

  • catalogTypestringobrigatório

    max length 128

Get Dedicated Server App Logs

get_dedicated_app_logs
Somente leitura

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

Permissão
dedicated.apps.read
Concedida ao conectar
Ler configuração

Parâmetros

  • serviceIdstringobrigatório

    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.

  • installationIdstringobrigatório

    Installation id from get_vserver_apps / get_dedicated_apps.

    max length 64

  • linesintegeropcional

    min 50 · max 500

Altera dadosExige confirmação

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.

Permissão
dedicated.apps.manage
Concedida ao conectar
Alterar configuração

Parâmetros

  • serviceIdstringobrigatório

    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.

  • catalogTypestringobrigatório

    Catalog type from the app catalog.

    max length 128

  • displayNamestringobrigatório

    min length 2 · max length 80

  • envValuesRecord<string, string>opcional

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

  • customEnvsobject[]opcional

    max items 50

  • confirmbooleanopcional
DestrutivaExige confirmação

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

Permissão
dedicated.apps.manage
Concedida ao conectar
Alterar configuração

Parâmetros

  • serviceIdstringobrigatório

    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.

  • installationIdstringobrigatório

    Installation id from get_vserver_apps / get_dedicated_apps.

    max length 64

  • action"start" | "stop" | "restart"obrigatório

  • confirmbooleanopcional
DestrutivaExige confirmação

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

Permissão
dedicated.apps.manage
Concedida ao conectar
Alterar configuração

Parâmetros

  • serviceIdstringobrigatório

    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.

  • installationIdstringobrigatório

    Installation id from get_vserver_apps / get_dedicated_apps.

    max length 64

  • deleteVolumesbooleanopcional

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

  • confirmbooleanopcional
DestrutivaExige confirmação

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

Permissão
dedicated.apps.manage
Concedida ao conectar
Alterar configuração

Parâmetros

  • serviceIdstringobrigatório

    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.

  • installationIdstringobrigatório

    Installation id from get_vserver_apps / get_dedicated_apps.

    max length 64

  • deleteVolumesbooleanopcional

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

  • confirmbooleanopcional

Backups e snapshots

Criar, restaurar e excluir backups e snapshots.

List Game Server Backups

list_gameserver_backups
Somente leituraPonto de partida

List gameserver backups.

Permissão
gameserver.backups.read
Concedida ao conectar
Ler configuração

Parâmetros

  • serviceIdstringobrigatório

    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
DestrutivaExige confirmação

Create a gameserver backup. Requires confirm=true.

Permissão
gameserver.backups.manage
Concedida ao conectar
Alterar configuração

Parâmetros

  • serviceIdstringobrigatório

    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.

  • namestringopcional

    max length 120

  • confirmbooleanopcional

Delete Game Server Backup

delete_gameserver_backup
DestrutivaExige confirmação

Delete a gameserver backup. Requires confirm=true.

Permissão
gameserver.backups.manage
Concedida ao conectar
Alterar configuração

Parâmetros

  • serviceIdstringobrigatório

    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.

  • backupIdstringobrigatório
  • confirmbooleanopcional

Restore Game Server Backup

restore_gameserver_backup
DestrutivaExige confirmação

Restore a gameserver backup. Requires confirm=true.

Permissão
gameserver.backups.manage
Concedida ao conectar
Alterar configuração

Parâmetros

  • serviceIdstringobrigatório

    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.

  • backupIdstringobrigatório
  • confirmbooleanopcional

List VPS Backups

list_vserver_backups
Somente leituraPonto de partida

List VPS backups.

Permissão
vserver.backups.read
Concedida ao conectar
Ler configuração

Parâmetros

  • serviceIdstringobrigatório

    ID of the VPS: the "id" field from list_account_services or list_vservers (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
Somente leitura

List VPS VM snapshots.

Permissão
vserver.backups.read
Concedida ao conectar
Ler configuração

Parâmetros

  • serviceIdstringobrigatório

    ID of the VPS: the "id" field from list_account_services or list_vservers (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
Altera dadosExige confirmação

Create a VPS VM snapshot. Requires confirm=true.

Permissão
vserver.backups.manage
Concedida ao conectar
Alterar configuração

Parâmetros

  • serviceIdstringobrigatório

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

  • namestringobrigatório
  • descriptionstringopcional
  • includeRambooleanopcional
  • confirmbooleanopcional

Delete VPS Snapshot

delete_vserver_snapshot
DestrutivaExige confirmação

Delete a VPS VM snapshot. Requires confirm=true.

Permissão
vserver.backups.manage
Concedida ao conectar
Alterar configuração

Parâmetros

  • serviceIdstringobrigatório

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

  • namestringobrigatório
  • confirmbooleanopcional

Roll Back VPS to Snapshot

rollback_vserver_snapshot
DestrutivaExige confirmação

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

Permissão
vserver.backups.manage
Concedida ao conectar
Alterar configuração

Parâmetros

  • serviceIdstringobrigatório

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

  • namestringobrigatório
  • confirmbooleanopcional

Create VPS Backup

create_vserver_backup
Altera dadosExige confirmação

Create a VPS backup. Requires confirm=true.

Permissão
vserver.backups.manage
Concedida ao conectar
Alterar configuração

Parâmetros

  • serviceIdstringobrigatório

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

  • notesstringopcional

    max length 500

  • confirmbooleanopcional

Delete VPS Backup

delete_vserver_backup
DestrutivaExige confirmação

Delete a VPS backup. Requires confirm=true.

Permissão
vserver.backups.manage
Concedida ao conectar
Alterar configuração

Parâmetros

  • serviceIdstringobrigatório

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

  • backupIdstringobrigatório
  • confirmbooleanopcional

Restore VPS Backup

restore_vserver_backup
DestrutivaExige confirmação

Restore a VPS backup. Requires confirm=true.

Permissão
vserver.backups.manage
Concedida ao conectar
Alterar configuração

Parâmetros

  • serviceIdstringobrigatório

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

  • backupIdstringobrigatório
  • confirmbooleanopcional

Mudanças de plano

Upgrades e downgrades com prévia de preço, aplicados só depois da sua confirmação expressa.

Get Game Server Plan Change Options

get_gameserver_plan_change_options
Somente leituraPonto de partidaIndisponível nos conectores do ChatGPT e do Claude

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

Pedidos e mudanças de plano ficam ocultos nos conectores dos diretórios de apps do ChatGPT e do Claude. No Claude Code, no Cursor e com uma chave de API, a ferramenta está disponível.

Permissão
gameserver.plan_change
Concedida ao conectar
Alterações ao plano

Parâmetros

  • serviceIdstringobrigatório

    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
Somente leituraIndisponível nos conectores do ChatGPT e do Claude

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

Pedidos e mudanças de plano ficam ocultos nos conectores dos diretórios de apps do ChatGPT e do Claude. No Claude Code, no Cursor e com uma chave de API, a ferramenta está disponível.

Permissão
gameserver.plan_change
Concedida ao conectar
Alterações ao plano

Parâmetros

  • serviceIdstringobrigatório

    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.

  • targetobjectopcional
  • target.pricingMode"package" | "custom"opcional

  • target.targetPackageKeystringopcional
  • target.ramMbintegeropcional

    > 0 · max 9007199254740991

  • target.cpuMillisintegeropcional

    > 0 · max 9007199254740991

  • target.diskMbintegeropcional

    > 0 · max 9007199254740991

  • target.slotsintegeropcional

    > 0 · max 9007199254740991

  • target.dedicatedIpbooleanopcional
  • target.premiumCpubooleanopcional

    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.targetRegionIdstringopcional
  • target.targetBillingIntervalCountintegeropcional

    > 0 · max 9007199254740991

  • couponCodestringopcional

    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
DestrutivaExige confirmaçãoIndisponível nos conectores do ChatGPT e do Claude

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

Pedidos e mudanças de plano ficam ocultos nos conectores dos diretórios de apps do ChatGPT e do Claude. No Claude Code, no Cursor e com uma chave de API, a ferramenta está disponível.

Permissão
gameserver.plan_change
Concedida ao conectar
Alterações ao plano

Parâmetros

  • serviceIdstringobrigatório

    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.

  • targetobjectopcional
  • target.pricingMode"package" | "custom"opcional

  • target.targetPackageKeystringopcional
  • target.ramMbintegeropcional

    > 0 · max 9007199254740991

  • target.cpuMillisintegeropcional

    > 0 · max 9007199254740991

  • target.diskMbintegeropcional

    > 0 · max 9007199254740991

  • target.slotsintegeropcional

    > 0 · max 9007199254740991

  • target.dedicatedIpbooleanopcional
  • target.premiumCpubooleanopcional

    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.targetRegionIdstringopcional
  • target.targetBillingIntervalCountintegeropcional

    > 0 · max 9007199254740991

  • couponCodestringopcional

    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

  • confirmtrueobrigatório
  • userExplicitlyConfirmedtrueobrigatório
  • previewConfirmationNoncestringobrigatório
  • requestImmediateStartbooleanopcional

    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
Somente leitura

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.

Permissão
vserver.plan_change
Concedida ao conectar
Alterações ao plano

Parâmetros

  • serviceIdstringobrigatório

    ID of the VPS: the "id" field from list_account_services or list_vservers (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
Somente leitura

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.

Permissão
vserver.plan_change
Concedida ao conectar
Alterações ao plano

Parâmetros

  • serviceIdstringobrigatório

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

  • targetobjectopcional
  • target.pricingMode"package" | "custom"opcional

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

  • target.targetPackageKeystringopcional
  • target.coresintegeropcional

    > 0 · max 9007199254740991

  • target.memoryMbintegeropcional

    > 0 · max 9007199254740991

  • target.diskGbintegeropcional

    > 0 · max 9007199254740991

  • target.bandwidthMbpsintegeropcional

    > 0 · max 9007199254740991

  • target.memoryintegeropcional

    > 0 · max 9007199254740991

  • target.diskintegeropcional

    > 0 · max 9007199254740991

  • target.bandwidthintegeropcional

    > 0 · max 9007199254740991

  • target.additionalIpCountintegeropcional

    min 0 · max 9007199254740991

  • target.targetBillingIntervalCountintegeropcional

    > 0 · max 9007199254740991

  • couponCodestringopcional

    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
DestrutivaExige confirmação

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.

Permissão
vserver.plan_change
Concedida ao conectar
Alterações ao plano

Parâmetros

  • serviceIdstringobrigatório

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

  • targetobjectopcional
  • target.pricingMode"package" | "custom"opcional

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

  • target.targetPackageKeystringopcional
  • target.coresintegeropcional

    > 0 · max 9007199254740991

  • target.memoryMbintegeropcional

    > 0 · max 9007199254740991

  • target.diskGbintegeropcional

    > 0 · max 9007199254740991

  • target.bandwidthMbpsintegeropcional

    > 0 · max 9007199254740991

  • target.memoryintegeropcional

    > 0 · max 9007199254740991

  • target.diskintegeropcional

    > 0 · max 9007199254740991

  • target.bandwidthintegeropcional

    > 0 · max 9007199254740991

  • target.additionalIpCountintegeropcional

    min 0 · max 9007199254740991

  • target.targetBillingIntervalCountintegeropcional

    > 0 · max 9007199254740991

  • couponCodestringopcional

    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

  • confirmtrueobrigatório
  • userExplicitlyConfirmedtrueobrigatório
  • previewConfirmationNoncestringobrigatório
  • requestImmediateStartbooleanopcional

    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
Somente leituraIndisponível nos conectores do ChatGPT e do Claude

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

Pedidos e mudanças de plano ficam ocultos nos conectores dos diretórios de apps do ChatGPT e do Claude. No Claude Code, no Cursor e com uma chave de API, a ferramenta está disponível.

Permissão
teamspeak.plan_change
Concedida ao conectar
Alterações ao plano

Parâmetros

  • serviceIdstringobrigatório

    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
Somente leituraIndisponível nos conectores do ChatGPT e do Claude

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

Pedidos e mudanças de plano ficam ocultos nos conectores dos diretórios de apps do ChatGPT e do Claude. No Claude Code, no Cursor e com uma chave de API, a ferramenta está disponível.

Permissão
teamspeak.plan_change
Concedida ao conectar
Alterações ao plano

Parâmetros

  • serviceIdstringobrigatório

    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.

  • targetobjectopcional
  • target.pricingMode"package" | "custom"opcional

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

  • target.targetPackageKeystringopcional
  • target.slotsintegeropcional

    > 0 · max 9007199254740991

  • target.hasAdvertisementbooleanopcional
  • target.targetBillingIntervalCountintegeropcional

    > 0 · max 9007199254740991

  • couponCodestringopcional

    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
DestrutivaExige confirmaçãoIndisponível nos conectores do ChatGPT e do Claude

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

Pedidos e mudanças de plano ficam ocultos nos conectores dos diretórios de apps do ChatGPT e do Claude. No Claude Code, no Cursor e com uma chave de API, a ferramenta está disponível.

Permissão
teamspeak.plan_change
Concedida ao conectar
Alterações ao plano

Parâmetros

  • serviceIdstringobrigatório

    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.

  • targetobjectopcional
  • target.pricingMode"package" | "custom"opcional

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

  • target.targetPackageKeystringopcional
  • target.slotsintegeropcional

    > 0 · max 9007199254740991

  • target.hasAdvertisementbooleanopcional
  • target.targetBillingIntervalCountintegeropcional

    > 0 · max 9007199254740991

  • couponCodestringopcional

    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

  • confirmtrueobrigatório
  • userExplicitlyConfirmedtrueobrigatório
  • previewConfirmationNoncestringobrigatório
  • requestImmediateStartbooleanopcional

    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
Somente leituraIndisponível nos conectores do ChatGPT e do Claude

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

Pedidos e mudanças de plano ficam ocultos nos conectores dos diretórios de apps do ChatGPT e do Claude. No Claude Code, no Cursor e com uma chave de API, a ferramenta está disponível.

Permissão
dedicated.plan_change
Concedida ao conectar
Alterações ao plano

Parâmetros

  • serviceIdstringobrigatório

    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
Somente leituraIndisponível nos conectores do ChatGPT e do Claude

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

Pedidos e mudanças de plano ficam ocultos nos conectores dos diretórios de apps do ChatGPT e do Claude. No Claude Code, no Cursor e com uma chave de API, a ferramenta está disponível.

Permissão
dedicated.plan_change
Concedida ao conectar
Alterações ao plano

Parâmetros

  • serviceIdstringobrigatório

    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.

  • targetobjectopcional
  • target.additionalIpCountintegeropcional

    min 0 · max 9007199254740991

  • target.releaseIpAssignmentIdsstring[]opcional
  • couponCodestringopcional

    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
DestrutivaExige confirmaçãoIndisponível nos conectores do ChatGPT e do Claude

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

Pedidos e mudanças de plano ficam ocultos nos conectores dos diretórios de apps do ChatGPT e do Claude. No Claude Code, no Cursor e com uma chave de API, a ferramenta está disponível.

Permissão
dedicated.plan_change
Concedida ao conectar
Alterações ao plano

Parâmetros

  • serviceIdstringobrigatório

    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.

  • targetobjectopcional
  • target.additionalIpCountintegeropcional

    min 0 · max 9007199254740991

  • target.releaseIpAssignmentIdsstring[]opcional
  • couponCodestringopcional

    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

  • confirmtrueobrigatório
  • userExplicitlyConfirmedtrueobrigatório
  • previewConfirmationNoncestringobrigatório
  • requestImmediateStartbooleanopcional

    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
Somente leituraPonto de partida

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

Permissão
gameserver.plan_changevserver.plan_changeteamspeak.plan_changededicated.plan_change
Concedida ao conectar
Alterações ao plano

Parâmetros

  • changeIdstringobrigatório

Pedidos

Produtos, planos, regiões, jogos e imagens ISO disponíveis, além da prévia de preço de um pedido.

List Orderable Products

list_orderable_products
Somente leituraPonto de partidaIndisponível nos conectores do ChatGPT e do Claude

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

Pedidos e mudanças de plano ficam ocultos nos conectores dos diretórios de apps do ChatGPT e do Claude. No Claude Code, no Cursor e com uma chave de API, a ferramenta está disponível.

Permissão
orders.view
Concedida ao conectar
Catálogo de pedidos e prévia

Parâmetros

Sem parâmetros

List Orderable Plans

list_orderable_plans
Somente leituraIndisponível nos conectores do ChatGPT e do Claude

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

Pedidos e mudanças de plano ficam ocultos nos conectores dos diretórios de apps do ChatGPT e do Claude. No Claude Code, no Cursor e com uma chave de API, a ferramenta está disponível.

Permissão
orders.view
Concedida ao conectar
Catálogo de pedidos e prévia

Parâmetros

  • productSlugstringobrigatório

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

List Regions for an Orderable Product

list_orderable_product_regions
Somente leituraIndisponível nos conectores do ChatGPT e do Claude

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

Pedidos e mudanças de plano ficam ocultos nos conectores dos diretórios de apps do ChatGPT e do Claude. No Claude Code, no Cursor e com uma chave de API, a ferramenta está disponível.

Permissão
orders.view
Concedida ao conectar
Catálogo de pedidos e prévia

Parâmetros

  • productSlugstringobrigatório

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

List Order Regions

list_order_regions
Somente leituraIndisponível nos conectores do ChatGPT e do Claude

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

Pedidos e mudanças de plano ficam ocultos nos conectores dos diretórios de apps do ChatGPT e do Claude. No Claude Code, no Cursor e com uma chave de API, a ferramenta está disponível.

Permissão
orders.view
Concedida ao conectar
Catálogo de pedidos e prévia

Parâmetros

Sem parâmetros

List Orderable Games

list_orderable_games
Somente leituraIndisponível nos conectores do ChatGPT e do Claude

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

Pedidos e mudanças de plano ficam ocultos nos conectores dos diretórios de apps do ChatGPT e do Claude. No Claude Code, no Cursor e com uma chave de API, a ferramenta está disponível.

Permissão
orders.view
Concedida ao conectar
Catálogo de pedidos e prévia

Parâmetros

Sem parâmetros

List ISO Images for VPS Orders

list_vserver_order_isos
Somente leituraIndisponível nos conectores do ChatGPT e do Claude

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

Pedidos e mudanças de plano ficam ocultos nos conectores dos diretórios de apps do ChatGPT e do Claude. No Claude Code, no Cursor e com uma chave de API, a ferramenta está disponível.

Permissão
orders.view
Concedida ao conectar
Catálogo de pedidos e prévia

Parâmetros

Sem parâmetros

Somente leituraPonto de partidaIndisponível nos conectores do ChatGPT e do Claude

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

Pedidos e mudanças de plano ficam ocultos nos conectores dos diretórios de apps do ChatGPT e do Claude. No Claude Code, no Cursor e com uma chave de API, a ferramenta está disponível.

Permissão
orders.view
Concedida ao conectar
Catálogo de pedidos e prévia

Parâmetros

  • productSlugstringobrigatório

    Product slug from list_orderable_products.

  • billingCycleSlug"3-day" | "monthly" | "quarterly" | "semi-annual" | "annual"obrigatório

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

  • planSlugstringopcional

    Plan slug from list_orderable_plans (products with fixed plans).

  • gameSlugstringopcional

    Game slug from list_orderable_games (gameservers).

  • regionSlugstringopcional

    Region slug from list_orderable_product_regions (products with region choice).

  • resourceConfigRecord<string, number>opcional

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

  • optionsobjectopcional
  • options.couponCodestringopcional
  • options.dedicatedIpCountintegeropcional

    min 0 · max 9007199254740991

  • options.domainAttachmentobjectopcional
  • configurationRecord<string, any>opcional

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

  • domainsobject[]opcional

Get Order Status

get_order_status
Somente leituraIndisponível nos conectores do ChatGPT e do Claude

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

Pedidos e mudanças de plano ficam ocultos nos conectores dos diretórios de apps do ChatGPT e do Claude. No Claude Code, no Cursor e com uma chave de API, a ferramenta está disponível.

Permissão
orders.view
Concedida ao conectar
Catálogo de pedidos e prévia

Parâmetros

  • orderIdstringobrigatório

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

Place Paid Order

create_order
Altera dadosExige confirmaçãoIndisponível nos conectores do ChatGPT e do Claude

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

Pedidos e mudanças de plano ficam ocultos nos conectores dos diretórios de apps do ChatGPT e do Claude. No Claude Code, no Cursor e com uma chave de API, a ferramenta está disponível.

Permissão
orders.create
Concedida ao conectar
Fazer pedido (pago)

Parâmetros

  • confirmationCodestringobrigatório

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

  • confirmtrueobrigatório

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

  • userExplicitlyConfirmedbooleanobrigatório

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

  • requestImmediateStartbooleanopcional

    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

Seu cliente de IA nos informa diretamente sobre bugs ou funções que faltam nas ferramentas MCP.

Altera dadosPonto de partida

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.

Permissão
Qualquer conexão
Concedida ao conectar
Qualquer conexão

Parâmetros

  • kind"bug" | "missing_capability" | "unclear_tool_description" | "improvement"obrigatório

  • summarystringobrigatório

    One sentence: what went wrong or what is missing.

    min length 5 · max length 200

  • detailsstringopcional

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

    max length 4000

  • relatedToolstringopcional

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

    max length 100

  • exampleArgsRecord<string, any>opcional

    Optional arguments of the failing call, without secrets.