Scans List - Get Repositories

Description: Get a list of repositories that contain at least one scanned artifact.

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

Usage: GET /xray/api/v1/repos?order_by=&direction=&num_of_rows=&offset=&search={string}&indexed_artifact_start={int}&indexed_artifact_end={int}&repo={string}

Produces: application/json

Parameters:

Required: None
Optional:
- order_by: By which column to order the results.
  Allowed values:
  - repo - This is the default
  - indexed_artifact
- search: Free text search.
  - repo
  - latest_artifact
- indexed_artifact_start: Return records with the minimum specified artifact count.
- indexed_artifact_end: Return records with the maximum specified artifact count.
- 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": [
        {
            "repo": "DEBs",
            "indexed_artifact": 358,
            "latest_artifact": "libgdbm-compat4_1.14.1-6_amd64.deb",
            "package_type": "Debian",
            "created_at": "2022-07-31T08:55:50Z"
        }
    ],
    "offset": -1
}

Response Codes:

200: Success

400: Bad request

500: Internal server error