Scans List - Get Release Bundle Versions

Xray REST APIs

Products
JFrog Xray
Content Type
REST API
ft:sourceType
Paligo

Description: Get a list of release bundle versions scanned by Xray.

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

Usage: GET api/v1/release_bundle_versions?order_by=&direction=&num_of_rows=&offset=&created_on_start={datetime}&created_on_end={datetime}&package={package}

Produces: application/json

Parameters:

  • Required:

    • package: The relevant value from the target release bundle.

  • Optional:

    • order_by: By which column to order the results.

      Allowed values:

      • created_on - This is the default

      • version

      • size

    • created_on_start: Return only recordscreatedafter the specified time (in RFC 3339 format).

    • created_on_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": [
        {
            "version": "2.0",
            "size": "0.00 B",
            "violations": 0,
            "created_on": "1649235896791",
            "sec_issues": {
                "total": 0
            },
            "sha256": "d59422279fa5c4e1cb398e51066adf5fdc45cd1cea5f2634b444757c3d49f6fe",
            "package_id": "releaseBundle://myRB"
        }
    ],
    "offset": -1
}

Response Codes:

200: Success

400: Bad request

500: Internal server error