Commit 25ff5a93 authored by Nils Bandener's avatar Nils Bandener
Browse files

Settings API

parent 155c573c
---
title: Put Destination
html_title: Put a destination with the REST API
slug: elasticsearch-alerting-rest-api-destination-put
category: signals-rest
order: 900
layout: docs
edition: preview
description:
---
<!--- Copyright 2019 floragunn GmbH -->
# Get Settings API
{: .no_toc}
{% include toc.md %}
## Endpoint
```
GET /_signals/settings
```
```
GET /_signals/settings/{key}
```
Retries all Signals settings or a single setting item.
## Path Parameters
**{key}** The configuration setting to be retrieved. See (Signals Administration)[administration.md] 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.
### 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](security_permissions.md):
* SGS\_SIGNALS\_ALL
## Examples
```
GET /_signals/settings
```
**Response**
```
TODO
```
---
title: Put Destination
html_title: Put a destination with the REST API
slug: elasticsearch-alerting-rest-api-destination-put
category: signals-rest
order: 900
layout: docs
edition: preview
description:
---
<!--- Copyright 2019 floragunn GmbH -->
# Put Settings API
{: .no_toc}
{% include toc.md %}
## Endpoint
```
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.
## 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](security_permissions.md):
* SGS\_SIGNALS\_ALL
## Examples
### Node Filter
```
PUT /_signals/tenant._main.node_filter
```
```
signals:true
```
**Response**
```
200 OK
```
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment