PUpuppet
Scan

Retrieve a list of scans.

To use this endpoint, you must have one of the following roles: comply-admin comply-operator comply-viewer

get/v1/scan

Request

Query parameters

offsetinteger

The offset where list should start response at.

limitinteger

The offset where list should start response at.

Response

ScanListResponse is the response for a scan list.

limitinteger

If specified limit, you retrieve a subset of records limited to the given value..

nextstring nullable

Next page value .

offsetinteger

Offset is the position in the dataset of a particular record. By specifying offset, you retrieve a subset of records starting with the offset value.

totalinteger required

Total number of records.

Example response

{
  "data": [
    {
      "created_at": "2023-09-25T13:57:16.743Z",
      "finished": 100,
      "finished_at": "2023-09-25T13:57:16.743Z",
      "id": "123",
      "name": "Scan 1",
      "nodes_scanned": 100,
      "status": "finished",
      "type": "desired"
    }
  ],
  "limit": 10,
  "next": "/api/public/v_/_api_?offset=10&limit=10",
  "total": 123
}

Changes

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