Skip to content
GET /unified/cloud-infrastructure/data_snapshots

Query Parameters

Refer Specifying query parameters in Truto APIs

snapshot_familystring

Which snapshot API to read: 'ebs' (default), 'rds_instance' or 'rds_cluster'. Call all three for a complete inventory, as none returns another's rows. The 'ebs' route does not accept the region parameter.

Possible values:
block_volumedatabase_clusterdatabase_instancediskebsotherrds_clusterrds_instance
1 supported
Amazon Web Services
supported
ebsrds_instancerds_cluster
regionstring

AWS region to read. One call reads one region; the caller drives any multi-region loop.

1 supported
Amazon Web Services
supported
Show Truto-specific parameters
integrated_account_idstring · uuid
required·

The ID of the integrated account to use for the request.

Example: 62f44730-dd91-461e-bd6a-aedd9e0ad79d
truto_response_formatstring

The format of the response.

  • unified returns the response with unified mappings applied.
  • raw returns the unprocessed, raw response from the remote API.
  • normalized applies the unified mappings and returns the data in a normalized format.
  • stream returns 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.
  • debug returns the final unified result alongside raw remote fetch information. The response is an envelope containing result (identical to unified mode output) and debug (with requestUrl, requestOptions, data, responseHeaders, and for list operations: nextCursor, isLooping, isEmptyResult, resultCount). When the upstream body exceeds 1 MiB, data is replaced by { truto_truncated: true, truto_max_bytes, truto_excerpt }. debug is null for static responses or when truto_skip_api_call=true.

Defaults to unified.

Example: unified
Possible values:
unifiedrawnormalizedstreamdebug
truto_key_bystring

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.

Example: id
truto_ignore_limitboolean

Ignores the limit query parameter.

truto_ignore_remote_databoolean

Excludes the remote_data attribute from the response.

truto_exclude_fieldsstring[]

Array of fields to exclude from the response.

Example: truto_exclude_fields[]=id&truto_exclude_fields[]=name
remote_queryRecord<string, any>

Query parameters to pass to the underlying API without any transformations. Refer this guide to see how to structure the query parameters.

Example: remote_query[foo]=bar

Response Body

debugobject

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.

data
isEmptyResultboolean
isLoopingboolean
nextCursorstring
requestOptionsRecord<string, any>
requestUrlstring
responseHeadersRecord<string, any>
resultCountnumber
next_cursorstring

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.

resultobject[]

List of Data snapshots

idstring
required·

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
Amazon Web Services
supported
accountstring

The account, subscription or project this object belongs to.

References: Accounts → id
1 supported
Amazon Web Services
supported
collected_atstring · date-time

When Truto actually read this object from the provider, in UTC ISO 8601 with the offset present — not the request time, and not a provider timestamp.

1 supported
Amazon Web Services
supported
created_atstring · date-time

When the snapshot was taken.

1 supported
Amazon Web Services
supported
encryptedboolean

Whether the snapshot is encrypted.

1 supported
Amazon Web Services
supported
encryption_keyobject

The key protecting the snapshot, where it is encrypted.

References: ManagedKeys → id
1 supported
Amazon Web Services
supported
1 property
idstring

The target's id.

is_publicboolean

Whether the snapshot is readable by any account on the provider.

1 supported
Amazon Web Services
supported
locationstring

Where the snapshot currently sits (not its origin — a cross-region copy reports its current location). AWS returns no location for block-volume snapshots, so the queried region is used instead.

1 supported
Amazon Web Services
supported
native_typestring

The provider's own type string, unmodified — for example 'AWS::S3::Bucket', 'aws_iam_role', 'Microsoft.Sql/servers'. Used for display and drill-down.

1 supported
Amazon Web Services
supported
providerstring

Which cloud this object was read from.

Possible values:
awsazuregcp
1 supported
Amazon Web Services
supported
provider_idstring

The provider's own identifier, passed through verbatim — a full ARN, resource id, or self-link. Never truncated, prefixed, or normalized.

1 supported
Amazon Web Services
supported
regionstring

Where the object is located. 'global' denotes genuinely global resources (e.g. IAM, GCP VPC networks) rather than a guessed region. A substituted region (when none is derivable) is flagged in unreadable_fields.

1 supported
Amazon Web Services
supported
regional_public_access_blockstring

The account-and-region-wide snapshot sharing posture. Under a block-all-sharing setting, an already-public snapshot (is_public true) is effectively private and not actually exposed.

1 supported
Amazon Web Services
supported
remote_dataRecord<string, any>

Raw data returned from the remote API call.

shared_with_accountsstring[]

Accounts this snapshot has been explicitly shared with. Empty means shared with nobody; null means the sharing attribute could not be read.

1 supported
Amazon Web Services
supported
sharing_readableboolean

Whether the per-snapshot sharing attribute was actually read. False means shared_with_accounts and is_public are inferred, not confirmed.

1 supported
Amazon Web Services
supported
snapshot_familystring

Which snapshot service this came from — block volume, database instance, database cluster, or disk. Encryption and sharing fields have different semantics per family.

Possible values:
block_volumedatabase_instancedatabase_clusterdiskother
1 supported
Amazon Web Services
supported
snapshot_idstring

The provider's own identifier for the snapshot.

1 supported
Amazon Web Services
supported
snapshot_typestring

Whether the snapshot was taken manually or by automated backup. Automated snapshots can't be shared, so their sharing fields are set by construction, not read per-snapshot.

Possible values:
manualautomatedunknown
1 supported
Amazon Web Services
supported
source_account_idstring

The account that owns the source. On AWS this is parsed from the ARN, since neither database snapshot type carries an owner field.

1 supported
Amazon Web Services
supported
source_resource_idstring

The database or volume this snapshot was taken from.

1 supported
Amazon Web Services
supported
statusstring

The provider's own status string for the snapshot, verbatim.

1 supported
Amazon Web Services
supported
tagsobject

Key-value pairs exactly as the customer set them: no case folding, key/value normalization, or merging of separate provider concepts. An empty object means no tags; tags that could not be read appear in unreadable_fields instead.

1 supported
Amazon Web Services
supported
unreadable_fieldsobject[]

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
Amazon Web Services
supported
3 properties
detailstring

Explanation of the reason, where one adds anything.

fieldstring

The property on this resource that could not be read.

reasonstring

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.

Possible values:
not_supported_by_providernot_configuredpermission_deniednot_collectedcollection_errorpartially_collectedavailable_on_get
updated_atstring

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
Amazon Web Services
supported
truto unified cloud-infrastructure datasnapshots \
  -a '<integrated_account_id>' \
  -o json
import Truto from '@truto/truto-ts-sdk';

const truto = new Truto({
  token: '<your_api_token>',
});

const result = await truto.unifiedApi.list(
  'cloud-infrastructure',
  'datasnapshots',
  { 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",
        "datasnapshots",
        {"integrated_account_id": "<integrated_account_id>"}
    ):
        print(item)

asyncio.run(main())
curl -X GET 'https://api.truto.one/unified/cloud-infrastructure/data_snapshots?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/data_snapshots?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/data_snapshots"
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())