Update collection aliases

POST

1 # Create an alias
2 curl  -X POST \
3   'http://localhost:6333/collections/aliases' \
4   --header 'api-key: <api-key-value>' \
5   --header 'Content-Type: application/json' \
6   --data-raw '{
7   "actions": [
8     {
9       "create_alias": {
10         "collection_name": "{collection_name}",
11         "alias_name": "{alias_name}"
12       }
13     }
14   ]
15 }'
16 
17 # Delete an alias
18 curl  -X POST \
19   'http://localhost:6333/collections/aliases' \
20   --header 'api-key: <api-key-value>' \
21   --header 'Content-Type: application/json' \
22   --data-raw '{
23   "actions": [
24     {
25       "delete_alias": {
26         "alias_name": "{alias_name}"
27       }
28     }
29   ]
30 }'
31 
32 # Rename an alias
33 curl  -X POST \
34   'http://localhost:6333/collections/aliases' \
35   --header 'api-key: <api-key-value>' \
36   --header 'Content-Type: application/json' \
37   --data-raw '{
38   "actions": [
39     {
40       "rename_alias": {
41         "old_alias_name": "{old_alias_name}",
42         "new_alias_name": "{new_alias_name}"
43       }
44     }
45   ]
46 }'

Play

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.

Query parameters

timeoutintegerOptional

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

Request

This endpoint expects an object.

actionslist of objectsRequired

Response

This endpoint returns an object.

usageobject or anyOptional

timedoubleOptional

Time spent to process this request

statusstringOptional

resultbooleanOptional

Headers

Query parameters

Request

Response