Description: Updates the contents of the specified draft Release Bundle v2 version.
Since: 7.136.0
Security: Requires Read permissions for the Release Bundles; requires Deploy/Cache permissions to target artifact repository paths.
Usage: PATCH /lifecycle/api/v2/release_bundle
Consumes: application/json
Query Parameters (optional):
Parameter | Type | Description |
|---|---|---|
| string | Release Bundles repository identifier that identifies where a Release Bundle version resides. If this parameter and the |
| string | Project key used to determine the Release Bundles repository. By convention, each project may contain only one Release Bundles system repository with the name ImportantYou must specify either the |
| boolean | Determines whether the operation should be asynchronous ( The default value is |
| boolean | Determines whether the creation operation stops immediately when a validation error occurs:
NoteFor details about supported errors, see Release Bundle v2 Creation Errors Collected by System. |
Request Body:
Parameter | Required | Type | Description |
|---|---|---|---|
| required | string | The Release Bundle name. |
| required | string | The Release Bundle version. |
| required | array | The artifacts, packages, builds, and Release Bundles to add to this draft Release Bundle version. For more information about Release Bundle sources, see Create Release Bundle v2 Version. |
| optional | object | Defines sources to include or exclude in the Release Bundle version. Filters are used for Release Bundle patching. |
| optional | array:object | If defined, only those artifacts/packages from the defined
A single Regular expressions and character classes are not supported. |
| optional | array:object | If defined, only those artifacts/packages from the defined
A single Regular expressions and character classes are not supported. |
Warning
Both include and exclude filters can be used in the same request, but an error is generated If there is a conflict between them.
Response Body:
Parameter | Type | Description |
|---|---|---|
| string | The repository key (by default, |
| string | The Release Bundle name. |
| string | The Release Bundle version. |
| boolean | Will always return |
| time | The timestamp when the Release Bundle was updated (ISO 8601 format). |
| integer | The number of artifacts that were added in this update. Note: Relevant only when working in sync mode ( |
Sample Request:
{
"release_bundle_name": "Tomact-Bundle",
"release_bundle_version": "1.0.0-snapshot",
"add_sources": [],
"filters": {
"included": [],
"excluded": []
}
}Sample Response:
{
"repository_key": "release-bundles-v2",
"release_bundle_name": "BundleTest-183",
"release_bundle_version": "1.0.0",
"draft": true,
"updated": "2026-01-18T08:35:48.683Z",
"added_artifacts_count": 5
}Status Codes:
Code | Meaning | Description |
|---|---|---|
200 | Ok | The Release Bundle version was updated successfully. |
400 | Bad Request | The request body is malformed, a required parameter is missing, or the AQL is invalid. |
401 | Bad Credentials | Authentication failed. A valid token is required. |
403 | Permission Denied | The Release Bundle version is locked (that is, not a draft) or the user does not have write permissions for the target repository. |
404 | Not Found | The Release Bundle could not be found. |