Plugin Manager endpoints (Admin API)

GET/api/admin/plugin-manager

Get all plugins Retrieve a list of all installed plugins with their configuration, status, dependencies, and file information. Only available in developer mode.

curl -X GET "$PANEL_URL/api/admin/plugin-manager" \
  -H "Authorization: Bearer $FEATHERPANEL_API_KEY" \
  -H "Accept: application/json"

Responses: 200 Plugins retrieved successfully · 401 Unauthorized · 403 Forbidden - Developer mode not enabled or insufficient permissions · 500 Internal server error - Failed to fetch plugins

POST/api/admin/plugin-manager

Create new plugin Create a new plugin with complete directory structure, configuration files, and example code. Only available in developer mode.

Request body: PluginCreate (application/json)

curl -X POST "$PANEL_URL/api/admin/plugin-manager" \
  -H "Authorization: Bearer $FEATHERPANEL_API_KEY" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{"identifier":"","name":"","description":"","version":"","author":[],"flags":[],"dependencies":[],"requiredConfigs":[],"configSchema":[]}'

Plugin events: featherpanel:admin:plugin_manager:plugin:created

Responses: 201 Plugin created successfully · 400 Bad request - Missing required fields, invalid identifier, or validation errors · 401 Unauthorized · 403 Forbidden - Developer mode not enabled or insufficient permissions · 409 Conflict - Plugin already exists · 500 Internal server error - Failed to create plugin

GET/api/admin/plugin-manager/{identifier}

Get plugin details Retrieve detailed information about a specific plugin including configuration, status, dependencies, settings, and files. Only available in developer mode.

Response data: Plugin

curl -X GET "$PANEL_URL/api/admin/plugin-manager/$IDENTIFIER" \
  -H "Authorization: Bearer $FEATHERPANEL_API_KEY" \
  -H "Accept: application/json"

Responses: 200 Plugin details retrieved successfully · 400 Bad request - Invalid plugin identifier · 401 Unauthorized · 403 Forbidden - Developer mode not enabled or insufficient permissions · 404 Plugin not found · 500 Internal server error - Failed to fetch plugin details

PUT/api/admin/plugin-manager/{identifier}

Update plugin configuration Update an existing plugin's configuration including metadata, dependencies, and configuration schema. Only available in developer mode.

Request body: PluginUpdate (application/json)

curl -X PUT "$PANEL_URL/api/admin/plugin-manager/$IDENTIFIER" \
  -H "Authorization: Bearer $FEATHERPANEL_API_KEY" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{"name":"","description":"","version":"","target":"","author":[],"flags":[],"dependencies":[],"requiredConfigs":[],"configSchema":[]}'

Plugin events: featherpanel:admin:plugin_manager:plugin:updated

Responses: 200 Plugin updated successfully · 400 Bad request - Invalid plugin identifier, invalid configuration, or validation errors · 401 Unauthorized · 403 Forbidden - Developer mode not enabled or insufficient permissions · 404 Plugin not found · 500 Internal server error - Failed to update plugin

PATCH/api/admin/plugin-manager/{identifier}

Update plugin configuration Update an existing plugin's configuration including metadata, dependencies, and configuration schema. Only available in developer mode.

Request body: PluginUpdate (application/json)

curl -X PATCH "$PANEL_URL/api/admin/plugin-manager/$IDENTIFIER" \
  -H "Authorization: Bearer $FEATHERPANEL_API_KEY" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{"name":"","description":"","version":"","target":"","author":[],"flags":[],"dependencies":[],"requiredConfigs":[],"configSchema":[]}'

Plugin events: featherpanel:admin:plugin_manager:plugin:updated

Responses: 200 Plugin updated successfully · 400 Bad request - Invalid plugin identifier, invalid configuration, or validation errors · 401 Unauthorized · 403 Forbidden - Developer mode not enabled or insufficient permissions · 404 Plugin not found · 500 Internal server error - Failed to update plugin

PUT/api/admin/plugin-manager/{identifier}/settings

Update plugin settings Update plugin-specific settings by providing key-value pairs. Only available in developer mode.

Request body: PluginSettingsUpdate (application/json)

curl -X PUT "$PANEL_URL/api/admin/plugin-manager/$IDENTIFIER/settings" \
  -H "Authorization: Bearer $FEATHERPANEL_API_KEY" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{"settings":{}}'

Plugin events: featherpanel:admin:plugin_manager:settings:updated

Responses: 200 Plugin settings updated successfully · 400 Bad request - Invalid plugin identifier or missing settings data · 401 Unauthorized · 403 Forbidden - Developer mode not enabled or insufficient permissions · 500 Internal server error - Failed to update plugin settings

PATCH/api/admin/plugin-manager/{identifier}/settings

Update plugin settings Update plugin-specific settings by providing key-value pairs. Only available in developer mode.

Request body: PluginSettingsUpdate (application/json)

curl -X PATCH "$PANEL_URL/api/admin/plugin-manager/$IDENTIFIER/settings" \
  -H "Authorization: Bearer $FEATHERPANEL_API_KEY" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{"settings":{}}'

Plugin events: featherpanel:admin:plugin_manager:settings:updated

Responses: 200 Plugin settings updated successfully · 400 Bad request - Invalid plugin identifier or missing settings data · 401 Unauthorized · 403 Forbidden - Developer mode not enabled or insufficient permissions · 500 Internal server error - Failed to update plugin settings

GET/api/admin/plugin-manager/flags

Get available plugin flags Retrieve a list of all available plugin flags that can be used when creating or updating plugins.

curl -X GET "$PANEL_URL/api/admin/plugin-manager/flags" \
  -H "Authorization: Bearer $FEATHERPANEL_API_KEY" \
  -H "Accept: application/json"

Responses: 200 Available flags retrieved successfully · 401 Unauthorized · 403 Forbidden - Insufficient permissions · 500 Internal server error - Failed to fetch flags

GET/api/admin/plugin-manager/{identifier}/validate

Validate plugin Validate a plugin's configuration, dependencies, required configs, identifier, flags, and file structure. Only available in developer mode.

Response data: PluginValidation

curl -X GET "$PANEL_URL/api/admin/plugin-manager/$IDENTIFIER/validate" \
  -H "Authorization: Bearer $FEATHERPANEL_API_KEY" \
  -H "Accept: application/json"

Responses: 200 Plugin validation completed · 400 Bad request - Invalid plugin identifier · 401 Unauthorized · 403 Forbidden - Developer mode not enabled or insufficient permissions · 404 Plugin not found · 500 Internal server error - Failed to validate plugin

GET/api/admin/plugin-tools/creation-options

Get plugin creation options Retrieve available options for creating different types of plugin files including field definitions and validation rules. Only available in developer mode.

Response data: PluginCreationOptions

curl -X GET "$PANEL_URL/api/admin/plugin-tools/creation-options" \
  -H "Authorization: Bearer $FEATHERPANEL_API_KEY" \
  -H "Accept: application/json"

Responses: 200 Plugin creation options retrieved successfully · 401 Unauthorized · 403 Forbidden - Developer mode not enabled or insufficient permissions · 500 Internal server error - Failed to get creation options

POST/api/admin/plugin-tools/create-file

Create plugin file Create various types of plugin files including migrations, cron jobs, CLI commands, or upload public files. Only available in developer mode.

Request body: PluginFileCreate (multipart/form-data)

curl -X POST "$PANEL_URL/api/admin/plugin-tools/create-file" \
  -H "Authorization: Bearer $FEATHERPANEL_API_KEY" \
  -H "Accept: application/json" \
  -F "plugin_id=" \
  -F "file_type=" \
  -F "name=" \
  -F "description=" \
  -F "schedule=" \
  -F "file=@./file"

Plugin events: featherpanel:admin:plugin_manager:file:created

Responses: 200 Plugin file created successfully · 400 Bad request - Missing required fields, invalid file type, or validation errors · 401 Unauthorized · 403 Forbidden - Developer mode not enabled or insufficient permissions · 404 Plugin not found · 500 Internal server error - Failed to create plugin file