La API REST te permite conectar un script o una aplicación con servicios de tu cuenta Hostbrid. Antes de automatizar cambios, haz una petición de lectura, confirma que ves los recursos correctos y entiende qué permiso requiere cada operación. La referencia pública se genera a partir de las rutas activas del panel: úsala como fuente de verdad cuando cambien los endpoints.
1. Crea y guarda una clave
Entra en Ajustes → claves API y crea una clave. El valor completo se enseña una sola vez. Guárdalo en un gestor de secretos o en el mecanismo seguro de tu entorno; no lo subas a Git, no lo incluyas en JavaScript del navegador y no lo pegues en un prompt o captura. Si alguien la ve, revócala y crea otra.
Una clave recién creada permite consultar. Los permisos para escribir, operar máquinas o borrar son independientes; algunos se tienen que pedir a soporte. Concede solo el permiso que exige el trabajo. La clave sigue activa hasta que la revocas, no porque tenga una fecha de caducidad corta.
2. Haz una petición de lectura
Define HOSTBRID_API_KEY en el entorno protegido de tu terminal y consulta tus sitios con una petición GET:
curl --fail-with-body \
-H "Authorization: Bearer $HOSTBRID_API_KEY" \
https://my.hostbrid.com/api/sites/v1/sites/
La clave debe empezar por nxp_. Si tu herramienta no puede configurar Authorization, la misma clave se puede enviar en X-API-Key. No uses el token de sesión del panel ni un JWT: la API de cliente autentica con la clave larga.
El ejemplo solo consulta. Para crear o cambiar un recurso, revisa primero el método, el cuerpo esperado y el permiso en la referencia OpenAPI. La consola muestra el esquema, pero no ejecuta las peticiones desde el navegador. La API limita cada clave por separado; si automatizas tareas periódicas, evita llamar en bucle cuando no haya cambios.
3. Lee el resultado antes de seguir
Trata la respuesta como datos de tu propia cuenta. Comprueba el estado HTTP y el JSON antes de dar una tarea por completada. Un 200 no demuestra por sí solo que se haya guardado lo que querías; una respuesta de una llamada de lectura solo confirma esa consulta.
| Respuesta | Qué revisar |
|---|---|
401 |
Falta la clave, está mal copiada, fue revocada o el encabezado no tiene el formato correcto. |
403 |
La clave no tiene el permiso requerido. Revisa el alcance que indica la referencia; no pruebes métodos al azar. |
404 |
La ruta o el recurso no existe para tu cuenta. Los recursos de otra cuenta no se revelan. |
429 |
Has superado el límite por clave. Reduce la frecuencia y evita repetir peticiones sin necesidad. |
No reintentes a ciegas una operación POST que pueda crear un pedido o recurso: primero comprueba si la operación anterior produjo resultado. No guardes encabezados de autenticación en logs ni compartas capturas que los contengan.
Después de la primera llamada
Para conocer el catálogo completo, los permisos por operación y los ejemplos de petición, abre la referencia de API REST. Si prefieres ejecutar tareas desde la terminal, consulta la guía de la CLI. Para conectar un asistente compatible con MCP, revisa API, CLI y MCP para automatizar Hostbrid y la guía para conectar una IA.
Si tu automatización es para contratar y administrar hardware, sigue el recorrido específico de la API para servidores dedicados.
Esta guía no habilita permisos, compra un servicio ni demuestra que un script arbitrario sea seguro. Primero prueba lecturas y concede permisos de escritura solo cuando necesites una acción concreta.