# Scans#ListScans List a collection of Security Test Scans Endpoint: GET /sto/api/v2/scans Version: 1.0 Security: ## Query parameters: - `accountId` (string, required) Harness Account ID Example: "abcdef1234567890ghijkl" - `page` (integer) Page number to fetch (starting from 0) Example: 4 - `pageSize` (integer) Number of results per page Example: 50 - `executionId` (string) Harness Execution ID Example: "abcdef1234567890ghijkl" ## Header parameters: - `X-Api-Key` (string) Harness personal or service access token Example: "Fugiat tempore." ## Response 200 fields (application/json): - `pagination` (object, required) Example: {"link":"","page":4,"pageSize":20,"totalItems":230,"totalPages":12} - `pagination.link` (string) Link-based paging - `pagination.page` (integer, required) Page number (starting from 0) Example: 4 - `pagination.pageSize` (integer, required) Requested page size Example: 20 - `pagination.totalItems` (integer, required) Total results available Example: 230 - `pagination.totalPages` (integer, required) Total pages available Example: 12 - `results` (array, required) Example: [{"codeCoverage":65.5,"created":1651578240,"executionId":"abcdef1234567890ghijkl","gitMetadata":{"detectedName":"Nesciunt et.","detectedVariant":"Et voluptatem quos voluptate voluptatem eos.","droneCorrelated":true,"provider":"Dignissimos incidunt quibusdam officiis doloremque eos et.","pullRequestNumber":11,"repositoryHttp":"https://github.com/harness/drone-cli.git","repositoryPath":["Nulla ipsa.","Molestiae possimus expedita odio ut.","Et dolor doloribus.","Ut adipisci optio sit itaque assumenda."],"repositorySsh":"git@github.com:harness/drone-cli.git","sourceBranch":"feat/shiny-object","targetBranch":"develop","workspace":"/harness"},"id":"abcdef1234567890ghijkl","lastModified":1651578240,"metadata":{"baseImageDigest":"sha256:abcdef1234567890ghijkl","baseImageName":"my-image","baseImageTag":"1.0.0"},"orgId":"your_harness_org","pipelineId":"your_harness_pipeline","productId":"product111111111111111","projectId":"your_harness_project","refinementVersion":"1.0.5","stageId":"stage_id","status":"Succeeded","stepId":"step_id","subproduct":"owasp","targetVariantId":"variant111111111111111"},{"codeCoverage":65.5,"created":1651578240,"executionId":"abcdef1234567890ghijkl","gitMetadata":{"detectedName":"Nesciunt et.","detectedVariant":"Et voluptatem quos voluptate voluptatem eos.","droneCorrelated":true,"provider":"Dignissimos incidunt quibusdam officiis doloremque eos et.","pullRequestNumber":11,"repositoryHttp":"https://github.com/harness/drone-cli.git","repositoryPath":["Nulla ipsa.","Molestiae possimus expedita odio ut.","Et dolor doloribus.","Ut adipisci optio sit itaque assumenda."],"repositorySsh":"git@github.com:harness/drone-cli.git","sourceBranch":"feat/shiny-object","targetBranch":"develop","workspace":"/harness"},"id":"abcdef1234567890ghijkl","lastModified":1651578240,"metadata":{"baseImageDigest":"sha256:abcdef1234567890ghijkl","baseImageName":"my-image","baseImageTag":"1.0.0"},"orgId":"your_harness_org","pipelineId":"your_harness_pipeline","productId":"product111111111111111","projectId":"your_harness_project","refinementVersion":"1.0.5","stageId":"stage_id","status":"Succeeded","stepId":"step_id","subproduct":"owasp","targetVariantId":"variant111111111111111"},{"codeCoverage":65.5,"created":1651578240,"executionId":"abcdef1234567890ghijkl","gitMetadata":{"detectedName":"Nesciunt et.","detectedVariant":"Et voluptatem quos voluptate voluptatem eos.","droneCorrelated":true,"provider":"Dignissimos incidunt quibusdam officiis doloremque eos et.","pullRequestNumber":11,"repositoryHttp":"https://github.com/harness/drone-cli.git","repositoryPath":["Nulla ipsa.","Molestiae possimus expedita odio ut.","Et dolor doloribus.","Ut adipisci optio sit itaque assumenda."],"repositorySsh":"git@github.com:harness/drone-cli.git","sourceBranch":"feat/shiny-object","targetBranch":"develop","workspace":"/harness"},"id":"abcdef1234567890ghijkl","lastModified":1651578240,"metadata":{"baseImageDigest":"sha256:abcdef1234567890ghijkl","baseImageName":"my-image","baseImageTag":"1.0.0"},"orgId":"your_harness_org","pipelineId":"your_harness_pipeline","productId":"product111111111111111","projectId":"your_harness_project","refinementVersion":"1.0.5","stageId":"stage_id","status":"Succeeded","stepId":"step_id","subproduct":"owasp","targetVariantId":"variant111111111111111"},{"codeCoverage":65.5,"created":1651578240,"executionId":"abcdef1234567890ghijkl","gitMetadata":{"detectedName":"Nesciunt et.","detectedVariant":"Et voluptatem quos voluptate voluptatem eos.","droneCorrelated":true,"provider":"Dignissimos incidunt quibusdam officiis doloremque eos et.","pullRequestNumber":11,"repositoryHttp":"https://github.com/harness/drone-cli.git","repositoryPath":["Nulla ipsa.","Molestiae possimus expedita odio ut.","Et dolor doloribus.","Ut adipisci optio sit itaque assumenda."],"repositorySsh":"git@github.com:harness/drone-cli.git","sourceBranch":"feat/shiny-object","targetBranch":"develop","workspace":"/harness"},"id":"abcdef1234567890ghijkl","lastModified":1651578240,"metadata":{"baseImageDigest":"sha256:abcdef1234567890ghijkl","baseImageName":"my-image","baseImageTag":"1.0.0"},"orgId":"your_harness_org","pipelineId":"your_harness_pipeline","productId":"product111111111111111","projectId":"your_harness_project","refinementVersion":"1.0.5","stageId":"stage_id","status":"Succeeded","stepId":"step_id","subproduct":"owasp","targetVariantId":"variant111111111111111"}] - `results.codeCoverage` (number) The Code Coverage value for the Scan Example: 65.5 - `results.created` (integer, required) Unix timestamp at which the resource was created Example: 1651578240 - `results.executionId` (string, required) Pipeline Execution ID associated with the Scan Example: "abcdef1234567890ghijkl" - `results.gitMetadata` (object) Git Metadata associated with the Scan Example: {"detectedName":"Id et iste accusantium occaecati laboriosam quibusdam.","detectedVariant":"Eligendi eos qui commodi.","droneCorrelated":false,"provider":"Dignissimos reprehenderit accusamus ducimus.","pullRequestNumber":11,"repositoryHttp":"https://github.com/harness/drone-cli.git","repositoryPath":["Natus vel est rerum.","Repellendus facilis aspernatur cum ab vel.","Quae doloremque recusandae qui nostrum nam."],"repositorySsh":"git@github.com:harness/drone-cli.git","sourceBranch":"feat/shiny-object","targetBranch":"develop","workspace":"/harness"} - `results.gitMetadata.detectedName` (string) Detected Name Example: "Id et iste accusantium occaecati laboriosam quibusdam." - `results.gitMetadata.detectedVariant` (string) Detected Variant Example: "Eligendi eos qui commodi." - `results.gitMetadata.droneCorrelated` (boolean) Drone Correlated - `results.gitMetadata.provider` (string) Git Provider Example: "Dignissimos reprehenderit accusamus ducimus." - `results.gitMetadata.pullRequestNumber` (integer) Git Pull Request Number Example: 11 - `results.gitMetadata.repositoryHttp` (string) Git HTTP Repository Example: "https://github.com/harness/drone-cli.git" - `results.gitMetadata.repositoryPath` (array) Git Repository Path Example: ["Natus vel est rerum.","Repellendus facilis aspernatur cum ab vel.","Quae doloremque recusandae qui nostrum nam."] - `results.gitMetadata.repositorySsh` (string) Git SSH Repository Example: "git@github.com:harness/drone-cli.git" - `results.gitMetadata.sourceBranch` (string) Git Source Branch Example: "feat/shiny-object" - `results.gitMetadata.targetBranch` (string) Git Target Branch Example: "develop" - `results.gitMetadata.workspace` (string) Git Workspace Root Example: "/harness" - `results.id` (string, required) Resource identifier Example: "abcdef1234567890ghijkl" - `results.lastModified` (integer, required) Unix timestamp at which the resource was most recently modified Example: 1651578240 - `results.metadata` (object) Metadata specific to the entity being scanned Example: {"baseImageDigest":"sha256:1234567890abcdefghijkl","baseImageName":"alpine","baseImageTag":"3.18","deduplicatedCount":80,"imageDomain":"docker.io","imageName":"my-application","imageTag":"v1.2.3","normalizedCount":100} - `results.metadata.baseImageDigest` (string) Digest of the base image Example: "sha256:1234567890abcdefghijkl" - `results.metadata.baseImageName` (string) Name of the base image Example: "alpine" - `results.metadata.baseImageTag` (string) Tag of the base image Example: "3.18" - `results.metadata.deduplicatedCount` (integer) Total number of deduplicated issues found in the scan Example: 80 - `results.metadata.imageDomain` (string) Domain of the container image registry Example: "docker.io" - `results.metadata.imageName` (string) Name of the container image Example: "my-application" - `results.metadata.imageTag` (string) Tag of the container image Example: "v1.2.3" - `results.metadata.normalizedCount` (integer) Total number of normalized issues found in the scan Example: 100 - `results.orgId` (string, required) Harness Organization ID Example: "your_harness_org" - `results.pipelineId` (string, required) Harness Organization ID Example: "your_harness_pipeline" - `results.productId` (string, required) The Scan Product used for the Scan Example: "product111111111111111" - `results.projectId` (string, required) Harness Project ID Example: "your_harness_project" - `results.refinementVersion` (string, required) The Issue refinement version used for this Scan Example: "1.0.5" - `results.stageId` (string, required) Pipeline Stage ID associated with the Scan Example: "stage_id" - `results.status` (string, required) Current status of the Scan Enum: "Pending", "Running", "Succeeded", "Failed" - `results.stepId` (string, required) Pipeline Step ID associated with the Scan Example: "step_id" - `results.subproduct` (string) The Scan Subproduct used for the Scan Example: "owasp" - `results.targetVariantId` (string, required) The Target Variant associated with the Scan Example: "variant111111111111111" ## Response 400 fields (application/json): - `message` (string, required) Example: "Not Found" - `status` (integer) Example: 404 ## Response 401 fields (application/json): - `message` (string, required) Example: "Not Found" - `status` (integer) Example: 404 ## Response 403 fields (application/json): - `message` (string, required) Example: "Not Found" - `status` (integer) Example: 404 ## Response 404 fields (application/json): - `message` (string, required) Example: "Not Found" - `status` (integer) Example: 404 ## Response 429 fields (application/json): - `message` (string, required) Example: "Not Found" - `status` (integer) Example: 404 ## Response 500 fields (application/json): - `message` (string, required) Example: "Not Found" - `status` (integer) Example: 404