v1

latestOpenAPI 3.0.02026-07-14169306521.0 KB
enterprisePortal

Get update instructions

Generates step-by-step instructions for updating an installation to a specific target version. Supports both Helm and Linux (Embedded Cluster) installation types. The update instructions will use upgrade/update commands instead of install commands, and are tailored to the network and registry availability configuration from the original install options.

get/app/{app_id}/enterprise-portal/install-options/{option_id}/update-instructions

Path parameters

app_idstring required

App identifier

option_idstring required

The ID for a customer install options record

Query parameters

targetChannelIdstring required

Target channel ID for the update

targetChannelSequenceinteger required

Target channel sequence for the update

Response

GetUpdateInstructionsResponse contains the response from getting update instructions.

formatstring

Version format ("basic")

install_typestring

Installation type ("linux" or "helm")

titlestring

Overall installation title