API de planes

Lista los planes de servidor que puedes implementar, con sus recursos y precios. Pasa el uuid de un plan como plan_uuid cuando creas o redimensionas un servidor.

Puntos finales 2

Ruta base /api/v1/plans

CONSEGUIR /api/v1/plans/

Listar todos los planes

Devuelve cada plan activo, el más barato primero. La lista no tiene filtros y actualmente se ajusta a una página.

Permiso requerido: plans:list

Ejemplo de solicitud

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

Ejemplo de respuesta

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

Campos de respuesta

Campo	Tipo	Descripción
`uuid`	string	Identificador del plan. Úselo como plan_uuid o new_plan_uuid.
`cpu`	integer	Número de UPCv
`ram`, `ram_unit`	integer, string	Cantidad de memoria y su unidad (MB o GB)
`disk_space`	integer	Tamaño del disco en GB
`disk_space_total`	integer	Tamaño del disco en MB
`transfer`, `transfer_unit`	integer, string	Subsidio mensual de transferencia de datos y su unidad (GB o TB)
`disk_space_unit`	string	Unidad de disco_espacio (GB)
`includes_ipv4`	boolean	Si el plan incluye una dirección IPv4 pública. Los planes sin uno son solamente IPv6; una dirección IPv4 se puede agregar por $2.00/mes.
`monthly_price`, `price`	string	Precio mensual en USD como cadena decimal. precio es el mismo valor.
`hourly_price`	string	Precio por hora en USD como cadena decimal
`cpu_type_name`	string	Tipo de CPU, por ejemplo Compartido. Omitido para planes sin un tipo de CPU, como el plan GPU.
`is_active`	boolean	Siempre es cierto en esta lista, porque los planes inactivos no se devuelven
`is_gpu`, `gpu_count`, `gpu_model`	boolean, integer, string	Si el plan incluye GPUs dedicadas, cuántas, y qué modelo

La respuesta no dice si un plan incluye una dirección IPv4. El plan de 512 MB es solamente IPv6; los otros planes actuales incluyen IPv4. Compare con la página de precios antes de elegir un plan para un sitio que debe ser accesible sobre IPv4.

Códigos de estado de respuesta

200	Lista de planes recuperados con éxito
403	Token API no válido o falta el token o el token carece del permiso requerido

CONSEGUIR /api/v1/plans/{uuid}/

Obtener detalles del plan

Devuelve un plan activo con los campos anteriores. Un uuid inactivo o desconocido devuelve 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": ""
}