Files
elasticsearch-js/docs/reference/api/IndicesCreateRequest.md
2025-05-27 15:30:21 -05:00

2.2 KiB

Interface IndicesCreateRequest

Name Type Description
aliases Record<Name, IndicesAlias> Aliases for the index.
body string ({ [key: string]: any; } & { index?: never; master_timeout?: never; timeout?: never; wait_for_active_shards?: never; aliases?: never; mappings?: never; settings?: never; })
index IndexName Name of the index you wish to create. Index names must meet the following criteria: * Lowercase only * Cannot include \, /, *, ?, ", <, >, `
mappings MappingTypeMapping Mapping for fields in the index. If specified, this mapping can include: - Field names - Field data types - Mapping parameters
master_timeout Duration Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error.
querystring { [key: string]: any; } & { index?: never; master_timeout?: never; timeout?: never; wait_for_active_shards?: never; aliases?: never; mappings?: never; settings?: never; } All values in querystring will be added to the request querystring.
settings IndicesIndexSettings Configuration options for the index.
timeout Duration Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error.
wait_for_active_shards WaitForActiveShards The number of shard copies that must be active before proceeding with the operation. Set to all or any positive integer up to the total number of shards in the index ( number_of_replicas+1).