channels

Creates a channel in the KOTS application.

Changed on

Create a new channel for the specified app, allowing for configuration of channel properties such as name, description, and feature flags.

Required RBAC Policy: kots/app/[:appid]/channel/create

post/app/{app_id}/channel

Request

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

Path parameters

app_idstring required

App 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

ChannelIcon icon of the channel that is to be created.

descriptionstring

Description of the channel that is to be created.

enterprisePartnerChannelIDstring

Enterprise Partner Channel Id to be added to channel.

isDefaultboolean

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

namestring required
semverRequiredboolean

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

Response

GetChannelResponse represents a channel.

Changes

    • info

      added the new optional request property

    • info

      added the new optional 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