v2
latestOpenAPI 3.0.1private2026-07-2667209320.4 KBPerch
Stop a hosted scan
Stop a Scan
Stops a running hosted security scan and cleans up the resources used for the scan.
This endpoint will immediately stop any running scan for the specified application and clean up the associated hosted resources.
Prerequisites
- A scan must be currently running for this application
Request Body
| Parameter | Default | Description |
|---|---|---|
| id | "" | |
| name | "" | |
| command | {} |
Response
| Parameter | Default | Description |
|---|---|---|
| id | "" | |
| name | "" | |
| status | "UNKNOWN" |
{
"id": "",
"name": "",
"status": "UNKNOWN"
}
Status Response
The response will include a status of HOSTED_SCANNER_DISCONNECTED to indicate the scan has been successfully stopped.
Errors
- 404 Not Found: Application not found, no active scan, or user doesn't have access
👥 Teams Supported If the application belongs to a StackHawk Team, only members of the Team can call this endpoint. 🧾 Audited This is recorded as SCAN_ERRORED User Activity.
Requires write:scan permission.
post/api/v1/app/{appId}/perch/stop
Path parameters
appIdstring uuid required
UUID identifier for this StackHawk Application.
Request body
Response
OK