MEmendix
clusters

Retrieve cluster by id

Retrieve cluster by id

get/clusters/{clusterId}

Request

  • Base URL
    https://pmp-demo.privateplatform.mendix.com/clusterservice/v1
  • Auth
    • HTTP basic
    • or API key in header Authorization

Path parameters

clusterIdstring required

Cluster Id

Response

Cluster information

clusterIdstring
clusterNamestring
descriptionstring
clusterType'AKS' | 'EKS' | 'GKE' | 'OpenShift' | 'Kubernetes'
deployMode'Standalone' | 'Connected'
apiServerURLstring

API server URL of the cluster. Applicable only for Standalone mode clusters.

tokenstring

Token for API token for access the cluster. Applicable only for Standalone mode clusters.

secretSource'AWS' | 'DB' | 'AZURE' | 'HASHICORP'

Secret source for API token for access the cluster. Required only for Standalone mode clusters. AWS is AWS Secrets Manager, DB is Database, AZURE is Azure Key Vault, HASHICORP is HashiCorp Vault.

secretNamestring

Secret name for API token for access the cluster. Applicable only for Standalone mode clusters.

enableLogging'Yes' | 'No'
enableMonitoring'Yes' | 'No'
registryOciURLstring

OCI URL for the container registry. Optional only for Standalone mode clusters.

Changes

No recorded changes to this operation across all 1 revision of this API.