Version: 7.x-36.0.0

This is a technical preview. Technical preview features are not fully supported, may not be functionally complete, and are not suitable for deployment in production. We encourage you to try them out and provide your feedback, good and bad, on the Search Guard forum. This will help us improve and add any features you might be missing.

Acknowledge Watch API

Endpoint

PUT /_signals/watch/{watch_id}/_ack
PUT /_signals/watch/{watch_id}/_ack/{action_id}

These endpoints can be used to acknowledge actions performed by watches. By acknowledging actions, you can temporarily suppress further executions of these actions.

When an action is acknowledged, its checks will be still executed on schedule. The actual action however won’t be executed until the checks determined the action to be inapplicable during at least one scheduled run. If the checks change their state again afterwards, the action will be normally executed again.

Path Parameters

{watch_id} The id of the watch containing the action to be acknowledged. Required.

{action_id} The id of the action to be acknowledged. Optional. If not specified, all actions of the watch will be acknowledged.

Request Body

No request body is required for this endpoint.

Responses

200 OK

A watch identified by the given id exists and was successfully acknowledged.

403 Forbidden

The user does not have the permission to acknowledge watches for the currently selected tenant.

404 Not Found

A watch with the given id does not exist for the current tenant.

The status 404 is also returned if the tenant specified by the sg_tenant request header does not exist.

412 Precondition Failed

The specified action was not executed during its last scheduled run. Thus, it cannot be acknowledged.

Multi Tenancy

The watch REST API is tenant-aware. Each Signals tenant has its own separate set of watches. The HTTP request header sg_tenant can be used to specify the tenant to be used. If the header is absent, the default tenant is used.

Permissions

For being able to access the endpoint, the user needs to have the privilege cluster:admin:searchguard:tenant:signals:watch/ack for the currently selected tenant.

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

  • SGS_SIGNALS_WATCH_ACKNOWLEDGE

Examples

PUT /_signals/watch/bad_weather/_ack/email

Response

200 OK

Not what you were looking for? Try the search.