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
      • PUTCreate payload index
      • DELDelete payload index
LogoLogo
CloudGitHub
API ReferenceIndexes

Delete payload index

DELETE
/collections/:collection_name/index/:field_name
DELETE
/collections/:collection_name/index/:field_name
$curl -X DELETE \
> 'http://localhost:6333/collections/collection_name/index/field_name' \
> --header 'api-key: <api-key-value>'
200Deleted
1{
2 "usage": {
3 "cpu": 1,
4 "payload_io_read": 1,
5 "payload_io_write": 1,
6 "payload_index_io_read": 1,
7 "payload_index_io_write": 1,
8 "vector_io_read": 1,
9 "vector_io_write": 1
10 },
11 "time": 0.002,
12 "status": "ok",
13 "result": {
14 "status": "acknowledged",
15 "operation_id": 1
16 }
17}
Deletes a payload index for a field in the specified collection.
Was this page helpful?
Previous

List all snapshots (collection)

Next
Built with

Authentication

api-keystring
API Key authentication via header

Path parameters

collection_namestringRequired
Name of the collection
field_namestringRequired
Name of the field where to delete the index

Query parameters

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

Response

successful operation
usageobject or any
timedouble
Time spent to process this request
statusstring
resultobject