API Management Console

Turn 30 minutes of API disable/enable work into 5 seconds. One click. Instant effect. Full audit trail.

A Phoenix LiveView library that gives you real-time control over your backend routes. Discover every endpoint in your Phoenix app, then enable or disable them from a protected dashboard — no redeployment needed.

What It Does

• Route Discovery — Automatically pulls every route from your Phoenix router
• Grouped Management — Routes organized by controller name so you can toggle in bulk
• One-Click Toggles — Enable or disable individual routes or entire groups instantly via LiveView (page reload fallback for apps without LiveView JS)
• Route Guard Plug — Disabled routes return 403 at the Plug level, before they hit your controller
• Session-Based Login — Secure login page with admin/viewer role-based access control
• Account Management — Add/remove users, set roles (admin/viewer) directly from the dashboard
• Persistent State — Route policies, accounts, and audit logs stored via CubDB (crash-safe, ACID atomic toggles)
• Audit Log — Every toggle, hide, and account change logged with who/what/when — expandable with pagination and CSV download
• Dead Render Fallback — Full static HTML fallback for API-only apps without LiveView JS

Why It Matters

Quick Start

Prerequisites

Your Phoenix app must have LiveView's JavaScript client loaded. Every app created with mix phx.new ships with this in assets/js/app.js:

import { Socket } from "phoenix"
import { LiveSocket } from "phoenix_live_view"

let csrfToken = document.querySelector("meta[name='csrf-token']").getAttribute("content")
let liveSocket = new LiveSocket("/live", Socket, { params: { _csrf_token: csrfToken } })
liveSocket.connect()

Without LiveView JS (--no-assets or API-only apps): the console operates in dead-render mode using standard HTML forms and links. Every feature works: toggles, search, audit log expand, account management, compare plans modal, reset all. Features that require JavaScript (bulk checkboxes/select) are hidden in dead mode.

Install

# Add from Hex (recommended)
def deps do
  [
    {:api_management_console, "~> 0.1.0"}
  ]
end

# Or from GitHub
# {:api_management_console, github: "rizwan-khalid-1/api-management-console"}

# Install
$ mix deps.get

Mount the console in your router

# In your router — `use` injects route guard + auth pipelines automatically
use ApiManagementConsoleV2.Router

scope "/" do
  pipe_through [:browser, :route_guard]
  api_console "/admin/api-console"
end

That's it. The use macro automatically:

• Defines the :route_guard pipeline — blocks disabled routes with 403
• Defines the :api_console_auth pipeline — session-based login protection
• Registers the api_console/1 macro to mount dashboard routes under your chosen path

To enforce disabled routes, add :route_guard to every scope you want protected:

scope "/", SampleBlogWeb do
  pipe_through [:browser, :route_guard]
  get "/", PageController, :index
end

scope "/api", SampleBlogWeb do
  pipe_through [:api, :route_guard]
  get "/blogs", BlogController, :index
end

Or add the plug directly inside any pipeline:

pipeline :api do
  plug ApiManagementConsoleV2.Plugs.RouteGuard
end

Default login

The console uses session-based authentication. A default admin account is auto-created on first access:

• Username: admin
• Password: admin123

Override via env vars:

export API_CONSOLE_ADMIN_USERNAME=admin
export API_CONSOLE_ADMIN_PASSWORD=your_password

Configuration

All settings under a single config key:

config :api_management_console,
  # Protected routes — cannot be toggled (supports strings and regex)
  protected_routes: [
    "/dev/dashboard",
    ~r{HealthController},
    ~r{^/api/internal/}
  ],

  # Storage path (default: "api-console-data/")
  storage_dir: "/var/data/api_console",

  # Company branding (requires paid license — see Licensing below)
  app_name: "Acme Corp API Console",
  hide_powered_by: true,

  # Debug logging (default: false)
  debug: true,

  # License key — unlock paid features (offline JWT validation)
  license_key: "eyJhbGciOiJSUzI1NiIs..."

Or set the license key via environment variable:

export API_CONSOLE_LICENSE_KEY=eyJhbGciOiJSUzI1NiIs...

Manual route setup (no macro)

# Wire it up yourself instead of using `api_console`
scope "/admin/api-console" do
  pipe_through [:browser]

  # Login routes (unauthenticated)
  get "/login", ApiManagementConsoleV2Web.LoginController, :index
  post "/login", ApiManagementConsoleV2Web.LoginController, :create

  # Protected console routes
  pipe_through [:api_console_auth]
  get "/logout", ApiManagementConsoleV2Web.Plugs.Logout, []
  get "/audit.csv", ApiManagementConsoleV2Web.Plugs.AuditDownload, []
  live "/", ApiManagementConsoleV2Web.RouteConsoleLive, :index
end

Start your server:

$ mix phx.server
# Visit http://localhost:4000/admin/api-console

Features

Free Tier

Paid (PRO) Tier

Route Limit (Free Tier)

When your app has more than 50 managed routes on the free tier:

• Routes 1–47 render normally — fully interactive
• Routes 48–50 appear in a faded teaser container below the groups:
  • Dimmed, non-interactive, with a gradient blur overlay
  • Lock icon + "X routes hidden" + "Upgrade to PRO" button
• Routes 51+ are hidden entirely

The "Compare Plans" modal (button next to the tier badge) shows exactly what each tier includes, with the active plan highlighted in green.

Storage

How Licensing Works

Offline JWT validation — no phone-home, no external server dependency.

1. Receive your license key (signed JWT with embedded tier, expiry, trial claims)
2. Set API_CONSOLE_LICENSE_KEY env var or license_key in config
3. Paid features unlock automatically based on the license tier

No license key = Free tier. All paid features degrade gracefully — limits are enforced, upgrade prompts appear where applicable.

License keys are issued by the library maintainer. Contact the author to obtain a key for your organization.

Requirements

• Elixir ~> 1.13
• Phoenix ~> 1.6, ~> 1.7, or ~> 1.8
• Erlang/OTP

Dependencies

Screenshots

Main Dashboard (LiveView)

Main Dashboard (Static / Dead Render)

Routes with Bulk Selection

Audit Log & Account Management

Compare Plans Modal

Login Screen

Roadmap

See ROADMAP.md for completed features, planned work, and known issues.

License

MIT License — use, modify, distribute freely. Paid features are unlocked via a signed JWT license key, not a separate software license.

Community

• GitHub Issues — Bug reports & feature requests

Built with ❤️ in Elixir for the Phoenix ecosystem.