Skip to content

Routes (API)

Junbong Lee edited this page Feb 23, 2017 · 10 revisions

Meta Information API

[GET] /_info : Get overall server information

Collection API

Basic CRUD

[GET] /:collection : Get properties of collection

[POST] /:collection : Create new collection with specified name

[DELETE] /:collection : Remove collection with specified name, either all documents in collection

[PUT] /:collection : Update properties of collection - Future feature

Document API

Basic CRUD

[GET] /:collection/:key : Get document with specified key

[POST] /:collection/:key : Create new document with specified key

{
  /* Value of document */
  "value": "put contents of the document",
  /* Option that when this document expired in seconds */
  "expire": 10
}

[DELETE] /:collection/:key : Remove document with specified key

{
  /* Option that whether fire expiration callback or not */
  "exp_callback": true
}

[PUT] /:collection/:key : Update document with specified key

{
  /* Value of document */
  "value": "put contents of the document",
  /* Option that when this document expired in seconds */
  "expire": 10
}

Advance / Scan API

[GET] /:collection/_scan/:key_regex : Scan documents with key matched with specified regular expression

[DELETE] /:collection/_scan/:key_regex : Delete documents with key matched with specified regular expression

[POST] /:collection/_scan/:key_regex : Update documents with key matched with specified regular expression

Clone this wiki locally