Scans List - Get Artifacts



Description: Get a list of artifacts for a specific repository.

Security: Requires a valid user with "Read" permissions.

Usage: GET api/v1/artifacts?order_by=&direction=&num_of_rows=&offset=&search={string}&created_start={datetime}&created_end={datetime}&repo={repo}

Produces: application/json


  • Required:

    • repo: The repository key for which to get artifacts.

  • Optional:

    • order_by: By which column to order the results.

      Allowed values:

      • created - This is the default

      • size

      • name

      • repo_path

    • search: Free text search.

      • repo_path

    • created_start: Return only recordscreatedafter the specified time (in RFC 3339 format).

    • created_end: Return only records created before the specified time (in RFC 3339 format).

    • direction: The direction by which to order the results (either ascending or descending):

      • asc

      • desc

    • num_of_rows: The number ofentries to return.

    • offset: A value returned by the API. It needs to be passed to the API to get the next page. A value of -1 means that the last page was reached.

Sample Response:

    "data": [
            "name": "bash_4.3-11+deb8u2_i386.deb",
            "repo_path": "/deb/bash_4.3-11+deb8u2_i386.deb",
            "package_id": "deb://bash",
            "version": "4.3-11+deb8u2",
            "sec_issues": {
                "high": 2,
                "low": 8,
                "medium": 3,
                "total": 13
            "size": "1.13 MB",
            "violations": 0,
            "created": "2022-07-31T12:06:00+03:00",
            "deployed_by": "admin",
            "repo_full_path": "DEBs/deb/bash_4.3-11+deb8u2_i386.deb"
    "offset": -1

Response Codes:

200: Success

400: Bad request

500: Internal server error