Server Deployment API
The Server API allows you to create, configure, and manage game servers programmatically.
Endpoints
| Method | Endpoint | Description |
|---|---|---|
| GET | /servers | List all servers |
| GET | /servers/:id | Get server details |
| POST | /servers | Create a new server |
| PUT | /servers/:id | Update server config |
| DELETE | /servers/:id | Delete a server |
| POST | /servers/:id/start | Start server |
| POST | /servers/:id/stop | Stop server |
| POST | /servers/:id/restart | Restart server |
List All Servers
GET /v1/serversResponse:
{
"success": true,
"data": [
{
"id": "srv_abc123",
"name": "Minecraft Server",
"game": "minecraft",
"location": "brisbane",
"status": "running",
"ip": "123.45.67.89",
"port": 25565,
"created_at": "2026-01-15T10:30:00Z"
}
],
"meta": {
"total": 5,
"page": 1,
"per_page": 20
}
}Create a Server
POST /v1/serversRequest Body:
{
"name": "My Rust Server",
"game": "rust",
"location": "singapore",
"plan": "game-rust-4gb",
"billing_cycle": "monthly"
}Available Games:
| Game ID | Display Name |
|---|---|
minecraft | Minecraft |
minecraft-bedrock | Minecraft Bedrock |
rust | Rust |
ark | ARK: Survival Evolved |
valheim | Valheim |
terraria | Terraria |
factorio | Factorio |
csgo | Counter-Strike 2 |
Available Plans
Use the /locations and /games/:id/plans endpoints to get available locations and plans for each game.
Server Actions
Start Server
POST /v1/servers/:id/startStop Server
POST /v1/servers/:id/stopRestart Server
POST /v1/servers/:id/restartWebhooks
Configure webhooks to receive notifications about server events:
{
"events": [
"server.started",
"server.stopped",
"server.crashed",
"server.backup_completed"
],
"url": "https://your-server.com/webhook"
}Rate Limits
Server creation is limited to 10 requests per minute to prevent abuse.