HTTP List Keys

Lists keys in a bucket.

Not for production use

This operation requires traversing all keys stored in the cluster and should not be used in production.


# Using the default bucket type
GET /buckets/bucket/keys?keys=true    # List all keys
GET /buckets/bucket/keys?keys=stream  # Stream keys to the client

# Using a non-default bucket type
GET /types/<type>/buckets/bucket/keys?keys=true
GET /types/<type>/buckets/bucket/keys?keys=stream

Required query parameters:

  • keys - defaults to false. When set to true all keys will be returned in a single payload. When set to stream, keys will be returned in chunked-encoding.


Normal response codes:

  • 200 OK

Important headers:

  • Content-Type - application/json
  • Transfer-Encoding - chunked when the keys query parameter is set to stream.

The JSON object in the response will contain up to two entries, "props" and "keys" which are present or missing according to the query parameters and format used. If keys=stream in the query parameters, multiple JSON objects in chunked-encoding will be returned containing "keys" entries.


$ curl -i http://localhost:8098/buckets/jsconf/keys?keys=true
HTTP/1.1 200 OK
Vary: Accept-Encoding
Server: MochiWeb/1.1 WebMachine/1.9.0 (participate in the frantic)
Date: Fri, 30 Sep 2011 15:24:35 GMT
Content-Type: application/json
Content-Length: 239