We're excited to announce the launch of the GameGrid Customer API!!! — a comprehensive RESTful API that gives developers and organizations programmatic access to manage their GameGrid game servers, plans, and account data.
What Is the Customer API?
The Customer API allows you to integrate GameGrid's server management capabilities directly into your own applications, dashboards, automation scripts, and infrastructure. Whether you're building a custom control panel, automating server deployments, or syncing billing data with your accounting system, the Customer API provides the endpoints you need.
Key Features
Server Management
- List, create, and delete server instances — Full lifecycle management via API
- Start, stop, and restart servers — Control server state programmatically
- View server status and metrics — Real-time server health and performance data
- Update server settings — Modify configuration without touching the control panel
- Manage mods and files — Install mods, upload files, and manage your server's filesystem
Billing and Subscriptions
- View billing history — Retrieve transaction records and invoice data
- Check credit balance — Monitor account credit and referral earnings
Webhooks
- Real-time event notifications — Receive HTTP callbacks for server state changes, billing events, and more
- Configurable endpoints — Register multiple webhook URLs for different event types
- Signed payloads — All webhooks are cryptographically signed for verification
Security
- API Key authentication — Generate scoped API keys with specific permissions
- Per-key scope control — Restrict keys to read-only, server management, or billing access
- Rate limiting — Generous rate limits with clear headers for monitoring usage
- Audit logging — All API actions are logged for security and compliance
Getting Started
- Generate an API key — Log in to your GameGrid dashboard, navigate to Settings → API Keys, and create a new key with the permissions you need
- Review the API documentation — Full API reference with examples is available in the knowledge base
- Make your first request — All requests use standard HTTP methods (GET, POST, PUT, DELETE) with JSON payloads
- Set up webhooks (optional) — Register webhook URLs to receive real-time event notifications
API Key Scopes
| Scope | Description |
|---|---|
| servers:read | View server instances, status, and metrics |
| servers:write | Create, modify, start, stop, and delete servers |
| illing:read | View billing history, subscriptions, and credit balance |
| illing:write | Manage subscriptions and payment methods |
| iles:read | View server files and directories |
| iles:write | Upload, modify, and delete server files |
| webhooks:manage | Register and manage webhook endpoints |
Example: List Your Servers
GET /api/v1/servers Authorization: Bearer YOUR_API_KEY
Response:
json { "servers": [ { "id": "srv_abc123", "name": "My Palworld Server", "game": "palworld", "status": "running", "players": 4, "maxPlayers": 32 } ] }
Learn More
For complete API documentation, guides, and examples: