HTTP Get Bucket Properties

Reads the bucket or bucket type properties.


GET /buckets/bucket/props

Or, to read bucket properties from a bucket in a bucket type:

GET /types/type/buckets/bucket/props

Optional query parameters (only valid for the old format):

  • props - whether to return the bucket properties (true is the default)
  • keys - whether to return the keys stored in the bucket. (false is the default). See also HTTP List Keys.


Normal status codes:

  • 200 OK

Important headers:

  • Content-Type - application/json

The JSON object in the response will contain up to two entries, "props" and "keys", which are present or missing, according to the optional query parameters. The default is for only "props" to be present.

See HTTP Set Bucket Properties for more information about the available bucket properties. See Managing Bucket Types Through the Command Line for more details about reading bucket types using the riak-admin bucket-type interface.


$ curl -v
* About to connect() to port 8098 (#0)
*   Trying connected
* Connected to ( port 8098 (#0)
> GET /buckets/test/props HTTP/1.1
> User-Agent: curl/7.19.7 (universal-apple-darwin10.0) libcurl/7.19.7
OpenSSL/0.9.8l zlib/1.2.3
> Host:
> Accept: */*
< 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: 368
* Connection #0 to host left intact
* Closing connection #0