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

Configuration & Notifications

22 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.

POST/api/config/db/delete

Db delete backup

curl --fail-with-body -sS -X POST "$ALPHIE_URL/api/config/db/delete" \
  -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/config/env

Get ui env

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

PUT/api/config/env

Put ui env

curl --fail-with-body -sS -X PUT "$ALPHIE_URL/api/config/env" \
  -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/config/env_public

Get ui env public

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

GET/api/config/files/{filename}

Serve an approved configuration file from api_call.

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

GET/api/config/network/vmware

Return vmware.json to an authenticated API client.

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

GET/api/config/notify-emails

List notification emails

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

POST/api/config/notify-emails

Create a notification email

curl --fail-with-body -sS -X POST "$ALPHIE_URL/api/config/notify-emails" \
  -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/config/notify-emails/public

List my group's notification emails

curl --fail-with-body -sS -X GET "$ALPHIE_URL/api/config/notify-emails/public" \
  -H "Authorization: Bearer $ALPHIE_TOKEN"

DELETE/api/config/notify-emails/{email_id}

Delete a notification email

curl --fail-with-body -sS -X DELETE "$ALPHIE_URL/api/config/notify-emails/${EMAIL_ID}" \
  -H "Authorization: Bearer $ALPHIE_TOKEN"

PUT/api/config/notify-emails/{email_id}

Update a notification email

curl --fail-with-body -sS -X PUT "$ALPHIE_URL/api/config/notify-emails/${EMAIL_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/config/notify-emails/{email_id}/test

Send a test email

curl --fail-with-body -sS -X POST "$ALPHIE_URL/api/config/notify-emails/${EMAIL_ID}/test" \
  -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/config/notify-rules

List notification rules

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

POST/api/config/notify-rules

Create a notification rule

curl --fail-with-body -sS -X POST "$ALPHIE_URL/api/config/notify-rules" \
  -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/config/notify-rules/{rule_id}

Delete a notification rule

curl --fail-with-body -sS -X DELETE "$ALPHIE_URL/api/config/notify-rules/${RULE_ID}" \
  -H "Authorization: Bearer $ALPHIE_TOKEN"

PUT/api/config/notify-rules/{rule_id}

Update a notification rule

curl --fail-with-body -sS -X PUT "$ALPHIE_URL/api/config/notify-rules/${RULE_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/config/notify-rules/{rule_id}/test

Send a test using rule recipients

curl --fail-with-body -sS -X POST "$ALPHIE_URL/api/config/notify-rules/${RULE_ID}/test" \
  -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/config/{kind}

Get config

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

PUT/api/config/{kind}

Put config

curl --fail-with-body -sS -X PUT "$ALPHIE_URL/api/config/${KIND}" \
  -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/config/{kind}/backups

List backups

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

POST/api/config/{kind}/delete

Delete config backup

curl --fail-with-body -sS -X POST "$ALPHIE_URL/api/config/${KIND}/delete" \
  -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/config/{kind}/restore

Restore config

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