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).

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"
      ]
    }
  }
}

Authorizations

Authorization · string · header · required

Management API authentication for /api/* endpoints. Use the Authorization header with Bearer <API key>. Virtual keys, dashboard/user/session tokens, and x-api-key headers are not supported on management APIs.

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"]
  }
}