Get Release Bundle v2 Version Details

JFrog REST APIs

Content Type
REST API

Description: Returns the details of a selected Release Bundle v2 version, such as its creation time, the user who created it, the artifacts it includes, and so on. The details are stored in the form of a DSSE attestation, a signature envelope with a Base64-encoded payload, which contains a snapshot of the items in the Release Bundle.

Since: 7.63.2

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

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

Query Parameters (optional):

Field

Type

Description

offset

integer

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

limit

integer

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

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.

Sample Response:

{
    "service_id": "jfrt@01j800t90khnyz0mcy3py50r0d",
    "created_by": "admin",
    "created": "2024-09-17T13:25:55.013Z",
    "created_millis": 1726579555013,
    "total_artifacts_count": 16,
    "artifacts": [
        {
            "path": "catalina/1.0.1/sha256__cd46d47a0b5cca1b85334f6775120e58b676cb24b6bdf2c6328788b6336d1e04",
            "checksum": "cd46d47a0b5cca1b85334f6775120e58b676cb24b6bdf2c6328788b6336d1e04",
            "source_repository_key": "catalina-dev-docker-local",
            "package_type": "docker",
            "package_name": "catalina",
            "package_version": "1.0.1",
            "size": 206,
            "properties": [
                {
                    "key": "build.name",
                    "values": [
                        "Catalina-Build"
                    ]
                },
                {
                    "key": "build.number",
                    "values": [
                        "1.0.1"
                    ]
                },
                {
                    "key": "build.timestamp",
                    "values": [
                        "1726579000304"
                    ]
                },
                {
                    "key": "sha256",
                    "values": [
                        "cd46d47a0b5cca1b85334f6775120e58b676cb24b6bdf2c6328788b6336d1e04"
                    ]
                }
            ]
        },
        {
            "path": "catalina/1.0.1/sha256__fee54f469a2a999a89cf8659ae0eb33450d675f11109093382a7142152cfe4ff",
            "checksum": "fee54f469a2a999a89cf8659ae0eb33450d675f11109093382a7142152cfe4ff",
            "source_repository_key": "catalina-dev-docker-local",
            "package_type": "docker",
            "package_name": "catalina",
            "package_version": "1.0.1",
            "size": 657,
            "properties": [
                {
                    "key": "build.name",
                    "values": [
                        "Catalina-Build"
                    ]
                },
                {
                    "key": "build.number",
                    "values": [
                        "1.0.1"
                    ]
                },
                {
                    "key": "build.timestamp",
                    "values": [
                        "1726579000304"
                    ]
                },
                {
                    "key": "sha256",
                    "values": [
                        "fee54f469a2a999a89cf8659ae0eb33450d675f11109093382a7142152cfe4ff"
                    ]
                }
            ]
        },
        {
            "path": "commons/1.0.1/manifest.json",
            "checksum": "09a6aa2c159946d264854baea15ebf0378a432157f2ffbd8737aff541cb9ed00",
            "source_repository_key": "commons-dev-docker-local",
            "package_type": "docker",
            "package_name": "commons",
            "package_version": "1.0.1",
            "size": 523,
            "properties": [
                {
                    "key": "artifactory.content-type",
                    "values": [
                        "application/vnd.docker.distribution.manifest.v2+json"
                    ]
                },
                {
                    "key": "build.name",
                    "values": [
                        "Commons-Build"
                    ]
                },
                {
                    "key": "build.number",
                    "values": [
                        "1.0.1"
                    ]
                },
                {
                    "key": "build.timestamp",
                    "values": [
                        "1726579003176"
                    ]
                },
                {
                    "key": "docker.manifest",
                    "values": [
                        "1.0.1"
                    ]
                },
                {
                    "key": "docker.manifest.digest",
                    "values": [
                        "sha256:09a6aa2c159946d264854baea15ebf0378a432157f2ffbd8737aff541cb9ed00"
                    ]
                },
                {
                    "key": "docker.manifest.type",
                    "values": [
                        "application/vnd.docker.distribution.manifest.v2+json"
                    ]
                },
                {
                    "key": "docker.repoName",
                    "values": [
                        "commons"
                    ]
                },
                {
                    "key": "oci.artifact.type",
                    "values": [
                        "application/vnd.docker.container.image.v1+json"
                    ]
                },
                {
                    "key": "sha256",
                    "values": [
                        "09a6aa2c159946d264854baea15ebf0378a432157f2ffbd8737aff541cb9ed00"
                    ]
                }
            ]
        }
    ]
}

The response includes the following information:

Property

Description

service_id

The unique identifier of the Artifactory instance where the Release Bundle version was created.

created_by

The name of the user who created the Release Bundle version.

Note

Names longer than 64 characters will appear truncated.

created

The timestamp when the Release Bundle version was created (ISO 8601 standard).

created_millis

The timestamp when the Release Bundle version was created (in milliseconds).

total_artifacts_count

The total number of artifacts included in the Release Bundle version.

artifacts

The properties of the artifact, as described below.

artifacts.path

The path of a Release Bundle item relative to its contents directory.

artifacts.checksum

The SHA-256 checksum of the source artifact.

artifacts.source_repository_key

The source repository of the artifact.

artifacts.package_type

The package type of the source repository associated with the artifact.

artifacts.package_name

The name of the package associated with the artifact.

artifacts.package_version

The version of the package associated with the artifact.

artifacts.size

The size of the artifact (in bytes).

artifacts.properties

The source artifact properties that were present when the Release Bundle version was created (each property includes a key and values).

Status Codes:

Code

Description

200

Fetched

401

Bad Credentials

403

Permission Denied

404

Not Found (Release Bundle/version)