Qdrant Distributed 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 9
Across 7 paths, the API surfaces 9 operations — 1 DELETE, 4 GET, 3 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.
The contract defines 85 schemas that model the data the API accepts and returns. The most detailed are DistributedReplicaTelemetry (11 properties), FieldCondition (9 properties), DistributedPeerDetails (7 properties), HardwareUsage (7 properties). Each schema is shown below with its type and property counts.
DropShardingKey
object
1 property1 required
DistributedClusterTelemetry
object
3 properties2 required
ReshardingInfo
object
4 properties3 required
IsNullCondition
object
Select points with null payload for a specified field
1 property1 required
FieldCondition
object
All possible payload filtering conditions
9 properties1 required
HasIdCondition
object
ID-based filtering condition
1 property1 required
ShardCleanStatusFailedTelemetry
object
1 property1 required
GeoLineString
object
Ordered sequence of GeoPoints representing the line
1 property1 required
AbortReshardingOperation
object
1 property1 required
IsEmptyCondition
object
Select points with empty payload for a specified field
1 property1 required
Usage
object
Usage of the hardware resources, spent to process the request
2 properties
Filter
object
4 properties
ExtendedPointId
Type, used for specifying point ID in user interface
InferenceUsage
object
1 property1 required
MoveShard
object
4 properties3 required
ShardTransferInfo
object
7 properties4 required
LocalShardInfo
object
4 properties3 required
ShardKey
ReshardingDirection
string
Resharding direction, scale up or down in number of shards - up - Scale up, add a new shard - down - Scale down, remove a shard
HasVectorCondition
object
Filter points which have specific vector assigned
1 property1 required
ConsensusThreadStatus
Information about current consensus thread status
ShardCleanStatusTelemetry
DropReplicaOperation
object
1 property1 required
MatchAny
object
Exact match on any of the given values
1 property1 required
StartResharding
object
3 properties1 required
MatchPhrase
object
Full-text phrase match of the string.
1 property1 required
PeerInfo
object
Information of a peer in the cluster
1 property1 required
RaftInfo
object
Summary information about the current raft state
6 properties4 required
StateRole
string
Role of the peer in the consensus
RestartTransferOperation
object
1 property1 required
ShardTransferMethod
string
Methods for transferring a shard from one node to another. - streamrecords - Stream all shard records in batches until the whole shard is transferred. - snapsh…
Range
object
Range filter request
4 properties
Condition
ShardCleanStatusProgressTelemetry
object
1 property1 required
PartialSnapshotTelemetry
object
3 properties3 required
DropShardingKeyOperation
object
1 property1 required
DistributedReplicaTelemetry
object
11 properties2 required
MinShould
object
2 properties2 required
MatchTextAny
object
Full-text match of at least one token of the string.
1 property1 required
PayloadField
object
Payload field
1 property1 required
ModelUsage
object
1 property1 required
GeoRadius
object
Geo filter request Matches coordinates inside the circle of radius and center with coordinates center
2 properties2 required
RestartTransfer
object
4 properties4 required
ShardStatus
string
Current state of the shard (supports same states as the collection) Green - all good. Yellow - optimization is running, 'Grey' - optimizations are possible but…
ReplicateShard
object
4 properties3 required
MoveShardOperation
object
1 property1 required
AbortTransferOperation
object
1 property1 required
DistributedCollectionTelemetry
object
4 properties1 required
HardwareUsage
object
Usage of the hardware resources, spent to process the request
7 properties7 required
MatchValue
object
Exact match of the given value
1 property1 required
Nested
object
Select points with payload for a specified nested field
2 properties2 required
RemoteShardInfo
object
4 properties3 required
ClusterOperations
CreateShardingKey
object
5 properties1 required
ClusterStatus
Information about current cluster status and structure
DistributedPeerDetails
object
7 properties6 required
DatetimeRange
object
Range filter request
4 properties
Replica
object
2 properties2 required
ErrorResponse
object
3 properties
GeoPolygon
object
Geo filter request Matches coordinates inside the polygon, defined by exterior and interiors
2 properties1 required
ValuesCount
object
Values count filter request
4 properties
ValueVariants
StartReshardingOperation
object
1 property1 required
GeoPoint
object
Geo point payload schema
2 properties2 required
ReplicaState
string
State of the single shard within a replica set.
DistributedTelemetryData
object
2 properties1 required
GeoBoundingBox
object
Geo filter request Matches coordinates inside the rectangle, described by coordinates of lop-left and bottom-right edges
2 properties2 required
AbortResharding
object
RangeInterface
CreateShardingKeyOperation
object
1 property1 required
AbortShardTransfer
object
3 properties3 required
ReplicatePoints
object
3 properties2 required
AnyVariants
ShardKeyDescription
object
1 property1 required
DistributedShardTelemetry
object
3 properties2 required
ReplicatePointsOperation
object
1 property1 required
ReplicateShardOperation
object
1 property1 required
MatchText
object
Full-text match of the strings.
1 property1 required
Match
Match filter request
CollectionClusterInfo
object
Current clustering distribution for the collection
6 properties5 required
NestedCondition
object
1 property1 required
DistributedPeerInfo
object
3 properties2 required
MatchExcept
object
Should have at least one value not matching the any given values
1 property1 required
ShardKeysResponse
object
1 property
MessageSendErrors
object
Message send failures for a particular peer
3 properties1 required
Specification
The full machine-readable OpenAPI contract behind this narrative.
