Files
elasticsearch-js/docs/reference/api/CatSnapshotsRequest.md
2025-05-28 10:02:30 -05:00

1.4 KiB

CatSnapshotsRequest [interface-CatSnapshotsRequest]

Name Type Description
body string ({ [key: string]: any; } & { repository?: never; ignore_unavailable?: never; h?: never; s?: never; master_timeout?: never; time?: never; })
h Names List of columns to appear in the response. Supports simple wildcards.
ignore_unavailable boolean If true, the response does not include information from unavailable snapshots.
master_timeout Duration Period to wait for a connection to the master node.
querystring { [key: string]: any; } & { repository?: never; ignore_unavailable?: never; h?: never; s?: never; master_timeout?: never; time?: never; } All values in querystring will be added to the request querystring.
repository Names A comma-separated list of snapshot repositories used to limit the request. Accepts wildcard expressions. _all returns all repositories. If any repository fails during the request, Elasticsearch returns an error.
s Names List of columns that determine how the table should be sorted. Sorting defaults to ascending and can be changed by setting :asc or :desc as a suffix to the column name.
time TimeUnit Unit used to display time values.