Pterodactyl Client icon

Pterodactyl Client

User-level server management with Pterodactyl Panel Client API

Schedule → Create Task

AI-generated

Summary

Create a new task within an existing schedule for a selected server in the Pterodactyl Panel. Specify the task's action type (command, power, or backup), provide required details depending on the action, and optionally delay the task execution by a time offset.

Inputs

  • Server (required) — Select the server containing the schedule where the task will be created.
  • Schedule (required) — Select the specific schedule to which the new task will be added.
  • Action (required) — Choose the type of task action to perform: send a console command, execute a power action, or create a backup.
  • Power Action (required) — If the action is 'Power', select the power action to execute (start, stop, restart, kill).
  • Command (required) — If the action is 'Command', enter the console command string to be executed.
  • Backup Name — If the action is 'Backup', optionally specify a custom backup filename; otherwise, the system generates one automatically.
  • Time Offset — Number of seconds to delay before executing this task; defaults to 0 for immediate execution.

Output shape

a single record

Returns the created task details as JSON. Contains task identifiers, action, payload, and scheduling information.

Examples

Example 1: To create a command task that sends a console command within a schedule, specify the server and schedule, set action to 'Command', provide the command string, and optionally set a time offset to delay execution.

Server ID, Schedule ID, Action: 'command', Command string, Time Offset (optional)

Discussion