Artifact Scan Status

Xray REST APIs

Products
JFrog Xray
Content Type
REST API
ft:sourceType
Paligo

Description: Get the scan status of an artifact.

Since: 3.80.9

Security: Requires a valid user with the Read permission.

Usage: POST /api/v1/artifact/status

Consumes: application/json

Produces: application/json

Required Parameters

Parameter

Type

Mandatory/Optional

Description

repo

string

mandatory

The name of the repository.

path

string

mandatory

Path including file name

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

{
  "repo": "docker-local",
  "path": "desktop-storage/1.0/manifest.json"
}

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"
    },
    "contextual_analysis": {
      "status": "DONE",
      "time": "2023-08-09T15:14:44+03:00"
    },
    "exposures": {
      "status": "DONE",
      "time": "2023-08-09T15:14:44+03:00",
      "categories": {
        "iac": {
          "time": "2023-08-09T15:14:44+03:00",
          "status": "NOT_SUPPORTED"
        },
        "secrets": {
          "time": "2023-08-09T15:14:44+03:00",
          "status": "DONE"
        },
        "services": {
          "time": "2023-08-09T15:14:44+03:00",
          "status": "DONE"
        },
        "applications": {
          "time": "2023-08-09T15:14:44+03:00",
          "status": "DONE"
        }
      }
    },
    "violations": {
      "status": "DONE",
      "time": "2023-08-09T15:14:44+03:00"
    }
  }
}