Update Draft Release Bundle v2 Content

JFrog REST APIs

Content Type
REST API

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

repository_key

string

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

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

async

boolean

Determines whether the operation should be asynchronous (true) or synchronous (false).

The default value is true, which means that Artifactory does not wait for Release Bundle creation to complete before allowing you to move on to the next task.

fail_fast

boolean

Determines whether the creation operation stops immediately when a validation error occurs:

  • true: [default] The Release Bundle creation operation stops immediately when a validation error occurs.

  • false: The Release Bundle creation operation will continue even if validation errors occur. After the operation fails, supported errors are returned as a group to the operator. This option is useful for debugging purposes.

Note

For details about supported errors, see Release Bundle v2 Creation Errors Collected by System.

Request Body:

Parameter

Required

Type

Description

release_bundle_name

required

string

The Release Bundle name.

release_bundle_version

required

string

The Release Bundle version.

add_sources

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.

filters

optional

object

Defines sources to include or exclude in the Release Bundle version. Filters are used for Release Bundle patching.

filters.included

optional

array:object

If defined, only those artifacts/packages from the defined sources that match the filter are included in the Release Bundle version.

  • For artifacts: At least one field (path or sha256) must be specified.

  • For packages: At least one field (package_type, package_name, or package_version) must be specified.

A single * can be used as a wildcard at the beginning or the end of the string. Each string is limited to 255 characters. Each request can have a maximum of 50 filter objects.

Regular expressions and character classes are not supported.

filters.excluded

optional

array:object

If defined, only those artifacts/packages from the defined sources that match the filter are excluded from the Release Bundle version.

  • For artifacts: At least one field (path or sha256) must be specified.

  • For packages: At least one field (package_type, package_name, or package_version) must be specified.

A single * can be used as a wildcard at the beginning or the end of the string. Each string is limited to 255 characters. Each request can have a maximum of 50 filter objects.

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

repository_key

string

The repository key (by default, <project>-release-bundles-v2).

release_bundle_name

string

The Release Bundle name.

release_bundle_version

string

The Release Bundle version.

draft

boolean

Will always return true to indicate you have updated a draft Release Bundle version.

updated

time

The timestamp when the Release Bundle was updated (ISO 8601 format).

added_artifacts_count

integer

The number of artifacts that were added in this update.

Note: Relevant only when working in sync mode (async=false).

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.