Routes (API)

Meta Information API

[GET] /_info : Get overall server information

Collection API

Basic CRUD

[GET] /:collection : Get properties of collection

Response body:

{
  /* Name of this collection */
  "name": "name_of_collection"
  /* Number of documents in collection */
  "size": 1
}

[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

Response body:

{
  "key": "key_of_document"
  "value": "contents of document",
  "_created_at": 1487808000000
  "_expires_at": 1487810000000
}

• key: Key of this document
• value: Value of this document
• _created_at: Timestamp that means when this document created
• _expires_at: Timestamp that means when this document expired

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

Request body saved as value of document

Query param options:

• ttl : Option that when this document expired in seconds. If not set, document never be expired

Response body:

{
  /* Key of this document */
  "key": "key_of_document"
  /* Value of this document */
  "value": "contents of document",
  /* Timestamp that means when this document created */
  "_created_at": 1487808000000
  /* Timestamp that means when this document expired */
  "_expires_at": 1487810000000
}

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

Advance / Scan API

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

Response body:

{
  "documents": [
    /* Key of this document */
    "key": "key_of_document"
    /* Value of this document */
    "value": "contents of document",
    /* Timestamp that means when this document created */
    "_created_at": 1487808000000
    /* Timestamp that means when this document expired */
    "_expires_at": 1487810000000
  ]
}

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

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

Request body:

{
  /* Value of this document - EMPTY STRING will put when this field is not supplied */
  "value": "put contents of document",
  /* Option that when this document expired in seconds */
  "expire": 10
}