ESescape
Scans

List scan targets and API coverage

Returns targets discovered during a scan, including REST and GraphQL operations with per-endpoint coverage. Filter by target type and source (specification vs inferred) to focus on API routes and resolvers for CI/CD quality gates.

get/scans/{scanId}/targets

Request

  • Base URL
    https://public.escape.tech/v3
  • Auth
    API key in header X-ESCAPE-API-KEY

Path parameters

scanIdstring uuid required

The scan ID

Example:00000000-0000-0000-0000-000000000000

Query parameters

cursorstring

The cursor to start the pagination from. Returned by the previous page response. If not provided, the first page will be returned.

Example:R1BDOlM6NTEwMzk4NTYtNGIyOS00NTlkLTg0ZDYtMWJhYjM0NWMzZjU5
sizeinteger

The number of items to return per page

Example:50
sortType'CREATED_AT' | 'ISSUES_COUNT' | 'NAME'

The type to sort by

sortDirection'asc' | 'desc'

The direction to sort by

typesstring[]

Optional filter by target kinds (comma-separated or repeated), e.g. API_ROUTE or GRAPHQL_RESOLVER

sourcesstring[]

Optional filter by how the target was discovered (comma-separated or repeated). SOURCE_SPECIFICATION comes from the API schema; SOURCE_INFERRED was found during the scan. Applies to API_ROUTE and GRAPHQL_RESOLVER.

coveragestring[]

Optional filter by the coverage status the scanner observed on the target (comma-separated or repeated), e.g. OK or SERVER_ERROR

severitiesstring[]

Optional filter by the severity of the issues found on the target (comma-separated or repeated)

issuesstring[]

Optional filter by issue IDs found on the target

methodsstring[]

Optional filter by HTTP method (comma-separated or repeated). Applies to API_ROUTE.

searchstring

Optional free-text search on the target path

Example:/api/v1/users

Response

OK

nextCursorstring nullable required
totalCountinteger

Example response

{
  "totalCount": 20
}

Changes

No recorded changes to this operation across all 1 revision of this API.