Reference

Field-level reference for Agent Gateway surfaces, gateways, trust registries, settings, and operations.

This section provides field-level reference material for every configurable component in the Agent Gateway. Each page covers exact field names, types, defaults, and accepted values.

For step-by-step configuration tasks, see How-to Guides. For conceptual explanations, see Concepts.

Surfaces

ReferenceWhat it covers
Surface referenceTop-level AgentSurface fields: name, status, tags, identity slots, and outbound credentials.
Access PointInbound configuration: listen address, route, protocol, caller authentication, policies, and rate limiting.
TargetUpstream destination: endpoint, authentication, OPA policies, networking, MCP tool policies, and identity injection.
Transit PointsAgent-initiated outbound routes: transit point fields, shared transit config, and credential injection.
VariantsNamed surface variations: alias grammar, override model, and default variant promotion.
Trust Check elementPer-leg TRQP verification element: fields, query parameters, template syntax, error codes, and TrustCheckResult wire shape.
OPA policy inputComplete input field reference for gateway, surface, and MCP tool policy scopes: field tables, source_auth variants, availability by evaluation path, and the McpPolicyContext schema.

Proxies

ReferenceWhat it covers
MCP ProxyMCP Proxy fields, tool generation, sandbox, and how to target a proxy from a surface.

Authentication

ReferenceWhat it covers
SecretsSecret fields, types, and lifecycle operations (create, update, delete).
API keysAPI key fields, key states, and lifecycle operations (create, revoke, rotate, delete).
JWT Verification StrategiesStrategy fields, token validation sequence, and audience configuration.

Gateways

ReferenceWhat it covers
Gateway objectGateway fields, status, and Publishing tab settings.
Connection point objectConnection point fields and metadata.
MediatorMediator fields, status values, and metadata.

Trust registries

ReferenceWhat it covers
Trust registry objectTrust registry fields, verification modes, and mediator configuration.
Issuer objectIssuer fields, TR Registration Status values, and actions.

Observability

ReferenceWhat it covers
TasksSurface, connection point, and MCP proxy task fields. Auto-refresh behaviour and throughput display.
NotificationsNotification fields, statuses, and the difference between inbox notifications and integration deliveries.
MetricsConnectionMetric record fields emitted per request. Drives the built-in dashboard, surface monitoring, and OTLP metrics export.

Payments

ReferenceWhat it covers
PaymentsTransaction table columns, processing modes, status values, and actions in the Payments view.

Configuration

ReferenceWhat it covers
IntegrationsFields for email, Slack, webhook, and streaming platform integrations.
SettingsDashboard settings: system settings, user preferences, network and mTLS configuration, VP audit configuration, admin operations, and user management.
Echo serverDependency-free local HTTP echo server. Prints incoming requests to stdout and echoes them as JSON. Supports passive echo and active relay modes for Transit Point testing.