Locations API

List the locations where you can deploy a VPS. Pass a location's id as location_id when you create a server.

Endpoints 2 endpoints

Base Path /api/v1/locations

GET /api/v1/locations/

List All Locations

Retrieve a list of all available datacenter locations where you can deploy VPS servers.

Example Request

cURL

Python

JavaScript

PHP

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

import requests

url = "https://admin.vps.org/api/v1/locations/"
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/locations/', {
  method: 'GET',
  headers: {
    'Authorization': 'Bearer YOUR_API_TOKEN',
    'Content-Type': 'application/json'
  }
});

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

$ch = curl_init('https://admin.vps.org/api/v1/locations/');
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    'Authorization: Bearer YOUR_API_TOKEN',
    'Content-Type: application/json'
]);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);

$response = curl_exec($ch);
$locations = json_decode($response, true);
curl_close($ch);

Example Response

{
  "count": 1,
  "next": null,
  "previous": null,
  "results": [
    {
      "id": 1,
      "name": "New Jersey",
      "country_name": "United States",
      "country_code": "US",
      "is_active": true
    }
  ]
}

Response Fields

Field	Type	Description
`id`	integer	Location identifier. Use it as location_id when creating a server.
`name`	string	Human-readable location name
`country_name`	string	Country the location is in
`country_code`	string	ISO 3166-1 alpha-2 country code, uppercase
`is_active`	boolean	Whether the location is accepting new servers

Response Status Codes

200	Successfully retrieved locations list
403	Missing or invalid API token, or the token lacks the required permission

GET /api/v1/locations/{id}/

Get a Location

Retrieve a single location by its id. The response is one location object with the fields above.

curl -X GET "https://admin.vps.org/api/v1/locations/1/" \
  -H "Authorization: Bearer YOUR_API_TOKEN"

{
  "id": 1,
  "name": "New Jersey",
  "country_name": "United States",
  "country_code": "US",
  "is_active": true
}

Where Your Servers Run

Every VPS.org server currently runs in our New Jersey, USA location, which serves customers worldwide over IPv4 and IPv6. Always read the locations endpoint rather than hardcoding an id, so your integration picks up new locations when they are added.

VPS.org API