Skip to main content
Version: 2.0.7

HTTP API

Riak has a rich, full-featured HTTP 1.1 API. This is an overview of the operations you can perform via HTTP and can be used as a guide for developing a compliant client. All URLs assume the default configuration values where applicable. All examples use curl to interact with Riak.

URL Escaping

Buckets, keys, and link specifications may not contain unescaped slashes. Use a URL-escaping library or replace slashes with %2F.

MethodURLDoc
GET/types/<type>/buckets/<bucket>/propsHTTP Get Bucket Properties
PUT/types/<type>/buckets/<bucket>/propsHTTP Set Bucket Properties
DELETE/types/<type>/buckets/<bucket>/propsHTTP Reset Bucket Properties
GET/types/<type>/buckets?buckets=trueHTTP List Buckets
GET/types/<type>/buckets/<bucket>/keys?keys=trueHTTP List Keys
MethodURLDoc
GET/types/<type>/buckets/<bucket>/keys/<key>HTTP Fetch Object
POST/types/<type>/buckets/<bucket>/<key>HTTP Store Object
PUT/types/<type>/buckets/<bucket>/keys/<key>HTTP Store Object
DELETE/types/<type>/buckets/<bucket>/keys/<key>HTTP Delete Object

For documentation on the HTTP API for Riak Data Types, see the curl examples in Using Data Types and subpages e.g. sets.

MethodURLDoc
POST/mapredHTTP MapReduce
GET/types/<type>/buckets/<bucket>/index/<index>/<value>HTTP Secondary Indexes
GET/types/<type>/buckets/<bucket>/index/<index>/<start>/<end>HTTP Secondary Indexes
MethodURLDoc
GET/pingHTTP Ping
GET/statsHTTP Status
GET/HTTP List Resources
MethodURLDoc
GET/search/query/<index_name>HTTP Search Query
GET/search/indexHTTP Search Index Info
GET/search/index/<index_name>HTTP Fetch Search Index
PUT/search/index/<index_name>HTTP Store Search Index
DELETE/search/index/<index_name>HTTP Delete Search Index
GET/search/schema/<schema_name>HTTP Fetch Search Schema
PUT/search/schema/<schema_name>HTTP Store Search Schema