Path parameters

• repository string Required

  Repository for the snapshot.

• snapshot string Required

  Name of the snapshot. Must be unique in the repository.

Query parameters

• master_timeout string

  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.

• wait_for_completion boolean

  If true, the request returns a response when the snapshot is complete. If false, the request returns a response when the snapshot initializes.

Responses

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

  • accepted boolean

    Equals true if the snapshot was accepted. Present when the request had wait_for_completion set to false

  • snapshot object

    Additional properties are allowed.

    Hide snapshot attributes Show snapshot 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 number

      Time unit for milliseconds

    • end_time string | 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:

      _types:DateTime string _types: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 string Required
      • index_uuid string Required
      • status string Required
    • include_global_state boolean
    • indices array[string]
    • index_details object
      Hide index_details attribute Show index_details attribute object

      • * object Additional properties

        Additional properties are allowed.

        Hide * attributes Show * attributes object

        • shard_count number Required

        • size number | string

          One of:

          _types:ByteSize number _types:ByteSize string
        • size_in_bytes number Required
        • max_segments_per_shard number Required
    • metadata object
      Hide metadata attribute Show metadata attribute object

      • * object Additional properties

        Additional properties are allowed.

    • reason string
    • repository string
    • snapshot string Required
    • shards object

      Additional properties are allowed.

      Hide shards attributes Show shards attributes object

      • failed number Required
      • successful number Required
      • total number Required
      • failures array[object]
        Hide failures attributes Show failures attributes object

        • index string
        • node string
        • reason object Required

          Additional properties are allowed.

          Hide reason attributes Show reason attributes object

          • type string Required

            The type of error

          • reason string

            A human-readable explanation of the error, in english

          • stack_trace string

            The server stack trace. Present only if the error_trace=true parameter was sent with the request.

          • caused_by object

            Additional properties are allowed.

          • root_cause array[object]
          • suppressed array[object]
        • shard number Required
        • status string
      • skipped number

    • start_time string | 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:

      _types:DateTime string _types: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