Get the pending cluster tasks

GET /_cluster/pending_tasks

Get information about cluster-level changes (such as create index, update mapping, allocate or fail shard) that have not yet taken effect.

Note

This API returns a list of any pending updates to the cluster state. These are distinct from the tasks reported by the task management API which include periodic tasks and tasks initiated by the user, such as node stats, search queries, or create index requests. However, if a user-initiated task such as a create index command causes a cluster state update, the activity of this task might be reported by both task api and pending cluster tasks 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

Response

application/json

Examples

Request Console 1 / 8 languages

Console Kibana Dev Tools

GET /_cluster/pending_tasks

JavaScript Elasticsearch JavaScript Client

const response = await client.cluster.pendingTasks();

Python Elasticsearch Python Client

resp = client.cluster.pending_tasks()

curl Shell

curl -X GET "$ELASTICSEARCH_URL/_cluster/pending_tasks" \
  -H "Authorization: ApiKey $ELASTIC_API_KEY"

Java Elasticsearch Java Client

client.cluster().pendingTasks(p -> p);

C# Elasticsearch .NET Client

var response = await client.Cluster.PendingTasksAsync();

PHP Elasticsearch PHP Client

$resp = $client->cluster()->pendingTasks();

Ruby Elasticsearch Ruby Client

response = client.cluster.pending_tasks

Response

No example