Get Release Bundle v2 Versions

Description: Returns a list of versions for a specified Release Bundle v2. Records are provided regardless of status, including failed attempts at creation. You can filter the results based on version, creator, tags, status, and where they have been promoted.

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}

Path Parameter (required):

Parameter	Type	Description
`name`	string	The name of the Release Bundle.

Query Parameters (optional):

Parameter	Type	Description
`repository_key`	string	The Release Bundles repository identifier that identifies where a Release Bundle version resides. If this parameter and the `project` query parameter are not specified, the default value of `release-bundles-v2` is assumed.
`project`	string	The project key used to determine the Release Bundles repository. By convention, each project may contain only one Release Bundles system repository with the name `<project-key>-release-bundles-v2`. This query parameter may be used instead of `repository_key`. Important You must specify either the `repository_key` or the `project` when performing an operation (for example, promotion or distribution) on a Release Bundle v2 that belongs to a specific project.Projects
`include {messages\|permissions}`	string	Adds details to the response: `messages`: Returns any error messages generated when creating the Release Bundle version. `permissions`: Returns user permissions for these versions.
`offset`	integer	Sets the number of records to skip for pagination.
`limit`	integer	Sets the maximum number of versions to return at one time. Used for pagination purposes. The default value is `25`. The maximum value is `255`.
`filter_by`	string	Defines a filter for the list of Release Bundle versions. You can filter according to `release_bundle_version` and `created_by`. Warning This parameter has been replaced with new filters, as described below, and will be deprecated in a future version.
`release_bundle_version`	array	Filters by the Release Bundle version. Supports a trailing wildcard (*) for prefix searching and multiple comma-separated values.
`created_by`	string	Filters by the user who created the Release Bundle.
`release_status`	string	Filters by the release status of the Release Bundle: `pre_release` `released` Supports multiple comma-separated values.
`tag`	array	Filters by the assigned Release Bundle tag. Supports a trailing wildcard (*) and multiple comma-separated values.
`order_by`	string	Defines the sort criterion for the Release Bundle versions: `created`: Sorts by the Release Bundle version creation timestamp. `created_by`: Sorts by the name of the user who created the Release Bundle version. `release_bundle_name`: Sorts by the Release Bundle name. `release_bundle_version`: Sorts by Release Bundle versions sorted lexicographically. `release_bundle_semver`: Sorts by Release Bundle versions using SemVer rules. (Versions that do not conform to SemVer rules are added to the end sorted lexicographically.) Note The `release_bundle_semver` option pulls the latest 1000 records only and does not support pagination. When this option is selected, the `offset` must be set to 0, and the maximum `limit` is 1000.
`order_asc {true\|false}`	boolean	Defines the sort order: `true`: ascending order `false`: descending order The default value is `false`.

Response Parameters:

Parameter	Type	Description
`status`	string	Status of the Release Bundle: STARTED, FAILED, COMPLETED, DELETING
`release_bundle_name`	string	The name of the Release Bundle.
`release_bundle_version`	string	The Release Bundle version.
`service_id`	string	The unique identifier of the Artifactory instance where the Release Bundle version was created.
`release_status`	string	Indicates whether the Release Bundle has been promoted successfully to the official release stage (PROD), making it available for consumption. Possible values are `pre_release` and `released` Note Requires release 7.120.1 or above.
`current_environment`	string	Indicates the most recent environment (for example, QA, Staging) to which the Release Bundle version was promoted successfully. If the version has not yet been promoted, this value will be an empty string. Note Requires release 7.120.1 or above.
`created_by`		The name of the user who created the Release Bundle. Note Names longer than 64 characters will appear truncated.
`created`		Timestamp when the new version was created (ISO 8601 format).
`tag`		The descriptive tag assigned to the Release Bundle version, if any.
`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.

Click here for examples of different responses.

Status Codes:

Code	Meaning	Description
200	Submitted (asynchronous)	The request was successful.
401	Bad Credentials	The provided authentication is invalid.
403	Permission Denied	The user does not have the necessary permissions to perform this action.
404	Not Found	The specified Release Bundle name does not exist.

Note

Important

Warning

Note

Note

Note

Note