Path parameters

• task_id string Required

  The ID of the reindex task to cancel.

Query parameters

• wait_for_completion boolean

  If true (the default), the request blocks until the cancellation is complete and returns the final task state. If false, the request returns immediately with acknowledged: true.

Responses

• 200 application/json
  Hide response attributes Show response attributes object

  • acknowledged boolean

    Present and true when wait_for_completion=false.

  • completed boolean

    Whether the reindex task has completed. Present when wait_for_completion=true.

  • id string

    The ID of the reindex task. The value is the ID assigned when the task was first created and remains stable across node-shutdown relocations. Present when wait_for_completion=true.

  • description string

    A sanitized description of the reindex operation.

  • start_time_in_millis number

    Time unit for milliseconds

  • start_time string

    The time at which the reindex task started, as an ISO 8601 formatted string.

  • running_time string

    The elapsed running time of the reindex task, in a human-readable format. Only present when the request includes the ?human=true query parameter.

    External documentation
  • running_time_in_nanos number

    Time unit for nanoseconds

  • cancelled boolean

    Whether the reindex task has been cancelled.

  • status object

    The status of the reindex operation at the time of cancellation.

    Hide status attributes Show status attributes object

    • slice_id number

      The slice ID

    • batches number Required

      The number of scroll responses pulled back by the reindex.

    • created number

      The number of documents that were successfully created.

    • deleted number Required

      The number of documents that were successfully deleted.

    • noops number Required

      The number of documents that were ignored because the script used for the reindex returned a noop value for ctx.op.

    • requests_per_second number Required

      The number of requests per second effectively executed during the reindex.

    • retries object Required

      The number of retries attempted by reindex. bulk is the number of bulk actions retried and search is the number of search actions retried.

      Hide retries attributes Show retries attributes object

      • bulk number Required

        The number of bulk actions retried.

      • search number Required

        The number of search actions retried.

    • throttled 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.

      External documentation
    • throttled_millis number

      Time unit for milliseconds

    • throttled_until 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.

      External documentation
    • throttled_until_millis number

      Time unit for milliseconds

    • total number Required

      The number of documents that were successfully processed.

    • updated number

      The number of documents that were successfully updated, for example, a document with same ID already existed prior to reindex updating it.

    • version_conflicts number Required

      The number of version conflicts that reindex hits.

    • cancelled string

      The reason for cancellation if the slice was canceled

  • error object

    The error that caused the reindex task to fail, if any.

    Hide error attributes Show error attributes object

    • type string Required

      The type of error

    • reason string | null

      A human-readable explanation of the error, in English.

      One of:

      string-1 string string-2 string | null
    • stack_trace string

      The server stack trace. Present only if the error_trace=true parameter was sent with the request.

    • caused_by object

      Cause and details about a request failure. This class defines the properties common to all error types. Additional details are also provided, that depend on the error type.

    • root_cause array[object]

      Cause and details about a request failure. This class defines the properties common to all error types. Additional details are also provided, that depend on the error type.

      Cause and details about a request failure. This class defines the properties common to all error types. Additional details are also provided, that depend on the error type.

    • suppressed array[object]

      Cause and details about a request failure. This class defines the properties common to all error types. Additional details are also provided, that depend on the error type.

      Cause and details about a request failure. This class defines the properties common to all error types. Additional details are also provided, that depend on the error type.

  • response object

    The final result of the reindex operation, if it completed before being cancelled.

    Hide response attributes Show response attributes object

    • batches number

      The number of scroll responses pulled back by the reindex.

    • created number

      The number of documents that were successfully created.

    • deleted number

      The number of documents that were successfully deleted.

    • failures array[object]

      Any failures encountered during the reindex. If non-empty, the reindex ended because of these failures.

      Hide failures attributes Show failures attributes object

      • cause object Required

        Cause and details about a request failure. This class defines the properties common to all error types. Additional details are also provided, that depend on the error type.

      • id string Required
      • index string Required
      • status number Required
    • noops number

      The number of documents that were ignored because the script returned a noop value for ctx.op.

    • requests_per_second number

      The number of requests per second effectively executed during the reindex.

    • retries object

      The number of retries attempted by reindex.

      Hide retries attributes Show retries attributes object

      • bulk number Required

        The number of bulk actions retried.

      • search number Required

        The number of search actions retried.

    • throttled_millis number

      Time unit for milliseconds

    • throttled_until_millis number

      Time unit for milliseconds

    • timed_out boolean

      Whether any of the requests executed during the reindex timed out.

    • took number

      Time unit for milliseconds

    • total number

      The number of documents that were successfully processed.

    • updated number

      The number of documents that were successfully updated.

    • version_conflicts number

      The number of version conflicts that occurred.