Description: Get the scan status of a build.
Note: Only for builds 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/build/status
Consumes: application/json
Produces: application/json
Required Parameters
Parameter | Type | Mandatory/Optional | Description |
---|---|---|---|
name | string | mandatory | The build name |
number | string | mandatory | The build number |
project | string | optional | The project key |
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": "docker-build", "number": "1", "Project" : "pkey" }
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" } } }