deployments

Create App Hosting Deployment

Create a deployment on App Hosting infrastructure.

Each App Hosting deployment gets its own vCluster running on the shared host cluster infrastructure. This provides isolated Kubernetes environments with minimal resource overhead.

This will:

  1. Pick the best available location for the geographic region
  2. Create a vCluster (tier=SHARED) for this deployment
  3. Trigger app-hosting job to provision vCluster + deploy the app
post/deployments/app-hosting

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/app-hosting
  • Auth: none declared

Request body

geographic_regionstring required
deployment_namestring required
app_typestring
configobject nullable
cpu_requestnumber nullable
memory_request_mbinteger nullable
replicasinteger nullable
container_portinteger nullable
docker_imagestring nullable
storage_size_gbinteger nullable
run_as_uidinteger 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
kubernetes_versionstring 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

No recorded changes to this operation across all 2 revisions of this API.