Query

List of images containing given package

Changed on

Filterable query interface to search for images containing specified package

get/query/images/by_package

Request

  • Base URL: / (relative, and the document was published on a file host, not at the API’s origin)
  • URL: /query/images/by_package
  • Auth: none declared

Query parameters

namestring required

Name of package to search for (e.g. sed)

package_typestring

Type of package to filter on (e.g. dpkg)

versionstring

Version of named package to filter on (e.g. 4.4-1)

pagestring

The page of results to fetch. Pages start at 1

limitinteger

Limit the number of records for the requested page. If omitted or set to 0, return all results in a single page

Headers

x-anchore-accountstring

An account name to change the resource scope of the request to that account, if permissions allow (admin only)

Response

Image listing

pagestring

The page number returned (should match the requested page query string param)

next_pagestring

True if additional pages exist (page + 1) or False if this is the last page

returned_countinteger

The number of items sent in this response

Example response

{
  "images": [
    {
      "image": {
        "tag_history": [
          {
            "registry": "registry",
            "detected_at": "2000-01-23T04:56:07.000+00:00",
            "pullstring": "pullstring",
            "tag": "tag",
            "repository": "repository"
          }
        ]
      }
    }
  ]
}

Changes

    • breaking

      the /// response's property type changed from no type to object for status

    • info

      api tag Query added

    • info

      added the optional property //////// to the response with the status

    • info

      added to the response body allOf list for the response status

    • info

      removed subschema #2 from the response body allOf list for the response status