LogoLogo
CloudGitHub
  • API Reference
CloudGitHub
API ReferencePoints

Clear payload

POST
/collections/:collection_name/points/payload/clear
POST
/collections/:collection_name/points/payload/clear
1curl  -X POST \
2  'http://localhost:6333/collections/collection_name/points/payload/clear' \
3  --header 'Content-Type: application/json' \
4  --header 'api-key: <api-key-value>' \
5  --data-raw '{
6  "points": [
7    0,
8    3,
9    100
10  ]
11}'
Try it
200Successful
1{
2  "time": 0.002,
3  "status": "ok",
4  "result": {
5    "status": "acknowledged",
6    "operation_id": 1
7  }
8}
Removes the entire payload for specified points.

Path parameters

collection_namestringRequired
Name of the collection to clear payload from

Headers

api-keystringRequired

Query parameters

waitbooleanOptional
If true, wait for changes to actually happen
orderingenumOptional
define ordering guarantees for the operation
Allowed values:

Request

clear payload on points
PointIdsListobjectRequired
OR
FilterSelectorobjectRequired

Response

successful operation
timedouble or null
Time spent to process this request
statusstring or null
resultobject or null
Was this page helpful?
Previous

Batch update points

Next
Built with
Name of the collection to clear payload from
If true, wait for changes to actually happen
define ordering guarantees for the operation
clear payload on points
successful operation