Tools & Resources

Tools

`auth_me`

Get the current user

`auth_strategies`

Get the available authentication strategies

Prop	Type	Default
`include_disabled?`	`boolean`	-

`auth_user_create`

Create a new user

Prop	Type	Default
`email`	`string`	-
`password`	`string`	-
`role?`	`string`	-

`auth_user_password_change`

Change a user's password

Prop	Type	Default
`id?`	`number \| string`	-
`email?`	`string`	-
`password`	`string`	-

`auth_user_password_test`

Test a user's password

Prop	Type	Default
`email`	`string`	-
`password`	`string`	-

`auth_user_token`

Get a user token

Prop	Type	Default
`id?`	`number \| string`	-
`email?`	`string`	-

`data_entity_delete_many`

Delete many

Prop	Type	Default
`entity`	`string`	-
`json`	`object`	-

`data_entity_delete_one`

Delete one

Prop	Type	Default
`entity`	`string`	-
`id`	`number \| string`	-

`data_entity_fn_count`

Count entities

Prop	Type	Default
`entity`	`string`	-
`json?`	`string \| object`	`{}`

`data_entity_fn_exists`

Check if entity exists

Prop	Type	Default
`entity`	`string`	-
`json?`	`string \| object`	`{}`

`data_entity_info`

Retrieve entity info

Prop	Type	Default
`entity`	`string`	-

`data_entity_insert`

Insert one or many

Prop	Type	Default
`entity`	`string`	-
`json`	`object \| array`	-

`data_entity_read_many`

Query entities

Prop	Type	Default
`entity`	`string`	-
`limit?`	`number`	`10`
`offset?`	`number`	`0`
`sort?`	`string`	`"id"`
`where?`	`string \| object`	`{}`
`select?`	`array`	-
`join?`	`array`	-
`with?`	`object`	-

`data_entity_read_one`

Read one

Prop	Type	Default
`entity`	`string`	-
`id`	`number \| string`	-
`offset?`	`number`	`0`
`sort?`	`string`	`"id"`
`select?`	`array`	-

`data_entity_update_many`

Update many

Prop	Type	Default
`entity`	`string`	-
`update`	`object`	-
`where`	`object`	-

`data_entity_update_one`

Update one

Prop	Type	Default
`entity`	`string`	-
`id`	`number \| string`	-
`json`	`object`	-

`data_sync`

Sync database schema

Prop	Type	Default
`force?`	`boolean`	-
`drop?`	`boolean`	-

`system_build`

Build the app

Prop	Type	Default
`sync?`	`boolean`	-
`fetch?`	`boolean`	-

`system_config`

Get the config for a module

Prop	Type	Default
`module?`	`string`	-
`secrets?`	`boolean`	-

`system_info`

Get the server info

`system_ping`

Ping the server

`config_auth_get`

Prop	Type	Default
`path?`	`string`	-
`depth?`	`number`	-
`secrets?`	`boolean`	`false`

`config_auth_roles_add`

Prop	Type	Default
`key`	`string`	-
`value`	`object`	-
`return_config?`	`boolean`	`false`

`config_auth_roles_get`

Prop	Type	Default
`key?`	`string`	-
`secrets?`	`boolean`	`false`
`schema?`	`boolean`	`false`

`config_auth_roles_remove`

Prop	Type	Default
`key`	`string`	-
`return_config?`	`boolean`	`false`

`config_auth_roles_update`

Prop	Type	Default
`key`	`string`	-
`value`	`object`	-
`return_config?`	`boolean`	`false`

`config_auth_strategies_add`

Prop	Type	Default
`key`	`string`	-
`value`	`object`	-
`return_config?`	`boolean`	`false`

`config_auth_strategies_get`

Prop	Type	Default
`key?`	`string`	-
`secrets?`	`boolean`	`false`
`schema?`	`boolean`	`false`

`config_auth_strategies_remove`

Prop	Type	Default
`key`	`string`	-
`return_config?`	`boolean`	`false`

`config_auth_strategies_update`

Prop	Type	Default
`key`	`string`	-
`value`	`object`	-
`return_config?`	`boolean`	`false`

`config_auth_update`

Prop	Type	Default
`full?`	`boolean`	`false`
`return_config?`	`boolean`	`false`
`value`	`object`	-

`config_data_entities_add`

Prop	Type	Default
`key`	`string`	-
`value`	`object`	-
`return_config?`	`boolean`	`false`

`config_data_entities_get`

Prop	Type	Default
`key?`	`string`	-
`secrets?`	`boolean`	`false`
`schema?`	`boolean`	`false`

`config_data_entities_remove`

Prop	Type	Default
`key`	`string`	-
`return_config?`	`boolean`	`false`

`config_data_entities_update`

Prop	Type	Default
`key`	`string`	-
`value`	`object`	-
`return_config?`	`boolean`	`false`

`config_data_get`

Prop	Type	Default
`path?`	`string`	-
`depth?`	`number`	-
`secrets?`	`boolean`	`false`

`config_data_indices_add`

Prop	Type	Default
`key`	`string`	-
`value`	`object`	-
`return_config?`	`boolean`	`false`

`config_data_indices_get`

Prop	Type	Default
`key?`	`string`	-
`secrets?`	`boolean`	`false`
`schema?`	`boolean`	`false`

`config_data_indices_remove`

Prop	Type	Default
`key`	`string`	-
`return_config?`	`boolean`	`false`

`config_data_relations_add`

Prop	Type	Default
`key`	`string`	-
`value`	`object`	-
`return_config?`	`boolean`	`false`

`config_data_relations_get`

Prop	Type	Default
`key?`	`string`	-
`secrets?`	`boolean`	`false`
`schema?`	`boolean`	`false`

`config_data_relations_remove`

Prop	Type	Default
`key`	`string`	-
`return_config?`	`boolean`	`false`

`config_data_relations_update`

Prop	Type	Default
`key`	`string`	-
`value`	`object`	-
`return_config?`	`boolean`	`false`

`config_data_update`

Prop	Type	Default
`full?`	`boolean`	`false`
`return_config?`	`boolean`	`false`
`value`	`object`	-

`config_media_adapter_get`

Prop	Type	Default
`secrets?`	`boolean`	`false`

`config_media_adapter_update`

Prop	Type	Default
`value?`	`object \| object \| object`	-
`return_config?`	`boolean`	`false`
`secrets?`	`boolean`	`false`

`config_media_get`

Prop	Type	Default
`path?`	`string`	-
`depth?`	`number`	-
`secrets?`	`boolean`	`false`

`config_media_update`

Prop	Type	Default
`full?`	`boolean`	`false`
`return_config?`	`boolean`	`false`
`value`	`object`	-

`config_server_get`

Get Server configuration

Prop	Type	Default
`path?`	`string`	-
`depth?`	`number`	-
`secrets?`	`boolean`	`false`

`config_server_update`

Update Server configuration

Prop	Type	Default
`full?`	`boolean`	`false`
`return_config?`	`boolean`	`false`
`value`	`object`	-

Resources

`data_entities`

Retrieve all entities

`data_relations`

Retrieve all relations

`data_indices`

Retrieve all indices

Tools & Resources

On this page