Create or update an alias

POST also PUT /{index}/_aliases/{name}
POST also PUT /{index}/_alias/{name}

Adds a data stream or index to an alias.

Authentication

Api key

Authorization: <value>

Elasticsearch APIs support key-based authentication. You must create an API key and use the encoded value in the request header. For example:

		curl -X GET "${ES_URL}/_cat/indices?v=true" \
  -H "Authorization: ApiKey ${API_KEY}"

To get API keys, use the /_security/api_key APIs.

Basic

Authorization: Basic <credentials>

Bearer

Authorization: Bearer <token>

Elasticsearch APIs support the use of bearer tokens in the Authorization HTTP header to authenticate with the API. For examples, refer to Token-based authentication services

Path parameters

Query parameters

Request body

Response

application/json

Examples

Request Console 1 / 8 languages

The filter option uses Query DSL to limit the documents an alias can access.

Console Kibana Dev Tools

POST /my-index-2099.05.06-000001/_alias/my-alias
{
  "filter": {
    "bool": {
      "filter": [
        {
          "range": {
            "@timestamp": {
              "gte": "now-1d/d",
              "lt": "now/d"
            }
          }
        },
        {
          "term": {
            "user.id": "kimchy"
          }
        }
      ]
    }
  }
}

JavaScript Elasticsearch JavaScript Client

const response = await client.indices.putAlias({
  index: "my-index-2099.05.06-000001",
  name: "my-alias",
  filter: {
    bool: {
      filter: [
        {
          range: {
            "@timestamp": {
              gte: "now-1d/d",
              lt: "now/d",
            },
          },
        },
        {
          term: {
            "user.id": "kimchy",
          },
        },
      ],
    },
  },
});

Python Elasticsearch Python Client

resp = client.indices.put_alias(
    index="my-index-2099.05.06-000001",
    name="my-alias",
    filter={
        "bool": {
            "filter": [
                {
                    "range": {
                        "@timestamp": {
                            "gte": "now-1d/d",
                            "lt": "now/d"
                        }
                    }
                },
                {
                    "term": {
                        "user.id": "kimchy"
                    }
                }
            ]
        }
    },
)

curl Shell

curl -X POST "$ELASTICSEARCH_URL/my-index-2099.05.06-000001/_alias/my-alias" \
  -H "Authorization: ApiKey $ELASTIC_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "filter": {
      "bool": {
        "filter": [
          {
            "range": {
              "@timestamp": {
                "gte": "now-1d/d",
                "lt": "now/d"
              }
            }
          },
          {
            "term": {
              "user.id": "kimchy"
            }
          }
        ]
      }
    }
  }'

Java Elasticsearch Java Client

client.indices().putAlias(p -> p
    .filter(f -> f
        .bool(b -> b
            .filter(List.of(Query.of(q -> q
                    .range(r -> r
                        .untyped(u -> u
                            .field("@timestamp")
                            .gte(JsonData.fromJson("\"now-1d/d\""))
                            .lt(JsonData.fromJson("\"now/d\""))
                        )
                    )
                ),Query.of(qu -> qu
                    .term(t -> t
                        .field("user.id")
                        .value(FieldValue.of("kimchy"))
                    )
                )))
        )
    )
    .index("my-index-2099.05.06-000001")
    .name("my-alias")
);

C# Elasticsearch .NET Client

var response = await client.Indices
    .PutAliasAsync(indices: new[] { "my-index-2099.05.06-000001" }, name: "my-alias", d1 => d1
        .Filter(d2 => d2
            .Bool(d3 => d3
                .Filter(d4 => d4
                    .Range(new UntypedRangeQuery()
                    {
                        Field = global::Elastic.Clients.Elasticsearch.Infer.Field<MyDocument>(x => x.Timestamp),
                        Gte = "now-1d/d",
                        Lt = "now/d"
                    }), d4 => d4
                    .Term(d5 => d5
                        .Field(x => x.User.Id)
                        .Value("kimchy")
                    )
                )
            )
        )
    );

PHP Elasticsearch PHP Client

$resp = $client->indices()->putAlias([
    "index" => "my-index-2099.05.06-000001",
    "name" => "my-alias",
    "body" => [
        "filter" => [
            "bool" => [
                "filter" => array(
                    [
                        "range" => [
                            "@timestamp" => [
                                "gte" => "now-1d/d",
                                "lt" => "now/d",
                            ],
                        ],
                    ],
                    [
                        "term" => [
                            "user.id" => "kimchy",
                        ],
                    ],
                ),
            ],
        ],
    ],
]);

Ruby Elasticsearch Ruby Client

response = client.indices.put_alias(
  index: "my-index-2099.05.06-000001",
  name: "my-alias",
  body: {
    "filter": {
      "bool": {
        "filter": [
          {
            "range": {
              "@timestamp": {
                "gte": "now-1d/d",
                "lt": "now/d"
              }
            }
          },
          {
            "term": {
              "user.id": "kimchy"
            }
          }
        ]
      }
    }
  }
)

Response

No example

Request Console 1 / 2 languages

You can use is_write_index to specify a write index or data stream for an alias. Elasticsearch routes any write requests for the alias to this index or data stream.

Console Kibana Dev Tools

POST /INDEX/_alias/NAME
{
  "is_write_index": true
}

Generated from the API spec

curl Shell

curl -X POST "$ELASTICSEARCH_URL/${INDEX}/_alias/${NAME}" \
  -H "Authorization: ApiKey $ELASTIC_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "is_write_index": true
  }'

Generated from the API spec

Response

No example

Request Console 1 / 2 languages

Use the routing option to route requests for an alias to a specific shard.

Console Kibana Dev Tools

POST /INDEX/_alias/NAME
{
  "routing": "1"
}

Generated from the API spec

curl Shell

curl -X POST "$ELASTICSEARCH_URL/${INDEX}/_alias/${NAME}" \
  -H "Authorization: ApiKey $ELASTIC_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "routing": "1"
  }'

Generated from the API spec

Response

No example

Authentication

Path parameters

Query parameters

Request body { }

Response

Request body