Version: SG FLX
Community

Get Settings API

Endpoint

copy
GET /_signals/settings
copy
GET /_signals/settings/{key}

Retrieves all Signals settings or a single settings item.

Path Parameters

{key} The configuration setting to be retrieved. See Signals Administration for a list of the available settings.

Responses

200 OK

The setting could be successfully retrieved. The value of the settings is returned in the response body. The response format is JSON. This means, that if a setting as a simple textual value, the value will be returned in double quotes. If you specify the header Accept: text/plain in the request, you will get a plain text response with unquoted textual values.

403 Forbidden

The user does not have the permission to retrieve settings.

404 Not Found

A setting does not exist for the particular key.

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

copy
GET /_signals/settings

Response

copy
{
  "active": "true",
  "http": {
    "allowed_endpoints": [
      "https://www.example.com/*",
      "https://intra.example.com/*"
    ]
  },
  "tenant": {
    "_main": {
      "active": "true",
      "node_filter": "node.attr.signals: true"
    }
  }
}
copy
GET /_signals/settings/watch_log.index

Response

copy
""


Not what you were looking for? Try the search.