Path parameters

• indexstring Required

  The name of the data stream or index to target. If the target doesn't exist and matches the name or wildcard (*) pattern of an index template with a data_stream definition, this request creates the data stream. If the target doesn't exist and doesn't match a data stream template, this request creates the index. You can check for existing targets with the resolve index API.
• idstring Required

  A unique identifier for the document. To automatically generate a document ID, use the POST /<target>/_doc/ request format and omit this parameter.

Query parameters

• if_primary_termnumber

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

• if_seq_nonumber

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

• include_source_on_errorboolean

  True or false if to include the document source in the error message in case of parsing errors.

• op_typestring

  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. The behavior is the same as using the <index>/_create endpoint. If a document ID is specified, this paramater defaults to index. Otherwise, it defaults to create. If the request targets a data stream, an op_type of create is required.

  Values are index or create.

• pipelinestring

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

• refreshstring

  If true, Elasticsearch refreshes the affected shards to make this operation visible to search. If wait_for, it waits for a refresh to make this operation visible to search. If false, it does nothing with refreshes.

  Values are true, false, or wait_for.

• routingstring

  A custom value that is used to route operations to a specific shard.

• timeoutstring

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

  This parameter is useful for situations where the primary shard assigned to perform the operation might not be available when the operation runs. Some reasons for this might be that the primary shard is currently recovering from a gateway or undergoing relocation. By default, the operation will wait on the primary shard to become available for at least 1 minute before failing and responding with an error. The actual wait time could be longer, particularly when multiple waits occur.

  Values are -1 or 0.

• versionnumber

  An explicit version number for concurrency control. It must be a non-negative long number.

• version_typestring

  The version type.

  Values are internal, external, external_gte, or force.

• wait_for_active_shardsnumber | string

  The number of shard copies that must be active before proceeding with the operation. You can set it to all or any positive integer up to the total number of shards in the index (number_of_replicas+1). The default value of 1 means it waits for each primary shard to be active.

  Values are all or index-setting.

• require_aliasboolean

  If true, the destination must be an index alias.

Responses

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

  • _idstring Required
  • _indexstring Required
  • _primary_termnumber

    The primary term assigned to the document for the indexing operation.

  • resultstring Required

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

  • _seq_nonumber
  • _shardsobject Required
    Hide _shards attributes Show _shards attributes object

    • failednumber Required
    • successfulnumber Required
    • totalnumber Required
    • failuresarray[object]
      Hide failures attributes Show failures attributes object

      • indexstring
      • nodestring
      • reasonobject Required

        Cause and details about a request failure. This class defines the properties common to all error types. Additional details are also provided, that depend on the error type.

        Hide reason attributes Show reason attributes object

        • typestring Required

          The type of error

        • reasonstring | null

          A human-readable explanation of the error, in English.

          One of:

          string-1stringstring-2string | null
        • stack_tracestring

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

        • caused_byobject

          Cause and details about a request failure. This class defines the properties common to all error types. Additional details are also provided, that depend on the error type.

        • root_causearray[object]

          Cause and details about a request failure. This class defines the properties common to all error types. Additional details are also provided, that depend on the error type.

          Cause and details about a request failure. This class defines the properties common to all error types. Additional details are also provided, that depend on the error type.

        • suppressedarray[object]

          Cause and details about a request failure. This class defines the properties common to all error types. Additional details are also provided, that depend on the error type.

          Cause and details about a request failure. This class defines the properties common to all error types. Additional details are also provided, that depend on the error type.

      • shardnumber Required
      • statusstring
    • skippednumber
  • _versionnumber Required
  • forced_refreshboolean