VPS.org API Documentation

Getting Started

The VPS.org API allows you to programmatically manage all aspects of your VPS hosting infrastructure, including servers, domains, DNS records, backups, and snapshots.

Authentication

All API requests require authentication using a Bearer token. You can generate your API token from your account settings at admin.vps.org/account/developers/.

curl -X GET https://admin.vps.org/api/v1/servers/ \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Content-Type: application/json"

import requests

url = "https://admin.vps.org/api/v1/servers/"
headers = {
    "Authorization": "Bearer YOUR_API_TOKEN",
    "Content-Type": "application/json"
}

response = requests.get(url, headers=headers)
print(response.json())

const response = await fetch('https://admin.vps.org/api/v1/servers/', {
  method: 'GET',
  headers: {
    'Authorization': 'Bearer YOUR_API_TOKEN',
    'Content-Type': 'application/json'
  }
});

const data = await response.json();
console.log(data);

Each token carries its own permissions, such as servers:list or dns:*. A request that needs a permission the token does not have is refused with 403 and a required_permission field naming the missing permission. Permissions Reference

Rate Limiting

Authenticated requests are limited to 1,000 per hour per account. Unauthenticated requests are limited to 100 per hour per IP address. A request over the limit receives 429 with a Retry-After header giving the number of seconds to wait. No rate limit headers are sent on successful responses.

Pagination

List endpoints return an object with count, next, previous and results, 25 items per page. Pass page to move between pages, or follow the next URL until it is null. The servers list also accepts page_size, up to 100.

{
  "count": 84,
  "next": "https://admin.vps.org/api/v1/backups/?page=2",
  "previous": null,
  "results": [ ... ]
}

Error Handling

The API uses standard HTTP status codes to indicate success or failure:

Error bodies are JSON. Most have a detail field or an error field, sometimes with a message; validation errors list the problems by field name.

API Categories

Browse our API documentation by category:

More Endpoints

The API also has endpoints for app deployments (/api/v1/deploy-configs/ and /api/v1/deployments/). They are not described on these pages yet; the interactive reference lists every endpoint, generated from the live API.

Need Help?

If you have questions or need assistance with the API, please don't hesitate to reach out:

• Support Tickets: Open a support ticket
• Email: hello@vps.org
• Documentation: Full Documentation