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

Runtime Images & Realms

13 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/ansible_versions

Get ansible versions

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

GET/api/base_images

Get base images

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

POST/api/base_images

Add base image

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

Delete base image

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

PUT/api/base_images/{id}

Edit base image

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

List runtime realms

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

POST/api/runtime_realms

Create runtime realm

curl --fail-with-body -sS -X POST "$ALPHIE_URL/api/runtime_realms" \
  -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.

POST/api/runtime_realms/redistribute

Redistribute realms

curl --fail-with-body -sS -X POST "$ALPHIE_URL/api/runtime_realms/redistribute" \
  -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/runtime_realms/redistribute_results

Returns per-runner results for the latest (or matching) redistribution job.

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

DELETE/api/runtime_realms/{id:int}

Delete runtime realm

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

GET/api/runtime_realms/{id:int}

Get runtime realm

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

PUT/api/runtime_realms/{id:int}

Update runtime realm

curl --fail-with-body -sS -X PUT "$ALPHIE_URL/api/runtime_realms/${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/runtime_realms/{id:int}/build_status

Get realm build status

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