Create Cluster

POST

/clusters

curl --request POST \
  --url https://api.mengi.cloud/clusters \
  --header 'Content-Type: application/json' \
  --data '{ "name": "example", "provider": "example", "region": "example", "geographic_region": "example", "tier": "shared", "server_type": "example", "kubernetes_version": "example", "component_bundle_version": "latest", "autoscaling_enabled": false, "min_nodes": 1, "max_nodes": 1, "multi_region": false, "region_locations": [ "example" ], "use_byoc": false, "cloud_credential_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0" }'

Create a new Kubernetes cluster.

Request Body ^required

Media type application/json

ClusterCreate

object

name

required

Name

string

provider

Any of:

string

string

null

null

region

Any of:

string

string

null

null

geographic_region

Any of:

string

string

null

null

tier

ClusterTier

string

default: testing

Allowed values: shared testing production

server_type

Any of:

string

string

null

null

kubernetes_version

Any of:

string

string

null

null

component_bundle_version

Component Bundle Version

string

default: latest

autoscaling_enabled

Autoscaling Enabled

boolean

min_nodes

Any of:

integer

integer

>= 1 <= 100

null

null

max_nodes

Any of:

integer

integer

>= 1 <= 100

null

null

multi_region

Multi Region

boolean

region_locations

Any of:

Array<string>

Array<string>

null

null

use_byoc

Use Byoc

boolean

cloud_credential_id

Any of:

string

string format: uuid

null

null

Responses

200

Successful Response

Media type application/json

ClusterResponse

object

id

required

Id

string format: uuid

name

required

Name

string

provider

required

Provider

string

region

required

Region

string

tier

required

ClusterTier

string

Allowed values: shared testing production

status

required

ClusterStatus

string

Allowed values: pending provisioning importing running upgrading error deleting

kubernetes_version

Any of:

string

string

null

null

server_type

Any of:

string

string

null

null

argocd_url

Any of:

string

string

null

null

git_repo_url

Any of:

string

string

null

null

error_message

Any of:

string

string

null

null

status_message

Any of:

string

string

null

null

created_at

required

Created At

string format: date-time

updated_at

required

Updated At

string format: date-time

provisioning_started_at

Any of:

string

string format: date-time

null

null

provisioning_completed_at

Any of:

string

string format: date-time

null

null

autoscaling_enabled

Autoscaling Enabled

boolean

min_nodes

Any of:

integer

integer

null

null

max_nodes

Any of:

integer

integer

null

null

target_kubernetes_version

Any of:

string

string

null

null

upgrade_available

Upgrade Available

boolean

upgrade_available_version

Any of:

string

string

null

null

scheduled_upgrade_date

Any of:

string

string format: date-time

null

null

scheduled_upgrade_id

Any of:

string

string format: uuid

null

null

component_bundle_version

Component Bundle Version

string

default: latest

multi_region

Multi Region

boolean

region_locations

Any of:

Array<string>

Array<string>

null

null

is_byoc

Is Byoc

boolean

cloud_credential_id

Any of:

string

string format: uuid

null

null

is_imported

Is Imported

boolean

is_autopilot

Is Autopilot

boolean

display_order

Any of:

integer

integer

null

null

Example

{
  "tier": "shared",
  "status": "pending",
  "autoscaling_enabled": false,
  "upgrade_available": false,
  "component_bundle_version": "latest",
  "multi_region": false,
  "is_byoc": false,
  "is_imported": false,
  "is_autopilot": 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"
    }
  ]
}