GEgetbifrost
Plugins

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}

Request

Path parameters

namestring required

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

Request body

enabledboolean
configobject
pathstring

Response

Plugin updated successfully

messagestring

Example response

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

Changes

No recorded changes to this operation across all 1 revision of this API.