API docs by Redocly

Qdrant Web Backup API (1.0.0)

Download OpenAPI specification:

License: MIT

REST API for managing Qdrant vector database backups. Provides endpoints for cluster monitoring, collection management, snapshot operations, storage configuration, and job tracking.

Cluster

Cluster health and node management

Get cluster status

Returns current cluster health, Raft consensus info, and peer details

Authorizations:
NonebearerAuth

Responses

Response samples

Content type
application/json
{
  • "status": "ok",
  • "time": 0.1,
  • "result": {
    }
}

Get cluster nodes

Returns list of all nodes in the Qdrant cluster with their status

Authorizations:
NonebearerAuth

Responses

Response samples

Content type
application/json
{
  • "status": "ok",
  • "time": 0.1,
  • "result": []
}

Collections

Collection listing and details

List all collections

Returns list of all collections in the Qdrant cluster

Authorizations:
NonebearerAuth

Responses

Response samples

Content type
application/json
{
  • "status": "ok",
  • "time": 0.1,
  • "result": {
    }
}

Get collection details

Returns detailed information about a specific collection

Authorizations:
NonebearerAuth
path Parameters
name
required
string

Collection name

Responses

Response samples

Content type
application/json
{
  • "status": "ok",
  • "time": 0.1,
  • "result": {
    }
}

Get collection cluster info

Returns shard distribution and cluster info for a collection

Authorizations:
NonebearerAuth
path Parameters
name
required
string

Collection name

Responses

Response samples

Content type
application/json
{
  • "status": "ok",
  • "time": 0.1,
  • "result": {
    }
}

Snapshots

Collection snapshot operations

List collection snapshots

Returns all snapshots for a specific collection

Authorizations:
NonebearerAuth
path Parameters
name
required
string

Collection name

Responses

Response samples

Content type
application/json
{
  • "status": "ok",
  • "time": 0.1,
  • "result": [
    ]
}

Create collection snapshot

Creates a new snapshot for the specified collection

Authorizations:
NonebearerAuth
path Parameters
name
required
string

Collection name

query Parameters
wait
boolean
Default: true

Wait for snapshot creation to complete

Responses

Response samples

Content type
application/json
{
  • "status": "ok",
  • "time": 0.1,
  • "result": {
    }
}

Download snapshot

Downloads a snapshot file

Authorizations:
NonebearerAuth
path Parameters
name
required
string

Collection name

snapshotName
required
string

Snapshot name

Responses

Response samples

Content type
application/json
{
  • "status": {
    },
  • "time": 0.1
}

Delete snapshot

Deletes a snapshot from the collection

Authorizations:
NonebearerAuth
path Parameters
name
required
string

Collection name

snapshotName
required
string

Snapshot name

query Parameters
wait
boolean
Default: true

Wait for deletion to complete

Responses

Response samples

Content type
application/json
{
  • "status": "ok",
  • "time": 0.1,
  • "result": true
}

Recover collection from snapshot

Restores a collection from a snapshot URL or local file

Authorizations:
NonebearerAuth
path Parameters
name
required
string

Collection name

Request Body schema: application/json
required
location
required
string

Snapshot URL (S3, HTTP, or file://)

priority
string
Default: "snapshot"
Enum: "replica" "snapshot" "no_sync"

Recovery priority for conflict resolution

api_key
string

Optional API key for authenticated URLs

Responses

Request samples

Content type
application/json
{
  • "location": "string",
  • "priority": "replica",
  • "api_key": "string"
}

Response samples

Content type
application/json
{
  • "status": "ok",
  • "time": 0.1,
  • "result": true
}

Shard Snapshots

Per-shard snapshot operations for distributed mode

List shard snapshots

Returns all snapshots for a specific shard

Authorizations:
NonebearerAuth
path Parameters
name
required
string

Collection name

shardId
required
integer

Shard ID

Responses

Response samples

Content type
application/json
{
  • "status": "ok",
  • "time": 0.1,
  • "result": [
    ]
}

Create shard snapshot

Creates a snapshot for a specific shard

Authorizations:
NonebearerAuth
path Parameters
name
required
string

Collection name

shardId
required
integer

Shard ID

query Parameters
wait
boolean
Default: true

Wait for snapshot creation to complete

Responses

Response samples

Content type
application/json
{
  • "status": "ok",
  • "time": 0.1,
  • "result": {
    }
}

Storage

Backup storage configuration

Get storage configurations

Returns all configured storage backends

Authorizations:
NonebearerAuth

Responses

Response samples

Content type
application/json
{
  • "status": "ok",
  • "time": 0.1,
  • "result": [
    ]
}

Create storage configuration

Creates a new storage backend configuration

Authorizations:
NonebearerAuth
Request Body schema: application/json
required
name
required
string

Configuration name

type
required
string (StorageType)
Enum: "local" "s3"

Storage backend type

path
string

Local filesystem path (required for local type)

s3_endpoint
string <uri>

S3 endpoint URL (required for s3 type)

s3_bucket
string

S3 bucket name (required for s3 type)

s3_region
string

S3 region (required for s3 type)

s3_access_key
string

S3 access key (required for s3 type)

s3_secret_key
string

S3 secret key (required for s3 type)

is_default
boolean
Default: false

Set as default storage

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "type": "local",
  • "path": "string",
  • "s3_endpoint": "http://example.com",
  • "s3_bucket": "string",
  • "s3_region": "string",
  • "s3_access_key": "string",
  • "s3_secret_key": "string",
  • "is_default": false
}

Response samples

Content type
application/json
{
  • "status": "ok",
  • "time": 0.1,
  • "result": {
    }
}

Update storage configuration

Updates an existing storage backend configuration

Authorizations:
NonebearerAuth
path Parameters
id
required
string

Storage configuration ID

Request Body schema: application/json
required
name
string

Configuration name

path
string

Local filesystem path

s3_endpoint
string <uri>

S3 endpoint URL

s3_bucket
string

S3 bucket name

s3_region
string

S3 region

s3_access_key
string

S3 access key

s3_secret_key
string

S3 secret key

is_default
boolean

Set as default storage

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "path": "string",
  • "s3_endpoint": "http://example.com",
  • "s3_bucket": "string",
  • "s3_region": "string",
  • "s3_access_key": "string",
  • "s3_secret_key": "string",
  • "is_default": true
}

Response samples

Content type
application/json
{
  • "status": "ok",
  • "time": 0.1,
  • "result": {
    }
}

Delete storage configuration

Deletes a storage backend configuration

Authorizations:
NonebearerAuth
path Parameters
id
required
string

Storage configuration ID

Responses

Response samples

Content type
application/json
{
  • "status": "ok",
  • "time": 0.1,
  • "result": true
}

Test storage connectivity

Tests connectivity to a storage backend without saving

Authorizations:
NonebearerAuth
Request Body schema: application/json
required
name
required
string

Configuration name

type
required
string (StorageType)
Enum: "local" "s3"

Storage backend type

path
string

Local filesystem path (required for local type)

s3_endpoint
string <uri>

S3 endpoint URL (required for s3 type)

s3_bucket
string

S3 bucket name (required for s3 type)

s3_region
string

S3 region (required for s3 type)

s3_access_key
string

S3 access key (required for s3 type)

s3_secret_key
string

S3 secret key (required for s3 type)

is_default
boolean
Default: false

Set as default storage

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "type": "local",
  • "path": "string",
  • "s3_endpoint": "http://example.com",
  • "s3_bucket": "string",
  • "s3_region": "string",
  • "s3_access_key": "string",
  • "s3_secret_key": "string",
  • "is_default": false
}

Response samples

Content type
application/json
{
  • "status": "ok",
  • "time": 0.1,
  • "result": {
    }
}

Jobs

Backup and restore job management

List jobs

Returns paginated list of backup and restore jobs

Authorizations:
NonebearerAuth
query Parameters
status
string (JobStatus)
Enum: "pending" "running" "completed" "failed" "cancelled"

Filter by job status

type
string (JobType)
Enum: "backup" "restore" "shard_backup" "shard_restore"

Filter by job type

page
integer >= 1
Default: 1

Page number (1-indexed)

limit
integer [ 1 .. 100 ]
Default: 20

Items per page

Responses

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "total": 0,
  • "page": 0,
  • "limit": 0
}

Create job

Creates a new backup or restore job

Authorizations:
NonebearerAuth
Request Body schema: application/json
required
type
required
string (JobType)
Enum: "backup" "restore" "shard_backup" "shard_restore"

Job type

collection_name
required
string

Target collection name

shard_id
integer

Target shard ID (for shard operations)

snapshot_name
string

Snapshot name (for restore operations)

object

Additional job metadata

Responses

Request samples

Content type
application/json
{
  • "type": "backup",
  • "collection_name": "string",
  • "shard_id": 0,
  • "snapshot_name": "string",
  • "metadata": { }
}

Response samples

Content type
application/json
{
  • "status": "ok",
  • "time": 0.1,
  • "result": {
    }
}

Get job details

Returns detailed information about a specific job

Authorizations:
NonebearerAuth
path Parameters
id
required
string

Job ID

Responses

Response samples

Content type
application/json
{
  • "status": "ok",
  • "time": 0.1,
  • "result": {
    }
}

Cancel job

Cancels a pending or running job

Authorizations:
NonebearerAuth
path Parameters
id
required
string

Job ID

Responses

Response samples

Content type
application/json
{
  • "status": "ok",
  • "time": 0.1,
  • "result": {
    }
}

Retry job

Retries a failed or cancelled job

Authorizations:
NonebearerAuth
path Parameters
id
required
string

Job ID

Responses

Response samples

Content type
application/json
{
  • "status": "ok",
  • "time": 0.1,
  • "result": {
    }
}

Metrics

Prometheus metrics

Get Prometheus metrics

Returns metrics in Prometheus exposition format

Authorizations:
NonebearerAuth

Responses