Version: SG FLX
Community
Put Settings API
Endpoint
copy
PUT /_signals/settings/{key}
Updates a Signals configuration setting.
Path Parameters
{key} The configuration setting to be updated. See (Signals Administration)[administration.md] for a list of the available settings.
Request Body
The value of the setting as JSON. This means that if a setting is a simple textual value, you need to specify the value within quotes.
Responses
200 OK
The setting was updated.
400 Bad Request
The request was malformed.
403 Forbidden
The user does not have the permission to set settings.
Permissions
For being able to access the endpoint, the user needs to have the privilege cluster:admin:searchguard:signals:settings/put.
This permission is included in the following built-in action groups:
- SGS_SIGNALS_ALL
Examples
Node Filter
copy
PUT /_signals/settings/tenant._main.node_filter
copy
"signals:true"
Response
copy
200 OK
Active
copy
PUT /_signals/settings/active
copy
true
Response
copy
200 OK