Scan Status

Xray REST APIs

ft:sourceType
Paligo

Description: Returns the scan status for Packages, Builds, and Release Bundles.

Since: 3.34.1

Security: Requires a valid user with the "Read" permissions.

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

Packages: POST /xray/api/v1/scan/status/artifact

Sample Request

{
   "repository_pkg_type": "Npm",
   "path": "npm-local/static-module-3.0.4.tar.gz",
   "sha256": "b0a887f6e5c16134b7d1280c2150d38811357642d56c622c6f7f6b239f668608",
   "sha1": "2ed14fc6f7899d089cd5a2b880121d9467c32d46"
}

Builds: POST /xray/api/v1/scan/status/build

Sample Request

{
 "name":"test-build",
 "version":"1"
}

Sample Request with Projects

{
 "name":"test-build",
 "project":"proj1",
 "version":"1"
}

Release Bundles: POST /xray/api/v1/scan/status/releaseBundle

Sample Request

{
 "name":"test-release-bundle",
 "version":"1"
}

If the build belongs to a non-default Release Bundle repository:

{
 "name":"test-build",
 "repository":"repo",
 "version":"1"
}

Release Bundle V2: POST /xray/api/v1/scan/status/releaseBundleV2

Sample Request

{
"name":"v2bundle-new",
"repository":"release-bundles-v2",
"version":"1"
}

Returned Statuses:

{
"status": "failed"/"not supported"/"in progress"/"not scanned"/"scanned"
}

In the case the returned status is failed, for Self-Hosted installations only, users with Admin permissions have an additional step and reason parameters:

{
  "status": "failed"
  "Step": "scan/persist",
  "reason": "failed to process message …..."
}