Schema

Task

• id string

  Opaque identifier

  Example: tsk_000002e1

• status string

  unknown would indicate a state the API cannot name

  one of: pending, succeeded, failed, unknown

• action string

  Type of task

  one of: server.start, server.stop, server.shutdown, server.reboot, server.reset, server.rebuild, server.enable_rescue, server.disable_rescue, server.reboot_rescue, snapshot.create, snapshot.delete, snapshot.rollback, backup.create, backup.restore, iso.mount, iso.unmount, firewall.sync, firewall.unblock_port_25 TaskAction

• vmid string
• description string
• created_at string (date-time)
• finished_at string (date-time)

  null while the task is running

{
  "id": "tsk_000002e1",
  "status": "pending",
  "action": "server.start",
  "vmid": "string",
  "description": "string",
  "created_at": "2026-01-15T10:30:00Z",
  "finished_at": "2026-01-15T10:30:00Z"
}