VPS.org API

REST API құжаттамасы

Орналасқан жерлердің API интерфейсі

VPS- ті орналастыруға болатын орындардың тізімі. Серверді құрғанда орынның идентификаторы location_ 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 Орналасқан жердің идентификаторы. Серверді құрғанда location_ id ретінде қолданылсын.
name string Адам оқыйтын мекеннің атауы
country_name string Орналасқан жері
country_code string ISO 3166- 1 alpha- 2 елдің коды, үлкен әріп
is_active boolean Орын жаңа серверлерді қабылдай ма

Жауап күйінің кодтары

200 Орындар тізімі сәтті алынды
403 API токені жоқ немесе жарамсыз, немесе токеннің қажетті рұқсаты жоқ
АЛУ /api/v1/locations/{id}/

Орнын алу

Бір адресті оның 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 арқылы бүкіл әлемдегі клиенттерге қызмет көрсетеді. Идентификаторды қатты кодтау емес, әрқашан мекеннің соңы оқылады, сондықтан сіздің біріктіруіңіз жаңа мекендерді қосқанда оларды қабылдайды.