VPS.org API

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

API за планове

Изброете плановете за сървъра, които можете да разгръщате с техните ресурси и цени. Прехвърлите ууид на плана като план_uuid, когато създадете или промените размера на сървъра.

Крайни точки 2
Базов път /api/v1/plans
ПОЛУЧИ /api/v1/plans/

Списък на всички планове

Връща всеки активен план, най-евтино първо. Списъкът няма филтри и в момента се вписва на една страница.

Изискан разрешение: plans:list

Примерна заявка

cURL
Python
JavaScript
PHP
curl -X GET "https://admin.vps.org/api/v1/plans/" \
  -H "Authorization: Bearer YOUR_API_TOKEN"
import requests

url = "https://admin.vps.org/api/v1/plans/"
headers = {"Authorization": "Bearer YOUR_API_TOKEN"}

response = requests.get(url, headers=headers)
for plan in response.json()["results"]:
    print(plan["uuid"], plan["cpu"], plan["ram"], plan["ram_unit"], plan["monthly_price"])
const response = await fetch('https://admin.vps.org/api/v1/plans/', {
  headers: { 'Authorization': 'Bearer YOUR_API_TOKEN' }
});

const data = await response.json();
console.log(data.results);
$ch = curl_init('https://admin.vps.org/api/v1/plans/');
curl_setopt($ch, CURLOPT_HTTPHEADER, ['Authorization: Bearer YOUR_API_TOKEN']);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);

$plans = json_decode(curl_exec($ch), true);
curl_close($ch);

Примерен отговор

{
  "count": 12,
  "next": null,
  "previous": null,
  "results": [
    {
      "uuid": "ed0ac717-c26c-4d9b-a801-b170c4979028",
      "cpu": 1,
      "ram": 512,
      "ram_unit": "MB",
      "disk_space": 10,
      "disk_space_total": 10240,
      "transfer": 500,
      "transfer_unit": "GB",
      "includes_ipv4": false,
      "price": "2.50",
      "cpu_type_name": "Shared",
      "is_active": true,
      "hourly_price": "0.004",
      "monthly_price": "2.50",
      "is_gpu": false,
      "gpu_count": 0,
      "gpu_model": ""
    },
    {
      "uuid": "14186969-fbaf-43e1-9ab2-b1f1aeb66674",
      "cpu": 1,
      "ram": 2,
      "ram_unit": "GB",
      "disk_space": 25,
      "disk_space_total": 25600,
      "transfer": 1,
      "transfer_unit": "TB",
      "includes_ipv4": true,
      "price": "5.00",
      "cpu_type_name": "Shared",
      "is_active": true,
      "hourly_price": "0.007",
      "monthly_price": "5.00",
      "is_gpu": false,
      "gpu_count": 0,
      "gpu_model": ""
    }
  ]
}

Полета за отговор

Поле Тип Описание
uuid string Използвайте го като план_ууид или нова_план_уид.
cpu integer Брой вСПУ
ram, ram_unit integer, string Количество на паметта и единицата му (MB или GB)
disk_space integer Размер на диска в GB
disk_space_total integer Размер на диска в MB
transfer, transfer_unit integer, string Месечно надбавка за прехвърляне на данни и нейната единица (GB или TB)
disk_space_unit string Единица на диска_ пространство (GB)
includes_ipv4 boolean Дали планът включва публичен IPv4 адрес. Плановете без него са само IPv6; IPv4 адресът може да бъде добавен за 2,00 долара/месечно.
monthly_price, price string Месечна цена в USD като десетична низ. цена е същата стойност.
hourly_price string Почасова цена в USD като десетичен низ
cpu_type_name string Тип на процесора, например Споделено. Изпратено за планове без тип на процесор, като например планът на GPU.
is_active boolean Винаги е вярно в този списък, защото неактивните планове не са върнати
is_gpu, gpu_count, gpu_model boolean, integer, string Дали планът включва специализирани GPU, колко, и кой модел
В отговора не се посочва дали планът включва IPv4 адрес. Планът 512 MB е само IPv6; останалите текущи планове включват IPv4. Сравни с ценовната страница преди избора на план за сайт, който трябва да бъде достижим в IPv4.

Кодове за състояние на отговора

200 Успешно изтеглени планове
403 Липсва или невалиден API жетон, или на жетонът липсва изискваното разрешение
ПОЛУЧИ /api/v1/plans/{uuid}/

Получете подробности за плана

Връща един активен план с полетата по- горе. Неактивен или неизвестен uuid връща 404.

curl -X GET "https://admin.vps.org/api/v1/plans/ed0ac717-c26c-4d9b-a801-b170c4979028/" \
  -H "Authorization: Bearer YOUR_API_TOKEN"
{
  "uuid": "ed0ac717-c26c-4d9b-a801-b170c4979028",
  "cpu": 1,
  "ram": 512,
  "ram_unit": "MB",
  "disk_space": 10,
  "disk_space_total": 10240,
  "transfer": 500,
  "transfer_unit": "GB",
  "includes_ipv4": false,
  "price": "2.50",
  "cpu_type_name": "Shared",
  "is_active": true,
  "hourly_price": "0.004",
  "monthly_price": "2.50",
  "is_gpu": false,
  "gpu_count": 0,
  "gpu_model": ""
}