Skip to content
Mengi Cloud Mengi Cloud Docs

Request Upgrade

POST
/clusters/{cluster_id}/upgrades/request
 
curl --request POST \
  --url https://api.mengi.cloud/clusters/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/upgrades/request \
  --header 'Content-Type: application/json' \
  --data '{ "to_version": "example", "upgrade_notes": "example" }'

Request a Kubernetes version upgrade for the cluster. Creates a pending upgrade request that requires approval.

Parameters

Section titled “ Parameters ”

Path Parameters

Section titled “Path Parameters ”
cluster_id
required
Cluster Id
string format: uuid

Request Body required

Section titled “Request Body required ”
Media type application/json
UpgradeRequestCreate

Request to upgrade a cluster’s Kubernetes version.

object
to_version
required
To Version
string
upgrade_notes
Any of:
string
Example generated
{
  "to_version": "example",
  "upgrade_notes": "example"
}

Responses

Section titled “ Responses ”

200

Section titled “200 ”

Successful Response

Media type application/json
UpgradeRequestResponse

Response schema for an upgrade request.

object
id
required
Id
string format: uuid
cluster_id
required
Cluster Id
string format: uuid
from_version
required
From Version
string
to_version
required
To Version
string
status
required
Status
string
requested_at
required
Requested At
string format: date-time
approved_at
Any of:
string format: date-time
started_at
Any of:
string format: date-time
completed_at
Any of:
string format: date-time
error_message
Any of:
string
upgrade_notes
Any of:
string
scheduled_date
Any of:
string format: date-time
is_auto_scheduled
Is Auto Scheduled
boolean
Example 
{
  "is_auto_scheduled": false
}

422

Section titled “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"
    }
  ]
}