hostinger-api-mcp
Servidor de Protocolo de Contexto de Modelo (MCP) para la API Hostinger.
Requisitos previos
- Node.js versión 20 o superior
Si no tienes Node.js instalado, puedes descargarlo de la web oficial. Alternativamente, puedes usar un gestor de paquetes como Homebrew (para macOS) o Chocolatey (para Windows) para instalar Node.js.
Recomendamos usar NVM (Node Version Manager) para instalar y gestionar las versiones de Node.js instaladas. Después de instalar NVM, puedes instalar Node.js con el siguiente comando:
nvm install v20 nvm use v20
Instalación
Para instalar el servidor MCP, ejecute uno de los siguientes comandos, dependiendo de su gestor de paquetes:
# Instalar globalmente desde npm npm install -g hostinger-api-mcp # O con yarn yarn global add hostinger-api-mcp # O con pnpm pnpm add -g hostinger-api-mcp
Actualizar
Para actualizar el servidor MCP a la última versión, utilice uno de los siguientes comandos, dependiendo de su gestor de paquetes:
# Actualizar globalmente desde npm npm update -g hostinger-api-mcp # O con yarn yarn global upgrade hostinger-api-mcp # O con pnpm pnpm update -g hostinger-api-mcp
Configuración
Las siguientes variables de entorno se pueden configurar al ejecutar el servidor:
DEBUG
: Habilitar el registro de depuración (true/false) (por defecto: false)APITOKEN
: Su token de API, que se enviará en la cabecera deautorización
.
Uso
Configuración JSON para Claude, Cursor, etc.
{ "mcpServers": { "hostinger-api": { "command": "hostinger-api-mcp", "env": { "DEBUG": "false", "APITOKEN": "YOUR API TOKEN" } } }
Uso del transporte SSE
Para utilizar el servidor MCP con transporte SSE, debe ejecutar el servidor con la opción --sse
. Esto permitirá que el servidor se comunique con los clientes utilizando Server-Sent Events en el puerto 8100 de localhost. Además, puede especificar las opciones --host
y --port
para establecer el host y el puerto en los que escuchará el servidor.
Ejemplo de ejecución del servidor con transporte SSE:
hostinger-api-mcp --sse --host 127.0.0.1 --port 8100
Utilización como proveedor de herramientas MCP
Este servidor implementa el Protocolo de Contexto de Modelo (MCP) y puede utilizarse con cualquier consumidor compatible con MCP, como el cliente Claude.js u otros consumidores MCP.
Ejemplo de conexión a este servidor desde un cliente Claude.js:
import { MCP } from "claude-js"; import { createStdio } from "claude-js/mcp"; // Crear transporte stdin/stdout const transport = createStdio({ command: "hostinger-api-mcp" }); // Conectarse al servidor MCP const mcp = new MCP({ transport }); await mcp.connect(); // Listar herramientas disponibles const { tools } = await mcp.listTools(); console.log("Herramientas disponibles:", herramientas); // Llamar a una herramienta const result = await mcp.callTool({ id: "TOOL-ID", arguments: { param1: "valor1" } }); console.log("Resultado herramienta:", resultado)
Herramientas disponibles
Este servidor MCP proporciona las siguientes herramientas:
billing_getCatalogItemListV1
Este endpoint recupera una lista de artículos de catálogo disponibles para pedido.
Los precios de los artículos del catálogo se muestran en céntimos (sin coma flotante), por ejemplo: el valor flotante 17,99
se muestra como el número entero 1799
.
- Método
GET
- Ruta:
/api/billing/v1/catalog
Parámetros:
categoría
: Filtra los elementos del catálogo por categoríaname
: Filtra los elementos del catálogo por nombre. Utilice*
para la búsqueda comodín, por ejemplo,.COM*
para encontrar el dominio .com
billing_createNewServiceOrderV1
Este endpoint crea una nueva orden de servicio.
DEPRECATED
Para comprar un dominio, utilice POST /api/domains/v1/portfolio
.
Para comprar un VPS, utilice POST /api/vps/v1/virtual-machines
.
Para realizar un pedido, debe proporcionar el ID del método de pago y la lista de precios de los artículos del punto final del catálogo junto con la cantidad. También se pueden proporcionar cupones durante la creación del pedido.
Los pedidos creados utilizando este punto final se configurarán para renovación automática.
Es posible que algunos pagos con tarjeta
de
crédito
necesiten una verificación adicional, por lo que se recomienda utilizar otros métodos de pago.
- Método
POST
- Ruta:
/api/facturación/v1/pedidos
Parámetros:
payment_method_id
: ID del método de pago (obligatorio)items
: parámetro items (obligatorio)cupones
: Códigos de los cupones de descuento
billing_setDefaultPaymentMethodV1
Este endpoint establece el método de pago por defecto para su cuenta.
- Método
POST
- Ruta:
/api/billing/v1/payment-methods/{paymentMethodId}
Parámetros:
paymentMethodId
: ID del método de pago (obligatorio)
billing_deletePaymentMethodV1
Este endpoint elimina un método de pago de su cuenta.
- Método
DELETE
- Ruta:
/api/billing/v1/payment-methods/{paymentMethodId}
Parámetros:
paymentMethodId
: ID del método de pago (obligatorio)
billing_getPaymentMethodListV1
Este endpoint recupera una lista de métodos de pago disponibles que pueden utilizarse para realizar nuevos pedidos.
Si desea añadir un nuevo método de pago, utilice hPanel.
- Método
GET
- Ruta:
/api/billing/v1/métodos-de-pago
billing_cancelSubscriptionV1
Este punto final cancela una suscripción y detiene cualquier facturación posterior.
- Método
DELETE
- Ruta
/api/billing/v1/subscriptions/{subscriptionId}
Parámetros:
subscriptionId
: ID de suscripción (obligatorio)
billing_getSubscriptionListV1
Este punto final recupera una lista de todas las suscripciones asociadas a su cuenta.
- Método
GET
- Ruta
/api/billing/v1/subscriptions
DNS_getSnapshotV1
Este punto final recupera una instantánea DNS concreta con el contenido de los registros de zona DNS.
- Método
GET
- Ruta
/api/dns/v1/snapshots/{domain}/{snapshotId}
Parámetros:
dominio
: Nombre de dominio (obligatorio)snapshotId
: ID de instantánea (obligatorio)
DNS_getSnapshotListV1
Este endpoint recupera la lista de instantáneas DNS.
- Método
GET
- Ruta:
/api/dns/v1/snapshots/{dominio}
Parámetros:
dominio
: Nombre de dominio (obligatorio)
DNS_restoreSnapshotV1
Este endpoint restaura la zona DNS a la instantánea seleccionada.
- Método
POST
- Ruta:
/api/dns/v1/snapshots/{domain}/{snapshotId}/restore
Parámetros:
dominio
: Nombre de dominio (obligatorio)snapshotId
: ID de instantánea (obligatorio)
DNS_getRecordsV1
Este punto final recupera los registros de zona DNS para un dominio específico.
- Método
GET
- Ruta:
/api/dns/v1/zonas/{dominio}
Parámetros:
dominio
: Nombre de dominio (obligatorio)
DNS_updateZoneRecordsV1
Este endpoint actualiza los registros DNS del dominio seleccionado.
Si se utiliza overwrite = true
, se sustituirán los registros existentes por los proporcionados. En caso contrario, se actualizarán los registros existentes y se añadirán otros nuevos.
- Método
PUT
- Ruta de acceso:
/api/dns/v1/zonas/{dominio}
Parámetros:
dominio
: Nombre de dominio (obligatorio)sobrescribir
: Sies verdadero
, los registros de recursos (RR) que coincidan con el nombre y el tipo se eliminarán y se crearán nuevos RR; de lo contrario, se actualizarán los ttl de los registros de recursos y se añadirán nuevos registros. Si no se encuentran RR coincidentes, se crean.zone
: parámetro de zona (obligatorio)
DNS_deleteZoneRecordsV1
Este punto final elimina registros DNS para el dominio seleccionado. Para filtrar qué registros eliminar, añada el nombre
del registro y el tipo
al filtro. Se pueden proporcionar varios filtros con una única solicitud.
Si tiene varios registros con el mismo nombre y tipo y desea eliminar sólo una parte de ellos, consulte el punto final Actualizar registros de zona
.
- Método
DELETE
- Ruta
/api/dns/v1/zonas/{dominio}
Parámetros:
dominio
: Nombre de dominio (obligatorio)
DNS_resetZoneRecordsV1
Este endpoint restablece la zona DNS a los registros por defecto.
- Método: POST
POST
- Ruta:
/api/dns/v1/zonas/{dominio}/reset
Parámetros:
dominio
: Nombre de dominio (obligatorio)sync
: Determina si la operación debe ejecutarse de forma sincrónicareset_email_records
: Determina si se deben restablecer los registros de correo electrónicowhitelisted_record_types
: Especifica qué tipos de registros no se deben restablecer
DNS_validateZoneRecordsV1
Este endpoint se utiliza para validar los registros DNS antes de actualizarlos para el dominio seleccionado.
Si la validación se realiza correctamente, la respuesta contendrá el código 200 Success
. Si se produce un error de validación, la respuesta fallará con el código 422 Validation error
.
- Método
POST
- Ruta:
/api/dns/v1/zonas/{dominio}/validate
Parámetros:
dominio
: Nombre de dominio (obligatorio)sobrescribir
: Sies verdadero
, los registros de recursos (RR) que coincidan con el nombre y el tipo se eliminarán y se crearán nuevos RR; de lo contrario, se actualizarán los ttl de los registros de recursos y se añadirán nuevos registros. Si no se encuentran RR coincidentes, se crean.zone
: parámetro de zona (obligatorio)
domains_checkDomainAvailabilityV1
Este punto final comprueba la disponibilidad de un nombre de dominio. Se pueden comprobar varios TLD a la vez. Si desea obtener dominios alternativos con la respuesta, proporcione sólo un TLD en la solicitud y establezca with_alternatives
como true
. Los TLD deben proporcionarse sin el punto inicial (por ejemplo, com
, net
, org
).
El punto final tiene un límite de velocidad de 10 peticiones por minuto.
- Método
POST
- Ruta de acceso:
/api/dominios/v1/disponibilidad
Parámetros:
dominio
: Nombre de dominio (sin TLD) (obligatorio)tlds
: Lista de TLDs (obligatorio)with_alternatives
: La respuesta debe incluir alternativas
domains_getForwardingDataV1
Este punto final recupera datos de reenvío de dominios.
- Método
GET
- Ruta: /api/domains/v1/forwarding/{domain}
/api/dominios/v1/reenvío/{dominio}
Parámetros:
dominio
: Nombre de dominio (obligatorio)
domains_deleteForwardingDataV1
Este punto final elimina los datos de reenvío de dominios.
- Método: DELETE
DELETE
- Ruta:
/api/domains/v1/forwarding/{dominio}
Parámetros:
dominio
: Nombre de dominio (obligatorio)
domains_createForwardingDataV1
Este punto final crea datos de reenvío de dominios.
- Método: POST
POST
- Ruta
/api/dominios/v1/reenvío
Parámetros:
dominio
: Nombre de dominio (obligatorio)redirect_type
: Tipo de redirección (obligatorio)redirect_url
: URL a la que redirigir el dominio (obligatorio)
domains_enableDomainLockV1
Este endpoint habilita el bloqueo de dominio para el dominio. Cuando el bloqueo de dominio está activado, el dominio no puede transferirse a otro registrador sin desactivar antes el bloqueo.
- Método
PUT
- Ruta de acceso:
/api/dominios/v1/cartera/{dominio}/bloqueo-dominio
Parámetros:
dominio
: Nombre de dominio (obligatorio)
dominios_desactivarBloqueoDominioV1
Este punto final desactiva el bloqueo del dominio. El bloqueo de dominio debe desactivarse antes de transferir el dominio a otro registrador.
- Método: DELETE
DELETE
- Ruta de acceso:
/api/dominios/v1/cartera/{dominio}/bloqueo-dominio
Parámetros:
dominio
: Nombre de dominio (obligatorio)
dominios_obtenerDominioV1
Este punto final recupera los detalles del dominio especificado.
- Método
GET
- Ruta: /api/domains/v1/portfolio/{domain}
/api/dominios/v1/cartera/{dominio}
Parámetros:
dominio
: Nombre de dominio (obligatorio)
dominios_getListaDeDominiosV1
Este punto final recupera una lista de todos los dominios asociados a su cuenta.
- Método: GET
GET
- Ruta de acceso
/api/domains/v1/cartera
dominios_compraNuevoDominioV1
Este endpoint le permite comprar y registrar un nuevo nombre de dominio.
Si el registro falla, acceda a hPanel y compruebe el estado del registro del dominio.
Si no se proporciona ningún método de pago, se utilizará automáticamente su método de pago predeterminado.
Si no se proporciona información WHOIS, se utilizará la información de contacto predeterminada para ese TLD (dominio de nivel superior). Antes de realizar una solicitud, asegúrese de que la información WHOIS para el TLD deseado existe en su cuenta.
Algunos TLD requieren que se proporcionen detalles_adicionales
, que se validarán antes de completar la compra. Los detalles adicionales requeridos varían según el TLD.
- Método
POST
- Ruta
/api/dominios/v1/cartera
Parámetros:
dominio
: Nombre de dominio (obligatorio)item_id
: ID de artículo de precio de catálogo (obligatorio)payment_method_id
: ID del método de pago, se utilizará el predeterminado si no se proporcionadomain_contacts
: Información de contacto del dominioadditional_details
: Datos de registro adicionales, los valores posibles dependen del TLDcupones
: Códigos de cupones de descuento
domains_enablePrivacyProtectionV1
Este endpoint habilita la protección de privacidad para el dominio. Cuando la protección de privacidad está habilitada, la información personal del propietario del dominio se oculta de la base de datos pública WHOIS.
- Método
PUT
- Ruta
/api/domains/v1/portfolio/{domain}/privacy-protection
Parámetros:
dominio
: Nombre de dominio (obligatorio)
domains_disablePrivacyProtectionV1
Este endpoint desactiva la protección de privacidad para el dominio. Cuando la protección de privacidad está desactivada, la información personal del propietario del dominio es visible en la base de datos pública WHOIS.
- Método
DELETE
- Ruta de acceso:
/api/domains/v1/portfolio/{domain}/privacy-protection
Parámetros:
dominio
: Nombre de dominio (obligatorio)
domains_updateNameserversV1
Este punto final establece los servidores de nombres para un dominio especificado.
Tenga en cuenta que una configuración incorrecta de los servidores de nombres puede hacer que el dominio no se pueda resolver o no esté disponible.
- Método
PUT
- Ruta de acceso:
/api/dominios/v1/cartera/{dominio}/servidores de nombre
Parámetros:
dominio
: Nombre de dominio (obligatorio)ns1
: Primer servidor de nombres (obligatorio)ns2
: Segundo servidor de nombres (obligatorio)ns3
: Tercer servidor de nombresns4
: Cuarto servidor de nombres
domains_getWHOISProfileV1
Este endpoint recupera un perfil de contacto WHOIS.
- Método
GET
- Ruta:
/api/domains/v1/whois/{whoisId}
Parámetros:
whoisId
: ID de WHOIS (obligatorio)
domains_deleteWHOISProfileV1
Este endpoint elimina el perfil de contacto WHOIS.
- Método: DELETE
DELETE
- Ruta:
/api/domains/v1/whois/{whoisId}
Parámetros:
whoisId
: ID de WHOIS (obligatorio)
domains_getWHOISProfileListV1
Este endpoint recupera una lista de perfiles de contacto WHOIS.
- Método: GET
GET
- Ruta: /api/domains/v1/whois
/api/domains/v1/whois
Parámetros:
tld
: Filtrar por TLD (sin punto inicial)
domains_createWHOISProfileV1
Este endpoint crea el perfil de contacto WHOIS.
- Método: POST
POST
- Ruta
/api/dominios/v1/whois
Parámetros:
tld
: TLD del dominio (sin punto inicial) (obligatorio)país
: Código de país de 2 letras ISO 3166 (obligatorio)tipo_entidad
: Tipo de entidad jurídica (obligatorio)tld_details
: Detalles del TLDwhois_details
: Detalles de WHOIS (obligatorio)
domains_getWHOISProfileUsageV1
Este endpoint recupera una lista de dominios donde se utiliza el perfil de contacto WHOIS proporcionado.
- Método
GET
- Ruta
/api/domains/v1/whois/{whoisId}/usage
Parámetros:
whoisId
: ID de WHOIS (obligatorio)
VPS_getDataCentersListV1
Este endpoint recupera una lista de todos los centros de datos disponibles.
- Método: GET
GET
- Ruta: /api/vps/v1/data-centersList
/api/vps/v1/data-centers
VPS_activateFirewallV1
Este endpoint activa un firewall para una máquina virtual especificada.
Sólo puede haber un cortafuegos activo para una máquina virtual a la vez.
- Método
POST
- Ruta:
/api/vps/v1/firewall/{firewallId}/activate/{virtualMachineId}
Parámetros:
firewallId
: ID del cortafuegos (obligatorio)virtualMachineId
: ID de máquina virtual (obligatorio)
VPS_deactivateFirewallV1
Este endpoint desactiva un firewall para una máquina virtual especificada.
- Método
POST
- Ruta:
/api/vps/v1/firewall/{firewallId}/deactivate/{virtualMachineId}
Parámetros:
firewallId
: ID del cortafuegos (obligatorio)virtualMachineId
: ID de máquina virtual (obligatorio)
VPS_getFirewallV1
Este endpoint recupera el firewall por su ID y las reglas asociadas a él.
- Método
GET
- Ruta:
/api/vps/v1/firewall/{firewallId}
Parámetros:
firewallId
: ID del cortafuegos (obligatorio)
VPS_deleteFirewallV1
Este punto final elimina un cortafuegos especificado.
Cualquier máquina virtual que tenga activado este cortafuegos lo desactivará automáticamente.
- Método
BORRAR
- Ruta:
/api/vps/v1/firewall/{firewallId}
Parámetros:
firewallId
: ID del cortafuegos (obligatorio)
VPS_getFirewallListV1
Este endpoint recupera una lista de todos los cortafuegos disponibles.
- Método: GET
GET
- Ruta
/api/vps/v1/firewall
Parámetros:
página
: Número de página
VPS_createNewFirewallV1
Este endpoint crea un nuevo firewall.
- Método: POST
POST
- Ruta
/api/vps/v1/firewall
Parámetros:
name
: parámetro de nombre (obligatorio)
VPS_updateFirewallRuleV1
Este endpoint actualiza una regla de firewall específica de un firewall especificado.
Cualquier máquina virtual que tenga este cortafuegos activado perderá la sincronización con el cortafuegos y tendrá que sincronizarse de nuevo manualmente.
- Método
PUT
- Ruta:
/api/vps/v1/firewall/{firewallId}/rules/{ruleId}
Parámetros:
firewallId
: ID del cortafuegos (obligatorio)ruleId
: ID de regla del cortafuegos (obligatorio)protocol
: parámetro de protocolo (obligatorio)port (puerto
): Puerto o rango de puertos, ej: 1024:2048 (obligatorio)source
: parámetro source (obligatorio)source_detail
: Rango de IP, CIDR, IP única ocualquiera
(requerido)
VPS_deleteFirewallRuleV1
Este punto final elimina una regla de cortafuegos específica de un cortafuegos especificado.
Cualquier máquina virtual que tenga este cortafuegos activado perderá la sincronización con el cortafuegos y tendrá que sincronizarse de nuevo manualmente.
- Método
BORRAR
- Ruta:
/api/vps/v1/firewall/{firewallId}/rules/{ruleId}
Parámetros:
firewallId
: ID del cortafuegos (obligatorio)ruleId
: ID de regla de cortafuegos (obligatorio)
VPS_createFirewallRuleV1
Este endpoint crea una nueva regla de firewall de un firewall especificado. Por defecto, el firewall elimina todo el tráfico entrante, lo que significa que debe agregar reglas de aceptación para todos los puertos que desee utilizar.
Cualquier máquina virtual que tenga activado este cortafuegos perderá la sincronización con el cortafuegos y tendrá que sincronizarse de nuevo manualmente.
- Método:
POST
- Ruta:
/api/vps/v1/firewall/{firewallId}/rules
Parámetros:
firewallId
: ID del cortafuegos (obligatorio)protocol
: parámetro de protocolo (obligatorio)port (puerto
): Puerto o rango de puertos, ej: 1024:2048 (obligatorio)source
: parámetro source (obligatorio)source_detail
: Rango de IP, CIDR, IP única ocualquiera
(requerido)
VPS_syncFirewallV1
Este punto final sincroniza un cortafuegos para una máquina virtual especificada.
El cortafuegos puede perder la sincronización con la máquina virtual si se añaden, eliminan o actualizan nuevas reglas.
- Método
POST
- Ruta:
/api/vps/v1/firewall/{firewallId}/sync/{virtualMachineId}
Parámetros:
firewallId
: ID del cortafuegos (obligatorio)virtualMachineId
: ID de máquina virtual (obligatorio)
VPS_getPostInstallScriptV1
Este endpoint recupera el script de post-instalación por su ID.
- Método
GET
- Ruta:
/api/vps/v1/post-install-scripts/{postInstallScriptId}
Parámetros:
postInstallScriptId
: ID de script de postinstalación (obligatorio)
VPS_updatePostInstallScriptV1
Este punto final actualiza un script de postinstalación específico.
- Método: PUT
PUT
- Ruta: /api/vps/v1/post-install-scripts
/api/vps/v1/post-install-scripts/{postInstallScriptId}
Parámetros:
postInstallScriptId
: ID del script de postinstalación (obligatorio)name
: Nombre del script (obligatorio)content
: Contenido del script (obligatorio)
VPS_deleteAPostInstallScriptV1
Este endpoint elimina un script de post-instalación de su cuenta.
- Método: DELETE
DELETE
- Ruta
/api/vps/v1/post-install-scripts/{postInstallScriptId}
Parámetros:
postInstallScriptId
: ID de script de postinstalación (obligatorio)
VPS_getPostInstallScriptListV1
Este punto final recupera una lista de scripts de postinstalación asociados a su cuenta.
- Método: GET
GET
- Ruta: /api/vps/v1
/api/vps/v1/post-install-scripts
Parámetros:
page
: Número de página
VPS_createPostInstallScriptV1
Este endpoint le permite añadir un nuevo script post-install a su cuenta, que puede ser utilizado después de la instalación de una instancia de máquina virtual.
El contenido del script se guardará en el archivo /post_install
con el atributo ejecutable establecido y se ejecutará una vez instalada la máquina virtual. La salida del script se redirigirá a /post_install.log
. El tamaño máximo del script es de 48 KB.
- Método:
POST
- Ruta:
/api/vps/v1/post-install-scripts
Parámetros:
name
: Nombre del script (obligatorio)content
: Contenido del script (obligatorio)
VPS_attachPublicKeyV1
Este endpoint adjunta una clave pública existente de su cuenta a una máquina virtual especificada.
Se pueden adjuntar múltiples claves a una única máquina virtual.
- Método: POST
POST
- Ruta:
/api/vps/v1/public-keys/attach/{virtualMachineId}
Parámetros:
virtualMachineId
: ID de máquina virtual (obligatorio)ids
: IDs de clave pública a adjuntar (obligatorio)
VPS_deleteAPublicKeyV1
Este endpoint elimina una clave pública de su cuenta.
La eliminación de la clave pública de la cuenta no la elimina de la máquina virtual
- Método
BORRAR
- Ruta
/api/vps/v1/public-keys/{publicKeyId}
Parámetros:
publicKeyId
: ID de clave pública (obligatorio)
VPS_getPublicKeyListV1
Este endpoint recupera una lista de claves públicas asociadas a su cuenta.
- Método: GET
GET
- Ruta: /api/vps/v1/public-keys
/api/vps/v1/public-keys
Parámetros:
page
: Número de página
VPS_createNewPublicKeyV1
Este endpoint le permite añadir una nueva clave pública a su cuenta, que puede ser adjuntada a instancias de máquinas virtuales para un acceso seguro.
- Método: POST
POST
- Ruta
/api/vps/v1/public-keys
Parámetros:
name
: parámetro name (obligatorio)key
: parámetro key (obligatorio)
VPS_getTemplateV1
Este endpoint recupera detalles de una plantilla de SO específica para máquinas virtuales.
- Método:
GET
- Ruta:
/api/vps/v1/templates/{templateId}
Parámetros:
templateId
: ID de plantilla (obligatorio)
VPS_getTemplateListV1
Este endpoint recupera una lista de plantillas de SO disponibles para máquinas virtuales.
- Método: GET
GET
- Ruta: /api/vps/v1/templates
/api/vps/v1/templates
VPS_getActionV1
Este punto final recupera detalles de una acción específica realizada en una máquina virtual especificada.
Este punto final le permite ver información detallada sobre una acción en particular, incluyendo el nombre de la acción, la marca de tiempo y el estado.
- Método
GET
- Ruta:
/api/vps/v1/virtual-machines/{virtualMachineId}/actions/{actionId}
Parámetros:
virtualMachineId
: ID de la máquina virtual (obligatorio)actionId
: ID de acción (obligatorio)
VPS_getActionListV1
Este endpoint recupera una lista de acciones realizadas en una máquina virtual especificada.
Las acciones son operaciones o eventos que se han ejecutado en la máquina virtual, como iniciar, detener o modificar la máquina. Este punto final le permite ver el historial de estas acciones, proporcionando detalles sobre cada acción, como el nombre de la acción, la marca de tiempo y el estado.
- Método
GET
- Ruta:
/api/vps/v1/máquinasvirtuales/{virtualMachineId}/actions
Parámetros:
virtualMachineId
: ID de máquina virtual (obligatorio)page
: Número de página
VPS_getAttachedPublicKeysV1
Este endpoint recupera una lista de claves públicas adjuntas a una máquina virtual especificada.
- Método
GET
- Ruta
/api/vps/v1/máquinasvirtuales/{virtualMachineId}/public-keys
Parámetros:
virtualMachineId
: ID de máquina virtual (obligatorio)page
: Número de página
VPS_deleteBackupV1
Este endpoint elimina una copia de seguridad especificada para una máquina virtual.
- Método
DELETE
- Ruta:
/api/vps/v1/máquinasvirtuales/{virtualMachineId}/backups/{backupId}
Parámetros:
virtualMachineId
: ID de la máquina virtual (obligatorio)backupId
: ID de copia de seguridad (obligatorio)
VPS_getBackupListV1
Este endpoint recupera una lista de copias de seguridad para una máquina virtual especificada.
- Método
GET
- Ruta:
/api/vps/v1/máquinasvirtuales/{virtualMachineId}/backups
Parámetros:
virtualMachineId
: ID de máquina virtual (obligatorio)page
: Número de página
VPS_restoreBackupV1
Este endpoint restaura una copia de seguridad para una máquina virtual especificada.
El sistema iniciará el proceso de restauración, que puede tardar algún tiempo dependiendo del tamaño de la copia de seguridad.
Todos los datos de la máquina virtual se sobrescribirán con los datos de la copia de seguridad.
- Método:
POST
- Ruta:
/api/vps/v1/virtual-machines/{virtualMachineId}/backups/{backupId}/restore
Parámetros:
virtualMachineId
: ID de la máquina virtual (obligatorio)backupId
: ID de copia de seguridad (obligatorio)
VPS_setHostnameV1
Este endpoint establece el nombre de host para una máquina virtual especificada. Cambiar el nombre de host no actualiza el registro PTR automáticamente. Si quiere que su máquina virtual sea accesible por un nombre de host, necesita apuntar sus registros A/AAAA de dominio a la IP de la máquina virtual también.
- Método:
PUT
- Ruta:
/api/vps/v1/máquinasvirtuales/{virtualMachineId}/hostname
Parámetros:
virtualMachineId
: ID de máquina virtual (obligatorio)hostname
: parámetro hostname (obligatorio)
VPS_resetHostnameV1
Este punto final restablece el nombre de host y el registro PTR de una máquina virtual especificada al valor predeterminado.
- Método:
DELETE
- Ruta
/api/vps/v1/virtual-machines/{virtualMachineId}/hostname
Parámetros:
virtualMachineId
: ID de máquina virtual (obligatorio)
VPS_getVirtualMachineV1
Este punto final recupera información detallada sobre una máquina virtual especificada.
- Método
GET
- Ruta
/api/vps/v1/máquinasvirtuales/{virtualMachineId}
Parámetros:
virtualMachineId
: ID de máquina virtual (obligatorio)
VPS_getVirtualMachineListV1
Este endpoint recupera una lista de todas las máquinas virtuales disponibles.
- Método
GET
- Ruta
/api/vps/v1/máquinas-virtuales
VPS_compraNuevaMáquinaVirtualV1
Este endpoint le permite comprar y configurar una nueva máquina virtual.
Si la configuración de la máquina virtual falla por alguna razón, inicie sesión en hPanel y complete la configuración manualmente.
Si no se proporciona ningún método de pago, se utilizará automáticamente su método de pago predeterminado.
- Método de pago:
POST
- Ruta:
/api/vps/v1/máquinasvirtuales
Parámetros:
item_id
: ID de artículo de precio de catálogo (obligatorio)payment_method_id
: ID del método de pago, se utilizará el predeterminado si no se proporcionasetup
: parámetro de configuración (obligatorio)coupons
: Códigos de cupón de descuento
VPS_getScanMetricsV1
Este endpoint recupera las métricas de escaneo para el escáner de malware Monarx instalado en una máquina virtual especificada. Las métricas de escaneo proporcionan información detallada sobre los escaneos de malware realizados por Monarx, incluyendo el número de escaneos, amenazas detectadas y otras estadísticas relevantes. Esta información es útil para supervisar el estado de seguridad de la máquina virtual y evaluar la eficacia del escáner de malware.
- Método:
GET
- Ruta:
/api/vps/v1/virtual-machines/{virtualMachineId}/monarx
Parámetros:
virtualMachineId
: ID de máquina virtual (obligatorio)
VPS_installMonarxV1
Este endpoint instala el escáner de malware Monarx en una máquina virtual especificada.
Monarx es una herramienta de seguridad diseñada para detectar y prevenir infecciones de malware en máquinas virtuales. Instalando Monarx, los usuarios pueden mejorar la seguridad de sus máquinas virtuales, asegurando que están protegidas contra software malicioso.
- Método:
POST
- Ruta:
/api/vps/v1/máquinasvirtuales/{virtualMachineId}/monarx
Parámetros:
virtualMachineId
: ID de máquina virtual (obligatorio)
VPS_uninstallMonarxV1
Este endpoint desinstala el escáner de malware Monarx en una máquina virtual especificada. Si Monarx no está instalado, la solicitud se procesará igualmente sin ningún efecto.
- Método
DELETE
- Ruta:
/api/vps/v1/virtual-machines/{virtualMachineId}/monarx
Parámetros:
virtualMachineId
: ID de máquina virtual (obligatorio)
VPS_getMetricsV1
Este endpoint recupera las métricas históricas de una máquina virtual especificada. Incluye las siguientes métricas:
Uso de CPU
Uso de memoria
Uso de disco
Uso de red
Tiempo de actividad
Método
GET
Ruta:
/api/vps/v1/máquinasvirtuales/{virtualMachineId}/metrics
Parámetros:
virtualMachineId
: ID de máquina virtual (obligatorio)date_from
: parámetro date_from (obligatorio)date_to
: parámetro date_to (obligatorio)
VPS_setNameserversV1
Tenga en cuenta que una configuración incorrecta del servidor de nombres puede provocar que la máquina virtual no pueda resolver nombres de dominio.
- Método
PUT
- Ruta:
/api/vps/v1/virtual-machines/{virtualMachineId}/nameservers
Parámetros:
virtualMachineId
: ID de máquina virtual (obligatorio)ns1
: parámetro ns1 (obligatorio)ns2
: parámetro ns2
VPS_createPTRRecordV1
Este endpoint crea o actualiza un registro PTR (Pointer) para una máquina virtual especificada.
- Método
POST
- Ruta
/api/vps/v1/máquinasvirtuales/{virtualMachineId}/ptr
Parámetros:
virtualMachineId
: ID de máquina virtual (obligatorio)
VPS_deletePTRRecordV1
Este punto final elimina un registro PTR (puntero) para una máquina virtual especificada.
Una vez eliminado, las búsquedas DNS inversas de la dirección IP de la máquina virtual ya no devolverán el nombre de host configurado anteriormente.
- Método
BORRAR
- Ruta:
/api/vps/v1/virtual-machines/{virtualMachineId}/ptr
Parámetros:
virtualMachineId
: ID de máquina virtual (obligatorio)
VPS_setPanelContraseñaV1
Este endpoint establece la contraseña del panel para una máquina virtual especificada. Si la máquina virtual no utiliza el sistema operativo del panel, la solicitud se procesará igualmente sin ningún efecto. Los requisitos para la contraseña son los mismos que en el endpoint recrear máquina virtual.
- Método
PUT
- Ruta:
/api/vps/v1/virtual-machines/{virtualMachineId}/panel-password
Parámetros:
virtualMachineId
: ID de la máquina virtual (obligatorio)password
: Contraseña del panel para la máquina virtual (obligatorio)
VPS_startRecoveryModeV1
Este endpoint inicia el modo de recuperación para una máquina virtual especificada. El modo de recuperación es un estado especial que permite a los usuarios realizar operaciones de rescate del sistema, como reparar sistemas de archivos, recuperar datos o solucionar problemas que impiden a la máquina virtual arrancar normalmente.
La máquina virtual arrancará la imagen de disco de recuperación y la imagen de disco original se montará en el directorio /mnt
.
- Método:
POST
- Ruta:
/api/vps/v1/máquinasvirtuales/{virtualMachineId}/recovery
Parámetros:
virtualMachineId
: ID de máquina virtual (obligatorio)root_password
: Contraseña temporal de root para el modo de recuperación (obligatorio)
VPS_stopRecoveryModeV1
Este endpoint detiene el modo de recuperación para una máquina virtual especificada. Si la máquina virtual no está en modo de recuperación, esta operación fallará.
- Método
DELETE
- Ruta:
/api/vps/v1/virtual-machines/{virtualMachineId}/recovery
Parámetros:
virtualMachineId
: ID de máquina virtual (obligatorio)
VPS_recreateVirtualMachineV1
Este endpoint recreará una máquina virtual desde cero. El proceso de recreación implica la reinstalación del sistema operativo y el restablecimiento de la máquina virtual a su estado inicial. Se eliminarán las instantáneas, si las hubiera.
Requisitos de contraseña
La contraseña se cotejará con las bases de datos de contraseñas filtradas. Los requisitos para la contraseña son:
- Al menos 8 caracteres
- Al menos una letra mayúscula
- Al menos una letra minúscula
- Al menos un número
- Que no se haya filtrado públicamente
Esta operación es irreversible y provocará la pérdida de todos los datos almacenados en la máquina virtual
- Método
POST
- Ruta:
/api/vps/v1/virtual-machines/{virtualMachineId}/recreate
Parámetros:
virtualMachineId
: ID de la máquina virtual (obligatorio)template_id
: ID de plantilla (obligatorio)password
: Contraseña de la máquina virtual. Si no se proporciona, se generará una contraseña aleatoria. La contraseña no se mostrará en la respuesta.post_install_script_id
: ID del script de post-instalación
VPS_restartVirtualMachineV1
Este endpoint reinicia una máquina virtual especificada. Esto equivale a detener e iniciar completamente la máquina virtual. Si la máquina virtual estaba detenida, se iniciará.
- Método
POST
- Ruta:
/api/vps/v1/máquinasvirtuales/{virtualMachineId}/restart
Parámetros:
virtualMachineId
: ID de máquina virtual (obligatorio)
VPS_setRootPasswordV1
Este punto final establece la contraseña raíz para una máquina virtual especificada. Los requisitos para la contraseña son los mismos que en el punto final recrear máquina virtual.
- Método
PUT
- Ruta:
/api/vps/v1/virtual-machines/{virtualMachineId}/root-password
Parámetros:
virtualMachineId
: ID de la máquina virtual (obligatorio)password
: Contraseña raíz de la máquina virtual (obligatorio)
VPS_setupNewMachineVirtualV1
Este endpoint configurará la nueva máquina virtual adquirida con el estado inicial
.
- Método
POST
- Ruta
/api/vps/v1/máquinasvirtuales/{virtualMachineId}/setup
Parámetros:
virtualMachineId
: ID de máquina virtual (obligatorio)template_id
: ID de plantilla (obligatorio)data_center_id
: ID del centro de datos (obligatorio)post_install_script_id
: ID del script de postinstalaciónpassword
: Contraseña de la máquina virtual. Si no se proporciona, se generará una contraseña aleatoria. La contraseña no se mostrará en la respuesta.hostname
: Anula el nombre de host por defecto de la máquina virtualinstall_monarx
: Instala el escáner de malware Monarx (si es compatible)enable_backups
: Habilitar la programación semanal de copias de seguridadns1
: Servidor de nombres 1ns2
: Servidor de nombres 2public_key
: Usar clave SSH
VPS_getSnapshotV1
Este endpoint recupera una instantánea de una máquina virtual especificada.
- Método
GET
- Ruta:
/api/vps/v1/máquinasvirtuales/{virtualMachineId}/snapshot
Parámetros:
virtualMachineId
: ID de máquina virtual (obligatorio)
VPS_createSnapshotV1
Este punto final crea una instantánea de una máquina virtual especificada. Una instantánea captura el estado y los datos de la máquina virtual en un momento específico, lo que permite a los usuarios restaurar la máquina virtual a ese estado si es necesario. Esta operación es útil para realizar copias de seguridad, recuperar sistemas y probar cambios sin afectar al estado actual de la máquina virtual.
La creación de una nueva instantánea sobrescribirá la instantánea existente
- Método:
POST
- Ruta:
/api/vps/v1/máquinasvirtuales/{virtualMachineId}/snapshot
Parámetros:
virtualMachineId
: ID de máquina virtual (obligatorio)
VPS_deleteSnapshotV1
Este endpoint elimina una instantánea de una máquina virtual especificada.
- Método:
DELETE
- Ruta:
/api/vps/v1/máquinasvirtuales/{virtualMachineId}/snapshot
Parámetros:
virtualMachineId
: ID de máquina virtual (obligatorio)
VPS_restoreSnapshotV1
Este punto final restaura una máquina virtual especificada a un estado anterior utilizando una instantánea. La restauración desde una instantánea permite a los usuarios revertir la máquina virtual a ese estado, lo que resulta útil para la recuperación del sistema, deshacer cambios o realizar pruebas.
- Método
POST
- Ruta:
/api/vps/v1/máquinasvirtuales/{virtualMachineId}/snapshot/restore
Parámetros:
virtualMachineId
: ID de máquina virtual (obligatorio)
VPS_startVirtualMachineV1
Este endpoint inicia una máquina virtual especificada. Si la máquina virtual ya se está ejecutando, la solicitud se procesará igualmente sin ningún efecto.
- Método
POST
- Ruta:
/api/vps/v1/virtual-machines/{virtualMachineId}/start
Parámetros:
virtualMachineId
: ID de máquina virtual (obligatorio)
VPS_stopMáquinaVirtualV1
Este endpoint detiene una máquina virtual especificada. Si la máquina virtual ya está detenida, la solicitud se procesará igualmente sin ningún efecto.
- Método
POST
- Ruta:
/api/vps/v1/virtual-machines/{virtualMachineId}/stop
Parámetros:
virtualMachineId
: ID de máquina virtual (obligatorio)