SDK
SDK C++ v1.x
1

You are currently looking at the documentation of a previous version of Kuzzle. We strongly recommend that you use the latest version. You can also use the version selector in the top menu.

This SDK has been deprecated because of stability issues. It is not advised to use it in a production environment.

getConfig #

Returns the current Kuzzle configuration.

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

Signature #

Copied to clipboard!
std::string getConfig();

std::string getConfig(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 current server configuration.

Exceptions #

Throws a kuzzleio::KuzzleException if there is an error. See how to handle error.

Usage #

Copied to clipboard!
try {
  std::string configuration = kuzzle->server->getConfig();
  std::cout << configuration << std::endl;
} catch (kuzzleio::KuzzleException& e) {
  std::cerr << e.what() << std::endl;
}