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

Runbooks

8 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/runbooks/

List all runbooks

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

POST/api/runbooks/

Create a new runbook

curl --fail-with-body -sS -X POST "$ALPHIE_URL/api/runbooks/" \
  -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/runbooks/{id}

Delete a runbook

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

GET/api/runbooks/{id}

Get a single runbook

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

PUT/api/runbooks/{id}

Update an existing runbook

curl --fail-with-body -sS -X PUT "$ALPHIE_URL/api/runbooks/${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.

GET/api/runbooks/{id}/inputs

Get interactive inputs for this runbook

curl --fail-with-body -sS -X GET "$ALPHIE_URL/api/runbooks/${ID}/inputs" \
  -H "Authorization: Bearer $ALPHIE_TOKEN"

GET/api/runbooks/{id}/inquire

Get runbook inquire alias

curl --fail-with-body -sS -X GET "$ALPHIE_URL/api/runbooks/${ID}/inquire" \
  -H "Authorization: Bearer $ALPHIE_TOKEN"

POST/api/runbooks/{id}/run

Launch this runbook

curl --fail-with-body -sS -X POST "$ALPHIE_URL/api/runbooks/${ID}/run" \
  -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.