IMPORTANT: No additional bug fixes or documentation updates will be released for this version. For the latest information, see the current release documentation.

« Execute watch API Get Watcher stats API »

› › ›

Get watch API

edit

Get watch API

edit

Retrieves a watch by its ID.

Request

edit

GET _watcher/watch/<watch_id>

Prerequisites

edit

You must have manage_watcher or monitor_watcher cluster privileges to use this API. For more information, see Security privileges.

Path parameters

edit

<watch_id>: (Required, string) Identifier for the watch.

Examples

edit

The following example gets a watch with my_watch id:

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

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

GET _watcher/watch/my_watch

Response:

{
  "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"
        }
      }
    }
  }
}

The current status of the watch

« Execute watch API Get Watcher stats API »