Get agent

Read a registration with secret values redacted.

GET /api/agents/{name}

Error

A valid request URL is required to generate request examples

200

{
  "name": "<string>",
  "agent_card_url": "<string>",
  "enabled": true,
  "allow_by_default": true,
  "forward_accepted_credential": true,
  "forward_accepted_credential_overrides_auth": true,
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "discovery_auth": {
    "type": "none",
    "headers": {},
    "oauth": {
      "client_id": "<string>",
      "client_secret": "<string>",
      "provider_url": "<string>",
      "discovery_url": "<string>",
      "token_url": "<string>",
      "scopes": [
        "<string>"
      ],
      "resource": "<string>"
    },
    "security_schemes": [
      "<string>"
    ],
    "advanced": true,
    "tls": {
      "insecure_skip_verify": true,
      "ca_cert_pem": "<string>",
      "client_cert_pem": "<string>",
      "client_key_pem": "<string>"
    }
  },
  "runtime_auth": {
    "type": "none",
    "headers": {},
    "oauth": {
      "client_id": "<string>",
      "client_secret": "<string>",
      "provider_url": "<string>",
      "discovery_url": "<string>",
      "token_url": "<string>",
      "scopes": [
        "<string>"
      ],
      "resource": "<string>"
    },
    "security_schemes": [
      "<string>"
    ],
    "advanced": true,
    "tls": {
      "insecure_skip_verify": true,
      "ca_cert_pem": "<string>",
      "client_cert_pem": "<string>",
      "client_key_pem": "<string>"
    }
  },
  "extension_uris": [
    "<string>"
  ],
  "virtual_key_ids": [
    "<string>"
  ]
}

Required Permissions

Permission	Granted via
AgentGateway:View	RBAC role or API key scope

How permissions work

Authorizations

ManagementBearerAuthBasicAuth

Authorization · string · header · required

Management API authentication for /api/* endpoints. Use the Authorization header with Bearer <token>, where <token> is one of:

• a Bifrost management API key,
• a dashboard session token issued by POST /api/session/login,
• base64 of <admin-username>:<admin-password> (legacy equivalent of BasicAuth).

Virtual keys (sk-bf-*) and the x-api-key header are not accepted on management APIs - the sole exception is GET /api/governance/virtual-keys/quota, which is virtual-key-only.

Authentication alone is not sufficient in Bifrost Enterprise: each operation page shows a Required Permissions table (Resource:Operation, for example Dashboard:View) above its Authorizations section, and the caller's RBAC role or management API key scopes must include what it lists, otherwise the request is rejected with 403 Forbidden.

A local admin — authenticated with the admin password, or any caller on a deployment with dashboard auth disabled — bypasses these checks and can call every management endpoint.

OSS setup lock. On Bifrost OSS, while dashboard auth is not active (no admin account, or auth disabled), every management endpoint except the public ones (/health, /api/version, /api/session/is-auth-enabled, /api/session/login, ...) requires the operator's setup token in the X-Bifrost-Setup-Token header, in place of Authorization. The token is set with setup_token in config.json or the BIFROST_SETUP_TOKEN environment variable. A missing header returns 401, a wrong token 403. The header stops working once dashboard auth is enabled. The dashboard instead trades the token once for an HttpOnly bifrost_setup_session cookie via POST /api/session/setup. See Required permissions for how permissions are derived and which endpoints are exempt.

Path Parameters

name · string · required

Response

200

application/json

Success

Persisted registration with upstream secret values redacted.

name · string · required

Maximum string length: 255

Pattern: ^[a-z0-9]+(?:-[a-z0-9]+)*$

agent_card_url · string · required

Absolute HTTP(S) Agent Card URL without URL user information.

enabled · boolean · required

allow_by_default · boolean · required

Allow any valid virtual key to access this agent without an explicit grant.

forward_accepted_credential · boolean · required

Forward the credential accepted by Bifrost to the upstream agent.

forward_accepted_credential_overrides_auth · boolean · required

Allow the forwarded credential to override configured upstream authentication.

created_at · string<date-time> · required

updated_at · string<date-time> · required

discovery_auth · object

Shared upstream authentication. Header auth requires nonempty headers. OAuth uses client credentials and requires client_id, client_secret, and a token, discovery, or provider URL. Interactive OAuth is not supported.

Show child attributes

runtime_auth · object

Shared upstream authentication. Header auth requires nonempty headers. OAuth uses client credentials and requires client_id, client_secret, and a token, discovery, or provider URL. Interactive OAuth is not supported.

Show child attributes

extension_uris · string[]

A2A extension URIs enabled for upstream requests.

virtual_key_ids · string[]

Virtual key IDs granted access to the agent. Empty and duplicate IDs are rejected.