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.
Request
GET /buckets/bucket/keys?keys=true # List all keys
GET /buckets/bucket/keys?keys=stream # Stream keys to the client
Required query parameters:
keys
- defaults tofalse
. When set totrue
all keys will be returned in a single payload. When set tostream
, keys will be returned in chunked-encoding.
Response
Normal response codes:
200 OK
Important headers:
Content-Type
-application/json
Transfer-Encoding
-chunked
when thekeys
query parameter is set tostream
.
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.
Example
$ 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
{"keys":["challenge.jpg","puddi.png","basho.gif","puddikid.jpg","yay.png","
thinking.png","victory.gif","slides","joyent.png","seancribbs-small.jpg","
trollface.jpg","riak_logo_animated1.gif","victory.jpg","challenge.png","
team_cribbs.png"]}