Skip to content

Cancel Upgrade

POST
/clusters/{cluster_id}/upgrades/{upgrade_id}/cancel
curl --request POST \
--url https://api.mengi.cloud/clusters/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/upgrades/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/cancel

Cancel a pending upgrade request. Cannot cancel upgrades that are already in progress.

cluster_id
required
Cluster Id
string format: uuid
upgrade_id
required
Upgrade Id
string format: uuid

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
}

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