v17

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

Set payload

Set payload values for points

post/collections/{collection_name}/points/payload

Path parameters

collection_namestring required

Name of the collection to set 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

payloadPayload required
keystring nullable

Assigns payload to each point that satisfy this path of property

Response

successful operation

timenumber float

Time spent to process this request

statusstring

Example response

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