Artifact Scan Status

Description: Get the scan status of an artifact.

Since: 3.80.9

Applicable Environment: JFrog SaaS,  Self-Hosted

Security: Requires a valid user with the Read permission.

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

Consumes: application/json

Produces: application/json

Path parameters: None

Query parameters: None

Request Body

Response Body:

OverallObj:

DetailsObj:

ScaObj:

ContextualObj

ExposuresObj

ExposuresCategoriesObj

CategoryObj

ViolationsObj

Response Codes

Sample Request

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

Example Successful Response

200 OK

{
  "overall": {
    "status": "DONE",
    "time": "2024-07-04T07:05:51Z"
  },
  "details": {
    "sca": {
      "status": "DONE",
      "time": "2024-07-04T07:05:27Z"
    },
    "contextual_analysis": {
      "status": "DONE",
      "time": "2024-07-04T07:05:26Z"
    },
    "exposures": {
      "status": "DONE",
      "time": "2024-05-16T07:57:35Z",
      "categories": {
        "iac": {
          "time": "2024-05-16T07:57:35Z",
          "status": "NOT_SUPPORTED"
        },
        "secrets": {
          "time": "2024-05-16T07:57:35Z",
          "status": "DONE"
        },
        "services": {
          "time": "2024-05-16T07:57:35Z",
          "status": "DONE"
        },
        "applications": {
          "time": "2024-05-16T07:57:35Z",
          "status": "DONE"
        }
      }
    },
    "violations": {
      "status": "DONE",
      "time": "2024-07-04T07:05:51Z"
    }
  }
}

Example Error Response

404 Not Found

{
  "error": "artifact at path myrepo/myartifact does not exist in Artifactory"
}