---
title: "Get KV bucket details"
method: GET
path: "/storage/kv/{bucket}"
tags: ["KV Buckets"]
---

# Get KV bucket details

`GET /storage/kv/{bucket}`

## Request

- Base URL: `https://api.quiva.ai`
- URL: `https://api.quiva.ai/storage/kv/{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/kv/:bucket/get.ts> (a function with typed inputs; its response is checked against the schema)

Retrieves information about a specific KV bucket

## Path parameters

- `bucket` string, required

## Response `200`

Successfully retrieved bucket information

- KVBucketResponse
  - `body` object
    - `status` object
      - `backing_store` string
      - `bucket` string
      - `description` string
      - `bytes` integer
      - `history` integer
      - `ttl` integer
      - `is_compressed` boolean
    - `config` object
      - `bucket` string
      - `max_bytes` integer
      - `max_value_size` integer
      - `history` integer
      - `num_replicas` integer
    - `stream_info` object
      - `cluster` object
        - `leader` string
        - `name` string
        - `replicas` object[]
          - `active` integer
          - `current` boolean
          - `name` string
      - `config` object
        - `allow_direct` boolean
        - `allow_rollup_hdrs` boolean
        - `compression` string
        - `consumer_limits` object
          - `inactive_threshold` integer
          - `max_ack_pending` integer
        - `deny_delete` boolean
        - `discard` 'old' | 'new'
        - `duplicate_window` integer
        - `index_config` object
          - `engine` string
          - `idBy` string
          - `partitions` integer
          - `version` integer
        - `max_age` integer
        - `max_bytes` integer
        - `max_consumers` integer
        - `max_msg_size` integer
        - `max_msgs` integer
        - `max_msgs_per_subject` integer
        - `mirror_direct` boolean
        - `name` string
        - `num_replicas` integer
        - `retention` 'Limits' | 'Interest' | 'WorkQueue'
        - `storage` 'file' | 'memory'
        - `subject_transform` object
          - `dest` string
          - `src` string
        - `subjects` string[]
        - `metadata` object
      - `created` string, date-time
      - `state` object
        - `bytes` integer
        - `consumer_count` integer
        - `deleted` integer[]
        - `first_seq` integer
        - `first_ts` string, date-time
        - `last_seq` integer
        - `last_ts` string, date-time
        - `messages` integer
        - `num_deleted` integer
        - `num_subjects` integer
        - `subjects` 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** `08adefb664bb`: 3 info
  - added the optional property `body/config` to the response with the `200` status
  - added the optional property `body/status` to the response with the `200` status
  - added the optional property `body/stream_info` to the response with the `200` status
- **2025-07-04** `d566a61279be`: 1 breaking, 8 warning, 20 info
  - added the new path request parameter `bucket`
  - removed the optional property `backing_store` from the response with the `200` status
  - removed the optional property `bucket` from the response with the `200` status
  - removed the optional property `bytes` from the response with the `200` status
  - …25 more
- **2025-06-13** `e4ad9e1ccd66`: 1 info
  - the endpoint scheme security `bearerAuth` was removed from the API

[Operation history](https://skmtc.dev/quivaworks/apis/quiva-ai-gateway-5/changes/storage/kv/: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)