rest_api_settings_put.md 1.34 KB
Newer Older
Nils Bandener's avatar
Nils Bandener committed
1
2
3
4
5
6
7
---
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
8
edition: beta
Nils Bandener's avatar
Nils Bandener committed
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
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

35
The value of the setting as JSON. This means that if a setting is a simple textual value, you need to specify the value within quotes.
Nils Bandener's avatar
Nils Bandener committed
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69

## 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
```
```
70
"signals:true"
Nils Bandener's avatar
Nils Bandener committed
71
72
73
74
75
76
77
78
```

**Response**

```
200 OK
```

79
80
81
82
83
84
85
86
87
88
89
90
91
92
### Active

```
PUT /_signals/active
```
```
true
```

**Response**

```
200 OK
```
Nils Bandener's avatar
Nils Bandener committed
93
94