Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Qdrant Aliases API

Additional names for existing collections.

Qdrant Aliases API is one of 9 APIs that Qdrant publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Aliases. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.

This API exposes 3 operations across 3 paths, and defines 15 schemas. It is described by OpenAPI 3.0.1, at version master.

Requests are made against a single base URL, {protocol}://{hostname}:{port}.

3 operations 3 paths 15 schemas 2 GET1 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.1
API Version
master
Server
{protocol}://{hostname}:{port}
Authentication
API Key, HTTP Bearer
License
Resource Areas
1

Authentication & Security 2

Qdrant Aliases API declares 2 security schemes for authenticating requests. An API key is passed in the header as api-key (api-key). It accepts HTTP bearer tokens (bearerAuth). By default, every request must be authenticated, though some operations may also be called without credentials.

  • api-key — Authorization key, either read-write or read-only

Paths & Operations 3

Across 3 paths, the API surfaces 3 operations — 2 GET, 1 POST. Each is listed below with its method, path, parameters, and response codes.

Aliases 3

Additional names for existing collections.

POST
/collections/aliases
Update aliases of the collections
update_aliases 1 param body → default4XX200
GET
/collections/{collection_name}/aliases
List aliases for collection
get_collection_aliases 1 param → default4XX200
GET
/aliases
List collections aliases
get_collections_aliases → default4XX200

Schemas 15

The contract defines 15 schemas that model the data the API accepts and returns. The most detailed are HardwareUsage (7 properties), ErrorResponse (3 properties), CreateAlias (2 properties), AliasDescription (2 properties). Each schema is shown below with its type and property counts.

HardwareUsage
object
Usage of the hardware resources, spent to process the request
7 properties 7 required
AliasOperations
Group of all the possible operations related to collection aliases
CreateAliasOperation
object
1 property 1 required
DeleteAlias
object
Delete alias if exists
1 property 1 required
RenameAlias
object
Change alias to a new one
2 properties 2 required
Usage
object
Usage of the hardware resources, spent to process the request
2 properties
AliasDescription
object
2 properties 2 required
RenameAliasOperation
object
Change alias to a new one
1 property 1 required
CreateAlias
object
Create alternative name for a collection. Collection will be available under both names for search, retrieve,
2 properties 2 required
ErrorResponse
object
3 properties
InferenceUsage
object
1 property 1 required
ModelUsage
object
1 property 1 required
DeleteAliasOperation
object
Delete alias if exists
1 property 1 required
CollectionsAliasesResponse
object
1 property 1 required
ChangeAliasesOperation
object
Operation for performing changes of collection aliases. Alias changes are atomic, meaning that no collection modifications can happen between alias operations.
1 property 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

qdrant-aliases-api-openapi.yml Raw ↑

Other APIs Qdrant publishes across the network.

Qdrant Beta API
Qdrant Collections API
Qdrant Distributed API
Qdrant Indexes API
Qdrant Points API
Qdrant Search API
Qdrant Service API
Qdrant Snapshots API