SDK
SDK Java 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.

Arguments #

public java.lang.String getConfig(
io.kuzzle.sdk.QueryOptions
);
public java.lang.String getConfig();
ArgumentsTypeDescriptionRequired
optionsio.kuzzle.sdk.QueryOptionsAn object containing query options.no

Options #

Additional query options

PropertyTypeDescriptionDefault
queuablebooleanMake this request queuable or nottrue

Return #

Return server configuration as a String.

Exceptions #

Throws a io.kuzzle.sdk.KuzzleException if there is an error. See how to handle error.

Usage #

try {
  String config = new String(kuzzle.getServer().getConfig());
  System.out.println("Kuzzle Server configuration as JSON string: " + config);
} catch (KuzzleException e) {
  System.err.println(e.getMessage());
}