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 Snapshots API

Storage and collections snapshots.

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

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

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

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

17 operations 11 paths 10 schemas 3 DELETE7 GET5 POST2 PUT

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 Snapshots 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 17

Across 11 paths, the API surfaces 17 operations — 3 DELETE, 7 GET, 5 POST, 2 PUT. Each is listed below with its method, path, parameters, and response codes.

Snapshots 17

Storage and collections snapshots.

POST
/collections/{collection_name}/snapshots/upload
Recover from an uploaded snapshot
recover_from_uploaded_snapshot 4 params body → default4XX200202
PUT
/collections/{collection_name}/snapshots/recover
Recover from a snapshot
recover_from_snapshot 2 params body → default4XX200202
GET
/collections/{collection_name}/snapshots
List collection snapshots
list_snapshots 1 param → default4XX200
POST
/collections/{collection_name}/snapshots
Create collection snapshot
create_snapshot 2 params → default4XX200202
DELETE
/collections/{collection_name}/snapshots/{snapshot_name}
Delete collection snapshot
delete_snapshot 3 params → default4XX200202
GET
/collections/{collection_name}/snapshots/{snapshot_name}
Download collection snapshot
get_snapshot 2 params → default4XX200
GET
/snapshots
List of storage snapshots
list_full_snapshots → default4XX200
POST
/snapshots
Create storage snapshot
create_full_snapshot 1 param → default4XX200202
DELETE
/snapshots/{snapshot_name}
Delete storage snapshot
delete_full_snapshot 2 params → default4XX200202
GET
/snapshots/{snapshot_name}
Download storage snapshot
get_full_snapshot 1 param → default4XX200
GET
/collections/{collection_name}/shards/{shard_id}/snapshot
Download shard snapshot
stream_shard_snapshot 2 params → default4XX200
POST
/collections/{collection_name}/shards/{shard_id}/snapshots/upload
Recover shard from an uploaded snapshot
recover_shard_from_uploaded_snapshot 5 params body → default4XX200202
PUT
/collections/{collection_name}/shards/{shard_id}/snapshots/recover
Recover from a snapshot
recover_shard_from_snapshot 3 params body → default4XX200202
GET
/collections/{collection_name}/shards/{shard_id}/snapshots
List shards snapshots for a collection
list_shard_snapshots 2 params → default4XX200
POST
/collections/{collection_name}/shards/{shard_id}/snapshots
Create shard snapshot
create_shard_snapshot 3 params → default4XX200202
DELETE
/collections/{collection_name}/shards/{shard_id}/snapshots/{snapshot_name}
Delete shard snapshot
delete_shard_snapshot 4 params → default4XX200202
GET
/collections/{collection_name}/shards/{shard_id}/snapshots/{snapshot_name}
Download collection snapshot
get_shard_snapshot 3 params → default4XX200

Schemas 10

The contract defines 10 schemas that model the data the API accepts and returns. The most detailed are HardwareUsage (7 properties), SnapshotRecover (4 properties), SnapshotDescription (4 properties), ShardSnapshotRecover (4 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
ShardSnapshotLocation
InferenceUsage
object
1 property 1 required
Usage
object
Usage of the hardware resources, spent to process the request
2 properties
ErrorResponse
object
3 properties
SnapshotDescription
object
4 properties 2 required
SnapshotPriority
string
Defines source of truth for snapshot recovery: NoSync means - restore snapshot without any additional synchronization. Snapshot means - prefer snapshot data ov…
ModelUsage
object
1 property 1 required
SnapshotRecover
object
4 properties 1 required
ShardSnapshotRecover
object
4 properties 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

qdrant-snapshots-api-openapi.yml Raw ↑

Other APIs Qdrant publishes across the network.

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