v17

latestOpenAPI 3.0.1Apache 2.0raw.githubusercontent.com2026-05-2575397522.8 KB
Snapshots

Create shard snapshot

Create new snapshot of a shard for a collection

post/collections/{collection_name}/shards/{shard_id}/snapshots

Path parameters

collection_namestring required

Name of the collection for which to create a snapshot

shard_idinteger required

Id of the shard

Query parameters

waitboolean

If true, wait for changes to actually happen. If false - let changes happen in background. Default is true.

Response

successful operation

timenumber float

Time spent to process this request

statusstring

Example response

{
  "time": 0.002,
  "status": "ok",
  "result": {
    "name": "my-collection-3766212330831337-2024-07-22-08-31-55.snapshot",
    "creation_time": "2022-08-04T10:49:10",
    "size": 1000000,
    "checksum": "a1b2c3d4e5f6a7b8c9d0e1f2a3b4c5d6e7f8a9b0c1d2e3f4a5b6c7d8e9f0"
  }
}