ovahub
Ir a la documentación
DocumentaciónReferencia de la APIGestionar una instantánea
POSTToken Bearer

Gestionar una instantánea

/api/v1/servers/:id/snapshots/action

Crea, renombra, elimina o restaura una instantánea de un servidor de la organización. La respuesta describe la operación, no la instantánea.

Antes de llamar

Eliminar y restaurar requieren confirm=true. Restaurar reemplaza los datos del servidor. El mismo requestKey devuelve la operación original; consulta su taskKey en lugar de reintentar a ciegas.

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/snapshots/action" -X POST \
  -H "Authorization: Bearer $TOVAHUB_TOKEN" \
  -H "Content-Type: application/json" \
  --data '{
  "action": "create",
  "requestKey": "docs_example_001",
  "name": "before-update"
}'

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

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

"create" | "update" | "delete" | "restore"

Operación de instantánea.

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.

snapshotIdCuerpo JSON · Opcional

string

ID de instantánea del proveedor, entre 1 y 80 caracteres. Obligatorio para update, delete y restore.

nameCuerpo JSON · Opcional

string

Nombre de 1 a 30 caracteres tras quitar espacios iniciales y finales. Obligatorio para create y update.

descriptionCuerpo JSON · Opcional

string

Descripción de hasta 255 caracteres tras quitar espacios iniciales y finales.

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.

Respuesta

Estado HTTP 200 / 202

Devuelve el estado persistente de la tarea tras crear, actualizar, eliminar o restaurar una instantánea.

taskKeystring

Clave estable de la operación en la plataforma.

actionstring

Nombre de la acción registrada.

statestring ('started' | 'succeeded' | 'failed')

Estado de la operación en la plataforma, distinto del estado de la tarea del proveedor.

pendingboolean

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

localFinishPendingboolean

Es true si la solicitud de instantánea está en succeeded, tiene una respuesta guardada y una fecha de finalización válida, no tiene ID de tarea del proveedor y falta completar el cierre local de la aceptación. Usa recover_snapshot con los valores originales de action y requestKey; el GET de la tarea sigue siendo de solo lectura.

taskIdstring | null

Identificador de la tarea del proveedor, si existe.

taskStatusstring | null

Último estado observado de la tarea del proveedor.

errorstring | null

Error registrado sin datos sensibles, si existe.

createdAtstring (ISO 8601)

Fecha y hora de creación de la operación en la plataforma.

finishedAtstring (ISO 8601) | null

Fecha y hora de finalización en la plataforma, si existen.

Relacionado

Peticiones y erroresAutenticaciónMCP · snapshot_action