Create a Pterodactyl backup
ptero_create_backupTake an immediate server backup to create a rollback point before file changes or power operations. Waits for completion by default, returns size and status.
Instructions
Take a backup of the server right now. Safe. The natural thing to do BEFORE any file write, delete, or power kill — it gives you a rollback point.
By default (wait: true) this blocks until the panel reports the backup complete (polling for up to two minutes) and returns its final size and success state. Pass wait: false to return immediately with just the uuid if you do not want to block; check completion later with ptero_list_backups.
The panel enforces a per-server backup-count limit; creation fails with an actionable error when the server is full — the fix is ptero_delete_backup on an old one, not a retry.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| name | No | Backup name. Omit to let the panel assign a default name. | |
| wait | No | Wait for the backup to finish before returning (up to ~2 minutes). false returns immediately with just the uuid — check ptero_list_backups for completion. | |
| server | No | Server short identifier (e.g. 1a2b3c4d). Omit to use PTERODACTYL_DEFAULT_SERVER. Call ptero_list_servers to discover valid identifiers. | |
| dry_run | No | When true, validate and preview the change without performing it. Nothing is modified and no confirmation token is issued. Use this to reason about an operation before committing to it. | |
| ignored | No | Newline-separated list of glob patterns to exclude from the backup, e.g. "cache/**\n*.log". |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| name | No | ||
| uuid | No | ||
| bytes | No | ||
| reason | No | Why the call was refused. | |
| server | Yes | ||
| status | Yes | success = the change was made. refused = a guardrail blocked it (see reason/variable). dry_run = nothing changed; preview shows what would. needs_confirmation = nothing changed; SHOW the preview to the human and, only if they agree, call again with confirmation_token. | |
| message | No | ||
| preview | No | What would / did change. | |
| variable | No | Environment variable that caused the refusal. | |
| backup_id | No | UUID of the automatic pre-change backup, if one was taken. | |
| completed | No | True once the backup has finished (only when wait:true). | |
| waited_ms | No | Milliseconds spent polling for completion (only when wait:true). | |
| bytes_human | No | ||
| completed_at | No | ||
| expires_in_s | No | ||
| confirmed_via | No | ||
| is_successful | No | ||
| confirmation_token | No |