VPS.org API

REST API Documentation

Planer API

Liste serverplaner du kan implementere, med deres ressourcer og priser. Pass en plan uuid som plan_uuid når du opretter eller ændrer størrelsen på en server.

Endepunkter 2
Basissti /api/v1/plans
/api/v1/plans/

Liste over alle planer

Returnerer alle aktive planer, billigste først. Listen har ingen filtre og passer i øjeblikket på en side.

Krævet tilladelse: plans:list

Eksempel på anmodning

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

Eksempel på svar

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

Svarfelter

Felt Type Description
uuid string Plan- identifikator. Brug det som plan_ uuid eller new_ plan_ uuid.
cpu integer Antal vCPU'er
ram, ram_unit integer, string Hukommelsesmængde og dens enhed (MB eller GB)
disk_space integer Diskstørrelse i GB
disk_space_total integer Diskstørrelse i MB
transfer, transfer_unit integer, string Månedlig dataoverførselsgodtgørelse og dens enhed (GB eller TB)
disk_space_unit string Enhed af disk_space (GB)
includes_ipv4 boolean Om planen indeholder en offentlig IPv4- adresse. Planer uden en er kun IPv6; en IPv4- adresse kan tilføjes for $ 2,00 / måned.
monthly_price, price string Månedlig pris i USD som en decimal streng. pris er den samme værdi.
hourly_price string Timepris i USD som decimalstreng
cpu_type_name string CPU- type, for eksempel delt. Udtaget for planer uden en CPU- type, såsom GPU- planen.
is_active boolean Altid sandt på denne liste, fordi inaktive planer ikke returneres
is_gpu, gpu_count, gpu_model boolean, integer, string Om planen indeholder dedikerede GPU'er, hvor mange, og hvilken model
Svaret siger ikke om en plan indeholder en IPv4- adresse. 512 MB- planen er kun IPv6; de andre aktuelle planer omfatter IPv4. Sammenlign med prissiden før du vælger en plan for et websted, der skal være tilgængelig over IPv4.

Svarstatuskoder

200 List over planer, der er blevet hentet med succes
403 Manglende eller ugyldig API token, eller den token mangler den krævede tilladelse
/api/v1/plans/{uuid}/

Få planoplysninger

Returnerer en aktiv plan med felterne ovenfor. En inaktiv eller ukendt uuid giver 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": ""
}