Get artifact

We can fetch a single artifact using get_artifact. The method takes a project name, repositry name and a tag or digest. It returns an Artifact object.

import asyncio
from harborapi import HarborAsyncClient

client = HarborAsyncClient(...)


async def main() -> None:
    artifact = await client.get_artifact("library", "hello-world", "latest")
    # or
    artifact = await client.get_artifact(
        "library", "hello-world", "sha256:123456abcdef..."
    )


asyncio.run(main())

We can optionally fetch a number of extra attributes for the artifact using any of the following arguments:

• with_tag - Fetches the tags for the artifact. This is a list of Tag objects.
• with_label - Fetches the labels for the artifact (False by default). This is a list of Label objects.
• with_scan_overview - Fetches the scan overview for the artifact. This is a ScanOverview object.
• with_signature - Fetches the signature for the artifact.
• with_immutable_status - Fetches the immutable status for the artifact.
• with_accessory - Fetches the accessories for the artifact. This is a list of Accessory objects.

All these arguments can be mixed and matched, and will control the attributes that are fetched for the artifact.

See below for examples of how to use these arguments and what they return.

Fetching tags

We can fetch the tags for an artifact using the with_tag argument. This will populate the tags field of the artifact with a list of Tag objects. This parameter is True by default, so we only need to specify this if we don't want to fetch the tags.

import asyncio
from harborapi import HarborAsyncClient

client = HarborAsyncClient(...)


async def main() -> None:
    artifact = await client.get_artifact(
        project="library",
        repository="hello-world",
        reference="latest"
        with_tag=True,
    )

    for tag in artifact.tags:
        print(tag.name)


asyncio.run(main())

Fetching labels

We can fetch the labels for an artifact using the with_tag argument. This will populate the labels field of the artifact with a list of Label objects. This parameter is False by default.

import asyncio
from harborapi import HarborAsyncClient

client = HarborAsyncClient(...)


async def main() -> None:
    artifact = await client.get_artifact(
        project="library",
        repository="hello-world",
        reference="latest"
        with_label=True,
    )

    for label in artifact.labels:
        print(label.name)


asyncio.run(main())

Fetching scan overview

We can fetch the scan overview for an artifact using the with_scan_overview argument. This will populate the scan_overview field of the artifact with a NativeReportSummary object. This object contains a brief overview of the scan results for the artifact. To fetch the full vulnerability report (a separate API call), see the Get artifact vulnerability report recipe.

import asyncio
from harborapi import HarborAsyncClient

client = HarborAsyncClient(...)

async def main() -> None:
    artifact = await client.get_artifact(
        "library",
        "hello-world",
        "latest",
        with_scan_overview=True,
    )
    print(artifact.scan_overview)


asyncio.run(main())

See Get artifact scan overview for more in-depth usage of this feature.

Other extra data

As outlined previously, different types of extra information can be fetched for an artifact. Adding these arguments will populate the relevant fields of the artifact with the relevant data.

import asyncio
from harborapi import HarborAsyncClient

client = HarborAsyncClient(...)

async def main() -> None:
    artifact = await client.get_artifact(
        "library",
        "hello-world",
        "latest",
        with_accessory=True,
        with_immutable_status=True,
        with_label=True,
        with_scan_overview=True,
        with_signature=True,
        with_tag=True,
    )
    print(artifact.accessories)
    print(artifact.labels)
    print(artifact.scan_overview)
    print(artifact.tags)
    # immutable status and signature unknown...


asyncio.run(main())