Update a plugin

Updates a plugin’s configuration. Will reload or stop the plugin based on enabled status. The response actualName field shows the plugin name from GetName() (used as the map key), which may differ from the display name (name). Setting path on a non-builtin plugin loads native code (a .so, via dlopen) into the gateway process and requires genuine admin authentication - it is refused with 403 if dashboard authentication is disabled or unconfigured, even though other management endpoints remain reachable in that state. Only http/https URLs are fetched for remote paths, and by default only ones resolving to a public address; private, loopback, link-local, and CGNAT addresses are additionally allowed if explicitly listed in the deploy-time server.plugin_download_private_allowlist config. Local filesystem paths are unaffected.

PUT /api/plugins/{name}

Error

A valid request URL is required to generate request examples

200

{
  "message": "<string>",
  "plugin": {
    "name": "my_custom_plugin",
    "actualName": "MyCustomPlugin",
    "enabled": true,
    "config": {
      "api_key": "xxx"
    },
    "isCustom": true,
    "path": "/plugins/my_custom_plugin.so",
    "status": {
      "name": "my_custom_plugin",
      "status": "active",
      "logs": [
        "plugin my_custom_plugin initialized successfully"
      ],
      "types": [
        "llm",
        "http"
      ]
    }
  }
}

Required Permissions

Permission	Granted via
Plugins:Update	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

Plugin display name (the config field name, not the internal actualName from GetName())

Body

application/json

Update plugin request

enabled · boolean

config · object

path · string

Response

200

application/json

Plugin updated successfully

Plugin operation response

message · string

plugin · object

Plugin configuration

Show child attributes

Example:

{
  "name": "my_custom_plugin",
  "actualName": "MyCustomPlugin",
  "enabled": true,
  "config": { "api_key": "xxx" },
  "isCustom": true,
  "path": "/plugins/my_custom_plugin.so",
  "status": {
    "name": "my_custom_plugin",
    "status": "active",
    "logs": [
      "plugin my_custom_plugin initialized successfully"
    ],
    "types": ["llm", "http"]
  }
}