Release Bundle V2 Scan Status

Description: Get the scan status of a Release Bundle.

Note: Only for Release Bundles that are set to be indexed by Xray.

Applicable Environment: JFrog SaaS,  Self-Hosted

Since: 3.80.9

Security: Requires a valid user with the Read permission.

Usage: POST /xray/api/v1/release_bundle_v2/status

Consumes: application/json

Produces: application/json

Request Body

Response Body:

OverallObj:

DetailsObj:

ScaObj:

ContextualObj

ExposuresObj

ExposuresCategoriesObj

CategoryObj

ViolationsObj

Response Codes

Sample Request

{
 "name":"my-bundle",
 "version":"1"
}

Sample Request with Project

{
 "name": "my-project-bundle",
 "version": "1",
 "project": "my-project"
}

Sample Successful Response

200 OK

200 OK

{
    "overall": {
        "status": "DONE",
        "time": "2024-10-30T10:52:20+02:00"
    },
    "details": {
        "sca": {
            "status": "DONE",
            "time": "2024-10-30T10:52:13+02:00"
        },
        "contextual_analysis": {
            "status": "DONE",
            "time": "2024-10-30T10:52:20+02:00"
        },
        "exposures": {
            "status": "NOT_SCANNED",
            "time": "2024-10-30T10:52:09+02:00",
            "categories": {
                "secrets": {
                    "time": "2024-10-30T10:52:09+02:00",
                    "status": "NOT_SCANNED"
                },
                "services": {
                    "time": "2024-10-30T10:52:09+02:00",
                    "status": "NOT_SCANNED"
                },
                "applications": {
                    "time": "2024-10-30T10:52:09+02:00",
                    "status": "NOT_SCANNED"
                }
            }
        },
        "violations": {
            "status": "NOT_SCANNED",
            "time": "2024-10-30T10:52:13+02:00"
        }
    }
}

Sample Error Response

404 Not Found

{
    "error": "release bundle v2 name: my-bundle version: 2.0 does not exist in Artifactory"
}