Create or update a search application

PUT /_application/search_application/{name}

Auth

Required privileges

Index privileges manage
Cluster privileges manage_search_application

Path parameters

name string required: The name of the search application to be created or updated.

Query parameters

create boolean · default: false: If true, this request cannot replace or update existing Search Applications.

Request body

indices string[] required: Indices that are part of the Search Application.
analytics_collection_name string: Analytics collection associated to the Search Application.
template object: Search template to use on search operations.

Response

application/json

result enum required: Values: created updated deleted not_found noop

Examples

Request Console 1 / 7 languages

Run PUT _application/search_application/my-app to create or update a search application called my-app. When the dictionary parameter is specified, the search application search API will perform the following parameter validation: it accepts only the query_string and default_field parameters; it verifies that query_string and default_field are both strings; it accepts default_field only if it takes the values title or description. If the parameters are not valid, the search application search API will return an error.

Console Kibana Dev Tools

PUT _application/search_application/my-app
{
  "indices": [ "index1", "index2" ],
  "template": {
    "script": {
      "source": {
        "query": {
          "query_string": {
            "query": "{{query_string}}",
            "default_field": "{{default_field}}"
          }
        }
      },
      "params": {
        "query_string": "*",
        "default_field": "*"
      }
    },
    "dictionary": {
      "properties": {
        "query_string": {
          "type": "string"
        },
        "default_field": {
          "type": "string",
          "enum": [
            "title",
            "description"
          ]
        },
        "additionalProperties": false
      },
      "required": [
        "query_string"
      ]
    }
  }
}

JavaScript Elasticsearch JavaScript Client

const response = await client.searchApplication.put({
  name: "my-app",
  search_application: {
    indices: ["index1", "index2"],
    template: {
      script: {
        source: {
          query: {
            query_string: {
              query: "{{query_string}}",
              default_field: "{{default_field}}",
            },
          },
        },
        params: {
          query_string: "*",
          default_field: "*",
        },
      },
      dictionary: {
        properties: {
          query_string: {
            type: "string",
          },
          default_field: {
            type: "string",
            enum: ["title", "description"],
          },
          additionalProperties: false,
        },
        required: ["query_string"],
      },
    },
  },
});

Python Elasticsearch Python Client

resp = client.search_application.put(
    name="my-app",
    search_application={
        "indices": [
            "index1",
            "index2"
        ],
        "template": {
            "script": {
                "source": {
                    "query": {
                        "query_string": {
                            "query": "{{query_string}}",
                            "default_field": "{{default_field}}"
                        }
                    }
                },
                "params": {
                    "query_string": "*",
                    "default_field": "*"
                }
            },
            "dictionary": {
                "properties": {
                    "query_string": {
                        "type": "string"
                    },
                    "default_field": {
                        "type": "string",
                        "enum": [
                            "title",
                            "description"
                        ]
                    },
                    "additionalProperties": False
                },
                "required": [
                    "query_string"
                ]
            }
        }
    },
)

curl Shell

curl -X PUT "$ELASTICSEARCH_URL/_application/search_application/my-app" \
  -H "Authorization: ApiKey $ELASTIC_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "indices": [
      "index1",
      "index2"
    ],
    "template": {
      "script": {
        "source": {
          "query": {
            "query_string": {
              "query": "{{query_string}}",
              "default_field": "{{default_field}}"
            }
          }
        },
        "params": {
          "query_string": "*",
          "default_field": "*"
        }
      },
      "dictionary": {
        "properties": {
          "query_string": {
            "type": "string"
          },
          "default_field": {
            "type": "string",
            "enum": [
              "title",
              "description"
            ]
          },
          "additionalProperties": false
        },
        "required": [
          "query_string"
        ]
      }
    }
  }'

Java Elasticsearch Java Client

client.searchApplication().put(p -> p
    .name("my-app")
    .searchApplication(s -> s
        .indices(List.of("index1","index2"))
        .template(t -> t
            .script(sc -> sc
                .source(so -> so
                    .scriptTemplate(scr -> scr
                        .query(q -> q
                            .queryString(qu -> qu
                                .defaultField("{{default_field}}")
                                .query("""
                                    {{query_string}}
                                    """)
                            )
                        )
                    )
                )
                .params(Map.of("default_field", JsonData.fromJson("\"*\""),"query_string", JsonData.fromJson("\"*\"")))
            )
        )
    )
);

PHP Elasticsearch PHP Client

$resp = $client->searchApplication()->put([
    "name" => "my-app",
    "body" => [
        "indices" => array(
            "index1",
            "index2",
        ),
        "template" => [
            "script" => [
                "source" => [
                    "query" => [
                        "query_string" => [
                            "query" => "{{query_string}}",
                            "default_field" => "{{default_field}}",
                        ],
                    ],
                ],
                "params" => [
                    "query_string" => "*",
                    "default_field" => "*",
                ],
            ],
            "dictionary" => [
                "properties" => [
                    "query_string" => [
                        "type" => "string",
                    ],
                    "default_field" => [
                        "type" => "string",
                        "enum" => array(
                            "title",
                            "description",
                        ),
                    ],
                    "additionalProperties" => false,
                ],
                "required" => array(
                    "query_string",
                ),
            ],
        ],
    ],
]);

Ruby Elasticsearch Ruby Client

response = client.search_application.put(
  name: "my-app",
  body: {
    "indices": [
      "index1",
      "index2"
    ],
    "template": {
      "script": {
        "source": {
          "query": {
            "query_string": {
              "query": "{{query_string}}",
              "default_field": "{{default_field}}"
            }
          }
        },
        "params": {
          "query_string": "*",
          "default_field": "*"
        }
      },
      "dictionary": {
        "properties": {
          "query_string": {
            "type": "string"
          },
          "default_field": {
            "type": "string",
            "enum": [
              "title",
              "description"
            ]
          },
          "additionalProperties": false
        },
        "required": [
          "query_string"
        ]
      }
    }
  }
)

Response

{
  "result": "created"
}

Generated from the API spec

Required privileges

Path parameters

Query parameters

Request body { }

Response

Request body