v2

latestOpenAPI 3.0.1private2026-07-2667209320.4 KB
Perch

Search devices for multiple apps

Search Devices

Searches for devices matching the provided application IDs within the specified organization.

This endpoint accepts a SearchDevicesRequest with a queryAppIds filter to retrieve the status of cloud-based security scan infrastructure for multiple applications in a single request. All requested application IDs must belong to the specified organization.

Request

Provide a SearchDevicesRequest body with a queryAppIds filter in the page.filters field. If no queryAppIds filter is provided, the endpoint returns an empty response.

Response

ParameterDefaultDescription
perchDevices[]
totalCount0
pageInfo{}

Errors

  • 403 Forbidden: One or more application IDs do not belong to the specified organization.
  • 404 Not Found: Organization not found or user doesn't have access.

Requires read:device permission.

post/api/v1/org/{orgId}/perch/status

Path parameters

orgIdstring uuid required

UUID identifier for this StackHawk Organization.

Request body

orgIdstring

Response

OK

totalCountinteger