Actions29
- Server Actions
- File Actions
- Database Actions
- Backup Actions
- Account Actions
Backup → Create
AI-generatedSummary
Create a new backup for a specified server on your Pterodactyl Panel, optionally naming the backup, excluding specified files, and optionally locking it to prevent accidental deletion.
Inputs
- Authentication (required) — Select between user-level (Client API) or admin-level (Application API) API access for authentication.
- Server Identifier (required) — Provide the alphanumeric identifier of the server (found in the server URL) to back up.
- Backup Name — Optionally specify a name for the backup; if omitted, a name is auto-generated.
- Ignored Files — Comma-separated list of file patterns to exclude from the backup (e.g., .log,cache/).
- Lock Backup — Set to true to lock the backup and prevent it from being deleted unintentionally.
Output shape
a single JSON object representing the created backup's details
The operation returns the created backup details as a single JSON object. Errors will be thrown unless configured to continue on failure.
Examples
Example 1: Create a backup named 'daily-backup' excluding log files and lock it
Set Authentication to Client API, Server Identifier to target server ID, Backup Name to 'daily-backup', Ignored Files to '*.log', and Lock Backup to true.