For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.

API Reference

API Reference Aliases

List all aliases

GET

/aliases

GET

/aliases

$ curl  -X GET \
>   'http://localhost:6333/aliases' \
>   --header 'api-key: <api-key-value>'

200Retrieved

1 {
2   "usage": {
3     "hardware": {
4       "cpu": 1,
5       "payload_io_read": 1,
6       "payload_io_write": 1,
7       "payload_index_io_read": 1,
8       "payload_index_io_write": 1,
9       "vector_io_read": 1,
10       "vector_io_write": 1
11     },
12     "inference": {
13       "models": {}
14     }
15   },
16   "time": 0.002,
17   "status": "ok",
18   "result": {
19     "aliases": [
20       {
21         "alias_name": "string",
22         "collection_name": "string"
23       }
24     ]
25   }
26 }

Retrieves a list of all existing aliases.

Was this page helpful?

Check cluster status

Authentication

api-keystring

API Key authentication via header

Response

successful operation

usageobject or any

timedouble

Time spent to process this request

statusstring

resultobject