Scans List - Get Release Bundles



Description: Get a list of release bundles scanned by Xray.

Security: Requires a valid user with "Read" permissions.

Usage: GET api/v1/release_bundles?order_by=&direction=&num_of_rows=&offset=&created_start={datetime}&created_end={datetime}&number_of_versions_start={int}&number_of_versions_end={int}

Produces: application/json


  • Required: None

  • Optional:

    • order_by: By which column to order the results.

      Allowed values:

      • created - This is the default

      • bundle_name

      • latest_version

      • number_of_versions

    • number_of_versions_start: Return release bundles with the minimum specified versions count.

    • number_of_versions_end: Return release bundles with the maximum specified versions count.

    • created_start: Return only records created after the specified time (in RFC 3339 format).

    • created_end: Return only records created before the specified time (in RFC 3339 format).

    • direction: The direction by which to order the results (either ascending or descending):

      • asc

      • desc

    • num_of_rows: The number ofentries to return.

    • offset: A value returned by the API. It needs to be passed to the API to get the next page. A value of -1 means that the last page was reached.

Sample Response:

    "data": [
            "bundle_name": "myrb",
            "number_of_versions": 2,
            "latest_version": "2.0",
            "package": "releaseBundle://myRB",
            "created": 1649235896243,
            "type": "releaseBundle"
    "offset": -1

Response Codes:

200: Success

400: Bad request

500: Internal server error