Launch Profile Scan

POST /api/v1/app/{appId}/perch/profile-scan

Triggers a profile scan for an application with automatic OpenAPI spec discovery

🧾 Audited This is recorded as SCAN_STARTED User Activity.

Requires write:device permission.

Path parameters

appIdstring · uuidrequired

UUID identifier for this StackHawk Application.

Response

scanKey

string

scanKey

string

Bad Request

Unauthorized

POST /api/v1/app/{appId}/perch/profile-scan

cURL

curl --request POST \
  --url 'https://api.stackhawk.com/api/v1/app/{appId}/perch/profile-scan' \
  --header 'Authorization: Bearer YOUR_ACCESS_TOKEN'

Copy

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.