Index APIs

Index APIs

New API reference

For the most up-to-date API details, refer to Index APIs.

Index APIs are used to manage individual indices, index settings, aliases, mappings, and index templates.

Index management:

• Create index
• Delete index
• Get index
• Exists
• Close index
• Open index
• Shrink index
• Split index
• Clone index
• Rollover
• Unfreeze index
• Resolve index
• Resolve cluster
• Downsample

Mapping management:

• Update mapping
• Get mapping
• Get field mapping
• Analyze index disk usage

Alias management:

• Aliases
• Create or update alias
• Get alias
• Alias exists
• Delete alias

Index settings:

• Update index settings
• Get index settings
• Analyze

Index templates:

Index templates automatically apply settings, mappings, and aliases to new indices. They are most often used to configure rolling indices for time series data to ensure that each new index has the same configuration as the previous one. The index template associated with a data stream configures its backing indices. For more information, see Index Templates.

• Create or update index template
• Get index template
• Delete index template
• Create or update component template
• Get component template
• Delete component template
• Simulate index
• Simulate template

Monitoring:

• Index stats
• Field usage stats
• Index segments
• Index recovery
• Index shard stores

Status management:

• Clear cache
• Refresh
• Flush
• Force merge

Dangling indices:

• List dangling indices
• Import dangling index
• Delete dangling index