Path parameters

• id string Required

  The identifier for the stored script or search template.

Query parameters

• master_timeout string

  The period to wait for the master node. If the master node is not available before the timeout expires, the request fails and returns an error. It can also be set to -1 to indicate that the request should never timeout.

  Values are -1 or 0.

  External documentation

Responses

• 200 application/json
  Hide response attributes Show response attributes object

  • _id string Required
  • found boolean Required
  • script object
    Hide script attributes Show script attributes object

    • lang string

      The language the script is written in. For search templates, use mustache.

      Any of:

      string-1 string string-2 string

      Values are painless, expression, mustache, or java.
    • options object
      Hide options attribute Show options attribute object

      • * string Additional properties

    • source string | object

      The script source. For search templates, an object containing the search template.

      One of:

      string-1 string SearchRequestBody object

      Hide attributes Show attributes

      • aggregations object

        Defines the aggregations that are run as part of the search request.

      • explain boolean

        If true, the request returns detailed information about score computation as part of a hit.

        Default value is false.

      • ext object

        Configuration of search extensions defined by Elasticsearch plugins.

      • from number

        The starting document offset, which must be non-negative. By default, you cannot page through more than 10,000 hits using the from and size parameters. To page through more hits, use the search_after parameter.

        Default value is 0.0.

      • indices_boost array[object]

        Boost the _score of documents from specified indices. The boost value is the factor by which scores are multiplied. A boost value greater than 1.0 increases the score. A boost value between 0 and 1.0 decreases the score.

      • docvalue_fields array[object]

        An array of wildcard (*) field patterns. The request returns doc values for field names matching these patterns in the hits.fields property of the response.

      • knn
      • min_score number

        The minimum _score for matching documents. Documents with a lower _score are not included in search results or results collected by aggregations.

      • profile boolean

        Set to true to return detailed timing information about the execution of individual components in a search request. NOTE: This is a debugging tool and adds significant overhead to search execution.

        Default value is false.

      • rescore
      • script_fields object

        Retrieve a script evaluation (based on different fields) for each hit.

      • size number

        The number of hits to return, which must not be negative. By default, you cannot page through more than 10,000 hits using the from and size parameters. To page through more hits, use the search_after property.

        Default value is 10.0.

      • fields array[object]

        An array of wildcard (*) field patterns. The request returns values for field names matching these patterns in the hits.fields property of the response.

      • terminate_after number

        The maximum number of documents to collect for each shard. If a query reaches this limit, Elasticsearch terminates the query early. Elasticsearch collects documents before sorting.

        IMPORTANT: Use with caution. Elasticsearch applies this property to each shard handling the request. When possible, let Elasticsearch perform early termination automatically. Avoid specifying this property for requests that target data streams with backing indices across multiple data tiers.

        If set to 0 (default), the query does not terminate early.

        Default value is 0.0.

      • timeout string

        The period of time to wait for a response from each shard. If no response is received before the timeout expires, the request fails and returns an error. Defaults to no timeout.

      • track_scores boolean

        If true, calculate and return document scores, even if the scores are not used for sorting.

        Default value is false.

      • version boolean

        If true, the request returns the document version as part of a hit.

        Default value is false.

      • seq_no_primary_term boolean

        If true, the request returns sequence number and primary term of the last modification of each hit.

      • stats array[string]

        The stats groups to associate with the search. Each group maintains a statistics aggregation for its associated searches. You can retrieve these stats using the indices stats API.