# FileSystems Object

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

Schema for the `FileSystems` 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.
- **`file_system_id`** _(string)_
  The provider's own identifier for the file system, verbatim (an EFS fs- id, an Azure file share name, a GCP Filestore instance name).
- **`status`** _(string)_
  The provider's own lifecycle state string for the file system, verbatim (on AWS EFS: creating, available, updating, deleting, deleted or error).
- **`encryption_at_rest`** _(boolean)_
  Whether the file system's data is encrypted at rest. Encryption in transit is a separate, client-side mount setting and is not reported here.
- **`encryption_key_type`** _(string)_
  Who manages the key that encrypts the file system at rest. 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. none: not encrypted at rest. unknown: encrypted, but who manages the key was not resolved - unreadable_fields says why. On AWS, DescribeFileSystems names the key ARN but not whether it is the AWS managed aws/elasticfilesystem key or a customer managed key, so an encrypted EFS file system reads unknown here; join encryption_key.id to managed_keys (managed_by) to resolve it.
  Allowed: `provider_managed`, `provider_owned`, `customer_managed`, `none`, `unknown`
- **`encryption_key`** _(object)_
  The key that protects the file system at rest. Null when the file system is not encrypted, or when the provider names no key object the customer can see.
  - **`id`** _(string)_
    The target's `id`.
- **`automatic_backups_enabled`** _(boolean)_
  Whether the provider's own automatic backup of this file system is on. On AWS this is the EFS backup policy (backups by AWS Backup's default plan): true only when its status is ENABLED, so a policy that is still turning on (ENABLING) reads false. A separate backup plan the customer built in AWS Backup can still cover a file system that reads false; that is not checked here.
- **`backup_policy_status`** _(string)_
  The provider's own automatic-backup status string, verbatim (on AWS EFS: ENABLED, ENABLING, DISABLED or DISABLING). Null when no backup policy exists or it could not be read - see unreadable_fields.

## Methods

- [GET /unified/cloud-infrastructure/file_systems](/docs/api-reference/unified-cloud-infrastructure-api/filesystems/list) — List File systems