Create a data stream

PUT /_data_stream/{name}

Auth

You must have a matching index template with data stream enabled.

Required privileges

Index privileges create_index

Path parameters

name string required: Name of the data stream, which must meet the following criteria: Lowercase only; Cannot include \, /, *, ?, ", <, >, |, ,, #, :, or a space character; Cannot start with -, _, +, or .ds-; Cannot be . or ..; Cannot be longer than 255 bytes. Multi-byte characters count towards this limit faster.

Query parameters

master_timeout union oneOf · default: 30s: 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.; Values: -1 0
timeout union oneOf · default: 30s: Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error.; Values: -1 0

Response

application/json

acknowledged boolean required: For a successful response, this value is always true. On failure, an exception is returned instead.

View as Markdown

Examples

Request Console 1 / 8 languages

Console Kibana Dev Tools

PUT _data_stream/logs-foo-bar

JavaScript Elasticsearch JavaScript Client

const response = await client.indices.createDataStream({
  name: "logs-foo-bar",
});

Python Elasticsearch Python Client

resp = client.indices.create_data_stream(
    name="logs-foo-bar",
)

curl Shell

curl -X PUT "$ELASTICSEARCH_URL/_data_stream/logs-foo-bar" \
  -H "Authorization: ApiKey $ELASTIC_API_KEY"

Java Elasticsearch Java Client

client.indices().createDataStream(c -> c
    .name("logs-foo-bar")
);

C# Elasticsearch .NET Client

var response = await client.Indices.CreateDataStreamAsync(name: "logs-foo-bar");

PHP Elasticsearch PHP Client

$resp = $client->indices()->createDataStream([
    "name" => "logs-foo-bar",
]);

Ruby Elasticsearch Ruby Client

response = client.indices.create_data_stream(
  name: "logs-foo-bar"
)

Response

{
  "acknowledged": false
}

Generated from the API spec