Calagopus icon

Calagopus

Interact with the Calagopus API

Actions343

Server Backups → Restore

AI-generated

Summary

Restore a specified backup to a server by sending a POST request to the Calagopus API. You can choose whether to empty the server directory first and whether to restore startup variables from the backup metadata.

Inputs

  • Server UUID (required) — The server UUID or identifier to restore the backup to.
  • Backup UUID (required) — The backup to restore.
  • Truncate Directory — Defaults to false. When enabled, requests that the server directory be emptied before restoring.
  • Restore Startup — Defaults to false. When enabled, requests that startup variables be restored from the backup metadata.
  • Query Parameters JSON — Optional query parameters as a JSON object; defaults to {}.
  • Body Mode — Choose JSON, Raw Text, or None. In JSON mode, the operation sends the two restore flags plus any fields from Body JSON; Body JSON fields override the generated flags if they use the same keys.
  • Body JSON — Optional JSON object merged into the restore request body when Body Mode is JSON; defaults to {}.
  • Raw Body — Plain text request body when Body Mode is Raw Text.
  • Additional Options — Can return the full response, return HTTP status errors instead of failing the item, or set a request timeout.

Output shape

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

Array responses are wrapped as {"data": [...]}, scalar responses as {"data": value}, and an empty response as {"success": true}. Return Full Response can include status and headers. With Continue On Fail enabled, an error is returned as {"error": "..."} for that item.

Examples

Example 1: Restore a backup without clearing the directory or restoring startup variables

Provide the server and backup UUIDs, leave Truncate Directory and Restore Startup disabled, and use JSON body mode.

Example 2: Restore a backup and clear the directory first

Enable Truncate Directory; enable Restore Startup as well if startup variables from the backup should be applied.

Links

Discussion