{
  "transform.stop_transform": {
    "documentation": {
      "url": "https://www.elastic.co/guide/en/elasticsearch/reference/8.19/stop-transform.html",
      "description": "Stop transforms"
    },
    "stability": "stable",
    "visibility": "public",
    "headers": {
      "accept": [
        "application/json"
      ]
    },
    "url": {
      "paths": [
        {
          "path": "/_transform/{transform_id}/_stop",
          "methods": [
            "POST"
          ],
          "parts": {
            "transform_id": {
              "type": "string",
              "description": "The id of the transform to stop"
            }
          }
        }
      ]
    },
    "params": {
      "force": {
        "type": "boolean",
        "default": false,
        "description": "Whether to force stop a failed transform or not. Default to false"
      },
      "wait_for_completion": {
        "type": "boolean",
        "default": false,
        "description": "Whether to wait for the transform to fully stop before returning or not. Default to false"
      },
      "timeout": {
        "type": "time",
        "default": "30s",
        "description": "Controls the time to wait until the transform has stopped. Default to 30 seconds"
      },
      "allow_no_match": {
        "type": "boolean",
        "default": true,
        "description": "Whether to ignore if a wildcard expression matches no transforms. (This includes `_all` string or when no transforms have been specified)"
      },
      "wait_for_checkpoint": {
        "type": "boolean",
        "default": false,
        "description": "Whether to wait for the transform to reach a checkpoint before stopping. Default to false"
      }
    }
  }
}
