Settings

Reference for all tabs and fields on the Agent Gateway dashboard Settings page, including system settings, the Appliance ID, user preferences, admin operations, networking configuration, VP Audit event selection, and user management.

The Settings page is the central configuration area for the management dashboard. It is organised into seven tabs. Every signed-in user sees User and Limits. Administrators also see System, Admin, Networking, and Security. Users with the users.view permission also see Users. Use it to tune system performance windows, set the Appliance ID that integrations send, choose which audit events the VP Audit Log keeps, run backups, manage user accounts, check appliance resource usage, and set personal dashboard display preferences.

Access Settings from the dashboard sidebar under Settings.

Agent Gateway settings

System tab

Applies to the entire gateway instance. Requires administrator role. Changes take effect immediately when saved.

Fields

SettingTypeDefaultRangeDescription
Metrics Retention Periodinteger (minutes)3601–10,080How long in-memory metrics data is retained. 360 retains 6 hours. Maximum is 10,080 minutes (7 days). Data outside this window is not available in charts or the dashboard. Reducing this value truncates historical data on the next restart.
Task Activity Scopeinteger (seconds)6010–600Time window used to calculate task throughput. If no activity occurs within this window, throughput shows 0 B/s. Any new activity resets the window.
Temporary Channel Timeoutinteger (seconds)3010–300Lifetime of temporary surfaces created during the onboard-from-payload wizard. The surface is automatically deleted after this period.
Total Connections Windowinteger (minutes)601–1,440Sliding window used to count total connections on the dashboard and surface Monitoring tab.
Average Latency Windowinteger (minutes)601–1,440Sliding window used to calculate average latency on charts.
Appliance IDtextEmptyUp to 256 charactersUnder Integrations. An identifier for this appliance, for example its ID in your own monitoring or asset system. Integrations send it wherever a template uses the ${APPLIANCE_ID} variable, including the default webhook and stream payload. While the field is empty, the variable is sent empty. See Common variables.

Actions

ActionDescription
Save System SettingsApplies all current system field values immediately.
Reset to DefaultsReverts all system fields to their factory default values.

User tab

Personal preferences saved to your user account. These override system defaults for your dashboard session only. Other users are not affected.

Fields

SettingTypeDefaultOptions / RangeDescription
Badge Time Thresholdinteger (minutes)51–1,440Identities created or used within this window are shown with a NEW or ACTIVE badge on the Identities page.
Auto-Refresh Intervalinteger (seconds)51–300How often the dashboard polls for updated data. Lower values increase update frequency at the cost of higher bandwidth.
Log Timestamp Formatselectlocallocal, utc, relative, compactFormat for log entry timestamps. local: browser timezone. utc: ISO 8601. relative: for example, “2m ago”. compact: time portion only.
Time Series Bucket Intervalselect (seconds)3030, 60, 300, 900, 1800, 3600, 10800, 21600Default bucket size for the aggregated connections time series graph. Can be overridden on the dashboard per session.
Minimum Payment Items to Displayinteger101–100How many payment items the Payments page displays.

Actions

ActionDescription
Save My PreferencesSaves the current user preference values to your account.
Reset to System DefaultsReverts your personal preferences to the system-wide values set by the administrator.

Admin tab

System-level operations. Requires administrator role.

System actions

ActionDescription
Truncate Old Metrics NowImmediately deletes metrics data older than the current retention period, without a restart. Returns a count of records removed and retained.
Truncate Old LogsRemoves accumulated log data. The current active log is always kept.

Export storage

Produces a PII-redacted, encrypted snapshot of the storage directory.

Field / actionDescription
Ed25519 Public Key (PEM)Paste the Ed25519 public key to encrypt the export. The export uses hybrid encryption (X25519 ECDH + AES-256-GCM). Only the holder of the matching private key can decrypt it.
Export & DownloadGenerates and downloads the export as a .agx file. Sensitive directories (private keys, secrets, API keys, certificates, session tokens, credentials, avatars) are excluded entirely.

Backup and restore

Full backup includes all data, including private keys, secrets, and credentials: everything required to fully restore the service. Backup files are encrypted with AES-256-GCM.

ActionDescription
BackupDownloads an encrypted backup.agbak snapshot of all gateway data, including private keys, secrets, and credentials. Log data and system metrics are excluded; both are ephemeral and regenerate at runtime.
RestoreUnder Restore from Backup. Uploads a .agbak backup file, or a legacy .tgwbak backup file. The gateway automatically backs up the current data first, then restarts twice to complete the restore: once to begin replacing the data with the uploaded backup, and again once the restored data is in place and the gateway resumes normal operation.

Prometheus authentication

Prometheus scrape authentication is not configured from this tab. It’s set on the Metrics page, under the OpenTelemetry tab, not here.

Feature flags

FlagDefaultDescription
metricsOnShows the Metrics entry in the sidebar. Set to off to hide the sidebar entry; the /metrics routes remain reachable directly.
agent_pay_delegationOffReveals the Agent Pay (delegate payment) provider option in the Payment element of the surface builder. This only controls whether the option is offered when configuring a Payment element; surfaces already set up to delegate payment to a connected Agent-Pay gateway keep working and stay editable regardless of this setting.

Changes to feature flags take effect immediately.


Networking tab

Shows the gateway’s inbound mTLS (mutual TLS) and client authentication configuration. Requires administrator role. These settings are read-only; they reflect the platform’s network configuration and cannot be changed from the dashboard.

SettingDescription
Direct TLS client-cert requestWhether the gateway requests a client certificate during its own TLS handshake: Disabled, Optional (request, don't require), or Required (handshake fails without cert).
Trusted proxy CIDRsIP ranges allowed to present a forwarded client certificate header. When empty, the forwarded-cert path is disabled.
Forwarded client-cert headerName and format of the header read when the peer matches a trusted proxy CIDR. Format is either Envoy XFCC (x-forwarded-client-cert) or URL-encoded PEM (nginx ssl_client_escaped_cert).

Security tab

The VP Audit card controls what the VP Audit Log keeps: the governance records shown on the Audit page. Requires administrator role.

These settings apply to the VP Audit Log only. Each integration whose event set holds audit events receives them independently of what the VP Audit Log keeps. See Send audit events to an external system.

Fields

SettingTypeDefaultDescription
Enable VP AuditingtoggleOffWhen on, the VP Audit Log keeps a record of every event selected under Events to keep. When off, the log keeps nothing and the event selection is retained for later.
Events to keepcheckboxesNone selectedShown when Enable VP Auditing is on. Lists every audit event, grouped by area. Each group heading has its own checkbox that selects or clears every event in the group.

Audit events

Events to keep lists the following events, in this order. The same events appear under the Governance Audit groups of an event set on the Integrations page.

GroupEventRecorded when
PoliciesPolicy DecisionA gateway, surface, MCP-tool, or response OPA policy allowed or denied a request.
TrustTrust CheckA TRQP (Trust Registry Query Protocol) trust check returned an outcome for the caller or target leg.
TraceTrace TerminatedA surface terminated the end-to-end trace at its egress.
IdentityVP InjectedA signed identity Verifiable Presentation was injected into a proxied request or response.
Identity Binding FailedA request’s identity binding Verifiable Presentation was absent or failed verification.
Identity Binding VerifiedA request’s identity binding Verifiable Presentation was verified.
DelegationToken InjectedA delegated credential from the vault was injected on the caller’s behalf.
Token RefreshedAn expired delegated credential was refreshed and injected.
Refresh FailedA refresh of a delegated credential failed, so consent is required again.
Consent GrantedA user completed the OAuth consent flow and a delegation token was stored.
Consent RequiredThe caller was asked to grant consent before the request could proceed.
Token RevokedA delegation token was revoked.
User Tokens RevokedEvery delegation token for a user was revoked.
Token Not FoundA delegation token lookup found no match.
Elicitation SentAn MCP elicitation request was sent to the client.
Elicitation AcceptedThe client accepted an MCP elicitation.
Elicitation DeclinedThe client declined an MCP elicitation.
Elicitation CancelledThe client cancelled an MCP elicitation.
Elicitation Timed OutAn MCP elicitation reached its time limit before the client answered.
PaymentsPayment EventAn x402 or MPP payment lifecycle event occurred, such as a challenge, verification, or settlement.
AuthAuthentication FailedA caller’s JWT, API key, DID Auth session, mTLS certificate, or MCP resource token was rejected.
RequestsRate LimitedA request was refused because a surface rate limit, SSE session cap, or Fabric stream capacity was reached.
Request RejectedA request was refused at routing, admission, or forwarding before it reached the target.

Request events such as Authentication Failed, Rate Limited, and Request Rejected are recorded once for every request they apply to, so on a busy or heavily probed surface they can produce a large number of records.

Actions

ActionDescription
SaveApplies the Enable VP Auditing setting and the event selection to the running gateway immediately.

Limits tab

Visible to every signed-in user, with no permission requirement. Shows a read-only summary of the appliance-wide resource caps configured for this deployment, alongside how much of each is currently in use. Check it before provisioning a new secret, surface, policy, connection, integration, or proxy to see whether there is headroom left, or to understand why a create action was just blocked.

Fields

ColumnShows
LimitThe resource dimension’s name, with a short description underneath of what it counts.
UsageA progress bar showing current usage as a percentage of the cap. The bar turns amber at 80% of the cap and red once the cap is reached.
CurrentHow many of that resource exist right now.
LimitThe configured maximum for that resource.

The table reuses the heading Limit for two different columns: the leftmost names the resource, the rightmost gives its numeric cap.

Some resources are capped both individually and as a group. A deployment might, for example, cap the total number of proxies while also capping how many of those may be MCP proxies or A2A proxies specifically. Creating a new proxy is blocked once either the group total or the specific type’s own cap is reached, whichever comes first. Where a resource has this kind of grouping, the table lists the group total and each of its sub-types as separate rows. The dashboard shows only the plain-language name for each row, but a row can be matched back to your own limits.json by its dot-notation key, for example proxies for the total and proxies.mcp for the MCP-specific cap.

If no limits are configured for this deployment, the tab shows “No resource limits are configured. All entity types are currently uncapped.” instead of a table.

When a limit is reached

Creating a new secret, surface, policy, connection, integration, or proxy is blocked once its resource cap is reached, whether that is the specific type’s own cap or the group total it belongs to. The create button shows a small “Limit reached” popup naming the resource and its current usage, and suggesting an appliance tier upgrade. This behaviour applies wherever a create action exists across the dashboard, not only when you have the Limits tab open.


Users tab

Visible to administrators only. Lists all gateway users with their username, role, status, and last login time. Users self-register from the login page using a passkey and appear here with New status until an administrator approves them. Provides edit and delete operations for existing accounts.

Roles

Agent Gateway enforces role-based access control with three roles. Roles are hierarchical: each role includes all capabilities of the roles below it.

Administrator

Full access to all permissions.

  • System settings (view and edit)
  • User management (create, approve, edit, and delete all accounts)
  • Trust registry management
  • Surface configuration and deletion
  • API key and certificate management
  • Integration management (add, edit, test, and delete endpoints, event sets, and integrations) and gateway configuration reload
  • Agent identity issuance
  • Storage backup, restore, and export
  • Gateway management (edit and delete)
  • Secrets management (view, edit, and delete)
  • Trust authority management (edit and delete)
  • JWT Verification Strategies and STS Clients management
  • Policy management
  • Payment record edit and delete
  • Audit log access

Another Administrator can downgrade or delete an Administrator account, with one exception: the only remaining approved Administrator account is protected, and its role and status cannot be changed and it cannot be deleted by any user.

Power User

Inherits all User access, plus:

  • Mediator management (view, edit, and delete)
  • MCP proxy management (view, edit, and delete)
  • A2A proxy management (view, edit, and delete)
  • Notification and issuer management (edit and delete)
  • Payment viewing and retry
  • Surface payload capture

Power Users cannot access user management, system settings, trust registry or surface configuration, API keys, certificates, storage operations, or the audit log.

User

Read-only access to most shared gateway resources:

  • View gateways, trust registries, surfaces, integrations, notifications, issuers, trust authorities, metrics, the dashboard, and logs

Users cannot manage user accounts, modify system settings, edit trust registries or surfaces, manage API keys, or perform storage operations.

User status

StatusDescription
NewRegistered but not yet approved. The user cannot sign in until an administrator changes the status to Approved.
ApprovedActive account. The user can sign in.
DisabledSuspended account. The user cannot sign in. The account and its data are retained.

  • Observability: How the dashboard home screen uses metrics retention and bucket size to display traffic data.
  • Audit log: What the VP Audit Log keeps and how Governance Audit integrations receive audit events.
  • Integrations reference: Template variables, including ${APPLIANCE_ID}, and the Governance Audit delivery limits.