rest_api_tenant_activate.md 1.62 KB
Newer Older
Nils Bandener's avatar
Nils Bandener committed
1
2
3
4
5
6
7
8
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
35
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
---
title: Activate and deactivate watch
html_title: Activating and deactivating a watch with the REST API
slug: elasticsearch-alerting-rest-api-watch-activate
category: signals-rest
order: 500
layout: docs
edition: beta
description: 
---

<!--- Copyright 2019 floragunn GmbH -->

# Activate/Deactivate Signals API
{: .no_toc}

{% include toc.md %}


## Endpoint

```
PUT /_signals/tenant/{tenant}/_active
```

```
DELETE  /_signals/tenant/{tenant}/_active
```

These endpoints can be used to activate and deactivate the execution of all watches configured for a Signals tenant.

Using the PUT verb activates the execution, using the DELETE verb deactivates the execution.

This is equivalent to changing the value of the Signals setting `tenant.{tenant}.active`. However, this API requires a distinct permission. Thus, it is possible to allow a user activation and deactivation of a tenant while the user cannot change other settings.

## Path Parameters

**{tenant}:** The name of the tenant to be activated or deactivated. `_main` refers to the default tenant. Users of the community edition will can only use `_main` here.

## Request Body

No request body is required for this endpoint.

## Responses

### 200 OK

The execution was successfully enabled or disabled.

### 403 Forbidden

The user does not have the permission to activate or deactivate the execution of a tenant. 

## Permissions

For being able to access the endpoint, the user needs to have the privilege `cluster:admin:searchguard:tenant:signals:tenant/start_stop` .

This permission is included in the following [built-in action groups](security_permissions.md):

* SGS\_SIGNALS\_ALL