---
title: "Get a list of file_items"
method: POST
path: "/file_store/list"
tags: ["file_store"]
---

# Get a list of file_items

`POST /file_store/list`

This operation gets a list of file_items, allowing for sorting and pagination. Note: Entities that have not been created successfully are not listed.

## Request body

- FileItemListMetadata — All api calls that return a list will have this metadata block as input
  - `filter` string — The filter in FIQL syntax used for the results.
  - `kind` string — The kind name
  - `sort_order` string — The sort order in which results are returned
  - `offset` integer — Offset from the start of the entity list
  - `length` integer — The number of records to retrieve relative to the offset
  - `sort_attribute` string — The attribute to perform sort on

## Response `200`

Success

- FileItemListIntentResponse — Response object for intentful operation of file_items
  - `entities` FileItemIntentResource[]
    - `status` FileItemDefStatus — An intentful representation of a file_item status
      - `state` string — The state of the file_item.
      - `name` string, required — file_item Name.
      - `availability_zone_reference` AvailabilityZoneReference — The reference to a availability_zone
        - `kind` string, required — The kind name
        - `name` string
        - `uuid` string, UUID, required
      - `message_list` MessageResource[] — Any error messages for the file_item, if in an error state.
        - `message` string, required — If state is ERROR, a message describing the error.
        - `reason` string, required — If state is ERROR, a machine-readable snake-cased string.
        - `details` object — Custom key-value details relevant to the status.
      - `cluster_reference` ClusterReference — The reference to a cluster
        - `kind` string, required — The kind name
        - `name` string
        - `uuid` string, UUID, required
      - `resources` FileItemResourcesDefStatus, required — File item object
        - `retrieval_uri_list` string[] — List of URIs where the raw file_item data can be accessed.
        - `checksum` Checksum — Image checksum
          - `checksum_algorithm` string, required — The type of checksum calculated for the image
          - `checksum_value` string, bytes, required
        - `source_uri` string — URI that points at the file to create the file_item from.
        - `source_auth` SourceAuth — File item source authentication object.
          - `aws_auth` AwsCredentials — Credentials to access AWS
            - `access_key` string, required
            - `secret_key` string, required
          - `basic_auth` Credentials — Credentials to login server
            - `username` string, required
            - `password` string
        - `size_bytes` integer
      - `description` string — A description for file_item.
    - `spec` FileItem — An intentful representation of a file_item spec
      - `description` string — A description for file_item.
      - `resources` FileItemResources, required — File item spec object
        - `checksum` Checksum — Image checksum
          - `checksum_algorithm` string, required — The type of checksum calculated for the image
          - `checksum_value` string, bytes, required
        - `source_uri` string — URI that points at the file to create the file_item from.
        - `source_auth` SourceAuth — File item source authentication object.
          - `aws_auth` AwsCredentials — Credentials to access AWS
            - `access_key` string, required
            - `secret_key` string, required
          - `basic_auth` Credentials — Credentials to login server
            - `username` string, required
            - `password` string
      - `cluster_reference` ClusterReference — The reference to a cluster
        - `kind` string, required — The kind name
        - `name` string
        - `uuid` string, UUID, required
      - `name` string, required — file_item Name.
      - `availability_zone_reference` AvailabilityZoneReference — The reference to a availability_zone
        - `kind` string, required — The kind name
        - `name` string
        - `uuid` string, UUID, required
    - `api_version` string
    - `metadata` FileItemMetadata, required — The file_item kind metadata
      - `last_update_time` string, date-time — UTC date and time in RFC-3339 format when file_item was last updated
      - `kind` string, required — The kind name
      - `uuid` string, UUID — file_item uuid
      - `spec_version` integer — Version number of the latest spec.
      - `creation_time` string, date-time — UTC date and time in RFC-3339 format when file_item was created
      - `spec_hash` string — Hash of the spec. This will be returned from server.
      - `should_force_translate` boolean — Applied on Prism Central only. Indicate whether force to translate the spec of the fanout request to fit the target cluster API schema.
      - `owner_reference` UserReference — The reference to a user
        - `kind` string, required — The kind name
        - `name` string
        - `uuid` string, UUID, required
      - `categories` object — Categories for the file_item
      - `name` string — file_item name
  - `api_version` string, required
  - `metadata` FileItemListMetadataOutput, required — All api calls that return a list will have this metadata block
    - `filter` string — The filter used for the results
    - `kind` string — The kind name
    - `sort_order` string — The sort order in which results are returned
    - `offset` integer — Offset from the start of the entity list
    - `total_matches` integer — Total matches found
    - `length` integer — The number of records retrieved relative to the offset
    - `sort_attribute` string — The attribute to perform sort on

## Other responses

- `default` — Internal Error

---

[API](https://skmtc.net/nutanix/apis/nutanix-intentful-api.md) · [All operations](https://skmtc.net/nutanix/apis/nutanix-intentful-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/nutanix/nutanix-intentful-api/revisions/40395083ab31/schema)