Skip to main content
GET
List scan subproject stats
This endpoint is experimental. It may change or be removed without notice and is not covered by API stability guarantees.

Authorizations

Authorization
string
header
required

Get access to data with your API token. Example header:

Authorization: Bearer 2991e2fb4b540fe75b8f90677b0b892b6314e4961cb001fe6eb452eee248a628

The token can be provisioned from the Tokens section in your Settings, and requires explicitly enabling Web API access.

Path Parameters

deploymentId
string<int64>
required

The unique numerical identifier of the deployment containing the scan.

Example:

"1234"

scanId
string<int64>
required

The unique numerical identifier of the scan to inspect.

Example:

"12345"

Query Parameters

cursor
string

The nextCursor from the previous page. Omit for the first page.

limit
integer<int64>

Maximum subprojects per page. Defaults to 100; must be between 1 and 500.

Example:

100

Response

200 - application/json

OK

subprojects
object[]

Subproject statistics for this page of the requested scan.

nextCursor
string

Cursor for the next page. Absent on the last page.

availability
enum<string>

Whether the scan recorded subproject statistics. When NOT_RECORDED, subprojects is empty because there is no evidence, not because the scan found no subprojects.

Available options:
SUBPROJECT_STATS_AVAILABILITY_RECORDED,
SUBPROJECT_STATS_AVAILABILITY_NOT_RECORDED
Example:

"SUBPROJECT_STATS_AVAILABILITY_RECORDED"