Get collection

Get collection #

Returns information about one or more collections.

Examples #

The following request gets all the collections under the default namespace:

GET /default:*

Request #

GET /<target>

Path Parameters #

• target
  (Required, String) Comma-separated, names of the collections to get (wildcard supported)

Response #

One entry per collection, keyed by its namespace:collection name. Each entry combines the schema, settings, index definitions and rollings:

Get collection index

Get collection index #

See the following documents:

• Get index
• Get index alias
• Get index mapping
• Get index settings

Get collection rollings

Get collection rollings #

Returns rollings information about one or more collections.

Examples #

The following request gets the rollings information of all the collections under the default namespace:

GET /default:*/_rollings

Retrieve the rollings information of all the collections:

GET /_rollings

Request #

GET /<target>/_rollings

Path Parameters #

• target
  (Optional, String) Comma-separated, names of the collections to get (wildcard supported)

Get collection schema

Get collection schema #

Returns schema information about one or more collections.

Examples #

The following request gets the schema information of all the collections under the default namespace:

GET /default:*/_schema

Retrieve the schema information of all the collections:

GET /_schema

Request #

GET /<target>/_schema

Path Parameters #

• target
  (Optional, String) Comma-separated, names of the collections to get (wildcard supported)

Get collection settings

Get collection settings #

Returns settings information about one or more collections.

Examples #

The following request gets the settings information of all the collections under the default namespace:

GET /default:*/_settings

Retrieve the settings information of all the collections:

GET /_settings

Request #

GET /<target>/_settings

Path Parameters #

• target
  (Optional, String) Comma-separated, names of the collections to get (wildcard supported)

Get index

Get index #

Returns information about one or more indices

Examples #

Get the information of all indices:

GET /_index

Get the information of the index named my-index under collection my-collection:

GET /my-collection/_index/my-index

Request #

GET /_index
GET /<target>/_index
GET /<target>/_index/<index>

Path Parameters #

• target
  (Required, String) Comma-separated, names of the collections to specify (wildcard supported)

• index
  (Required, String) Comma-separated, names of the indices to get (wildcard supported)

  ...

Get index alias

Get index alias #

Returns alias information about one or more indices under the specified collection.

Examples #

Get the alias information of the my-index index under collection my-collection:

GET /my-collection/_index/my-index/_alias

Request #

GET /<target>/_index/<index>/_alias
GET /<target>/_index/_alias

Path Parameters #

• target
  (Required, String) Comma-separated, names of the collections to specify (wildcard supported)

• index
  (Optional, String) Comma-separated, names of the indices to get (wildcard supported)