Skip to main content

Get Image Scan Results

GET 
/api/v33.02/images
x-prisma-cloud-target-env: {"permission":"monitorImages"}

Retrieves image scan reports.

Note: The API rate limit for this endpoint is 30 requests per 30 seconds. You get an HTTP error response 429 if the limit exceeds.

This endpoint maps to the image table in Monitor > Compliance > Images > Deployed in the Console UI.

Note: The image object of the response was created for internal use of Prisma Cloud Compute for image scanning and analysis. Therefore, its inner fields are not saved in the database and will return empty in the endpoint response. You can get some of its values, such as labels and history, from the main structure of the response.

You can use the wildcard (*) character as input to filter the retrieved images.

If no entry is present in the database, the search returns an empty list.

Consider the following available options to retrieve when you use the fields query parameter:

  • labels
  • repoTag.repo
  • repoTag.registry
  • clusters
  • hosts
  • repoTag.tag

Note: The query parameters issueType is not supported for this API endpoint.

cURL Request​

Refer to the following cURL command that retrieves a compact scan report for all images:

$ curl -k \
  -u <USER> \
  -H 'Content-Type: application/json' \
  -X GET \
  "https://<CONSOLE>/api/v<VERSION>/images"

Refer to the following cURL command that retrieves a compact scan report for an Ubuntu image:

$ curl -k \
  -u <USER> \
  -H 'Content-Type: application/json' \
  -X GET \
  "https://<CONSOLE>/api/v<VERSION>/images?name=https://<REPO-URL>/ubuntu:latest&compact=true"

The name query is synonymous with the filter images text field in the Console UI.

Refer to the following cURL command that retrieves the scan report for an image with the matching SHA-256 hash:

$ curl -k \
  -u <USER> \
  -H 'Content-Type: application/json' \
  -X GET \
  "https://<CONSOLE>/api/v<VERSION>/images?id=sha256:d461f1845c43105d7d686a9cfca9d73b0272b1dcd0381bf105276c978cb02832"

A successful response returns the image scan reports.

Request​

Responses​