Endpoints: 76,849MCP servers: 32,730Payout addresses: 3,825Paid calls: 6,158Letters: 84Defects: 3,894counted 4 min ago
teppi

Server definition

Hash
sha256:49a7dd0541e7f2a4723c950cdbc513120339ee8a739a0fe10c74bdeb326a5489
What it is
What a remote MCP server returned when asked what it offers: 233 tools

The blob, as servednamed by its sha256

{ "instructions": "These tools belong to ZAP-Hosting: gameservers, VPS and TeamSpeak servers. The user is not signed in yet; they can still get advice, prices and an order link.\n\nAdvise, price, hand over\n- Ask what the user needs (game, players at the same time, mods; or what will run on a VPS), then call recommend_plan. For other questions use list_orderable_products, list_orderable_games, list_orderable_plans and list_orderable_product_regions.\n- Price the chosen configuration with preview_order (pass recommend_plan's orderRequest unchanged). Guest prices are EUR incl. German VAT; the checkout prices for the user's country. Never invent prices or plans.\n- When the user wants it, call create_checkout_link with the same orderRequest and the user's language as locale and give them the link: the ZapX order page opens with everything preselected, the user signs up or signs in and pays there. Nothing is ordered before that.\n\nSign-in\n- Ordering inside the chat and managing servers (status, start/stop, console, files, backups, settings) need the user's ZAP-Hosting account. Before calling such a tool, say that the user will be asked to sign in (connect the account); the tool call starts it. Afterwards the same tools work on the user's own services.\n- If a tool answer says a ZapX Pass is needed, tell the user which Pass, its price and the link from that answer.\n\nNot possible here: payments, invoices, cancellations and support tickets; the user does them in the ZAP-Hosting dashboard.", "tools": [ { "description": "Activate remote management for a dedicated server. Requires confirm=true. Requires an active ZapX Pass (see server instructions).", "inputSchema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "properties": { "confirm": { "type": "boolean" }, "durationHours": { "exclusiveMinimum": 0, "maximum": 9007199254740991, "type": "integer" }, "serviceId": { "description": "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.", "minLength": 1, "type": "string" } }, "required": [ "serviceId" ], "type": "object" }, "name": "activate_dedicated_remote_management", "outputSchema": null }, { "description": "Add a TeamSpeak ban. Requires confirm=true. Requires an active ZapX Pass (see server instructions).", "inputSchema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "properties": { "confirm": { "type": "boolean" }, "ip": { "type": "string" }, "name": { "type": "string" }, "reason": { "type": "string" }, "serviceId": { "description": "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.", "minLength": 1, "type": "string" }, "time": { "type": "number" }, "uid": { "type": "string" } }, "required": [ "serviceId" ], "type": "object" }, "name": "add_teamspeak_ban", "outputSchema": null }, { "description": "Install an account SSH key (list_vserver_account_ssh_keys) on the VPS as root authorized key. Requires confirm=true. Requires an active ZapX Pass (see server instructions).", "inputSchema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "properties": { "confirm": { "type": "boolean" }, "serviceId": { "description": "ID of the VPS: the \"id\" field from list_account_services or list_vservers (e.g. \"cmabc123...\"). The numericId shown in the panel (e.g. \"180\") is accepted too. IDs of other service types do not work here.", "minLength": 1, "type": "string" }, "sshKeyId": { "description": "Key id from list_vserver_account_ssh_keys.", "minLength": 1, "type": "string" } }, "required": [ "serviceId", "sshKeyId" ], "type": "object" }, "name": "add_vserver_ssh_key", "outputSchema": null }, { "description": "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.", "inputSchema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "properties": { "confirm": { "const": true, "type": "boolean" }, "couponCode": { "description": "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.", "maxLength": 100, "type": "string" }, "previewConfirmationNonce": { "minLength": 1, "type": "string" }, "requestImmediateStart": { "description": "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.", "type": "boolean" }, "serviceId": { "description": "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.", "minLength": 1, "type": "string" }, "target": { "properties": { "additionalIpCount": { "maximum": 9007199254740991, "minimum": 0, "type": "integer" }, "releaseIpAssignmentIds": { "items": { "minLength": 1, "type": "string" }, "type": "array" } }, "type": "object" }, "userExplicitlyConfirmed": { "const": true, "type": "boolean" } }, "required": [ "serviceId", "confirm", "userExplicitlyConfirmed", "previewConfirmationNonce" ], "type": "object" }, "name": "apply_dedicated_plan_change", "outputSchema": null }, { "description": "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.", "inputSchema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "properties": { "confirm": { "const": true, "type": "boolean" }, "couponCode": { "description": "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.", "maxLength": 100, "type": "string" }, "previewConfirmationNonce": { "minLength": 1, "type": "string" }, "requestImmediateStart": { "description": "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.", "type": "boolean" }, "serviceId": { "description": "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.", "minLength": 1, "type": "string" }, "target": { "properties": { "cpuMillis": { "exclusiveMinimum": 0, "maximum": 9007199254740991, "type": "integer" }, "dedicatedIp": { "type": "boolean" }, "diskMb": { "exclusiveMinimum": 0, "maximum": 9007199254740991, "type": "integer" }, "premiumCpu": { "description": "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.", "type": "boolean" }, "pricingMode": { "enum": [ "package", "custom" ], "type": "string" }, "ramMb": { "exclusiveMinimum": 0, "maximum": 9007199254740991, "type": "integer" }, "slots": { "exclusiveMinimum": 0, "maximum": 9007199254740991, "type": "integer" }, "targetBillingIntervalCount": { "anyOf": [ { "exclusiveMinimum": 0, "maximum": 9007199254740991, "type": "integer" }, { "type": "null" } ] }, "targetPackageKey": { "minLength": 1, "type": "string" }, "targetRegionId": { "anyOf": [ { "minLength": 1, "type": "string" }, { "type": "null" } ] } }, "type": "object" }, "userExplicitlyConfirmed": { "const": true, "type": "boolean" } }, "required": [ "serviceId", "confirm", "userExplicitlyConfirmed", "previewConfirmationNonce" ], "type": "object" }, "name": "apply_gameserver_plan_change", "outputSchema": null }, { "description": "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.", "inputSchema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "properties": { "confirm": { "const": true, "type": "boolean" }, "couponCode": { "description": "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.", "maxLength": 100, "type": "string" }, "previewConfirmationNonce": { "minLength": 1, "type": "string" }, "requestImmediateStart": { "description": "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.", "type": "boolean" }, "serviceId": { "description": "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.", "minLength": 1, "type": "string" }, "target": { "properties": { "hasAdvertisement": { "type": "boolean" }, "pricingMode": { "description": "Set \"custom\" to change slots on a package TeamSpeak server (otherwise the request is rejected); use targetPackageKey to switch package.", "enum": [ "package", "custom" ], "type": "string" }, "slots": { "exclusiveMinimum": 0, "maximum": 9007199254740991, "type": "integer" }, "targetBillingIntervalCount": { "anyOf": [ { "exclusiveMinimum": 0, "maximum": 9007199254740991, "type": "integer" }, { "type": "null" } ] }, "targetPackageKey": { "minLength": 1, "type": "string" } }, "type": "object" }, "userExplicitlyConfirmed": { "const": true, "type": "boolean" } }, "required": [ "serviceId", "confirm", "userExplicitlyConfirmed", "previewConfirmationNonce" ], "type": "object" }, "name": "apply_teamspeak_plan_change", "outputSchema": null }, { "description": "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.", "inputSchema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "properties": { "confirm": { "const": true, "type": "boolean" }, "couponCode": { "description": "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.", "maxLength": 100, "type": "string" }, "previewConfirmationNonce": { "minLength": 1, "type": "string" }, "requestImmediateStart": { "description": "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.", "type": "boolean" }, "serviceId": { "description": "ID of the VPS: the \"id\" field from list_account_services or list_vservers (e.g. \"cmabc123...\"). The numericId shown in the panel (e.g. \"180\") is accepted too. IDs of other service types do not work here.", "minLength": 1, "type": "string" }, "target": { "properties": { "additionalIpCount": { "maximum": 9007199254740991, "minimum": 0, "type": "integer" }, "bandwidth": { "exclusiveMinimum": 0, "maximum": 9007199254740991, "type": "integer" }, "bandwidthMbps": { "exclusiveMinimum": 0, "maximum": 9007199254740991, "type": "integer" }, "cores": { "exclusiveMinimum": 0, "maximum": 9007199254740991, "type": "integer" }, "disk": { "exclusiveMinimum": 0, "maximum": 9007199254740991, "type": "integer" }, "diskGb": { "exclusiveMinimum": 0, "maximum": 9007199254740991, "type": "integer" }, "memory": { "exclusiveMinimum": 0, "maximum": 9007199254740991, "type": "integer" }, "memoryMb": { "exclusiveMinimum": 0, "maximum": 9007199254740991, "type": "integer" }, "pricingMode": { "description": "Set \"custom\" to change cores, memoryMb, diskGb or bandwidthMbps on a package VPS (otherwise the request is rejected); use targetPackageKey to switch package.", "enum": [ "package", "custom" ], "type": "string" }, "targetBillingIntervalCount": { "anyOf": [ { "exclusiveMinimum": 0, "maximum": 9007199254740991, "type": "integer" }, { "type": "null" } ] }, "targetPackageKey": { "minLength": 1, "type": "string" } }, "type": "object" }, "userExplicitlyConfirmed": { "const": true, "type": "boolean" } }, "required": [ "serviceId", "confirm", "userExplicitlyConfirmed", "previewConfirmationNonce" ], "type": "object" }, "name": "apply_vserver_plan_change", "outputSchema": null }, { "description": "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. Requires an active ZapX Pass (see server instructions).", "inputSchema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "properties": { "kind": { "enum": [ "mods", "plugins" ], "type": "string" }, "refresh": { "type": "boolean" }, "serviceId": { "description": "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.", "minLength": 1, "type": "string" } }, "required": [ "serviceId", "kind" ], "type": "object" }, "name": "check_gameserver_addon_updates", "outputSchema": null }, { "description": "Link to the ZapX order page with the configuration preselected (product, plan or resources, game, location, billing cycle); same arguments as preview_order, plus locale (the user's language). The user signs up or signs in and pays on that page. Works without sign-in; use it whenever the user wants to order and cannot or does not want to order in the chat. Creates nothing.", "inputSchema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "properties": { "billingCycleSlug": { "description": "Billing cycle: 3-day, monthly, quarterly, semi-annual or annual.", "enum": [ "3-day", "monthly", "quarterly", "semi-annual", "annual" ], "type": "string" }, "configuration": { "additionalProperties": {}, "description": "Product-specific configuration, same shape as the REST order body.", "propertyNames": { "type": "string" }, "type": "object" }, "domains": { "items": { "properties": { "authCode": { "type": "string" }, "dnsMode": { "enum": [ "managed", "external" ], "type": "string" }, "domain": { "type": "string" }, "enableCloudflareProtection": { "type": "boolean" }, "handleProfileId": { "type": "string" }, "periodYears": { "maximum": 9007199254740991, "minimum": -9007199254740991, "type": "integer" }, "registrationMode": { "enum": [ "register", "transfer" ], "type": "string" } }, "required": [ "domain", "registrationMode" ], "type": "object" }, "type": "array" }, "gameSlug": { "description": "Game slug from list_orderable_games (gameservers).", "type": "string" }, "locale": { "description": "Language of the order page, the user's language: de, en, fr, es, it, pl, pt, nl, ... Default de.", "pattern": "^[a-z]{2}$", "type": "string" }, "options": { "properties": { "couponCode": { "type": "string" }, "dedicatedIpCount": { "maximum": 9007199254740991, "minimum": 0, "type": "integer" }, "domainAttachment": { "properties": { "attachMode": { "enum": [ "skip", "existing", "purchased" ], "type": "string" }, "existingDomainId": { "type": "string" }, "subdomainLabel": { "type": "string" }, "targetDomainName": { "type": "string" } }, "required": [ "attachMode" ], "type": "object" } }, "type": "object" }, "planSlug": { "description": "Plan slug from list_orderable_plans (products with fixed plans).", "type": "string" }, "productSlug": { "description": "Product slug from list_orderable_products.", "minLength": 1, "type": "string" }, "regionSlug": { "description": "Region slug from list_orderable_product_regions (products with region choice).", "type": "string" }, "resourceConfig": { "additionalProperties": { "type": "number" }, "description": "Resource values for configurable products, keyed as listed by list_orderable_plans.", "propertyNames": { "type": "string" }, "type": "object" } }, "required": [ "productSlug", "billingCycleSlug" ], "type": "object" }, "name": "create_checkout_link", "outputSchema": null }, { "description": "Create a Discord bot schedule, recurring (`cron`) or one-time (`runOnceAt`); set exactly one of them. Bot owner only. action: restart, start, stop, command (needs `command`, sent to the bot console), backup (needs ZapX Pass Pro). Five-field cron evaluated in `timezone` (IANA, default UTC), at most every 5 minutes, max 20 schedules per bot. `runOnceAt` = local \"YYYY-MM-DDTHH:mm\" in `timezone`, in the future and at most one year ahead: the schedule runs exactly once and switches itself off. Write both as the customer's local wall-clock time and set `timezone` to their zone, never convert to UTC yourself. Requires confirm=true. Requires an active ZapX Pass (see server instructions).", "inputSchema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "properties": { "action": { "enum": [ "restart", "backup", "start", "stop", "command" ], "type": "string" }, "command": { "description": "Bot console command, required for action=command.", "maxLength": 2000, "type": "string" }, "confirm": { "type": "boolean" }, "cron": { "description": "Recurring schedule: five-field cron in local time of `timezone`, e.g. \"0 4 * * *\" = daily 04:00. At most every 5 minutes. Leave out for a one-time schedule (`runOnceAt`).", "minLength": 1, "type": "string" }, "isActive": { "type": "boolean" }, "name": { "maxLength": 120, "minLength": 1, "type": "string" }, "runOnceAt": { "description": "One-time schedule: local date and time \"YYYY-MM-DDTHH:mm\" in `timezone` (e.g. \"2026-11-20T03:00\"), in the future and at most one year ahead. Runs exactly once, then switches itself off (isActive=false). Use it for \"once tomorrow at 3am\", never a cron with a fixed day and month.", "maxLength": 32, "type": "string" }, "serviceId": { "description": "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.", "minLength": 1, "type": "string" }, "timezone": { "description": "IANA zone the cron / runOnceAt is evaluated in, e.g. \"Europe/Berlin\". Default UTC.", "type": [ "string", "null" ] } }, "required": [ "serviceId", "name", "action" ], "type": "object" }, "name": "create_discord_bot_schedule", "outputSchema": null }, { "description": "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. Requires an active ZapX Pass (see server instructions).", "inputSchema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "properties": { "confirm": { "description": "Must be true to apply the change.", "type": "boolean" }, "content": { "description": "Record value (IP address, hostname, TXT text, ...).", "maxLength": 4096, "minLength": 1, "type": "string" }, "domainId": { "description": "Domain id (from list_domains or list_account_services).", "minLength": 1, "type": "string" }, "name": { "description": "Record name relative to the domain: '@' (default) for the domain itself, 'www', '_acme-challenge', ...", "maxLength": 253, "type": "string" }, "port": { "description": "SRV port.", "maximum": 65535, "minimum": 0, "type": "integer" }, "priority": { "description": "MX/SRV priority.", "maximum": 65535, "minimum": 0, "type": "integer" }, "ttl": { "description": "TTL in seconds (default 3600, min 60).", "maximum": 9007199254740991, "minimum": 60, "type": "integer" }, "type": { "description": "Record type.", "enum": [ "A", "AAAA", "CAA", "CNAME", "MX", "NS", "SRV", "SSHFP", "TLSA", "TXT" ], "type": "string" }, "weight": { "description": "SRV weight.", "maximum": 65535, "minimum": 0, "type": "integer" } }, "required": [ "domainId", "type", "content" ], "type": "object" }, "name": "create_domain_dns_record", "outputSchema": null }, { "description": "Create a gameserver backup. Requires confirm=true. Requires an active ZapX Pass (see server instructions).", "inputSchema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "properties": { "confirm": { "type": "boolean" }, "name": { "maxLength": 120, "type": "string" }, "serviceId": { "description": "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.", "minLength": 1, "type": "string" } }, "required": [ "serviceId" ], "type": "object" }, "name": "create_gameserver_backup", "outputSchema": null }, { "description": "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. Requires an active ZapX Pass (see server instructions).", "inputSchema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "properties": { "confirm": { "type": "boolean" }, "name": { "description": "Display label, e.g. \"fivem\". Optional.", "maxLength": 40, "type": "string" }, "serviceId": { "description": "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.", "minLength": 1, "type": "string" } }, "required": [ "serviceId" ], "type": "object" }, "name": "create_gameserver_database", "outputSchema": null }, { "description": "Create a gameserver schedule, recurring (`cron`) or one-time (`runOnceAt`); set exactly one of them. 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. `runOnceAt` = local \"YYYY-MM-DDTHH:mm\" in `timezone`, in the future and at most one year ahead: the schedule runs exactly once and switches itself off. Write both as the customer's local wall-clock time and set `timezone` to their zone, never convert to UTC yourself. 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. Requires an active ZapX Pass (see server instructions).", "inputSchema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "properties": { "action": { "enum": [ "restart", "backup", "start", "stop", "command", "wipe" ], "type": "string" }, "command": { "description": "Console command, required for action=command.", "maxLength": 2000, "type": "string" }, "confirm": { "type": "boolean" }, "cron": { "description": "Recurring schedule: five-field cron in local time of `timezone`, e.g. \"0 4 * * *\" = daily 04:00. At most every 5 minutes. Leave out for a one-time schedule (`runOnceAt`).", "minLength": 1, "type": "string" }, "isActive": { "type": "boolean" }, "name": { "maxLength": 120, "minLength": 1, "type": "string" }, "runOnceAt": { "description": "One-time schedule: local date and time \"YYYY-MM-DDTHH:mm\" in `timezone` (e.g. \"2026-11-20T03:00\"), in the future and at most one year ahead. Runs exactly once, then switches itself off (isActive=false). Use it for \"once tomorrow at 3am\", never a cron with a fixed day and month.", "maxLength": 32, "type": "string" }, "serviceId": { "description": "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.", "minLength": 1, "type": "string" }, "timezone": { "description": "IANA zone the cron / runOnceAt is evaluated in, e.g. \"Europe/Berlin\". Default UTC.", "type": [ "string", "null" ] }, "wipe": { "description": "Wipe options, required for action=wipe (only games with a wipe, e.g. Rust).", "properties": { "backupFirst": { "description": "Back up before wiping (default true).", "type": "boolean" }, "kind": { "description": "Rust: map, blueprints or full.", "enum": [ "map", "blueprints", "full" ], "type": "string" }, "seed": { "description": "Map seed: \"keep\" (default) or \"random\".", "enum": [ "keep", "random" ], "type": "string" }, "worldSize": { "anyOf": [ { "maximum": 6000, "minimum": 1000, "type": "integer" }, { "type": "null" } ] } }, "required": [ "kind" ], "type": "object" } }, "required": [ "serviceId", "name", "action" ], "type": "object" }, "name": "create_gameserver_schedule", "outputSchema": null }, { "description": "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.", "inputSchema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "properties": { "confirm": { "const": true, "description": "Must be true. Same confirm=true every state-changing MCP tool requires; set it only together with userExplicitlyConfirmed=true.", "type": "boolean" }, "confirmationCode": { "description": "confirmation.confirmationCode from preview_order. It stands for exactly the previewed order; nothing else can be ordered with it.", "minLength": 1, "type": "string" }, "requestImmediateStart": { "description": "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.", "type": "boolean" }, "userExplicitlyConfirmed": { "description": "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).", "type": "boolean" } }, "required": [ "confirmationCode", "confirm", "userExplicitlyConfirmed" ], "type": "object" }, "name": "create_order", "outputSchema": null }, { "description": "Create a TeamSpeak privilege token. Requires confirm=true. Requires an active ZapX Pass (see server instructions).", "inputSchema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "properties": { "confirm": { "type": "boolean" }, "description": { "maxLength": 100, "type": "string" }, "serviceId": { "description": "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.", "minLength": 1, "type": "string" } }, "required": [ "serviceId" ], "type": "object" }, "name": "create_teamspeak_token", "outputSchema": null }, { "description": "Add a public SSH key to the account key store (then install it with add_vserver_ssh_key). Requires confirm=true. Requires an active ZapX Pass (see server instructions).", "inputSchema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "properties": { "confirm": { "type": "boolean" }, "name": { "minLength": 1, "type": "string" }, "publicKey": { "description": "OpenSSH public key line (ssh-ed25519/ssh-rsa/ecdsa ...). Never pass a private key.", "minLength": 1, "type": "string" } }, "required": [ "name", "publicKey" ], "type": "object" }, "name": "create_vserver_account_ssh_key", "outputSchema": null }, { "description": "Create a VPS backup. Requires confirm=true. Requires an active ZapX Pass (see server instructions).", "inputSchema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "properties": { "confirm": { "type": "boolean" }, "notes": { "maxLength": 500, "type": "string" }, "serviceId": { "description": "ID of the VPS: the \"id\" field from list_account_services or list_vservers (e.g. \"cmabc123...\"). The numericId shown in the panel (e.g. \"180\") is accepted too. IDs of other service types do not work here.", "minLength": 1, "type": "string" } }, "required": [ "serviceId" ], "type": "object" }, "name": "create_vserver_backup", "outputSchema": null }, { "description": "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. Requires an active ZapX Pass (see server instructions).", "inputSchema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "properties": { "action": { "enum": [ "restart", "start", "stop", "command" ], "type": "string" }, "command": { "type": "string" }, "confirm": { "type": "boolean" }, "cron": { "minLength": 1, "type": "string" }, "isActive": { "type": "boolean" }, "name": { "minLength": 1, "type": "string" }, "serviceId": { "description": "ID of the VPS: the \"id\" field from list_account_services or list_vservers (e.g. \"cmabc123...\"). The numericId shown in the panel (e.g. \"180\") is accepted too. IDs of other service types do not work here.", "minLength": 1, "type": "string" }, "timezone": { "type": [ "string", "null" ] } }, "required": [ "serviceId", "name", "action", "cron" ], "type": "object" }, "name": "create_vserver_schedule", "outputSchema": null }, { "description": "Create a VPS VM snapshot. Requires confirm=true. Requires an active ZapX Pass (see server instructions).", "inputSchema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "properties": { "confirm": { "type": "boolean" }, "description": { "type": "string" }, "includeRam": { "type": "boolean" }, "name": { "minLength": 1, "type": "string" }, "serviceId": { "description": "ID of the VPS: the \"id\" field from list_account_services or list_vservers (e.g. \"cmabc123...\"). The numericId shown in the panel (e.g. \"180\") is accepted too. IDs of other service types do not work here.", "minLength": 1, "type": "string" } }, "required": [ "serviceId", "name" ], "type": "object" }, "name": "create_vserver_snapshot", "outputSchema": null }, { "description": "Create a subdomain that points at the VPS (free ZAP domain or one of the customer's domains). Requires confirm=true. Requires an active ZapX Pass (see server instructions).", "inputSchema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "properties": { "confirm": { "type": "boolean" }, "domainId": { "description": "Domain from get_vserver_dns `domains[].id`; default `platform` (the free ZAP domain).", "type": "string" }, "label": { "description": "Subdomain label, e.g. `myserver` for myserver.<domain>.", "minLength": 1, "type": "string" }, "serviceId": { "description": "ID of the VPS: the \"id\" field from list_account_services or list_vservers (e.g. \"cmabc123...\"). The numericId shown in the panel (e.g. \"180\") is accepted too. IDs of other service types do not work here.", "minLength": 1, "type": "string" } }, "required": [ "serviceId", "label" ], "type": "object" }, "name": "create_vserver_subdomain", "outputSchema": null }, { "description": "Delete a custom ISO asset. Requires confirm=true. Requires an active ZapX Pass (see server instructions).", "inputSchema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "properties": { "assetId": { "minLength": 1, "type": "string" }, "confirm": { "type": "boolean" }, "serviceId": { "description": "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.", "minLength": 1, "type": "string" } }, "required": [ "serviceId", "assetId" ], "type": "object" }, "name": "delete_dedicated_custom_iso", "outputSchema": null }, { "description": "Delete a Discord bot schedule. Bot owner only. The daily auto backup (isSystem) cannot be deleted. Requires confirm=true. Requires an active ZapX Pass (see server instructions).", "inputSchema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "properties": { "confirm": { "type": "boolean" }, "scheduleId": { "minLength": 1, "type": "string" }, "serviceId": { "description": "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.", "minLength": 1, "type": "string" } }, "required": [ "serviceId", "scheduleId" ], "type": "object" }, "name": "delete_discord_bot_schedule", "outputSchema": null }, { "description": "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. Requires an active ZapX Pass (see server instructions).", "inputSchema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "properties": { "confirm": { "description": "Must be true to apply the change.", "type": "boolean" }, "domainId": { "description": "Domain id (from list_domains or list_account_services).", "minLength": 1, "type": "string" }, "recordId": { "description": "Record id from get_domain_dns_records.", "minLength": 1, "type": "string" } }, "required": [ "domainId", "recordId" ], "type": "object" }, "name": "delete_domain_dns_record", "outputSchema": null }, { "description": "Delete a gameserver backup. Requires confirm=true. Requires an active ZapX Pass (see server instructions).", "inputSchema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "properties": { "backupId": { "minLength": 1, "type": "string" }, "confirm": { "type": "boolean" }, "serviceId": { "description": "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.", "minLength": 1, "type": "string" } }, "required": [ "serviceId", "backupId" ], "type": "object" }, "name": "delete_gameserver_backup", "outputSchema": null }, { "description": "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. Requires an active ZapX Pass (see server instructions).", "inputSchema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "properties": { "confirm": { "type": "boolean" }, "confirmationName": { "description": "The exact database name (field `database` of list_gameserver_databases), as typed in the dashboard.", "minLength": 1, "type": "string" }, "databaseId": { "minLength": 1, "type": "string" }, "serviceId": { "description": "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.", "minLength": 1, "type": "string" } }, "required": [ "serviceId", "databaseId", "confirmationName" ], "type": "object" }, "name": "delete_gameserver_database", "outputSchema": null }, { "description": "Delete a gameserver savegame. Requires confirm=true. Requires an active ZapX Pass (see server instructions).", "inputSchema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "properties": { "confirm": { "type": "boolean" }, "path": { "minLength": 1, "type": "string" }, "serviceId": { "description": "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.", "minLength": 1, "type": "string" } }, "required": [ "serviceId", "path" ], "type": "object" }, "name": "delete_gameserver_savegame", "outputSchema": null }, { "description": "Delete a gameserver schedule. The daily auto backup (isSystem) cannot be deleted. Requires confirm=true. Requires an active ZapX Pass (see server instructions).", "inputSchema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "properties": { "confirm": { "type": "boolean" }, "scheduleId": { "minLength": 1, "type": "string" }, "serviceId": { "description": "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.", "minLength": 1, "type": "string" } }, "required": [ "serviceId", "scheduleId" ], "type": "object" }, "name": "delete_gameserver_schedule", "outputSchema": null }, { "description": "Delete a TeamSpeak ban. Requires confirm=true. Requires an active ZapX Pass (see server instructions).", "inputSchema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "properties": { "banId": { "exclusiveMinimum": 0, "maximum": 9007199254740991, "type": "integer" }, "confirm": { "type": "boolean" }, "serviceId": { "description": "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.", "minLength": 1, "type": "string" } }, "required": [ "serviceId", "banId" ], "type": "object" }, "name": "delete_teamspeak_ban", "outputSchema": null }, { "description": "Delete a TeamSpeak privilege token. Requires confirm=true. Requires an active ZapX Pass (see server instructions).", "inputSchema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "properties": { "confirm": { "type": "boolean" }, "serviceId": { "description": "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.", "minLength": 1, "type": "string" }, "token": { "minLength": 1, "type": "string" } }, "required": [ "serviceId", "token" ], "type": "object" }, "name": "delete_teamspeak_token", "outputSchema": null }, { "description": "Delete an account SSH key and remove it from every VPS it is installed on. Requires confirm=true. Requires an active ZapX Pass (see server instructions).", "inputSchema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "properties": { "confirm": { "type": "boolean" }, "keyId": { "description": "Key id from list_vserver_account_ssh_keys.", "minLength": 1, "type": "string" } }, "required": [ "keyId" ], "type": "object" }, "name": "delete_vserver_account_ssh_key", "outputSchema": null }, { "description": "Delete a VPS backup. Requires confirm=true. Requires an active ZapX Pass (see server instructions).", "inputSchema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "properties": { "backupId": { "minLength": 1, "type": "string" }, "confirm": { "type": "boolean" }, "serviceId": { "description": "ID of the VPS: the \"id\" field from list_account_services or list_vservers (e.g. \"cmabc123...\"). The numericId shown in the panel (e.g. \"180\") is accepted too. IDs of other service types do not work here.", "minLength": 1, "type": "string" } }, "required": [ "serviceId", "backupId" ], "type": "object" }, "name": "delete_vserver_backup", "outputSchema": null }, { "description": "Delete an own imported ISO. Requires confirm=true. Requires an active ZapX Pass (see server instructions).", "inputSchema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "properties": { "assetId": { "description": "Custom ISO id from list_vserver_custom_isos.", "minLength": 1, "type": "string" }, "confirm": { "type": "boolean" }, "serviceId": { "description": "ID of the VPS: the \"id\" field from list_account_services or list_vservers (e.g. \"cmabc123...\"). The numericId shown in the panel (e.g. \"180\") is accepted too. IDs of other service types do not work here.", "minLength": 1, "type": "string" } }, "required": [ "serviceId", "assetId" ], "type": "object" }, "name": "delete_vserver_custom_iso", "outputSchema": null }, { "description": "Delete a VPS schedule. Requires confirm=true. Requires an active ZapX Pass (see server instructions).", "inputSchema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "properties": { "confirm": { "type": "boolean" }, "scheduleId": { "minLength": 1, "type": "string" }, "serviceId": { "description": "ID of the VPS: the \"id\" field from list_account_services or list_vservers (e.g. \"cmabc123...\"). The numericId shown in the panel (e.g. \"180\") is accepted too. IDs of other service types do not work here.", "minLength": 1, "type": "string" } }, "required": [ "serviceId", "scheduleId" ], "type": "object" }, "name": "delete_vserver_schedule", "outputSchema": null }, { "description": "Delete a VPS VM snapshot. Requires confirm=true. Requires an active ZapX Pass (see server instructions).", "inputSchema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "properties": { "confirm": { "type": "boolean" }, "name": { "minLength": 1, "type": "string" }, "serviceId": { "description": "ID of the VPS: the \"id\" field from list_account_services or list_vservers (e.g. \"cmabc123...\"). The numericId shown in the panel (e.g. \"180\") is accepted too. IDs of other service types do not work here.", "minLength": 1, "type": "string" } }, "required": [ "serviceId", "name" ], "type": "object" }, "name": "delete_vserver_snapshot", "outputSchema": null }, { "description": "Delete a subdomain of the VPS. Requires confirm=true. Requires an active ZapX Pass (see server instructions).", "inputSchema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "properties": { "confirm": { "type": "boolean" }, "serviceId": { "description": "ID of the VPS: the \"id\" field from list_account_services or list_vservers (e.g. \"cmabc123...\"). The numericId shown in the panel (e.g. \"180\") is accepted too. IDs of other service types do not work here.", "minLength": 1, "type": "string" }, "subdomainId": { "description": "Subdomain id from get_vserver_dns.", "minLength": 1, "type": "string" } }, "required": [ "serviceId", "subdomainId" ], "type": "object" }, "name": "delete_vserver_subdomain", "outputSchema": null }, { "description": "Disable rescue mode on a dedicated server. Requires confirm=true. Requires an active ZapX Pass (see server instructions).", "inputSchema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "properties": { "confirm": { "type": "boolean" }, "serviceId": { "description": "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.", "minLength": 1, "type": "string" } }, "required": [ "serviceId" ], "type": "object" }, "name": "disable_dedicated_rescue", "outputSchema": null }, { "description": "Disable VPS rescue mode. Requires confirm=true. Requires an active ZapX Pass (see server instructions).", "inputSchema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "properties": { "confirm": { "type": "boolean" }, "serviceId": { "description": "ID of the VPS: the \"id\" field from list_account_services or list_vservers (e.g. \"cmabc123...\"). The numericId shown in the panel (e.g. \"180\") is accepted too. IDs of other service types do not work here.", "minLength": 1, "type": "string" } }, "required": [ "serviceId" ], "type": "object" }, "name": "disable_vserver_rescue", "outputSchema": null }, { "description": "Enable rescue mode on a dedicated server. Requires confirm=true. Requires an active ZapX Pass (see server instructions).", "inputSchema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "properties": { "confirm": { "type": "boolean" }, "serviceId": { "description": "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.", "minLength": 1, "type": "string" }, "templateId": { "minLength": 1, "type": "string" } }, "required": [ "serviceId", "templateId" ], "type": "object" }, "name": "enable_dedicated_rescue", "outputSchema": null }, { "description": "Enable VPS rescue mode. Requires confirm=true. Requires an active ZapX Pass (see server instructions).", "inputSchema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "properties": { "confirm": { "type": "boolean" }, "serviceId": { "description": "ID of the VPS: the \"id\" field from list_account_services or list_vservers (e.g. \"cmabc123...\"). The numericId shown in the panel (e.g. \"180\") is accepted too. IDs of other service types do not work here.", "minLength": 1, "type": "string" } }, "required": [ "serviceId" ], "type": "object" }, "name": "enable_vserver_rescue", "outputSchema": null }, { "description": "Ensure gameserver external access is provisioned. Requires confirm=true. Requires an active ZapX Pass (see server instructions).", "inputSchema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "properties": { "confirm": { "type": "boolean" }, "serviceId": { "description": "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.", "minLength": 1, "type": "string" } }, "required": [ "serviceId" ], "type": "object" }, "name": "ensure_gameserver_external_access", "outputSchema": null }, { "description": "Erase all disks of a dedicated server so an operating system can be installed afterwards. No operating system is installed by this tool (osTemplateId is only validated); install one by mounting a catalog ISO with mount_dedicated_install_media. All data on the server is lost. Requires confirm=true. Requires an active ZapX Pass (see server instructions).", "inputSchema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "properties": { "confirm": { "type": "boolean" }, "osTemplateId": { "description": "Optional catalog template id; only validated, nothing is installed (the reset only wipes the disks).", "type": "string" }, "serviceId": { "description": "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.", "minLength": 1, "type": "string" } }, "required": [ "serviceId" ], "type": "object" }, "name": "erase_dedicated_server_disks", "outputSchema": null }, { "description": "Extend remote management for a dedicated server. Requires confirm=true. Requires an active ZapX Pass (see server instructions).", "inputSchema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "properties": { "confirm": { "type": "boolean" }, "serviceId": { "description": "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.", "minLength": 1, "type": "string" } }, "required": [ "serviceId" ], "type": "object" }, "name": "extend_dedicated_remote_management", "outputSchema": null }, { "description": "Read recent dedicated server activity logs.", "inputSchema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "properties": { "limit": { "exclusiveMinimum": 0, "maximum": 9007199254740991, "type": "integer" }, "offset": { "maximum": 9007199254740991, "minimum": 0, "type": "integer" }, "serviceId": { "description": "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.", "minLength": 1, "type": "string" } }, "required": [ "serviceId" ], "type": "object" }, "name": "get_dedicated_activity", "outputSchema": null }, { "description": "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). Requires an active ZapX Pass (see server instructions).", "inputSchema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "properties": { "catalogType": { "maxLength": 128, "minLength": 1, "type": "string" }, "serviceId": { "description": "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.", "minLength": 1, "type": "string" } }, "required": [ "serviceId", "catalogType" ], "type": "object" }, "name": "get_dedicated_app_catalog_entry", "outputSchema": null }, { "description": "Recent container logs of an installed One-Click App on a dedicated server (secrets and login links removed). Read them before suggesting a restart. Requires an active ZapX Pass (see server instructions).", "inputSchema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "properties": { "installationId": { "description": "Installation id from get_vserver_apps / get_dedicated_apps.", "maxLength": 64, "minLength": 1, "type": "string" }, "lines": { "maximum": 500, "minimum": 50, "type": "integer" }, "serviceId": { "description": "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.", "minLength": 1, "type": "string" } }, "required": [ "serviceId", "installationId" ], "type": "object" }, "name": "get_dedicated_app_logs", "outputSchema": null }, { "description": "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. Requires an active ZapX Pass (see server instructions).", "inputSchema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "properties": { "live": { "description": "Ask the panel for the live status (slower; needs the manage permission), default the stored status.", "type": "boolean" }, "serviceId": { "description": "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.", "minLength": 1, "type": "string" } }, "required": [ "serviceId" ], "type": "object" }, "name": "get_dedicated_apps", "outputSchema": null }, { "description": "Get DDoS bandwidth statistics for a dedicated server. Requires an active ZapX Pass (see server instructions).", "inputSchema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "properties": { "ipAddress": { "type": "string" }, "range": { "type": "string" }, "serviceId": { "description": "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.", "minLength": 1, "type": "string" } }, "required": [ "serviceId" ], "type": "object" }, "name": "get_dedicated_ddos_bandwidth", "outputSchema": null }, { "description": "Get DDoS protection status for a dedicated server. Requires an active ZapX Pass (see server instructions).", "inputSchema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "properties": { "ipAddress": { "type": "string" }, "serviceId": { "description": "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.", "minLength": 1, "type": "string" } }, "required": [ "serviceId" ], "type": "object" }, "name": "get_dedicated_ddos_status", "outputSchema": null }, { "description": "Get dedicated server hardware inventory.", "inputSchema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "properties": { "serviceId": { "description": "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.", "minLength": 1, "type": "string" } }, "required": [ "serviceId" ], "type": "object" }, "name": "get_dedicated_hardware", "outputSchema": null }, { "description": "Get dedicated server installation status.", "inputSchema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "properties": { "serviceId": { "description": "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.", "minLength": 1, "type": "string" } }, "required": [ "serviceId" ], "type": "object" }, "name": "get_dedicated_installation", "outputSchema": null }, { "description": "List install media, reinstall, rescue, and custom ISO options. Requires an active ZapX Pass (see server instructions).", "inputSchema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "properties": { "serviceId": { "description": "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.", "minLength": 1, "type": "string" } }, "required": [ "serviceId" ], "type": "object" }, "name": "get_dedicated_installation_options", "outputSchema": null }, { "description": "Get dedicated server installation progress and log.", "inputSchema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "properties": { "serviceId": { "description": "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.", "minLength": 1, "type": "string" } }, "required": [ "serviceId" ], "type": "object" }, "name": "get_dedicated_installation_progress", "outputSchema": null }, { "description": "Get dedicated server hardware metrics for a timeframe.", "inputSchema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "properties": { "range": { "enum": [ "1h", "6h", "24h", "7d", "30d" ], "type": "string" }, "serviceId": { "description": "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.", "minLength": 1, "type": "string" } }, "required": [ "serviceId" ], "type": "object" }, "name": "get_dedicated_metrics", "outputSchema": null }, { "description": "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.", "inputSchema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "properties": { "serviceId": { "description": "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.", "minLength": 1, "type": "string" } }, "required": [ "serviceId" ], "type": "object" }, "name": "get_dedicated_plan_change_options", "outputSchema": null }, { "description": "Get dedicated server hardware power state.", "inputSchema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "properties": { "serviceId": { "description": "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.", "minLength": 1, "type": "string" } }, "required": [ "serviceId" ], "type": "object" }, "name": "get_dedicated_power_state", "outputSchema": null }, { "description": "Get dedicated server remote management session state. Requires an active ZapX Pass (see server instructions).", "inputSchema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "properties": { "serviceId": { "description": "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.", "minLength": 1, "type": "string" } }, "required": [ "serviceId" ], "type": "object" }, "name": "get_dedicated_remote_management", "outputSchema": null }, { "description": "Read reverse DNS entries for a dedicated server. Requires an active ZapX Pass (see server instructions).", "inputSchema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "properties": { "serviceId": { "description": "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.", "minLength": 1, "type": "string" } }, "required": [ "serviceId" ], "type": "object" }, "name": "get_dedicated_reverse_dns", "outputSchema": null }, { "description": "Get one dedicated server by ID.", "inputSchema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "properties": { "serviceId": { "description": "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.", "minLength": 1, "type": "string" } }, "required": [ "serviceId" ], "type": "object" }, "name": "get_dedicated_server", "outputSchema": null }, { "description": "Get dedicated server traffic overview for a timeframe.", "inputSchema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "properties": { "range": { "enum": [ "1h", "6h", "24h", "7d", "30d" ], "type": "string" }, "serviceId": { "description": "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.", "minLength": 1, "type": "string" } }, "required": [ "serviceId" ], "type": "object" }, "name": "get_dedicated_traffic", "outputSchema": null }, { "description": "Get dedicated server traffic history entries.", "inputSchema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "properties": { "limit": { "exclusiveMinimum": 0, "maximum": 9007199254740991, "type": "integer" }, "offset": { "maximum": 9007199254740991, "minimum": 0, "type": "integer" }, "serviceId": { "description": "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.", "minLength": 1, "type": "string" } }, "required": [ "serviceId" ], "type": "object" }, "name": "get_dedicated_traffic_history", "outputSchema": null }, { "description": "Get dedicated server traffic quota snapshot.", "inputSchema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "properties": { "serviceId": { "description": "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.", "minLength": 1, "type": "string" } }, "required": [ "serviceId" ], "type": "object" }, "name": "get_dedicated_traffic_quota", "outputSchema": null }, { "description": "Get Discord bot details.", "inputSchema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "properties": { "serviceId": { "description": "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.", "minLength": 1, "type": "string" } }, "required": [ "serviceId" ], "type": "object" }, "name": "get_discord_bot", "outputSchema": null }, { "description": "Read recent Discord bot activity logs.", "inputSchema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "properties": { "limit": { "maximum": 100, "minimum": 1, "type": "integer" }, "offset": { "maximum": 9007199254740991, "minimum": 0, "type": "integer" }, "serviceId": { "description": "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.", "minLength": 1, "type": "string" } }, "required": [ "serviceId" ], "type": "object" }, "name": "get_discord_bot_activity", "outputSchema": null }, { "description": "Get recent Discord bot console log lines. Requires an active ZapX Pass (see server instructions).", "inputSchema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "properties": { "lines": { "description": "Number of recent log lines to return, 1-200 (default 50). Values above 200 are rejected.", "exclusiveMinimum": 0, "maximum": 200, "type": "integer" }, "serviceId": { "description": "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.", "minLength": 1, "type": "string" } }, "required": [ "serviceId" ], "type": "object" }, "name": "get_discord_bot_console_logs", "outputSchema": null }, { "description": "Get Discord bot container and port reachability status.", "inputSchema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "properties": { "serviceId": { "description": "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.", "minLength": 1, "type": "string" } }, "required": [ "serviceId" ], "type": "object" }, "name": "get_discord_bot_container_status", "outputSchema": null }, { "description": "Get one domain by ID. Read-only.", "inputSchema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "properties": { "domainId": { "description": "Domain id (from list_domains or list_account_services).", "minLength": 1, "type": "string" } }, "required": [ "domainId" ], "type": "object" }, "name": "get_domain", "outputSchema": null }, { "description": "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. Requires an active ZapX Pass (see server instructions).", "inputSchema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "properties": { "domainId": { "description": "Domain id (from list_domains or list_account_services).", "minLength": 1, "type": "string" } }, "required": [ "domainId" ], "type": "object" }, "name": "get_domain_dns_records", "outputSchema": null }, { "description": "Read the nameserver delegation of a domain (dnsMode managed/external and the nameservers). Read-only. Requires an active ZapX Pass (see server instructions).", "inputSchema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "properties": { "domainId": { "description": "Domain id (from list_domains or list_account_services).", "minLength": 1, "type": "string" } }, "required": [ "domainId" ], "type": "object" }, "name": "get_domain_nameservers", "outputSchema": null }, { "description": "Read the renewal state of a domain (domain owner only): autoRenew, expiresAt, registrarStatus, scheduledDeletionAt, nextRenewalChargeAt. Read-only.", "inputSchema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "properties": { "domainId": { "description": "Domain id (from list_domains or list_account_services).", "minLength": 1, "type": "string" } }, "required": [ "domainId" ], "type": "object" }, "name": "get_domain_renewal", "outputSchema": null }, { "description": "Get one gameserver by ID.", "inputSchema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "properties": { "serviceId": { "description": "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.", "minLength": 1, "type": "string" } }, "required": [ "serviceId" ], "type": "object" }, "name": "get_gameserver", "outputSchema": null }, { "description": "Read recent gameserver activity logs.", "inputSchema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "properties": { "limit": { "exclusiveMinimum": 0, "maximum": 100, "type": "integer" }, "offset": { "maximum": 9007199254740991, "minimum": 0, "type": "integer" }, "serviceId": { "description": "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.", "minLength": 1, "type": "string" } }, "required": [ "serviceId" ], "type": "object" }, "name": "get_gameserver_activity", "outputSchema": null }, { "description": "Read editable gameserver configuration fields. Requires an active ZapX Pass (see server instructions).", "inputSchema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "properties": { "serviceId": { "description": "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.", "minLength": 1, "type": "string" } }, "required": [ "serviceId" ], "type": "object" }, "name": "get_gameserver_config", "outputSchema": null }, { "description": "Read a recent gameserver console log snapshot. Requires an active ZapX Pass (see server instructions).", "inputSchema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "properties": { "lines": { "description": "Number of recent log lines to return, 1-200 (default 50). Values above 200 are rejected.", "exclusiveMinimum": 0, "maximum": 200, "type": "integer" }, "serviceId": { "description": "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.", "minLength": 1, "type": "string" } }, "required": [ "serviceId" ], "type": "object" }, "name": "get_gameserver_console_logs", "outputSchema": null }, { "description": "Get gameserver container and port reachability status.", "inputSchema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "properties": { "serviceId": { "description": "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.", "minLength": 1, "type": "string" } }, "required": [ "serviceId" ], "type": "object" }, "name": "get_gameserver_container_status", "outputSchema": null }, { "description": "Read the free daily system backup of a gameserver: whether it runs (enabled), when the customer switched it off, next and last run (null without a ZapX Pass with backups) and canSwitchOff. Read-only: switching it off or on is only possible in the dashboard or via the REST API. Requires an active ZapX Pass (see server instructions).", "inputSchema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "properties": { "serviceId": { "description": "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.", "minLength": 1, "type": "string" } }, "required": [ "serviceId" ], "type": "object" }, "name": "get_gameserver_daily_backup", "outputSchema": null }, { "description": "Read gameserver external access details. Requires an active ZapX Pass (see server instructions).", "inputSchema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "properties": { "serviceId": { "description": "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.", "minLength": 1, "type": "string" } }, "required": [ "serviceId" ], "type": "object" }, "name": "get_gameserver_external_access", "outputSchema": null }, { "description": "Get live query status for a gameserver.", "inputSchema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "properties": { "serviceId": { "description": "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.", "minLength": 1, "type": "string" } }, "required": [ "serviceId" ], "type": "object" }, "name": "get_gameserver_live_status", "outputSchema": null }, { "description": "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.", "inputSchema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "properties": { "serviceId": { "description": "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.", "minLength": 1, "type": "string" } }, "required": [ "serviceId" ], "type": "object" }, "name": "get_gameserver_plan_change_options", "outputSchema": null }, { "description": "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. Requires an active ZapX Pass (see server instructions).", "inputSchema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "properties": { "serviceId": { "description": "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.", "minLength": 1, "type": "string" } }, "required": [ "serviceId" ], "type": "object" }, "name": "get_gameserver_rust_framework", "outputSchema": null }, { "description": "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. Requires an active ZapX Pass (see server instructions).", "inputSchema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "properties": { "serviceId": { "description": "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.", "minLength": 1, "type": "string" } }, "required": [ "serviceId" ], "type": "object" }, "name": "get_gameserver_workshop", "outputSchema": null }, { "description": "Poll the status of an async public API operation.", "inputSchema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "properties": { "operationId": { "minLength": 1, "type": "string" } }, "required": [ "operationId" ], "type": "object" }, "name": "get_operation_status", "outputSchema": null }, { "description": "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.", "inputSchema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "properties": { "orderId": { "description": "orderId returned by create_order (or an order id from the dashboard).", "minLength": 1, "type": "string" } }, "required": [ "orderId" ], "type": "object" }, "name": "get_order_status", "outputSchema": null }, { "description": "Whether the account can pay for an order: saved payment method and billing details (country, name) for the first paid order. When something is missing (or with includeSetupLink=true) it returns paymentSetup.url, a 60-minute link the user opens in their browser to set the billing country and add a payment method. Use it when preview_order reports NO_PAYMENT_METHOD or BILLING_PROFILE_INCOMPLETE, and after the user says they are done. Never ask for card details in the chat. Read-only apart from issuing the link.", "inputSchema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "properties": { "includeSetupLink": { "description": "true to also get a setup link when nothing is missing, e.g. because the user wants to change their payment method before ordering. A link is always included when something is missing.", "type": "boolean" } }, "type": "object" }, "name": "get_payment_setup_status", "outputSchema": null }, { "description": "Poll the status of a service plan change by change ID after a confirmed apply_* call (billing commit, queue, and infrastructure apply).", "inputSchema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "properties": { "changeId": { "minLength": 1, "type": "string" } }, "required": [ "changeId" ], "type": "object" }, "name": "get_plan_change_status", "outputSchema": null }, { "description": "Read TeamSpeak server configuration. Requires an active ZapX Pass (see server instructions).", "inputSchema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "properties": { "serviceId": { "description": "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.", "minLength": 1, "type": "string" } }, "required": [ "serviceId" ], "type": "object" }, "name": "get_teamspeak_config", "outputSchema": null }, { "description": "Get TeamSpeak server metrics.", "inputSchema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "properties": { "serviceId": { "description": "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.", "minLength": 1, "type": "string" } }, "required": [ "serviceId" ], "type": "object" }, "name": "get_teamspeak_metrics", "outputSchema": null }, { "description": "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.", "inputSchema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "properties": { "serviceId": { "description": "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.", "minLength": 1, "type": "string" } }, "required": [ "serviceId" ], "type": "object" }, "name": "get_teamspeak_plan_change_options", "outputSchema": null }, { "description": "Get one TeamSpeak server by ID.", "inputSchema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "properties": { "serviceId": { "description": "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.", "minLength": 1, "type": "string" } }, "required": [ "serviceId" ], "type": "object" }, "name": "get_teamspeak_server", "outputSchema": null }, { "description": "Get one VPS by ID.", "inputSchema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "properties": { "serviceId": { "description": "ID of the VPS: the \"id\" field from list_account_services or list_vservers (e.g. \"cmabc123...\"). The numericId shown in the panel (e.g. \"180\") is accepted too. IDs of other service types do not work here.", "minLength": 1, "type": "string" } }, "required": [ "serviceId" ], "type": "object" }, "name": "get_vserver", "outputSchema": null }, { "description": "Read paginated VPS activity log entries.", "inputSchema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "properties": { "limit": { "maximum": 100, "minimum": 1, "type": "integer" }, "offset": { "maximum": 9007199254740991, "minimum": 0, "type": "integer" }, "serviceId": { "description": "ID of the VPS: the \"id\" field from list_account_services or list_vservers (e.g. \"cmabc123...\"). The numericId shown in the panel (e.g. \"180\") is accepted too. IDs of other service types do not work here.", "minLength": 1, "type": "string" } }, "required": [ "serviceId" ], "type": "object" }, "name": "get_vserver_activity", "outputSchema": null }, { "description": "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). Requires an active ZapX Pass (see server instructions).", "inputSchema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "properties": { "catalogType": { "maxLength": 128, "minLength": 1, "type": "string" }, "serviceId": { "description": "ID of the VPS: the \"id\" field from list_account_services or list_vservers (e.g. \"cmabc123...\"). The numericId shown in the panel (e.g. \"180\") is accepted too. IDs of other service types do not work here.", "minLength": 1, "type": "string" } }, "required": [ "serviceId", "catalogType" ], "type": "object" }, "name": "get_vserver_app_catalog_entry", "outputSchema": null }, { "description": "Recent container logs of an installed One-Click App on a VPS (secrets and login links removed). Read them before suggesting a restart. Requires an active ZapX Pass (see server instructions).", "inputSchema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "properties": { "installationId": { "description": "Installation id from get_vserver_apps / get_dedicated_apps.", "maxLength": 64, "minLength": 1, "type": "string" }, "lines": { "maximum": 500, "minimum": 50, "type": "integer" }, "serviceId": { "description": "ID of the VPS: the \"id\" field from list_account_services or list_vservers (e.g. \"cmabc123...\"). The numericId shown in the panel (e.g. \"180\") is accepted too. IDs of other service types do not work here.", "minLength": 1, "type": "string" } }, "required": [ "serviceId", "installationId" ], "type": "object" }, "name": "get_vserver_app_logs", "outputSchema": null }, { "description": "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. Requires an active ZapX Pass (see server instructions).", "inputSchema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "properties": { "live": { "description": "Ask the panel for the live status (slower; needs the manage permission), default the stored status.", "type": "boolean" }, "serviceId": { "description": "ID of the VPS: the \"id\" field from list_account_services or list_vservers (e.g. \"cmabc123...\"). The numericId shown in the panel (e.g. \"180\") is accepted too. IDs of other service types do not work here.", "minLength": 1, "type": "string" } }, "required": [ "serviceId" ], "type": "object" }, "name": "get_vserver_apps", "outputSchema": null }, { "description": "Read VPS configuration. Requires an active ZapX Pass (see server instructions).", "inputSchema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "properties": { "serviceId": { "description": "ID of the VPS: the \"id\" field from list_account_services or list_vservers (e.g. \"cmabc123...\"). The numericId shown in the panel (e.g. \"180\") is accepted too. IDs of other service types do not work here.", "minLength": 1, "type": "string" } }, "required": [ "serviceId" ], "type": "object" }, "name": "get_vserver_config", "outputSchema": null }, { "description": "Read the daily system backup of a VPS: whether it runs (enabled), when the customer switched it off, next and last run (null without a ZapX Pass with backups) and canSwitchOff. Read-only: switching it off or on is only possible in the dashboard or via the REST API. Fails when daily backups are not available for this VPS. Requires an active ZapX Pass (see server instructions).", "inputSchema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "properties": { "serviceId": { "description": "ID of the VPS: the \"id\" field from list_account_services or list_vservers (e.g. \"cmabc123...\"). The numericId shown in the panel (e.g. \"180\") is accepted too. IDs of other service types do not work here.", "minLength": 1, "type": "string" } }, "required": [ "serviceId" ], "type": "object" }, "name": "get_vserver_daily_backup", "outputSchema": null }, { "description": "Get DDoS pass/drop bandwidth statistics of a VPS IP. range: 10m, 1h (default), 1d or 1w. Requires an active ZapX Pass (see server instructions).", "inputSchema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "properties": { "ipAddress": { "type": "string" }, "range": { "enum": [ "10m", "1h", "1d", "1w" ], "type": "string" }, "serviceId": { "description": "ID of the VPS: the \"id\" field from list_account_services or list_vservers (e.g. \"cmabc123...\"). The numericId shown in the panel (e.g. \"180\") is accepted too. IDs of other service types do not work here.", "minLength": 1, "type": "string" } }, "required": [ "serviceId" ], "type": "object" }, "name": "get_vserver_ddos_bandwidth", "outputSchema": null }, { "description": "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. Requires an active ZapX Pass (see server instructions).", "inputSchema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "properties": { "ipAddress": { "type": "string" }, "serviceId": { "description": "ID of the VPS: the \"id\" field from list_account_services or list_vservers (e.g. \"cmabc123...\"). The numericId shown in the panel (e.g. \"180\") is accepted too. IDs of other service types do not work here.", "minLength": 1, "type": "string" } }, "required": [ "serviceId" ], "type": "object" }, "name": "get_vserver_ddos_status", "outputSchema": null }, { "description": "Read VPS DNS domains, subdomains, and favorite subdomain. Requires an active ZapX Pass (see server instructions).", "inputSchema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "properties": { "serviceId": { "description": "ID of the VPS: the \"id\" field from list_account_services or list_vservers (e.g. \"cmabc123...\"). The numericId shown in the panel (e.g. \"180\") is accepted too. IDs of other service types do not work here.", "minLength": 1, "type": "string" } }, "required": [ "serviceId" ], "type": "object" }, "name": "get_vserver_dns", "outputSchema": null }, { "description": "Read the VPS firewall configuration. Requires an active ZapX Pass (see server instructions).", "inputSchema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "properties": { "serviceId": { "description": "ID of the VPS: the \"id\" field from list_account_services or list_vservers (e.g. \"cmabc123...\"). The numericId shown in the panel (e.g. \"180\") is accepted too. IDs of other service types do not work here.", "minLength": 1, "type": "string" } }, "required": [ "serviceId" ], "type": "object" }, "name": "get_vserver_firewall", "outputSchema": null }, { "description": "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.", "inputSchema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "properties": { "serviceId": { "description": "ID of the VPS: the \"id\" field from list_account_services or list_vservers (e.g. \"cmabc123...\"). The numericId shown in the panel (e.g. \"180\") is accepted too. IDs of other service types do not work here.", "minLength": 1, "type": "string" }, "timeframe": { "enum": [ "hour", "day", "week", "month" ], "type": "string" } }, "required": [ "serviceId" ], "type": "object" }, "name": "get_vserver_metrics", "outputSchema": null }, { "description": "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.", "inputSchema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "properties": { "serviceId": { "description": "ID of the VPS: the \"id\" field from list_account_services or list_vservers (e.g. \"cmabc123...\"). The numericId shown in the panel (e.g. \"180\") is accepted too. IDs of other service types do not work here.", "minLength": 1, "type": "string" } }, "required": [ "serviceId" ], "type": "object" }, "name": "get_vserver_plan_change_options", "outputSchema": null }, { "description": "Read the reverse DNS (PTR) entries of the VPS IPv4 addresses and IPv6 prefixes. Requires an active ZapX Pass (see server instructions).", "inputSchema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "properties": { "serviceId": { "description": "ID of the VPS: the \"id\" field from list_account_services or list_vservers (e.g. \"cmabc123...\"). The numericId shown in the panel (e.g. \"180\") is accepted too. IDs of other service types do not work here.", "minLength": 1, "type": "string" } }, "required": [ "serviceId" ], "type": "object" }, "name": "get_vserver_reverse_dns", "outputSchema": null }, { "description": "Read paginated VPS network traffic history.", "inputSchema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "properties": { "limit": { "maximum": 100, "minimum": 1, "type": "integer" }, "offset": { "maximum": 9007199254740991, "minimum": 0, "type": "integer" }, "serviceId": { "description": "ID of the VPS: the \"id\" field from list_account_services or list_vservers (e.g. \"cmabc123...\"). The numericId shown in the panel (e.g. \"180\") is accepted too. IDs of other service types do not work here.", "minLength": 1, "type": "string" } }, "required": [ "serviceId" ], "type": "object" }, "name": "get_vserver_traffic", "outputSchema": null }, { "description": "Import a custom ISO for dedicated servers. Requires confirm=true. Requires an active ZapX Pass (see server instructions).", "inputSchema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "properties": { "confirm": { "type": "boolean" }, "displayName": { "minLength": 1, "type": "string" }, "filename": { "type": "string" }, "serviceId": { "description": "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.", "minLength": 1, "type": "string" }, "sourceUrl": { "format": "uri", "type": "string" } }, "required": [ "serviceId", "displayName", "sourceUrl" ], "type": "object" }, "name": "import_dedicated_custom_iso", "outputSchema": null }, { "description": "Import an own ISO from a public URL into the VPS ISO library. Returns an operation. Requires confirm=true. Requires an active ZapX Pass (see server instructions).", "inputSchema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "properties": { "confirm": { "type": "boolean" }, "displayName": { "minLength": 1, "type": "string" }, "filename": { "type": "string" }, "osProfile": { "description": "OS of the ISO, sets the hardware profile on mount.", "enum": [ "linux", "windows" ], "type": "string" }, "serviceId": { "description": "ID of the VPS: the \"id\" field from list_account_services or list_vservers (e.g. \"cmabc123...\"). The numericId shown in the panel (e.g. \"180\") is accepted too. IDs of other service types do not work here.", "minLength": 1, "type": "string" }, "sourceUrl": { "description": "Public http(s) URL of the .iso file.", "minLength": 1, "type": "string" } }, "required": [ "serviceId", "displayName", "sourceUrl" ], "type": "object" }, "name": "import_vserver_custom_iso", "outputSchema": null }, { "description": "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. Requires an active ZapX Pass (see server instructions).", "inputSchema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "properties": { "catalogType": { "description": "Catalog type from the app catalog.", "maxLength": 128, "minLength": 1, "type": "string" }, "confirm": { "type": "boolean" }, "customEnvs": { "items": { "properties": { "key": { "maxLength": 256, "type": "string" }, "value": { "maxLength": 4096, "type": "string" } }, "required": [ "key", "value" ], "type": "object" }, "maxItems": 50, "type": "array" }, "displayName": { "maxLength": 80, "minLength": 2, "type": "string" }, "envValues": { "additionalProperties": { "maxLength": 4096, "type": "string" }, "description": "Non-secret catalog fields only (see the catalog entry's install.requiredCustomerEnvFields).", "propertyNames": { "maxLength": 256, "type": "string" }, "type": "object" }, "serviceId": { "description": "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.", "minLength": 1, "type": "string" } }, "required": [ "serviceId", "catalogType", "displayName" ], "type": "object" }, "name": "install_dedicated_app", "outputSchema": null }, { "description": "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. Requires an active ZapX Pass (see server instructions).", "inputSchema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "properties": { "confirm": { "type": "boolean" }, "projectId": { "maxLength": 200, "minLength": 1, "type": "string" }, "provider": { "enum": [ "modrinth", "curseforge", "thunderstore", "umod", "beamng", "ficsit", "hangar" ], "type": "string" }, "resolveDependencies": { "type": "boolean" }, "serviceId": { "description": "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.", "minLength": 1, "type": "string" }, "title": { "maxLength": 200, "type": "string" }, "versionId": { "maxLength": 200, "minLength": 1, "type": "string" } }, "required": [ "serviceId", "provider", "projectId" ], "type": "object" }, "name": "install_gameserver_mod", "outputSchema": null }, { "description": "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. Requires an active ZapX Pass (see server instructions).", "inputSchema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "properties": { "confirm": { "type": "boolean" }, "modpackId": { "minLength": 1, "type": "string" }, "serviceId": { "description": "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.", "minLength": 1, "type": "string" }, "versionId": { "minLength": 1, "type": "string" } }, "required": [ "serviceId", "modpackId", "versionId" ], "type": "object" }, "name": "install_gameserver_modpack", "outputSchema": null }, { "description": "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. Requires an active ZapX Pass (see server instructions).", "inputSchema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "properties": { "confirm": { "type": "boolean" }, "projectId": { "maxLength": 200, "minLength": 1, "type": "string" }, "provider": { "enum": [ "modrinth", "hangar" ], "type": "string" }, "resolveDependencies": { "type": "boolean" }, "serviceId": { "description": "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.", "minLength": 1, "type": "string" }, "title": { "maxLength": 200, "type": "string" }, "versionId": { "maxLength": 200, "minLength": 1, "type": "string" } }, "required": [ "serviceId", "provider", "projectId" ], "type": "object" }, "name": "install_gameserver_plugin", "outputSchema": null }, { "description": "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. Requires an active ZapX Pass (see server instructions).", "inputSchema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "properties": { "catalogType": { "description": "Catalog type from the app catalog.", "maxLength": 128, "minLength": 1, "type": "string" }, "confirm": { "type": "boolean" }, "customEnvs": { "items": { "properties": { "key": { "maxLength": 256, "type": "string" }, "value": { "maxLength": 4096, "type": "string" } }, "required": [ "key", "value" ], "type": "object" }, "maxItems": 50, "type": "array" }, "displayName": { "maxLength": 80, "minLength": 2, "type": "string" }, "envValues": { "additionalProperties": { "maxLength": 4096, "type": "string" }, "description": "Non-secret catalog fields only (see the catalog entry's install.requiredCustomerEnvFields).", "propertyNames": { "maxLength": 256, "type": "string" }, "type": "object" }, "serviceId": { "description": "ID of the VPS: the \"id\" field from list_account_services or list_vservers (e.g. \"cmabc123...\"). The numericId shown in the panel (e.g. \"180\") is accepted too. IDs of other service types do not work here.", "minLength": 1, "type": "string" }, "withoutHostname": { "description": "Skip the default HTTPS zap.cloud address (only when the user wants no domain).", "type": "boolean" } }, "required": [ "serviceId", "catalogType", "displayName" ], "type": "object" }, "name": "install_vserver_app", "outputSchema": null }, { "description": "Issue a remote management launch URL for a dedicated server. Requires confirm=true. Requires an active ZapX Pass (see server instructions).", "inputSchema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "properties": { "confirm": { "type": "boolean" }, "serviceId": { "description": "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.", "minLength": 1, "type": "string" } }, "required": [ "serviceId" ], "type": "object" }, "name": "launch_dedicated_remote_management", "outputSchema": null }, { "description": "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, ...).", "inputSchema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "properties": {}, "type": "object" }, "name": "list_account_services", "outputSchema": null }, { "description": "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. Requires an active ZapX Pass (see server instructions).", "inputSchema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "properties": { "category": { "maxLength": 100, "type": "string" }, "page": { "exclusiveMinimum": 0, "maximum": 9007199254740991, "type": "integer" }, "pageSize": { "exclusiveMinimum": 0, "maximum": 50, "type": "integer" }, "search": { "description": "Free text search over name, description and tags.", "maxLength": 200, "type": "string" }, "serviceId": { "description": "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.", "minLength": 1, "type": "string" } }, "required": [ "serviceId" ], "type": "object" }, "name": "list_dedicated_app_catalog", "outputSchema": null }, { "description": "List custom ISO assets available for a dedicated server. Requires an active ZapX Pass (see server instructions).", "inputSchema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "properties": { "serviceId": { "description": "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.", "minLength": 1, "type": "string" } }, "required": [ "serviceId" ], "type": "object" }, "name": "list_dedicated_custom_isos", "outputSchema": null }, { "description": "List DDoS incidents for a dedicated server. Requires an active ZapX Pass (see server instructions).", "inputSchema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "properties": { "ipAddress": { "type": "string" }, "page": { "exclusiveMinimum": 0, "maximum": 9007199254740991, "type": "integer" }, "pageSize": { "exclusiveMinimum": 0, "maximum": 100, "type": "integer" }, "serviceId": { "description": "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.", "minLength": 1, "type": "string" } }, "required": [ "serviceId" ], "type": "object" }, "name": "list_dedicated_ddos_incidents", "outputSchema": null }, { "description": "List DDoS protection rules for a dedicated server. Requires an active ZapX Pass (see server instructions).", "inputSchema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "properties": { "ipAddress": { "type": "string" }, "serviceId": { "description": "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.", "minLength": 1, "type": "string" } }, "required": [ "serviceId" ], "type": "object" }, "name": "list_dedicated_ddos_rules", "outputSchema": null }, { "description": "List the OS installation ISOs of the dedicated server catalog. They are not installed automatically: mount one and install it through remote management. Requires an active ZapX Pass (see server instructions).", "inputSchema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "properties": {}, "type": "object" }, "name": "list_dedicated_reinstall_templates", "outputSchema": null }, { "description": "List dedicated servers accessible with the current credential. Prefer list_account_services for cross-product discovery.", "inputSchema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "properties": {}, "type": "object" }, "name": "list_dedicated_servers", "outputSchema": null }, { "description": "List files in a Discord bot directory. Requires an active ZapX Pass (see server instructions).", "inputSchema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "properties": { "includeFolderSizes": { "type": "boolean" }, "path": { "type": "string" }, "serviceId": { "description": "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.", "minLength": 1, "type": "string" } }, "required": [ "serviceId" ], "type": "object" }, "name": "list_discord_bot_files", "outputSchema": null }, { "description": "List the schedules of a Discord bot (restart, start, stop, console command, backup) with cron, timezone, next and last run. Bot owner only. Only schedules whose action the credential may manage are listed. `runOnceAt` set = one-time schedule: it runs once at that local time in `timezone` (`runOnceAtUtc` = same instant in UTC; its `cron` is only that minute, not a yearly repeat); `runOnceStatus` is pending, done (it ran, see lastRunAt) or expired (time passed without a successful run). Requires an active ZapX Pass (see server instructions).", "inputSchema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "properties": { "serviceId": { "description": "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.", "minLength": 1, "type": "string" } }, "required": [ "serviceId" ], "type": "object" }, "name": "list_discord_bot_schedules", "outputSchema": null }, { "description": "List Discord bots accessible with the current token.", "inputSchema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "properties": {}, "type": "object" }, "name": "list_discord_bots", "outputSchema": null }, { "description": "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.", "inputSchema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "properties": {}, "type": "object" }, "name": "list_domains", "outputSchema": null }, { "description": "List gameserver backups. Requires an active ZapX Pass (see server instructions).", "inputSchema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "properties": { "serviceId": { "description": "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.", "minLength": 1, "type": "string" } }, "required": [ "serviceId" ], "type": "object" }, "name": "list_gameserver_backups", "outputSchema": null }, { "description": "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. Requires an active ZapX Pass (see server instructions).", "inputSchema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "properties": { "serviceId": { "description": "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.", "minLength": 1, "type": "string" } }, "required": [ "serviceId" ], "type": "object" }, "name": "list_gameserver_databases", "outputSchema": null }, { "description": "List files in a gameserver directory. Requires an active ZapX Pass (see server instructions).", "inputSchema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "properties": { "includeFolderSizes": { "type": "boolean" }, "path": { "type": "string" }, "scope": { "description": "Without scope paths start at the server root (as `list_gameserver_files` without scope shows them); `config`/`active` resolve paths from the game data root; `savegame` additionally restricts to savegame paths. Read and write a file with the same scope.", "enum": [ "savegame", "config", "active" ], "type": "string" }, "serviceId": { "description": "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.", "minLength": 1, "type": "string" } }, "required": [ "serviceId" ], "type": "object" }, "name": "list_gameserver_files", "outputSchema": null }, { "description": "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. Requires an active ZapX Pass (see server instructions).", "inputSchema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "properties": { "limit": { "maximum": 100, "minimum": 1, "type": "integer" }, "modpackId": { "minLength": 1, "type": "string" }, "offset": { "maximum": 100000, "minimum": 0, "type": "integer" }, "provider": { "enum": [ "all", "modrinth", "curseforge", "ftb", "technic" ], "type": "string" }, "search": { "maxLength": 200, "type": "string" }, "serviceId": { "description": "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.", "minLength": 1, "type": "string" } }, "required": [ "serviceId" ], "type": "object" }, "name": "list_gameserver_modpacks", "outputSchema": null }, { "description": "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. Requires an active ZapX Pass (see server instructions).", "inputSchema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "properties": { "installedOnly": { "type": "boolean" }, "limit": { "exclusiveMinimum": 0, "maximum": 48, "type": "integer" }, "offset": { "maximum": 9007199254740991, "minimum": 0, "type": "integer" }, "provider": { "type": "string" }, "query": { "type": "string" }, "serviceId": { "description": "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.", "minLength": 1, "type": "string" }, "sort": { "enum": [ "relevance", "downloads", "updated", "newest" ], "type": "string" } }, "required": [ "serviceId" ], "type": "object" }, "name": "list_gameserver_mods", "outputSchema": null }, { "description": "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. Requires an active ZapX Pass (see server instructions).", "inputSchema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "properties": { "installedOnly": { "type": "boolean" }, "limit": { "maximum": 48, "minimum": 1, "type": "integer" }, "offset": { "maximum": 9007199254740991, "minimum": 0, "type": "integer" }, "provider": { "enum": [ "all", "modrinth", "hangar" ], "type": "string" }, "query": { "maxLength": 200, "type": "string" }, "serviceId": { "description": "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.", "minLength": 1, "type": "string" }, "sort": { "maxLength": 40, "type": "string" } }, "required": [ "serviceId" ], "type": "object" }, "name": "list_gameserver_plugins", "outputSchema": null }, { "description": "List gameserver savegames. Requires an active ZapX Pass (see server instructions).", "inputSchema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "properties": { "limit": { "exclusiveMinimum": 0, "maximum": 100, "type": "integer" }, "page": { "exclusiveMinimum": 0, "maximum": 9007199254740991, "type": "integer" }, "serviceId": { "description": "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.", "minLength": 1, "type": "string" } }, "required": [ "serviceId" ], "type": "object" }, "name": "list_gameserver_savegames", "outputSchema": null }, { "description": "List the 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. `runOnceAt` set = one-time schedule: it runs once at that local time in `timezone` (`runOnceAtUtc` = same instant in UTC; its `cron` is only that minute, not a yearly repeat); `runOnceStatus` is pending, done (it ran, see lastRunAt) or expired (time passed without a successful run). Requires an active ZapX Pass (see server instructions).", "inputSchema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "properties": { "serviceId": { "description": "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.", "minLength": 1, "type": "string" } }, "required": [ "serviceId" ], "type": "object" }, "name": "list_gameserver_schedules", "outputSchema": null }, { "description": "List gameservers accessible with the current credential. Prefer list_account_services for cross-product discovery.", "inputSchema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "properties": {}, "type": "object" }, "name": "list_gameservers", "outputSchema": null }, { "description": "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.", "inputSchema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "properties": { "resolvedHours": { "maximum": 168, "minimum": 0, "type": "integer" } }, "type": "object" }, "name": "list_incidents", "outputSchema": null }, { "description": "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.", "inputSchema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "properties": {}, "type": "object" }, "name": "list_order_regions", "outputSchema": null }, { "description": "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.", "inputSchema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "properties": {}, "type": "object" }, "name": "list_orderable_games", "outputSchema": null }, { "description": "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.", "inputSchema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "properties": { "productSlug": { "description": "Product slug from list_orderable_products, e.g. the productSlug field of a product.", "minLength": 1, "type": "string" } }, "required": [ "productSlug" ], "type": "object" }, "name": "list_orderable_plans", "outputSchema": null }, { "description": "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.", "inputSchema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "properties": { "productSlug": { "description": "Product slug from list_orderable_products, e.g. the productSlug field of a product.", "minLength": 1, "type": "string" } }, "required": [ "productSlug" ], "type": "object" }, "name": "list_orderable_product_regions", "outputSchema": null }, { "description": "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.", "inputSchema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "properties": {}, "type": "object" }, "name": "list_orderable_products", "outputSchema": null }, { "description": "List TeamSpeak server bans. Requires an active ZapX Pass (see server instructions).", "inputSchema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "properties": { "serviceId": { "description": "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.", "minLength": 1, "type": "string" } }, "required": [ "serviceId" ], "type": "object" }, "name": "list_teamspeak_bans", "outputSchema": null }, { "description": "List connected TeamSpeak clients. Requires an active ZapX Pass (see server instructions).", "inputSchema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "properties": { "serviceId": { "description": "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.", "minLength": 1, "type": "string" } }, "required": [ "serviceId" ], "type": "object" }, "name": "list_teamspeak_clients", "outputSchema": null }, { "description": "List TeamSpeak servers accessible with the current credential. Prefer list_account_services for cross-product discovery.", "inputSchema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "properties": {}, "type": "object" }, "name": "list_teamspeak_servers", "outputSchema": null }, { "description": "List privilege tokens for a TeamSpeak server. Requires an active ZapX Pass (see server instructions).", "inputSchema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "properties": { "serviceId": { "description": "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.", "minLength": 1, "type": "string" } }, "required": [ "serviceId" ], "type": "object" }, "name": "list_teamspeak_tokens", "outputSchema": null }, { "description": "List SSH keys stored on the authenticated account. Requires an active ZapX Pass (see server instructions).", "inputSchema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "properties": {}, "type": "object" }, "name": "list_vserver_account_ssh_keys", "outputSchema": null }, { "description": "Search the One-Click Apps catalog for a VPS (name, description, category, paged). Use the type with get_vserver_app_catalog_entry before installing. Requires an active ZapX Pass (see server instructions).", "inputSchema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "properties": { "category": { "maxLength": 100, "type": "string" }, "page": { "exclusiveMinimum": 0, "maximum": 9007199254740991, "type": "integer" }, "pageSize": { "exclusiveMinimum": 0, "maximum": 50, "type": "integer" }, "search": { "description": "Free text search over name, description and tags.", "maxLength": 200, "type": "string" }, "serviceId": { "description": "ID of the VPS: the \"id\" field from list_account_services or list_vservers (e.g. \"cmabc123...\"). The numericId shown in the panel (e.g. \"180\") is accepted too. IDs of other service types do not work here.", "minLength": 1, "type": "string" } }, "required": [ "serviceId" ], "type": "object" }, "name": "list_vserver_app_catalog", "outputSchema": null }, { "description": "List VPS backups. Requires an active ZapX Pass (see server instructions).", "inputSchema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "properties": { "serviceId": { "description": "ID of the VPS: the \"id\" field from list_account_services or list_vservers (e.g. \"cmabc123...\"). The numericId shown in the panel (e.g. \"180\") is accepted too. IDs of other service types do not work here.", "minLength": 1, "type": "string" } }, "required": [ "serviceId" ], "type": "object" }, "name": "list_vserver_backups", "outputSchema": null }, { "description": "List the customer's own imported ISO images for VPS. Requires an active ZapX Pass (see server instructions).", "inputSchema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "properties": { "serviceId": { "description": "ID of the VPS: the \"id\" field from list_account_services or list_vservers (e.g. \"cmabc123...\"). The numericId shown in the panel (e.g. \"180\") is accepted too. IDs of other service types do not work here.", "minLength": 1, "type": "string" } }, "required": [ "serviceId" ], "type": "object" }, "name": "list_vserver_custom_isos", "outputSchema": null }, { "description": "List inbound DDoS incidents against a VPS IP (paginated). Requires an active ZapX Pass (see server instructions).", "inputSchema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "properties": { "ipAddress": { "type": "string" }, "page": { "exclusiveMinimum": 0, "maximum": 9007199254740991, "type": "integer" }, "pageSize": { "exclusiveMinimum": 0, "maximum": 100, "type": "integer" }, "serviceId": { "description": "ID of the VPS: the \"id\" field from list_account_services or list_vservers (e.g. \"cmabc123...\"). The numericId shown in the panel (e.g. \"180\") is accepted too. IDs of other service types do not work here.", "minLength": 1, "type": "string" } }, "required": [ "serviceId" ], "type": "object" }, "name": "list_vserver_ddos_incidents", "outputSchema": null }, { "description": "List the DDoS filter rules learned for a VPS IP. Requires an active ZapX Pass (see server instructions).", "inputSchema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "properties": { "ipAddress": { "type": "string" }, "serviceId": { "description": "ID of the VPS: the \"id\" field from list_account_services or list_vservers (e.g. \"cmabc123...\"). The numericId shown in the panel (e.g. \"180\") is accepted too. IDs of other service types do not work here.", "minLength": 1, "type": "string" } }, "required": [ "serviceId" ], "type": "object" }, "name": "list_vserver_ddos_rules", "outputSchema": null }, { "description": "List the ISO images that can be mounted on the VPS (ZAP library and own custom ISOs) and the mounted one. Requires an active ZapX Pass (see server instructions).", "inputSchema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "properties": { "serviceId": { "description": "ID of the VPS: the \"id\" field from list_account_services or list_vservers (e.g. \"cmabc123...\"). The numericId shown in the panel (e.g. \"180\") is accepted too. IDs of other service types do not work here.", "minLength": 1, "type": "string" } }, "required": [ "serviceId" ], "type": "object" }, "name": "list_vserver_isos", "outputSchema": null }, { "description": "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.", "inputSchema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "properties": {}, "type": "object" }, "name": "list_vserver_order_isos", "outputSchema": null }, { "description": "List outgoing DDoS attacks detected from a VPS and whether it is flagged for reinstall. Requires an active ZapX Pass (see server instructions).", "inputSchema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "properties": { "serviceId": { "description": "ID of the VPS: the \"id\" field from list_account_services or list_vservers (e.g. \"cmabc123...\"). The numericId shown in the panel (e.g. \"180\") is accepted too. IDs of other service types do not work here.", "minLength": 1, "type": "string" } }, "required": [ "serviceId" ], "type": "object" }, "name": "list_vserver_outgoing_ddos", "outputSchema": null }, { "description": "List available VPS reinstall templates. minDiskGb is the minimum disk in GB the template needs (null = none); templates above the VPS disk are rejected. Requires an active ZapX Pass (see server instructions).", "inputSchema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "properties": {}, "type": "object" }, "name": "list_vserver_reinstall_templates", "outputSchema": null }, { "description": "List recurring VPS schedules (restart, start, stop, guest-agent command) the credential may manage. Requires an active ZapX Pass (see server instructions).", "inputSchema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "properties": { "serviceId": { "description": "ID of the VPS: the \"id\" field from list_account_services or list_vservers (e.g. \"cmabc123...\"). The numericId shown in the panel (e.g. \"180\") is accepted too. IDs of other service types do not work here.", "minLength": 1, "type": "string" } }, "required": [ "serviceId" ], "type": "object" }, "name": "list_vserver_schedules", "outputSchema": null }, { "description": "List VPS VM snapshots. Requires an active ZapX Pass (see server instructions).", "inputSchema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "properties": { "serviceId": { "description": "ID of the VPS: the \"id\" field from list_account_services or list_vservers (e.g. \"cmabc123...\"). The numericId shown in the panel (e.g. \"180\") is accepted too. IDs of other service types do not work here.", "minLength": 1, "type": "string" } }, "required": [ "serviceId" ], "type": "object" }, "name": "list_vserver_snapshots", "outputSchema": null }, { "description": "List the account SSH keys installed on one VPS. Requires an active ZapX Pass (see server instructions).", "inputSchema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "properties": { "serviceId": { "description": "ID of the VPS: the \"id\" field from list_account_services or list_vservers (e.g. \"cmabc123...\"). The numericId shown in the panel (e.g. \"180\") is accepted too. IDs of other service types do not work here.", "minLength": 1, "type": "string" } }, "required": [ "serviceId" ], "type": "object" }, "name": "list_vserver_ssh_keys", "outputSchema": null }, { "description": "List VPS accessible with the current credential. Prefer list_account_services for cross-product discovery.", "inputSchema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "properties": {}, "type": "object" }, "name": "list_vservers", "outputSchema": null }, { "description": "Start, stop or restart an installed One-Click App on a dedicated server. Requires confirm=true. Requires an active ZapX Pass (see server instructions).", "inputSchema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "properties": { "action": { "enum": [ "start", "stop", "restart" ], "type": "string" }, "confirm": { "type": "boolean" }, "installationId": { "description": "Installation id from get_vserver_apps / get_dedicated_apps.", "maxLength": 64, "minLength": 1, "type": "string" }, "serviceId": { "description": "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.", "minLength": 1, "type": "string" } }, "required": [ "serviceId", "installationId", "action" ], "type": "object" }, "name": "manage_dedicated_app", "outputSchema": null }, { "description": "Start, stop or restart an installed One-Click App on a VPS. Requires confirm=true. Requires an active ZapX Pass (see server instructions).", "inputSchema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "properties": { "action": { "enum": [ "start", "stop", "restart" ], "type": "string" }, "confirm": { "type": "boolean" }, "installationId": { "description": "Installation id from get_vserver_apps / get_dedicated_apps.", "maxLength": 64, "minLength": 1, "type": "string" }, "serviceId": { "description": "ID of the VPS: the \"id\" field from list_account_services or list_vservers (e.g. \"cmabc123...\"). The numericId shown in the panel (e.g. \"180\") is accepted too. IDs of other service types do not work here.", "minLength": 1, "type": "string" } }, "required": [ "serviceId", "installationId", "action" ], "type": "object" }, "name": "manage_vserver_app", "outputSchema": null }, { "description": "Mount a custom ISO on a dedicated server. Requires confirm=true. Requires an active ZapX Pass (see server instructions).", "inputSchema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "properties": { "assetId": { "minLength": 1, "type": "string" }, "confirm": { "type": "boolean" }, "serviceId": { "description": "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.", "minLength": 1, "type": "string" } }, "required": [ "serviceId", "assetId" ], "type": "object" }, "name": "mount_dedicated_custom_iso", "outputSchema": null }, { "description": "Mount install media on a dedicated server. Requires confirm=true. Requires an active ZapX Pass (see server instructions).", "inputSchema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "properties": { "confirm": { "type": "boolean" }, "serviceId": { "description": "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.", "minLength": 1, "type": "string" }, "templateId": { "minLength": 1, "type": "string" } }, "required": [ "serviceId", "templateId" ], "type": "object" }, "name": "mount_dedicated_install_media", "outputSchema": null }, { "description": "Mount an ISO on the VPS (e.g. to install an own OS). Restart the VPS to boot from it. Requires confirm=true. Requires an active ZapX Pass (see server instructions).", "inputSchema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "properties": { "applyHardwareProfile": { "description": "Adapt the VM hardware to the ISO's OS (UEFI + TPM); default false. Set true for Windows 11 / UEFI-only ISOs.", "type": "boolean" }, "attachDriverDisc": { "description": "Attach the VirtIO driver disc (Windows installs).", "type": "boolean" }, "bootFromIso": { "description": "Boot from the ISO first; default true except driver/tool ISOs.", "type": "boolean" }, "confirm": { "type": "boolean" }, "isoId": { "description": "ISO id from list_vserver_isos `images[].id`.", "type": "string" }, "serviceId": { "description": "ID of the VPS: the \"id\" field from list_account_services or list_vservers (e.g. \"cmabc123...\"). The numericId shown in the panel (e.g. \"180\") is accepted too. IDs of other service types do not work here.", "minLength": 1, "type": "string" }, "volid": { "description": "Alternative to isoId: the image's `volid` from list_vserver_isos.", "type": "string" } }, "required": [ "serviceId" ], "type": "object" }, "name": "mount_vserver_iso", "outputSchema": null }, { "description": "Create, rename, delete, or write Discord bot file content. Destructive actions require confirm=true. Requires an active ZapX Pass (see server instructions).", "inputSchema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "properties": { "action": { "enum": [ "write", "create_file", "create_dir", "rename", "delete" ], "type": "string" }, "confirm": { "type": "boolean" }, "content": { "type": "string" }, "expectedRevision": { "description": "`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.", "type": "string" }, "newName": { "type": "string" }, "path": { "minLength": 1, "type": "string" }, "serviceId": { "description": "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.", "minLength": 1, "type": "string" } }, "required": [ "serviceId", "action", "path" ], "type": "object" }, "name": "mutate_discord_bot_file", "outputSchema": null }, { "description": "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. Requires an active ZapX Pass (see server instructions).", "inputSchema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "properties": { "action": { "enum": [ "write", "create_file", "create_dir", "rename", "delete", "move", "copy" ], "type": "string" }, "confirm": { "type": "boolean" }, "content": { "type": "string" }, "destination": { "description": "move/copy: existing folder the entries go into, keeping their names. Nothing is overwritten: a taken name or a missing folder refuses the request.", "type": "string" }, "expectedRevision": { "description": "`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.", "type": "string" }, "newName": { "type": "string" }, "path": { "description": "File or folder to act on (required except for move/copy given `paths`). For move/copy: the single entry to transfer.", "minLength": 1, "type": "string" }, "paths": { "description": "move/copy: several entries to transfer at once (overrides path).", "items": { "minLength": 1, "type": "string" }, "maxItems": 100, "minItems": 1, "type": "array" }, "scope": { "description": "Without scope paths start at the server root (as `list_gameserver_files` without scope shows them); `config`/`active` resolve paths from the game data root; `savegame` additionally restricts to savegame paths. Read and write a file with the same scope.", "enum": [ "savegame", "config", "active" ], "type": "string" }, "serviceId": { "description": "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.", "minLength": 1, "type": "string" } }, "required": [ "serviceId", "action" ], "type": "object" }, "name": "mutate_gameserver_file", "outputSchema": null }, { "description": "Create or delete a VPS firewall IP set, or add/remove an address (cidr). Rules reference a set as +name. Requires confirm=true. Requires an active ZapX Pass (see server instructions).", "inputSchema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "properties": { "action": { "enum": [ "create", "delete", "add_entry", "remove_entry" ], "type": "string" }, "cidr": { "description": "add_entry/remove_entry: IP address or CIDR, e.g. 203.0.113.7 or 198.51.100.0/24.", "type": "string" }, "comment": { "description": "add_entry: free text comment.", "type": "string" }, "confirm": { "type": "boolean" }, "name": { "description": "IP set name (letters, digits, - and _). Use it in rules as +name.", "minLength": 1, "type": "string" }, "serviceId": { "description": "ID of the VPS: the \"id\" field from list_account_services or list_vservers (e.g. \"cmabc123...\"). The numericId shown in the panel (e.g. \"180\") is accepted too. IDs of other service types do not work here.", "minLength": 1, "type": "string" } }, "required": [ "serviceId", "action", "name" ], "type": "object" }, "name": "mutate_vserver_firewall_ipset", "outputSchema": null }, { "description": "Add, update, delete or move a VPS firewall rule (positions from get_vserver_firewall). add/update need type and ruleAction; update replaces the whole rule, so send every field to keep (omitted optional fields are cleared). Requires confirm=true. Requires an active ZapX Pass (see server instructions).", "inputSchema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "properties": { "action": { "enum": [ "add", "update", "delete", "move" ], "type": "string" }, "comment": { "description": "add/update: free text comment.", "type": "string" }, "confirm": { "type": "boolean" }, "dest": { "description": "add/update: destination address, CIDR or +ipset_name. Empty = any.", "type": "string" }, "dport": { "description": "add/update: destination port(s), e.g. 22, 80,443 or 27015:27020.", "type": "string" }, "enable": { "description": "add/update: rule active (default true).", "type": "boolean" }, "log": { "description": "add/update: log level (default nolog).", "enum": [ "nolog", "alert", "crit", "debug", "emerg", "err", "info", "notice", "warning" ], "type": "string" }, "macro": { "description": "add/update: Proxmox firewall macro instead of proto/ports, e.g. SSH, HTTP, HTTPS, DNS, Ping.", "type": "string" }, "newPos": { "description": "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.", "maximum": 9007199254740991, "minimum": 0, "type": "integer" }, "pos": { "description": "update/delete/move: `pos` of the rule as returned by get_vserver_firewall.", "maximum": 9007199254740991, "minimum": 0, "type": "integer" }, "proto": { "description": "add/update: protocol, e.g. tcp, udp, icmp, icmpv6.", "type": "string" }, "ruleAction": { "description": "add/update: what the rule does with matching traffic.", "enum": [ "ACCEPT", "DROP", "REJECT" ], "type": "string" }, "serviceId": { "description": "ID of the VPS: the \"id\" field from list_account_services or list_vservers (e.g. \"cmabc123...\"). The numericId shown in the panel (e.g. \"180\") is accepted too. IDs of other service types do not work here.", "minLength": 1, "type": "string" }, "source": { "description": "add/update: source address, CIDR or +ipset_name (IP set of this VPS). Empty = any.", "type": "string" }, "sport": { "description": "add/update: source port(s), e.g. 1024:65535.", "type": "string" }, "type": { "description": "add/update: traffic direction.", "enum": [ "in", "out" ], "type": "string" } }, "required": [ "serviceId", "action" ], "type": "object" }, "name": "mutate_vserver_firewall_rule", "outputSchema": null }, { "description": "Update VPS hostname, DNS, ballooning, or SSH password settings. Requires confirm=true. Requires an active ZapX Pass (see server instructions).", "inputSchema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "properties": { "ballooningDisabled": { "type": "boolean" }, "confirm": { "type": "boolean" }, "dnsServer": { "type": "string" }, "hostname": { "type": "string" }, "serviceId": { "description": "ID of the VPS: the \"id\" field from list_account_services or list_vservers (e.g. \"cmabc123...\"). The numericId shown in the panel (e.g. \"180\") is accepted too. IDs of other service types do not work here.", "minLength": 1, "type": "string" }, "sshPasswordEnabled": { "type": "boolean" } }, "required": [ "serviceId" ], "type": "object" }, "name": "patch_vserver_config", "outputSchema": null }, { "description": "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.", "inputSchema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "properties": { "couponCode": { "description": "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.", "maxLength": 100, "type": "string" }, "serviceId": { "description": "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.", "minLength": 1, "type": "string" }, "target": { "properties": { "additionalIpCount": { "maximum": 9007199254740991, "minimum": 0, "type": "integer" }, "releaseIpAssignmentIds": { "items": { "minLength": 1, "type": "string" }, "type": "array" } }, "type": "object" } }, "required": [ "serviceId" ], "type": "object" }, "name": "preview_dedicated_plan_change", "outputSchema": null }, { "description": "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.", "inputSchema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "properties": { "couponCode": { "description": "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.", "maxLength": 100, "type": "string" }, "serviceId": { "description": "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.", "minLength": 1, "type": "string" }, "target": { "properties": { "cpuMillis": { "exclusiveMinimum": 0, "maximum": 9007199254740991, "type": "integer" }, "dedicatedIp": { "type": "boolean" }, "diskMb": { "exclusiveMinimum": 0, "maximum": 9007199254740991, "type": "integer" }, "premiumCpu": { "description": "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.", "type": "boolean" }, "pricingMode": { "enum": [ "package", "custom" ], "type": "string" }, "ramMb": { "exclusiveMinimum": 0, "maximum": 9007199254740991, "type": "integer" }, "slots": { "exclusiveMinimum": 0, "maximum": 9007199254740991, "type": "integer" }, "targetBillingIntervalCount": { "anyOf": [ { "exclusiveMinimum": 0, "maximum": 9007199254740991, "type": "integer" }, { "type": "null" } ] }, "targetPackageKey": { "minLength": 1, "type": "string" }, "targetRegionId": { "anyOf": [ { "minLength": 1, "type": "string" }, { "type": "null" } ] } }, "type": "object" } }, "required": [ "serviceId" ], "type": "object" }, "name": "preview_gameserver_plan_change", "outputSchema": null }, { "description": "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.", "inputSchema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "properties": { "billingCycleSlug": { "description": "Billing cycle: 3-day, monthly, quarterly, semi-annual or annual.", "enum": [ "3-day", "monthly", "quarterly", "semi-annual", "annual" ], "type": "string" }, "configuration": { "additionalProperties": {}, "description": "Product-specific configuration, same shape as the REST order body.", "propertyNames": { "type": "string" }, "type": "object" }, "domains": { "items": { "properties": { "authCode": { "type": "string" }, "dnsMode": { "enum": [ "managed", "external" ], "type": "string" }, "domain": { "type": "string" }, "enableCloudflareProtection": { "type": "boolean" }, "handleProfileId": { "type": "string" }, "periodYears": { "maximum": 9007199254740991, "minimum": -9007199254740991, "type": "integer" }, "registrationMode": { "enum": [ "register", "transfer" ], "type": "string" } }, "required": [ "domain", "registrationMode" ], "type": "object" }, "type": "array" }, "gameSlug": { "description": "Game slug from list_orderable_games (gameservers).", "type": "string" }, "options": { "properties": { "couponCode": { "type": "string" }, "dedicatedIpCount": { "maximum": 9007199254740991, "minimum": 0, "type": "integer" }, "domainAttachment": { "properties": { "attachMode": { "enum": [ "skip", "existing", "purchased" ], "type": "string" }, "existingDomainId": { "type": "string" }, "subdomainLabel": { "type": "string" }, "targetDomainName": { "type": "string" } }, "required": [ "attachMode" ], "type": "object" } }, "type": "object" }, "planSlug": { "description": "Plan slug from list_orderable_plans (products with fixed plans).", "type": "string" }, "productSlug": { "description": "Product slug from list_orderable_products.", "minLength": 1, "type": "string" }, "regionSlug": { "description": "Region slug from list_orderable_product_regions (products with region choice).", "type": "string" }, "resourceConfig": { "additionalProperties": { "type": "number" }, "description": "Resource values for configurable products, keyed as listed by list_orderable_plans.", "propertyNames": { "type": "string" }, "type": "object" } }, "required": [ "productSlug", "billingCycleSlug" ], "type": "object" }, "name": "preview_order", "outputSchema": null }, { "description": "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.", "inputSchema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "properties": { "couponCode": { "description": "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.", "maxLength": 100, "type": "string" }, "serviceId": { "description": "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.", "minLength": 1, "type": "string" }, "target": { "properties": { "hasAdvertisement": { "type": "boolean" }, "pricingMode": { "description": "Set \"custom\" to change slots on a package TeamSpeak server (otherwise the request is rejected); use targetPackageKey to switch package.", "enum": [ "package", "custom" ], "type": "string" }, "slots": { "exclusiveMinimum": 0, "maximum": 9007199254740991, "type": "integer" }, "targetBillingIntervalCount": { "anyOf": [ { "exclusiveMinimum": 0, "maximum": 9007199254740991, "type": "integer" }, { "type": "null" } ] }, "targetPackageKey": { "minLength": 1, "type": "string" } }, "type": "object" } }, "required": [ "serviceId" ], "type": "object" }, "name": "preview_teamspeak_plan_change", "outputSchema": null }, { "description": "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.", "inputSchema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "properties": { "couponCode": { "description": "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.", "maxLength": 100, "type": "string" }, "serviceId": { "description": "ID of the VPS: the \"id\" field from list_account_services or list_vservers (e.g. \"cmabc123...\"). The numericId shown in the panel (e.g. \"180\") is accepted too. IDs of other service types do not work here.", "minLength": 1, "type": "string" }, "target": { "properties": { "additionalIpCount": { "maximum": 9007199254740991, "minimum": 0, "type": "integer" }, "bandwidth": { "exclusiveMinimum": 0, "maximum": 9007199254740991, "type": "integer" }, "bandwidthMbps": { "exclusiveMinimum": 0, "maximum": 9007199254740991, "type": "integer" }, "cores": { "exclusiveMinimum": 0, "maximum": 9007199254740991, "type": "integer" }, "disk": { "exclusiveMinimum": 0, "maximum": 9007199254740991, "type": "integer" }, "diskGb": { "exclusiveMinimum": 0, "maximum": 9007199254740991, "type": "integer" }, "memory": { "exclusiveMinimum": 0, "maximum": 9007199254740991, "type": "integer" }, "memoryMb": { "exclusiveMinimum": 0, "maximum": 9007199254740991, "type": "integer" }, "pricingMode": { "description": "Set \"custom\" to change cores, memoryMb, diskGb or bandwidthMbps on a package VPS (otherwise the request is rejected); use targetPackageKey to switch package.", "enum": [ "package", "custom" ], "type": "string" }, "targetBillingIntervalCount": { "anyOf": [ { "exclusiveMinimum": 0, "maximum": 9007199254740991, "type": "integer" }, { "type": "null" } ] }, "targetPackageKey": { "minLength": 1, "type": "string" } }, "type": "object" } }, "required": [ "serviceId" ], "type": "object" }, "name": "preview_vserver_plan_change", "outputSchema": null }, { "description": "Read an editable text file from a Discord bot. Requires an active ZapX Pass (see server instructions).", "inputSchema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "properties": { "path": { "minLength": 1, "type": "string" }, "serviceId": { "description": "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.", "minLength": 1, "type": "string" } }, "required": [ "serviceId", "path" ], "type": "object" }, "name": "read_discord_bot_file", "outputSchema": null }, { "description": "Read text content of a gameserver file. Credential values (passwords, tokens, connection strings) come back as [configured]; write the placeholder back unchanged to keep the stored value. Requires an active ZapX Pass (see server instructions).", "inputSchema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "properties": { "path": { "minLength": 1, "type": "string" }, "scope": { "description": "Without scope paths start at the server root (as `list_gameserver_files` without scope shows them); `config`/`active` resolve paths from the game data root; `savegame` additionally restricts to savegame paths. Read and write a file with the same scope.", "enum": [ "savegame", "config", "active" ], "type": "string" }, "serviceId": { "description": "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.", "minLength": 1, "type": "string" } }, "required": [ "serviceId", "path" ], "type": "object" }, "name": "read_gameserver_file", "outputSchema": null }, { "description": "Recommend a gameserver or VPS plan from the user's needs (game, players at the same time, mods; or what runs on the VPS) with the shop's sizing logic. Returns the recommended configuration, alternatives and orderRequest, the exact arguments for preview_order and create_checkout_link. Works without sign-in. Read-only: nothing is ordered.", "inputSchema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "properties": { "description": { "description": "vserver: what will run on it, in the user's words (e.g. \"Nextcloud for 10 people\").", "maxLength": 500, "type": "string" }, "expectedPlayers": { "description": "gameserver: players online at the same time. Ask the user; without it the game's default is used.", "maximum": 500, "minimum": 1, "type": "integer" }, "gameSlug": { "description": "gameserver: gameSlug from list_orderable_games, or the game's name (e.g. \"Minecraft\").", "maxLength": 120, "minLength": 1, "type": "string" }, "minCpuCores": { "description": "Hard minimum CPU cores, only if the user states one.", "exclusiveMinimum": 0, "maximum": 256, "type": "number" }, "minDiskGb": { "description": "Hard minimum disk in GB, only if the user states one.", "exclusiveMinimum": 0, "maximum": 100000, "type": "number" }, "minRamGb": { "description": "Hard minimum RAM in GB, only if the user states one.", "exclusiveMinimum": 0, "maximum": 1024, "type": "number" }, "mods": { "description": "gameserver: none (vanilla), light (a few mods/plugins) or heavy (big modpacks, many plugins). Default none.", "enum": [ "none", "light", "heavy" ], "type": "string" }, "os": { "description": "vserver: operating system preference.", "enum": [ "linux", "windows", "no_preference" ], "type": "string" }, "priority": { "description": "lowest_cost, balanced (default) or performance_first.", "enum": [ "lowest_cost", "balanced", "performance_first" ], "type": "string" }, "productType": { "description": "gameserver: a server for one game. vserver: a VPS (website, bot, database, VPN, own software).", "enum": [ "gameserver", "vserver" ], "type": "string" }, "regionSlug": { "description": "Location from list_orderable_product_regions; omit for the automatic choice.", "maxLength": 80, "minLength": 1, "type": "string" }, "useCase": { "description": "vserver: main purpose.", "enum": [ "website", "api_backend", "database", "game_server", "vpn", "dev_test", "mixed", "other" ], "type": "string" }, "workload": { "description": "vserver: expected load. Default moderate.", "enum": [ "light", "moderate", "heavy", "very_heavy" ], "type": "string" } }, "required": [ "productType" ], "type": "object" }, "name": "recommend_plan", "outputSchema": null }, { "description": "Refresh dedicated server installation media and boot state. Requires confirm=true. Requires an active ZapX Pass (see server instructions).", "inputSchema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "properties": { "confirm": { "type": "boolean" }, "serviceId": { "description": "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.", "minLength": 1, "type": "string" } }, "required": [ "serviceId" ], "type": "object" }, "name": "refresh_dedicated_installation", "outputSchema": null }, { "description": "Reinstall a One-Click App on a dedicated server (redeploys it; keeps the data unless deleteVolumes=true). Requires confirm=true. Requires an active ZapX Pass (see server instructions).", "inputSchema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "properties": { "confirm": { "type": "boolean" }, "deleteVolumes": { "description": "Also delete the app's persistent data (volumes). Only when the user explicitly asked for it; default keeps the data.", "type": "boolean" }, "installationId": { "description": "Installation id from get_vserver_apps / get_dedicated_apps.", "maxLength": 64, "minLength": 1, "type": "string" }, "serviceId": { "description": "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.", "minLength": 1, "type": "string" } }, "required": [ "serviceId", "installationId" ], "type": "object" }, "name": "reinstall_dedicated_app", "outputSchema": null }, { "description": "Reinstall a gameserver. Requires confirm=true. Requires an active ZapX Pass (see server instructions).", "inputSchema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "properties": { "confirm": { "type": "boolean" }, "serviceId": { "description": "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.", "minLength": 1, "type": "string" } }, "required": [ "serviceId" ], "type": "object" }, "name": "reinstall_gameserver", "outputSchema": null }, { "description": "Reinstall a VPS. Requires confirm=true. Requires an active ZapX Pass (see server instructions).", "inputSchema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "properties": { "confirm": { "type": "boolean" }, "serviceId": { "description": "ID of the VPS: the \"id\" field from list_account_services or list_vservers (e.g. \"cmabc123...\"). The numericId shown in the panel (e.g. \"180\") is accepted too. IDs of other service types do not work here.", "minLength": 1, "type": "string" }, "templateId": { "type": "string" } }, "required": [ "serviceId" ], "type": "object" }, "name": "reinstall_vserver", "outputSchema": null }, { "description": "Reinstall a One-Click App on a VPS (redeploys it; keeps the data unless deleteVolumes=true). Requires confirm=true. Requires an active ZapX Pass (see server instructions).", "inputSchema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "properties": { "confirm": { "type": "boolean" }, "deleteVolumes": { "description": "Also delete the app's persistent data (volumes). Only when the user explicitly asked for it; default keeps the data.", "type": "boolean" }, "installationId": { "description": "Installation id from get_vserver_apps / get_dedicated_apps.", "maxLength": 64, "minLength": 1, "type": "string" }, "serviceId": { "description": "ID of the VPS: the \"id\" field from list_account_services or list_vservers (e.g. \"cmabc123...\"). The numericId shown in the panel (e.g. \"180\") is accepted too. IDs of other service types do not work here.", "minLength": 1, "type": "string" } }, "required": [ "serviceId", "installationId" ], "type": "object" }, "name": "reinstall_vserver_app", "outputSchema": null }, { "description": "Remove an SSH key from the VPS (the key stays in the account). Requires confirm=true. Requires an active ZapX Pass (see server instructions).", "inputSchema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "properties": { "confirm": { "type": "boolean" }, "serviceId": { "description": "ID of the VPS: the \"id\" field from list_account_services or list_vservers (e.g. \"cmabc123...\"). The numericId shown in the panel (e.g. \"180\") is accepted too. IDs of other service types do not work here.", "minLength": 1, "type": "string" }, "sshKeyId": { "description": "Key id from list_vserver_ssh_keys.", "minLength": 1, "type": "string" } }, "required": [ "serviceId", "sshKeyId" ], "type": "object" }, "name": "remove_vserver_ssh_key", "outputSchema": null }, { "description": "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.", "inputSchema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "properties": { "details": { "description": "What you tried, what you expected and what happened (error text). No secrets or file contents.", "maxLength": 4000, "type": "string" }, "exampleArgs": { "additionalProperties": {}, "description": "Optional arguments of the failing call, without secrets.", "propertyNames": { "type": "string" }, "type": "object" }, "kind": { "enum": [ "bug", "missing_capability", "unclear_tool_description", "improvement" ], "type": "string" }, "relatedTool": { "description": "Name of the tool the report is about, if any (e.g. get_gameserver).", "maxLength": 100, "type": "string" }, "summary": { "description": "One sentence: what went wrong or what is missing.", "maxLength": 200, "minLength": 5, "type": "string" } }, "required": [ "kind", "summary" ], "type": "object" }, "name": "report_mcp_feedback", "outputSchema": null }, { "description": "Restart a dedicated server. Requires confirm=true.", "inputSchema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "properties": { "confirm": { "type": "boolean" }, "mode": { "enum": [ "gracefulRestart", "forceRestart", "powerCycle" ], "type": "string" }, "serviceId": { "description": "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.", "minLength": 1, "type": "string" } }, "required": [ "serviceId" ], "type": "object" }, "name": "restart_dedicated_server", "outputSchema": null }, { "description": "Restart a Discord bot. Requires confirm=true.", "inputSchema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "properties": { "confirm": { "type": "boolean" }, "serviceId": { "description": "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.", "minLength": 1, "type": "string" } }, "required": [ "serviceId" ], "type": "object" }, "name": "restart_discord_bot", "outputSchema": null }, { "description": "Restart a gameserver. Requires confirm=true because this is a power action.", "inputSchema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "properties": { "confirm": { "type": "boolean" }, "serviceId": { "description": "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.", "minLength": 1, "type": "string" } }, "required": [ "serviceId" ], "type": "object" }, "name": "restart_gameserver", "outputSchema": null }, { "description": "Restart a TeamSpeak server. Requires confirm=true.", "inputSchema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "properties": { "confirm": { "type": "boolean" }, "serviceId": { "description": "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.", "minLength": 1, "type": "string" } }, "required": [ "serviceId" ], "type": "object" }, "name": "restart_teamspeak_server", "outputSchema": null }, { "description": "Restart a VPS. Requires confirm=true.", "inputSchema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "properties": { "confirm": { "type": "boolean" }, "serviceId": { "description": "ID of the VPS: the \"id\" field from list_account_services or list_vservers (e.g. \"cmabc123...\"). The numericId shown in the panel (e.g. \"180\") is accepted too. IDs of other service types do not work here.", "minLength": 1, "type": "string" } }, "required": [ "serviceId" ], "type": "object" }, "name": "restart_vserver", "outputSchema": null }, { "description": "Restore a gameserver backup. Requires confirm=true. Requires an active ZapX Pass (see server instructions).", "inputSchema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "properties": { "backupId": { "minLength": 1, "type": "string" }, "confirm": { "type": "boolean" }, "serviceId": { "description": "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.", "minLength": 1, "type": "string" } }, "required": [ "serviceId", "backupId" ], "type": "object" }, "name": "restore_gameserver_backup", "outputSchema": null }, { "description": "Restore a VPS backup. Requires confirm=true. Requires an active ZapX Pass (see server instructions).", "inputSchema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "properties": { "backupId": { "minLength": 1, "type": "string" }, "confirm": { "type": "boolean" }, "serviceId": { "description": "ID of the VPS: the \"id\" field from list_account_services or list_vservers (e.g. \"cmabc123...\"). The numericId shown in the panel (e.g. \"180\") is accepted too. IDs of other service types do not work here.", "minLength": 1, "type": "string" } }, "required": [ "serviceId", "backupId" ], "type": "object" }, "name": "restore_vserver_backup", "outputSchema": null }, { "description": "Reveal gameserver external access credentials. Requires confirm=true. Requires an active ZapX Pass (see server instructions).", "inputSchema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "properties": { "confirm": { "type": "boolean" }, "serviceId": { "description": "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.", "minLength": 1, "type": "string" } }, "required": [ "serviceId" ], "type": "object" }, "name": "reveal_gameserver_external_access", "outputSchema": null }, { "description": "Revoke remote management for a dedicated server. Requires confirm=true. Requires an active ZapX Pass (see server instructions).", "inputSchema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "properties": { "confirm": { "type": "boolean" }, "serviceId": { "description": "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.", "minLength": 1, "type": "string" } }, "required": [ "serviceId" ], "type": "object" }, "name": "revoke_dedicated_remote_management", "outputSchema": null }, { "description": "Roll back a VPS to a named snapshot. Requires confirm=true. Requires an active ZapX Pass (see server instructions).", "inputSchema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "properties": { "confirm": { "type": "boolean" }, "name": { "minLength": 1, "type": "string" }, "serviceId": { "description": "ID of the VPS: the \"id\" field from list_account_services or list_vservers (e.g. \"cmabc123...\"). The numericId shown in the panel (e.g. \"180\") is accepted too. IDs of other service types do not work here.", "minLength": 1, "type": "string" } }, "required": [ "serviceId", "name" ], "type": "object" }, "name": "rollback_vserver_snapshot", "outputSchema": null }, { "description": "Rotate gameserver external access credentials. Requires confirm=true. Requires an active ZapX Pass (see server instructions).", "inputSchema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "properties": { "confirm": { "type": "boolean" }, "serviceId": { "description": "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.", "minLength": 1, "type": "string" } }, "required": [ "serviceId" ], "type": "object" }, "name": "rotate_gameserver_external_access", "outputSchema": null }, { "description": "Send a command to the Discord bot console. Requires confirm=true. Requires an active ZapX Pass (see server instructions).", "inputSchema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "properties": { "command": { "maxLength": 500, "minLength": 1, "type": "string" }, "confirm": { "type": "boolean" }, "serviceId": { "description": "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.", "minLength": 1, "type": "string" } }, "required": [ "serviceId", "command" ], "type": "object" }, "name": "send_discord_bot_console_command", "outputSchema": null }, { "description": "Send one console command to a running gameserver. Requires confirm=true. Not every game accepts commands here: FiveM/RedM (txAdmin) and some games reject them, so use the txAdmin Live Console or config files instead. Requires an active ZapX Pass (see server instructions).", "inputSchema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "properties": { "command": { "maxLength": 500, "minLength": 1, "type": "string" }, "confirm": { "type": "boolean" }, "serviceId": { "description": "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.", "minLength": 1, "type": "string" } }, "required": [ "serviceId", "command" ], "type": "object" }, "name": "send_gameserver_console_command", "outputSchema": null }, { "description": "Set the next boot device for a dedicated server. Requires confirm=true. Requires an active ZapX Pass (see server instructions).", "inputSchema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "properties": { "confirm": { "type": "boolean" }, "device": { "enum": [ "disk", "virtual_media" ], "type": "string" }, "serviceId": { "description": "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.", "minLength": 1, "type": "string" } }, "required": [ "serviceId", "device" ], "type": "object" }, "name": "set_dedicated_next_boot", "outputSchema": null }, { "description": "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. Requires an active ZapX Pass (see server instructions).", "inputSchema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "properties": { "autoRenew": { "description": "false = the domain is not renewed (nor charged) at the end of its term and expires.", "type": "boolean" }, "confirm": { "description": "Must be true to apply the change.", "type": "boolean" }, "domainId": { "description": "Domain id (from list_domains or list_account_services).", "minLength": 1, "type": "string" } }, "required": [ "domainId", "autoRenew" ], "type": "object" }, "name": "set_domain_auto_renew", "outputSchema": null }, { "description": "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. Requires an active ZapX Pass (see server instructions).", "inputSchema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "properties": { "confirm": { "description": "Must be true to apply the change.", "type": "boolean" }, "domainId": { "description": "Domain id (from list_domains or list_account_services).", "minLength": 1, "type": "string" }, "mode": { "description": "managed = ZapX nameservers (DNS records editable here), external = own nameservers.", "enum": [ "managed", "external" ], "type": "string" }, "nameservers": { "description": "External nameserver hostnames (mode external only, 2-13 distinct).", "items": { "maxLength": 253, "minLength": 1, "type": "string" }, "maxItems": 13, "minItems": 2, "type": "array" } }, "required": [ "domainId", "mode" ], "type": "object" }, "name": "set_domain_nameservers", "outputSchema": null }, { "description": "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. Requires an active ZapX Pass (see server instructions).", "inputSchema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "properties": { "confirm": { "description": "Must be true to apply the change.", "type": "boolean" }, "confirmedReplaceRecordIds": { "description": "Ids of the own records the previous call listed under `replace` (switching on only).", "items": { "minLength": 1, "type": "string" }, "maxItems": 200, "type": "array" }, "domainId": { "description": "Domain id (from list_domains or list_account_services).", "minLength": 1, "type": "string" }, "enabled": { "description": "true = show the ZapX parking page, false = remove it.", "type": "boolean" } }, "required": [ "domainId", "enabled" ], "type": "object" }, "name": "set_domain_parking_page", "outputSchema": null }, { "description": "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. Requires an active ZapX Pass (see server instructions).", "inputSchema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "properties": { "confirm": { "type": "boolean" }, "framework": { "enum": [ "vanilla", "oxide", "carbon" ], "type": "string" }, "serviceId": { "description": "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.", "minLength": 1, "type": "string" } }, "required": [ "serviceId", "framework" ], "type": "object" }, "name": "set_gameserver_rust_framework", "outputSchema": null }, { "description": "Set or clear the favorite subdomain shown as the VPS address. Requires confirm=true. Requires an active ZapX Pass (see server instructions).", "inputSchema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "properties": { "confirm": { "type": "boolean" }, "serviceId": { "description": "ID of the VPS: the \"id\" field from list_account_services or list_vservers (e.g. \"cmabc123...\"). The numericId shown in the panel (e.g. \"180\") is accepted too. IDs of other service types do not work here.", "minLength": 1, "type": "string" }, "subdomainId": { "description": "Subdomain id from get_vserver_dns; null or omitted clears the favorite.", "type": [ "string", "null" ] } }, "required": [ "serviceId" ], "type": "object" }, "name": "set_vserver_favorite_subdomain", "outputSchema": null }, { "description": "Start a dedicated server. Requires confirm=true.", "inputSchema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "properties": { "confirm": { "type": "boolean" }, "serviceId": { "description": "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.", "minLength": 1, "type": "string" } }, "required": [ "serviceId" ], "type": "object" }, "name": "start_dedicated_server", "outputSchema": null }, { "description": "Start a Discord bot. Requires confirm=true.", "inputSchema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "properties": { "confirm": { "type": "boolean" }, "serviceId": { "description": "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.", "minLength": 1, "type": "string" } }, "required": [ "serviceId" ], "type": "object" }, "name": "start_discord_bot", "outputSchema": null }, { "description": "Start a gameserver. Requires confirm=true because this is a power action.", "inputSchema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "properties": { "confirm": { "type": "boolean" }, "serviceId": { "description": "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.", "minLength": 1, "type": "string" } }, "required": [ "serviceId" ], "type": "object" }, "name": "start_gameserver", "outputSchema": null }, { "description": "Start a TeamSpeak server. Requires confirm=true.", "inputSchema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "properties": { "confirm": { "type": "boolean" }, "serviceId": { "description": "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.", "minLength": 1, "type": "string" } }, "required": [ "serviceId" ], "type": "object" }, "name": "start_teamspeak_server", "outputSchema": null }, { "description": "Start a VPS. Requires confirm=true.", "inputSchema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "properties": { "confirm": { "type": "boolean" }, "serviceId": { "description": "ID of the VPS: the \"id\" field from list_account_services or list_vservers (e.g. \"cmabc123...\"). The numericId shown in the panel (e.g. \"180\") is accepted too. IDs of other service types do not work here.", "minLength": 1, "type": "string" } }, "required": [ "serviceId" ], "type": "object" }, "name": "start_vserver", "outputSchema": null }, { "description": "Stop a dedicated server. Requires confirm=true.", "inputSchema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "properties": { "confirm": { "type": "boolean" }, "mode": { "enum": [ "gracefulShutdown", "forceShutdown" ], "type": "string" }, "serviceId": { "description": "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.", "minLength": 1, "type": "string" } }, "required": [ "serviceId" ], "type": "object" }, "name": "stop_dedicated_server", "outputSchema": null }, { "description": "Stop a Discord bot. Requires confirm=true.", "inputSchema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "properties": { "confirm": { "type": "boolean" }, "serviceId": { "description": "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.", "minLength": 1, "type": "string" } }, "required": [ "serviceId" ], "type": "object" }, "name": "stop_discord_bot", "outputSchema": null }, { "description": "Stop a gameserver. Requires confirm=true because this is a power action.", "inputSchema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "properties": { "confirm": { "type": "boolean" }, "serviceId": { "description": "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.", "minLength": 1, "type": "string" } }, "required": [ "serviceId" ], "type": "object" }, "name": "stop_gameserver", "outputSchema": null }, { "description": "Stop a TeamSpeak server. Requires confirm=true.", "inputSchema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "properties": { "confirm": { "type": "boolean" }, "serviceId": { "description": "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.", "minLength": 1, "type": "string" } }, "required": [ "serviceId" ], "type": "object" }, "name": "stop_teamspeak_server", "outputSchema": null }, { "description": "Stop a VPS. Requires confirm=true.", "inputSchema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "properties": { "confirm": { "type": "boolean" }, "serviceId": { "description": "ID of the VPS: the \"id\" field from list_account_services or list_vservers (e.g. \"cmabc123...\"). The numericId shown in the panel (e.g. \"180\") is accepted too. IDs of other service types do not work here.", "minLength": 1, "type": "string" } }, "required": [ "serviceId" ], "type": "object" }, "name": "stop_vserver", "outputSchema": null }, { "description": "Toggle DDoS protection for a dedicated server. Requires confirm=true. Requires an active ZapX Pass (see server instructions).", "inputSchema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "properties": { "confirm": { "type": "boolean" }, "enabled": { "description": "Target state (true = protected). Without it the current state is flipped.", "type": "boolean" }, "ipAddress": { "type": "string" }, "serviceId": { "description": "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.", "minLength": 1, "type": "string" } }, "required": [ "serviceId" ], "type": "object" }, "name": "toggle_dedicated_ddos_protection", "outputSchema": null }, { "description": "Switch DDoS protection of a VPS IP on or off (service owner only). Switching it off leaves the IP unfiltered. Requires confirm=true. Requires an active ZapX Pass (see server instructions).", "inputSchema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "properties": { "confirm": { "type": "boolean" }, "enabled": { "description": "Target state (true = protected). Without it the current state is flipped.", "type": "boolean" }, "ipAddress": { "type": "string" }, "serviceId": { "description": "ID of the VPS: the \"id\" field from list_account_services or list_vservers (e.g. \"cmabc123...\"). The numericId shown in the panel (e.g. \"180\") is accepted too. IDs of other service types do not work here.", "minLength": 1, "type": "string" } }, "required": [ "serviceId" ], "type": "object" }, "name": "toggle_vserver_ddos_protection", "outputSchema": null }, { "description": "Uninstall a One-Click App from a dedicated server. Keeps the app data unless deleteVolumes=true. Requires confirm=true. Requires an active ZapX Pass (see server instructions).", "inputSchema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "properties": { "confirm": { "type": "boolean" }, "deleteVolumes": { "description": "Also delete the app's persistent data (volumes). Only when the user explicitly asked for it; default keeps the data.", "type": "boolean" }, "installationId": { "description": "Installation id from get_vserver_apps / get_dedicated_apps.", "maxLength": 64, "minLength": 1, "type": "string" }, "serviceId": { "description": "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.", "minLength": 1, "type": "string" } }, "required": [ "serviceId", "installationId" ], "type": "object" }, "name": "uninstall_dedicated_app", "outputSchema": null }, { "description": "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. Requires an active ZapX Pass (see server instructions).", "inputSchema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "properties": { "confirm": { "type": "boolean" }, "installationId": { "minLength": 1, "type": "string" }, "serviceId": { "description": "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.", "minLength": 1, "type": "string" } }, "required": [ "serviceId", "installationId" ], "type": "object" }, "name": "uninstall_gameserver_mod", "outputSchema": null }, { "description": "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. Requires an active ZapX Pass (see server instructions).", "inputSchema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "properties": { "confirm": { "type": "boolean" }, "installationId": { "minLength": 1, "type": "string" }, "serviceId": { "description": "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.", "minLength": 1, "type": "string" } }, "required": [ "serviceId", "installationId" ], "type": "object" }, "name": "uninstall_gameserver_plugin", "outputSchema": null }, { "description": "Uninstall a One-Click App from a VPS. Keeps the app data unless deleteVolumes=true. Requires confirm=true. Requires an active ZapX Pass (see server instructions).", "inputSchema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "properties": { "confirm": { "type": "boolean" }, "deleteVolumes": { "description": "Also delete the app's persistent data (volumes). Only when the user explicitly asked for it; default keeps the data.", "type": "boolean" }, "installationId": { "description": "Installation id from get_vserver_apps / get_dedicated_apps.", "maxLength": 64, "minLength": 1, "type": "string" }, "serviceId": { "description": "ID of the VPS: the \"id\" field from list_account_services or list_vservers (e.g. \"cmabc123...\"). The numericId shown in the panel (e.g. \"180\") is accepted too. IDs of other service types do not work here.", "minLength": 1, "type": "string" } }, "required": [ "serviceId", "installationId" ], "type": "object" }, "name": "uninstall_vserver_app", "outputSchema": null }, { "description": "Unmount install media from a dedicated server. Requires confirm=true. Requires an active ZapX Pass (see server instructions).", "inputSchema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "properties": { "confirm": { "type": "boolean" }, "serviceId": { "description": "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.", "minLength": 1, "type": "string" } }, "required": [ "serviceId" ], "type": "object" }, "name": "unmount_dedicated_install_media", "outputSchema": null }, { "description": "Eject the mounted ISO and boot from disk again. Requires confirm=true. Requires an active ZapX Pass (see server instructions).", "inputSchema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "properties": { "confirm": { "type": "boolean" }, "serviceId": { "description": "ID of the VPS: the \"id\" field from list_account_services or list_vservers (e.g. \"cmabc123...\"). The numericId shown in the panel (e.g. \"180\") is accepted too. IDs of other service types do not work here.", "minLength": 1, "type": "string" } }, "required": [ "serviceId" ], "type": "object" }, "name": "unmount_vserver_iso", "outputSchema": null }, { "description": "Update reverse DNS for a dedicated server. Requires confirm=true. Requires an active ZapX Pass (see server instructions).", "inputSchema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "properties": { "confirm": { "type": "boolean" }, "hostname": { "type": [ "string", "null" ] }, "ipAddressId": { "type": "string" }, "ipv6PrefixAllocationId": { "type": "string" }, "serviceId": { "description": "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.", "minLength": 1, "type": "string" } }, "required": [ "serviceId" ], "type": "object" }, "name": "update_dedicated_reverse_dns", "outputSchema": null }, { "description": "Update a Discord bot schedule (name, action, cron, runOnceAt, timezone, command, isActive). Bot owner only. isActive=false pauses it. A new cron or runOnceAt is local time in the schedule's own `timezone` (from list_discord_bot_schedules) unless you also send `timezone`; omitting `timezone` keeps the schedule's zone. `runOnceAt` makes it a one-time schedule (a finished one runs again at the new time); a new `cron` (or runOnceAt=null plus cron) makes a one-time schedule recurring again. Re-enabling a finished one-time schedule needs a new runOnceAt. The daily auto backup (isSystem) cannot be changed. Requires confirm=true. Requires an active ZapX Pass (see server instructions).", "inputSchema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "properties": { "action": { "enum": [ "restart", "backup", "start", "stop", "command" ], "type": "string" }, "command": { "description": "Bot console command, required for action=command.", "maxLength": 2000, "type": "string" }, "confirm": { "type": "boolean" }, "cron": { "description": "Recurring schedule: five-field cron in local time of `timezone`, e.g. \"0 4 * * *\" = daily 04:00. At most every 5 minutes. Leave out for a one-time schedule (`runOnceAt`).", "minLength": 1, "type": "string" }, "isActive": { "type": "boolean" }, "name": { "maxLength": 120, "minLength": 1, "type": "string" }, "runOnceAt": { "anyOf": [ { "description": "One-time schedule: local date and time \"YYYY-MM-DDTHH:mm\" in `timezone` (e.g. \"2026-11-20T03:00\"), in the future and at most one year ahead. Runs exactly once, then switches itself off (isActive=false). Use it for \"once tomorrow at 3am\", never a cron with a fixed day and month.", "maxLength": 32, "type": "string" }, { "type": "null" } ], "description": "One-time time \"YYYY-MM-DDTHH:mm\" in the schedule's zone (or the new `timezone`): makes it a one-time schedule; a finished one runs again at the new time. null makes a one-time schedule recurring again (send `cron` with it). Omit to keep." }, "scheduleId": { "minLength": 1, "type": "string" }, "serviceId": { "description": "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.", "minLength": 1, "type": "string" }, "timezone": { "description": "New IANA zone; omit to keep the schedule's zone (a pending one-time schedule keeps its local time), null resets to UTC.", "type": [ "string", "null" ] } }, "required": [ "serviceId", "scheduleId" ], "type": "object" }, "name": "update_discord_bot_schedule", "outputSchema": null }, { "description": "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. Requires an active ZapX Pass (see server instructions).", "inputSchema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "properties": { "confirm": { "description": "Must be true to apply the change.", "type": "boolean" }, "content": { "description": "Record value (IP address, hostname, TXT text, ...).", "maxLength": 4096, "minLength": 1, "type": "string" }, "domainId": { "description": "Domain id (from list_domains or list_account_services).", "minLength": 1, "type": "string" }, "name": { "description": "Record name relative to the domain: '@' (default) for the domain itself, 'www', '_acme-challenge', ...", "maxLength": 253, "type": "string" }, "port": { "description": "SRV port.", "maximum": 65535, "minimum": 0, "type": "integer" }, "priority": { "description": "MX/SRV priority.", "maximum": 65535, "minimum": 0, "type": "integer" }, "recordId": { "description": "Record id from get_domain_dns_records.", "minLength": 1, "type": "string" }, "ttl": { "description": "TTL in seconds (default 3600, min 60).", "maximum": 9007199254740991, "minimum": 60, "type": "integer" }, "type": { "description": "Record type.", "enum": [ "A", "AAAA", "CAA", "CNAME", "MX", "NS", "SRV", "SSHFP", "TLSA", "TXT" ], "type": "string" }, "weight": { "description": "SRV weight.", "maximum": 65535, "minimum": 0, "type": "integer" } }, "required": [ "domainId", "recordId", "type", "content" ], "type": "object" }, "name": "update_domain_dns_record", "outputSchema": null }, { "description": "Update editable gameserver configuration fields. Requires confirm=true. Requires an active ZapX Pass (see server instructions).", "inputSchema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "properties": { "changes": { "additionalProperties": { "type": "string" }, "propertyNames": { "type": "string" }, "type": "object" }, "confirm": { "type": "boolean" }, "serviceId": { "description": "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.", "minLength": 1, "type": "string" } }, "required": [ "serviceId", "changes" ], "type": "object" }, "name": "update_gameserver_config", "outputSchema": null }, { "description": "Update a gameserver schedule (name, action, cron, runOnceAt, timezone, command, wipe options, isActive). isActive=false pauses it. A new cron or runOnceAt is local time in the schedule's own `timezone` (from list_gameserver_schedules) unless you also send `timezone`; omitting `timezone` keeps the schedule's zone. `runOnceAt` makes it a one-time schedule (a finished one runs again at the new time); a new `cron` (or runOnceAt=null plus cron) makes a one-time schedule recurring again. Re-enabling a finished one-time schedule needs a new runOnceAt. The daily auto backup (isSystem) cannot be changed. Requires confirm=true. Requires an active ZapX Pass (see server instructions).", "inputSchema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "properties": { "action": { "enum": [ "restart", "backup", "start", "stop", "command", "wipe" ], "type": "string" }, "command": { "description": "Console command, required for action=command.", "maxLength": 2000, "type": "string" }, "confirm": { "type": "boolean" }, "cron": { "description": "Recurring schedule: five-field cron in local time of `timezone`, e.g. \"0 4 * * *\" = daily 04:00. At most every 5 minutes. Leave out for a one-time schedule (`runOnceAt`).", "minLength": 1, "type": "string" }, "isActive": { "type": "boolean" }, "name": { "maxLength": 120, "minLength": 1, "type": "string" }, "runOnceAt": { "anyOf": [ { "description": "One-time schedule: local date and time \"YYYY-MM-DDTHH:mm\" in `timezone` (e.g. \"2026-11-20T03:00\"), in the future and at most one year ahead. Runs exactly once, then switches itself off (isActive=false). Use it for \"once tomorrow at 3am\", never a cron with a fixed day and month.", "maxLength": 32, "type": "string" }, { "type": "null" } ], "description": "One-time time \"YYYY-MM-DDTHH:mm\" in the schedule's zone (or the new `timezone`): makes it a one-time schedule; a finished one runs again at the new time. null makes a one-time schedule recurring again (send `cron` with it). Omit to keep." }, "scheduleId": { "minLength": 1, "type": "string" }, "serviceId": { "description": "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.", "minLength": 1, "type": "string" }, "timezone": { "description": "New IANA zone; omit to keep the schedule's zone (a pending one-time schedule keeps its local time), null resets to UTC.", "type": [ "string", "null" ] }, "wipe": { "description": "Wipe options, required for action=wipe (only games with a wipe, e.g. Rust).", "properties": { "backupFirst": { "description": "Back up before wiping (default true).", "type": "boolean" }, "kind": { "description": "Rust: map, blueprints or full.", "enum": [ "map", "blueprints", "full" ], "type": "string" }, "seed": { "description": "Map seed: \"keep\" (default) or \"random\".", "enum": [ "keep", "random" ], "type": "string" }, "worldSize": { "anyOf": [ { "maximum": 6000, "minimum": 1000, "type": "integer" }, { "type": "null" } ] } }, "required": [ "kind" ], "type": "object" } }, "required": [ "serviceId", "scheduleId" ], "type": "object" }, "name": "update_gameserver_schedule", "outputSchema": null }, { "description": "Change gameserver variant. Requires confirm=true. Requires an active ZapX Pass (see server instructions).", "inputSchema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "properties": { "confirm": { "type": "boolean" }, "serviceId": { "description": "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.", "minLength": 1, "type": "string" }, "variantId": { "minLength": 1, "type": "string" } }, "required": [ "serviceId", "variantId" ], "type": "object" }, "name": "update_gameserver_variant", "outputSchema": null }, { "description": "Update gameserver game version. Requires confirm=true. Requires an active ZapX Pass (see server instructions).", "inputSchema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "properties": { "confirm": { "type": "boolean" }, "serviceId": { "description": "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.", "minLength": 1, "type": "string" }, "targetModpackVersion": { "type": "string" }, "targetVersion": { "type": "string" } }, "required": [ "serviceId" ], "type": "object" }, "name": "update_gameserver_version", "outputSchema": null }, { "description": "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. Requires an active ZapX Pass (see server instructions).", "inputSchema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "properties": { "addItemIds": { "items": { "pattern": "^\\d{1,20}$", "type": "string" }, "maxItems": 200, "type": "array" }, "collectionId": { "anyOf": [ { "pattern": "^\\d{1,20}$", "type": "string" }, { "type": "null" } ] }, "confirm": { "type": "boolean" }, "disabledItemIds": { "items": { "pattern": "^\\d{1,20}$", "type": "string" }, "maxItems": 500, "type": "array" }, "itemIds": { "items": { "pattern": "^\\d{1,20}$", "type": "string" }, "maxItems": 500, "type": "array" }, "removeItemIds": { "items": { "pattern": "^\\d{1,20}$", "type": "string" }, "maxItems": 500, "type": "array" }, "serviceId": { "description": "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.", "minLength": 1, "type": "string" } }, "required": [ "serviceId" ], "type": "object" }, "name": "update_gameserver_workshop", "outputSchema": null }, { "description": "Update TeamSpeak server configuration. Requires confirm=true. Requires an active ZapX Pass (see server instructions).", "inputSchema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "properties": { "confirm": { "type": "boolean" }, "properties": { "additionalProperties": { "type": [ "string", "number" ] }, "propertyNames": { "type": "string" }, "type": "object" }, "serviceId": { "description": "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.", "minLength": 1, "type": "string" } }, "required": [ "serviceId", "properties" ], "type": "object" }, "name": "update_teamspeak_config", "outputSchema": null }, { "description": "Rename an account SSH key or replace its public key on every VPS it is installed on. Requires confirm=true. Requires an active ZapX Pass (see server instructions).", "inputSchema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "properties": { "confirm": { "type": "boolean" }, "keyId": { "description": "Key id from list_vserver_account_ssh_keys.", "minLength": 1, "type": "string" }, "name": { "type": "string" }, "publicKey": { "description": "Replaces the key on every VPS it is installed on.", "type": "string" } }, "required": [ "keyId" ], "type": "object" }, "name": "update_vserver_account_ssh_key", "outputSchema": null }, { "description": "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. Requires an active ZapX Pass (see server instructions).", "inputSchema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "properties": { "confirm": { "type": "boolean" }, "enable": { "description": "Firewall on (true) or off (false).", "type": "boolean" }, "policyIn": { "description": "Default policy for incoming traffic no rule matches.", "enum": [ "ACCEPT", "DROP", "REJECT" ], "type": "string" }, "policyOut": { "description": "Default policy for outgoing traffic no rule matches.", "enum": [ "ACCEPT", "DROP", "REJECT" ], "type": "string" }, "serviceId": { "description": "ID of the VPS: the \"id\" field from list_account_services or list_vservers (e.g. \"cmabc123...\"). The numericId shown in the panel (e.g. \"180\") is accepted too. IDs of other service types do not work here.", "minLength": 1, "type": "string" } }, "required": [ "serviceId", "enable", "policyIn", "policyOut" ], "type": "object" }, "name": "update_vserver_firewall_options", "outputSchema": null }, { "description": "Set or reset the reverse DNS (PTR) hostname of one VPS IP. The hostname must resolve to that IP. Requires confirm=true. Requires an active ZapX Pass (see server instructions).", "inputSchema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "properties": { "confirm": { "type": "boolean" }, "hostname": { "description": "New PTR hostname (must resolve to the IP); empty or null resets it to the default.", "type": [ "string", "null" ] }, "ipAddressId": { "description": "IPv4 entry from get_vserver_reverse_dns (`ipAddressId`). Pass this or ipv6PrefixAllocationId.", "type": "string" }, "ipv6PrefixAllocationId": { "description": "IPv6 entry from get_vserver_reverse_dns (`ipv6PrefixAllocationId`).", "type": "string" }, "serviceId": { "description": "ID of the VPS: the \"id\" field from list_account_services or list_vservers (e.g. \"cmabc123...\"). The numericId shown in the panel (e.g. \"180\") is accepted too. IDs of other service types do not work here.", "minLength": 1, "type": "string" } }, "required": [ "serviceId" ], "type": "object" }, "name": "update_vserver_reverse_dns", "outputSchema": null }, { "description": "Update a VPS schedule (name, action, cron, timezone, command, isActive). Requires confirm=true. Requires an active ZapX Pass (see server instructions).", "inputSchema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "properties": { "action": { "enum": [ "restart", "start", "stop", "command" ], "type": "string" }, "command": { "type": "string" }, "confirm": { "type": "boolean" }, "cron": { "type": "string" }, "isActive": { "type": "boolean" }, "name": { "type": "string" }, "scheduleId": { "minLength": 1, "type": "string" }, "serviceId": { "description": "ID of the VPS: the \"id\" field from list_account_services or list_vservers (e.g. \"cmabc123...\"). The numericId shown in the panel (e.g. \"180\") is accepted too. IDs of other service types do not work here.", "minLength": 1, "type": "string" }, "timezone": { "type": [ "string", "null" ] } }, "required": [ "serviceId", "scheduleId" ], "type": "object" }, "name": "update_vserver_schedule", "outputSchema": null }, { "description": "Wipe a dedicated server. Requires confirm=true. Requires an active ZapX Pass (see server instructions).", "inputSchema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "properties": { "confirm": { "type": "boolean" }, "serviceId": { "description": "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.", "minLength": 1, "type": "string" } }, "required": [ "serviceId" ], "type": "object" }, "name": "wipe_dedicated_server", "outputSchema": null }, { "description": "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. Requires an active ZapX Pass (see server instructions).", "inputSchema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "properties": { "backupFirst": { "description": "Back up before wiping (default true).", "type": "boolean" }, "confirm": { "type": "boolean" }, "kind": { "description": "Rust: map, blueprints or full.", "enum": [ "map", "blueprints", "full" ], "type": "string" }, "seed": { "anyOf": [ { "enum": [ "keep", "random" ], "type": "string" }, { "maximum": 2147483647, "minimum": 1, "type": "integer" } ], "description": "Map seed: \"keep\" (default), \"random\" or a fixed number." }, "serviceId": { "description": "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.", "minLength": 1, "type": "string" }, "worldSize": { "anyOf": [ { "maximum": 6000, "minimum": 1000, "type": "integer" }, { "type": "null" } ] } }, "required": [ "serviceId", "kind" ], "type": "object" }, "name": "wipe_gameserver", "outputSchema": null } ] }
Verify it yourselfcurl -s https://api.teppi.xyz/v1/evidence/sha256:49a7dd0541e7f2a4723c950cdbc513120339ee8a739a0fe10c74bdeb326a5489 | sha256sum