Update a document

POST /{index}/_update/{id}

Updates a document by running a script or passing a partial document.

Path parameters

index string Required

The name of the index
id string Required

Document ID

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.
lang string

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

Values are true, false, or wait_for.
require_alias boolean

If true, the destination must be an index alias.
retry_on_conflict number

Specify how many times should the operation be retried when a conflict occurs.
routing string

Custom value used to route operations to a specific shard.
timeout string

Period to wait for dynamic mapping updates and active shards. This guarantees Elasticsearch waits for at least the timeout before failing. The actual wait time could be longer, particularly when multiple waits occur.
wait_for_active_shards number | string

The number of shard copies that must be active before proceeding with the operations. Set to 'all' or any positive integer up to the total number of shards in the index (number_of_replicas+1). Defaults to 1 meaning the primary shard.
_source boolean | string | array[string]

Set to false to disable source retrieval. You can also specify a comma-separated list of the fields you want to retrieve.
_source_excludes string | array[string]

Specify the source fields you want to exclude.
_source_includes string | array[string]

Specify the source fields you want to retrieve.

application/json

Body Required

detect_noop boolean

Set to false to disable setting 'result' in the response to 'noop' if no change to the document occurred.
doc object

A partial update to an existing document.
doc_as_upsert boolean

Set to true to use the contents of 'doc' as the value of 'upsert'
script object
Hide script attributes Show script attributes object
- source string
  
  The script source.
- id string
- params object
  
  Specifies any named parameters that are passed into the script as variables. Use parameters instead of hard-coded values to decrease compile time.
  Hide params attributes Show params attributes object
  
  Additional properties
  
  key object
- lang string
  
  Any of:
  _types:ScriptLanguage string _types:ScriptLanguage string
  
  Values are painless, expression, mustache, or java.
- options object
  Hide options attributes Show options attributes object
  
  Additional properties
  
  key string
scripted_upsert boolean

Set to true to execute the script whether or not the document exists.
_source boolean | object

Defines how to fetch a source. Fetching can be disabled entirely, or the source can be filtered.
One of:
_types:SourceConfig boolean _types:SourceFilter object
Hide attributes Show attributes

excludes string | array[string]

includes string | array[string]
upsert object

If the document does not already exist, the contents of 'upsert' are inserted as a new document. If the document exists, the 'script' is executed.

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
  
  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
  
  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
  
  root_cause array[object]
  
  suppressed array[object]
  
  shard number Required
  
  status string
  
  skipped number
- _version number Required
- forced_refresh boolean
- get object
  
  Hide get attributes Show get attributes object
  
  fields object
  
  Hide fields attributes Show fields attributes object
  
  Additional properties
  
  key object
  
  found boolean Required
  
  _seq_no number
  
  _primary_term number
  
  _routing string
  
  _source object

POST /{index}/_update/{id}

curl \
 -X POST http://api.example.com/{index}/_update/{id} \
 -H "Content-Type: application/json" \
 -d '{"detect_noop":true,"doc":{},"doc_as_upsert":true,"script":{"source":"string","id":"string","params":{"key":{}},"":"painless","options":{"key":"string"}},"scripted_upsert":true,"":true,"upsert":{}}'

Update a document

Path parameters

Query parameters

Body Required

lang string

_source boolean | object

Responses