deployments

Create Deployment With Cluster

Changed on

Create a new cluster and deployment in one transaction.

post/deployments/with-cluster

Request

  • Base URL: https://api.mengi.cloud (the document declares no server; this is the origin it was published from)
  • URL: https://api.mengi.cloud/deployments/with-cluster
  • Auth: none declared

Request body

cluster_namestring required
providerstring required
regionstring required
tier'shared' | 'dedicated' | 'production'
server_typestring nullable
deployment_namestring required
app_typestring
configobject nullable
cpu_requestnumber nullable
memory_request_mbinteger nullable
replicasinteger nullable
container_portinteger nullable
storage_size_gbinteger nullable
run_as_uidinteger nullable
docker_imagestring nullable
deployment_typestring
helm_repo_urlstring nullable
helm_chart_namestring nullable
helm_chart_versionstring nullable
custom_values_yamlstring nullable
image_update_strategystring nullable
image_update_constraintstring nullable
image_allow_tagsstring nullable
image_ignore_tagsstring nullable
helm_ingress_valuesboolean nullable

Response

Successful Response

idstring uuid required
user_idstring uuid required
organization_idstring uuid nullable
cluster_idstring uuid required
namestring required
app_type'web_app' | 'api' | 'database' | 'static_site' | 'container' | 'helm' required
status'pending' | 'provisioning' | 'promoting' | 'running' | 'stopped' | 'failed' | 'error' | 'migrating' | 'deleting' required
configobject nullable
values_yamlstring nullable
git_pathstring nullable
endpoint_urlstring nullable
error_messagestring nullable
cpu_requestnumber nullable
memory_request_mbinteger nullable
replicasinteger nullable
container_portinteger nullable
storage_size_gbinteger nullable
commandstring[] nullable
argsstring[] nullable
deployment_typestring nullable
helm_repo_urlstring nullable
helm_chart_namestring nullable
helm_chart_versionstring nullable
custom_values_yamlstring nullable
image_update_strategystring nullable
image_update_constraintstring nullable
image_allow_tagsstring nullable
image_ignore_tagsstring nullable
is_adoptedboolean
source_namespacestring nullable
created_atstring date-time required
updated_atstring date-time required
providerstring nullable
regionstring nullable
cluster_statusstring nullable
cluster_errorstring nullable

Changes