Path parameters

• id string Required

  A unique identifier for the async search.

Query parameters

• keep_alive string

  The length of time that the async search needs to be available. Ongoing async searches and any saved search results are deleted after this period.

  Values are -1 or 0.

Responses

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

  • id string
  • is_partial boolean Required

    When the query is no longer running, this property indicates whether the search failed or was successfully completed on all shards. While the query is running, is_partial is always set to true.

  • is_running boolean Required

    Indicates whether the search is still running or has completed.

    
    

    If the search failed after some shards returned their results or the node that is coordinating the async search dies, results may be partial even though is_running is false.

  • expiration_time string | number

    A date and time, either as a string whose format can depend on the context (defaulting to ISO 8601), or a number of milliseconds since the Epoch. Elasticsearch accepts both as input, but will generally output a string representation.

    One of:

    string-1 string UnitMillis number

    Time unit for milliseconds

  • Time unit for milliseconds

  • start_time string | number

    A date and time, either as a string whose format can depend on the context (defaulting to ISO 8601), or a number of milliseconds since the Epoch. Elasticsearch accepts both as input, but will generally output a string representation.

    One of:

    string-1 string UnitMillis number

    Time unit for milliseconds

  • Time unit for milliseconds

  • completion_time string | number

    A date and time, either as a string whose format can depend on the context (defaulting to ISO 8601), or a number of milliseconds since the Epoch. Elasticsearch accepts both as input, but will generally output a string representation.

    One of:

    string-1 string UnitMillis number

    Time unit for milliseconds

  • Time unit for milliseconds

  • _shards object Required
    Hide _shards attributes Show _shards attributes object

    • failed number Required
    • successful number Required
    • total number Required
    • failures array[object]
      Hide failures attributes Show failures attributes object

      • index string
      • node string
      • reason object Required

        Cause and details about a request failure. This class defines the properties common to all error types. Additional details are also provided, that depend on the error type.

        Hide reason attributes Show reason attributes object

        • type string Required

          The type of error

        • reason
        • stack_trace string

          The server stack trace. Present only if the error_trace=true parameter was sent with the request.

        • caused_by object

          Cause and details about a request failure. This class defines the properties common to all error types. Additional details are also provided, that depend on the error type.

        • root_cause array[object]
        • suppressed array[object]
      • shard number Required
      • status string
    • skipped number
  • _clusters object
    Hide _clusters attributes Show _clusters attributes object

    • skipped number Required
    • successful number Required
    • total number Required
    • running number Required
    • partial number Required
    • failed number Required
    • details object
      Hide details attribute Show details attribute object

      • * object Additional properties
        Hide * attributes Show * attributes object

        • status string Required

          Values are running, successful, partial, skipped, or failed.

        • indices string Required

        • Time unit for milliseconds

        • timed_out boolean Required
        • _shards object
          Hide _shards attributes Show _shards attributes object

          • failed number Required
          • successful number Required
          • total number Required
          • failures array[object]
          • skipped number
        • failures array[object]
  • completion_status number

    If the async search completed, this field shows the status code of the search. For example, 200 indicates that the async search was successfully completed. 503 indicates that the async search was completed with an error.