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
$# Create an alias
$curl  -X POST \
>  'http://localhost:6333/collections/aliases' \
>  --header 'api-key: <api-key-value>' \
>  --header 'Content-Type: application/json' \
>  --data-raw '{
>  "actions": [
>    {
>      "create_alias": {
>        "collection_name": "{collection_name}",
>        "alias_name": "{alias_name}"
>      }
>    }
>  ]
>}'
$
$# Delete an alias
$curl  -X POST \
>  'http://localhost:6333/collections/aliases' \
>  --header 'api-key: <api-key-value>' \
>  --header 'Content-Type: application/json' \
>  --data-raw '{
>  "actions": [
>    {
>      "delete_alias": {
>        "alias_name": "{alias_name}"
>      }
>    }
>  ]
>}'
$
$# Rename an alias
$curl  -X POST \
>  'http://localhost:6333/collections/aliases' \
>  --header 'api-key: <api-key-value>' \
>  --header 'Content-Type: application/json' \
>  --data-raw '{
>  "actions": [
>    {
>      "rename_alias": {
>        "old_alias_name": "{old_alias_name}",
>        "new_alias_name": "{new_alias_name}"
>      }
>    }
>  ]
>}'
200Successful
1{
2  "usage": {
3    "cpu": 1,
4    "io_read": 1,
5    "io_write": 1
6  },
7  "time": 0.002,
8  "status": "ok",
9  "result": true
10}
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
usageobject or any
timedouble
Time spent to process this request
statusstring
resultboolean