StackHawk Documentation StackHawk Logo HawkDocs

No results found

Try different keywords or check your spelling

Search documentation

Find guides, API references, and more

esc

Get latest profile scan result

GET /api/v1/app/{appId}/profile/results

Retrieves the most recent profile scan result for an application with testability analysis.

Requires read:scan permission.

Path parameters

appIdstring · uuidrequired

UUID identifier for this StackHawk Application.

Response

OK

application/json
assets
scanresults.AssetInventory
Hide child attributesShow child attributes
assets.assetSummary
scanresults.AssetSummary
Hide child attributesShow child attributes
assets.assetSummary.dynamicContent
scanresults.AssetCategoryCount
Hide child attributesShow child attributes
assets.assetSummary.dynamicContent.count
integer<int32>
assets.assetSummary.dynamicContent.sampleUrls
string[]
assets.assetSummary.dynamicContent.totalSizeBytes
integer<int64>
assets.assetSummary.scripts
scanresults.AssetCategoryCount
Hide child attributesShow child attributes
assets.assetSummary.scripts.count
integer<int32>
assets.assetSummary.scripts.sampleUrls
string[]
assets.assetSummary.scripts.totalSizeBytes
integer<int64>
assets.assetSummary.staticMedia
scanresults.AssetCategoryCount
Hide child attributesShow child attributes
assets.assetSummary.staticMedia.count
integer<int32>
assets.assetSummary.staticMedia.sampleUrls
string[]
assets.assetSummary.staticMedia.totalSizeBytes
integer<int64>
assets.buildStrategy
enum<string>

Build analysis

4 available options
BUILD_SINGLE_BUNDLEBUILD_VENDOR_APP_SPLITBUILD_CODE_SPLIT_OPTIMIZEDBUILD_STRATEGY_UNKNOWN
assets.optimizationNotes
string[]
assets.totalAssets
integer<int32>

Summary

assets.totalSizeBytes
integer<int64>
authConfigPresent
boolean
authMarkers
scanresults.AuthMarker[]

Authentication markers detected

Hide child attributesShow child attributes
authMarkers.confidence
enum<string>
3 available options
AUTH_CONFIDENCE_LOWAUTH_CONFIDENCE_MEDIUMAUTH_CONFIDENCE_HIGH
authMarkers.evidence
string
authMarkers.signals
scanresults.AuthSignal[]
Hide child attributesShow child attributes
authMarkers.signals.detail
string
authMarkers.signals.signalType
enum<string>
8 available options
SIGNAL_PATH_PATTERNSIGNAL_STATUS_CODE_401_403SIGNAL_REDIRECT_TO_AUTHSIGNAL_LOGIN_FORM_DETECTEDSIGNAL_OAUTH_PROMPTSIGNAL_SESSION_COOKIESIGNAL_WWW_AUTHENTICATESIGNAL_CSRF_TOKEN
authMarkers.type
enum<string>
6 available options
AUTH_LOGIN_FORMAUTH_REDIRECT_TO_AUTHAUTH_SESSION_COOKIEAUTH_OAUTH_ENDPOINTAUTH_WWW_AUTHENTICATEAUTH_PROTECTED_ENDPOINT
classification
enum<string>

Application classification

5 available options
APP_SPA_WITH_AUTHAPP_API_WITH_AUTHAPP_PUBLIC_WEBSITEAPP_STATIC_SITEAPP_CLASSIFICATION_UNKNOWN
discoveredOpenapiSpecPath
string

Path where OpenAPI/Swagger spec was discovered (e.g., "/api/v3/api-docs") Empty if no spec was discovered

paths
scanresults.PathDiscovery
Hide child attributesShow child attributes
paths.authProtectedCount
integer<int32>
paths.dynamicCount
integer<int32>
paths.samplesAuthProtected
scanresults.PathInfo[]
Hide child attributesShow child attributes
paths.samplesAuthProtected.authEvidence
string
paths.samplesAuthProtected.method
string
paths.samplesAuthProtected.url
string
paths.samplesDynamic
scanresults.PathInfo[]
Hide child attributesShow child attributes
paths.samplesDynamic.authEvidence
string
paths.samplesDynamic.method
string
paths.samplesDynamic.url
string
paths.samplesStatic
scanresults.PathInfo[]

Sample paths (up to 10 each for UI display)

Hide child attributesShow child attributes
paths.samplesStatic.authEvidence
string
paths.samplesStatic.method
string
paths.samplesStatic.url
string
paths.staticCount
integer<int32>
paths.total
integer<int32>

Total counts

recommendations
string[]

Actionable recommendations

scanId
string
score
enum<string>

Testability assessment

3 available options
TESTABILITY_HIGHTESTABILITY_MEDIUMTESTABILITY_LOW
scoreReasons
string[]
timestamp
integer<int64>

Unauthorized

Your privacy settings

We use first and third party cookies to ensure that we give you the best experience on our website and in our products.