Release Bundle Scan Status

Xray REST APIs

Products

JFrog Xray

Content Type

REST API

ft:sourceType

Paligo

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/releaseBundle/status

Consumes: application/json

Produces: application/json

Request Body

Parameter	Type	Required/Optional	Description
`name`	string	required	The Release Bundle name
`version`	string	required	The Release Bundle version

Response Body:

Parameter	Type	Description
`overall`	OverallObj	Overall scan status object
`details`	DetailsObj	Detailed scan status object

OverallObj:

Parameter	Type	Description
`status`	string	Overall status of the scan. Possible values: `NOT_SUPPORTED`, `NOT_SCANNED`, `PENDING`, `SCANNING`, `DONE`, `PARTIAL`, `FAILED`
`time`	string	Timestamp in RFC 3339 format of the scan status.

Parameter

Type

Description

status

string

Overall status of the scan.

Possible values: NOT_SUPPORTED, NOT_SCANNED, PENDING, SCANNING, DONE, PARTIAL, FAILED

time

string

Timestamp in RFC 3339 format of the scan status.

DetailsObj:

Parameter	Type	Description
`sca`	ScaObj	SCA scan status object
`contextual_analysis`	ContextualObj	Contextual analysis scan status object
`exposures`	ExposuresObj	Exposures scan status object
`violations`	ViolationsObj	Violations scan status object

ScaObj:

Parameter	Type	Description
`status`	string	Possible values: `NOT_SUPPORTED`, `NOT_SCANNED`, `PENDING`, `SCANNING`, `DONE`, `PARTIAL`, `FAILED`
`time`	string	Timestamp in RFC 3339 format of the SCA scan status.

ContextualObj

Parameter	Type	Description
`status`	string	Possible values: `NOT_SUPPORTED`, `NOT_SCANNED`, `PENDING`, `SCANNING`, `DONE`, `PARTIAL`, `FAILED`
`time`	string	Timestamp in RFC 3339 format of the SCA scan status.

ExposuresObj

Parameter	Type	Description
`status`	string	Possible values: `NOT_SUPPORTED`, `NOT_SCANNED`, `PENDING`, `SCANNING`, `DONE`, `PARTIAL`, `FAILED`
`time`	string	Timestamp in RFC 3339 format of the SCA scan status.
`categories`	ExposuresCategoriesObj	Categories of the exposures scan

ExposuresCategoriesObj

Parameter	Type	Description
`iac`	CategoryObj	Infrastructure as code status
`secrets`	CategoryObj	Secrets scan status
`services`	CategoryObj	Services scan status
`applications`	CategoryObj	Applications scan status

CategoryObj

Parameter	Type	Description
`status`	string	Possible values: `NOT_SUPPORTED`, `NOT_SCANNED`, `PENDING`, `SCANNING`, `DONE`, `PARTIAL`, `FAILED`
`time`	string	Timestamp in RFC 3339 format of the SCA scan status.

ViolationsObj

Parameter	Type	Description
`status`	string	Possible values: `NOT_SUPPORTED`, `NOT_SCANNED`, `PENDING`, `SCANNING`, `DONE`, `PARTIAL`, `FAILED`
`time`	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.1"
}

Sample Successful Response

200 OK

{
    "overall": {
        "status": "DONE",
        "time": "2024-06-24T09:04:35Z"
    },
    "details": {
        "sca": {
            "status": "DONE",
            "time": "2024-06-24T09:04:35Z"
        },
        "contextual_analysis": {
            "status": "DONE",
            "time": "2024-06-24T09:04:34Z"
        },
        "violations": {
            "status": "NOT_SCANNED",
            "time": "2024-06-24T09:04:35Z"
        }
    }
}

Sample Error Response

404 Not Found

{
 "error": "release bundle name: segevtest release bundle version: 1.5 is not exist in Artifactory"
}