Index APIs

Introduced 1.0

The index API operations let you interact with indexes in your cluster. Using these operations, you can create, delete, close, and complete other index-related operations.

Index API operations

The following index API operations are available.

Index management

• Create index
• Delete index
• Get index
• Index exists
• Open index
• Close index
• Resolve index

Index operations

• Clear index cache
• Clone index
• Flush
• Force merge
• Recover
• Refresh
• Rollover
• Scale
• Segments
• Shrink index
• Split
• Stats

Index settings and mappings

• Get settings
• Update settings
• Put mapping

Index templates

• Create index template
• Delete index template
• Get index template
• Index template exists
• Simulate index template
• Component template

Legacy index templates

• Delete template (legacy)
• Get template (legacy)
• Post template (legacy)
• Put template (legacy)
• Template exists (legacy)

Index aliases

• Alias
• Update alias

Index blocks and allocation

• Blocks
• Shard allocation

Data streams

• Data stream stats

Dangling indexes

• Dangling index

If you use the Security plugin, make sure you have the appropriate permissions.