Query parameters

• actionsstring | array[string]

  A comma-separated list or wildcard expression of actions used to limit the request. For example, you can use cluser:* to retrieve all cluster-related tasks.
• detailedboolean

  If true, the response includes detailed information about the running tasks. This information is useful to distinguish tasks from each other but is more costly to run.

• group_bystring

  A key that is used to group tasks in the response. The task lists can be grouped either by nodes or by parent tasks.

  Values are nodes, parents, or none.

• nodesstring | array[string]

  A comma-separated list of node IDs or names that is used to limit the returned information.

• parent_task_idstring

  A parent task identifier that is used to limit returned information. To return all tasks, omit this parameter or use a value of -1. If the parent task is not found, the API does not return a 404 response code.

• timeoutstring

  The period to wait for each node to respond. If a node does not respond before its timeout expires, the response does not include its information. However, timed out nodes are included in the node_failures property.

  Values are -1 or 0.

• wait_for_completionboolean

  If true, the request blocks until the operation is complete.

Responses

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

  • node_failuresarray[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 node_failures attributes Show node_failures attributes object

    • typestring Required

      The type of error

    • reasonstring | null

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

      One of:

      string-1stringstring-2string | null
    • stack_tracestring

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

    • caused_byobject

      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_causearray[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.

    • suppressedarray[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.

  • task_failuresarray[object]
    Hide task_failures attributes Show task_failures attributes object

    • task_idnumber Required
    • node_idstring Required
    • statusstring Required
    • reasonobject 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.

      Hide reason attributes Show reason attributes object

      • typestring Required

        The type of error

      • reasonstring | null

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

        One of:

        string-1stringstring-2string | null
      • stack_tracestring

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

      • caused_byobject

        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_causearray[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.

      • suppressedarray[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.

  • nodesobject

    Task information grouped by node, if group_by was set to node (the default).

    Hide nodes attribute Show nodes attribute object

    • *object Additional properties
      Hide * attributes Show * attributes object

      • namestring
      • transport_addressstring
      • hoststring
      • ipstring
      • rolesarray[string]
      • attributesobject
        Hide attributes attribute Show attributes attribute object

        • *string Additional properties
      • tasksobject Required
        Hide tasks attribute Show tasks attribute object

        • *object Additional properties
          Hide * attributes Show * attributes object

          • actionstring Required
          • cancelledboolean
          • cancellableboolean Required
          • descriptionstring

            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.

          • headersobject Required
            Hide headers attribute Show headers attribute object
          • idnumber Required
          • nodestring Required
          • running_timestring

            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.

          • running_time_in_nanosnumber

            Time unit for nanoseconds

          • start_time_in_millisnumber

            Time unit for milliseconds

          • statusobject

            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.

          • typestring Required
          • parent_task_idstring

  • tasksarray[object] | object

    One of:

    TaskInfosarray[object]TaskInfosobject

    Hide attributes Show attributes object

    • actionstring Required
    • cancelledboolean
    • cancellableboolean Required
    • descriptionstring

      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.

    • headersobject Required
      Hide headers attribute Show headers attribute object
    • idnumber Required
    • nodestring Required
    • running_timestring

      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.

    • running_time_in_nanosnumber

      Time unit for nanoseconds

    • start_time_in_millisnumber

      Time unit for milliseconds

    • statusobject

      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.

    • typestring Required
    • parent_task_idstring