IMPORTANT: No additional bug fixes or documentation updates will be released for this version. For the latest information, see the current release documentation.
« Data stream APIs Delete data stream API »
Elastic Docs ›Elasticsearch Guide [7.10] ›REST APIs ›Data stream APIs

Create data stream API

edit

Create data stream API

edit

Creates a new data stream.

Data streams require a matching index template. See Set up a data stream.

PUT /_data_stream/my-data-stream

Request

edit

PUT /_data_stream/<data-stream>

Prerequisites

edit
  • If the Elasticsearch security features are enabled, you must have the create_index or manage index privilege for the data stream.

Path parameters

edit
<data-stream>

(Required, string) Name of the data stream to create.

We recommend using the Elastic data stream naming scheme. Data stream names must meet the following criteria:

  • Lowercase only
  • Cannot include \, /, *, ?, ", <, >, |, ` ` (space character), ,, #, :
  • Cannot start with -, _, +, .
  • Cannot be . or ..
  • Cannot be longer than 255 bytes (note it is bytes, so multi-byte characters will count towards the 255 limit faster)
« Data stream APIs Delete data stream API »