---
title: "Query a registered storage index."
method: POST
path: "/v2/console/storage/index/{name}/query"
tags: ["Console"]
---

# Query a registered storage index.

`POST /v2/console/storage/index/{name}/query`

## Request

- Base URL: `http://127.0.0.1:7351`
- URL: `http://127.0.0.1:7351/v2/console/storage/index/{name}/query`
- Auth: API key in header `Authorization`

## Path parameters

- `name` string, required

## Request body

- QueryStorageIndexBody
  - `query` string: Index query.
  - `limit` integer: Max number of results per page.
  - `order` string[]: Optional sorting for the results.
  - `cursor` string: Optional cursor to retrieve next page of records.

## Response `200`

A successful response.

- StorageIndexList
  - `objects` StorageObject[]: A list of storage objects.
    - `collection` string: The collection which stores the object.
    - `key` string: The key of the object within the collection.
    - `user_id` string: The user owner of the object.
    - `value` string: The value of the object.
    - `version` string: The version hash of the object.
    - `permission_read` integer: The read access permissions for the object.
    - `permission_write` integer: The write access permissions for the object.
    - `create_time` string, date-time: The UNIX time (for gRPC clients) or ISO string (for REST clients) when the object was created.
    - `update_time` string, date-time: The UNIX time (for gRPC clients) or ISO string (for REST clients) when the object was last updated.
  - `next_cursor` string: Cursor to fetch next page of results, if any.

## Other responses

- `default`: An unexpected error response.

---

[API](https://skmtc.dev/heroiclabs/apis/nakama-console-api-v2.md) - [All operations](https://skmtc.dev/heroiclabs/apis/nakama-console-api-v2/llms.txt) - [OpenAPI document](https://skmtc.dev/heroiclabs/apis/nakama-console-api-v2/revisions/fbde2e3c5ead?raw)