Get Release Bundle v2 Version Promotions with a Specific Artifact

JFrog REST APIs

Content Type
REST API
ft:sourceType
Paligo

Description: Returns a list of promoted Release Bundle v2 versions that contain the specified artifact.

Since: 7.106.2

Security: Requires Read permissions to the target Release Bundle path.

Usage: GET /lifecycle/api/v2/promotion/{{repository_path}}

Path Parameters:

Field

Type

Description

repository_path

string

The full path of the artifact to search for.

Query Parameters (optional):

Field

Type

Description

project

string

Defines the project associated with the Release Bundles. If this parameter is not specified, the default global project is assumed.Projects

order_by

string

Defines the criterion by which to order the returned records: release_bundle_name, release_bundle_version, environment, created_by

The default is created_by.

order_asc {true|false}

boolean

Defines whether to list the Release Bundle versions in ascending (true) or descending (false) order.

The default value is false.

offset

integer

Sets the number of records to skip before returning the query response. Used for pagination purposes. The default value is 0.

limit

integer

Sets the maximum number of records to return at one time. Used for pagination purposes. The default value is 100. The maximum valid value is 1000.

Sample Request:

curl --location 'http://localhost:8082/lifecycle/api/v2/promotion/commons-dev-generic-local/commons-1.0.0.txt?limit=3&offset=3' \
--header 'Authorization: Bearer *********'

Sample Response:

 "promotions": [
        {
            "repository_key": "release-bundles-v2",
            "release_bundle_name": "ccc",
            "release_bundle_version": "1.0.0",
            "environment": "DEV",
            "created": "2025-01-19T11:02:43.536Z",
            "created_millis": 1737284563536,
            "created_by": "admin",
            "project_key": "default"
        },
        {
            "repository_key": "release-bundles-v2",
            "release_bundle_name": "bbb",
            "release_bundle_version": "1.0.2",
            "environment": "DEV",
            "created": "2025-01-19T10:52:30.901Z",
            "created_millis": 1737283950901,
            "created_by": "admin",
            "project_key": "default"
        },
        {
            "repository_key": "release-bundles-v2",
            "release_bundle_name": "aaa",
            "release_bundle_version": "1.0.3",
            "environment": "DEV",
            "created": "2025-01-19T10:51:53.394Z",
            "created_millis": 1737283913394,
            "created_by": "admin",
            "project_key": "default"
        }
    ],
    "offset": 3 

The response includes the following information:

Property

Description

repository_key

The repository that contains the Release Bundle version. The default value is release-bundles-v2. If a project was specified, the name of the project is appended to the beginning of the repository name.

release_bundle_name

The Release Bundle name.

release_bundle_version

The Release Bundle version.

environment

The target environment to which the Release Bundle version was promoted.

created

The timestamp of the promotion (ISO 8601 standard).

created_millis

The timestamp of the promotion in milliseconds.

created_by

The user who initiated the promotion operation.

project_key

The project associated with the Release Bundle version.

Note

The response is limited to a maximum of 1000 records at a time.

Status Codes:

Code

Description

200

Fetched

400

Bad Request (no criteria specified)

403

Permission Denied

Note

This API returns 200 with an empty body, if:

  • The artifact isn't a part of any Release Bundle v2 version.

  • The artifact is part of a Release Bundle v2 version that has not been promoted.

  • The user does not have permission to see the relevant Release Bundle v2 version.

{
    "promotions": [],
    "offset": 0
}