Create a snapshot (shard)

POST

Creates a new snapshot of a shard from a collection.

collection_namestringRequired

Name of the collection for which to create a snapshot

shard_idintegerRequired

Id of the shard

waitbooleanOptional

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

This endpoint returns an object.

timedoubleOptional

Time spent to process this request

statusstringOptional

resultobjectOptional

1	{
2	"time": 0.002,
3	"status": "ok",
4	"result": {
5	"name": "my-collection-3766212330831337-2024-07-22-08-31-55.snapshot",
6	"size": 1000000,
7	"creation_time": "2022-08-04T10:49:10",
8	"checksum": "a1b2c3d4e5f6a7b8c9d0e1f2a3b4c5d6e7f8a9b0c1d2e3f4a5b6c7d8e9f0"
9	}
10	}

1	curl -X POST http://localhost:6333/collections/collection_name/shards/1/snapshots \
2	-H "api-key: <apiKey>"