Update collection aliases | Qdrant

# 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}"
      }
    }
  ]
}'

{
  "usage": {
    "cpu": 1,
    "payload_io_read": 1,
    "payload_io_write": 1,
    "payload_index_io_read": 1,
    "payload_index_io_write": 1,
    "vector_io_read": 1,
    "vector_io_write": 1
  },
  "time": 0.002,
  "status": "ok",
  "result": true
}

Updates aliases for the specified collections.

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 anyOptional

timedoubleOptional

Time spent to process this request

statusstringOptional

resultbooleanOptional