Stop a hosted scan
/api/v1/app/{appId}/perch/stop 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_ERROREDUser Activity.
Requires
write:scanpermission.
Path parameters
appIdstring · uuidrequiredUUID identifier for this StackHawk Application.
Body
Response
OK
33 available options
OFFLINEONLINERUNNINGHEARTBEATHOSTED_SCANNER_CONNECTEDHOSTED_SCANNER_PROVISIONINGHOSTED_SCANNER_DISCONNECTEDHOSTED_SCANNER_ERROREDSCREENR_STARTINGSCREENR_BROWSER_READYSCREENR_MCP_READYSCREENR_READYSCREENR_ANALYZINGSCREENR_SESSION_COMPLETESCREENR_CONNECTEDCONFIG_VALIDATOR_CONNECTEDCONFIG_VALIDATION_RUNNINGCONFIG_VALIDATION_COMPLETECONFIG_VALIDATION_FAILEDAUTH_VALIDATOR_CONNECTEDAUTH_VALIDATION_RUNNINGAUTH_VALIDATION_COMPLETEAUTH_VALIDATION_FAILEDSCREENR_SESSION_ABANDONEDSCREENR_SESSION_COMPLETEDVALIDATOR_CONNECTEDSCREENR_ASSET_NOT_FOUNDHOSTED_VALIDATOR_PROVISIONINGSCREENR_AUTH_LOGGED_INSCREENR_AUTH_LOGIN_TIMEOUTSCREENR_AUTH_CONFIG_COMPLETESCREENR_AUTH_CONFIG_FAILEDSCREENR_AUTH_READY33 available options
OFFLINEONLINERUNNINGHEARTBEATHOSTED_SCANNER_CONNECTEDHOSTED_SCANNER_PROVISIONINGHOSTED_SCANNER_DISCONNECTEDHOSTED_SCANNER_ERROREDSCREENR_STARTINGSCREENR_BROWSER_READYSCREENR_MCP_READYSCREENR_READYSCREENR_ANALYZINGSCREENR_SESSION_COMPLETESCREENR_CONNECTEDCONFIG_VALIDATOR_CONNECTEDCONFIG_VALIDATION_RUNNINGCONFIG_VALIDATION_COMPLETECONFIG_VALIDATION_FAILEDAUTH_VALIDATOR_CONNECTEDAUTH_VALIDATION_RUNNINGAUTH_VALIDATION_COMPLETEAUTH_VALIDATION_FAILEDSCREENR_SESSION_ABANDONEDSCREENR_SESSION_COMPLETEDVALIDATOR_CONNECTEDSCREENR_ASSET_NOT_FOUNDHOSTED_VALIDATOR_PROVISIONINGSCREENR_AUTH_LOGGED_INSCREENR_AUTH_LOGIN_TIMEOUTSCREENR_AUTH_CONFIG_COMPLETESCREENR_AUTH_CONFIG_FAILEDSCREENR_AUTH_READYBad Request
Unauthorized