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>'
{
  "body": {
    "status": {
      "backing_store": "<string>",
      "bucket": "<string>",
      "description": "<string>",
      "bytes": 123,
      "history": 123,
      "ttl": 123,
      "is_compressed": true
    },
    "config": {
      "bucket": "<string>",
      "max_bytes": 123,
      "max_value_size": 123,
      "history": 123,
      "num_replicas": 123
    },
    "stream_info": {
      "cluster": {
        "leader": "<string>",
        "name": "<string>",
        "replicas": [
          {
            "active": 123,
            "current": true,
            "name": "<string>"
          }
        ]
      },
      "config": {
        "allow_direct": true,
        "allow_rollup_hdrs": true,
        "compression": "<string>",
        "consumer_limits": {
          "inactive_threshold": 123,
          "max_ack_pending": 123
        },
        "deny_delete": true,
        "discard": "old",
        "duplicate_window": 123,
        "index_config": {
          "engine": "<string>",
          "idBy": "<string>",
          "partitions": 123,
          "version": 123
        },
        "max_age": 123,
        "max_bytes": 123,
        "max_consumers": 123,
        "max_msg_size": 123,
        "max_msgs": 123,
        "max_msgs_per_subject": 123,
        "mirror_direct": true,
        "name": "<string>",
        "num_replicas": 123,
        "retention": "Limits",
        "storage": "file",
        "subject_transform": {
          "dest": "<string>",
          "src": "<string>"
        },
        "subjects": [
          "<string>"
        ],
        "metadata": {}
      },
      "created": "2023-11-07T05:31:56Z",
      "state": {
        "bytes": 123,
        "consumer_count": 123,
        "deleted": [
          123
        ],
        "first_seq": 123,
        "first_ts": "2023-11-07T05:31:56Z",
        "last_seq": 123,
        "last_ts": "2023-11-07T05:31:56Z",
        "messages": 123,
        "num_deleted": 123,
        "num_subjects": 123,
        "subjects": {}
      }
    }
  },
  "metadata": {
    "bucket": "<string>",
    "duration": "<string>",
    "field": "<string>",
    "hits": 123,
    "index_duration": "<string>",
    "index_hits": 123,
    "index_name": "<string>",
    "index_partitions": 123,
    "key": "<string>",
    "limit": 123,
    "partitions": 123,
    "search": "<string>",
    "stream": "<string>",
    "subject": "<string>"
  }
}

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