The basics
Common parameters, pagination, the response envelope and behaviour specific to this product.
Pagination
Lists are paginated with page and limit; if limit exceeds the maximum, the request returns 400. Page information is in the pagination object: total, page, limit, totalPages (for report credentials and scan findings this object is inside data). Exception: the leak event list returns no page information — if fewer records than limit come back, you are on the last page.
/v1/leakslimit: default 50 · max 100/v1/leaks/{reportId}/credentialslimit: default 50 · max 100/v1/leak-eventslimit: default 50 · max 100/v1/scanslimit: default 50 · max 100/v1/scans/{scanId}/findingslimit: default 50 · max 100/v1/inventorylimit: default 50 · max 100/v1/analyseslimit: default 25 · max 100/v1/protection-resourceslimit: default 50 · max 100/v1/requestslimit: default 50 · max 100/v1/webhooks/{groupId}/deliverieslimit: default 100 · max 100GET /v1/leaks?page=2&limit=50
Filters
Events and reports are filtered by type (type), severity (severity), date range and protection resource group.
Response envelope
Successful responses carry success, message and data; lists come inside data with pagination info.
{
"success": true,
"data": { "reports": [ ... ] },
"pagination": { "total": 142, "page": 2, "limit": 50, "totalPages": 3 }
}