Skip to main content
PUT
Upgrade Instance

Headers

Content-Type
string
required

Allowed value: application/json.

Authorization
string
required

Bearer authentication format, e.g.: Bearer {{API_KEY}}.

Path Parameters

instance_id
string
required

Instance ID. String, length: 1-255 characters.

Body

application/json
image
string
required

Image address. String, length: 1-500 characters.

Example:

"registry.example.com/namespace/new-image:tag"

registry_auth_id
string

Saved registry authentication ID. String, length: 0-255 characters.

Example:

"registry-auth-id"

entrypoint
string

Container entrypoint.

Example:

""

command
string

Container startup command.

Example:

""

envs
object[]

Environment variable list.

save_data
boolean

Whether to keep existing data when upgrading or resetting the instance.

Example:

true

Response

200 - application/json

OK

The response is of type object.

Last modified on June 26, 2026