Admin Endpoints

--- title: "Admin API" description: "Built-in REST APIs behind Aurora's dashboard for usage, models, cache, and gateway health." icon: "server-cog" ---

Philosophy

Aurora ships with admin endpoints enabled by default. The goal is simple: you should be able to deploy Aurora and immediately have visibility into what's happening — no extra services, no separate monitoring stack, no configuration.

The admin layer is split into two independently controllable pieces:

1. Admin REST API (/admin/api/v1/*) — machine-readable JSON endpoints for usage data, model inventory, and gateway settings. Protected by AURORA_MASTER_KEY like all other API routes.
2. Admin Dashboard UI (/admin/dashboard) — a lightweight, embedded HTML dashboard that visualizes the same data. No external dependencies, no JavaScript frameworks to install — it's compiled into the binary.

Both are on by default because observability shouldn't be opt-in. If you don't need them, turn them off with a single environment variable.

Configuration

Or in YAML:

admin:
  endpoints_enabled: true
  ui_enabled: true

Authentication

The admin REST API endpoints (/admin/api/v1/*) are protected by the same AURORA_MASTER_KEY authentication as the main API routes. Include the key as a Bearer token:

curl -H "Authorization: Bearer $AURORA_MASTER_KEY" \
  http://your-aurora-host/admin/api/v1/usage/summary

The dashboard UI pages (/admin/dashboard) and static assets (/admin/static/*) skip authentication so the dashboard is accessible without configuring API keys in the browser.

REST API Endpoints

For a complete reference of all admin API endpoints — usage, models, keys, policies, and operational endpoints — see the Admin API Reference in the API tab. Enterprise-gated endpoints (budgets, identity, tenants) are included in the reference with their edition requirements noted.

The API tab reference includes request/response shapes for every endpoint, organized by category.

Admin Dashboard

The dashboard is a server-rendered HTML page embedded in the Aurora binary. Access it at:

http://your-aurora-host/admin/dashboard

It provides a visual overview of usage statistics and registered models using the same data as the REST API endpoints above.

Disabling Admin Features

To disable all admin features:

export ADMIN_ENDPOINTS_ENABLED=false

This disables both the REST API and the dashboard UI. To keep the API but hide the dashboard:

export ADMIN_ENDPOINTS_ENABLED=true
export ADMIN_UI_ENABLED=false