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>]
Method: GET
Other protocols #
{
"index": "<index>",
"controller": "collection",
"action": "list",
"type": "stored"
}
Arguments #
collection
: collection nameindex
: index name
Optional: #
from
andsize
: response paginationDeprecated since 2.1.4type
: filters the returned collections. Allowed values:all
,stored
andrealtime
(default :all
).Deprecated since 2.10.2
Response #
Returns an array of objects, each one of those describing a collection, using the following properties:
name
: collection nametype
: collection type (eitherstored
orrealtime
)
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 (opens new window)