getConfig #
Returns the current Kuzzle configuration.
This route should only be accessible to administrators, as it might return sensitive information about the backend.
getConfig([options]);| Arguments | Type | Description |
|---|---|---|
options | object | Query options |
Options #
Additional query options
| Property | Type (default) | Description |
|---|---|---|
queuable | boolean ( true) | If true, queues the request during downtime, until connected to Kuzzle again |
timeout | number ( -1) | Time (in ms) during which a request will still be waited to be resolved. Set it -1 if you want to wait indefinitely |
triggerEvents | boolean ( false) | If set to true, will trigger events even if using Embeded SDK. You should always ensure that your events/pipes does not create an infinite loop. Available since Kuzzle 2.31.0 |
Resolve #
Resolves to an object containing server configuration.
Usage #
try {
const config = await kuzzle.server.getConfig();
console.log('Kuzzle Server configuration:', JSON.stringify(config));
} catch (error) {
console.error(error.message);
}