Get Feature Health

Get Feature Health
Retrieve hierarchical feature and component health status

Retrieve hierarchical health status: Features -> Services -> Components.

Structure:

  • Features are high-level groupings (e.g., "intelligence", "analytics")
  • Services are feature components (e.g., "cluster-api")
  • Components are pods/deployments

Key points:

  • Overall platform status: UP, PARTIALLY_UP, DOWN
  • Aggregated from feature status
  • See API guide for when to use this vs other endpoints
Request
URI
GET
https://{api_host}/ssp/cluster/monitor/feature/health
COPY
Responses
200

Successfully retrieved feature health status

Returns MonitorFeatureHealthResponse of type(s) application/json 
{
    "status": "UP",
    "migration_in_progress": false,
    "features": [
        {
            "name": "string",
            "status": "UP",
            "services": [
                {
                    "name": "cluster-api",
                    "status": "UP",
                    "components": [
                        {
                            "name": "cluster-api",
                            "status": "UP",
                            "ready_replica": 1,
                            "total_replica": 1
                        }
                    ],
                    "prefixes": [
                        "cluster-api"
                    ]
                }
            ]
        }
    ]
}
string
status
Required  

Overall health status of the Security Services Platform.

Enumeration: UP, PARTIALLY_UP, DOWN
boolean
migration_in_progress
Optional

Indicates if NAPP to SSP migration is currently in progress. When true, some degraded statuses may be suppressed.

array of object
features
Required  

List of all deployed features and their health status.


400

Bad Request

Returns BadRequest of type(s) application/json 
{
    "error_code": 0,
    "module_name": "string",
    "error_message": "string"
}
integer
error_code
Required  

HTTP Status or Application error code.

string
module_name
Optional

Module where the error happened.

string
error_message
Required  

Message describing the error.


401

Unauthorized

Returns Unauthorized of type(s) application/json 
{
    "error_code": 0,
    "module_name": "string",
    "error_message": "string"
}
integer
error_code
Required  

HTTP Status or Application error code.

string
module_name
Optional

Module where the error happened.

string
error_message
Required  

Message describing the error.


403

Forbidden

Returns Forbidden of type(s) application/json 
{
    "error_code": 0,
    "module_name": "string",
    "error_message": "string"
}
integer
error_code
Required  

HTTP Status or Application error code.

string
module_name
Optional

Module where the error happened.

string
error_message
Required  

Message describing the error.


412

Precondition Failed

Returns PreconditionFailed of type(s) application/json 
{
    "error_code": 0,
    "module_name": "string",
    "error_message": "string"
}
integer
error_code
Required  

HTTP Status or Application error code.

string
module_name
Optional

Module where the error happened.

string
error_message
Required  

Message describing the error.


428

Precondition Required

Returns PreconditionRequired of type(s) application/json 
{
    "error_code": 0,
    "module_name": "string",
    "error_message": "string"
}
integer
error_code
Required  

HTTP Status or Application error code.

string
module_name
Optional

Module where the error happened.

string
error_message
Required  

Message describing the error.


429

Too Many Requests

Returns TooManyRequests of type(s) application/json 
{
    "error_code": 0,
    "module_name": "string",
    "error_message": "string"
}
integer
error_code
Required  

HTTP Status or Application error code.

string
module_name
Optional

Module where the error happened.

string
error_message
Required  

Message describing the error.


default

An error occurred while retrieving feature health status. This could be due to authentication issues, authorization failures, invalid requests, or internal server errors.

Returns Error of type(s) application/json 
{
    "error_code": 0,
    "module_name": "string",
    "error_message": "string"
}
integer
error_code
Required  

HTTP Status or Application error code.

string
module_name
Optional

Module where the error happened.

string
error_message
Required  

Message describing the error.


Code Samples
COPY
                    curl -H 'Authorization: <value>' https://{api_host}/ssp/cluster/monitor/feature/health
On This Page
Cluster Monitor Operations
GET
Get Feature Health
GET
Get Platform Status
GET
Get Services Status