Ir a la documentación
DocumentaciónReferencia de la APIEjecutar una acción del servidor
POSTToken Bearer

Ejecutar una acción del servidor

/api/v1/servers/:id/actions

Inicia, apaga de forma segura (shutdown), corta la alimentación (stop), reinicia, restablece la contraseña, reinstala o termina un servicio de la organización.

Antes de llamar

La reinstalación borra los datos. Terminar el servicio no genera un reembolso ni cancela el contrato del proveedor. Las operaciones destructivas requieren confirm=true; terminate/reinstall mediante IA también requieren una prueba de billetera coincidente. 202 significa aceptado, no completado. Si el resultado es incierto, consulta taskKey.

Los nombres de campos, los tipos y el código de la API se mantienen iguales en todos los idiomas.

Ejemplo de petición

cURL
curl "https://tovahub.com/api/v1/servers/507f1f77bcf86cd799439012/actions" -X POST \
  -H "Authorization: Bearer $TOVAHUB_TOKEN" \
  -H "Content-Type: application/json" \
  --data '{
  "action": "restart",
  "requestKey": "docs_example_001"
}'

Solo ejemplos. Esta página no envía peticiones.

Respuesta ilustrativa
JSON
{
  "ok": true,
  "pending": true,
  "replay": false,
  "simulated": false,
  "error": null,
  "taskKey": "server:507f1f77bcf86cd799439012:restart:restart_001"
}

Parámetros

idRuta · Obligatorio

string

ID del recurso: 24 caracteres hexadecimales. Use el ID de la plataforma devuelto por el endpoint de listado correspondiente, no el ID de instancia del proveedor.

actionCuerpo JSON · Obligatorio

"start" | "shutdown" | "stop" | "restart" | "changepass" | "reinstall" | "terminate"

Operación que se ejecutará.

requestKeyCuerpo JSON · Obligatorio

string

Entre 8 y 100 caracteres: A–Z, a–z, 0–9, guion bajo o guion. Al reintentar la misma operación, conserve la clave y todos los datos de entrada.

confirmCuerpo JSON · Opcional

boolean

Confirmación explícita tras revisar los efectos. Obligatoria para stop (apagado forzado), terminate, reinstall, changepass y eliminar/restaurar instantáneas.

osCuerpo JSON · Opcional

string

Identificador del sistema operativo. Incluye debian12 y ubuntu24. La disponibilidad y la licencia se validan para el plan elegido. En las acciones del servidor y sus desafíos, solo reinstall acepta os.

proofCuerpo JSON · Opcional

object

Consentimiento de IA para terminate/reinstall: { challengeId: string (24 caracteres hexadecimales), signature: string (20–200 caracteres) }. Obtenga un desafío para los mismos action, requestKey y sistema operativo, y firme localmente su mensaje exacto.

Respuesta

Estado HTTP 200 / 202

Devuelve el comprobante de la acción enviada al servidor; consulte la tarea original si el resultado está pendiente o es incierto.

okboolean

Indica si la acción subyacente informó ok.

pendingboolean

El estado HTTP es 202 si es true; de lo contrario, 200.

replayboolean

Indica si se está devolviendo el resultado de la solicitud original.

simulatedboolean

Indica si la operación usó un comportamiento de prueba aislado.

errorunknown | null

Valor del error de la acción subyacente, o null; no se define un esquema de salida de ejecución más específico.

taskKeystring

Clave estable server:<platform-server-id>:<action>:<requestKey>.