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

Schedules

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/schedules/

List schedules

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

POST/api/schedules/

Create schedule

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

Create or update an automation schedule row

curl --fail-with-body -sS -X POST "$ALPHIE_URL/api/schedules/automation" \
  -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/schedules/tick-all

Scan for due schedules and fire them

curl --fail-with-body -sS -X POST "$ALPHIE_URL/api/schedules/tick-all" \
  -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/schedules/{sid:int}

Delete schedule

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

PUT/api/schedules/{sid:int}

Update schedule

curl --fail-with-body -sS -X PUT "$ALPHIE_URL/api/schedules/${SID}" \
  -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/schedules/{sid:int}/approve

Approve schedule

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

GET/api/schedules/{sid:int}/deny

Deny schedule

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

GET/api/schedules/{sid:int}/due-debug

Debug due

curl --fail-with-body -sS -X GET "$ALPHIE_URL/api/schedules/${SID}/due-debug" \
  -H "Authorization: Bearer $ALPHIE_TOKEN"

POST/api/schedules/{sid:int}/enabled

Enable/disable schedule

curl --fail-with-body -sS -X POST "$ALPHIE_URL/api/schedules/${SID}/enabled" \
  -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/schedules/{sid:int}/force-tick

Minimal "ticker" for one schedule: if due by simple rules, fire it now.

curl --fail-with-body -sS -X POST "$ALPHIE_URL/api/schedules/${SID}/force-tick" \
  -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/schedules/{sid:int}/run-now

Trigger immediately

curl --fail-with-body -sS -X POST "$ALPHIE_URL/api/schedules/${SID}/run-now" \
  -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/schedules/{sid:int}/send-approval

Send approval email for next run (manual)

curl --fail-with-body -sS -X POST "$ALPHIE_URL/api/schedules/${SID}/send-approval" \
  -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.