Create payload index

PUT

Creates a payload index for a field in the specified collection.

Path parameters

collection_namestringRequired

Name of the collection

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.
field_namestringRequired
field_schemaenum or object or anyOptional

Response

This endpoint returns an object.
usageobject or anyOptional
timedoubleOptional

Time spent to process this request

statusstringOptional
resultobjectOptional
Delete payload index
Built with