Skip to main content
Version: Next

Get current clusters

GET 
/admin-api/clusters

Returns a list of all automation and management clusters. Each cluster entry contains the running apps and their status.

Request​

Responses​

Ok

Schema
  • Array [
    • uuid stringrequired

    Unique identifier of the cluster

    name stringrequired

    Name of the cluster

    namespace stringrequired

    Namespace the cluster is running in.

    status ConsoleSMAdminApi.Statusrequired

    Possible values: [healthy, unhealthy, unknown]

    Indicates if a cluster is healthy or not

    generation stringrequired

    This is the current version of the running cluster

    type ConsoleSMAdminApi.ClusterTyperequired

    Possible values: [automation, management]

    We're distinguishing between automation and management clusters. Management clusters include applications that act globally in an installed context, like Console or Modeler. Automation clusters are the Zeebe clusters including applications like Operate, Tasklist and Optimize.

    apps object[]required

    The list of applications running in the cluster

  • Array [
    • type ConsoleSMAdminApi.AppTyperequired

    Possible values: [zeebe-broker, zeebe-gateway, operate, tasklist, optimize, modeler, console, identity, unknown]

    What application is running in the cluster, like Zeebe, Operate, Tasklist, ...

    id stringrequired

    Unique identifier of the application

    status ConsoleSMAdminApi.Statusrequired

    Possible values: [healthy, unhealthy, unknown]

    Indicates if an application is healthy or not

    url stringrequired

    The public URL of the application

    generation stringrequired

    This is the current version of the running application

    readiness string

    The readiness URL of the application

    metrics string

    The metrics URL of the application

  • ]
  • ]
Loading...