Sign in
ScansService

Get Scan

Get a scan by ID.

get/api/v2/deployments/{deploymentId}/scans/{scanId}

Path parameters

deploymentIdstring int64 required

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

Example:1234
scanIdstring int64 required

The unique numerical identifier for the scan.

Example:12345

Response

OK

Example response

{
  "scan": {
    "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"
    ]
  }
}

Changes

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