VPS.org API

REST API Documentation

VPS.org API Documentation

Complete REST API documentation for managing VPS servers, domains, DNS, backups, and more.

Base URL https://admin.vps.org/api/v1
Authentication Bearer Token
Version v1.0
Format JSON

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
Python
JavaScript
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);

Rate Limiting

API requests are limited to 300 requests per 5 minutes per API token. Rate limit information is included in the response headers:

Error Handling

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

Status Code Description
200 Success - Request completed successfully
201 Created - Resource created successfully
400 Bad Request - Invalid parameters or malformed request
401 Unauthorized - Invalid or missing authentication token
403 Forbidden - Insufficient permissions
404 Not Found - Resource does not exist
429 Too Many Requests - Rate limit exceeded
500 Internal Server Error - Something went wrong on our end

API Categories

Browse our API documentation by category:

Servers API 9 endpoints

Create, manage, and control VPS servers. Includes power management, resizing, reinstallation, and server information retrieval.

View Documentation
Backups API 3 endpoints

Manage automated and manual backups for your servers. List, create, restore, and delete server backups.

View Documentation
Snapshots API 4 endpoints

Create and manage server snapshots for quick restoration points. Perfect for testing and quick rollbacks.

View Documentation
Plans API 2 endpoints

Retrieve available VPS plans and pricing information. Get details about resources, pricing, and availability.

View Documentation
Operating Systems API 2 endpoints

List available operating systems and images for server deployment. Includes Ubuntu, Debian, CentOS, and more.

View Documentation
Domains API 6 endpoints

Search, check availability, register, and manage domain names. Complete domain lifecycle management through the API.

View Documentation
DNS API 4 endpoints

Manage DNS zones and records programmatically. Create, update, and delete A, AAAA, CNAME, MX, TXT, and other record types.

View Documentation
Locations API 1 endpoint

List available datacenter locations for server deployment. Choose from multiple regions across the globe.

View Documentation

Need Help?

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