Get a watch | Elasticsearch API documentation

Get a watch Generally available; Added in 5.6.0

GET /_watcher/watch/{id}

Api key auth Basic auth Bearer auth

Required authorization

Cluster privileges: monitor_watcher

Path parameters

id string Required

The watch identifier.

Responses

200 application/json
Hide response attributes Show response attributes object
- found boolean Required
- _id string Required
- status object
  
  Hide status attributes Show status attributes object
  
  actions object Required
  
  Hide actions attribute Show actions attribute object
  
  * object Additional properties
  
  Hide * attributes Show * attributes object
  
  ack object Required
  
  Hide ack attributes Show ack attributes object
  
  state string Required
  
  Values are awaits_successful_execution, ackable, or acked.
  
  timestamp string
  
  last_execution object
  
  Hide last_execution attributes Show last_execution attributes object
  
  successful boolean Required
  
  timestamp string
  
  reason string
  
  last_successful_execution object
  
  Hide last_successful_execution attributes Show last_successful_execution attributes object
  
  successful boolean Required
  
  timestamp string
  
  reason string
  
  last_throttle object
  
  Hide last_throttle attributes Show last_throttle attributes object
  
  reason string Required
  
  timestamp string
  
  last_checked string | number
  
  A date and time, either as a string whose format can depend on the context (defaulting to ISO 8601), or a number of milliseconds since the Epoch. Elasticsearch accepts both as input, but will generally output a string representation.
  
  One of:
  DateTime string UnitMillis number
  
  Time unit for milliseconds
  
  last_met_condition string | number
  
  A date and time, either as a string whose format can depend on the context (defaulting to ISO 8601), or a number of milliseconds since the Epoch. Elasticsearch accepts both as input, but will generally output a string representation.
  
  One of:
  DateTime string UnitMillis number
  
  Time unit for milliseconds
  
  state object Required
  
  Hide state attributes Show state attributes object
  
  active boolean Required
  
  timestamp string | number Required
  
  A date and time, either as a string whose format can depend on the context (defaulting to ISO 8601), or a number of milliseconds since the Epoch. Elasticsearch accepts both as input, but will generally output a string representation.
  
  One of:
  DateTime string UnitMillis number
  
  Time unit for milliseconds
  
  version number Required
  
  execution_state string
- watch object
  
  Hide watch attributes Show watch attributes object
  
  actions object Required
  
  Hide actions attribute Show actions attribute object
  
  * object Additional properties
  
  Hide * attributes Show * attributes object
  
  action_type string
  
  Values are email, webhook, index, logging, slack, or pagerduty.
  
  condition object
  
  Hide condition attributes Show condition attributes object
  
  always object
  
  array_compare object
  
  Hide array_compare attribute Show array_compare attribute object
  
  * object Additional properties
  
  compare object
  
  Hide compare attribute Show compare attribute object
  
  * object Additional properties
  
  never object
  
  script object
  
  Hide script attributes Show script attributes object
  
  lang
  
  params object
  
  source
  
  id string
  
  foreach string
  
  max_iterations number
  
  name string
  
  throttle_period string
  
  A duration. Units can be nanos, micros, ms (milliseconds), s (seconds), m (minutes), h (hours) and d (days). Also accepts "0" without a unit and "-1" to indicate an unspecified value.
  
  throttle_period_in_millis number
  
  Time unit for milliseconds
  
  transform object
  
  Hide transform attributes Show transform attributes object
  
  chain array[object]
  
  script object
  
  Hide script attributes Show script attributes object
  
  lang string
  
  params object
  
  source
  
  id string
  
  search object
  
  Hide search attributes Show search attributes object
  
  request object Required
  
  timeout string Required
  
  A duration. Units can be nanos, micros, ms (milliseconds), s (seconds), m (minutes), h (hours) and d (days). Also accepts "0" without a unit and "-1" to indicate an unspecified value.
  
  index object
  
  Hide index attributes Show index attributes object
  
  index string Required
  
  doc_id string
  
  refresh string
  
  Values are true, false, or wait_for.
  
  op_type string
  
  Values are index or create.
  
  timeout string
  
  A duration. Units can be nanos, micros, ms (milliseconds), s (seconds), m (minutes), h (hours) and d (days). Also accepts "0" without a unit and "-1" to indicate an unspecified value.
  
  execution_time_field string
  
  Path to field or array of paths. Some API's support wildcards in the path to select multiple fields.
  
  logging object
  
  Hide logging attributes Show logging attributes object
  
  level string
  
  text string Required
  
  category string
  
  email object
  
  Hide email attributes Show email attributes object
  
  id string
  
  bcc
  
  body object
  
  cc
  
  from string
  
  priority string
  
  Values are lowest, low, normal, high, or highest.
  
  reply_to
  
  sent_date
  
  subject string Required
  
  to
  
  attachments object
  
  pagerduty object
  
  Hide pagerduty attributes Show pagerduty attributes object
  
  account string
  
  attach_payload boolean Required
  
  client string
  
  client_url string
  
  contexts array[object]
  
  description string Required
  
  event_type string
  
  Values are trigger, resolve, or acknowledge.
  
  incident_key string Required
  
  proxy object
  
  slack object
  
  Hide slack attributes Show slack attributes object
  
  account string
  
  message object Required
  
  Hide message attributes Show message attributes object
  
  attachments array[object] Required
  
  dynamic_attachments object
  
  from string Required
  
  icon string
  
  text string Required
  
  to array[string] Required
  
  webhook object
  
  Hide webhook attributes Show webhook attributes object
  
  auth object
  
  body string
  
  connection_timeout string
  
  A duration. Units can be nanos, micros, ms (milliseconds), s (seconds), m (minutes), h (hours) and d (days). Also accepts "0" without a unit and "-1" to indicate an unspecified value.
  
  headers object
  
  host string
  
  method string
  
  Values are head, get, post, put, or delete.
  
  params object
  
  path string
  
  port number
  
  proxy object
  
  read_timeout string
  
  A duration. Units can be nanos, micros, ms (milliseconds), s (seconds), m (minutes), h (hours) and d (days). Also accepts "0" without a unit and "-1" to indicate an unspecified value.
  
  scheme string
  
  Values are http or https.
  
  url string
  
  condition object Required
  
  Hide condition attributes Show condition attributes object
  
  always object
  
  array_compare object
  
  Hide array_compare attribute Show array_compare attribute object
  
  * object Additional properties
  
  Hide * attribute Show * attribute object
  
  path string Required
  
  compare object
  
  Hide compare attribute Show compare attribute object
  
  * object Additional properties
  
  never object
  
  script object
  
  Hide script attributes Show script attributes object
  
  lang string
  
  Any of:
  ScriptLanguage string ScriptLanguage string
  
  Values are painless, expression, mustache, or java.
  
  params object
  
  Hide params attribute Show params attribute object
  
  * object Additional properties
  
  source string | object
  
  One of:
  ScriptSource string SearchRequestBody object
  
  Hide attributes Show attributes
  
  aggregations object
  
  Defines the aggregations that are run as part of the search request.
  
  collapse object
  
  explain boolean
  
  If true, the request returns detailed information about score computation as part of a hit.
  
  ext object
  
  Configuration of search extensions defined by Elasticsearch plugins.
  
  from number
  
  The starting document offset, which must be non-negative. By default, you cannot page through more than 10,000 hits using the from and size parameters. To page through more hits, use the search_after parameter.
  
  highlight
  
  track_total_hits boolean | number
  
  Number of hits matching the query to count accurately. If true, the exact number of hits is returned at the cost of some performance. If false, the response does not include the total number of hits matching the query. Defaults to 10,000 hits.
  
  indices_boost array[object]
  
  Boost the _score of documents from specified indices. The boost value is the factor by which scores are multiplied. A boost value greater than 1.0 increases the score. A boost value between 0 and 1.0 decreases the score.
  
  docvalue_fields array[object]
  
  An array of wildcard (*) field patterns. The request returns doc values for field names matching these patterns in the hits.fields property of the response.
  
  knn
  
  rank object
  
  min_score number
  
  The minimum _score for matching documents. Documents with a lower _score are not included in search results or results collected by aggregations.
  
  post_filter object
  
  An Elasticsearch Query DSL (Domain Specific Language) object that defines a query.
  
  profile boolean
  
  Set to true to return detailed timing information about the execution of individual components in a search request. NOTE: This is a debugging tool and adds significant overhead to search execution.
  
  query object
  
  An Elasticsearch Query DSL (Domain Specific Language) object that defines a query.
  
  rescore
  
  retriever object
  
  script_fields object
  
  Retrieve a script evaluation (based on different fields) for each hit.
  
  search_after array[number | string | boolean | null]
  
  A field value.
  
  size number
  
  The number of hits to return, which must not be negative. By default, you cannot page through more than 10,000 hits using the from and size parameters. To page through more hits, use the search_after property.
  
  slice object
  
  sort
  
  _source
  
  fields array[object]
  
  An array of wildcard (*) field patterns. The request returns values for field names matching these patterns in the hits.fields property of the response.
  
  suggest object
  
  terminate_after number
  
  The maximum number of documents to collect for each shard. If a query reaches this limit, Elasticsearch terminates the query early. Elasticsearch collects documents before sorting.
  
  IMPORTANT: Use with caution. Elasticsearch applies this property to each shard handling the request. When possible, let Elasticsearch perform early termination automatically. Avoid specifying this property for requests that target data streams with backing indices across multiple data tiers.
  
  If set to 0 (default), the query does not terminate early.
  
  timeout string
  
  The period of time to wait for a response from each shard. If no response is received before the timeout expires, the request fails and returns an error. Defaults to no timeout.
  
  track_scores boolean
  
  If true, calculate and return document scores, even if the scores are not used for sorting.
  
  version boolean
  
  If true, the request returns the document version as part of a hit.
  
  seq_no_primary_term boolean
  
  If true, the request returns sequence number and primary term of the last modification of each hit.
  
  stored_fields string | array[string]
  
  pit object
  
  runtime_mappings object
  
  stats array[string]
  
  The stats groups to associate with the search. Each group maintains a statistics aggregation for its associated searches. You can retrieve these stats using the indices stats API.
  
  id string
  
  input object Required
  
  Hide input attributes Show input attributes object
  
  chain object
  
  Hide chain attribute Show chain attribute object
  
  inputs array[object] Required
  
  Hide inputs attribute Show inputs attribute object
  
  * object
  
  http object
  
  Hide http attributes Show http attributes object
  
  extract array[string]
  
  request object
  
  Hide request attributes Show request attributes object
  
  auth object
  
  Hide auth attribute Show auth attribute object
  
  basic object Required
  
  body string
  
  connection_timeout string
  
  A duration. Units can be nanos, micros, ms (milliseconds), s (seconds), m (minutes), h (hours) and d (days). Also accepts "0" without a unit and "-1" to indicate an unspecified value.
  
  headers object
  
  Hide headers attribute Show headers attribute object
  
  * string Additional properties
  
  host string
  
  method string
  
  Values are head, get, post, put, or delete.
  
  params object
  
  Hide params attribute Show params attribute object
  
  * string Additional properties
  
  path string
  
  port number
  
  proxy object
  
  Hide proxy attributes Show proxy attributes object
  
  host string Required
  
  port number Required
  
  read_timeout string
  
  A duration. Units can be nanos, micros, ms (milliseconds), s (seconds), m (minutes), h (hours) and d (days). Also accepts "0" without a unit and "-1" to indicate an unspecified value.
  
  scheme string
  
  Values are http or https.
  
  url string
  
  response_content_type string
  
  Values are json, yaml, or text.
  
  search object
  
  Hide search attributes Show search attributes object
  
  extract array[string]
  
  request object Required
  
  Hide request attributes Show request attributes object
  
  body object
  
  Hide body attribute Show body attribute object
  
  query object Required
  
  An Elasticsearch Query DSL (Domain Specific Language) object that defines a query.
  
  indices array[string]
  
  indices_options object
  
  Controls how to deal with unavailable concrete indices (closed or missing), how wildcard expressions are expanded to actual indices (all, closed or open indices) and how to deal with wildcard expressions that resolve to no indices.
  
  Hide indices_options attributes Show indices_options attributes object
  
  allow_no_indices boolean
  
  If false, the request returns an error if any wildcard expression, index alias, or _all value targets only missing or closed indices. This behavior applies even if the request targets other open indices. For example, a request targeting foo*,bar* returns an error if an index starts with foo but no index starts with bar.
  
  expand_wildcards string | array[string]
  
  ignore_unavailable boolean
  
  If true, missing or closed indices are not included in the response.
  
  ignore_throttled boolean
  
  If true, concrete, expanded or aliased indices are ignored when frozen.
  
  search_type string
  
  Values are query_then_fetch or dfs_query_then_fetch.
  
  template object
  
  Hide template attributes Show template attributes object
  
  explain boolean
  
  id string
  
  params object
  
  profile boolean
  
  source string
  
  An inline search template. Supports the same parameters as the search API's request body. Also supports Mustache variables. If no id is specified, this parameter is required.
  
  rest_total_hits_as_int boolean
  
  timeout string
  
  A duration. Units can be nanos, micros, ms (milliseconds), s (seconds), m (minutes), h (hours) and d (days). Also accepts "0" without a unit and "-1" to indicate an unspecified value.
  
  simple object
  
  Hide simple attribute Show simple attribute object
  
  * object Additional properties
  
  metadata object
  
  Hide metadata attribute Show metadata attribute object
  
  * object Additional properties
  
  status object
  
  Hide status attributes Show status attributes object
  
  actions object Required
  
  Hide actions attribute Show actions attribute object
  
  * object Additional properties
  
  Hide * attributes Show * attributes object
  
  ack object Required
  
  Hide ack attributes Show ack attributes object
  
  state string Required
  
  Values are awaits_successful_execution, ackable, or acked.
  
  timestamp
  
  last_execution object
  
  Hide last_execution attributes Show last_execution attributes object
  
  successful boolean Required
  
  timestamp
  
  reason string
  
  last_successful_execution object
  
  Hide last_successful_execution attributes Show last_successful_execution attributes object
  
  successful boolean Required
  
  timestamp
  
  reason string
  
  last_throttle object
  
  Hide last_throttle attributes Show last_throttle attributes object
  
  reason string Required
  
  timestamp
  
  last_checked string | number
  
  A date and time, either as a string whose format can depend on the context (defaulting to ISO 8601), or a number of milliseconds since the Epoch. Elasticsearch accepts both as input, but will generally output a string representation.
  
  One of:
  DateTime string UnitMillis number
  
  Time unit for milliseconds
  
  last_met_condition string | number
  
  A date and time, either as a string whose format can depend on the context (defaulting to ISO 8601), or a number of milliseconds since the Epoch. Elasticsearch accepts both as input, but will generally output a string representation.
  
  One of:
  DateTime string UnitMillis number
  
  Time unit for milliseconds
  
  state object Required
  
  Hide state attributes Show state attributes object
  
  active boolean Required
  
  timestamp string | number Required
  
  A date and time, either as a string whose format can depend on the context (defaulting to ISO 8601), or a number of milliseconds since the Epoch. Elasticsearch accepts both as input, but will generally output a string representation.
  
  One of:
  DateTime string UnitMillis number
  
  Time unit for milliseconds
  
  version number Required
  
  execution_state string
  
  throttle_period string
  
  A duration. Units can be nanos, micros, ms (milliseconds), s (seconds), m (minutes), h (hours) and d (days). Also accepts "0" without a unit and "-1" to indicate an unspecified value.
  
  throttle_period_in_millis number
  
  Time unit for milliseconds
  
  transform object
  
  Hide transform attributes Show transform attributes object
  
  chain array[object]
  
  script object
  
  Hide script attributes Show script attributes object
  
  lang string
  
  params object
  
  Hide params attribute Show params attribute object
  
  * object Additional properties
  
  source string | object
  
  One of:
  ScriptSource string SearchRequestBody object
  
  Hide attributes Show attributes
  
  aggregations object
  
  Defines the aggregations that are run as part of the search request.
  
  collapse object
  
  explain boolean
  
  If true, the request returns detailed information about score computation as part of a hit.
  
  ext object
  
  Configuration of search extensions defined by Elasticsearch plugins.
  
  from number
  
  The starting document offset, which must be non-negative. By default, you cannot page through more than 10,000 hits using the from and size parameters. To page through more hits, use the search_after parameter.
  
  highlight
  
  track_total_hits boolean | number
  
  Number of hits matching the query to count accurately. If true, the exact number of hits is returned at the cost of some performance. If false, the response does not include the total number of hits matching the query. Defaults to 10,000 hits.
  
  indices_boost array[object]
  
  Boost the _score of documents from specified indices. The boost value is the factor by which scores are multiplied. A boost value greater than 1.0 increases the score. A boost value between 0 and 1.0 decreases the score.
  
  docvalue_fields array[object]
  
  An array of wildcard (*) field patterns. The request returns doc values for field names matching these patterns in the hits.fields property of the response.
  
  knn
  
  rank object
  
  min_score number
  
  The minimum _score for matching documents. Documents with a lower _score are not included in search results or results collected by aggregations.
  
  post_filter object
  
  An Elasticsearch Query DSL (Domain Specific Language) object that defines a query.
  
  profile boolean
  
  Set to true to return detailed timing information about the execution of individual components in a search request. NOTE: This is a debugging tool and adds significant overhead to search execution.
  
  query object
  
  An Elasticsearch Query DSL (Domain Specific Language) object that defines a query.
  
  rescore
  
  retriever object
  
  script_fields object
  
  Retrieve a script evaluation (based on different fields) for each hit.
  
  search_after array[number | string | boolean | null]
  
  A field value.
  
  size number
  
  The number of hits to return, which must not be negative. By default, you cannot page through more than 10,000 hits using the from and size parameters. To page through more hits, use the search_after property.
  
  slice object
  
  sort
  
  _source
  
  fields array[object]
  
  An array of wildcard (*) field patterns. The request returns values for field names matching these patterns in the hits.fields property of the response.
  
  suggest object
  
  terminate_after number
  
  The maximum number of documents to collect for each shard. If a query reaches this limit, Elasticsearch terminates the query early. Elasticsearch collects documents before sorting.
  
  IMPORTANT: Use with caution. Elasticsearch applies this property to each shard handling the request. When possible, let Elasticsearch perform early termination automatically. Avoid specifying this property for requests that target data streams with backing indices across multiple data tiers.
  
  If set to 0 (default), the query does not terminate early.
  
  timeout string
  
  The period of time to wait for a response from each shard. If no response is received before the timeout expires, the request fails and returns an error. Defaults to no timeout.
  
  track_scores boolean
  
  If true, calculate and return document scores, even if the scores are not used for sorting.
  
  version boolean
  
  If true, the request returns the document version as part of a hit.
  
  seq_no_primary_term boolean
  
  If true, the request returns sequence number and primary term of the last modification of each hit.
  
  stored_fields string | array[string]
  
  pit object
  
  runtime_mappings object
  
  stats array[string]
  
  The stats groups to associate with the search. Each group maintains a statistics aggregation for its associated searches. You can retrieve these stats using the indices stats API.
  
  id string
  
  search object
  
  Hide search attributes Show search attributes object
  
  request object Required
  
  Hide request attributes Show request attributes object
  
  body object
  
  Hide body attribute Show body attribute object
  
  query object Required
  
  An Elasticsearch Query DSL (Domain Specific Language) object that defines a query.
  
  indices array[string]
  
  indices_options object
  
  Controls how to deal with unavailable concrete indices (closed or missing), how wildcard expressions are expanded to actual indices (all, closed or open indices) and how to deal with wildcard expressions that resolve to no indices.
  
  Hide indices_options attributes Show indices_options attributes object
  
  allow_no_indices boolean
  
  If false, the request returns an error if any wildcard expression, index alias, or _all value targets only missing or closed indices. This behavior applies even if the request targets other open indices. For example, a request targeting foo*,bar* returns an error if an index starts with foo but no index starts with bar.
  
  expand_wildcards string | array[string]
  
  ignore_unavailable boolean
  
  If true, missing or closed indices are not included in the response.
  
  ignore_throttled boolean
  
  If true, concrete, expanded or aliased indices are ignored when frozen.
  
  search_type string
  
  Values are query_then_fetch or dfs_query_then_fetch.
  
  template object
  
  Hide template attributes Show template attributes object
  
  explain boolean
  
  id string
  
  params object
  
  profile boolean
  
  source string
  
  An inline search template. Supports the same parameters as the search API's request body. Also supports Mustache variables. If no id is specified, this parameter is required.
  
  rest_total_hits_as_int boolean
  
  timeout string Required
  
  A duration. Units can be nanos, micros, ms (milliseconds), s (seconds), m (minutes), h (hours) and d (days). Also accepts "0" without a unit and "-1" to indicate an unspecified value.
  
  trigger object Required
  
  Hide trigger attribute Show trigger attribute object
  
  schedule object
  
  Hide schedule attributes Show schedule attributes object
  
  timezone string
  
  cron string
  
  daily object
  
  Hide daily attribute Show daily attribute object
  
  at array[string | object] Required
  
  A time of day, expressed either as hh:mm, noon, midnight, or an hour/minutes structure.
  
  hourly object
  
  Hide hourly attribute Show hourly attribute object
  
  minute array[number] Required
  
  interval string
  
  A duration. Units can be nanos, micros, ms (milliseconds), s (seconds), m (minutes), h (hours) and d (days). Also accepts "0" without a unit and "-1" to indicate an unspecified value.
  
  monthly object | array[object]
  
  One of:
  TimeOfMonth object array-2 array[object]
  
  weekly object | array[object]
  
  One of:
  TimeOfWeek object array-2 array[object]
  
  yearly object | array[object]
  
  One of:
  TimeOfYear object array-2 array[object]
  
  Hide attributes Show attributes
  
  at array[string] Required
  
  int array[string] Required
  
  Values are january, february, march, april, may, june, july, august, september, october, november, or december.
  
  on array[number] Required
- _primary_term number
- _seq_no number
- _version number

GET /_watcher/watch/{id}

GET _watcher/watch/my_watch

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

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

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

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

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

Response examples (200)

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

Get a watch Generally available; Added in 5.6.0

Required authorization

Path parameters

Responses

last_checked string | number

last_met_condition string | number

timestamp string | number Required

lang string

source string | object

last_checked string | number

last_met_condition string | number

timestamp string | number Required

source string | object

monthly object | array[object]

weekly object | array[object]

yearly object | array[object]