rest-api-spec.api.watcher.put_watch.json Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of rest-api-spec Show documentation

Elasticsearch subproject :rest-api-spec

There is a newer version: 8.17.0

{
  "watcher.put_watch":{
    "documentation":{
      "url":"https://www.elastic.co/guide/en/elasticsearch/reference/current/watcher-api-put-watch.html",
      "description":"Creates a new watch, or updates an existing one."
    },
    "stability":"stable",
    "visibility":"public",
    "headers":{
      "accept": [ "application/json"],
      "content_type": ["application/json"]
    },
    "url":{
      "paths":[
        {
          "path":"/_watcher/watch/{id}",
          "methods":[
            "PUT",
            "POST"
          ],
          "parts":{
            "id":{
              "type":"string",
              "description":"Watch ID"
            }
          }
        }
      ]
    },
    "params":{
      "active":{
        "type":"boolean",
        "description":"Specify whether the watch is in/active by default"
      },
      "version":{
        "type":"number",
        "description":"Explicit version number for concurrency control"
      },
      "if_seq_no":{
        "type":"number",
        "description":"only update the watch if the last operation that has changed the watch has the specified sequence number"
      },
      "if_primary_term":{
        "type":"number",
        "description":"only update the watch if the last operation that has changed the watch has the specified primary term"
      }
    },
    "body":{
      "description":"The watch",
      "required":false
    }
  }
}