VPS.org API

Документація з програмного інтерфейсу REST

API місцезнаходжень

Показує список адрес, за допомогою яких ви можете відкрити VPS. Передайте ідентифікатор адреси як ідентифікатор_ адреси під час створення сервера.

Кінцеві точки 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 Ідентифікатор адреси. Використовуйте його як адресу_ ІД під час створення сервера.
name string Назва адреси, яку можна прочитати
country_name string Країна, де знаходиться місто
country_code string Код країни ISO 3166- 1- альфа- 2, верхній регістр
is_active boolean Чи приймати нові сервери

Коди стану відповіді

200 Список місць розташування успішно отримано
403 Відсутній або некоректний ключ API або елемент не має потрібного дозволу
ОТРИМАТИ /api/v1/locations/{id}/

Отримати адресу

Отримати окреме місце за ідентифікатором. Відповідь - це об' єкт одного місця з вказаними вище полями.

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. Завжди читати точки призначення, а не жорсткий кодування ідентифікатора, отже, ваша інтеграція обирає нові місця, коли їх буде додано.