Skip to main content
POST
Upgrade Instance

API Description

When upgrading an instance, all parameters must be provided in full.

Request Headers

string
required
Enum: application/json
string
required
Bearer authentication format, for example: Bearer {{API Key}}.

Request Body

string
required
The ID of the instance to be upgraded.
string
required
Container image URL. String, length limit: 1-500 characters.
string
Image registry authentication ID.
object[]
required
Instance environment variables. Up to 100 environment variable pairs can be created.
string
required
Container startup command. String, length limit: 0-2047 characters.
string
required
Container startup entrypoint. This setting will override the Docker image’s ENTRYPOINT. String, length limit: 0-2047 characters.
boolean
required
Whether to retain data from the previous instance. Boolean, values: true or false.
object
required
Configure cloud storage (type: network). Each instance supports mounting up to 30 cloud storage volumes. To remove all cloud storage mounts, set volumeMounts to an empty array: [].
Last modified on December 24, 2025