• Apollo
    • Search documentation
    karat

    +

    K

    ReferenceApollo CLIapollo-cli release-channel update [Experimental]

    apollo-cli release-channel update [Experimental]

    This command is Experimental. To enable this command, run the apollo-cli configure command and enable V2 experimental commands.

    Update a release channel's metadata

    Updates a release channel's metadata including description, label requirements, and archive status.

    The command fetches the current channel state to obtain the revision number for optimistic concurrency control.

    Example:

    Update description

    apollo-cli release-channel update MY_CHANNEL --description "New description"

    Set label requirements that must exist (replaces existing)

    apollo-cli release-channel update MY_CHANNEL
    --label-requirement "label1"
    --label-requirement "label2"

    Set label requirements with specific values

    apollo-cli release-channel update MY_CHANNEL
    --label-requirement-value "approval.palantir.build/approved=true"

    Clear all label requirements

    apollo-cli release-channel update MY_CHANNEL --clear-label-requirements

    Archive a channel

    apollo-cli release-channel update MY_CHANNEL --archive --archive-rationale "No longer needed"

    Unarchive a channel

    apollo-cli release-channel update MY_CHANNEL --unarchive

    Use --space-id for omniscient mode

    apollo-cli release-channel update MY_CHANNEL --description "New desc" --space-id my-space-id

    Copied!
    1
apollo-cli release-channel update <channel-name> [flags]

    Flags

    FlagUse
    --archiveArchive the release channel (makes it read-only)
    --archive-rationaleRationale for archiving (required with --archive)
    --clear-label-requirementsRemove all label requirements
    --descriptionUpdate the channel description
    -h, --helpHelp for update
    --label-requirementLabel ID that must exist on product releases (can be specified multiple times)
    --label-requirement-valueLabel ID with required value in format 'labelId=value' (can be specified multiple times)
    --unarchiveUnarchive the release channel

    Flags inherited from parent commands

    FlagUse
    --apollo-client-idClient ID to use for generating Bearer Token
    --apollo-client-secretClient secret to use for generating Bearer Token
    --apollo-tokenBearer Token to use for authenticated endpoints
    --apollo-token-providerSpecifies how the Bearer Token used for authenticated Apollo endpoint calls is provided. Valid values are "auto", "static", or "service-user" (default "auto"). If "auto" is specified, will use either the Bearer Token provided by "apollo-token" or a Bearer Token obtained by using "apollo-client-id" and "apollo-client-secret" to generate a token from Multipass depending on which values are set (but will error if both values are set). If "static" is specified, the token provided by "apollo-token" is used. If "service-user" is specified, "apollo-client-id" and "apollo-client-secret" are used to generate a token from Multipass.
    --apollo-urlBase URL for Apollo that is used to derive the API endpoints
    --debugEnable debug level logging
    -e, --environmentEnvironment ID (including suffix) to use for environment-scoped commands
    --http-timeoutTimeout in minutes for all apollo requests
    -k, --insecure-skip-verifySkip verification of server certificate
    -o, --outputOutput format (json,yaml,pretty)
    --profileUse a specific profile from your configuration file
    --quietDo not print log output to stderr
    --space-idSpace ID to use for certain space-scoped commands

    See also