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.

    Example: 0
    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

    Filter results using the standard syntax described in V3 API Standard Collection Parameters

    Filtering is supported for the following fields and operators:

    operational: eq

    Example: operational eq "operation"


Responds with a list of ManagedCluster.

  • Array [
  • id stringrequired

    ManagedCluster ID

    name string

    ManagedCluster name

    pod string

    ManagedCluster pod

    org string

    ManagedCluster org

    type ManagedClusterTypes

    Possible values: [idn, iai]

    Default value: idn

    The Type of Cluster

    configuration object

    ManagedProcess configuration map

    property name* string
    keyPair object

    key pair for the ManagedCluster

    publicKey stringnullable

    ManagedCluster publicKey

    publicKeyThumbprint stringnullable

    ManagedCluster publicKeyThumbprint

    publicKeyCertificate stringnullable

    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 stringnullable

    ManagedCluster keystore for spConnectCluster type

    description string

    Default value: q

    ManagedCluster description

    redis object

    Redis configuration for the ManagedCluster

    redisHost string

    ManagedCluster redisHost

    redisPort int32

    ManagedCluster redisPort

    clientType ManagedClientTypenullablerequired

    Possible values: [CCG, VA, INTERNAL, IIQ_HARVESTER, null]

    type of client for the ManagedCluster

    ccgVersion stringrequired

    CCG version used by the ManagedCluster

    pinnedConfig boolean

    Default value: false

    boolean flag indiacting whether or not the cluster configuration is pinned

    logConfiguration objectnullable

    client log configuration for the cluster

    clientId string

    Log configuration's client ID

    durationMinutes int32required

    Possible values: >= 5 and <= 1440

    Duration in minutes for log configuration to remain in effect before resetting to defaults

    expiration date-time

    Expiration date-time of the log configuration request

    rootLevel StandardLevelrequired

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

    Default value: INFO

    Root log level to apply, the default level for all logs. For more information about logging levels, refer to the "Logging Levels" table in Enabling Connector Logging in IdentityNow.

    logLevels object

    Map of log level by key. The keys are logging classes, and the values are logging levels. To see the available connectors and their logging classes, refer to the "Logging Classes" table in Enabling Connector Logging in IdentityNow.

    property name* StandardLevel

    Default value: INFO

    Standard Log4j log level

    operational boolean

    Default value: false

    Whether or not the cluster is operational or not

    status string

    Cluster status

    publicKeyCertificate stringnullable

    Public key certificate

    publicKeyThumbprint stringnullable

    Public key thumbprint

    publicKey stringnullable

    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

    createdAt date-timenullable

    The date/time this cluster was created

    updatedAt date-timenullable

    The date/time this cluster was last updated

  • ]