Promote Release Bundle v2 Version

JFrog REST APIs

Products
JFrog Xray
Content Type
REST API
ft:sourceType
Paligo

Description: Promotes the selected Release Bundle v2 version.

Since: 7.63.2

Security: Requires Read and Promote permissions to the target Release Bundle paths; requires Create permissions to target artifact repository paths.

Usage: POST  /lifecycle/api/v2/promotion/records/{name}/{version}

Query Parameters (optional):

Field

Type

Description

async

boolean

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

Note

See Common Optional Query Parameters for additional query parameters that are available for all Release Lifecycle Management APIs.

Important

If the Release Bundle v2 version belongs to a specific project, you must specify either the repository_key or the project. The repository_key refers to the system repository that contains the Release Bundles related to the project (<project_key>-release_bundles-v2).Projects

Request Header: X-JFrog-Signing-Key-Name (key-pair name to use for signature creation)

Sample Request:

{
    "environment": "QA",
    "included_repository_keys": [],
    "excluded_repository_keys": [],
}

The request includes the following information:

Property

Description

environment

Name of the target environment for the promotion.

included_repository_keys

Defines specific repositories to include in the promotion.

If this property is left undefined, all repositories (except those specifically excluded) are included in the promotion.

Important: If one or more repositories are specifically included, all other repositories are excluded (regardless of what is defined in excluded_repository_keys).

excluded_repository_keys

Defines specific repositories to exclude from the promotion.

Sample Response:

{
    "repository_key": "release-bundles-v2",
    "release_bundle_name": "Commons-Bundle",
    "release_bundle_version": "1.0.0",
    "environment": "QA",
    "included_repository_keys": [
        "commons-qa-generic-local",
        "commons-qa-docker-local",
        "commons-qa-maven-local"
    ],
    "excluded_repository_keys": [],
    "created": "2023-05-19T06:21:44.916Z",
    "created_millis": 1684477304916
}

Additional information included in the response:

Property

Description

created

Timestamp when the new version was created (ISO 8601 standard).

created_millis

Timestamp when the new version was created (in milliseconds).

Status Codes:

Code

Description

200

Submitted (asynchronous)

201

Promoted (synchronous)

400

Bad Request

404

Not Found

409

Already Exists