A valid request URL is required to generate request examples{
"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"
]
}
}
}{
"event_id": "<string>",
"type": "<string>",
"is_bifrost_error": true,
"status_code": 123,
"error": {
"type": "<string>",
"code": "<string>",
"message": "<string>",
"param": "<string>",
"event_id": "<string>"
},
"extra_fields": {
"model_requested": "<string>",
"request_type": "<string>"
}
}{
"event_id": "<string>",
"type": "<string>",
"is_bifrost_error": true,
"status_code": 123,
"error": {
"type": "<string>",
"code": "<string>",
"message": "<string>",
"param": "<string>",
"event_id": "<string>"
},
"extra_fields": {
"model_requested": "<string>",
"request_type": "<string>"
}
}{
"event_id": "<string>",
"type": "<string>",
"is_bifrost_error": true,
"status_code": 123,
"error": {
"type": "<string>",
"code": "<string>",
"message": "<string>",
"param": "<string>",
"event_id": "<string>"
},
"extra_fields": {
"model_requested": "<string>",
"request_type": "<string>"
}
}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.
A valid request URL is required to generate request examples{
"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"
]
}
}
}{
"event_id": "<string>",
"type": "<string>",
"is_bifrost_error": true,
"status_code": 123,
"error": {
"type": "<string>",
"code": "<string>",
"message": "<string>",
"param": "<string>",
"event_id": "<string>"
},
"extra_fields": {
"model_requested": "<string>",
"request_type": "<string>"
}
}{
"event_id": "<string>",
"type": "<string>",
"is_bifrost_error": true,
"status_code": 123,
"error": {
"type": "<string>",
"code": "<string>",
"message": "<string>",
"param": "<string>",
"event_id": "<string>"
},
"extra_fields": {
"model_requested": "<string>",
"request_type": "<string>"
}
}{
"event_id": "<string>",
"type": "<string>",
"is_bifrost_error": true,
"status_code": 123,
"error": {
"type": "<string>",
"code": "<string>",
"message": "<string>",
"param": "<string>",
"event_id": "<string>"
},
"extra_fields": {
"model_requested": "<string>",
"request_type": "<string>"
}
}Authorizations
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
Plugin display name (the config field name, not the internal actualName from GetName())
Response
Plugin updated successfully
Plugin operation response
Plugin configuration
Show child attributes
Show child attributes
{
"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"]
}
}
Was this page helpful?