Promote Release Bundle v2 Version

post

https://{jfrog_url}/lifecycle/api/v2/promotion/records/{name}/{version}

Promotes the selected Release Bundle v2 version to a target environment or stage. You can choose to copy or move the artifacts to the target repository.

Security: Requires Read and Promote permissions for the Release Bundles; requires Deploy/Cache permissions to target artifact repository paths.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

name

string

required

length ≥ 1

^\w[\w\-.]*$

Release bundle name

version

string

required

length ≥ 1

^\w[\w\-.+]*$

Release bundle version

Query Params

async

boolean

Defaults to true

Determines whether the operation should be asynchronous (true) or synchronous (false). The default value is true.

operation

string

enum

Defaults to copy

Determines how to perform the promotion. 'copy' copies contents to target repository (default). 'move' moves contents from last promotion repository to target repository.

Allowed:

project

string

The project key used to determine the Release Bundles repository

repository_key

string

The Release Bundles repository identifier

Body Params

Promotion configuration including the target environment/stage, repository filters, and overwrite strategy.

environment

string

Name of the target environment for the promotion (deprecated, use stage instead)

stage

string

Name of the target environment/stage for the promotion

included_repository_keys

array of strings

Defines specific repositories to include in the promotion. If left undefined, all repositories (except those specifically excluded) are included.

included_repository_keys

excluded_repository_keys

array of strings

Defines specific repositories to exclude from the promotion

excluded_repository_keys

included_source_paths

array of strings

Defines specific source paths to include in the promotion

included_source_paths

excluded_source_paths

array of strings

Defines specific source paths to exclude from the promotion

excluded_source_paths

overwrite_strategy

string

enum

Defaults to disabled

Specifies the strategy for overwriting artifacts when a promotion would overwrite a file that is not part of the release bundle. disabled - (default) The promotion will fail if an artifact can't be overwritten. all - The promotion will overwrite the artifact regardless it's tag. latest - The promotion will overwrite the artifact only if the artifact has tag latest.

Allowed:

artifact_additional_properties

array of objects

Key-value pairs that define properties to add to each promoted artifact on top of any existing properties

artifact_additional_properties

promotion_authorization_type

string

enum

Defaults to undefined

Type of promotion authorization

Allowed:

Responses

Language

Credentials

Bearer

JWT

URL

Loading…

Response

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

application/json

200Submitted (asynchronous) - The request to promote the Release Bundle version was submitted successfully.

201Promoted (synchronous) - The Release Bundle version was promoted successfully.

400Bad Request - The request was malformed.

401Bad Credentials - Authentication failed.

403Permission Denied - The user does not have the necessary permissions.

404Not Found - The Release Bundle name or version does not exist.

409Conflict - Can occur when trying to promote when another promotion is in progress, or when artifact already exists at target with different checksum.