Sign in

v1

latestOpenAPI 3.0.32026-07-22238629559.2 KB
ScansService

List Scans

List the scans associated with a particular project from the past 30 days.

post/api/v2/deployments/{deploymentId}/projects/{projectId}/scans/list

Path parameters

deploymentIdstring int64 required

The unique numerical identifier of your deployment. Can be found via the Deployments Service or in your Settings in the web UI.

Example:1234
projectIdstring int64 required

The unique numerical identifier for the project that was scanned. Can be found via the Projects Service, or in the Projects panel in the web UI.

Example:5678

Request body

cursorstring

Include the cursor from the previous response to paginate through the results

limitinteger

Number of scans to return per page. Default is 100, max is 500.

Example request

{
  "limit": 100,
  "filters": {
    "branch": "refs/heads/main",
    "createdSince": "2019-08-24T14:15:22.000Z",
    "duration": {
      "min": 12.5,
      "max": 60
    },
    "includeEnabledProducts": [
      "PRODUCT_SAST",
      "PRODUCT_SECRETS"
    ],
    "statuses": [
      "SCAN_STATUS_RUNNING",
      "SCAN_STATUS_COMPLETED"
    ],
    "types": [
      "SCAN_TYPE_FULL"
    ]
  }
}

Response

OK

cursorstring

Cursor to retrieve the next page of results.

Example response

{
  "scans": [
    {
      "id": "12345",
      "deploymentId": "1605",
      "projectId": "7884",
      "branchId": "7890",
      "commit": "abcdef1234567890",
      "startTime": "2023-11-18T23:28:12.391Z",
      "completeTime": "2023-11-18T23:30:12.391Z",
      "isFullScan": true,
      "findingsCounts": {
        "total": 10,
        "code": 5,
        "supplyChain": 3,
        "secrets": 2
      },
      "status": "SCAN_STATUS_RUNNING",
      "enabledProducts": [
        "PRODUCT_SAST",
        "PRODUCT_SCA",
        "PRODUCT_SECRETS"
      ]
    }
  ]
}