Path parameters

• repository string | array[string] Required

  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.

Query parameters

• ignore_unavailable boolean

  If true, the response does not include information from unavailable snapshots.

• h string | array[string]

  A comma-separated list of columns names to display. It supports simple wildcards.

  Supported values include:

  • id (or snapshot): The ID of the snapshot, such as 'snap1'.
  • repository (or re, repo): The name of the repository, such as 'repo1'.
  • status (or s): State of the snapshot process. Returned values are: 'FAILED': The snapshot process failed. 'INCOMPATIBLE': The snapshot process is incompatible with the current cluster version. 'IN_PROGRESS': The snapshot process started but has not completed. 'PARTIAL': The snapshot process completed with a partial success. 'SUCCESS': The snapshot process completed with a full success.
  • start_epoch (or ste, startEpoch): The unix epoch time at which the snapshot process started.
  • start_time (or sti, startTime): 'HH:MM:SS' time at which the snapshot process started.
  • end_epoch (or ete, endEpoch): The unix epoch time at which the snapshot process ended.
  • end_time (or eti, endTime): 'HH:MM:SS' time at which the snapshot process ended.
  • duration (or dur): The time it took the snapshot process to complete in time units.
  • indices (or i): The number of indices in the snapshot.
  • successful_shards (or ss): The number of successful shards in the snapshot.
  • failed_shards (or fs): The number of failed shards in the snapshot.
  • total_shards (or ts): The total number of shards in the snapshot.
  • reason (or r): The reason for any snapshot failures.

  Values are id, snapshot, repository, re, repo, status, s, start_epoch, ste, startEpoch, start_time, sti, startTime, end_epoch, ete, endEpoch, end_time, eti, endTime, duration, dur, indices, i, successful_shards, ss, failed_shards, fs, total_shards, ts, reason, or r.

• s string | array[string]

  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.

• master_timeout string

  Period to wait for a connection to the master node.

  Values are -1 or 0.

• time string

  Unit used to display time values.

  Values are nanos, micros, ms, s, m, h, or d.

Responses

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

  • id string

    The unique identifier for the snapshot.

  • repository string

    The repository name.

  • status string

    The state of the snapshot process. Returned values include: FAILED: The snapshot process failed. INCOMPATIBLE: The snapshot process is incompatible with the current cluster version. IN_PROGRESS: The snapshot process started but has not completed. PARTIAL: The snapshot process completed with a partial success. SUCCESS: The snapshot process completed with a full success.

  • start_epoch number | string

    Some APIs will return values such as numbers also as a string (notably epoch timestamps). This behavior is used to capture this behavior while keeping the semantics of the field type.

    Depending on the target language, code generators can keep the union or remove it and leniently parse strings to the target type.

    One of:

    UnitSeconds number string-2 string

    Time unit for seconds

  • start_time string | object

    A time of day, expressed either as hh:mm, noon, midnight, or an hour/minutes structure.

    One of:

    string-1 string HourAndMinute object

    Hide attributes Show attributes

    • hour array[number] Required
    • minute array[number] Required

  • end_epoch number | string

    Some APIs will return values such as numbers also as a string (notably epoch timestamps). This behavior is used to capture this behavior while keeping the semantics of the field type.

    Depending on the target language, code generators can keep the union or remove it and leniently parse strings to the target type.

    One of:

    UnitSeconds number string-2 string

    Time unit for seconds
  • end_time string

    Time of day, expressed as HH:MM:SS

  • 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.

  • indices string

    The number of indices in the snapshot.

  • successful_shards string

    The number of successful shards in the snapshot.

  • failed_shards string

    The number of failed shards in the snapshot.

  • total_shards string

    The total number of shards in the snapshot.

  • reason string

    The reason for any snapshot failures.