Delete payload

POST

Deletes a specified key payload for points.

Path parameters

collection_namestringRequired

Name of the collection to delete from

Query parameters

waitbooleanOptional

If true, wait for changes to actually happen

orderingenumOptional

define ordering guarantees for the operation

Allowed values: weakmediumstrong

Request

This endpoint expects an object.

keyslist of stringsRequired

List of payload keys to remove from payload

pointslist of integers or stringsOptional

Deletes values from each point in this list

filterobject or anyOptional

Deletes values from points that satisfy this filter condition

shard_keystring or integer or list of strings or integers or anyOptional

Response

This endpoint returns an object.

timedoubleOptional

Time spent to process this request

statusstringOptional

resultobjectOptional

POST

1 # Delete payload by ID
2 curl  -X POST \
3   'http://localhost:6333/collections/collection_name/points/payload/delete' \
4   --header 'api-key: <api-key-value>' \
5   --header 'Content-Type: application/json' \
6   --data-raw '{
7   "keys": [
8     "color",
9     "price"
10   ],
11   "points": [
12     0,
13     3,
14     100
15   ]
16 }'
17 
18 # Delete payload by filter
19 curl  -X POST \
20   'http://localhost:6333/collections/collection_name/points/payload/delete' \
21   --header 'api-key: <api-key-value>' \
22   --header 'Content-Type: application/json' \
23   --data-raw '{
24   "keys": [
25     "color",
26     "price"
27   ],
28   "filter": {
29     "must": [
30       {
31         "key": "color",
32         "match": {
33           "value": "red"
34         }
35       }
36     ]
37   }
38 }'

200Successful

1 {
2   "time": 0.002,
3   "status": "ok",
4   "result": {
5     "status": "acknowledged",
6     "operation_id": 1
7   }
8 }

Built with

1	# Delete payload by ID
2	curl -X POST \
3	'http://localhost:6333/collections/collection_name/points/payload/delete' \
4	--header 'api-key: <api-key-value>' \
5	--header 'Content-Type: application/json' \
6	--data-raw '{
7	"keys": [
8	"color",
9	"price"
10	],
11	"points": [
12	0,
13	3,
14	100
15	]
16	}'
17
18	# Delete payload by filter
19	curl -X POST \
20	'http://localhost:6333/collections/collection_name/points/payload/delete' \
21	--header 'api-key: <api-key-value>' \
22	--header 'Content-Type: application/json' \
23	--data-raw '{
24	"keys": [
25	"color",
26	"price"
27	],
28	"filter": {
29	"must": [
30	{
31	"key": "color",
32	"match": {
33	"value": "red"
34	}
35	}
36	]
37	}
38	}'

1	{
2	"time": 0.002,
3	"status": "ok",
4	"result": {
5	"status": "acknowledged",
6	"operation_id": 1
7	}
8	}