StackHawk · Schema

StackHawk Scan

A security scan run against an application environment

API SecurityApplication SecurityDASTSecurity TestingVulnerability Management

Properties

Name	Type	Description
scanId	string	Unique scan identifier
appId	string	Application ID
envId	string	Environment ID
status	string	Current scan status
startedAt	string
completedAt	string
findingCount	integer	Total number of findings

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "$id": "https://api.stackhawk.com/schemas/scan",
  "title": "StackHawk Scan",
  "description": "A security scan run against an application environment",
  "type": "object",
  "properties": {
    "scanId": { "type": "string", "description": "Unique scan identifier" },
    "appId": { "type": "string", "description": "Application ID" },
    "envId": { "type": "string", "description": "Environment ID" },
    "status": {
      "type": "string",
      "enum": ["RUNNING", "COMPLETED", "FAILED"],
      "description": "Current scan status"
    },
    "startedAt": { "type": "string", "format": "date-time" },
    "completedAt": { "type": "string", "format": "date-time" },
    "findingCount": { "type": "integer", "description": "Total number of findings" }
  },
  "required": ["scanId", "appId", "envId", "status"]
}