---
title: "Search KV entries by key pattern"
method: GET
path: "/storage/kv/{bucket}/search-by-key"
tags: ["KV Search"]
---

# Search KV entries by key pattern

`GET /storage/kv/{bucket}/search-by-key`

## Request

- Base URL: `https://api.quiva.ai`
- URL: `https://api.quiva.ai/storage/kv/{bucket}/search-by-key`
- Auth: one of:
  - HTTP bearer
  - API key in header `x-api-key`

Searches for KV entries by key pattern (e.g., 'user*')

## Path parameters

- `bucket` string, required

## Query parameters

- `search` string, required
- `limit` integer

## Response `200`

Search results

- SearchByKeyResponse
  - `body` object
    - `results` SearchKVItem[]
      - `key` string
      - `value` string
    - `results_total` integer
  - `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`: 4 breaking, 2 warning, 11 info
  - added the new path request parameter `bucket`
  - the response property `body/results/items/key` became optional for the status `200`
  - the response property `body/results/items/value` became optional for the status `200`
  - the `body/results/items/value` response's property type changed from `object` to `string` for status `200`
  - …13 more

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