Pterodactyl Client

User-level server management with Pterodactyl Panel Client API

Actions52

Account Actions
Backup Actions
Database Actions
File Actions
Network Actions
Schedule Actions
Server Actions
Startup Actions
- Get Variables
- Update Variable
Subuser Actions

Backup → Restore

AI-generated

Summary

Restore a server backup by specifying the server and backup to restore, with an option to delete existing files before restoration.

Inputs

serverId (required) — Select the server containing the backup to restore.
backupId (required) — Select the specific backup to restore on the selected server.
truncate — Optional boolean to determine whether to delete existing files on the server before restoring the backup.

Output shape

a JSON object representing the restored backup details or the API response confirming the backup restoration.

The operation returns the response data from the Pterodactyl API after attempting the restore. Errors will cause the node to fail unless 'Continue on Fail' is enabled, in which case they are output as error messages per item.

Discussion