API

Jobs

Jobs and their logs. Every hardware action runs as a job.

4 endpoints

Jobs of a server

#

GET/api/v1/servers/{id}/jobs

Path parameters

  • id integer> 0

Example

curl "https://panel.example.com/api/v1/servers/42/jobs" \
  -H "Authorization: Bearer $TRIXOS_TOKEN"

List jobs

#

GET/api/v1/jobs

Filter by status, type and serverId.

Query parameters

  • status stringone of queued, running, success, failed, cancelled
  • type stringone of power, bmc_command, reinstall, rescue, hardware_collect, hardware_discover, firmware_update, disk_wipe, password_reset, switch_port, outlet_power, agent_install
  • serverId integer
  • limit integer≥ 1, ≤ 500, default 100

Example

curl "https://panel.example.com/api/v1/jobs" \
  -H "Authorization: Bearer $TRIXOS_TOKEN"

Get a job with its log

#

GET/api/v1/jobs/{id}

afterLogId returns only newer log lines, for polling. Live updates: websocket /api/v1/ws/jobs/{id}.

Path parameters

  • id stringuuid, pattern ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$

Query parameters

  • afterLogId integerdefault 0

Example

curl "https://panel.example.com/api/v1/jobs/42" \
  -H "Authorization: Bearer $TRIXOS_TOKEN"

Cancel a job

#

POST/api/v1/jobs/{id}/cancel

Queued jobs end at once; running jobs stop at the next step boundary.

Path parameters

  • id stringuuid, pattern ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$

Example

curl -X POST "https://panel.example.com/api/v1/jobs/42/cancel" \
  -H "Authorization: Bearer $TRIXOS_TOKEN"