channels

Updates an app channel.

Changed on

Update the properties of an existing channel, such as its name, description, and feature flags. All properties must be provided in the request body.

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

put/app/{app_id}/channel/{channel_id}

Request

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

Path parameters

app_idstring required

App identifier

channel_idstring required

Channel identifier

Request body

airgapDiffBundlesEnabledboolean

AirgapDiffBundlesEnabled will allow building diff airgap bundles for the channel.

airgapDockerRegistryFormatEnabledboolean

AirgapDockerRegistryFormatEnabled airgap bundles built after enabling this will use the Docker Registry format.

allowPublishableKeyboolean

AllowPublishableKey when enabled, allows customers to use publishable keys to create customer records and sign up for this channel through the SDK

buildAirgapAutomaticallyboolean

BuildAirgapAutomatically when enabled, automatically creates air gap builds for newly promoted releases in this channel.

channelIconstring

Icon of the channel that is to be updated.

descriptionstring

Description of the channel that is to be updated.

isDefaultboolean

IsDefault indicates if this channel is the default channel for the application.

namestring required

Name of the channel that is to be updated.

semverRequiredboolean

SemverRequired when enabled, will cause an error when non semver values are used for new releases

Response

GetChannelResponse represents a channel.

Changes

    • warning

      removed the request property

    • info

      added the new optional request property

    • info

      added the new optional request property

    • 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