List Deployments

GET

/deployments

curl --request GET \
  --url 'https://api.mengi.cloud/deployments?skip=0&limit=20'

Parameters

Query Parameters

skip

Skip

integer

0

limit

Limit

integer

default: 20

cluster_id

Any of:

string

string format: uuid

null

null

status

Any of:

DeploymentStatus

DeploymentStatus

string

Allowed values: pending provisioning promoting running stopped failed error migrating deleting

null

null

Responses

200

Successful Response

Media type application/json

DeploymentListResponse

object

deployments

required

Deployments

Array<object>

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

object

key

additional properties

any

null

null

values_yaml

Any of:

string

string

null

null

git_path

Any of:

string

string

null

null

endpoint_url

Any of:

string

string

null

null

error_message

Any of:

string

string

null

null

cpu_request

Any of:

number

number

null

null

memory_request_mb

Any of:

integer

integer

null

null

replicas

Any of:

integer

integer

null

null

container_port

Any of:

integer

integer

null

null

storage_size_gb

Any of:

integer

integer

null

null

deployment_type

Any of:

string

string

null

null

helm_repo_url

Any of:

string

string

null

null

helm_chart_name

Any of:

string

string

null

null

helm_chart_version

Any of:

string

string

null

null

custom_values_yaml

Any of:

string

string

null

null

image_update_strategy

Any of:

string

string

null

null

image_update_constraint

Any of:

string

string

null

null

image_allow_tags

Any of:

string

string

null

null

image_ignore_tags

Any of:

string

string

null

null

is_adopted

Is Adopted

boolean

source_namespace

Any of:

string

string

null

null

created_at

required

Created At

string format: date-time

updated_at

required

Updated At

string format: date-time

provider

Any of:

string

string

null

null

region

Any of:

string

string

null

null

cluster_status

Any of:

string

string

null

null

cluster_error

Any of:

string

string

null

null

total

required

Total

integer

Example

{
  "deployments": [
    {
      "app_type": "web_app",
      "status": "pending",
      "is_adopted": false
    }
  ]
}

422

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"
    }
  ]
}