Skip to content

Get Deployment

GET
/deployments/{deployment_id}
curl --request GET \
--url https://api.mengi.cloud/deployments/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0
deployment_id
required
Deployment Id
string format: uuid

Successful Response

Media type application/json
DeploymentResponse
object
id
required
Id
string format: uuid
user_id
required
User Id
string format: uuid
cluster_id
required
Cluster Id
string format: uuid
name
required
Name
string
app_type
required
AppType
string
Allowed values: web_app api database static_site container helm
status
required
DeploymentStatus
string
Allowed values: pending provisioning promoting running stopped failed error migrating deleting
config
Any of:
object
key
additional properties
any
values_yaml
Any of:
string
git_path
Any of:
string
endpoint_url
Any of:
string
error_message
Any of:
string
cpu_request
Any of:
number
memory_request_mb
Any of:
integer
replicas
Any of:
integer
container_port
Any of:
integer
storage_size_gb
Any of:
integer
deployment_type
Any of:
string
helm_repo_url
Any of:
string
helm_chart_name
Any of:
string
helm_chart_version
Any of:
string
custom_values_yaml
Any of:
string
image_update_strategy
Any of:
string
image_update_constraint
Any of:
string
image_allow_tags
Any of:
string
image_ignore_tags
Any of:
string
is_adopted
Is Adopted
boolean
source_namespace
Any of:
string
created_at
required
Created At
string format: date-time
updated_at
required
Updated At
string format: date-time
provider
Any of:
string
region
Any of:
string
cluster_status
Any of:
string
cluster_error
Any of:
string
Example
{
"app_type": "web_app",
"status": "pending",
"is_adopted": false
}

Validation Error

Media type application/json
HTTPValidationError
object
detail
Detail
Array<object>
ValidationError
object
loc
required
Location
Array
msg
required
Message
string
type
required
Error Type
string
Example generated
{
"detail": [
{
"loc": [
"example"
],
"msg": "example",
"type": "example"
}
]
}