Open a point in time | Elasticsearch API documentation (original) (raw)

Dismiss highlight Show more

index
string | array[string] Required
A comma-separated list of index names to open point in time; use _all or empty string to perform the operation on all indices

Extend the length of time that the point in time persists.
If false, the request returns an error if it targets a missing or closed index.
The node or shard the operation should be performed on. By default, it is random.
A custom value that is used to route operations to a specific shard.
The type of index that wildcard patterns can match. If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams. It supports comma-separated values, such as open,hidden. Valid values are: all, open, closed, hidden, none.
Supported values include:
- all: Match any data stream or index, including hidden ones.
- open: Match open, non-hidden indices. Also matches any non-hidden data stream.
- closed: Match closed, non-hidden indices. Also matches any non-hidden data stream. Data streams cannot be closed.
- hidden: Match hidden data streams and hidden indices. Must be combined with open, closed, or both.
- none: Wildcard expressions are not accepted.
Indicates whether the point in time tolerates unavailable shards or shard failures when initially creating the PIT. If false, creating a point in time request when a shard is missing or unavailable will throw an exception. If true, the point in time will contain all the shards that are available at the time of the request.
Maximum number of concurrent shard requests that each sub-search request executes per node.

application/json

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