API request arguments are accessible here.
Common arguments are accessible at the root level:
jwt, volatile, body, controller, action
Every other arguments are accessible under the args property. E.g:
_id, index, collection, refresh, onExistingUser, foobar, etc.
action #
| Type | Description | get / set |
|---|
string | API action name | get |
args #
| Type | Description | get / set |
|---|
JSONObject | KuzzleRequest arguments (except body) | get |
body #
| Type | Description | get / set |
|---|
JSONObject | KuzzleRequest body | get |
controller #
| Type | Description | get / set |
|---|
string | API controller name | get |
| Type | Description | get / set |
|---|
JSONObject | KuzzleRequest headers (Http only) | get |
jwt #
| Type | Description | get / set |
|---|
string | Authentication token | get |
resource #
Deprecated since 2.11.0
| Type | Description | get / set |
|---|
JSONObject | Class containing Kuzzle specific arguments | get |
Specific arguments #
| name | Type | Description | get / set |
|---|
resource._id | string | Document ID | get |
resource.index | string | Index name | get |
resource.collection | string | Collection name | get |
volatile #
| Type | Description | get / set |
|---|
string | API action name | get |