Primeros pasos con la API
API y automatización
Automatiza el despliegue de servidores, redes y facturación con la API de Serverside.com. Empieza con un flujo o explora la referencia de endpoints.
Usa estas páginas para gestionar Serverside.com desde scripts e integraciones. Para instrucciones con la consola en la nube, abre Documentación.
Empezar a usar la API
Flujos de automatización
- Desplegar un servidor: claves SSH, cloud-init y progreso del despliegue.
- Alimentación y acceso remoto: comandos de alimentación, sesiones de consola y medios virtuales.
- Scripts iPXE personalizados: configura un flujo de arranque personalizado.
- Gestionar direcciones IP: asignaciones de direcciones y DNS inverso.
- Configurar redes virtuales: creación de redes y conexión de servidores.
Referencia de endpoints
https://api.serverside.com
Las peticiones llevan una clave de API de organización como token Bearer en la cabecera Authorization (Autenticación). Una llamada correcta responde con success, data y, en una lista paginada, pagination; una fallida responde con un estado HTTP y la estructura de error, cuyo code indica qué falló (Convenciones de la API).
La referencia enumera únicamente las operaciones que una clave puede invocar. Los miembros, roles, invitaciones, claves de API, notificaciones, tu perfil y los tickets de soporte se gestionan en la consola; sus endpoints responden a una clave con 401 (Operaciones que una clave no puede invocar).
Cada página de endpoint enumera los parámetros y campos, indica el permiso que necesita la clave cuando la operación comprueba uno y muestra un cuerpo de ejemplo para cada estado de respuesta posible, incluidos los errores. La petición aparece en cURL, Node.js, Python, Go, PHP, Ruby, Java, C# y PowerShell, y Try it la envía a la API real con la clave que pegues.
La referencia se genera a partir del documento OpenAPI para clientes de la API, la descripción de las operaciones que puede invocar una clave de API de organización. Descárgalo como JSON para generar un cliente o importarlo en una herramienta de API.
Grupos de endpoints
| Área | Grupo | Contenido |
|---|---|---|
| Bare metal | Servidores | Enumerar, crear con facturación por hora, renombrar, bloquear y eliminar servidores; estado, suscripción y redes virtuales de cada servidor |
| Alimentación | Comandos de alimentación, reinicio del BMC, lecturas de PSU, térmicas y de consumo | |
| Operaciones | Imágenes de SO y aplicaciones, despliegues, pruebas de hardware y sus cancelaciones | |
| Acceso remoto | Sesiones de consola y medios virtuales | |
| Arranque e iPXE | Script iPXE personalizado y modo de arranque | |
| ISO del servicio | Las ISO que puede montar un servidor y cuáles están montadas | |
| Redes | Puertos, segmentos, resultados de análisis de seguridad | |
| Ancho de banda | Transferencia diaria respecto a la cuota mensual e historial de tasas de tráfico | |
| Actividad | Registro de auditoría de un servidor | |
| Redes | Redes virtuales | Crear redes, etiquetas VLAN, conectar y desconectar servidores |
| Bloques de IP | Enumerar bloques y sus direcciones, añadir o devolver un bloque | |
| Direcciones IP | Asignar, reservar y liberar direcciones; DNS inverso para IPv4 | |
| Análisis de seguridad | Hallazgos, destinos y nuevos análisis | |
| Facturación | Pedidos | Realizar y consultar pedidos |
| Suscripciones | Estado de renovación y cancelación | |
| Facturas | Consultar, pagar y descargar facturas | |
| Uso | Cargos del periodo actual | |
| Crédito y Métodos de pago | Crédito de cuenta y tarjetas guardadas | |
| Catálogo | Planes | Planes bare metal y de bloques de IP con precios y existencias |
| Regiones | Centros de datos donde se pueden contratar servicios, con sus códigos | |
| Organización | Derechos | Límites y funciones activadas para la organización, incluida la facturación por hora |
| Claves SSH | Claves públicas que se instalarán en servidores nuevos | |
| Actividad | Registro de auditoría de la organización | |
| Recursos | Biblioteca ISO | Subir y eliminar las ISO que montan los medios virtuales |