---
updatedAt: 2026-05-12T09:58:51.000Z
---

# Retrieve scan details

This operation returns an object containing information about all of the full scan instances for the specified application.

# OpenAPI definition

```json
{
  "components": {
    "schemas": {
      "CodebaseMetadata": {
        "properties": {
          "name": {
            "type": "string"
          },
          "revision": {
            "type": "string"
          },
          "url": {
            "type": "string"
          }
        },
        "type": "object"
      },
      "CodebaseMetadataArray": {
        "items": {
          "$ref": "#/components/schemas/CodebaseMetadata"
        },
        "type": "array"
      },
      "EngineConf": {
        "properties": {
          "binary_exclusions": {
            "type": "string"
          },
          "binary_inclusions": {
            "type": "string"
          },
          "exclude_directories": {
            "type": "string"
          },
          "exclude_directories_console": {
            "type": "string"
          }
        },
        "type": "object"
      },
      "ErrorMessage": {
        "description": "ErrorMessage describes the error",
        "properties": {
          "code": {
            "format": "int64",
            "type": "integer"
          },
          "reason": {
            "type": "string"
          }
        },
        "type": "object"
      },
      "ScanHistory": {
        "description": "ScanHistory is the structure returned for the GET to retrieve scan information",
        "properties": {
          "appID": {
            "format": "int64",
            "type": "integer"
          },
          "applicationSize": {
            "format": "int64",
            "type": "integer"
          },
          "assetID": {
            "format": "int64",
            "type": "integer"
          },
          "codebaseMetadata": {
            "$ref": "#/components/schemas/CodebaseMetadataArray"
          },
          "completedOn": {
            "format": "date-time",
            "type": "string"
          },
          "engineConf": {
            "$ref": "#/components/schemas/EngineConf"
          },
          "filename": {
            "type": "string"
          },
          "id": {
            "format": "int64",
            "type": "integer"
          },
          "instanceID": {
            "format": "int64",
            "type": "integer"
          },
          "linesOfCode": {
            "format": "int64",
            "type": "integer"
          },
          "requestedBy": {
            "format": "int64",
            "type": "integer"
          },
          "status": {
            "type": "string"
          },
          "tag": {
            "type": "string"
          },
          "uploadedOn": {
            "format": "date-time",
            "type": "string"
          },
          "username": {
            "type": "string"
          }
        },
        "type": "object"
      },
      "ScanHistoryResponseSwagger": {
        "description": "ScanHistoryResponseSwagger holds data for all previous completed full scan instances",
        "properties": {
          "collection": {
            "items": {
              "$ref": "#/components/schemas/ScanHistory"
            },
            "type": "array"
          },
          "page": {
            "$ref": "#/components/schemas/SourceAppPageData"
          }
        },
        "type": "object"
      },
      "SourceAppPageData": {
        "properties": {
          "currentPage": {
            "format": "int64",
            "type": "integer"
          },
          "filteredCount": {
            "format": "int64",
            "type": "integer"
          },
          "totalCount": {
            "format": "int64",
            "type": "integer"
          },
          "totalPages": {
            "format": "int64",
            "type": "integer"
          }
        },
        "type": "object"
      }
    }
  },
  "info": {
    "license": {
      "name": "(c) Copyright 2020 WhiteHat Security"
    },
    "title": "Source Applications API",
    "version": "2.0.0"
  },
  "openapi": "3.0.1",
  "paths": {
    "/api/sourceApplications/{appID}/scans": {
      "get": {
        "description": "This operation returns an object containing information about all of the full scan instances for the specified application.",
        "operationId": "GetApplicationScansParams",
        "parameters": [
          {
            "description": "Offset begin showing results from item number n.",
            "in": "query",
            "name": "offset",
            "schema": {
              "format": "int64",
              "type": "integer",
              "x-go-name": "Offset"
            },
            "x-go-name": "Offset"
          },
          {
            "description": "Limit results to n number of items.",
            "in": "query",
            "name": "limit",
            "schema": {
              "format": "int64",
              "type": "integer",
              "x-go-name": "Limit"
            },
            "x-go-name": "Limit"
          },
          {
            "description": "Application ID",
            "in": "path",
            "name": "appID",
            "required": true,
            "schema": {
              "format": "int64",
              "type": "integer",
              "x-go-name": "ID"
            },
            "x-go-name": "ID"
          },
          {
            "description": "Sort results by the given field.\nSupported fields are: id, tag, filename, requestedBy, username, uploadedOn, completedOn\napplicationSize, linesOfCode, appID, assetID, status\nDefault field is completedOn\nPrefix the field name with '-' to order in descending order.\nE.g., '-name' sorts results in descending order using the  field 'name'",
            "in": "query",
            "name": "sort",
            "schema": {
              "type": "string",
              "x-go-name": "Sort"
            },
            "x-go-name": "Sort"
          },
          {
            "description": "Filter results of scan history by scan status\nValid values: pending, running, suspended, completed, aborted",
            "in": "query",
            "name": "status",
            "schema": {
              "type": "string",
              "x-go-name": "Status"
            },
            "x-go-name": "Status"
          }
        ],
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ScanHistoryResponseSwagger"
                }
              }
            },
            "description": "ScanHistoryResponse holds data for all full scan instances"
          },
          "400": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorMessage"
                }
              }
            },
            "description": "BadRequestResponse indicates a request with invalid parameters"
          },
          "401": {
            "description": "UnauthorizedResponse signals an unauthorized API access"
          },
          "403": {
            "description": "ForbiddenResponse signals a request for a resource that does not exist or is not authorized"
          },
          "500": {
            "description": "GenericError generic error"
          }
        },
        "summary": "Retrieve scan details",
        "tags": [
          "Source Applications API v2.0"
        ]
      }
    }
  },
  "servers": [
    {
      "url": "https://sentinel.whitehatsec.com/"
    }
  ],
  "tags": [
    {
      "name": "Source Applications API v2.0"
    }
  ],
  "x-explorer-enabled": false,
  "x-readme": {
    "proxy-enabled": true
  }
}
```