VPS.org API

Documentazione REST API

API di i piani

Elenca i piani di servituri ca si ponu dispiegari, cu li so risorse e prezzi. Passa l'uuid di un pianu comu plan_uuid quannu si crea o si ridimensiona un servituri.

Punti finali 2
Percorsu di Base /api/v1/plans
OTTIENI /api/v1/plans/

Elencu di tutti i piani

Ritorna tutti li piani attivi, u cchiù picciriddu prima. A lista nun havi filtri e attualmente si pò caricari nta na pàggina.

Permessi richiesti: plans:list

Esempiu di dumanda

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

Esempiu di risposta

{
  "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": ""
    }
  ]
}

Campi di risposta

Campu Tipu Descrizzioni
uuid string L'identificativu di u pianu. Usallu comu plan_uuid o new_plan_uuid.
cpu integer Nùmmaru di vuci
ram, ram_unit integer, string La quantità di memoria e la so unità (MB o GB)
disk_space integer Dimensioni discu in GB
disk_space_total integer Dimensioni discu in MB
transfer, transfer_unit integer, string A quantità mensili di dati trasfiriti è a so unità (GB o TB)
disk_space_unit string Unità di spazio_disco (GB)
includes_ipv4 boolean Si lu pianu includi un indirizzu IPv4 pùbblicu. Li piani senza unu sunnu sulu IPv6; un indirizzu IPv4 pò èssiri agghiunciutu pi $2.00/mese.
monthly_price, price string Prezzu mensili in USD comu na stringa dicimali. u prezzu hè u listessu valuri.
hourly_price string U prezzu orariu in USD comu stringa dicimali
cpu_type_name string U tipu di CPU, pi esempiu Cunnivisi. Omissioni pi piani senza tipu di CPU, comu lu pianu GPU.
is_active boolean Sempre vera in sta lista, picchì i piani inattivi nun sunnu riturnati
is_gpu, gpu_count, gpu_model boolean, integer, string Si lu pianu include GPU didicati, quanti, e quali mudellu
A risposta ùn dice micca se un pianu include un indirizzu IPv4. U pianu di 512 MB hè solu IPv6; l'altri piani attuali includenu IPv4. Comparate cù a pagina di prezzi prima di sceglie un pianu per un situ chì deve esse raggiungibile attraversu IPv4.

Codici di Statu di Risposta

200 Lista di piani ricivuti
403 Token API mancante o nun validu, o u token nun havi li permessi richiesti
OTTIENI /api/v1/plans/{uuid}/

Ottene i dettagli di u pianu

Ritorna un pianu attivu cu li campi supra. Un uuid inattivu o sconosciutu riturna 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": ""
}