VPS.org API

REST API Documentation

Pläne-API

Liste die Serverpläne auf, die du bereitstellen kannst, mit ihren Ressourcen und Preisen. Übergib die Uuid eines Plans als plan_uuid, wenn du einen Server erstellst oder sizest.

Endpunkte 2
Basispfad /api/v1/plans
ERHALTEN /api/v1/plans/

Alle Tarife auflisten

Gibt zuerst jeden aktiven Plan zurück, billigste. Die Liste hat keine Filter und passt aktuell auf eine Seite.

Erforderliche Genehmigung: plans:list

Beispielanfrage

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

Beispielantwort

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

Antwortfelder

Feld Typ Description
uuid string Plankennung. Verwenden Sie es als plan_uuid oder new_plan_uuid.
cpu integer Anzahl der vCPUs
ram, ram_unit integer, string Speichermenge und seine Einheit (MB oder GB)
disk_space integer Festplattengröße in GB
disk_space_total integer Festplattengröße in MB
transfer, transfer_unit integer, string Monatliche Datenübermittlungszulage und ihre Einheit (GB oder TB)
disk_space_unit string Einheit des Disk_space (GB)
includes_ipv4 boolean Ob der Plan eine öffentliche IPv4-Adresse enthält. Pläne ohne eine sind nur IPv6; eine IPv4-Adresse kann für $2.00/Monat hinzugefügt werden.
monthly_price, price string Monatlicher Preis in USD als Dezimalzeichen. Preis ist der gleiche Wert.
hourly_price string Stundenpreis in USD als Dezimalzeichenfolge
cpu_type_name string CPU-Typ, zum Beispiel Shared. Odited für Pläne ohne CPU-Typ, wie der GPU-Plan.
is_active boolean Immer in dieser Liste wahr, weil nicht aktive Pläne nicht zurückgegeben werden
is_gpu, gpu_count, gpu_model boolean, integer, string Ob der Plan dedizierte GPUs umfasst, wie viele und welches Modell
Die Antwort sagt nicht, ob ein Plan eine IPv4-Adresse enthält. Der 512 MB-Plan ist nur IPv6; die anderen aktuellen Pläne beinhalten IPv4. Vergleichen Sie mit der Preisseite, bevor Sie einen Plan für eine Website, die über IPv4 erreichbar sein muss.

Antwortstatuscodes

200 Erfolgreich abgerufene Pläne Liste
403 Fehlendes oder ungültiges API-Token oder dem Token fehlt die erforderliche Berechtigung
ERHALTEN /api/v1/plans/{uuid}/

Tarifdetails anfordern

Gibt einen aktiven Plan mit den oben genannten Feldern zurück. Ein inaktiver oder unbekannter Uuid gibt 404 zurück.

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