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.

Method URL Doc
GET /types/<type>/buckets/<bucket>/props HTTP Get Bucket Properties
PUT /types/<type>/buckets/<bucket>/props HTTP Set Bucket Properties
DELETE /types/<type>/buckets/<bucket>/props HTTP Reset Bucket Properties
GET /types/<type>/buckets?buckets=true HTTP List Buckets
GET /types/<type>/buckets/<bucket>/keys?keys=true HTTP List Keys
Method URL Doc
GET /types/<type>/buckets/<bucket>/keys/<key> HTTP Fetch Object
POST /types/<type>/buckets/<bucket>/keys HTTP Store Object
PUT /types/<type>/buckets/<bucket>/keys/<key> HTTP Store Object
POST /types/<type>/buckets/<bucket>/keys/<key> HTTP Store Object
DELETE /types/<type>/buckets/<bucket>/keys/<key> HTTP Delete Object
Method URL
GET /types/<type>/buckets/<bucket>/datatypes/<key>
POST /types/<type>/buckets/<bucket>/datatypes
POST /types/<type>/buckets/<bucket>/datatypes/<key>

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

Advanced users may consult the technical documentation inside the Riak KV internal module riak_kv_wm_crdt.

Method URL Doc
POST /mapred HTTP MapReduce
GET /types/<type>/buckets/<bucket>/index/<index>/<value> HTTP Secondary Indexes
GET /types/<type>/buckets/<bucket>/index/<index>/<start>/<end> HTTP Secondary Indexes
Method URL Doc
GET /ping HTTP Ping
GET /stats HTTP Status
GET / HTTP List Resources