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

Update collection aliases

POST
/collections/aliases
POST
/collections/aliases
$curl -X POST http://localhost:6333/collections/aliases \
>     -H "api-key: <apiKey>" \
>     -H "Content-Type: application/json" \
>     -d '{
>  "actions": [
>    {
>      "create_alias": {
>        "collection_name": "string",
>        "alias_name": "string"
>      }
>    }
>  ]
>}'
200Successful
1{
2  "time": 1.1,
3  "status": "string",
4  "result": true
5}
Updates aliases for the specified collections.
Was this page helpful?
Previous

List collection aliases

Next
Built with

Authentication

api-keystring
API Key authentication via header

Query parameters

timeoutintegerOptional

Wait for operation commit timeout in seconds. If timeout is reached - request will return with service error.

Request

Alias update operations
actionslist of objectsRequired

Response

successful operation
timedouble
Time spent to process this request
statusstring
resultboolean