info

Returns information about Kuzzle: available API (base + extended), plugins, external services (Redis, Elasticsearch, ...), servers, etc.


Copied to clipboard!
info([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 information.

Usage

Copied to clipboard!
try {
  const serverInfo = await kuzzle.server.info();

  console.log('Kuzzle Server information:', JSON.stringify(serverInfo));
} catch (error) {
  console.error(error.message);
}