SDK
SDK Javascript v6.x
1

getConfig #

Returns the current Kuzzle configuration.

This route should only be accessible to administrators, as it might return sensitive information about the backend.


Copied to clipboard!
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

Resolve #

Resolves to an object containing server configuration.

Usage #

Copied to clipboard!
try {
  const config = await kuzzle.server.getConfig();
  console.log('Kuzzle Server configuration:', JSON.stringify(config));
} catch (error) {
  console.error(error.message);
}