API Reference
Complete API documentation for developers who want to integrate with ZenithLab servers programmatically.
Getting Started
Base URL
API Version
Currently at v1 (stable)
Rate Limiting
- • 1000 requests per hour
- • Limited to 5 requests per second per IP
- • Check X-RateLimit headers in responses
Authentication
API Key Authentication
Include your API key in the Authorization header:
Authorization: Bearer YOUR_API_KEY
Getting Your API Key
- 1. Log in to your dashboard
- 2. Go to Settings → API Keys
- 3. Click "Generate New Key"
- 4. Copy and store it securely
Servers
GET /servers
List all your servers
Response:
{{
"servers": [
@{{
"id": "srv_123456",
"name": "My Server",
"game": "minecraft",
"status": "online",
"ip": "192.168.1.1:25565",
"players": 32,
"maxPlayers": 64
@}}
]
@}}
GET /servers/:id
Get details of a specific server
POST /servers/:id/restart
Restart a server
Players
GET /servers/:id/players
Get list of players on a server
Query Parameters:
- • limit (default: 50)
- • offset (default: 0)
- • sort (online, name, joins)
Example:
/servers/srv_123456/players?limit=10&sort=online
Server Status
GET /servers/:id/status
Get real-time server metrics
Response includes:
- • CPU usage (%)
- • RAM usage (%)
- • Network bandwidth
- • Uptime
- • Last restart
Backups
GET /servers/:id/backups
List all backups for a server
POST /servers/:id/backups
Create a new backup immediately
POST /servers/:id/backups/:backup_id/restore
Restore from a specific backup
Error Handling
HTTP Status Codes
200 OK
Successful request
400 Bad Request
Invalid parameters
401 Unauthorized
Missing or invalid API key
403 Forbidden
Insufficient permissions
404 Not Found
Resource not found
Official SDKs
We provide official SDKs to make API integration easier: