releases

Promote a release.

Changed on

Promote a specific release to one or more channels, making it available for deployment. Supports setting release notes, version labels, and marking releases as required.

Required RBAC Policy: kots/app/[:appid]/channel/[:channelid]/promote

post/app/{app_id}/release/{sequence}/promote

Request

  • Base URL
    https://api.replicated.com/vendor/v3
  • URL
    https://api.replicated.com/vendor/v3/app/{app_id}/release/{sequence}/promote
  • Auth
    API key in header Authorization

Path parameters

app_idstring required

App identifier

sequenceinteger required

Release identifier

Request body

channelIdsstring[]
ignoreWarningsboolean
isRequiredboolean
notifyUsersboolean

Sends email notifications to all Enterprise Portal users on the target channel

omitDetailsInResponseboolean

Omits channels, charts, and compatibilityResults details in the response body

releaseNotesstring
releaseNotesGzipinteger[]
versionLabelstring

Response

PromoteReleaseResponse contains the release properties.

AirgapBuilds field semantics: Body.AirgapBuilds (top-level) — one entry per channel JUST promoted to by THIS call. Populated for every promoted channel, not just auto-build ones, because the airgap-builder runs metadata generation for every promoted channel-release and that step can fail. Each entry's FullAirgapBuild bool distinguishes channels that produce a full bundle (auto-build on) from those that only get metadata generation (auto-build off). CLI / GitHub Action waiters should poll these. Body.Release.AirgapBuilds (nested) — the FULL history of channel-releases for this release sequence (including prior re-promotes to the same channel). Use for inspect / history views, not for waiting on the current promote.

warningsstring[]

Changes

    • info

      added the optional property to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property /// to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property /// to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property /// to the response with the status

    • info

      added the optional property ///// to the response with the status

    • info

      added the optional property ///// to the response with the status

    • info

      added the optional property ///// to the response with the status

    • info

      added the optional property ///// to the response with the status

    • info

      added the optional property ///// to the response with the status

    • info

      added the optional property ///// to the response with the status

    • info

      added the optional property ///// to the response with the status

    • info

      added the optional property ///// to the response with the status

    • info

      added the optional property ///// to the response with the status

    • info

      added the optional property ///// to the response with the status

    • info

      added the optional property ///// to the response with the status

    • info

      added the optional property ///// to the response with the status

    • info

      added the optional property ///// to the response with the status

    • info

      added the optional property ///// to the response with the status

    • info

      added the optional property ///// to the response with the status

    • info

      added the optional property ///// to the response with the status

    • info

      added the optional property ///// to the response with the status

    • info

      added the optional property ///// to the response with the status

    • info

      added the optional property //// to the response with the status

    • info

      added the optional property //// to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property /// to the response with the status

    • info

      added the optional property ///// to the response with the status

    • info

      added the optional property /// to the response with the status

    • info

      added the optional property ///// to the response with the status

    • info

      added the optional property /// to the response with the status

    • info

      added the optional property /// to the response with the status

    • info

      added the optional property ///// to the response with the status

    • info

      added the optional property /////// to the response with the status

    • info

      added the optional property /////// to the response with the status

    • info

      added the optional property /////// to the response with the status

    • info

      added the optional property /////// to the response with the status

    • info

      added the optional property /////// to the response with the status

    • info

      added the optional property /////// to the response with the status

    • info

      added the optional property /////// to the response with the status

    • info

      added the optional property /////// to the response with the status

    • info

      added the optional property /////// to the response with the status

    • info

      added the optional property /////// to the response with the status

    • info

      added the optional property /////// to the response with the status

    • info

      added the optional property /////// to the response with the status

    • info

      added the optional property /////// to the response with the status

    • info

      added the optional property /////// to the response with the status

    • info

      added the optional property /////// to the response with the status

    • info

      added the optional property /////// to the response with the status

    • info

      added the optional property /////// to the response with the status

    • info

      added the optional property /////// to the response with the status

    • info

      added the optional property ////// to the response with the status

    • info

      added the optional property ////// to the response with the status

    • info

      added the optional property /// to the response with the status

    • info

      added the optional property /// to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property to the response with the status