Actions29
- Server Actions
- File Actions
- Database Actions
- Backup Actions
- Account Actions
Backup → Restore
AI-generatedSummary
Restore a backup to a specified Pterodactyl server, optionally deleting existing server files before restoration.
Inputs
- Authentication — Selects the type of API authentication to use: 'Client API' for user-level access or 'Application API' for admin-level access.
- Server Identifier (required) — The alphanumeric identifier of the server to restore the backup to, obtained from the server URL in the Pterodactyl Panel.
- Backup ID (required) — The UUID of the backup to restore.
- Truncate Files — Whether to delete existing server files before restoring the backup; defaults to false.
Output shape
a single JSON object representing the API response to the restore action
Returns the direct result from the Pterodactyl API backup restore endpoint; error details appear within the JSON if the operation fails.
Examples
Example 1: Restore backup with client API
Authentication: Client API, Server Identifier: 'abc12def', Backup ID: 'backup-uuid-1234', Truncate Files: false
Example 2: Restore backup with application API and truncate existing files
Authentication: Application API, Server Identifier: 'abc12def', Backup ID: 'backup-uuid-5678', Truncate Files: true