---
id: get-managed-cluster
sidebar_label: Get a specified ManagedCluster.
hide_title: true
hide_table_of_contents: true
api: {"tags":["Managed Clusters"],"description":"Retrieve a ManagedCluster by ID.","operationId":"getManagedCluster","parameters":[{"name":"id","in":"path","description":"ID of the ManagedCluster to get","required":true,"style":"simple","explode":false,"schema":{"type":"string","example":"aClusterId"}}],"responses":{"200":{"description":"Responds with ManagedCluster having the given ID.","content":{"application/json":{"schema":{"description":"Managed Cluster","type":"object","required":["id","clientType","ccgVersion"],"properties":{"id":{"description":"ManagedCluster ID","type":"string","example":"aClusterId"},"name":{"description":"ManagedCluster name","type":"string","example":"Managed Cluster Name"},"pod":{"description":"ManagedCluster pod","type":"string","example":"megapod-useast1"},"org":{"description":"ManagedCluster org","type":"string","example":"denali"},"type":{"description":"The Type of Cluster","example":"idn","nullable":false,"type":"string","enum":["idn","iai"]},"configuration":{"description":"ManagedProcess configuration map","type":"object","additionalProperties":{"type":"string"},"example":{"clusterExternalId":"externalId","ccgVersion":"77.0.0"}},"keyPair":{"description":"key pair for the ManagedCluster","type":"object","properties":{"publicKey":{"description":"ManagedCluster publicKey","type":"string","example":"-----BEGIN PUBLIC KEY-----******-----END PUBLIC KEY-----"},"publicKeyThumbprint":{"description":"ManagedCluster publicKeyThumbprint","type":"string","example":"6CMlaJIV44-xJxcB3CJBjDUUn54"},"publicKeyCertificate":{"description":"ManagedCluster publicKeyCertificate","type":"string","example":"-----BEGIN CERTIFICATE-----****-----END CERTIFICATE-----"}}},"attributes":{"description":"Specific Attributes for Configuring a ManagedCluster by Type","type":"object","properties":{"queue":{"description":"ManagedCluster keystore for sqsCluster type","type":"object","properties":{"name":{"description":"ManagedCluster queue name","type":"string","example":"megapod-useast1-denali-lwt-cluster-1533"},"region":{"description":"ManagedCluster queue aws region","type":"string","example":"us-east-1"}}},"keystore":{"description":"ManagedCluster keystore for spConnectCluster type","type":"string","example":"/u3+7QAAAAIAAAABAAAAAQAvL3Byb3h5LWNsdXN0ZXIvMmM5MTgwODc3Yjg3MW"}}},"description":{"description":"ManagedCluster description","type":"string","example":"A short description of the managed cluster."},"redis":{"description":"Redis configuration for the ManagedCluster","type":"object","properties":{"redisHost":{"description":"ManagedCluster redisHost","type":"string","example":"megapod-useast1-shared-redis.cloud.sailpoint.com"},"redisPort":{"description":"ManagedCluster redisPort","type":"integer","format":"int32","example":6379}}},"clientType":{"description":"type of client for the ManagedCluster","type":"string","example":"CCG","enum":["CCG","VA","INTERNAL"]},"ccgVersion":{"description":"CCG version used by the ManagedCluster","type":"string","example":"v01"},"pinnedConfig":{"description":"boolean flag indiacting whether or not the cluster configuration is pinned","type":"boolean","default":false,"example":false},"logConfiguration":{"description":"client log configuration for the cluster","example":"{ \"rootLevel\": \"WARN\", \"logLevels\": { \"foobar\": \"WARN\" } }","type":"object","required":["durationMinutes","rootLevel"],"properties":{"clientId":{"description":"client ID of the Log configuration","type":"string","example":"aClientId"},"durationMinutes":{"description":"duration in minutes for the log configuration to remain in effect before resetting to defaults","type":"integer","format":"int32","example":120,"default":240,"minimum":5,"maximum":1440},"expiration":{"description":"Expiration date-time of the log configuration request","example":120,"type":"string","format":"date-time"},"rootLevel":{"description":"Root Log level to apply","default":"INFO","example":"TRACE","type":"string","enum":["OFF","FATAL","ERROR","WARN","INFO","DEBUG","TRACE"]},"logLevels":{"description":"Map of LogLevel by key","example":"{ level:WARN }","type":"object","additionalProperties":{"default":"INFO","example":"TRACE","description":"Standard Log4j log level","type":"string","enum":["OFF","FATAL","ERROR","WARN","INFO","DEBUG","TRACE"]}}}},"operational":{"description":"Whether or not the cluster is operational or not","type":"boolean","default":false,"example":false},"status":{"description":"Cluster status","type":"string","example":"NORMAL"},"publicKeyCertificate":{"description":"Public key certificate","type":"string","example":"-----BEGIN CERTIFICATE-----TCCAb2gAwIBAgIBADANBgkqhkiG9w0BAQsFADAuMQ0wCwYDVQQD-----END CERTIFICATE-----"},"publicKeyThumbprint":{"description":"Public key thumbprint","type":"string","example":"obc6pLiulGbtZ"},"publicKey":{"description":"Public key","type":"string","example":"-----BEGIN PUBLIC KEY-----jANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEA3WgnsxP52MDgBTfHR+5n4-----END PUBLIC KEY-----"},"alertKey":{"description":"Key describing any immediate cluster alerts","type":"string","example":"LIMITED_RESOURCES"},"clientIds":{"type":"array","description":"List of clients in a cluster","items":{"type":"string"},"example":["1244","1245"]},"serviceCount":{"description":"Number of services bound to a cluster","type":"integer","format":"int32","default":0,"example":6},"ccId":{"description":"CC ID only used in calling CC, will be removed without notice when Migration to CEGS is finished","type":"string","default":"0","example":"1533"}}}}}},"400":{"description":"Client Error - Returned if the request body is invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}}}}},"403":{"description":"Forbidden - Returned if the user you are running as, doesn't have access to this end-point.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"403":{"summary":"An example of a 403 response object","value":{"detailCode":"403 Forbidden","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server understood the request but refuses to authorize it."}]}}}}}},"404":{"description":"Not Found - returned if the request URL refers to a resource or object that does not exist","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"404":{"summary":"An example of a 404 response object","value":{"detailCode":"404 Not found","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server did not find a current representation for the target resource."}]}}}}}}},"security":[{"bearerAuth":["idn:managed-cluster:read"]}],"method":"get","path":"/managed-clusters/{id}","servers":[{"url":"https://{tenant}.api.identitynow.com/beta","description":"This is the beta API server.","variables":{"tenant":{"default":"sailpoint","description":"This is the name of your tenant, typically your company's name."}}}],"securitySchemes":{"oauth2":{"type":"oauth2","description":"OAuth2 Bearer token (JWT). See [IdentityNow REST API Authentication](https://developer.sailpoint.com/docs/authentication.html) for more information.\n- Directions for generating a [personal access token](https://developer.sailpoint.com/docs/authentication.html#personal-access-tokens)\n- Directions using [client credentials flow](https://developer.sailpoint.com/docs/authentication.html#client-credentials-grant-flow)\n- Directions for using [authorization code flow](https://developer.sailpoint.com/docs/authentication.html#authorization-code-grant-flow)\n\nWhich authentication method should I choose? See our [guide](https://developer.sailpoint.com/docs/authentication.html#which-oauth-2-0-grant-flow-should-i-use)\n\nLearn more about how to find your `tokenUrl` and `authorizationUrl` [in our docs](https://developer.sailpoint.com/docs/authentication.html#finding-your-tenant-s-oauth-details)\n","flows":{"clientCredentials":{"tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}},"authorizationCode":{"authorizationUrl":"https://tenant.identitynow.com/oauth/authorize","tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}}}}},"info":{"contact":{"email":"developers@sailpoint.com","name":"Developer Relations","url":"https://developer.sailpoint.com/discuss"},"description":"These are the public, beta APIs for SailPoint's SaaS services and are subject to change.","title":"SailPoint - Beta SaaS API","version":"3.1.0-beta"},"postman":{"name":"Get a specified ManagedCluster.","description":{"content":"Retrieve a ManagedCluster by ID.","type":"text/plain"},"url":{"path":["managed-clusters",":id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) ID of the ManagedCluster to get","type":"text/plain"},"type":"any","value":"","key":"id"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET"}}
sidebar_class_name: "get api-method"
info_path: docs/sailpoint-api-beta/sail-point-beta-saa-s-api
---
import ApiTabs from "@theme/ApiTabs";
import MimeTabs from "@theme/MimeTabs";
import ParamsItem from "@theme/ParamsItem";
import ResponseSamples from "@theme/ResponseSamples";
import SchemaItem from "@theme/SchemaItem"
import SchemaTabs from "@theme/SchemaTabs";
import DiscriminatorTabs from "@theme/DiscriminatorTabs";
import TabItem from "@theme/TabItem";
## Get a specified ManagedCluster.
Retrieve a ManagedCluster by ID.
Path Parameters
Responds with ManagedCluster having the given ID.
Schema
configuration object
ManagedProcess configuration map
property name* string
keyPair object
key pair for the ManagedCluster
attributes object
Specific Attributes for Configuring a ManagedCluster by Type
queue object
ManagedCluster keystore for sqsCluster type
redis object
Redis configuration for the ManagedCluster
logConfiguration object
client log configuration for the cluster
= 5` and `<= 1440`"} defaultValue={240}>logLevels object