Skip to main content

​
Plugins

​
List Plugins

curl -X GET https://your-instance.com/api/plugins/plugins/ \
  -H "Authorization: Bearer YOUR_TOKEN"
Returns all installed plugins with their metadata and status.
​
key
string
Unique plugin identifier
​
name
string
Plugin display name
​
description
string
Plugin description
​
version
string
Plugin version
​
author
string
Plugin author
​
enabled
boolean
Whether plugin is enabled
​
has_settings
boolean
Whether plugin has configurable settings
​
logo_url
string
Plugin logo URL

​
Plugin Management

​
Reload Plugins

curl -X POST https://your-instance.com/api/plugins/plugins/reload/ \
  -H "Authorization: Bearer YOUR_TOKEN"
Reloads all plugins from disk, discovering new plugins and updating existing ones.
​
status
string
Reload status (success or failure)
​
message
string
Status message
​
plugins_loaded
integer
Number of plugins loaded

​
Import Plugin

curl -X POST https://your-instance.com/api/plugins/plugins/import/ \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -F "file=@plugin.zip"
Imports a plugin from a ZIP file.
​
file
file
required
Plugin ZIP file
​
status
string
Import status
​
message
string
Status message
​
plugin_key
string
Key of imported plugin

​
Delete Plugin

curl -X DELETE https://your-instance.com/api/plugins/plugins/my-plugin/delete/ \
  -H "Authorization: Bearer YOUR_TOKEN"
Deletes a plugin and its associated files.
​
key
string
required
Plugin key identifier
​
status
string
Deletion status
​
message
string
Status message

​
Plugin Settings

​
Get Plugin Settings

curl -X GET https://your-instance.com/api/plugins/plugins/my-plugin/settings/ \
  -H "Authorization: Bearer YOUR_TOKEN"
Returns the settings schema and current values for a plugin.
​
key
string
required
Plugin key identifier
​
schema
object
Settings schema with field definitions
​
values
object
Current setting values

​
Update Plugin Settings

curl -X PUT https://your-instance.com/api/plugins/plugins/my-plugin/settings/ \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "api_key": "your-api-key",
    "enabled_feature": true,
    "threshold": 100
  }'
Updates plugin settings.
​
key
string
required
Plugin key identifier
​
settings
object
required
Key-value pairs of settings to update
​
status
string
Update status
​
message
string
Status message
​
values
object
Updated setting values

​
Plugin Execution

​
Run Plugin

curl -X POST https://your-instance.com/api/plugins/plugins/my-plugin/run/ \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "param1": "value1",
    "param2": "value2"
  }'
Executes a plugin with optional parameters.
​
key
string
required
Plugin key identifier
​
parameters
object
Plugin-specific parameters
​
status
string
Execution status (success, running, failed)
​
message
string
Status message
​
result
object
Plugin execution result data
​
execution_time
number
Execution time in seconds

​
Plugin Status

​
Get Plugin Enabled Status

curl -X GET https://your-instance.com/api/plugins/plugins/my-plugin/enabled/ \
  -H "Authorization: Bearer YOUR_TOKEN"
Returns whether a plugin is currently enabled.
​
key
string
required
Plugin key identifier
​
enabled
boolean
Whether plugin is enabled

​
Update Plugin Enabled Status

curl -X PUT https://your-instance.com/api/plugins/plugins/my-plugin/enabled/ \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "enabled": true
  }'
Enables or disables a plugin.
​
key
string
required
Plugin key identifier
​
enabled
boolean
required
Whether to enable or disable the plugin
​
status
string
Update status
​
message
string
Status message
​
enabled
boolean
New enabled status

​
Plugin Assets

curl -X GET https://your-instance.com/api/plugins/plugins/my-plugin/logo/ \
  -H "Authorization: Bearer YOUR_TOKEN"
Returns the plugin’s logo image file.
​
key
string
required
Plugin key identifier
Returns the logo image file with appropriate content type (image/png, image/jpeg, etc.).