Get a watch

GET /_watcher/watch/{id}

Auth

Required privileges

Cluster privileges monitor_watcher

Path parameters

id string required: The watch identifier.

Response

application/json

found boolean required
_id string required
status object
watch object
_primary_term number
_seq_no number
_version number

View as Markdown

Examples

Request Console 1 / 7 languages

Console Kibana Dev Tools

GET _watcher/watch/my_watch

JavaScript Elasticsearch JavaScript Client

const response = await client.watcher.getWatch({
  id: "my_watch",
});

Python Elasticsearch Python Client

resp = client.watcher.get_watch(
    id="my_watch",
)

curl Shell

curl -X GET "$ELASTICSEARCH_URL/_watcher/watch/my_watch" \
  -H "Authorization: ApiKey $ELASTIC_API_KEY"

Java Elasticsearch Java Client

client.watcher().getWatch(g -> g
    .id("my_watch")
);

PHP Elasticsearch PHP Client

$resp = $client->watcher()->getWatch([
    "id" => "my_watch",
]);

Ruby Elasticsearch Ruby Client

response = client.watcher.get_watch(
  id: "my_watch"
)

Response

A successful response from GET _watcher/watch/my_watch.

{
  "found": true,
  "_id": "my_watch",
  "_seq_no": 0,
  "_primary_term": 1,
  "_version": 1,
  "status": { 
    "version": 1,
    "state": {
      "active": true,
      "timestamp": "2015-05-26T18:21:08.630Z"
    },
    "actions": {
      "test_index": {
        "ack": {
          "timestamp": "2015-05-26T18:21:08.630Z",
          "state": "awaits_successful_execution"
        }
      }
    }
  },
  "watch": {
    "input": {
      "simple": {
        "payload": {
          "send": "yes"
        }
      }
    },
    "condition": {
      "always": {}
    },
    "trigger": {
      "schedule": {
        "hourly": {
          "minute": [0, 5]
        }
      }
    },
    "actions": {
      "test_index": {
        "index": {
          "index": "test"
        }
      }
    }
  }
}