Get collection details

GET

1 curl  -X GET \
2   'http://localhost:6333/collections/collection_name' \
3   --header 'api-key: <api-key-value>'

Play

200Retrieved

1 {
2   "time": 0.002,
3   "status": "ok",
4   "result": {
5     "status": "green",
6     "optimizer_status": "ok",
7     "segments_count": 1,
8     "config": {
9       "params": {},
10       "hnsw_config": {
11         "m": 1,
12         "ef_construct": 1,
13         "full_scan_threshold": 1
14       },
15       "optimizer_config": {
16         "deleted_threshold": 1.1,
17         "vacuum_min_vector_number": 1,
18         "default_segment_number": 1,
19         "flush_interval_sec": 1
20       },
21       "wal_config": {
22         "wal_capacity_mb": 1,
23         "wal_segments_ahead": 1
24       },
25       "quantization_config": {
26         "scalar": {
27           "type": "int8"
28         }
29       }
30     },
31     "payload_schema": {
32       "payload_schema": {
33         "data_type": "keyword",
34         "points": 1
35       }
36     },
37     "vectors_count": 1,
38     "indexed_vectors_count": 1,
39     "points_count": 1
40   }
41 }

Retrieves parameters from the specified collection.

Path parameters

collection_namestringRequired

Name of the collection to retrieve

Response

This endpoint returns an object.

timedoubleOptional

Time spent to process this request

statusstringOptional

resultobjectOptional

Current statistics and configuration of the collection

Path parameters

Headers

Response