VPS.org API

Dokumentimi i API REST

API-ja e planeve

Liston planet e serverit që mund të vendosni, me burimet dhe çmimet e tyre. Përcille uuid të një plani si plan_uuid kur krijon apo ripërmason një server.

Pikat fundore 2
Shtegu Bazë /api/v1/plans
MERR /api/v1/plans/

Listo të gjitha planet

Kthen çdo plan aktiv, më të lirin së pari. Lista nuk ka filtra dhe aktualisht përshtatet në një faqe.

Të drejta të nevojshme: plans:list

Shembull Kërkese

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

Shembull Përgjigjeje

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

Fushat e Përgjigjes

Fusha Lloji Përshkrimi
uuid string Identifikuesi i planit. Përdoret si plan_uuid ose new_plan_uuid.
cpu integer Numri i CPU
ram, ram_unit integer, string Sasia e memories dhe njësia e saj (MB ose GB)
disk_space integer Madhësia e disk
disk_space_total integer Madhësia e disk
transfer, transfer_unit integer, string Transferimi i të dhënave mujore dhe njësia e tij (GB ose TB)
disk_space_unit string Njësia e hapësirës disk (GB)
includes_ipv4 boolean Nëse plani përfshin një adresë IPv4 publike. Planet pa një janë vetëm IPv6; një adresë IPv4 mund të shtohet për $2.00/muaj.
monthly_price, price string Çmimi mujor në USD si string decimal. çmimi është e njëjta vlerë.
hourly_price string Çmimi orar në USD si stringë decimale
cpu_type_name string Lloji i CPU, për shembull i përbashkët. Hiqet për planet pa një lloj CPU, si plani GPU.
is_active boolean Gjithmonë e vërtetë në këtë listë, sepse planet inaktive nuk kthehen
is_gpu, gpu_count, gpu_model boolean, integer, string Nëse plani përfshin GPU të dedikuar, sa dhe cili model
Përgjigja nuk thotë nëse një plan përfshin një adresë IPv4. Plani 512 MB është vetëm IPv6; planet e tjera aktuale përfshijnë IPv4. Krahaso me faqen e çmimeve para se të zgjedhësh një plan për një site që duhet të arrihet nëpërmjet IPv4.

Kodet e Statusit të Përgjigjes

200 Lista e planeve u mor me sukses
403 Token i munguar apo i pavlefshëm API, ose token nuk ka të drejtat e kërkuara
MERR /api/v1/plans/{uuid}/

Merrni Detajet e Planit

Kthen një plan aktiv me fushat e mësipërme. Një uuid i paaktiv apo i panjohur kthen 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": ""
}