# BlockVolumes Object

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

Schema for the `BlockVolumes` resource in **Unified Cloud Infrastructure API**.

## Properties

- **`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`.

## Methods

- [GET /unified/cloud-infrastructure/block_volumes](/docs/api-reference/unified-cloud-infrastructure-api/blockvolumes/list) — List Block volumes