Skip to main content

​
Introduction

The GamePanelX V3 API provides a RESTful interface for managing game servers and users programmatically. You can use the API to automate server provisioning, manage users, and control server operations.

​
Base URL

The API is accessible at: 
https://your-gamepanelx-domain.com/api/api.php

​
API Structure

The GamePanelX API uses a class-based structure with the following components:
  • class: The resource type you want to interact with (servers or users)
  • action: The operation you want to perform (create, delete, restart, etc.)
  • key: Your API authentication key

​
Available Resources

The API currently supports two main resource classes:

Servers API

Create, manage, and control game servers

Users API

Create, update, and delete user accounts

​
Request Methods

The API accepts both GET and POST requests. For security reasons, POST is recommended for all operations. 
curl "https://your-domain.com/api/api.php?class=servers&action=restart&key=YOUR_API_KEY&id=123"

​
Response Format

API responses are returned as plain text messages:
  • Success: Returns success or a success message
  • Error: Returns an error message describing the issue
The API uses simple text responses rather than JSON. Parse the response text to determine success or failure.

​
Error Handling

Common error responses include:
Error MessageCause
No API key specified (&key=)Missing API key parameter
Invalid API key specified!Incorrect API key
No class given (&class=)Missing class parameter
Invalid class givenInvalid class name (must be servers or users)
No action (&action=) givenMissing action parameter
Unknown API actionInvalid action for the specified class

​
Rate Limiting

There are no built-in rate limits in the API. Implement your own rate limiting on the client side to avoid overloading your GamePanelX instance.

​
Quick Start Example

Here’s a simple example to get you started: 
# Create a new game server
curl -X POST https://your-domain.com/api/api.php \
  -d "class=servers" \
  -d "action=create" \
  -d "key=YOUR_API_KEY" \
  -d "username=john_doe" \
  -d "game=csgo" \
  -d "slots=32" \
  -d "port=27015"

​
Next Steps

Authentication

Learn how to obtain and use your API key

Server Endpoints

Explore server management endpoints

Build docs developers (and LLMs) love

Get started for freeTalk to us