Skip to main content
GET
/
storage
/
kv
/
{bucket}
Get KV bucket details
curl --request GET \
  --url https://api.quiva.ai/storage/kv/{bucket} \
  --header 'Authorization: Bearer <token>'
import requests

url = "https://api.quiva.ai/storage/kv/{bucket}"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.quiva.ai/storage/kv/{bucket}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.quiva.ai/storage/kv/{bucket}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}
package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.quiva.ai/storage/kv/{bucket}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.get("https://api.quiva.ai/storage/kv/{bucket}")
  .header("Authorization", "Bearer <token>")
  .asString();
require 'uri'
require 'net/http'

url = URI("https://api.quiva.ai/storage/kv/{bucket}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body
{
  "body": {
    "status": {
      "backing_store": "BStream",
      "bucket": "products",
      "description": "Product catalog",
      "bytes": 52428800,
      "history": 5,
      "ttl": 0,
      "is_compressed": true
    },
    "config": {
      "bucket": "products",
      "max_bytes": 10737418240,
      "max_value_size": 1048576,
      "history": 5,
      "num_replicas": 3
    },
    "stream_info": {
      "cluster": {
        "leader": "node-1",
        "name": "quiva-cluster",
        "replicas": [
          {
            "active": 0,
            "current": true,
            "name": "node-2"
          },
          {
            "active": 0,
            "current": true,
            "name": "node-3"
          }
        ]
      },
      "config": {
        "name": "KV_products",
        "subjects": [
          "$KV.products.>"
        ],
        "retention": "Limits",
        "storage": "file",
        "num_replicas": 3,
        "discard": "old"
      },
      "created": "2025-05-08T12:49:45.029Z",
      "state": {
        "messages": 1250,
        "bytes": 52428800,
        "first_seq": 1,
        "last_seq": 1250,
        "consumer_count": 2,
        "num_subjects": 1250
      }
    }
  },
  "metadata": {
    "bucket": "products",
    "duration": "3ms"
  }
}
{
  "error": "validation_error"
}
{
  "error": "unauthorized"
}
{
  "error": "not_found"
}
{
  "error": "internal_error"
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
bucket
string
required

Name of the bucket

Response

Successfully retrieved bucket information

​
body
object
​
metadata
object