deployments

Update Deployment

Update a deployment's configuration.

Changes will regenerate the values.yaml and queue a worker job to sync to Git, triggering ArgoCD to redeploy with the new configuration.

Service principal (X-Service-Token) may update any deployment — internal tooling uses this same public endpoint per the dogfood principle (e.g. ops migrations of env secret_refs).

patch/api/v1/deployments/{deployment_id}

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/api/v1/deployments/{deployment_id}
  • Auth: none declared

Path parameters

deployment_idstring uuid required

Request body

namestring nullable
configobject nullable
cpu_requestnumber nullable
memory_request_mbinteger nullable
replicasinteger nullable
container_portinteger nullable
storage_size_gbinteger nullable
docker_imagestring 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
custom_domainstring nullable
failover_health_routeboolean nullable
commandstring[] nullable
argsstring[] 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 1 revision of this API.