Get Release Bundle v2 Versions

JFrog REST APIs

Products
JFrog Xray
Content Type
REST API
ft:sourceType
Paligo

Description: Returns a list of versions for a specified Release Bundle v2. Records are provided regardless of status, including failed attempts at creation.

Note

To get a list of versions for a specified Release Bundle v1, see Get Release Bundle v1 Versions.

Since: 7.63.2

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

Usage:GET  /lifecycle/api/v2/release_bundle/records/{name}

Query Parameters (optional):

Field

Type

Description

include {messages|permissions}

string, boolean

Messages: Returns any error messages generated when creating the Release Bundle version.

Permissions: Returns the permission settings for promoting, distributing, and deleting these Release Bundle versions.

offset

integer

Sets the number of records to skip before returning the query response. Used for pagination purposes.

limit

integer

Sets the maximum number of versions to return at one time. Used for pagination purposes.

filter_by

string

Defines a filter for the list of Release Bundle versions. Applies to release_bundle_version and created_by.

order_by {created|created_by|release_bundle_version}

string

Defines the criterion by which to order the list of Release Bundle versions: created, created_by, release_bundle_version

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.

Note

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

Sample Response:

{
    "release_bundles": [
        {
            "status": "FAILED",
            "repository_key": "release-bundles-v2",
            "release_bundle_name": "Commons-Bundle",
            "release_bundle_version": "1.0.1",
            "service_id": "jfrt@01h0nvs1pwjtzs15x7kbtv1sve",
            "created_by": "admin",
            "created": "2023-05-18T11:40:51.848Z",
            "messages": [
                {
                    "source": "System",
                    "text": "Invalid AQL query for Release Bundle creation",
                    "created": "2023-05-18T11:40:51.848Z"
                }
            ],
            "permissions": {
                "promote": true,
                "distribute": true,
                "delete": false
            }
        },
        {
            "status": "COMPLETED",
            "repository_key": "release-bundles-v2",
            "release_bundle_name": "Commons-Bundle",
            "release_bundle_version": "1.0.0",
            "service_id": "jfrt@01h0nvs1pwjtzs15x7kbtv1sve",
            "created_by": "admin",
            "created": "2023-05-18T11:25:35.936Z",
            "messages": [],
            "permissions": {
                "promote": true,
                "distribute": true,
                "delete": false
            }
        }
    ],
    "total": 2,
    "limit": 1000,
    "offset": 0
} 

The response includes the following information:

Property

Description

status

Status of the Release Bundle: PROCESSING, FAILED, COMPLETED, DELETING

created

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

messages

(Optional) Error messages related to the processing of the operation.

permissions

(Optional) Whether the user has permission to promote, distribute, and delete these Release Bundle versions.

Status Codes:

Code

Description

200

Submitted (asynchronous)

401

Bad Credentials

403

Permission Denied

404

Not Found (repository/build)