# List Block volumes

> Source: https://truto.one/docs/api-reference/unified-cloud-infrastructure-api/blockvolumes/list/

`GET /unified/cloud-infrastructure/block_volumes`

Resource: **BlockVolumes** · API: **Unified Cloud Infrastructure API**

## Supported integrations

Amazon Web Services

## Query parameters

- **`integrated_account_id`** _(string, required)_
  The ID of the integrated account to use for the request.
- **`truto_response_format`** _(string)_
  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`.
  Allowed: `unified`, `raw`, `normalized`, `stream`, `debug`
- **`truto_key_by`** _(string)_
  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.
- **`truto_ignore_limit`** _(boolean)_
  Ignores the `limit` query parameter.
- **`truto_ignore_remote_data`** _(boolean)_
  Excludes the `remote_data` attribute from the response.
- **`truto_exclude_fields`** _(array<string>)_
  Array of fields to exclude from the response.
- **`remote_query`** _(object)_
  Query parameters to pass to the underlying API without any transformations. Refer [this guide](https://truto.one/docs/api-reference/overview/querying#remote-query-parameters) to see how to structure the query parameters.
- **`region`** _(string)_
  AWS region to read. One call reads one region; the caller drives any multi-region loop.

## Response body

- **`result`** _(array<object>)_
  List of Block volumes
  - **`id`** _(string, 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.
  - **`provider_id`** _(string)_
    The provider's own identifier, passed through verbatim — a full ARN, resource id, or self-link. Never truncated, prefixed, or normalized.
  - **`provider`** _(string)_
    Which cloud this object was read from.
    Allowed: `aws`, `azure`, `gcp`
  - **`account`** _(string)_
    The account, subscription or project this object belongs to.
  - **`region`** _(string)_
    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.
  - **`native_type`** _(string)_
    The provider's own type string, unmodified — for example 'AWS::S3::Bucket', 'aws_iam_role', 'Microsoft.Sql/servers'. Used for display and drill-down.
  - **`tags`** _(object)_
    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.
  - **`collected_at`** _(string)_
    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.
  - **`updated_at`** _(string)_
    When the object was last modified at the provider, in UTC ISO 8601. Null when the provider does not record one - see unreadable_fields.
  - **`created_at`** _(string)_
    When the object was created at the provider, in UTC ISO 8601. Null when the provider does not record one - see unreadable_fields.
  - **`unreadable_fields`** _(array<object>)_
    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.
    - **`field`** _(string)_
      The property on this resource that could not be read.
    - **`reason`** _(string)_
      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.
      Allowed: `not_supported_by_provider`, `not_configured`, `permission_denied`, `not_collected`, `collection_error`, `partially_collected`, `available_on_get`
    - **`detail`** _(string)_
      Explanation of the reason, where one adds anything.
  - **`remote_data`** _(object)_
    Raw data returned from the remote API call.
  - **`volume_id`** _(string)_
    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.
  - **`status`** _(string)_
    The provider's own status string for the volume, verbatim (on AWS: creating, available, in-use, deleting, deleted or error).
  - **`attached`** _(boolean)_
    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.
  - **`attachments`** _(array<object>)_
    Where the volume is attached. Empty means unattached. A volume with multi-attach turned on can list several.
    - **`instance_id`** _(string)_
      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.
    - **`associated_resource_id`** _(string)_
      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.
    - **`state`** _(string)_
      The provider's own attachment state string, verbatim (on AWS: attaching, attached, detaching, detached or busy).
    - **`delete_on_termination`** _(boolean)_
      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.
  - **`encryption_at_rest`** _(boolean)_
    Whether the volume's data is encrypted at rest.
  - **`encryption_key_type`** _(string)_
    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/<service> 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.
    Allowed: `provider_managed`, `provider_owned`, `customer_managed`, `customer_supplied`, `none`, `unknown`
  - **`encryption_key`** _(object)_
    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.
    - **`id`** _(string)_
      The target's `id`.
- **`next_cursor`** _(string)_
  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.
- **`debug`** _(object)_
  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`.
  - **`requestUrl`** _(string)_
  - **`requestOptions`** _(object)_
  - **`data`** _(unknown)_
  - **`responseHeaders`** _(object)_
  - **`nextCursor`** _(string)_
  - **`isLooping`** _(boolean)_
  - **`isEmptyResult`** _(boolean)_
  - **`resultCount`** _(number)_

## Code examples

### Truto CLI

```bash
truto unified cloud-infrastructure blockvolumes \
  -a '<integrated_account_id>' \
  -o json
```

### Truto TS SDK

```typescript
import 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);
```

### Truto Python SDK

```python
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

```bash
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'
```

### JavaScript

```javascript
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);
```

### Python

```python
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())
```