Engine admin API explorer
This explorer lists the engine admin API routes, grouped by area, with the method, path, a short summary and the area tag of each. It does not show request or response shapes. It is a snapshot, so it does not follow changes to the engine you are running, and the engine emits and signs no specification of its own, so you cannot verify a running engine from this page.
downpipes engine admin API
Version r179.63403a4ff406
This specification lists the engine admin API routes: the path, method, summary, operation id and tag of each. It does not describe request or response shapes. It is a snapshot of one engine version, so it does not follow changes to the engine you are running. The engine does not emit or sign a specification of its own, so you cannot verify a running engine from this specification.
Base URLs
https://console.example.com/adminYour console's custom domain, suffixed with /admin. The console proxies these routes to the in-account engine over a service binding; the engine has no public host of its own.
attest
Endpoints under /attest.
/attest/session/abortSubmit attest session abort
post-attest-session-abort
/attest/session/capsulesSubmit attest session capsules
post-attest-session-capsules
/attest/session/createSubmit attest session create
post-attest-session-create
/attest/session/proveSubmit attest session prove
post-attest-session-prove
/attest/session/statusRead attest session status
get-attest-session-status
/attest/session/verifySubmit attest session verify
post-attest-session-verify
audit
Endpoints under /audit.
/auditRead audit
get-audit
/audit/exportRead audit export
get-audit-export
/audit/intentSubmit audit intent
post-audit-intent
/audit/verifyRead audit verify
get-audit-verify
canary
Endpoints under /canary.
/canaryRead canary
get-canary
/canary/configSubmit canary config
post-canary-config
/canary/runSubmit canary run
post-canary-run
config
Endpoints under /config.
/config/approval-policyRead config approval policy
get-config-approval-policy
/config/approval-policySubmit config approval policy
post-config-approval-policy
/config/attended-cadenceRead config attended cadence
get-config-attended-cadence
/config/attended-cadenceSubmit config attended cadence
post-config-attended-cadence
/config/change-number-policySubmit config change number policy
post-config-change-number-policy
/config/changesRead config changes
get-config-changes
/config/changes/{id}/approveSubmit config changes by id approve
post-config-changes-id-approve
/config/changes/{id}/rejectSubmit config changes by id reject
post-config-changes-id-reject
/config/diffRead config diff
get-config-diff
/config/egress-allowlistRead config egress allowlist
get-config-egress-allowlist
/config/egress-allowlistSubmit config egress allowlist
post-config-egress-allowlist
/config/historyRead config history
get-config-history
/config/restore-approval-policySubmit config restore approval policy
post-config-restore-approval-policy
/config/signin-context-policySubmit config signin context policy
post-config-signin-context-policy
/config/snapshotSubmit config snapshot
post-config-snapshot
/config/update-approval-policySubmit config update approval policy
post-config-update-approval-policy
/config/versionRead config version
get-config-version
control-plane
Endpoints under /control-plane.
/control-plane/apply-stagedSubmit control plane apply staged
post-control-plane-apply-staged
/control-plane/export-downloadRead control plane export download
get-control-plane-export-download
/control-plane/importSubmit control plane import
post-control-plane-import
/control-plane/import-sealedSubmit control plane import sealed
post-control-plane-import-sealed
/control-plane/restoreSubmit control plane restore
post-control-plane-restore
/control-plane/restore-sealedSubmit control plane restore sealed
post-control-plane-restore-sealed
/control-plane/statusRead control plane status
get-control-plane-status
cost
Endpoints under /cost.
/cost/estate-sizeRead cost estate size
get-cost-estate-size
coverage
Endpoints under /coverage.
/coverageRead coverage
get-coverage
/coverage/inventorySubmit coverage inventory
post-coverage-inventory
custody
Endpoints under /custody.
/custody/send-shareSubmit custody send share
post-custody-send-share
custom-roles
Endpoints under /custom-roles.
/custom-rolesRead custom roles
get-custom-roles
/custom-rolesSubmit custom roles
post-custom-roles
/custom-roles/deleteSubmit custom roles delete
post-custom-roles-delete
demo
Endpoints under /demo.
/demo/resetSubmit demo reset
post-demo-reset
destination
Endpoints under /destination.
/destinationRead destination
get-destination
/destinationSubmit destination
post-destination
/destination/verifySubmit destination verify
post-destination-verify
destinations
Endpoints under /destinations.
/destinationsRead destinations
get-destinations
/destinationsSubmit destinations
post-destinations
/destinations/defaultSubmit destinations default
post-destinations-default
/destinations/removeSubmit destinations remove
post-destinations-remove
downpipes
Endpoints under /downpipes.
/downpipesRead downpipes
get-downpipes
/downpipesSubmit downpipes
post-downpipes
/downpipes/bulkSubmit downpipes bulk
post-downpipes-bulk
/downpipes/cf-config/modeSubmit downpipes cf config mode
post-downpipes-cf-config-mode
/downpipes/cf-config/rediscoverSubmit downpipes cf config rediscover
post-downpipes-cf-config-rediscover
/downpipes/deleteSubmit downpipes delete
post-downpipes-delete
/downpipes/reconcile-rosterSubmit downpipes reconcile roster
post-downpipes-reconcile-roster
/downpipes/roster-hygieneRead downpipes roster hygiene
get-downpipes-roster-hygiene
drill
Endpoints under /drill.
/drillSubmit drill
post-drill
drill-all
Endpoints under /drill-all.
/drill-allRead drill all
get-drill-all
/drill-allSubmit drill all
post-drill-all
drill-evidence
Endpoints under /drill-evidence.
/drill-evidenceRead drill evidence
get-drill-evidence
/drill-evidenceSubmit drill evidence
post-drill-evidence
Endpoints under /email.
/email/testSubmit email test
post-email-test
expiry
Endpoints under /expiry.
/expiryRead expiry
get-expiry
/expirySubmit expiry
post-expiry
/expiry/cleanup-attestSubmit expiry cleanup attest
post-expiry-cleanup-attest
/expiry/deleteSubmit expiry delete
post-expiry-delete
group-roles
Endpoints under /group-roles.
/group-rolesRead group roles
get-group-roles
/group-rolesSubmit group roles
post-group-roles
/group-roles/deleteSubmit group roles delete
post-group-roles-delete
history
Endpoints under /history.
/historyRead history
get-history
idp
Endpoints under /idp.
/idp/connectionsRead idp connections
get-idp-connections
/idp/connectionsSubmit idp connections
post-idp-connections
/idp/connections/certSubmit idp connections cert
post-idp-connections-cert
/idp/connections/deleteSubmit idp connections delete
post-idp-connections-delete
/idp/connections/enabledSubmit idp connections enabled
post-idp-connections-enabled
/idp/presetsRead idp presets
get-idp-presets
/idp/testSubmit idp test
post-idp-test
/idp/test-savedSubmit idp test saved
post-idp-test-saved
keys
Endpoints under /keys.
/keys/add-config-recoverySubmit keys add config recovery
post-keys-add-config-recovery
/keys/add-operationalSubmit keys add operational
post-keys-add-operational
/keys/break-glass-onlySubmit keys break glass only
post-keys-break-glass-only
/keys/installSubmit keys install
post-keys-install
/keys/posture-acknowledgementSubmit keys posture acknowledgement
post-keys-posture-acknowledgement
/keys/rotateSubmit keys rotate
post-keys-rotate
/keys/vintagesRead keys vintages
get-keys-vintages
licence
Endpoints under /licence.
/licenceRead licence
get-licence
/licenceSubmit licence
post-licence
notify
Endpoints under /notify.
/notify/channelsRead notify channels
get-notify-channels
/notify/channelsSubmit notify channels
post-notify-channels
/notify/channels/deleteSubmit notify channels delete
post-notify-channels-delete
/notify/historyRead notify history
get-notify-history
/notify/rulesRead notify rules
get-notify-rules
/notify/rulesSubmit notify rules
post-notify-rules
/notify/rules/deleteSubmit notify rules delete
post-notify-rules-delete
/notify/testSubmit notify test
post-notify-test
otlp-push
Endpoints under /otlp-push.
/otlp-pushRead otlp push
get-otlp-push
/otlp-pushSubmit otlp push
post-otlp-push
/otlp-push/deleteSubmit otlp push delete
post-otlp-push-delete
owner-actions
Endpoints under /owner-actions.
/owner-actionsRead owner actions
get-owner-actions
/owner-actions/{id}/approveSubmit owner actions by id approve
post-owner-actions-id-approve
/owner-actions/{id}/rejectSubmit owner actions by id reject
post-owner-actions-id-reject
passkey
Endpoints under /passkey.
/passkey/credentialsRead passkey credentials
get-passkey-credentials
/passkey/credentials/allRead passkey credentials all
get-passkey-credentials-all
/passkey/credentials/deleteSubmit passkey credentials delete
post-passkey-credentials-delete
policy
Endpoints under /policy.
/policy/require-accessSubmit policy require access
post-policy-require-access
/policy/retire-break-glass-tokenSubmit policy retire break glass token
post-policy-retire-break-glass-token
posture
Endpoints under /posture.
/postureRead posture
get-posture
/posture/acceptSubmit posture accept
post-posture-accept
/posture/unacceptSubmit posture unaccept
post-posture-unaccept
preflight
Endpoints under /preflight.
/preflightRead preflight
get-preflight
push
Endpoints under /push.
/pushRead push
get-push
/pushSubmit push
post-push
/push/deleteSubmit push delete
post-push-delete
/push/testSubmit push test
post-push-test
replication
Endpoints under /replication.
/replicationRead replication
get-replication
reports
Endpoints under /reports.
/reports/{kind}Read reports by kind
get-reports-kind
restore
Endpoints under /restore.
/restoreSubmit restore
post-restore
/restore/approvalsRead restore approvals
get-restore-approvals
/restore/approveSubmit restore approve
post-restore-approve
/restore/attestSubmit restore attest
post-restore-attest
/restore/capsuleSubmit restore capsule
post-restore-capsule
/restore/rejectSubmit restore reject
post-restore-reject
/restore/requestSubmit restore request
post-restore-request
/restore/verifySubmit restore verify
post-restore-verify
retention-prune
Endpoints under /retention-prune.
/retention-prune/applySubmit retention prune apply
post-retention-prune-apply
/retention-prune/approvalsRead retention prune approvals
get-retention-prune-approvals
/retention-prune/approveSubmit retention prune approve
post-retention-prune-approve
/retention-prune/candidateSubmit retention prune candidate
post-retention-prune-candidate
/retention-prune/rejectSubmit retention prune reject
post-retention-prune-reject
/retention-prune/requestSubmit retention prune request
post-retention-prune-request
roles
Endpoints under /roles.
/rolesRead roles
get-roles
/rolesSubmit roles
post-roles
/roles/deleteSubmit roles delete
post-roles-delete
rto
Endpoints under /rto.
/rtoRead rto
get-rto
runs
Endpoints under /runs.
/runs/atRead runs at
get-runs-at
secrets
Endpoints under /secrets.
/secrets/rotatedSubmit secrets rotated
post-secrets-rotated
sessions
Endpoints under /sessions.
/sessionsRead sessions
get-sessions
/sessions/terminateSubmit sessions terminate
post-sessions-terminate
/sessions/terminate-allSubmit sessions terminate all
post-sessions-terminate-all
/sessions/terminate-othersSubmit sessions terminate others
post-sessions-terminate-others
/sessions/terminate-userSubmit sessions terminate user
post-sessions-terminate-user
setup
Endpoints under /setup.
/setup/acknowledgeSubmit setup acknowledge
post-setup-acknowledge
setup-state
Endpoints under /setup-state.
/setup-stateRead setup state
get-setup-state
signin-factors
Endpoints under /signin-factors.
/signin-factorsRead signin factors
get-signin-factors
/signin-factors/revokeSubmit signin factors revoke
post-signin-factors-revoke
sources
Endpoints under /sources.
/sources/attachSubmit sources attach
post-sources-attach
/sources/discoverRead sources discover
get-sources-discover
/sources/discovery-accountsSubmit sources discovery accounts
post-sources-discovery-accounts
/sources/discovery-statusRead sources discovery status
get-sources-discovery-status
/sources/discovery-tokenSubmit sources discovery token
post-sources-discovery-token
/sources/enableSubmit sources enable
post-sources-enable
/sources/reattach-missingSubmit sources reattach missing
post-sources-reattach-missing
status
Endpoints under /status.
/statusRead status
get-status
stepup
Endpoints under /stepup.
/stepup/beginSubmit stepup begin
post-stepup-begin
/stepup/finishSubmit stepup finish
post-stepup-finish
support
Endpoints under /support.
/supportRead support
get-support
/support/bundleRead support bundle
get-support-bundle
/support/bundleSubmit support bundle
post-support-bundle
/support/credentialsSubmit support credentials
post-support-credentials
/support/credentials/deleteSubmit support credentials delete
post-support-credentials-delete
test-fault
Endpoints under /test-fault.
/test-fault/armSubmit test fault arm
post-test-fault-arm
/test-fault/canary-tickSubmit test fault canary tick
post-test-fault-canary-tick
/test-fault/control-plane-clearSubmit test fault control plane clear
post-test-fault-control-plane-clear
/test-fault/disarmSubmit test fault disarm
post-test-fault-disarm
/test-fault/retention-tickSubmit test fault retention tick
post-test-fault-retention-tick
/test-fault/statusRead test fault status
get-test-fault-status
trigger
Endpoints under /trigger.
/triggerSubmit trigger
post-trigger
update
Endpoints under /update.
/update/applySubmit update apply
post-update-apply
/update/rampSubmit update ramp
post-update-ramp
/update/ramp/settleSubmit update ramp settle
post-update-ramp-settle
/update/rollbackSubmit update rollback
post-update-rollback
/update/settleSubmit update settle
post-update-settle
/update/statusRead update status
get-update-status
updates
Endpoints under /updates.
/updatesRead updates
get-updates
whoami
Endpoints under /whoami.
/whoamiRead whoami
get-whoami
Last updated .