Analyze the index disk usage

POST /{index}/_disk_usage

Analyze the disk usage of each field of an index or data stream. This API might not support indices created in previous Elasticsearch versions. The result of a small index can be inaccurate as some parts of an index might not be analyzed by the API.

Note

The total size of fields of the analyzed shards of the index in the response is usually smaller than the index store_size value because some small metadata files are ignored and some parts of data files might not be scanned by the API. Since stored fields are stored together in a compressed format, the sizes of stored fields are also estimates and can be inaccurate. The stored size of the _id field is likely underestimated while the _source field is overestimated.

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

Request Console 1 / 8 languages

Console Kibana Dev Tools

POST /my-index-000001/_disk_usage?run_expensive_tasks=true

JavaScript Elasticsearch JavaScript Client

const response = await client.indices.diskUsage({
  index: "my-index-000001",
  run_expensive_tasks: "true",
});

Python Elasticsearch Python Client

resp = client.indices.disk_usage(
    index="my-index-000001",
    run_expensive_tasks=True,
)

curl Shell

curl -X POST "$ELASTICSEARCH_URL/my-index-000001/_disk_usage?run_expensive_tasks=true" \
  -H "Authorization: ApiKey $ELASTIC_API_KEY"

Java Elasticsearch Java Client

client.indices().diskUsage(d -> d
    .index("my-index-000001")
    .runExpensiveTasks(true)
);

C# Elasticsearch .NET Client

var response = await client.Indices
    .DiskUsageAsync(indices: new[] { "my-index-000001" }, d1 => d1
        .RunExpensiveTasks(true)
    );

PHP Elasticsearch PHP Client

$resp = $client->indices()->diskUsage([
    "index" => "my-index-000001",
    "run_expensive_tasks" => "true",
]);

Ruby Elasticsearch Ruby Client

response = client.indices.disk_usage(
  index: "my-index-000001",
  run_expensive_tasks: "true"
)

Response

No example

Analyze the index disk usage

Authentication

Path parameters

Query parameters

Response