For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
CloudGitHub
  • API Reference
      • GETList all snapshots (collection)
      • POSTCreate a snapshot (collection)
      • POSTRecover from an uploaded snapshot (collection)
      • PUTRecover from a snapshot (collection)
      • GETDownload a snapshot (collection)
      • DELDelete a snapshot (collection)
      • GETList all snapshots (storage)
      • POSTCreate a snapshot (storage)
      • GETDownload a snapshot (storage)
      • DELDelete a snapshot (storage)
      • POSTRecover from an uploaded snapshot (shard)
      • PUTRecover from a snapshot (shard)
      • GETList all snapshots (shard)
      • POSTCreate a snapshot (shard)
      • GETDownload a snapshot (shard)
      • DELDelete a snapshot (shard)
LogoLogo
CloudGitHub
API ReferenceSnapshots

Create a snapshot (shard)

POST
/collections/:collection_name/shards/:shard_id/snapshots
POST
/collections/:collection_name/shards/:shard_id/snapshots
$curl -X POST http://localhost:6333/collections/collection_name/shards/1/snapshots \
>     -H "api-key: <apiKey>"
200Successful
1{
2  "time": 1.1,
3  "status": "string",
4  "result": {
5    "name": "string",
6    "size": 1,
7    "creation_time": "string",
8    "checksum": "string"
9  }
10}
Creates a new snapshot of a shard from a collection.
Was this page helpful?
Previous

Download a snapshot (shard)

Next
Built with

Authentication

api-keystring
API Key authentication via header

Path parameters

collection_namestringRequired
Name of the collection for which to create a snapshot
shard_idintegerRequired
Id of the shard

Query parameters

waitbooleanOptional

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

Response

successful operation
timedouble
Time spent to process this request
statusstring
resultobject