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
Parameter | Type | Required/Optional | Description |
---|---|---|---|
| string | required | The Release Bundle name |
| string | required | The Release Bundle version |
| string | optional | The project key that the RBv2 belongs to. When omitted or an empty string the request for a release bundle from the global (default) scope. |
Response Body:
Parameter | Type | Description |
---|---|---|
| Overall scan status object | |
| Detailed scan status object |
OverallObj:
Parameter | Type | Description |
---|---|---|
| string | Overall status of the scan. Possible values: |
| string | Timestamp in RFC 3339 format of the scan status. |
DetailsObj:
Parameter | Type | Description |
---|---|---|
| SCA scan status object | |
| Contextual analysis scan status object | |
| Exposures scan status object | |
| Violations scan status object |
ScaObj:
Parameter | Type | Description |
---|---|---|
| string | Possible values: |
| string | Timestamp in RFC 3339 format of the SCA scan status. |
ContextualObj
Parameter | Type | Description |
---|---|---|
| string | Possible values: |
| string | Timestamp in RFC 3339 format of the SCA scan status. |
ExposuresObj
Parameter | Type | Description |
---|---|---|
| string | Possible values: |
| string | Timestamp in RFC 3339 format of the SCA scan status. |
| Categories of the exposures scan |
ExposuresCategoriesObj
Parameter | Type | Description |
---|---|---|
| Infrastructure as code status | |
| Secrets scan status | |
| Services scan status | |
| Applications scan status |
CategoryObj
Parameter | Type | Description |
---|---|---|
| string | Possible values: |
| string | Timestamp in RFC 3339 format of the SCA scan status. |
ViolationsObj
Parameter | Type | Description |
---|---|---|
| string | Possible values: |
| string | Timestamp in RFC 3339 format of the SCA scan status. |
Response Codes
Status Code | Description |
---|---|
200 | OK |
400 | Bad request - Mandatory fields are missing |
403 | Permission denied |
404 | Not found |
500 | Internal server error |
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" }