Path parameters

• repository string Required

  A comma-separated list of snapshot repository names used to limit the request. Wildcard (*) expressions are supported.

• snapshot string | array[string] Required

  A comma-separated list of snapshot names to retrieve Wildcards (*) are supported.

  • To get information about all snapshots in a registered repository, use a wildcard (*) or _all.
  • To get information about any snapshots that are currently running, use _current.

Query parameters

• after string Generally available; Added in 7.14.0

  An offset identifier to start pagination from as returned by the next field in the response body.

• from_sort_value string Generally available; Added in 7.16.0

  The value of the current sort column at which to start retrieval. It can be a string snapshot- or a repository name when sorting by snapshot or repository name. It can be a millisecond time value or a number when sorting by index- or shard count.

• ignore_unavailable boolean

  If false, the request returns an error for any snapshots that are unavailable.

• index_details boolean Generally available; Added in 7.13.0

  If true, the response includes additional information about each index in the snapshot comprising the number of shards in the index, the total size of the index in bytes, and the maximum number of segments per shard in the index. The default is false, meaning that this information is omitted.

• index_names boolean Generally available; Added in 8.3.0

  If true, the response includes the name of each index in each snapshot.

• include_repository boolean

  If true, the response includes the repository name in each snapshot.

• master_timeout string

  The period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error.

  External documentation
• order string Generally available; Added in 7.14.0

  The sort order. Valid values are asc for ascending and desc for descending order. The default behavior is ascending order.

  Supported values include:

  • asc: Ascending (smallest to largest)
  • desc: Descending (largest to smallest)

  Values are asc or desc.

• offset number Generally available; Added in 7.15.0

  Numeric offset to start pagination from based on the snapshots matching this request. Using a non-zero value for this parameter is mutually exclusive with using the after parameter. Defaults to 0.

• size number Generally available; Added in 7.14.0

  The maximum number of snapshots to return. The default is 0, which means to return all that match the request without limit.

• slm_policy_filter string Generally available; Added in 7.16.0

  Filter snapshots by a comma-separated list of snapshot lifecycle management (SLM) policy names that snapshots belong to.

  You can use wildcards (*) and combinations of wildcards followed by exclude patterns starting with -. For example, the pattern *,-policy-a-\* will return all snapshots except for those that were created by an SLM policy with a name starting with policy-a-. Note that the wildcard pattern * matches all snapshots created by an SLM policy but not those snapshots that were not created by an SLM policy. To include snapshots that were not created by an SLM policy, you can use the special pattern _none that will match all snapshots without an SLM policy.

• sort string Generally available; Added in 7.14.0

  The sort order for the result. The default behavior is sorting by snapshot start time stamp.

  Values are start_time, duration, name, index_count, repository, shard_count, or failed_shard_count.

• state string | array[string] Generally available; Added in 9.1.0

  Only return snapshots with a state found in the given comma-separated list of snapshot states. The default is all snapshot states.

  Supported values include:

  • IN_PROGRESS: The snapshot process has started.
  • SUCCESS: The snapshot process completed successfully.
  • FAILED: The snapshot failed.
  • PARTIAL: The snapshot was partially successful.
  • INCOMPATIBLE: The snapshot is incompatible with the current version of the cluster.

  Values are IN_PROGRESS, SUCCESS, FAILED, PARTIAL, or INCOMPATIBLE.

• verbose boolean

  If true, returns additional information about each snapshot such as the version of Elasticsearch which took the snapshot, the start and end times of the snapshot, and the number of shards snapshotted.

  NOTE: The parameters size, order, after, from_sort_value, offset, slm_policy_filter, and sort are not supported when you set verbose=false and the sort order for requests with verbose=false is undefined.

Responses

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

  • remaining number Required Generally available; Added in 7.15.0

    The number of remaining snapshots that were not returned due to size limits and that can be fetched by additional requests using the next field value.

  • total number Required Generally available; Added in 7.15.0

    The total number of snapshots that match the request when ignoring the size limit or after query parameter.

  • next string

    If the request contained a size limit and there might be more results, a next field will be added to the response. It can be used as the after query parameter to fetch additional results.

  • responses array[object]
    Hide responses attributes Show responses attributes object

    • repository string Required
    • snapshots array[object]
      Hide snapshots attributes Show snapshots attributes object

      • data_streams array[string] Required
      • duration string

        A duration. Units can be nanos, micros, ms (milliseconds), s (seconds), m (minutes), h (hours) and d (days). Also accepts "0" without a unit and "-1" to indicate an unspecified value.

      • duration_in_millis
      • end_time
      • end_time_in_millis
      • failures array[object]
      • include_global_state boolean
      • indices array[string]
      • index_details object Generally available; Added in 7.13.0
        Hide index_details attribute Show index_details attribute object

        • * object Additional properties
      • metadata object
      • reason string
      • repository string
      • snapshot string Required
      • shards object
      • start_time
      • start_time_in_millis
      • state string
      • uuid string Required
      • version string
      • version_id number
      • feature_states array[object]
    • error 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.

      Hide error attributes Show error attributes object

      • type string Required

        The type of error

      • reason string | null

        A human-readable explanation of the error, in English.

        One of:

        string-1 string string-2 string | null
      • 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]

        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.

        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.

      • suppressed array[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.

        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.

  • snapshots array[object]
    Hide snapshots attributes Show snapshots attributes object

    • data_streams array[string] Required
    • duration string

      A duration. Units can be nanos, micros, ms (milliseconds), s (seconds), m (minutes), h (hours) and d (days). Also accepts "0" without a unit and "-1" to indicate an unspecified value.

      External documentation
    • duration_in_millis number

      Time unit for milliseconds

    • end_time string | number

      One of:

      string-1 string UnitMillis number

      Time unit for milliseconds

    • end_time_in_millis number

      Time unit for milliseconds

    • failures array[object]
      Hide failures attributes Show failures attributes object

      • index string Required
      • node_id string
      • reason string Required
      • shard_id number Required
      • index_uuid string Required
      • status string Required
    • include_global_state boolean
    • indices array[string]
    • index_details object Generally available; Added in 7.13.0
      Hide index_details attribute Show index_details attribute object

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

        • shard_count number Required
        • size
        • size_in_bytes number Required
        • max_segments_per_shard number Required
    • metadata object
      Hide metadata attribute Show metadata attribute object

      • * object Additional properties
    • reason string
    • repository string
    • snapshot string Required
    • shards object
      Hide shards attributes Show shards attributes object

      • failed number Required

        The number of shards the operation or search attempted to run on but failed.

      • successful number Required

        The number of shards the operation or search succeeded on.

      • total number Required

        The number of shards the operation or search will run on overall.

      • failures array[object]
      • skipped number

    • start_time string | number

      One of:

      string-1 string UnitMillis number

      Time unit for milliseconds

    • start_time_in_millis number

      Time unit for milliseconds

    • state string
    • uuid string Required
    • version string
    • version_id number
    • feature_states array[object]
      Hide feature_states attributes Show feature_states attributes object

      • feature_name string Required
      • indices string | array[string] Required