Patches an app channel.

patch

https://api.replicated.com/vendor/v3/app/{app_id}/channel/{channel_id}

Allow partial updates to a channel's properties. Only the fields provided in the request body will be updated.

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

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

app_id

string

required

App identifier

channel_id

string

required

Channel identifier

Body Params

Channel patch parameters.

airgapDiffBundlesEnabled

boolean

AirgapDiffBundlesEnabled will allow building diff airgap bundles for the channel.

airgapDockerRegistryFormatEnabled

boolean

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

allowPublishableKey

boolean

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

buildAirgapAutomatically

boolean

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

channelIcon

string

Icon of the channel that is to be updated.

customHostnameOverrides

object

description

string

Description of the channel that is to be updated.

isDefault

boolean

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

name

string

Name of the channel that is to be updated.

semverRequired

boolean

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

Responses

Language

Credentials

Header

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200GetChannelResponse represents a channel.

400Returned on bad input

401Return if the caller is not authorized

403Returned if the caller does not have the needed permission