---
title: "Get an object store bucket"
method: GET
path: "/storage/obj/{bucket}"
tags: ["Object Store"]
---

# Get an object store bucket

`GET /storage/obj/{bucket}`

## Request

- Base URL: `https://api.quiva.ai`
- URL: `https://api.quiva.ai/storage/obj/{bucket}`
- Auth: one of:
  - HTTP bearer
  - API key in header `x-api-key`
- TypeScript: <https://skmtc.dev/quivaworks/apis/quiva-ai-gateway-5/docs/storage/obj/:bucket/get.ts> (a function with typed inputs; its response is checked against the schema)

Retrieves detailed information about a specific object store, including its configuration and current state.

## Path parameters

- `bucket` string, required

## Response `200`

Successfully retrieved bucket information

- ObjectBucketResponse
  - `body` object
  - `metadata` Metadata
    - `bucket` string: Bucket name
    - `duration` string: Operation duration
    - `field` string: Search field
    - `hits` integer: Number of hits
    - `index_duration` string: Index search duration
    - `index_hits` integer: Number of index hits
    - `index_name` string: Index name
    - `index_partitions` integer: Number of index partitions
    - `key` string: Entry key
    - `limit` integer: Query limit
    - `partitions` integer: Number of partitions
    - `search` string: Search term
    - `stream` string: Stream name
    - `subject` string: Subject pattern

## Other responses

- `400`: Bad Request
- `401`: Unauthorized
- `404`: Not Found
- `500`: Internal Server Error

## Changes

- **2025-07-04** `d566a61279be`: 1 breaking, 2 warning, 6 info
  - added the new path request parameter `bucket`
  - removed the optional property `config` from the response with the `200` status
  - removed the optional property `stream_info` from the response with the `200` status
  - api operation id `getObjectStoreBucketInfo` removed and replaced with `getObjectStoreBucket`
  - …5 more
- **2025-06-13** `e4ad9e1ccd66`: 2 warning, 2 info
  - removed the optional property `bucket` from the response with the `200` status
  - removed the optional property `status` from the response with the `200` status
  - added the optional property `config` to the response with the `200` status
  - added the optional property `stream_info` to the response with the `200` status

[Operation history](https://skmtc.dev/quivaworks/apis/quiva-ai-gateway-5/changes/storage/obj/:bucket/get.md)

---

[API](https://skmtc.dev/quivaworks/apis/quiva-ai-gateway-5.md) - [All operations](https://skmtc.dev/quivaworks/apis/quiva-ai-gateway-5/llms.txt) - [OpenAPI document](https://skmtc.dev/quivaworks/apis/quiva-ai-gateway-5/revisions/104591eadd10?raw)
