Plugins
GET /api/v1/plugins
List plugins
List all available plugins with their current status.
Responses:
| Status | Schema | Description |
|---|---|---|
200 |
ApiSuccess_list_dict_str__Any___ |
Successful Response |
Response example (200):
{
"data": [
{}
],
"message": "",
"status": "success",
"warnings": [
"string"
]
}
cURL example:
curl -X GET \
-H "X-WHost-Key: $WHOST_API_KEY" \
-H "X-WHost-Timestamp: $(date +%s)" \
-H "X-WHost-Nonce: $(openssl rand -hex 16)" \
-H "X-WHost-Signature: $(compute_hmac)" \
https://your-server:2000/api/v1/plugins
GET /api/v1/plugins/sidebar-entries
Plugin sidebar entries
Return sidebar entries declared by active plugins, scoped to the caller's role.
Query parameters:
| Name | Type | Required | Notes |
|---|---|---|---|
audience |
string | no | — |
Responses:
| Status | Schema | Description |
|---|---|---|
200 |
ApiSuccess_list_dict_str__Any___ |
Successful Response |
422 |
HTTPValidationError |
Validation Error |
Response example (200):
{
"data": [
{}
],
"message": "",
"status": "success",
"warnings": [
"string"
]
}
cURL example:
curl -X GET \
-H "X-WHost-Key: $WHOST_API_KEY" \
-H "X-WHost-Timestamp: $(date +%s)" \
-H "X-WHost-Nonce: $(openssl rand -hex 16)" \
-H "X-WHost-Signature: $(compute_hmac)" \
https://your-server:2000/api/v1/plugins/sidebar-entries
GET /api/v1/plugins/tasks
Active plugin tasks
Return snapshots of every plugin task still running (resume support for the UI).
Responses:
| Status | Schema | Description |
|---|---|---|
200 |
ApiSuccess_list_dict_str__Any___ |
Successful Response |
Response example (200):
{
"data": [
{}
],
"message": "",
"status": "success",
"warnings": [
"string"
]
}
cURL example:
curl -X GET \
-H "X-WHost-Key: $WHOST_API_KEY" \
-H "X-WHost-Timestamp: $(date +%s)" \
-H "X-WHost-Nonce: $(openssl rand -hex 16)" \
-H "X-WHost-Signature: $(compute_hmac)" \
https://your-server:2000/api/v1/plugins/tasks
GET /api/v1/plugins/tasks/{task_id}
Plugin task snapshot
Polling fallback — returns a full snapshot of a plugin task.
Path parameters:
| Name | Type | Required | Notes |
|---|---|---|---|
task_id |
string | yes | pattern=^[a-f0-9]{8,64}$ |
Responses:
| Status | Schema | Description |
|---|---|---|
200 |
ApiSuccess_dict_str__Any__ |
Successful Response |
422 |
HTTPValidationError |
Validation Error |
Response example (200):
{
"data": {},
"message": "",
"status": "success",
"warnings": [
"string"
]
}
cURL example:
curl -X GET \
-H "X-WHost-Key: $WHOST_API_KEY" \
-H "X-WHost-Timestamp: $(date +%s)" \
-H "X-WHost-Nonce: $(openssl rand -hex 16)" \
-H "X-WHost-Signature: $(compute_hmac)" \
https://your-server:2000/api/v1/plugins/tasks/{task_id}
GET /api/v1/plugins/tasks/{task_id}/events
Stream Plugin Task Events
Server-Sent Events stream for a plugin task.
authenticated session can't saturate the agent's thread pool by rapidly reopening EventSource subscriptions. The actual stream is held open for the task's lifetime and the client reads events as they occur.
Path parameters:
| Name | Type | Required | Notes |
|---|---|---|---|
task_id |
string | yes | pattern=^[a-f0-9]{8,64}$ |
Responses:
| Status | Schema | Description |
|---|---|---|
200 |
— | Successful Response |
422 |
HTTPValidationError |
Validation Error |
cURL example:
curl -X GET \
-H "X-WHost-Key: $WHOST_API_KEY" \
-H "X-WHost-Timestamp: $(date +%s)" \
-H "X-WHost-Nonce: $(openssl rand -hex 16)" \
-H "X-WHost-Signature: $(compute_hmac)" \
https://your-server:2000/api/v1/plugins/tasks/{task_id}/events
GET /api/v1/plugins/{plugin_id}
Get plugin
Get details of a specific plugin.
Path parameters:
| Name | Type | Required | Notes |
|---|---|---|---|
plugin_id |
string | yes | pattern=^[a-z][a-z0-9_-]{1,30}$ |
Responses:
| Status | Schema | Description |
|---|---|---|
200 |
ApiSuccess_dict_str__Any__ |
Successful Response |
422 |
HTTPValidationError |
Validation Error |
Response example (200):
{
"data": {},
"message": "",
"status": "success",
"warnings": [
"string"
]
}
cURL example:
curl -X GET \
-H "X-WHost-Key: $WHOST_API_KEY" \
-H "X-WHost-Timestamp: $(date +%s)" \
-H "X-WHost-Nonce: $(openssl rand -hex 16)" \
-H "X-WHost-Signature: $(compute_hmac)" \
https://your-server:2000/api/v1/plugins/{plugin_id}
POST /api/v1/plugins/{plugin_id}/activate
Activate plugin (blocking)
Activate a plugin with trial or license mode; blocks for the full install duration. Refused 409 while a guarded OS update run, an OS package upgrade, a PHP version install or removal, or another web server plugin's activation, deactivation or update is in progress (web server plugins only); the error code names what runs (OS_UPGRADE_IN_PROGRESS, PHP_PACKAGE_JOB_IN_PROGRESS, PLUGIN_TASK_IN_PROGRESS), and a guarded run that starts while the work runs waits for it.
Path parameters:
| Name | Type | Required | Notes |
|---|---|---|---|
plugin_id |
string | yes | pattern=^[a-z][a-z0-9_-]{1,30}$ |
Body fields:
| Field | Type | Required | Notes |
|---|---|---|---|
mode |
string | no | Activation mode: 'trial', 'license', or 'free'; default free |
serial_key |
string | no | License serial key (required when mode is 'license') |
Request body example:
{
"mode": "free",
"serial_key": "string"
}
Responses:
| Status | Schema | Description |
|---|---|---|
200 |
ApiSuccess_dict_str__Any__ |
Successful Response |
422 |
HTTPValidationError |
Validation Error |
Response example (200):
{
"data": {},
"message": "",
"status": "success",
"warnings": [
"string"
]
}
cURL example:
curl -X POST \
-H "X-WHost-Key: $WHOST_API_KEY" \
-H "X-WHost-Timestamp: $(date +%s)" \
-H "X-WHost-Nonce: $(openssl rand -hex 16)" \
-H "X-WHost-Signature: $(compute_hmac)" \
-H "Content-Type: application/json" \
-d @body.json \
https://your-server:2000/api/v1/plugins/{plugin_id}/activate
POST /api/v1/plugins/{plugin_id}/activate/async
Activate plugin (async)
Kick off plugin activation in the background; returns a task_id for SSE subscription. Refused 409 while a guarded OS update run, an OS package upgrade, a PHP version install or removal, or another web server plugin's activation, deactivation or update is in progress (web server plugins only); the error code names what runs (OS_UPGRADE_IN_PROGRESS, PHP_PACKAGE_JOB_IN_PROGRESS, PLUGIN_TASK_IN_PROGRESS), and a guarded run that starts while the work runs waits for it. A guarded run that starts before the background work does ends the task failed with nothing changed.
Path parameters:
| Name | Type | Required | Notes |
|---|---|---|---|
plugin_id |
string | yes | pattern=^[a-z][a-z0-9_-]{1,30}$ |
Body fields:
| Field | Type | Required | Notes |
|---|---|---|---|
mode |
string | no | Activation mode: 'trial', 'license', or 'free'; default free |
serial_key |
string | no | License serial key (required when mode is 'license') |
Request body example:
{
"mode": "free",
"serial_key": "string"
}
Responses:
| Status | Schema | Description |
|---|---|---|
200 |
ApiSuccess_dict_str__Any__ |
Successful Response |
422 |
HTTPValidationError |
Validation Error |
Response example (200):
{
"data": {},
"message": "",
"status": "success",
"warnings": [
"string"
]
}
cURL example:
curl -X POST \
-H "X-WHost-Key: $WHOST_API_KEY" \
-H "X-WHost-Timestamp: $(date +%s)" \
-H "X-WHost-Nonce: $(openssl rand -hex 16)" \
-H "X-WHost-Signature: $(compute_hmac)" \
-H "Content-Type: application/json" \
-d @body.json \
https://your-server:2000/api/v1/plugins/{plugin_id}/activate/async
POST /api/v1/plugins/{plugin_id}/deactivate
Deactivate plugin
Deactivate a plugin and revert to default state. Refused 409 while a guarded OS update run, an OS package upgrade, a PHP version install or removal, or another web server plugin's activation, deactivation or update is in progress (web server plugins only); the error code names what runs (OS_UPGRADE_IN_PROGRESS, PHP_PACKAGE_JOB_IN_PROGRESS, PLUGIN_TASK_IN_PROGRESS), and a guarded run that starts while the work runs waits for it.
Path parameters:
| Name | Type | Required | Notes |
|---|---|---|---|
plugin_id |
string | yes | pattern=^[a-z][a-z0-9_-]{1,30}$ |
Responses:
| Status | Schema | Description |
|---|---|---|
200 |
ApiSuccess_dict_str__Any__ |
Successful Response |
422 |
HTTPValidationError |
Validation Error |
Response example (200):
{
"data": {},
"message": "",
"status": "success",
"warnings": [
"string"
]
}
cURL example:
curl -X POST \
-H "X-WHost-Key: $WHOST_API_KEY" \
-H "X-WHost-Timestamp: $(date +%s)" \
-H "X-WHost-Nonce: $(openssl rand -hex 16)" \
-H "X-WHost-Signature: $(compute_hmac)" \
https://your-server:2000/api/v1/plugins/{plugin_id}/deactivate
POST /api/v1/plugins/{plugin_id}/reset-state
Reset plugin state
Force-reset a plugin's state record to idle (use when an interrupted pipeline left a stuck marker).
Path parameters:
| Name | Type | Required | Notes |
|---|---|---|---|
plugin_id |
string | yes | pattern=^[a-z][a-z0-9_-]{1,30}$ |
Responses:
| Status | Schema | Description |
|---|---|---|
200 |
ApiSuccess_dict_str__Any__ |
Successful Response |
422 |
HTTPValidationError |
Validation Error |
Response example (200):
{
"data": {},
"message": "",
"status": "success",
"warnings": [
"string"
]
}
cURL example:
curl -X POST \
-H "X-WHost-Key: $WHOST_API_KEY" \
-H "X-WHost-Timestamp: $(date +%s)" \
-H "X-WHost-Nonce: $(openssl rand -hex 16)" \
-H "X-WHost-Signature: $(compute_hmac)" \
https://your-server:2000/api/v1/plugins/{plugin_id}/reset-state
POST /api/v1/plugins/{plugin_id}/update
Update plugin
Update an active plugin to the latest version. OpenLiteSpeed is updated through the system package manager from the LiteSpeed repository (openlitespeed; Debian / Ubuntu apt-get install --only-upgrade, RHEL family dnf upgrade) and restarted through its service when the package version changed; data.update_result names the package versions (version_before, version_after) and changed, and when the package already was the newest version the message says so and nothing is restarted. Refused 409 while a guarded OS update run, an OS package upgrade, a PHP version install or removal, or another web server plugin's activation, deactivation or update is in progress (web server plugins only); the error code names what runs (OS_UPGRADE_IN_PROGRESS, PHP_PACKAGE_JOB_IN_PROGRESS, PLUGIN_TASK_IN_PROGRESS), and a guarded run that starts while the work runs waits for it.
Path parameters:
| Name | Type | Required | Notes |
|---|---|---|---|
plugin_id |
string | yes | pattern=^[a-z][a-z0-9_-]{1,30}$ |
Responses:
| Status | Schema | Description |
|---|---|---|
200 |
ApiSuccess_dict_str__Any__ |
Successful Response |
422 |
HTTPValidationError |
Validation Error |
Response example (200):
{
"data": {},
"message": "",
"status": "success",
"warnings": [
"string"
]
}
cURL example:
curl -X POST \
-H "X-WHost-Key: $WHOST_API_KEY" \
-H "X-WHost-Timestamp: $(date +%s)" \
-H "X-WHost-Nonce: $(openssl rand -hex 16)" \
-H "X-WHost-Signature: $(compute_hmac)" \
https://your-server:2000/api/v1/plugins/{plugin_id}/update
Our support team is here around the clock for anything you can't find above.