Get Cluster Configs

Get Cluster Configs
Get cluster configurations

Retrieve paginated list of cluster configurations for a site, including cluster details, health status, DFW/IDPS status, and remediation messages.

Request
URI
POST
https://{api_host}/security-monitoring/sites/{site-id}/cluster-configs
COPY
Path Parameters
string
site-id
Required  

Site id in the query

Request Body
ClusterConfigsListRequestParameters of type(s) application/json
Optional
This request body class requires all of the following: ListRequestParameters 
{
    "site_ids": [
        "string"
    ],
    "offset": 0,
    "page_size": 0,
    "sort_ascending": false,
    "sort_by": "string"
}
Authentication
This operation uses the following authentication methods.
Responses
200

Success.

Returns ClusterConfigsListResult of type(s) application/json
This response body class contains all of the following: ListResult , InlineClusterConfigsListResult1 
{
    "offset": 0,
    "number_of_results": 0,
    "total_result_count": 0,
    "total_pages": 0,
    "sort_ascending": false,
    "sort_by": "string",
    "results": [
        {
            "cluster_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
            "cluster_name": "Production-Cluster-01",
            "cluster_type": "VLCM",
            "dfw_status": "ON",
            "hosts_count": 25,
            "idps_status": "ON",
            "turbo_eligible": "ELIGIBLE",
            "classic_eligible": "INELIGIBLE",
            "health": {
                "overall_health": "HIGH",
                "health_breakdown": [
                    {
                        "health_level": "CRITICAL",
                        "host_count": 0
                    },
                    {
                        "health_level": "HIGH",
                        "host_count": 2
                    },
                    {
                        "health_level": "NORMAL",
                        "host_count": 22
                    },
                    {
                        "health_level": "UNKNOWN",
                        "host_count": 1
                    },
                    {
                        "health_level": "INCORRECT_CONFIGURATION",
                        "host_count": 0
                    },
                    {
                        "health_level": "REQUIREMENT_NOT_MET",
                        "host_count": 0
                    }
                ]
            },
            "turbo_status": "ON",
            "remediation_message": [
                {
                    "key": "MEMORY_THRESHOLD_EXCEEDED",
                    "value": "Host memory usage above 90% on 2 hosts"
                }
            ]
        }
    ]
}

400

Bad request. The request parameters are invalid or malformed.

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.


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.


404

Not found.

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.


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 unexpected error occurred while processing the request.

Returns Error of type(s) application/json 
"Error Object"
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 -X POST -H 'Authorization: <value>' -H 'Content-Type: application/json' -d '{}' https://{api_host}/security-monitoring/sites/{site-id}/cluster-configs
On This Page
Security Monitoring Operations
GET
Get Security Monitoring Clusters Summary
POST
Get Cluster Configs