list #

Returns the list of collections associated to a provided index.

The returned list is sorted in alphanumerical order.

Query Syntax #

HTTP #

URL: http://kuzzle:7512/<index>/_list[?type=<all|stored|realtime>][&from=0][&size=42]
Method: GET

Other protocols #

{
  "index": "<index>",
  "controller": "collection",
  "action": "list",
  "type": "stored",
  "from": 0,
  "size": 42
}

Arguments #

collection: collection name
index: index name

Optional: #

from and size: response pagination
type: filters the returned collections. Allowed values: all, stored and realtime (default : all).

Response #

Returns an array of objects, each one of those describing a collection, using the following properties:

name: collection name
type: collection type (either stored or realtime)

Example:

{
  "status": 200,
  "error": null,
  "index": "<index>",
  "controller": "collection",
  "action": "list",
  "requestId": "<unique request identifier>",
  "result": {
    "collections": [
      {
        "name": "realtime_1", "type": "realtime"
      },
      {
        "name": "realtime_2", "type": "realtime"
      },
      {
        "name": "realtime_...", "type": "realtime"
      },
      {
        "name": "realtime_n", "type": "realtime"
      },
      {
        "name": "stored_1", "type": "stored"
      },
      {
        "name": "stored_2", "type": "stored"
      },
      {
        "name": "stored_...", "type": "stored"
      },
      {
        "name": "stored_n", "type": "stored"
      }
    ],
    "type": "all"
  }
}

Possible errors #

Edit this page on Github