Release Bundle Scan Status

Xray REST APIs

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.

Since: 3.80.9

Security: Requires a valid user with the Read permission.

Usage: POST /api/v1/releaseBundle/status

Consumes: application/json

Produces: application/json

Required Parameters

Parameter

Type

Mandatory/Optional

Description

name

string

mandatory

The Release Bundle name

version

string

mandatory

The Release Bundle version

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

Successful Response

200 - OK

{
  "overall": {
    "status": "DONE",
    "time": "2023-08-09T15:14:44+03:00"
  },
  "details": {
    "sca": {
      "status": "DONE",
      "time": "2023-08-09T15:13:45+03:00"
    },
    "violations": {
      "status": "DONE",
      "time": "2023-08-09T15:14:44+03:00"
    }
  }
}