rest_api.md 2.08 KB
Newer Older
1
2
3
4
5
6
7
8
---
title: REST API
html_title: Managing Signals Alerting with the REST API
slug: elasticsearch-alerting-rest-api
category: signals
subcategory: signals-rest
order: 900
layout: docs
9
edition: beta
10
canonical: elasticsearch-alerting-rest-api-overview
11
12
13
14
15
16
17
18
19
20
description: 
---

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

# REST API
{: .no_toc}

{% include toc.md %}

Jochen Kressin's avatar
Jochen Kressin committed
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
Signals can be configured by using the Signals REST API. To use the API, make sure that the user has [sufficient permissions](security_permissions.md). 

For a quick start, you can either use the Search Guard [admin demo user](demo-users-roles#demo-users), or assign the `SGS_SIGNALS_ALL` action group on cluster- and tenant-level to a Search Guard role, e.g.:

```
sg_signals_all:
  cluster_permissions:
    - 'GS_SIGNALS_ALL
  index_permissions:
    - index_patterns:
        - 'signal*'
      allowed_actions:
        - '*'
  tenant_permissions:
    - tenant_patterns:
        - '*'
      allowed_actions:
        - 'SGS_SIGNALS_ALL'
```

This will give this role complete access to all Signals features and indices.

## Watches APIs

* [Get Watch](rest_api_watch_get.md)
* [Search Watch](rest_api_watch_search.md)
* [Put Watch](rest_api_watch_put.md)
* [Delete Watch](rest_api_watch_delete.md)
* [Activate and Deactivate Watch](rest_api_watch_activate.md)
* [Execute Watch](rest_api_watch_execute.md)
* [Acknowledge Watch](rest_api_watch_acknowledge.md)
Nils Bandener's avatar
Nils Bandener committed
52
* [Un-Acknowledge Watch](rest_api_watch_unacknowledge.md)
Jochen Kressin's avatar
Jochen Kressin committed
53

Nils Bandener's avatar
Nils Bandener committed
54
55
56
57
58
59
## Watch State APIs

* [Get Watch State](rest_api_watch_state.md)
* [Search Watch State](rest_api_watch_state_search.md)


Jochen Kressin's avatar
Jochen Kressin committed
60
61
62
63
64
## Accounts APIs

* [Get Account](rest_api_watch_get.md)
* [Search Account](rest_api_account_search.md)
* [Put Account](rest_api_account_put.md)
Nils Bandener's avatar
Nils Bandener committed
65
66
67
68
69
70
* [Delete Account](rest_api_account_delete.md)

## Settings APIs

* [Get Settings](rest_api_settings_get.md)
* [Put Settings](rest_api_settings_put.md)
Nils Bandener's avatar
Nils Bandener committed
71
72
73
74

## Administration APIs

* [Activate and Deactivate Execution for Tenant](rest_api_tenant_activate.md)
75
76
77
78
79
* [Activate and Deactivate Execution Globally](rest_api_admin_activate.md)

## Other APIs

* [Convert Watch](rest_api_convert_es.md)