Calagopus icon

Calagopus

Interact with the Calagopus API

Actions343

Admin Nodes → Restore Backup

AI-generated

Summary

Restore a backup for a specified node by sending a POST request to the Calagopus admin API. In JSON body mode, optionally set restore behavior and add or override request fields.

Inputs

  • Node UUID (required) — UUID of the node containing the backup.
  • Backup UUID (required) — UUID of the backup to restore.
  • Query Parameters JSON — Optional JSON object of query parameters.
  • Body Mode — Choose JSON, Raw Text, or None. JSON is the default; Raw Text sends plain text, and None omits the request body.
  • Truncate Directory — In JSON mode, defaults to false. Set true to request emptying the server directory before restoring.
  • Restore Startup — In JSON mode, defaults to false. Set true to request restoring startup variables from backup metadata.
  • Body JSON — Optional JSON object merged over the structured restore fields, so matching keys can override them.
  • Raw Body — Plain-text request body used when Body Mode is Raw Text.
  • Additional Options — Optionally return the full HTTP response, return HTTP status error responses instead of failing, or set a timeout in milliseconds.

Output shape

A single JSON item per input item, containing the API response body.

Null or undefined responses become {"success":true}; arrays are wrapped as {"data":[...]}, and primitive responses as {"data":...}. With Return Full Response enabled, the response may include status, headers, and body. If Continue On Fail is enabled, errors are returned in an item as {"error":"..."}. Ensure the selected node and backup are valid; the operation triggers a restore.

Links

Discussion