HELPER VPS

API de VPS: automatiza tus servidores en la nube con JSON REST

API de servidores en la nube para gestionar desde tu código desde la creación hasta el borrado

  • JSON REST API
  • Autenticación con clave API (Bearer)
  • 300 peticiones por minuto

Una API de VPS es una forma programática de realizar el trabajo que harías en el panel de control, como crear, iniciar, detener y eliminar servidores, mediante solicitudes HTTP. La API de servidores en la nube de HELPER VPS es gratuita para todos los miembros; después de tu primer pago, crea una clave API y conéctate de inmediato.

  • REST API

    Todos los usuarios

    Gratis

    Facturado mensualmente

    • JSON REST
    • Clave API (Bearer)
    • 300 por minuto
    • Gratis

Si quieres ver al instante ejemplos de peticiones y formatos de respuesta Documentación de la API

¿Qué puedo automatizar con la API de VPS?

La API de VPS rinde al máximo cuando creas y borras servidores a menudo o gestionas muchos servidores a la vez. Resumimos cuatro automatizaciones frecuentes.

Panel o API de VPS: ¿cuándo usar cada uno?

El panel de control y la API funcionan con la misma cuenta y los mismos servidores. Para gestionar uno o dos servidores manualmente, el panel de control es conveniente; para trabajos repetitivos o muchos servidores, la API es más rápida.

Panel

Gestión pulsando en pantalla

Ideal para

  • Cuando creas tu primer servidor
  • Cuando gestionas tú mismo uno o dos servidores
  • Reinstalación del sistema operativo y registro de claves SSH
  • Cuando quieres volver a ver la contraseña de root

VPS API

Gestión mediante peticiones desde código

Ideal para

  • Entornos de prueba donde creas y borras servidores a menudo
  • Automatización de pipelines de despliegue y scripts
  • Cuando quieres leer de una vez el estado de muchos servidores
  • Cuando la conectas con tu propio panel de administración o bot

¿Cómo me conecto a la API de servidores en la nube?

Se necesitan tres pasos. Primero, realiza tu primer pago y, una vez confirmado, crea una clave en la página de claves API. Luego, coloca la clave en el encabezado Authorization de cada solicitud utilizando el esquema Bearer. Finalmente, envía solicitudes a la ruta que desees después de la dirección base https://helpervps.com/api/v1, y los resultados se devuelven en JSON.

Para empezar conviene llamar a GET /catalog. Devuelve de una vez los tipos y tamaños de servidor disponibles, los códigos de región, los códigos de sistemas operativos y apps en un clic, y los precios de copias automáticas, disco adicional y protección DDoS. Pon tal cual los códigos plan, location e image recibidos en la petición de creación de servidor.

Para crear un servidor, envía los valores plan, location, image y label como JSON a POST /servers. También puedes incluir el ID de una clave SSH que hayas añadido y las opciones backups, extra_disk_gb y ddos_protection. Pagas por el período elegido por adelantado, y la respuesta contiene el ID del servidor, el estado y la contraseña root, así que guárdalos en un lugar seguro de inmediato.

¿Qué tareas puedo hacer con la API de VPS?

La API de VPS cubre todo el ciclo de vida del servidor, de principio a fin. Con GET /catalog lees el catálogo, con POST /servers creas servidores, con GET /servers lees tu lista de servidores y con GET /servers/{id} la información de un servidor. La respuesta incluye nombre, estado, direcciones IPv4 e IPv6, tarifa mensual, opciones elegidas y próxima fecha de pago del servidor.

El encendido se controla con las peticiones POST /servers/{id}/start, stop y reboot para encender, apagar y reiniciar. POST /servers/{id}/renew paga ahora un mes sin esperar a la fecha de pago y renueva al instante, y DELETE /servers/{id} borra el servidor. Si la petición no cuadra con el estado actual del servidor, te avisa con el código wrong_state, así que a tu script le es fácil decidir el siguiente paso.

Los errores vuelven con su código de estado y un JSON con el valor error. Si la clave no es válida, unauthorized; si falta saldo, not_enough_balance; si la cuenta alcanza el límite de servidores, limit; si hay demasiadas peticiones, rate_limited: el motivo viene como código, así que en tu programa es fácil tratar cada caso. La lista completa y los ejemplos de respuesta están en la documentación de la API.

¿Cuánto cuesta la API de VPS?

La API de VPS es gratuita para todos los miembros. Los servidores y opciones creados con la API se pagan a los mismos precios que los servidores creados en el panel de control.

HELPER VPS en cifras

Elige entre 40 regiones, 12 sistemas operativos y 10 aplicaciones de un clic en una sola cuenta, y paga de inmediato. Los números a continuación se basan en lo que está en oferta ahora.

Herramientas de automatización que se usan con la API de VPS

Cualquier herramienta capaz de enviar peticiones HTTP se conecta a la API de VPS. Desde una línea de curl hasta scripts en Python o Node.js y pipelines de despliegue, todo se usa de la misma forma.

  • Terraform
  • Python
  • Node.js
  • GitLab CI
  • Docker

Por qué elegir la API de HELPER VPS

Preguntas frecuentes sobre la API de VPS

Respuestas sobre la conexión, la autenticación y el límite de peticiones de la API de VPS

¿La API de VPS es gratis?

Sí, la API de VPS es gratuita para todos los miembros. Emitir claves API y realizar solicitudes es gratuito, y los servidores y opciones creados con la API se pagan a los mismos precios que los creados en el panel de control. Cualquier miembro que haya realizado su primer pago puede crear una clave de inmediato en la página de claves API.

¿Dónde creo la clave API?

Una vez que realices tu primer pago, se abre la página de claves API (/api-key) y allí creas las claves. Coloca la clave en el encabezado Authorization de cada solicitud utilizando el esquema Bearer. La clave desbloquea toda tu cuenta, así que no la comprometas en repositorios de código; guárdala en variables de entorno o en un almacén de secretos.

¿Qué tareas puedo hacer con la API?

Puedes leer el catálogo (GET /catalog), leer la lista de servidores y la información de uno (GET /servers, GET /servers/{id}), crear servidores (POST /servers), encender, apagar y reiniciar (start, stop, reboot), renovar un mes (renew) y borrar (DELETE /servers/{id}). Los ejemplos de peticiones y formatos de respuesta están en la documentación de la API.

¿Cuál es el límite de peticiones?

Con una clave haces hasta 300 peticiones por minuto. Si superas el límite, vuelve un código de estado 429 con el error rate_limited, así que haz que tu script espere un momento y vuelva a enviar. Las automatizaciones diarias, como consultar la lista de servidores o gestionar el encendido, funcionan con holgura dentro de este límite. No hay coste por número de peticiones.

¿Cómo se cobra un servidor creado por API?

Cuando una solicitud POST /servers tiene éxito, se procesa el pago por el período de facturación elegido y se crea el servidor. El pago por un servidor que no se crea se devuelve al crédito de tu cuenta.

¿Cómo recibo la contraseña de root por API?

La respuesta a la petición de creación de servidor trae una vez el valor root_password. Guárdala en un lugar seguro en cuanto recibas la respuesta. También puedes volver a verla en el panel durante 7 días, y si envías a la vez el número de clave SSH, entras directamente con la clave sin contraseña. Con el valor ipv4 de la respuesta puedes empezar al instante la conexión SSH, así que se integra bien con scripts de despliegue.

¿Puedo añadir claves SSH por API?

Sí, si en la petición de creación de servidor pones el número de una clave SSH registrada en el valor ssh_key_id, esa clave se instala en el nuevo servidor. Basta con registrar la clave una vez en la pantalla de claves SSH del panel, y la huella se muestra igual que en ssh-keygen, así que reconoces al instante cada clave. Fija el número de clave una vez y reutilízalo.

¿Con qué lenguajes o herramientas puedo usarla?

Con cualquier lenguaje o herramienta capaz de enviar peticiones HTTP. Pruébala al instante con curl, y llámala con la misma dirección y cabeceras desde requests de Python, fetch de Node.js, los pasos de script de GitLab CI o la función de peticiones HTTP de Terraform. Todas las respuestas son JSON, así que leer los resultados es fácil.

¿Cómo sé si hay un error?

Los errores vuelven con un código de estado distinto de 2xx y un JSON con el valor error. Si la clave es incorrecta, unauthorized; si falta un valor, bad_request; si falta saldo, not_enough_balance; si la petición no cuadra con el estado del servidor, wrong_state: los motivos vienen separados, así que tu programa trata cada caso.

¿Los servidores creados por API aparecen en el panel?

Sí, la API y el panel trabajan con la misma cuenta y los mismos servidores. Los servidores creados por API aparecen tal cual en la lista del panel, y desde el panel puedes reinstalar el sistema operativo o consultar la contraseña. El límite de 10 servidores por cuenta se aplica a ambos métodos. Aunque combines tareas manuales y desde código, el estado y las fechas de pago siempre se ven igual.

Guías de la API de VPS

Guías que conviene leer al conectar la API por primera vez

La API de VPS es gratuita para todos los miembros, y puedes crear una clave API después de realizar tu primer pago. Los servidores y opciones creados con la API se pagan a los mismos precios que la lista de precios y se renuevan automáticamente por el mismo monto en cada fecha de facturación.

Límite de solicitudes: 300 por minuto por clave API | 10 servidores por cuenta | Si el pago falla: servidor suspendido, luego eliminado 3 días después | El tiempo restante en servidores eliminados no se reembolsa. Los reembolsos se devuelven al crédito de tu cuenta.