rest-api-spec.api.delete_by_query_rethrottle.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

OpenSearch subproject :rest-api-spec

The newest version!

{
  "delete_by_query_rethrottle":{
    "documentation":{
      "url":"https://opensearch.org/docs/latest/api-reference/document-apis/delete-by-query/",
      "description":"Changes the number of requests per second for a particular Delete By Query operation."
    },
    "stability":"stable",
    "url":{
      "paths":[
        {
          "path":"/_delete_by_query/{task_id}/_rethrottle",
          "methods":[
            "POST"
          ],
          "parts":{
            "task_id":{
              "type":"string",
              "description":"The task id to rethrottle"
            }
          }
        }
      ]
    },
    "params":{
      "requests_per_second":{
        "type":"number",
        "required":true,
        "description":"The throttle to set on this request in floating sub-requests per second. -1 means set no throttle."
      }
    }
  }
}