[[reference-snapshot-get]]

////////
===========================================================================================================================
||                                                                                                                       ||
||                                                                                                                       ||
||                                                                                                                       ||
||        ██████╗ ███████╗ █████╗ ██████╗ ███╗   ███╗███████╗                                                            ||
||        ██╔══██╗██╔════╝██╔══██╗██╔══██╗████╗ ████║██╔════╝                                                            ||
||        ██████╔╝█████╗  ███████║██║  ██║██╔████╔██║█████╗                                                              ||
||        ██╔══██╗██╔══╝  ██╔══██║██║  ██║██║╚██╔╝██║██╔══╝                                                              ||
||        ██║  ██║███████╗██║  ██║██████╔╝██║ ╚═╝ ██║███████╗                                                            ||
||        ╚═╝  ╚═╝╚══════╝╚═╝  ╚═╝╚═════╝ ╚═╝     ╚═╝╚══════╝                                                            ||
||                                                                                                                       ||
||                                                                                                                       ||
||    This file is autogenerated, DO NOT send pull requests that changes this file directly.                             ||
||    You should update the script that does the generation, which can be found in:                                      ||
||    https://github.com/elastic/elastic-client-generator-js                                                             ||
||                                                                                                                       ||
||    You can run the script with the following command:                                                                 ||
||       npm run elasticsearch -- --version <version>                                                                    ||
||                                                                                                                       ||
||                                                                                                                       ||
||                                                                                                                       ||
===========================================================================================================================
////////

[discrete]
=== client.snapshot.get

Returns information about a snapshot.

{ref}/modules-snapshots.html[{es} documentation]

[discrete]
==== Function signature

[source,ts]
----
(SnapshotGetRequest, options?): Promise<SnapshotGetResponse>
----

[discrete]
===== `SnapshotGetRequest`

[source,ts]
----
interface SnapshotGetRequest extends <<shared-type-request-base, RequestBase>> {
  repository: <<shared-type-name, Name>>
  snapshot: <<shared-type-names, Names>>
  ignore_unavailable?: boolean
  master_timeout?: <<shared-type-duration, Duration>>
  verbose?: boolean
  index_details?: boolean
  index_names?: boolean
  include_repository?: boolean
  sort?: SnapshotSnapshotSort
  size?: <<shared-type-integer, integer>>
  order?: <<shared-type-sort-order, SortOrder>>
  after?: string
  offset?: <<shared-type-integer, integer>>
  from_sort_value?: string
  slm_policy_filter?: <<shared-type-name, Name>>
}
----

[discrete]
===== `SnapshotGetResponse`

[source,ts]
----
interface SnapshotGetResponse {
  responses?: SnapshotGetSnapshotResponseItem[]
  snapshots?: SnapshotSnapshotInfo[]
  total: <<shared-type-integer, integer>>
  remaining: <<shared-type-integer, integer>>
}
----

