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     "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": true
19 }

Updates aliases for the specified collections.

Authentication

api-keystring

API Key authentication via header

Query parameters

timeoutintegerOptional>=1

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