Version: 7.x-36.0.0

This is a technical preview. Technical preview features are not fully supported, may not be functionally complete, and are not suitable for deployment in production. We encourage you to try them out and provide your feedback, good and bad, on the Search Guard forum. This will help us improve and add any features you might be missing.

Get Account API


GET /_signals/account/{account_id}

Retrieves the account configuration identified by the {account_id} path parameter.

Path Parameters

{account_id} The id of the account to be retrieved. Required.


200 OK

The account exists and the user has sufficient privileges to access it.

The return document is structured like an ElasticSearch GetDocument response with the configuration in the _source element. See example below.

403 Forbidden

The user does not have the required to access the endpoint.

404 Not found

An account with the given id does not exist.


For being able to access the endpoint, the user needs to have the privilege cluster:admin:searchguard:signals:destination/get.

This permission is included in the following built-in action groups:



GET /_signals/account/default_email


200 OK
    "_id": "default_email",
    "found": true,
    "_version": 2,
    "_seq_no": 13,
    "_primary_term": 5,
    "_source": {
        "type": "email",
        "host": "localhost",
        "port": 2500

Not what you were looking for? Try the search.