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 → Create

AI-generated

Summary

Create a new backup for a selected server in the Pterodactyl Panel.

Inputs

Server (required) — Select the server to create backup for, chosen from the list of accessible client servers.
Backup Name — Optional custom name for the backup; if omitted, the backup name is auto-generated.
Ignored Files — Comma-separated list of file patterns to exclude from the backup, e.g., '.log,cache/'.
Lock Backup — Boolean flag to lock the backup to prevent accidental deletion.

Output shape

a single JSON object representing the newly created backup details as returned by the Pterodactyl API

The operation returns the backup object on success. Errors will be returned according to standard node error handling.

Discussion