Reload the keystore on nodes in the cluster

  • POST /_nodes/{node_id}/reload_secure_settings
  • POST /_nodes/reload_secure_settings
Auth

Secure settings are stored in an on-disk keystore. Certain of these settings are reloadable. That is, you can change them on disk and reload them without restarting any nodes in the cluster. When you have updated reloadable secure settings in your keystore, you can use this API to reload those settings on each node.

When the Elasticsearch keystore is password protected and not simply obfuscated, you must provide the password for the keystore when you reload the secure settings. Reloading the settings for the whole cluster assumes that the keystores for all nodes are protected with the same password; this method is allowed only when inter-node communications are encrypted. Alternatively, you can reload the secure settings on each node by locally accessing the API and passing the node-specific Elasticsearch keystore password.

Path parameters

node_id union string | string[] optional

The names of particular nodes in the cluster to target.

Leave it out to use /_nodes/reload_secure_settings.

Query parameters

timeout string · default: 30s

Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error.

Request body

secure_settings_password string

The password for the Elasticsearch keystore.

Response

application/json
_nodes object

Contains statistics about the number of nodes selected by the request’s node filters.

failures object[]
type string required

The type of error

reason union string nullable

A human-readable explanation of the error, in English.

One of: string
stack_trace string

The server stack trace. Present only if the error_trace=true parameter was sent with the request.

caused_by object
Same fields as failures in _nodes
root_cause object[]
Same fields as failures in _nodes
suppressed object[]
Same fields as failures in _nodes
total number required

Total number of nodes selected by the request.

successful number required

Number of nodes that responded successfully to the request.

failed number required

Number of nodes that rejected the request or failed to respond. If this value is not 0, a reason for the rejection or failure is included in the response.

cluster_name string required
nodes map string to object required
<string> object
name string required
reload_exception object
type string required

The type of error

reason union string nullable

A human-readable explanation of the error, in English.

One of: string
stack_trace string

The server stack trace. Present only if the error_trace=true parameter was sent with the request.

caused_by object
Same fields as reload_exception in nodes
root_cause object[]
Same fields as reload_exception in nodes
suppressed object[]
Same fields as reload_exception in nodes
secure_setting_names string[]

The names of the secure settings that were reloaded.

keystore_path string

The path to the keystore file.

keystore_digest string

A SHA-256 hash of the keystore file contents.

keystore_last_modified_time union oneOf

The last modification time of the keystore file.

One of: string or number