Sign in
project

List artifacts

List artifacts of the specified project

get/projects/{project_name_or_id}/artifacts

Path parameters

project_name_or_idstring required

The name or id of the project

Query parameters

qstring

Query string to query resources. Supported query patterns are "exact match(k=v)", "fuzzy match(k=v)", "range(k=[minmax])", "list with union releationship(k={v1 v2 v3})" and "list with intersetion relationship(k=(v1 v2 v3))". The value of range and list can be string(enclosed by " or '), integer or time(in format "2020-04-09 02:36:00"). All of these query patterns should be put in the query string "q=xxx" and splitted by ",". e.g. q=k1=v1,k2=v2,k3=[minmax]

sortstring

Sort the resource list in ascending or descending order. e.g. sort by field1 in ascending order and field2 in descending order with "sort=field1,-field2"

pageinteger

The page number

page_sizeinteger

The size of per page

with_tagboolean

Specify whether the tags are included inside the returning artifacts

with_labelboolean

Specify whether the labels are included inside the returning artifacts

with_scan_overviewboolean

Specify whether the scan overview is included inside the returning artifacts

with_sbom_overviewboolean

Specify whether the SBOM overview is included in returning artifacts, when this option is true, the SBOM overview will be included in the response

with_immutable_statusboolean

Specify whether the immutable status is included inside the tags of the returning artifacts. Only works when setting "with_immutable_status=true"

with_accessoryboolean

Specify whether the accessories are included of the returning artifacts. Only works when setting "with_accessory=true"

latest_in_repositoryboolean

Specify whether only the latest pushed artifact of each repository is included inside the returning artifacts. Only works when either artifact_type or media_type is included in the query.

Headers

X-Request-Idstring

An unique ID for the request

X-Is-Resource-Nameboolean

The flag to indicate whether the parameter which supports both name and id in the path is the name of the resource. When the X-Is-Resource-Name is false and the parameter can be converted to an integer, the parameter will be as an id, otherwise, it will be as a name.

X-Accept-Vulnerabilitiesstring

A comma-separated lists of MIME types for the scan report or scan summary. The first mime type will be used when the report found for it. Currently the mime type supports 'application/vnd.scanner.adapter.vuln.report.harbor+json; version=1.0' and 'application/vnd.security.vulnerability.report; version=1.1'

Response

Success

idinteger

The ID of the artifact

typestring

The type of the artifact, e.g. image, chart, etc

media_typestring

The media type of the artifact

manifest_media_typestring

The manifest media type of the artifact

artifact_typestring

The artifact_type in the manifest of the artifact

project_idinteger

The ID of the project that the artifact belongs to

repository_idinteger

The ID of the repository that the artifact belongs to

repository_namestring

The name of the repository that the artifact belongs to

digeststring

The digest of the artifact

sizeinteger

The size of the artifact

iconstring

The digest of the icon

push_timestring date-time

The push time of the artifact

pull_timestring date-time

The latest pull time of the artifact

extra_attrsExtraAttrs
annotationsAnnotations
addition_linksAdditionLinks
scan_overviewScanOverview

The scan overview attached in the metadata of tag

Example response

[
  {
    "sbom_overview": {
      "start_time": "2006-01-02T14:04:05Z",
      "end_time": "2006-01-02T15:04:05Z",
      "report_id": "5f62c830-f996-11e9-957f-0242c0a89008",
      "duration": 300,
      "scanner": {
        "name": "Trivy",
        "vendor": "Aqua Security",
        "version": "v0.9.1"
      }
    }
  }
]

Changes

No recorded changes to this endpoint across all 1 revision of this API.