Get collection details

GET

/collections/:collection_name

GET

/collections/:collection_name

1 curl http://localhost:6333/collections/collection_name \
2      -H "api-key: <apiKey>"

Try it

200Retrieved

1 {
2   "time": 1.1,
3   "status": "string",
4   "result": {
5     "status": "green",
6     "optimizer_status": "ok",
7     "segments_count": 1,
8     "config": {
9       "params": {
10         "vectors": {},
11         "shard_number": 1,
12         "sharding_method": "auto",
13         "replication_factor": 1,
14         "write_consistency_factor": 1,
15         "read_fan_out_factor": 1,
16         "on_disk_payload": false,
17         "sparse_vectors": {}
18       },
19       "hnsw_config": {
20         "m": 1,
21         "ef_construct": 1,
22         "full_scan_threshold": 1,
23         "max_indexing_threads": 0,
24         "on_disk": true,
25         "payload_m": 1
26       },
27       "optimizer_config": {
28         "deleted_threshold": 1.1,
29         "vacuum_min_vector_number": 1,
30         "default_segment_number": 1,
31         "flush_interval_sec": 1,
32         "max_segment_size": 1,
33         "memmap_threshold": 1,
34         "indexing_threshold": 1,
35         "max_optimization_threads": 1
36       },
37       "wal_config": {
38         "wal_capacity_mb": 1,
39         "wal_segments_ahead": 1
40       },
41       "quantization_config": {
42         "scalar": {
43           "type": "int8",
44           "quantile": 1.1,
45           "always_ram": true
46         }
47       }
48     },
49     "payload_schema": {},
50     "vectors_count": 1,
51     "indexed_vectors_count": 1,
52     "points_count": 1
53   }
54 }

Retrieves parameters from the specified collection.

Authentication

api-keystring

API Key authentication via header

Path parameters

collection_namestringRequired

Name of the collection to retrieve

Response

successful operation

timedouble or null

Time spent to process this request

statusstring or null

resultobject or null

Current statistics and configuration of the collection