Skip to content
ZAP Customer API

REST API for developers

Connect your applications, bots, and tools to your ZAP-Hosting services. Manage game servers, VPS, dedicated servers, and TeamSpeak, or integrate orders and upgrades.

ClaudeCursorChatGPTGemini

API access is part of ZapX Pass

Getting started

Start in 3 steps

Create an API key and send your first request in just a few minutes.

  1. 1

    Create an API key

    Create a key under Settings → API Access and choose the permissions your integration needs.

    Go to API Access
  2. 2

    Send your first request

    Send your key in the Authorization header. /me shows whether it works and which permissions it has.

  3. 3

    Use the documentation

    The interactive API reference provides every endpoint, example, and the OpenAPI specification.

    API reference

First request (curl)

$ curl -s https://zap-hosting.com/api/v1/me \
  -H "Authorization: Bearer zapx_…" \
  -H "Accept: application/json"
200 OK· application/json
{
  "success": true,
  "data": {
    "userId": "usr_01HXYZ",
    "token": {
      "id": "cltok_01HXYZ",
      "name": "Automation",
      "accountPermissions": ["orders.view", "orders.create"],
      "serviceGrants": [
        {
          "serviceType": "gameserver",
          "serviceId": "clgs_01HXYZ",
          "permissions": ["gameserver.view", "gameserver.start"]
        }
      ],
      "typeGrants": []
    }
  }
}

Use cases

Build your own integration

From community bots and custom dashboards to order flows: connect your application to your ZAP-Hosting services.

Integrate server management into your application

Show status, backups, and configuration in your own interface and run approved server actions.

  • Show services and their status
  • Manage backups and files
  • Limit access to individual services

Monitor status and console logs in real time

Use current status data and console logs as Server-Sent Events for monitoring and notifications.

  • Retrieve current service status
  • Receive console logs as a stream
  • Trigger notifications for important events

Integrate orders and upgrades

Order new services or adjust existing packages directly from your application.

  • Place orders from your app
  • Upgrades with a price preview
  • Retrieve plan-change status

Supported services

The right endpoints for your services

The Customer API covers game servers, VPS, dedicated servers, and TeamSpeak, as well as orders and plan changes.

Game servers

Manage console, files, backups, server actions, and mods.

GET /api/v1/gameservers/{id}/console/logs

VPS

Manage firewall, console, backups, and server administration.

GET /api/v1/vservers/{id}/firewall

Dedicated servers

Manage server actions, reinstall, traffic, rescue, and DDoS.

GET /api/v1/dedicated-servers/{id}

TeamSpeak

Automate configuration, clients, bans, and tokens.

GET /api/v1/teamspeak-servers/{id}

Orders & upgrades

Order new services and adjust packages with a price preview.

POST /api/v1/orders

Access and security

API keys and permissions

Stay in control of the services and actions your integration can use.

API keys (Bearer)

Send your key in the Authorization header with every /api/v1/* request. You can create or replace keys at any time under Settings → API Access.

Permissions per service

Choose which services and actions your integration may access.

Asynchronous operations

For longer-running actions, you receive an operation ID and can retrieve its progress through the API.

REST API with ZapX Pass Pluscreate your API key in your settings with an active Pass Plus

View ZapX Pass

Developer tools

Everything for your integration

Use the API reference, the OpenAPI specification, or our Postman collection to get started.

Interactive API reference

Try every endpoint with examples right in your browser.

OpenAPI

Specification (OpenAPI 3.1) for your own clients and code generators.

API vs. MCP

REST API or MCP?

Choose the REST API for your own applications and MCP for working directly with an AI client.

Customer REST API

For your own applications, bots, dashboards, and automations.

  • Custom workflows and full control over requests
  • Orders and plan changes from your application
  • Real-time logs and asynchronous operations

MCP Connect

For Cursor, Claude, and other AI clients with OAuth.

  • Status, backups, and server controls in chat
  • Set permissions for each AI client
  • Convenient for daily administration

FAQ

Frequently asked API questions

Everything you need to know about building your own ZapX integrations.

For your own tools, apps, and automations.

Connect ZAP-Hosting to your dashboard, a bot, or your own application. You can query services, manage servers, integrate backups, and trigger orders from your application.

Game servers, VPS, dedicated servers, and TeamSpeak.

The Customer API provides features for your existing game servers, VPS, dedicated servers, and TeamSpeak servers. Which areas are available depends on your account and the respective access rights.

With a personal API key.

Create an API key under Settings → API Access and send it in the Authorization header with every request. You can find suitable examples in the API documentation.

The right interface for your use case.

The REST API is designed for your own applications, bots, and automations. With MCP, you connect ZAP-Hosting directly to AI clients such as Cursor or Claude.

The API is included with ZapX Pass Plus.

Yes. For the Customer REST API, you need an active ZapX Pass Plus. You can then create your API key under Settings → API Access.

Orders and plan changes from your application.

Yes. You can order new services and adjust existing packages. Before a plan change, you receive a price preview.

Still have questions? Our support team is happy to help.

Contact Support
Ready?

Connect your tools with ZapX

Open the API documentation, create an API key, and start with your first request.

API access is part of ZapX Pass

ZAP Customer API — REST API for Game Servers, VPS & Automation | ZAP-Hosting