REST API

Content

Watches APIs
Watch State APIs
Accounts APIs
Settings APIs
Trust Stores API
Proxies API

Signals can be configured by using the Signals REST API. To use the API, make sure that the user has sufficient permissions.

For a quick start, you can either use the Search Guard admin demo user, or assign the SGS_SIGNALS_ALL action group on cluster- and tenant-level to a Search Guard role, e.g.:

sg_signals_all:
  cluster_permissions:
    - 'GS_SIGNALS_ALL
  index_permissions:
    - index_patterns:
        - 'signal*'
      allowed_actions:
        - '*'
  tenant_permissions:
    - tenant_patterns:
        - '*'
      allowed_actions:
        - 'SGS_SIGNALS_ALL'

This will give this role complete access to all Signals features and indices.