ClientService

Batch Get Risk Summaries

Retrieves the RiskSummary for multiple Checks in a single request. All names must belong to teams within the Organization specified by parent. Maximum of 100 summaries can be retrieved per request.

get/v1alpha2/organizations/{organization}/riskSummaries:batchGet

Request

  • Base URL: https://api.thirdfort.dev/client/api
  • URL: https://api.thirdfort.dev/client/api/v1alpha2/organizations/{organization}/riskSummaries:batchGet
  • Auth: HTTP bearer

Path parameters

organizationstring required

The organization identifier of the resource path.

Query parameters

namesstring[] required

Required. RiskSummary resource names to retrieve. Format: organizations/{organization}/teams/{team}/checks/{check}/riskSummary. Must contain between 1 and 100 names; an empty list or more than 100 is rejected. The response mirrors this list positionally. A summary is returned for every requested name, so a check with no risk indicators yields an empty summary rather than a not-found error.

Response

A successful response.

Changes

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