List Scan coverages
/unified/cloud-infrastructure/scan_coverages
Query Parameters
Refer Specifying query parameters in Truto APIs
AWS region to read. Inspector v2 is regional. A region where Inspector is off returns an empty list (HTTP 200), not an error: read security_product_states?product=inspector to tell "nothing to scan" from "not scanning".
1 supported
Accepted and has no effect on scan_coverages: every resource_type row already carries resources_in_scope, resources_scanned, resources_not_scanned and coverage_percent. fields[]=a&fields[]=b or a comma list.
1 supported
resource_type (default): one row per resource type with in-scope (every resource Inspector lists), scanned (ACTIVE) and not-scanned counts, from two ListCoverageStatistics calls per page; if the ACTIVE call fails the row still returns, with the scanned counts null and flagged collection_error. resource: one row per covered resource and scan type (Inspector ListCoverage), with scan_status and scan_status_reason, so an unscanned resource can be listed by id. Any other value is refused.
resourceresource_type
1 supported
AWS_EC2_INSTANCE, AWS_ECR_CONTAINER_IMAGE, AWS_ECR_REPOSITORY, AWS_LAMBDA_FUNCTION, CODE_REPOSITORY, AWS_ACCOUNT, or an Inspector Azure type such as Microsoft.Compute/virtualMachines (case-insensitive). One value, a comma list, or repeated as name[]=a&name[]=b. Any other value fails the request. Sent to AWS as filterCriteria.resourceType.
1 supported
Needs granularity=resource; without it the request fails (aggregate rows carry both counts). covered (Inspector ACTIVE, including resources still waiting for their first scan - see scan_status_reason), not_covered (INACTIVE) or unknown (matches nothing). One value, a comma list, or repeated as name[]=a&name[]=b. Any other value fails the request.
coverednot_coveredunknown
1 supported
Show Truto-specific parameters
The ID of the integrated account to use for the request.
62f44730-dd91-461e-bd6a-aedd9e0ad79dThe format of the response.
unifiedreturns the response with unified mappings applied.rawreturns the unprocessed, raw response from the remote API.normalizedapplies the unified mappings and returns the data in a normalized format.streamreturns the response as a stream, which is ideal for transmitting large datasets, files, or binary data. Using streaming mode helps to efficiently handle large payloads or real-time data flows without requiring the entire data to be buffered in memory.debugreturns the final unified result alongside raw remote fetch information. The response is an envelope containingresult(identical to unified mode output) anddebug(withrequestUrl,requestOptions,data,responseHeaders, and for list operations:nextCursor,isLooping,isEmptyResult,resultCount). When the upstream body exceeds 1 MiB,datais replaced by{ truto_truncated: true, truto_max_bytes, truto_excerpt }.debugisnullfor static responses or whentruto_skip_api_call=true.
Defaults to unified.
unifiedunifiedrawnormalizedstreamdebug
By default the result attribute is an array of objects. This parameter allows you to specify a field in each result objects to use as key, which transforms the result array into an object with the array items keyed by the field. This is useful for when you want to use the result as a lookup table.
idIgnores the limit query parameter.
Excludes the remote_data attribute from the response.
Array of fields to exclude from the response.
truto_exclude_fields[]=id&truto_exclude_fields[]=nameQuery parameters to pass to the underlying API without any transformations. Refer this guide to see how to structure the query parameters.
remote_query[foo]=barResponse Body
Present only when truto_response_format=debug. Contains raw fetch details: requestUrl, requestOptions, data, responseHeaders, nextCursor, isLooping, isEmptyResult, resultCount. data is the parsed upstream body; when its JSON form exceeds 1 MiB it is replaced by { truto_truncated: true, truto_max_bytes, truto_excerpt }, where truto_excerpt is the leading bytes of that body. The same applies to a string requestOptions.body. null for static responses or when truto_skip_api_call=true.
The cursor to use for the next page of results. Pass this value as next_cursor in the query parameter in the next request to get the next page of results.
List of Scan coverages
Truto's stable unified identifier for this object. Opaque; use provider_id to address the object in the provider's own console or API.
1 supported
The account, subscription or project this object belongs to.
1 supported
When Truto actually read this object from the provider, in UTC ISO 8601 with offset. Not the request time, and not a provider timestamp.
1 supported
Whether the provider returned a ceiling rather than true counts — coverage_percent should not be read as exact in that case.
1 supported
Stable reference for this coverage row.
1 supported
Scanned as a proportion of in-scope, where both counts are known. Derived.
1 supported
When the object was created at the provider, in UTC ISO 8601. Null when the provider does not record one - see unreadable_fields.
1 supported
When the scanner last ran for this resource type.
1 supported
The provider's own type string, unmodified — e.g. 'AWS::S3::Bucket', 'aws_iam_role', 'Microsoft.Sql/servers'.
1 supported
Which cloud this object was read from.
awsazuregcp
1 supported
The provider's own identifier — a full ARN, resource id, or self-link — passed through verbatim, never truncated or normalized.
1 supported
Where the object is. 'global' marks resources with no region (e.g. IAM, a GCP VPC network). If the provider returns no location, the queried region is substituted and flagged in unreadable_fields.
1 supported
Raw data returned from the remote API call.
Per-resource rows only (granularity=resource): the covered resource, as the provider names it. Absent on aggregate rows.
1 supported
The resource type being scanned, as the provider names it.
1 supported
How many resources of this type exist in the account and region.
1 supported
How many resources are not covered by the scanner.
1 supported
How many of them the scanner actually covers.
1 supported
Per-resource rows only: whether the scanner covers this resource. not_covered means its findings, or their absence, say nothing about it. covered includes a resource still waiting for its first scan, which has no result yet - scan_status_reason says which (on AWS PENDING_INITIAL_SCAN versus SUCCESSFUL). Absent on aggregate rows.
coverednot_coveredunknown
1 supported
Per-resource rows only: the provider's own reason for scan_status, verbatim (on AWS e.g. SUCCESSFUL, PENDING_INITIAL_SCAN, UNMANAGED_EC2_INSTANCE, UNSUPPORTED_RUNTIME, EXCLUDED_BY_TAG).
1 supported
What kind of scan this is — for example package, code, network or data.
1 supported
Which scanning product this coverage describes.
1 supported
Key-value pairs exactly as the customer set them, with no case folding or normalization. An empty object means no tags; tags that could not be read appear in unreadable_fields instead.
1 supported
Fields on this object that could not be read, and why. An empty array means everything was read. Use this to tell a real value from a missing one.
1 supported
3 properties
Explanation of the reason, where one adds anything.
The property on this resource that could not be read.
Why the field could not be read. available_on_get: Not read on list to keep the list fast; call GET for this resource's id to get it.
not_supported_by_providernot_configuredpermission_deniednot_collectedcollection_errorpartially_collectedavailable_on_get
When the object was last modified at the provider, in UTC ISO 8601. Null when the provider does not record one - see unreadable_fields.
1 supported
truto unified cloud-infrastructure scancoverages \
-a '<integrated_account_id>' \
-o jsonimport Truto from '@truto/truto-ts-sdk';
const truto = new Truto({
token: '<your_api_token>',
});
const result = await truto.unifiedApi.list(
'cloud-infrastructure',
'scancoverages',
{ integrated_account_id: '<integrated_account_id>' }
);
console.log(result);import asyncio
from truto_python_sdk import TrutoApi
truto_api = TrutoApi(token="<your_api_token>")
async def main():
async for item in truto_api.unified_api.list(
"cloud-infrastructure",
"scancoverages",
{"integrated_account_id": "<integrated_account_id>"}
):
print(item)
asyncio.run(main())curl -X GET 'https://api.truto.one/unified/cloud-infrastructure/scan_coverages?integrated_account_id=<integrated_account_id>' \
-H 'Authorization: Bearer <your_api_token>' \
-H 'Content-Type: application/json'const integratedAccountId = '<integrated_account_id>';
const response = await fetch(`https://api.truto.one/unified/cloud-infrastructure/scan_coverages?integrated_account_id=${integratedAccountId}`, {
method: 'GET',
headers: {
'Authorization': 'Bearer <your_api_token>',
'Content-Type': 'application/json',
},
});
const data = await response.json();
console.log(data);import requests
url = "https://api.truto.one/unified/cloud-infrastructure/scan_coverages"
headers = {
"Authorization": "Bearer <your_api_token>",
"Content-Type": "application/json",
}
params = {
"integrated_account_id": "<integrated_account_id>"
}
response = requests.get(url, headers=headers, params=params)
print(response.json())