Path parameters

• policy_idstring | array[string] Required

  Comma-separated list of snapshot lifecycle policies to retrieve

Query parameters

• master_timeoutstring

  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.

  Values are -1 or 0.

• timeoutstring

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

  Values are -1 or 0.

Responses

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

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

    • in_progressobject
      Hide in_progress attributes Show in_progress attributes object

      • namestring Required
      • start_time_millisnumber

        Time unit for milliseconds

      • statestring Required
      • uuidstring Required
    • last_failureobject
      Hide last_failure attributes Show last_failure attributes object

      • snapshot_namestring Required

      • timestring | number Required

        A date and time, either as a string whose format can depend on the context (defaulting to ISO 8601), or a number of milliseconds since the Epoch. Elasticsearch accepts both as input, but will generally output a string representation.

        One of:

        DateTimestringUnitMillisnumber

        Time unit for milliseconds

    • last_successobject
      Hide last_success attributes Show last_success attributes object

      • snapshot_namestring Required

      • timestring | number Required

        A date and time, either as a string whose format can depend on the context (defaulting to ISO 8601), or a number of milliseconds since the Epoch. Elasticsearch accepts both as input, but will generally output a string representation.

        One of:

        DateTimestringUnitMillisnumber

        Time unit for milliseconds

    • modified_datestring | number

      A date and time, either as a string whose format can depend on the context (defaulting to ISO 8601), or a number of milliseconds since the Epoch. Elasticsearch accepts both as input, but will generally output a string representation.

      One of:

      DateTimestringUnitMillisnumber

      Time unit for milliseconds

    • modified_date_millisnumber

      Time unit for milliseconds

    • next_executionstring | number

      A date and time, either as a string whose format can depend on the context (defaulting to ISO 8601), or a number of milliseconds since the Epoch. Elasticsearch accepts both as input, but will generally output a string representation.

      One of:

      DateTimestringUnitMillisnumber

      Time unit for milliseconds

    • next_execution_millisnumber

      Time unit for milliseconds

    • policyobject Required
      Hide policy attributes Show policy attributes object

      • configobject
        Hide config attributes Show config attributes object

        • ignore_unavailableboolean

          If false, the snapshot fails if any data stream or index in indices is missing or closed. If true, the snapshot ignores missing or closed data streams and indices.

        • indicesstring | array[string]
        • include_global_stateboolean

          If true, the current global state is included in the snapshot.

        • feature_statesarray[string]

          A list of feature states to be included in this snapshot. A list of features available for inclusion in the snapshot and their descriptions be can be retrieved using the get features API. Each feature state includes one or more system indices containing data necessary for the function of that feature. Providing an empty array will include no feature states in the snapshot, regardless of the value of include_global_state. By default, all available feature states will be included in the snapshot if include_global_state is true, or no feature states if include_global_state is false.

        • metadataobject
          Hide metadata attribute Show metadata attribute object
        • partialboolean

          If false, the entire snapshot will fail if one or more indices included in the snapshot do not have all primary shards available.

      • namestring Required
      • repositorystring Required
      • retentionobject
        Hide retention attributes Show retention attributes object

        • expire_afterstring Required

          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.

        • max_countnumber Required

          Maximum number of snapshots to retain, even if the snapshots have not yet expired. If the number of snapshots in the repository exceeds this limit, the policy retains the most recent snapshots and deletes older snapshots.

        • min_countnumber Required

          Minimum number of snapshots to retain, even if the snapshots have expired.

      • schedulestring Required
    • versionnumber Required
    • statsobject Required
      Hide stats attributes Show stats attributes object

      • retention_deletion_timestring

        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.

      • retention_deletion_time_millisnumber

        Time unit for milliseconds

      • retention_failednumber
      • retention_runsnumber
      • retention_timed_outnumber
      • policystring
      • total_snapshots_deletednumber
      • total_snapshot_deletion_failuresnumber
      • total_snapshots_failednumber
      • total_snapshots_takennumber