Actions343
- Admin Activity Actions
- Admin Announcements Actions
- Admin Assets Actions
- Admin Backup Configurations Actions
- Admin Database Hosts Actions
- Admin Egg Configurations Actions
- Admin Egg Repositories Actions
- Admin Extensions Actions
- Admin Locations Actions
- Admin Mounts Actions
- Admin Nests Actions
- Create
- Create Egg
- Create Egg Mount
- Create Egg Variable
- Delete
- Delete Egg
- Delete Egg Mount
- Delete Egg Variable
- Delete Eggs
- Duplicate Egg
- Export Egg
- Get
- Get All Eggs
- Get Egg
- Get Egg Mounts
- Get Egg Servers
- Get Egg Variables
- Get Eggs
- Get Many
- Import Egg
- Move Egg
- Move Eggs
- Update
- Update Egg
- Update Egg From Import
- Update Egg From Repository
- Update Egg Variable
- Update Egg Variable Order
- Update Eggs From Repository
- Admin Nodes Actions
- Create
- Create Allocations
- Create Mount Link
- Delete
- Delete Allocations
- Delete Backup
- Delete Mount Link
- Detach Backup
- Download Backup
- Duplicate
- Get
- Get Allocations
- Get Available Allocations
- Get Backup
- Get Backups
- Get Capacity
- Get Config
- Get Many
- Get Mounts
- Get Server Resources
- Get Servers
- Get System Log
- Get System Logs
- Get System Overview
- Get System Stats
- Get Token
- Get Transferring Servers
- Reattach Backup
- Reset Token
- Restore Backup
- Send Servers Power Action
- Transfer Servers
- Update
- Update Allocations
- Update Config
- Update Default Config
- Admin OAuth Providers Actions
- Admin Roles Actions
- Admin Servers Actions
- Admin Settings Actions
- Admin Stats Actions
- Admin System Actions
- Admin Users Actions
- Client Account Actions
- Create API Key
- Create Command Snippet
- Create Security Key
- Create SSH Key
- Delete API Key
- Delete Avatar
- Delete Command Snippet
- Delete OAuth Link
- Delete Security Key
- Delete Session
- Delete SSH Key
- Disable Two-Factor
- Get
- Get Activity
- Get API Keys
- Get Command Snippets
- Get OAuth Link
- Get OAuth Links
- Get Permissions
- Get Security Keys
- Get Sessions
- Get SSH Keys
- Get Two-Factor
- Import SSH Key
- Logout
- Recreate API Key
- Security Key Challenge
- Update
- Update API Key
- Update Avatar
- Update Command Snippet
- Update Email
- Update Password
- Update Security Key
- Update SSH Key
- Client Server Actions
- Custom Request Actions
- Server Allocations Actions
- Server Announcements Actions
- Server Backups Actions
- Server Databases Actions
- Server Files Actions
- Server Mounts Actions
- Server Schedules Actions
- Server Settings Actions
- Server Startup Actions
- Server Subusers Actions
- System Actions
Server Backups → Restore
AI-generatedSummary
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.