VPS.org API

Документация REST API

API местоположений

Перечислите места, где вы можете использовать VPS. Пропускайте идентификатор места как место_id, когда вы создаёте сервер.

Конечные точки 2 endpoints
Базовый путь /api/v1/locations
ПОЛУЧАТЬ /api/v1/locations/

Список всех местоположений

Найдите список всех имеющихся мест в центре данных, где вы можете развертывать серверы VPS.

Пример запроса

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

Пример ответа

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

Поля ответа

Полевая Тип Описание
id integer Идентификатор местоположения. Используйте его как местоположение_id при создании сервера.
name string Имя места, которое можно прочесть
country_name string Страна, где находится
country_code string ISO 3166-1, альфа-2, код страны, верхний ящик
is_active boolean Принимает ли место новые серверы

Коды состояния ответа

200 Список местоположений успешно получен.
403 Недопущенный или недействительный токен API или же знак не имеет требуемого разрешения
ПОЛУЧАТЬ /api/v1/locations/{id}/

Найти местоположение

Получить одну локацию по её id. В ответе возвращается один объект location с перечисленными выше полями.

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
}

Где работают ваши серверы

Каждый сервер VPS.org в настоящее время работает в нашем Нью-Джерси, США, который обслуживает клиентов по всему миру по IPv4 и IPv6. Всегда читает конечная точка местоположения, а не жестко кодирует идентификатор, поэтому ваша интеграция поднимает новые точки, когда они добавлены.