Get Builtin Privileges APIedit

Retrieves the list of cluster privileges and index privileges that are available in this version of Elasticsearch.

Synchronous executionedit

When executing the get-builtin-privileges API in the following manner, the client waits for the GetBuiltinPrivilegesResponse to be returned before continuing with code execution:

GetBuiltinPrivilegesResponse response =;

Synchronous calls may throw an IOException in case of either failing to parse the REST response in the high-level REST client, the request times out or similar cases where there is no response coming back from the server.

In cases where the server returns a 4xx or 5xx error code, the high-level client tries to parse the response body error details instead and then throws a generic ElasticsearchException and adds the original ResponseException as a suppressed exception to it.

Asynchronous executionedit

The get-builtin-privileges API can also be called in an asynchronous fashion so that the client can return directly. Users need to specify how the response or potential failures will be handled by passing a listener to the asynchronous get-builtin-privileges method:, listener); 

The RequestOptions and ActionListener to use when the execution completes

The asynchronous method does not block and returns immediately. Once it is completed the ActionListener is called back using the onResponse method if the execution successfully completed or using the onFailure method if it failed. Failure scenarios and expected exceptions are the same as in the synchronous execution case.

A typical listener for get-builtin-privileges looks like:

ActionListener<GetBuiltinPrivilegesResponse> listener = new ActionListener<GetBuiltinPrivilegesResponse>() {
    public void onResponse(GetBuiltinPrivilegesResponse response) {

    public void onFailure(Exception e) {

Called when the execution is successfully completed.

Called when the get-builtin-privileges call fails.

Get Builtin Privileges Responseedit

The returned GetBuiltinPrivilegesResponse contains the following properties

A Set of all cluster privileges that are understood by this node.
A Set of all index privileges that are understood by this node.
final Set<String> cluster = response.getClusterPrivileges();
final Set<String> index = response.getIndexPrivileges();