Frequently Asked Questions
General
What can I do with the API?
The RespawnHost API lets you automate game server management (power control, file management, backups, databases, scheduled tasks) as well as KVM/VPS servers (provisioning, snapshots, firewall, networking) — and more.
Can I manage KVM/VPS servers via the API?
Yes. The /api/v1/kvm-servers endpoints let you order plans, control power, manage snapshots and backups, configure the firewall, set reverse DNS, and open a VNC console. See the KVM / VPS Servers guide. These require an API key with the kvm scope.
Where can I get an API key?
Log in to your RespawnHost dashboard and navigate to your account settings to generate an API key.
What languages can I use?
The API is REST-based and works with any language that can make HTTP requests. Use curl, Python, JavaScript, Go, or any HTTP client.
Technical
What format are responses?
All responses are JSON. Include Accept: application/json in your requests.
How do I paginate results?
Endpoints that return lists support page and limit query parameters:
GET /api/v1/payments?page=1&limit=20
What do the error codes mean?
| Status | Meaning |
|---|---|
| 400 | Bad request — check your request body |
| 401 | Unauthorized — invalid or missing API key |
| 403 | Forbidden — API key lacks required scope |
| 404 | Not found — resource doesn't exist |
| 422 | Validation error — check field requirements |
| 429 | Rate limited — slow down requests |
Troubleshooting
401 Unauthorized
- Verify your API key is correct
- Check the Authorization header format:
Bearer YOUR_API_KEY - Ensure the key hasn't been revoked
403 Forbidden
Your API key is valid but lacks the required scope. Create a new key with the appropriate permissions or update your existing key in the dashboard.
Server UUID
Every server has a unique UUID. Find it in your dashboard URL or by listing your servers via the API.