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.
CloudGitHub
  • API Reference
      • POSTUpdate collection aliases
      • GETList collection aliases
      • GETList all aliases
LogoLogo
CloudGitHub
API ReferenceAliases

List all aliases

GET
/aliases
GET
/aliases
$curl  -X GET \
>  'http://localhost:6333/aliases' \
>  --header 'api-key: <api-key-value>'
200Retrieved
1{
2  "time": 0.002,
3  "status": "ok",
4  "result": {
5    "aliases": [
6      {
7        "alias_name": "string",
8        "collection_name": "string"
9      }
10    ]
11  }
12}
Retrieves a list of all existing aliases.
Was this page helpful?
Previous

Check cluster status

Next
Built with

Authentication

api-keystring
API Key authentication via header

Response

successful operation
timedouble
Time spent to process this request
statusstring
resultobject