Skip to main content

Retrieve all Managed Clusters.

Retrieve all Managed Clusters for the current Org, based on request context.

Query Parameters
  • offset int32

    Offset into the full result set. Usually specified with limit to paginate through the results. See V3 API Standard Collection Parameters for more information.

  • limit int32

    Possible values: <= 250

    Default value: 250

    Max number of results to return. See V3 API Standard Collection Parameters for more information.

    Example: 250
  • count boolean

    If true it will populate the X-Total-Count response header with the number of results that would be returned if limit and offset were ignored.

    Since requesting a total count can have a performance impact, it is recommended not to send count=true if that value will not be used.

    See V3 API Standard Collection Parameters for more information.

    Example: true
  • filters string

    Filtering is supported for the following fields and operators:

    operational: eq


Responds with a list of ManagedCluster.

Schema array
  • id string

    ManagedCluster ID

  • name string

    ManagedCluster name

  • pod string

    ManagedCluster pod

  • org string

    ManagedCluster org

  • type string

    Possible values: [idn, iai]

    The Type of Cluster

  • configuration object

    ManagedProcess configuration map

  • property name* string
  • keyPair object

    key pair for the ManagedCluster

  • publicKey string

    ManagedCluster publicKey

  • publicKeyThumbprint string

    ManagedCluster publicKeyThumbprint

  • publicKeyCertificate string

    ManagedCluster publicKeyCertificate

  • attributes object

    Specific Attributes for Configuring a ManagedCluster by Type

  • queue object

    ManagedCluster keystore for sqsCluster type

  • name string

    ManagedCluster queue name

  • region string

    ManagedCluster queue aws region

  • keystore string

    ManagedCluster keystore for spConnectCluster type

  • description string

    ManagedCluster description

  • redis object

    Redis configuration for the ManagedCluster

  • redisHost string

    ManagedCluster redisHost

  • redisPort int32

    ManagedCluster redisPort

  • clientType string

    Possible values: [CCG, VA, INTERNAL]

    type of client for the ManagedCluster

  • ccgVersion string

    CCG version used by the ManagedCluster

  • pinnedConfig boolean

    Default value: false

    boolean flag indiacting whether or not the cluster configuration is pinned

  • logConfiguration object

    client log configuration for the cluster

  • clientId string

    client ID of the Log configuration

  • durationMinutes int32

    Possible values: >= 5 and <= 1440

    duration in minutes for the log configuration to remain in effect before resetting to defaults

  • expiration date-time

    Expiration date-time of the log configuration request

  • rootLevel string

    Possible values: [OFF, FATAL, ERROR, WARN, INFO, DEBUG, TRACE]

    Default value: INFO

    Root Log level to apply

  • logLevels object

    Map of LogLevel by key

  • property name* string

    Possible values: [OFF, FATAL, ERROR, WARN, INFO, DEBUG, TRACE]

  • operational boolean

    Default value: false

    Whether or not the cluster is operational or not

  • status string

    Cluster status

  • publicKeyCertificate string

    Public key certificate

  • publicKeyThumbprint string

    Public key thumbprint

  • publicKey string

    Public key

  • alertKey string

    Key describing any immediate cluster alerts

  • clientIds string[]

    List of clients in a cluster

  • serviceCount int32

    Number of services bound to a cluster

  • ccId string

    Default value: 0

    CC ID only used in calling CC, will be removed without notice when Migration to CEGS is finished