HomeGuidesAPI Reference
API Reference

Get Cluster State

Retrieves the cluster state information for all configured clusters or a specific cluster. Returns synchronization status, appliance interface details, nonce, and cipher profile information for each cluster.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
string

Filter results by specific cluster/site name. When not provided, returns state for all clusters.

boolean
Defaults to true

When true, uses cached flow redirection config from database. When false, fetches fresh data directly from appliances.

Responses

401

Unauthorized - Authentication required

403

Forbidden - Insufficient permissions. Requires READ or READ_WRITE role.

Language
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json