We're excited to announce the launch of the GameGrid Customer API — a RESTful API that gives developers and communities programmatic access to their GameGrid game servers, plans and account data.
What Is the Customer API?
The Customer API lets you bring GameGrid's server management into your own applications, dashboards, bots and automation scripts. Whether you're building a custom control panel, automating restarts, or feeding server status into your community's tools, the Customer API provides the endpoints you need.
Key Features
Server Management
- List and inspect your servers — Status, connection details and live stats for every server on your account
- Start, stop, and restart servers — Control server state programmatically
- Rename servers and set their restart schedule — Without opening the control panel
- Update server settings — Read and change the same settings as the panel's Settings tab
- Manage mods and files — Install and remove mods, upload files, and manage your server's filesystem
Servers are created and deleted in the control panel; the API manages the servers you already have.
Billing
- Read your billing summary — Your plans and billing overview, read-only
Webhooks
- Real-time event notifications — HTTP callbacks when a server starts, stops, restarts, crashes or moves to another host, when a console command is sent, and when a command schedule runs or raises an alert
- 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 — Give each key only the scopes it needs, from read-only access upwards
- Rate limiting — Generous rate limits with clear headers for monitoring usage
- Audit trail — Calls made with your organization's keys can be read back for 24 hours
Getting Started
- Generate an API key — Log in to your GameGrid dashboard, open Account → API Keys, and create a new key with the scopes you need
- Review the API documentation — Full API reference with examples is available in the knowledge base
- Make your first request — Requests use standard HTTP methods with JSON payloads, and your key goes in the
Authorization: Bearerheader - Set up webhooks (optional) — Register webhook URLs to receive real-time event notifications
API Key Scopes
Each key carries only the scopes you give it. A few examples:
| Scope | Description |
|---|---|
servers:read |
List and read servers, status, capabilities and lifecycle history |
servers:lifecycle |
Start, stop, restart and kill a server |
servers:write |
Rename a server; change auto-restart, restart schedule and resource limits |
billing:read |
Read the billing summary (read-only; never charges anything) |
files:read |
List, read and download files |
files:write |
Upload, edit, delete, rename and move files |
webhooks:manage |
Full webhook management |
The complete list, with what each scope grants, is in API Scopes and Permissions.
Example: List Your Servers
GET https://wdcgamegrid.com/api/public/v1/servers
Authorization: Bearer YOUR_API_KEY
The response is one page of servers: a data array with an object per server (its id, name, state and more) and a pagination object. The Customer API Reference documents every field.
Learn More
For complete API documentation, guides, and examples:
