Path parameters

• index string Required

  Name of the data stream or index to target.

Query parameters

• if_primary_term number

  Only perform the operation if the document has this primary term.

• if_seq_no number

  Only perform the operation if the document has this sequence number.

• op_type string

  Set to create to only index the document if it does not already exist (put if absent). If a document with the specified _id already exists, the indexing operation will fail. Same as using the <index>/_create endpoint. Valid values: index, create. If document id is specified, it defaults to index. Otherwise, it defaults to create.

  Values are index or create.

• pipeline string

  ID of the pipeline to use to preprocess incoming documents. If the index has a default ingest pipeline specified, then setting the value to _none disables the default ingest pipeline for this request. If a final pipeline is configured it will always run, regardless of the value of this parameter.

• refresh string

  If true, Elasticsearch refreshes the affected shards to make this operation visible to search, if wait_for then wait for a refresh to make this operation visible to search, if false do nothing with refreshes. Valid values: true, false, wait_for.

  Values are true, false, or wait_for.

• routing string

  Custom value used to route operations to a specific shard.

• timeout string

  Period the request waits for the following operations: automatic index creation, dynamic mapping updates, waiting for active shards.

• version number

  Explicit version number for concurrency control. The specified version must match the current version of the document for the request to succeed.

• version_type string

  Specific version type: external, external_gte.

  Values are internal, external, external_gte, or force.

• wait_for_active_shards number | string

  The number of shard copies that must be active before proceeding with the operation. Set to all or any positive integer up to the total number of shards in the index (number_of_replicas+1).

• require_alias boolean

  If true, the destination must be an index alias.

Responses

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

  • _id string Required
  • _index string Required
  • _primary_term number
  • result string Required

    Values are created, updated, deleted, not_found, or noop.

  • _seq_no number
  • _shards object Required

    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]

          Additional properties are allowed.

        • suppressed array[object]

          Additional properties are allowed.

      • shard number Required
      • status string
    • skipped number
  • _version number Required
  • forced_refresh boolean