VPS.org API

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

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 Идентификатор на местоположението. Използвайте го като местоположение_ id при създаване на сървър.
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. Винаги прочети точките крайна точка, а не твърдо кодиране на идентификатор, така че вашата интеграция избере нови места, когато те се добавят.