Query parameters

• ignore_unavailableboolean

  If true, the response does not include information from unavailable snapshots.
• hstring | array[string]

  List of columns to appear in the response. Supports simple wildcards.

• sstring | 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_timeoutstring

  Period to wait for a connection to the master node.

  Values are -1 or 0.

• timestring

  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

  • idstring

    The unique identifier for the snapshot.

  • repositorystring

    The repository name.

  • statusstring

    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_epochnumber | 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:

    UnitSecondsnumberStringifiedEpochTimeUnitSecondsstring

    Time unit for seconds

  • start_timestring | object

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

    One of:

    ScheduleTimeOfDaystringHourAndMinuteobject

    Hide attributes Show attributes

    • hourarray[number] Required
    • minutearray[number] Required

  • end_epochnumber | 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:

    UnitSecondsnumberStringifiedEpochTimeUnitSecondsstring

    Time unit for seconds
  • end_timestring

    Time of day, expressed as HH:MM:SS

  • durationstring

    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.

  • indicesstring

    The number of indices in the snapshot.

  • successful_shardsstring

    The number of successful shards in the snapshot.

  • failed_shardsstring

    The number of failed shards in the snapshot.

  • total_shardsstring

    The total number of shards in the snapshot.

  • reasonstring

    The reason for any snapshot failures.