Skip to main content

listInstances

client.kvStore.listInstances(params?: Record<string, unknown>): Promise<KvStoreInstance[]>

Lists all KV store instances.

Returns every instance in the system with their metadata and namespace information.

Parameters

ParameterTypeRequiredDescription
paramsRecord<string, unknown>NoOptional query parameters for filtering or pagination

Returns

Promise<KvStoreInstance[]> — A promise that resolves to an array of objects

Example

import { CodeBoltClient } from '@codebolt/clientsdk';

const client = new CodeBoltClient();

const result = await client.kvStore.listInstances();
console.log(result);