clusters

Register a new cluster

post/clusters

Request

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

Request body

clusterNamestring

descriptionstring

clusterType'AKS' | 'EKS' | 'GKE' | 'OpenShift' | 'Kubernetes'

Cluster type, GKE type is applicable only for Connected clusters.

deployMode'Standalone' | 'Connected'

apiServerURLstring

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

tokenstring

Token for API access the cluster. Required 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. Required only for Standalone mode clusters.

enableLogging'Yes' | 'No'

enableMonitoring'Yes' | 'No'

registryOciURLstring

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

Response

Cluster information

clusterIdstring