API v2.x

KuzzleRequest #

The KuzzleRequest Payload is a standardized request sent to Kuzzle in JSON format.

That's the standard format expected for protocols other than HTTP.

With the HTTP protocol, users can send a KuzzleRequest Payload to the JSON Query Endpoint.

The following properties are the most common but any property can be added to a KuzzleRequest

Property Type Description
controller string API controller name
action string API action name
index string Index name
collection string Collection name
_id string Document unique identifier
jwt string Authentication token
body object KuzzleRequest body
requestId string KuzzleRequest unique identifier
volatile object KuzzleRequest volatile data

See also the RequestPayload framework type.