latestOpenAPI 3.0.2cPanel License2026-08-106251554.3 MB

3da41671c02c

Plugin-Based Features

Check if a plugin feature is ready for use

This function checks if a plugin-based feature is installed and ready for use on the server.

get/EcosystemFeatures/is_ready

Query parameters

pluginstring required
Example:cpanel-monitoring-plugin

The plugin-based feature's name in the local /var/cpanel/plugins/ directory.

namespace'Whostmgr' | 'Cpanel'
Example:Cpanel

A filter that allows you to show plugin-based features for a specific interface.

  • Whostmgr - A WHM plugin-based feature.
  • Cpanel - A cPanel plugin-based feature.

Response

HTTP Request was successful.

Example response

{
  "data": {
    "ready": 1
  },
  "metadata": {
    "command": "is_ready",
    "namespace": "EcosystemFeatures",
    "reason": "OK",
    "result": 1,
    "version": 1
  }
}