Get Platform Status

Get Platform Status
Get comprehensive cluster status and deployment configuration

Retrieve complete cluster status: health, config, form factor, versions.

Returns:

  • Health metrics: CPU, memory, storage (1/5/15 min averages)
  • Config: cluster ID, name, node count, K8s version
  • Network metrics: transmit/receive rates
  • Form factor: current and desired, including transitions
  • Versions: product_version

Form factor transitions track scaling:

  • NOT_STARTED, IN_PROGRESS, COMPLETED, FAILED
  • Check message and job_name for details

See API guide for endpoint comparison and workflow.

Request
URI
GET
https://{api_host}/ssp/cluster/monitor/platform/status
COPY
Responses
200

Successfully retrieved platform status

Returns ClusterStatus of type(s) application/json
This response body class contains all of the following: Status , InlineClusterStatus1 
{
    "cluster_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    "cluster_name": "ssp-cluster",
    "message_bus_endpoint": "messagebus.example.com:9092",
    "node_count": 3,
    "k8s_version": "1.24.6",
    "network_data_flow": {
        "transmit": 34.7,
        "receive": 24.2,
        "total": 58.9
    },
    "ingress_url": "ssp.example.com:443",
    "form_factor": "SMALL",
    "product_version": "5.2.0-0.0-24893060",
    "desired_state": {
        "form_factor": "SMALL",
        "controller_node_replica": 3,
        "worker_node_replica": 5
    },
    "realized_state": {
        "form_factor": "SMALL",
        "controller_node_replica": 3,
        "worker_node_replica": 5,
        "form_factor_transition": {
            "phase": "IN_PROGRESS",
            "start_time": "2026-01-15T10:30:00Z",
            "completion_time": "2026-01-15T11:45:00Z",
            "message": "Form factor transition from MEDIUM to LARGE in progress",
            "job_name": "formfactor-transition-job-abc123",
            "operation_id": "op-12345-67890",
            "source_form_factor": "SMALL",
            "target_form_factor": "SMALL"
        }
    }
}

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 platform status.

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/platform/status
On This Page
Cluster Monitor Operations
GET
Get Feature Health
GET
Get Platform Status
GET
Get Services Status