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

Cluster privileges: monitor

Query Parameters

Response

application/json

Examples

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

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();

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

[
  {
    "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"
  }
]

Required authorization

Query Parameters { actions , detailed , nodes , parent_task_id , h , s , timeout , wait_for_completion , }

Response

Query Parameters