Get Received Release Bundles (v2)

JFrog REST APIs

Content Type
REST API
ft:sourceType
Paligo

Description: Returns a list of distributed Release Bundles (v2) that have been received by this target (for example, an Edge node).

Since: 7.103.1 (Artifactory), 2.28.1 (Distribution)

Security: Requires an admin user.

Usage:GET /api/v2/release_bundle/received

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 versions to return at one time. Used for pagination purposes.

The default is 100.

pattern

string

Defines a filter for the list of Release Bundle names.

You can filter by release_bundle_version or bundle_name.

The default is ** (all).

order_by {name|source_project_key|date_received}

string

Defines the criterion by which to order the list of received Release Bundles:

  • name: Release Bundle name

  • source_project_key: The project name from the source Artifactory.

  • date_received: When the Release Bundle was received.

order_asc {true|false}

boolean

Defines whether to list the results of the order_by column in ascending (true) or descending (false) order.

The default value is false.

Sample Response:

{
   "release_bundles": [
      {
         "name": "rb-test-1",
         "latest_version": "3.0.2",
         "source_project_key": "default"
         "date_received": 123654789
         "number_of_versions": 3
      },
      {
         "name": "rb-test-10",
         "latest_version": "1.3.0",
         "source_project_key": "test-project",
         "date_received": 223654789,
         "number_of_versions": 2
      }
   ],
   "total": "2"
}

The response includes the following information:

Property

Type

Description

name

string

The Release Bundle name.

latest_version

string

The latest Release Bundle version received.

source_project_key

string

The project name from the source Artifactory.

date_received

date

The date when the latest Release Bundle version was received.

number_of_versions

integer

The number of versions of the Release Bundle that have been received.

Status Codes:

Code

Description

200

Fetched

403

Permission Denied

404

Not Found