Get task information

GET /_cat/tasks

Get information about tasks currently running in the cluster. IMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications. For application consumption, use the task management API.

Required authorization

Authentication

Api key

Authorization: <value>

Elasticsearch APIs support key-based authentication. You must create an API key and use the encoded value in the request header. For example:

		curl -X GET "${ES_URL}/_cat/indices?v=true" \
  -H "Authorization: ApiKey ${API_KEY}"

To get API keys, use the /_security/api_key APIs.

Basic

Authorization: Basic <credentials>

Bearer

Authorization: Bearer <token>

Elasticsearch APIs support the use of bearer tokens in the Authorization HTTP header to authenticate with the API. For examples, refer to Token-based authentication services

Query parameters

actions string[]

The task action names, which are used to limit the response.

detailed boolean · default: false

If true, the response includes detailed information about shard recoveries.

nodes string[]

Unique node identifiers, which are used to limit the response.

parent_task_id string

The parent task identifier, which is used to limit the response.

h union oneOf

A comma-separated list of columns names to display. It supports simple wildcards.

Supported values include:

id: The ID of the task with the node.
action (or ac): The task action.
task_id (or ti): The unique task ID.
parent_task_id (or pti): The parent task ID.
type (or ty): The task type.
start_time (or start): The start time in milliseconds.
timestamp (or ts, hms, hhmmss): The start time in HH:MM:SS.
running_time_ns (or time): The running time in nanoseconds.
running_time (or time): The running time.
node_id (or ni): The unique node ID.
ip (or i): The IP address.
port (or po): The bound transport port.
node (or n): The node name.
version (or v): The Elasticsearch version.
x_opaque_id (or x): The X-Opaque-ID header.

Values: id action ac task_id ti parent_task_id pti type ty start_time start timestamp ts hms hhmmss running_time_ns time running_time node_id ni ip i port po node n version v x_opaque_id x

s union oneOf

List of columns that determine how the table should be sorted. Sorting defaults to ascending and can be changed by setting :asc or :desc as a suffix to the column name.

One of: string[] or string

timeout string · default: 30s

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

wait_for_completion boolean · default: false

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

format string · default: text

Specifies the format to return the columnar data in, can be set to text, json, cbor, yaml, or smile.

help boolean · default: false

When set to true will output available columns. This option can't be combined with any other query string option.

v boolean · default: false

When set to true will enable verbose output.

bytes enum

Sets the units for columns that contain a byte-size value. Note that byte-size value units work in terms of powers of 1024. For instance 1kb means 1024 bytes, not 1000 bytes. If omitted, byte-size values are rendered with a suffix such as kb, mb, or gb, chosen such that the numeric value of the column is as small as possible whilst still being at least 1.0. If given, byte-size values are rendered as an integer with no suffix, representing the value of the column in the chosen unit. Values that are not an exact multiple of the chosen unit are rounded down.

Values: b kb mb gb tb pb

time enum

Sets the units for columns that contain a time duration. If omitted, time duration values are rendered with a suffix such as ms, s, m or h, chosen such that the numeric value of the column is as small as possible whilst still being at least 1.0. If given, time duration values are rendered as an integer with no suffix. Values that are not an exact multiple of the chosen unit are rounded down.

Values: nanos micros ms s m h d

Response

application/json

Examples

Request Console 1 / 7 languages

Console Kibana Dev Tools

GET _cat/tasks?v=true&format=json

JavaScript Elasticsearch JavaScript Client

const response = await client.cat.tasks({
  v: "true",
  format: "json",
});

Python Elasticsearch Python Client

resp = client.cat.tasks(
    v=True,
    format="json",
)

curl Shell

curl -X GET "$ELASTICSEARCH_URL/_cat/tasks?v=true&format=json" \
  -H "Authorization: ApiKey $ELASTIC_API_KEY"

Java Elasticsearch Java Client

client.cat().tasks(t -> t);

PHP Elasticsearch PHP Client

$resp = $client->cat()->tasks([
    "v" => "true",
    "format" => "json",
]);

Ruby Elasticsearch Ruby Client

response = client.cat.tasks(
  v: "true",
  format: "json"
)

Response

A successful response from GET _cat/tasks?v=true&format=json.

[
  {
    "action": "cluster:monitor/tasks/lists[n]",
    "task_id": "oTUltX4IQMOUUVeiohTt8A:124",
    "parent_task_id": "oTUltX4IQMOUUVeiohTt8A:123",
    "type": "direct",
    "start_time": "1458585884904",
    "timestamp": "01:48:24",
    "running_time": "44.1micros",
    "ip": "127.0.0.1:9300",
    "node": "oTUltX4IQMOUUVeiohTt8A"
  },
  {
    "action": "cluster:monitor/tasks/lists",
    "task_id": "oTUltX4IQMOUUVeiohTt8A:123",
    "parent_task_id": "-",
    "type": "transport",
    "start_time": "1458585884904",
    "timestamp": "01:48:24",
    "running_time": "186.2micros",
    "ip": "127.0.0.1:9300",
    "node": "oTUltX4IQMOUUVeiohTt8A"
  }
]