info #
Returns information about Kuzzle: available API (base + extended), plugins, external services (Redis, Elasticsearch, ...), servers, etc.
Signature #
std::string info();
std::string info(const kuzzleio::query_options& options);
Arguments #
Arguments | Type | Description |
---|---|---|
options | kuzzleio::query_options* | Query options |
options #
Additional query options
Option | Type (default) | Description |
---|---|---|
queuable | bool ( true ) | If true, queues the request during downtime, until connected to Kuzzle again |
Return #
A JSON string representing the server information.
Exceptions #
Throws a kuzzleio::KuzzleException
if there is an error. See how to handle error.
Usage #
try {
std::string kuzzle_info = kuzzle->server->info();
std::cout << kuzzle_info << std::endl;
} catch (kuzzleio::KuzzleException& e) {
std::cerr << e.what() << std::endl;
}
Edit this page on Github(opens new window)