---
name: key-value-stores-routes
description: Handle 12 OpenAPI operation(s) under /v2/key-value-stores for the key value stores route group.
---

# key value stores API Routes

Handle 12 OpenAPI operation(s) under /v2/key-value-stores for the key value stores route group.

Use the generated operation tools to make real API calls. Do not invent API responses.
If a tool reports missing setup, return the exact setup field name to the caller.
For write, update, or delete operations, state the intended action before calling the tool.

## Operations

### key_value_stores_get

- Operation ID: `key_value_stores_get`
- Route: `GET /v2/key-value-stores`
- Mode: READ
- Summary: Get list of key-value stores
- Parameters:
  - `offset` in `query`
  - `limit` in `query`
  - `desc` in `query`
  - `unnamed` in `query`
  - `ownership` in `query`

### key_value_stores_post

- Operation ID: `key_value_stores_post`
- Route: `POST /v2/key-value-stores`
- Mode: WRITE
- Summary: Create key-value store
- Parameters:
  - `name` in `query`

### key_value_store_get

- Operation ID: `key_value_store_get`
- Route: `GET /v2/key-value-stores/{storeId}`
- Mode: READ
- Summary: Get store
- Parameters:
  - `storeId` in `path` required

### key_value_store_put

- Operation ID: `key_value_store_put`
- Route: `PUT /v2/key-value-stores/{storeId}`
- Mode: WRITE
- Summary: Update store
- Parameters:
  - `storeId` in `path` required
- Body: JSON request body accepted.

### key_value_store_delete

- Operation ID: `key_value_store_delete`
- Route: `DELETE /v2/key-value-stores/{storeId}`
- Mode: WRITE
- Summary: Delete store
- Parameters:
  - `storeId` in `path` required

### key_value_store_keys_get

- Operation ID: `key_value_store_keys_get`
- Route: `GET /v2/key-value-stores/{storeId}/keys`
- Mode: READ
- Summary: Get list of keys
- Parameters:
  - `storeId` in `path` required
  - `exclusiveStartKey` in `query`
  - `limit` in `query`
  - `collection` in `query`
  - `prefix` in `query`
  - `signature` in `query`

### key_value_store_records_get

- Operation ID: `key_value_store_records_get`
- Route: `GET /v2/key-value-stores/{storeId}/records`
- Mode: READ
- Summary: Download records
- Parameters:
  - `storeId` in `path` required
  - `collection` in `query`
  - `prefix` in `query`
  - `signature` in `query`

### key_value_store_record_get

- Operation ID: `key_value_store_record_get`
- Route: `GET /v2/key-value-stores/{storeId}/records/{recordKey}`
- Mode: READ
- Summary: Get record
- Parameters:
  - `storeId` in `path` required
  - `recordKey` in `path` required
  - `attachment` in `query`
  - `signature` in `query`

### key_value_store_record_head

- Operation ID: `key_value_store_record_head`
- Route: `HEAD /v2/key-value-stores/{storeId}/records/{recordKey}`
- Mode: READ
- Summary: Check if a record exists
- Parameters:
  - `storeId` in `path` required
  - `recordKey` in `path` required

### key_value_store_record_put

- Operation ID: `key_value_store_record_put`
- Route: `PUT /v2/key-value-stores/{storeId}/records/{recordKey}`
- Mode: WRITE
- Summary: Store record
- Parameters:
  - `storeId` in `path` required
  - `recordKey` in `path` required
  - `Content-Encoding` in `header`
- Body: JSON request body accepted.

### key_value_store_record_post

- Operation ID: `key_value_store_record_post`
- Route: `POST /v2/key-value-stores/{storeId}/records/{recordKey}`
- Mode: WRITE
- Summary: Store record (POST)
- Parameters:
  - `storeId` in `path` required
  - `recordKey` in `path` required
  - `Content-Encoding` in `header`
- Body: JSON request body accepted.

### key_value_store_record_delete

- Operation ID: `key_value_store_record_delete`
- Route: `DELETE /v2/key-value-stores/{storeId}/records/{recordKey}`
- Mode: WRITE
- Summary: Delete record
- Parameters:
  - `storeId` in `path` required
  - `recordKey` in `path` required