Skip to documentation
DocumentationAPI referenceRecover a snapshot request
POSTBearer token

Recover a snapshot request

/api/v1/servers/:id/snapshots/recover

Recover the original member's snapshot request in the current organization. Finish only saved local acceptance and return the original task status.

Before you call

Use the original action and requestKey. No new request or supplier call is made. Local completion requires a succeeded record, a valid finishedAt, a saved response object and no supplier task ID. Missing records return 409; incomplete evidence is not upgraded to success. Inspect pending and taskStatus: state=succeeded alone does not prove supplier completion. Task GET remains read-only.

Request example

cURL
curl "https://tovahub.com/api/v1/servers/507f1f77bcf86cd799439012/snapshots/recover" -X POST \
  -H "Authorization: Bearer $TOVAHUB_TOKEN" \
  -H "Content-Type: application/json" \
  --data '{
  "action": "create",
  "requestKey": "<ORIGINAL_REQUEST_KEY>"
}'

Examples only. No requests are sent from this page.

Illustrative response
JSON
{
  "taskKey": "server:507f1f77bcf86cd799439012:snapshot_create:original_request_001",
  "action": "snapshot_create",
  "state": "succeeded",
  "pending": false,
  "localFinishPending": false,
  "taskId": null,
  "taskStatus": null,
  "error": null,
  "createdAt": "2026-11-07T12:00:00.000Z",
  "finishedAt": "2026-11-07T12:00:01.000Z",
  "actorUserId": "507f1f77bcf86cd799439013"
}

Parameters

idPath · Required

string

Resource ID: 24 hexadecimal characters. Use the platform ID returned by the matching list endpoint, not a supplier instance ID.

actionJSON body · Required

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

The original snapshot action. Use the same action as the existing snapshot_action request; this does not start a new action.

requestKeyJSON body · Required

string

The original snapshot_action requestKey, 8–100 characters: A–Z, a–z, 0–9, underscore or hyphen. Do not generate a new key for recovery.

Response

HTTP status 200 / 202

Return the original snapshot task after checking saved local completion. No supplier call or new request is made.

taskKeystring

Stable platform operation key.

actionstring

Recorded action name.

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

Local operation state, distinct from the provider task status.

pendingboolean

HTTP status is 202 when true, otherwise 200.

localFinishPendingboolean

True when a succeeded snapshot request has a saved response, a valid completion time, no supplier task ID and unfinished local acceptance. Use recover_snapshot with the original action and requestKey; task GET remains read-only.

taskIdstring | null

Supplier task identifier, when present.

taskStatusstring | null

Last observed supplier task status.

errorstring | null

Sanitized recorded error, if any.

createdAtstring (ISO 8601)

Local operation creation time.

finishedAtstring (ISO 8601) | null

Local completion time, if present.

actorUserIdstring (ObjectId) | null

Original actor account ID, or null for incomplete history. The current reader must be an active member of the same fixed team.