Sign in

v17

latestOpenAPI 3.0.1Apache 2.0raw.githubusercontent.com2026-05-2575397522.8 KB
Points

Clear payload

Remove all payload for specified points

post/collections/{collection_name}/points/payload/clear

Path parameters

collection_namestring required

Name of the collection to clear payload from

Query parameters

waitboolean

If true, wait for changes to actually happen

ordering'weak' | 'medium' | 'strong'

Defines write ordering guarantees for collection operations

  • weak - write operations may be reordered, works faster, default

  • medium - write operations go through dynamically selected leader, may be inconsistent for a short period of time in case of leader change

  • strong - Write operations go through the permanent leader, consistent, but may be unavailable if leader is down

define ordering guarantees for the operation

timeoutinteger

Timeout for the operation

Request body

OR

Example request

{
  "points": [
    42
  ],
  "shard_key": "region_1"
}

Response

successful operation

timenumber float

Time spent to process this request

statusstring

Example response

{
  "time": 0.002,
  "status": "ok"
}