Create Release Bundle v2 Version

JFrog REST APIs

Content Type
REST API
ft:sourceType
Paligo

Description: Creates a new Release Bundle v2, uniquely identified by a combination of repository key, name, and version. For more information, see Understanding Release Bundles v2.Understanding Release Bundles v2

You can create a Release Bundle version using one or a combination of the following source types:

Since: 7.63.2

Latest revision: 7.113.0

Usage:POST  /lifecycle/api/v2/release_bundle

Usage restrictions:

  • The {release_bundle_name} string is limited to 255 characters.

  • The {release_bundle_version} string is limited to 255 characters.

  • The {release_bundle_name} and {release_bundle_version} strings must begin with a letter, digit, or underscore.

  • The {release_bundle_name} and {release_bundle_version} strings must consist only of letters, digits, underscores, periods, and hyphens.

Query Parameters (optional):

Field

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.

Request Header: X-JFrog-Signing-Key-Name (key-pair name to use for signature creation)

Note

See Create Key Pair for instructions about creating the key pair in Artifactory.

If the Release Bundle is intended for distribution using JFrog Distribution, you must propagate the key pair from Artifactory to the Distribution Edge nodes. For more information, see Propagate Public Signing Key.JFrog Distribution

The creation and distribution action will fail if the signing key has expired.

If you do not specify a key in the header, Artifactory will use a default key named default-rsa-key.

Consumes: application/json

Sample Request (using a combination of all available methods):

{
    "release_bundle_name": "multiRB",
    "release_bundle_version": "11",
    "sources":[
        {
            "source_type": "builds",
            "builds": [
                    {
                        "build_repository": "artifactory-build-info",
                        "build_name": "Commons-Build",
                        "build_number": "1.0.0",
                        "include_dependencies": false
                    },
                     {
                        "build_repository": "artifactory-build-info",
                        "build_name": "Commons-Build",
                        "build_number": "1.0.1",
                        "include_dependencies": false
                    }
                ]
        },
        {
            "source_type": "artifacts",
            "skip_docker_manifest_resolution": true,
            "artifacts": [
                {
                    "path": "commons-dev-maven-local/org/apache/tomcat/commons/1.0.0/commons-1.0.0.jar",
                     "sha256": "e51964f5d9b6829deb25aa7355c4f7bb5acbb42bf905e3352d0f10e40c6f459c"
                 }
             ]
        },
        {
            "source_type": "release_bundles",
            "release_bundles": [
                {
                    "project_key": "default",
                    "repository_key": "release-bundles-v2",
                    "release_bundle_name": "rb_package",
                    "release_bundle_version": "2"
                }
             ]
        },
        {
            "skip_docker_manifest_resolution": false,
            "source_type": "aql",
                "aql": "items.find({\"$and\" : [{\"repo\": {\"$match\": \"commons-dev-*\"}}, {\"name\": {\"$match\": \"*1.0.0*\"}}]})"
        }
    ]
}

The request body includes the following information:

Property

Description

release_bundle_name

Name of the Release Bundle. See here for details.

release_bundle_version

Release Bundle version. See here for details.

sources

Describes one or more sources for the contents of the Release Bundle, including:

Sample Response:

{
    "repository_key": "release-bundles-v2",
    "release_bundle_name": "multiRB",
    "release_bundle_version": "1.0.3",
    "created": "2025-04-29T14:17:21.587Z"
}

Status Codes:

Code

Description

200

Submitted (async)

201

Created (sync)

400

Bad Request

401

Bad Credentials

403

Permission Denied

404

Not Found

409

Already Exists