console — API reference
console — API reference
Section titled “console — API reference”The contract is declared once, on the handlers of unidpp-console, and committed as its openapi.yaml; this page renders that document.
A running service serves the same contract at /openapi.json and /openapi.yaml, and browses it live at /docs (Swagger UI). The deployment consumes 3 environment variables (x-unidpp-env-keys).
console
Section titled “console”The session-gated operator surface
The dashboard: the deployment’s service cards and their readiness.
Responses
200— The page, rendered against the deployment manifest303— The session gate redirects an unauthenticated browser to/login
GET /.well-known/unidpp-service
Section titled “GET /.well-known/unidpp-service”The service identity (the orchestrator’s probe reads it).
Responses
200— The identity document: service, version, build id
GET /archival
Section titled “GET /archival”The archival journey: snapshots and their verification.
Responses
200— The page, rendered against the deployment manifest303— The session gate redirects an unauthenticated browser to/login
POST /archival
Section titled “POST /archival”Intake a snapshot.
Request body: The archival intake form: the snapshot reference
Responses
200— The form is re-rendered with its error stated303— Intake accepted: a redirect back to the journey
GET /backups
Section titled “GET /backups”The backups view: the bundle, its consistency point and the restore drills.
Responses
200— The page, rendered against the deployment manifest303— The session gate redirects an unauthenticated browser to/login
POST /backups
Section titled “POST /backups”Run a backup operation.
Request body: The backup form: the operation to run
Responses
200— The form is re-rendered with its error stated303— Run: a redirect back to the view with the result stated
POST /backups/drill
Section titled “POST /backups/drill”POST /backups/drill — run the restore rehearsal through the durability program (session-gated; the program owns the logic).
Request body: The drill form: the bundle to restore
Responses
200— The form is re-rendered with its error stated303— Drilled: a redirect back to the view with the drill report stated
GET /branding
Section titled “GET /branding”The branding preview: the manifest’s identity rendered as the console chrome.
Responses
200— The page, rendered against the deployment manifest303— The session gate redirects an unauthenticated browser to/login
POST /branding
Section titled “POST /branding”POST /branding — apply the form to the manifest’s branding block through the validated save path; nothing else in the manifest is touched (the model is loaded, mutated, re-serialized).
Request body: The branding form: product name and locale
Responses
200— The form is re-rendered with its error stated303— Saved: a redirect back to the preview
GET /carrier
Section titled “GET /carrier”The carrier journey: carrier generation and translation.
Responses
200— The page, rendered against the deployment manifest303— The session gate redirects an unauthenticated browser to/login
GET /config
Section titled “GET /config”The manifest editor: the deployment as data, secrets still ${VAR} references.
Responses
200— The page, rendered against the deployment manifest303— The session gate redirects an unauthenticated browser to/login
POST /config
Section titled “POST /config”Save the edited manifest.
Request body: The edited manifest text
Responses
200— The form is re-rendered with its error stated303— Saved: a redirect back to the editor
GET /config/env
Section titled “GET /config/env”The rendered environment of the deployment, resolved secrets sealed.
Responses
200— The page, rendered against the deployment manifest303— The session gate redirects an unauthenticated browser to/login
GET /coverage
Section titled “GET /coverage”The coverage view: the profile’s coverage report.
Responses
200— The page, rendered against the deployment manifest303— The session gate redirects an unauthenticated browser to/login
GET /declarations
Section titled “GET /declarations”The declarations journey: the signed declarations and their state.
Responses
200— The page, rendered against the deployment manifest303— The session gate redirects an unauthenticated browser to/login
GET /egress
Section titled “GET /egress”The egress inventory: what leaves the deployment, sealed and real rows alike.
Responses
200— The page, rendered against the deployment manifest303— The session gate redirects an unauthenticated browser to/login
GET /feedback
Section titled “GET /feedback”The consumer-reports view over the gateway’s report channel.
Responses
200— The page, rendered against the deployment manifest303— The session gate redirects an unauthenticated browser to/login
GET /healthz
Section titled “GET /healthz”Liveness probe.
Responses
200— The service is serving
GET /login
Section titled “GET /login”The login page.
Responses
200— The page, rendered against the deployment manifest303— The session gate redirects an unauthenticated browser to/login
POST /login
Section titled “POST /login”Submit the login form.
Request body: The login form: the admin token
Responses
200— The form is re-rendered with its error stated303— Authenticated: a redirect to the dashboard with the session issued
POST /logout
Section titled “POST /logout”End the session.
Responses
303— A redirect to the login page, the session ended
GET /passports
Section titled “GET /passports”The verification form and its most recent verdicts.
Responses
200— The page, rendered against the deployment manifest303— The session gate redirects an unauthenticated browser to/login
POST /passports
Section titled “POST /passports”POST /passports with a pack: verify through the pipeline.
Request body: The verification form: the pack reference and its anchors
Responses
200— The form is re-rendered with its error stated303— Verified: a redirect back to the form with the verdict stated
GET /profiles
Section titled “GET /profiles”The profiles journey: profile intake and the registry’s manifest schema.
Responses
200— The page, rendered against the deployment manifest303— The session gate redirects an unauthenticated browser to/login
POST /profiles
Section titled “POST /profiles”Intake a profile.
Request body: The profile intake form: the manifest and its signature
Responses
200— The form is re-rendered with its error stated303— Intake accepted: a redirect back to the journey
GET /registry
Section titled “GET /registry”The register browser over the registry service’s items.
Responses
200— The page, rendered against the deployment manifest303— The session gate redirects an unauthenticated browser to/login
GET /tenants
Section titled “GET /tenants”The tenants view: the whitelabel tenants of the deployment.
Responses
200— The page, rendered against the deployment manifest303— The session gate redirects an unauthenticated browser to/login
POST /tenants
Section titled “POST /tenants”Create a tenant.
Request body: The tenant form: the tenant’s manifest
Responses
200— The form is re-rendered with its error stated303— Created: a redirect back to the tenants view
GET /trust
Section titled “GET /trust”The trust view: operators, trust markers and validity windows.
Responses
200— The page, rendered against the deployment manifest303— The session gate redirects an unauthenticated browser to/login