Web UI

The console at /ui manages endpoints, environments, tokens, users and settings, and displays the dashboard and application logs. It writes the same configuration files the gateway reads. The gateway API runs without it.

Access ​

environment:
  - PORTWAY_PUBLIC_ORIGINS=https://example.com
  - PORTWAY_SECURE_COOKIES=true

The console is enabled by default and accepts client addresses from loopback and allowedHosts in environments/network-access-policy.json. If allowedHosts has two or fewer entries, the IP addresses of the host are added. PORTWAY_WEBUI_ENABLED=false turns it off. PORTWAY_PUBLIC_ORIGINS (comma-separated) allows external origins. PORTWAY_SECURE_COOKIES restricts cookies to HTTPS. All Console settings: Application settings.

Accounts ​

Accounts are created under Users or from the shell. First account, roles, sessions and recovery: Console Accounts. OpenID Connect sign-in: Single sign-on.

Settings changes ​

Settings saved in the console are written to appsettings.overrides.json. Values in that file override appsettings.json. Environment variables override that file. A key set by an environment variable is read-only in the console and displays the variable name. A save applies all submitted keys or none, and the response states whether a restart is required.

The section Settings → Security → Deployment & Access sets trusted proxies, trusted proxy networks and public console origins. A change that would exclude the current request returns 400.

Every console change to environments, endpoints and MCP settings is recorded in the audit trail, and the previous file version is backed up. Both are listed under Settings → Security → Recent Configuration Changes, with restore.

Health ​

/ui/health reports /api requests. Console (/ui), documentation and /health requests are excluded. Data source: GET /ui/api/metrics/health.

The dashboard health tiles display the last 24 hours (success rate, failures, p95, request count) and link to /ui/health.

Figures ​

Filters ​

Each filter is an exact, case-insensitive match. Filters combine with AND and apply to the figures, the latency distribution and the breakdown.

Latency distribution ​

Request counts per latency bucket: ≤5, ≤10, ≤25, ≤50, ≤100, ≤250, ≤500 ms, ≤1, ≤2.5, ≤5, ≤10 s and >10 s. Bars up to the selected percentile (p50, p90, p95, p99) are highlighted; a solid line marks the percentile and a dashed line the mean.

Breakdown ​

One row per environment, endpoint, version and method, with requests, success rate, failures, p50, p95 and p99. Default order: failures, then p95, both descending. Maximum 500 rows. A column header sorts by that column; a row sets the four filters to its values.

Labels ​

Retention and clearing ​

Retention: 31 days in metrics.db; 31 days and at most 500,000 requests in memory, reloaded from metrics.db on start. Each instance keeps its own data. Purge (administrator role, DELETE /ui/api/metrics) deletes every request recorded before the purge from memory and metrics.db, which also resets the dashboard traffic, error and top endpoint cards. The purge is recorded in the audit trail. Clear filters resets the environment, endpoint, version and method filters.

Logs ​

Logs displays entries from the three newest log/portwayapi-*.log files, newest first. The level filter (INF, WRN, ERR, DBG) and page size (100, 200, 500, 1000) apply to all three files. File settings: Logging.

Users ​

Users lists console accounts. The table sorts by name, role, provider, status and last sign-in. The account menu displays the e-mail address of the signed-in account.

API ​

The console API under /ui/api uses the portway_auth session cookie and a CSRF header on writes: Console API.