Create or update an alias Generally available; Added in 1.3.0

POST /_aliases
Api key auth Basic auth Bearer auth

Adds a data stream or index to an alias.

Query parameters

  • master_timeout string

    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 are -1 or 0.

  • timeout string

    Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error.

    Values are -1 or 0.

application/json

Body Required

  • actions array[object]

    Actions to perform.

    Hide actions attributes Show actions attributes object
    • add object
      Hide add attributes Show add attributes object
      • alias string

      • aliases string | array[string]

        Aliases for the action. Index alias names support date math.

        One of:
        IndexAlias string array-2 array[string]
      • filter object

        An Elasticsearch Query DSL (Domain Specific Language) object that defines a query.

        External documentation
      • index string
      • indices string | array[string]
      • index_routing string
      • is_hidden boolean

        If true, the alias is hidden.

        Default value is false.

      • is_write_index boolean

        If true, sets the write index or data stream for the alias.

      • routing string
      • search_routing string
      • must_exist boolean

        If true, the alias must exist to perform the action.

        Default value is false.

    • remove object
      Hide remove attributes Show remove attributes object
      • alias string

      • aliases string | array[string]

        Aliases for the action. Index alias names support date math.

        One of:
        IndexAlias string array-2 array[string]
      • index string
      • indices string | array[string]
      • must_exist boolean

        If true, the alias must exist to perform the action.

        Default value is false.

    • remove_index object
      Hide remove_index attributes Show remove_index attributes object
      • index string
      • indices string | array[string]
      • must_exist boolean

        If true, the alias must exist to perform the action.

        Default value is false.

Responses

  • 200 application/json
    Hide response attribute Show response attribute object
    • acknowledged boolean Required

      For a successful response, this value is always true. On failure, an exception is returned instead.
POST /_aliases 
POST _aliases { "actions": [ { "add": { "index": "logs-nginx.access-prod", "alias": "logs" } } ] }
resp = client.indices.update_aliases( actions=[ { "add": { "index": "logs-nginx.access-prod", "alias": "logs" } } ], )
const response = await client.indices.updateAliases({ actions: [ { add: { index: "logs-nginx.access-prod", alias: "logs", }, }, ], });
response = client.indices.update_aliases( body: { "actions": [ { "add": { "index": "logs-nginx.access-prod", "alias": "logs" } } ] } )
$resp = $client->indices()->updateAliases([ "body" => [ "actions" => array( [ "add" => [ "index" => "logs-nginx.access-prod", "alias" => "logs", ], ], ), ], ]);
curl -X POST -H "Authorization: ApiKey $ELASTIC_API_KEY" -H "Content-Type: application/json" -d '{"actions":[{"add":{"index":"logs-nginx.access-prod","alias":"logs"}}]}' "$ELASTICSEARCH_URL/_aliases"
client.indices().updateAliases(u -> u .actions(a -> a .add(ad -> ad .alias("logs") .index("logs-nginx.access-prod") ) ) );
Request example
An example body for a `POST _aliases` request. 
{ "actions": [ { "add": { "index": "logs-nginx.access-prod", "alias": "logs" } } ] }