Path parameters

• task_id string Required

  The task identifier.

Query parameters

• timeout string

  The period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error.

  Default value is 30s.

• wait_for_completion boolean

  If true, the request blocks until the task has completed.

  Default value is false.

Responses

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

  • completed boolean Required
  • task object Required
    Hide task attributes Show task attributes object

    • action string Required
    • cancelled boolean
    • cancellable boolean Required
    • description string

      Human readable text that identifies the particular request that the task is performing. For example, it might identify the search request being performed by a search task. Other kinds of tasks have different descriptions, like _reindex which has the source and the destination, or _bulk which just has the number of requests and the destination indices. Many requests will have only an empty description because more detailed information about the request is not easily available or particularly helpful in identifying the request.

    • headers object Required
      Hide headers attribute Show headers attribute object

      • * string Additional properties
    • id number Required
    • node string Required
    • running_time 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
    • running_time_in_nanos number Required

      Time unit for nanoseconds

    • start_time_in_millis number Required

      Time unit for milliseconds

    • status object

      The internal status of the task, which varies from task to task. The format also varies. While the goal is to keep the status for a particular task consistent from version to version, this is not always possible because sometimes the implementation changes. Fields might be removed from the status for a particular request so any parsing you do of the status might break in minor releases.

    • type string Required
    • parent_task_id string
    • original_task_id string

      The task ID of the original task. Only present when the task is continuing the work of an earlier task that was running on a node which has since shut down (i.e. a relocatable task). For tasks that have not been relocated this is always equal to the task's own ID and is omitted from the response.

    • original_start_time_in_millis number

      The time at which the original task started, in milliseconds since the Unix epoch. Only present together with original_task_id.

    • original_start_time string

      The time at which the original task started, as an ISO 8601 formatted string. Only present together with original_task_id and when the request includes the ?human=true query parameter.

  • response object
  • error 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.

    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.

      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.

      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.