API REFERENCE
Overview & AuthenticationUsers & GroupsRunbooksJob RunsPipelinesSchedulesApprovals & Self-ServiceRunners & Runner GroupsAutomation SetsAccess Types, Packages & ListsTargets, Hosts & LookupsConfiguration & NotificationsRuntime Images & RealmsBackup, Health & Time

Job Runs

9 endpoints discovered from this archive’s backend.

Set these variables first
export ALPHIE_URL="https://YOUR-ALPHIE-HOST"
export ALPHIE_TOKEN="PASTE_YOUR_API_TOKEN_HERE"
# Requires a certificate trusted by your machine. For test-only self-signed certificates,
# use curl --cacert /path/to/alphie.crt (preferred) rather than disabling TLS verification.

Most authenticated endpoints accept Authorization: Bearer $ALPHIE_TOKEN. Endpoints can still require administrator permissions or particular roles. API tokens must be provisioned through an authorized Alphie account; don't put secrets in playbooks, logs, or browser-side forms.

GET/api/runs

List runs alias

curl --fail-with-body -sS -X GET "$ALPHIE_URL/api/runs" \
  -H "Authorization: Bearer $ALPHIE_TOKEN"

GET/api/runs/

List recent job runs

curl --fail-with-body -sS -X GET "$ALPHIE_URL/api/runs/" \
  -H "Authorization: Bearer $ALPHIE_TOKEN"

POST/api/runs/runbooks/{runbook_id}

Launch runbook

curl --fail-with-body -sS -X POST "$ALPHIE_URL/api/runs/runbooks/${RUNBOOK_ID}" \
  -H "Authorization: Bearer $ALPHIE_TOKEN" \n  -H "Content-Type: application/json" \n  --data-binary @request.json

Body example: supply a request.json file matching this endpoint’s request model. Consult $ALPHIE_URL/openapi.json for required fields.

DELETE/api/runs/{run_id}

Delete run

curl --fail-with-body -sS -X DELETE "$ALPHIE_URL/api/runs/${RUN_ID}" \
  -H "Authorization: Bearer $ALPHIE_TOKEN"

POST/api/runs/{run_id}/cancel

Cancel a running job run

curl --fail-with-body -sS -X POST "$ALPHIE_URL/api/runs/${RUN_ID}/cancel" \
  -H "Authorization: Bearer $ALPHIE_TOKEN" \n  -H "Content-Type: application/json" \n  --data-binary @request.json

Body example: supply a request.json file matching this endpoint’s request model. Consult $ALPHIE_URL/openapi.json for required fields.

GET/api/runs/{run_id}/file-log

Fetch live log file

curl --fail-with-body -sS -X GET "$ALPHIE_URL/api/runs/${RUN_ID}/file-log" \
  -H "Authorization: Bearer $ALPHIE_TOKEN"

GET/api/runs/{run_id}/file-log/tail

Tail the log by byte offset

curl --fail-with-body -sS -X GET "$ALPHIE_URL/api/runs/${RUN_ID}/file-log/tail" \
  -H "Authorization: Bearer $ALPHIE_TOKEN"

GET/api/runs/{run_id}/settings

Runbook settings for this run

curl --fail-with-body -sS -X GET "$ALPHIE_URL/api/runs/${RUN_ID}/settings" \
  -H "Authorization: Bearer $ALPHIE_TOKEN"

GET/api/runs/{run_id}/status

Lightweight status for external polling

curl --fail-with-body -sS -X GET "$ALPHIE_URL/api/runs/${RUN_ID}/status" \
  -H "Authorization: Bearer $ALPHIE_TOKEN"