API Plans

Énumérez les plans de serveur que vous pouvez déployer, avec leurs ressources et leurs prix. Passez l'uid d'un plan en tant que plan_uuid lorsque vous créez ou redimensionnez un serveur.

Points d'extrémité 2

Chemin de base /api/v1/plans

OBTENIR /api/v1/plans/

Liste de tous les forfaits

Retourne chaque plan actif, le moins cher d'abord. La liste n'a pas de filtres et s'adapte actuellement sur une page.

Autorisation requise: plans:list

Exemple de requête

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

Exemple de réponse

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

Champs de réponse

Champ	Taper	Désignation des marchandises
`uuid`	string	Identificateur de plan. Utilisez-le comme plan_uuid ou new_plan_uuid.
`cpu`	integer	Nombre de VCPU
`ram`, `ram_unit`	integer, string	Quantité de mémoire et son unité (MB ou GB)
`disk_space`	integer	Taille du disque en GB
`disk_space_total`	integer	Taille du disque en MB
`transfer`, `transfer_unit`	integer, string	Allocation mensuelle de transfert de données et son unité (GB ou CT)
`disk_space_unit`	string	Unité d'espace_disque (GB)
`includes_ipv4`	boolean	Indique si le plan inclut une adresse IPv4 publique. Les plans sans une ne sont IPv6 seulement; une adresse IPv4 peut être ajoutée pour $2.00/mois.
`monthly_price`, `price`	string	Prix mensuel en USD comme une chaîne décimale. prix est la même valeur.
`hourly_price`	string	Prix horaire en USD comme chaîne décimale
`cpu_type_name`	string	Type de processeur, par exemple Shared. Omis pour les plans sans type de processeur, comme le plan GPU.
`is_active`	boolean	Toujours vrai dans cette liste, car les plans inactifs ne sont pas retournés
`is_gpu`, `gpu_count`, `gpu_model`	boolean, integer, string	Indique si le plan comprend des GPU dédiés, combien et quel modèle

La réponse ne dit pas si un plan inclut une adresse IPv4. Le plan de 512 Mo est IPv6 seulement ; les autres plans actuels incluent IPv4. Comparez avec la page de prix avant de choisir un plan pour un site qui doit être accessible par rapport à IPv4.

Codes d'état de réponse

200	Liste des plans récupérés avec succès
403	Jeton API manquant ou invalide, ou le jeton manque la permission requise

OBTENIR /api/v1/plans/{uuid}/

Consultez les détails du forfait

Retourne un plan actif avec les champs ci-dessus. Un uuid inactif ou inconnu retourne 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": ""
}