Get a watch Added in 5.6.0

GET /_watcher/watch/{id}
Api key auth Basic auth Bearer auth

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
    • watch object
      Hide watch attributes Show watch attributes object
      • actions object Required
        Hide actions attribute Show actions attribute object
      • condition object Required
        Hide condition attributes Show condition attributes object
      • 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
        • 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
            • 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
            • 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
              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
      • 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
        • 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
              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
    • _primary_term number
    • _seq_no number
    • _version number
GET /_watcher/watch/{id} 
curl \
 --request GET 'http://api.example.com/_watcher/watch/{id}' \
 --header "Authorization: $API_KEY"
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"
        }
      }
    }
  }
}