Get Account API

Content

Endpoint
Path Parameters
Responses
Permissions
Examples

Endpoint

GET /_signals/account/{account_type}/{account_id}

Retrieves the account of type {account_type} identified by the {account_id} path parameter.

Path Parameters

{account_type} The type of the account to be retrieved. Required.

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

Responses

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.

Permissions

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

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

SGS_SIGNALS_ACCOUNT_MANAGE
SGS_SIGNALS_ACCOUNT_READ

Examples

GET /_signals/account/default_email

Response

200 OK

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

Questions? Drop us a note!