--- id: managed-clusters title: ManagedClusters pagination_label: ManagedClusters sidebar_label: ManagedClusters sidebar_class_name: powershellsdk keywords: ['powershell', 'PowerShell', 'sdk', 'ManagedClusters'] slug: /tools/sdk/powershell/v3/methods/managed-clusters tags: ['SDK', 'Software Development Kit', 'ManagedClusters'] --- # ManagedClusters All URIs are relative to *https://sailpoint.api.identitynow.com/v3* Method | HTTP request | Description ------------- | ------------- | ------------- [**New-ManagedCluster**](#create-managed-cluster) | **POST** `/managed-clusters` | Create Create Managed Cluster [**Remove-ManagedCluster**](#delete-managed-cluster) | **DELETE** `/managed-clusters/{id}` | Delete Managed Cluster [**Get-ClientLogConfiguration**](#get-client-log-configuration) | **GET** `/managed-clusters/{id}/log-config` | Get Managed Cluster Log Configuration [**Get-ManagedCluster**](#get-managed-cluster) | **GET** `/managed-clusters/{id}` | Get Managed Cluster [**Get-ManagedClusters**](#get-managed-clusters) | **GET** `/managed-clusters` | Get Managed Clusters [**Send-ClientLogConfiguration**](#put-client-log-configuration) | **PUT** `/managed-clusters/{id}/log-config` | Update Managed Cluster Log Configuration [**Update-ManagedCluster**](#update-managed-cluster) | **PATCH** `/managed-clusters/{id}` | Update Managed Cluster ## create-managed-cluster Create a new Managed Cluster. The API returns a result that includes the managed cluster ID. ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- Body | ManagedClusterRequest | [**ManagedClusterRequest**](../models/managed-cluster-request) | True | ### Return type [**ManagedCluster**](../models/managed-cluster) ### Responses Code | Description | Data Type ------------- | ------------- | ------------- 200 | Created managed cluster. | ManagedCluster 400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto 401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response 403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto 429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response 500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json ### Example ```powershell $ManagedClusterRequest = @"{ "configuration" : { "clusterExternalId" : "externalId", "ccgVersion" : "77.0.0" }, "name" : "Managed Cluster Name", "description" : "A short description of the managed cluster.", "type" : "idn" }"@ # Create Create Managed Cluster try { $Result = ConvertFrom-JsonToManagedClusterRequest -Json $ManagedClusterRequest New-ManagedCluster-ManagedClusterRequest $Result # Below is a request that includes all optional parameters # New-ManagedCluster -ManagedClusterRequest $ManagedClusterRequest } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-ManagedCluster" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) ## delete-managed-cluster Delete an existing managed cluster. ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- Path | Id | **String** | True | Managed cluster ID. Query | RemoveClients | **Boolean** | (optional) (default to $false) | Flag to determine the need to delete a cluster with clients. ### Return type (empty response body) ### Responses Code | Description | Data Type ------------- | ------------- | ------------- 204 | No content - indicates the request was successful but there is no content to be returned in the response. | 400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto 401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response 403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto 429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response 500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto ### HTTP request headers - **Content-Type**: Not defined - **Accept**: application/json ### Example ```powershell $Id = "2c9180897de347a2017de8859e8c5039" # String | Managed cluster ID. $RemoveClients = $false # Boolean | Flag to determine the need to delete a cluster with clients. (optional) (default to $false) # Delete Managed Cluster try { Remove-ManagedCluster-Id $Id # Below is a request that includes all optional parameters # Remove-ManagedCluster -Id $Id -RemoveClients $RemoveClients } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-ManagedCluster" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) ## get-client-log-configuration Get a managed cluster's log configuration. ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- Path | Id | **String** | True | ID of managed cluster to get log configuration for. ### Return type [**ClientLogConfiguration**](../models/client-log-configuration) ### Responses Code | Description | Data Type ------------- | ------------- | ------------- 200 | Log configuration of managed cluster for given cluster ID. | ClientLogConfiguration 204 | No content - indicates the request was successful but there is no content to be returned in the response. | 400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto 401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response 403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto 404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto 429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response 500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto ### HTTP request headers - **Content-Type**: Not defined - **Accept**: application/json ### Example ```powershell $Id = "2b838de9-db9b-abcf-e646-d4f274ad4238" # String | ID of managed cluster to get log configuration for. # Get Managed Cluster Log Configuration try { Get-ClientLogConfiguration-Id $Id # Below is a request that includes all optional parameters # Get-ClientLogConfiguration -Id $Id } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-ClientLogConfiguration" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) ## get-managed-cluster Get a managed cluster by ID. ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- Path | Id | **String** | True | Managed cluster ID. ### Return type [**ManagedCluster**](../models/managed-cluster) ### Responses Code | Description | Data Type ------------- | ------------- | ------------- 200 | Response with managed cluster for the given ID. | ManagedCluster 400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto 401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response 403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto 404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto 429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response 500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto ### HTTP request headers - **Content-Type**: Not defined - **Accept**: application/json ### Example ```powershell $Id = "2c9180897de347a2017de8859e8c5039" # String | Managed cluster ID. # Get Managed Cluster try { Get-ManagedCluster-Id $Id # Below is a request that includes all optional parameters # Get-ManagedCluster -Id $Id } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-ManagedCluster" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) ## get-managed-clusters List current organization's managed clusters, based on request context. ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- Query | Offset | **Int32** | (optional) (default to 0) | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. Query | Limit | **Int32** | (optional) (default to 250) | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. Query | Count | **Boolean** | (optional) (default to $false) | 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](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. Query | Filters | **String** | (optional) | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **operational**: *eq* ### Return type [**ManagedCluster[]**](../models/managed-cluster) ### Responses Code | Description | Data Type ------------- | ------------- | ------------- 200 | Response with a list of managed clusters. | ManagedCluster[] 400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto 401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response 403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto 429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response 500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto ### HTTP request headers - **Content-Type**: Not defined - **Accept**: application/json ### Example ```powershell $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) $Count = $true # 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](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) $Filters = 'operational eq "operation"' # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **operational**: *eq* (optional) # Get Managed Clusters try { Get-ManagedClusters # Below is a request that includes all optional parameters # Get-ManagedClusters -Offset $Offset -Limit $Limit -Count $Count -Filters $Filters } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-ManagedClusters" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) ## put-client-log-configuration Update a managed cluster's log configuration. You may only specify one of `durationMinutes` or `expiration`, up to 1440 minutes (24 hours) in the future. If neither is specified, the default value for `durationMinutes` is 240. ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- Path | Id | **String** | True | ID of the managed cluster to update the log configuration for. Body | PutClientLogConfigurationRequest | [**PutClientLogConfigurationRequest**](../models/put-client-log-configuration-request) | True | Client log configuration for the given managed cluster. ### Return type [**ClientLogConfiguration**](../models/client-log-configuration) ### Responses Code | Description | Data Type ------------- | ------------- | ------------- 200 | Response with updated client log configuration for the given managed cluster. | ClientLogConfiguration 400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto 401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response 403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto 404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto 429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response 500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json ### Example ```powershell $Id = "2b838de9-db9b-abcf-e646-d4f274ad4238" # String | ID of the managed cluster to update the log configuration for. $PutClientLogConfigurationRequest = @""@ # Update Managed Cluster Log Configuration try { $Result = ConvertFrom-JsonToPutClientLogConfigurationRequest -Json $PutClientLogConfigurationRequest Send-ClientLogConfiguration-Id $Id -PutClientLogConfigurationRequest $Result # Below is a request that includes all optional parameters # Send-ClientLogConfiguration -Id $Id -PutClientLogConfigurationRequest $PutClientLogConfigurationRequest } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-ClientLogConfiguration" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) ## update-managed-cluster Update an existing managed cluster. ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- Path | Id | **String** | True | Managed cluster ID. Body | JsonPatchOperation | [**[]JsonPatchOperation**](../models/json-patch-operation) | True | JSONPatch payload used to update the object. ### Return type [**ManagedCluster**](../models/managed-cluster) ### Responses Code | Description | Data Type ------------- | ------------- | ------------- 200 | Updated managed cluster. | ManagedCluster 400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto 401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response 403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto 404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto 429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response 500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto ### HTTP request headers - **Content-Type**: application/json-patch+json - **Accept**: application/json ### Example ```powershell $Id = "2c9180897de347a2017de8859e8c5039" # String | Managed cluster ID. # JsonPatchOperation[] | JSONPatch payload used to update the object. $JsonPatchOperation = @"{ "op" : "replace", "path" : "/description", "value" : "New description" }"@ # Update Managed Cluster try { $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation Update-ManagedCluster-Id $Id -JsonPatchOperation $Result # Below is a request that includes all optional parameters # Update-ManagedCluster -Id $Id -JsonPatchOperation $JsonPatchOperation } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-ManagedCluster" Write-Host $_.ErrorDetails } ``` [[Back to top]](#)