List Block volumes
/unified/cloud-infrastructure/block_volumes
Query Parameters
Refer Specifying query parameters in Truto APIs
AWS region to read. One call reads one region; the caller drives any multi-region loop.
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 Block volumes
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
Whether the volume is attached to at least one virtual machine or provider-managed host right now. An attachment still being made or removed counts as attached; false means the volume is unattached.
1 supported
Where the volume is attached. Empty means unattached. A volume with multi-attach turned on can list several.
1 supported
4 properties
What the volume serves when it is attached to a provider-managed host instead of a customer virtual machine - on AWS, the ARN of the ECS or Fargate task. Null for an ordinary virtual machine attachment.
Whether the volume is deleted when the virtual machine it is attached to is terminated. False means the volume and its data outlive the machine.
The attached virtual machine, as the provider identifies it (an EC2 i- id, an Azure VM resource id, a GCP instance self-link). Null when the volume is attached to a provider-managed host the customer does not own, such as an AWS Fargate task; associated_resource_id then names what it serves.
The provider's own attachment state string, verbatim (on AWS: attaching, attached, detaching, detached or busy).
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
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
Whether the volume's data is encrypted at rest.
1 supported
The key that protects the volume at rest. Null when the volume is not encrypted, or when the provider names no key object the customer can see.
1 supported
1 property
The target's id.
Who manages the key that encrypts the volume. provider_owned: a key the provider holds outside the customer's account, with no key object the customer can see. provider_managed: the provider's default key that lives inside the customer's key service but that the customer cannot manage (for example an AWS managed aws/ key). customer_managed: a key the customer creates and controls in the key service. customer_supplied: raw key material the customer passes in with each request and the provider does not store (GCP CSEK). none: not encrypted at rest. unknown: encrypted, but who manages the key was not resolved - unreadable_fields says why. On AWS, DescribeVolumes names the key ARN but not whether it is the AWS managed aws/ebs key or a customer managed key, so an encrypted EBS volume reads unknown here; join encryption_key.id to managed_keys (managed_by) to resolve it.
provider_managedprovider_ownedcustomer_managedcustomer_suppliednoneunknown
1 supported
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
Which cloud this object was read from.
awsazuregcp
1 supported
The provider's own identifier, passed through verbatim — a full ARN, resource id, or self-link. Never truncated, prefixed, or normalized.
1 supported
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
Raw data returned from the remote API call.
The provider's own status string for the volume, verbatim (on AWS: creating, available, in-use, deleting, deleted or error).
1 supported
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
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
The provider's own identifier for the volume, verbatim (an EBS vol- id, an Azure managed disk name, a GCP persistent disk name). On AWS, data_snapshots.source_resource_id holds this same vol- id for snapshots taken from the volume.
1 supported
truto unified cloud-infrastructure blockvolumes \
-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',
'blockvolumes',
{ 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",
"blockvolumes",
{"integrated_account_id": "<integrated_account_id>"}
):
print(item)
asyncio.run(main())curl -X GET 'https://api.truto.one/unified/cloud-infrastructure/block_volumes?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/block_volumes?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/block_volumes"
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())