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

Targets, Hosts & Lookups

21 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/admin/hosts

List hosts

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

POST/api/admin/hosts

Create host

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

Delete host

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

GET/api/admin/hosts/{host_id}

Get host

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

PUT/api/admin/hosts/{host_id}

Update host

curl --fail-with-body -sS -X PUT "$ALPHIE_URL/api/admin/hosts/${HOST_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/admin/me

Get me

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

DELETE/api/admin/sets/{set_id}

Delete host set

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

PUT/api/admin/sets/{set_id}

Update host set

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

POST/api/admin/sets/{set_id}/hosts

Set host membership

curl --fail-with-body -sS -X POST "$ALPHIE_URL/api/admin/sets/${SET_ID}/hosts" \
  -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/admin/targets

List targets

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

POST/api/admin/targets

Create target

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

Delete target

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

GET/api/admin/targets/{target_id}

Get target

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

PUT/api/admin/targets/{target_id}

Update target

curl --fail-with-body -sS -X PUT "$ALPHIE_URL/api/admin/targets/${TARGET_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/admin/targets/{target_id}/sets

List host sets

curl --fail-with-body -sS -X GET "$ALPHIE_URL/api/admin/targets/${TARGET_ID}/sets" \
  -H "Authorization: Bearer $ALPHIE_TOKEN"

POST/api/admin/targets/{target_id}/sets

Create host set

curl --fail-with-body -sS -X POST "$ALPHIE_URL/api/admin/targets/${TARGET_ID}/sets" \
  -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/lookups/access_packages

List access packages

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

GET/api/lookups/automation_sets

List automation sets

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

GET/api/lookups/playbooks

List .yml playbooks in a directory

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

GET/api/lookups/runtime_realms

List runtime realms

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

GET/api/lookups/target_hosts

List target hosts

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