VPS.org API

REST API-documentatie

Plannen-API

Geef een lijst van de serverplannen die u kunt implementeren, met hun bronnen en prijzen. Geef een plan uuid als plan_uuid wanneer u een server aanmaakt of formaat wijzigt.

Eindpunten 2
Basispad /api/v1/plans
KRIJGEN /api/v1/plans/

Alle plannen weergeven

Geeft elk actief plan terug, het goedkoopste eerst. De lijst heeft geen filters en past momenteel op één pagina.

Vereiste toestemming: plans:list

Voorbeeldverzoek

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

Voorbeeldantwoord

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

Antwoordvelden

Veld Type Omschrijving
uuid string Plan-identificatie. Gebruik het als plan_uuid of new_plan_uuid.
cpu integer Aantal vCPU's
ram, ram_unit integer, string Geheugenbedrag en eenheid (MB of GB)
disk_space integer Schijfgrootte in GB
disk_space_total integer Schijfgrootte in MB
transfer, transfer_unit integer, string Maandelijkse tegoed voor gegevensoverdracht en de eenheid daarvan (GB of TB)
disk_space_unit string Eenheid schijf_ruimte (GB)
includes_ipv4 boolean Of het plan een openbaar IPv4-adres bevat. Plannen zonder IPv6 zijn alleen; een IPv4-adres kan worden toegevoegd voor $2,00/maand.
monthly_price, price string Maandprijs in USD als decimaal tekenreeks. prijs is dezelfde waarde.
hourly_price string Uurprijs in USD als decimaal
cpu_type_name string CPU type, bijvoorbeeld Shared. Toegestaan voor plannen zonder een CPU type, zoals het GPU plan.
is_active boolean Altijd waar in deze lijst, omdat inactieve plannen niet worden teruggegeven
is_gpu, gpu_count, gpu_model boolean, integer, string Of het plan dedicated GPU's bevat, hoeveel, en welk model
Het antwoord geeft niet aan of een plan een IPv4-adres bevat. Het 512 MB-plan is alleen IPv6; de andere huidige plannen zijn IPv4. Vergelijk met de prijspagina voordat u een plan kiest voor een site die bereikbaar moet zijn via IPv4.

Responsstatuscodes

200 Geslaagd opgehaalde lijst van plannen
403 Ontbrekende of ongeldige API token, of het token mist de vereiste toestemming
KRIJGEN /api/v1/plans/{uuid}/

Bekijk de details van het abonnement

Geeft een actief plan terug met de velden hierboven. Een inactief of onbekend uuid geeft 404 terug.

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