Patch a list item
Server:
https://{kibana_url}
- PATCH /api/lists/items
- PATCH /s/{space_id}/api/lists/items
Refer to Spaces for more information.
Update specific fields of an existing list item using the list item ID.
Request
List item's properties
-
_versionstring -
idstring · min: 1required -
A string that does not contain only whitespace characters
-
metaobject -
refresh -
Determines when changes made by the request are made visible to search
-
Values:
truefalsewait_for -
valuestring · min: 1 -
A string that does not contain only whitespace characters
Responses
Successful response
-
_versionstring -
@timestampstring -
created_atstringrequired -
created_bystringrequired -
idstring · min: 1required -
A string that does not contain only whitespace characters
-
list_idstring · min: 1required -
A string that does not contain only whitespace characters
-
metaobject -
tie_breaker_idstringrequired -
type -
Values:
binarybooleanbytedatedate_nanosdate_rangedoubledouble_rangefloatfloat_rangegeo_pointgeo_shapehalf_floatintegerinteger_rangeipip_rangekeywordlonglong_rangeshapeshorttext -
updated_atstringrequired -
updated_bystringrequired -
valuestring · min: 1required -
A string that does not contain only whitespace characters
Invalid input data response
One of:
-
errorstringrequired -
messagestringrequired -
statusCodeintegerrequired
-
messagestringrequired -
status_codeintegerrequired
Unsuccessful authentication response
-
errorstringrequired -
messagestringrequired -
statusCodeintegerrequired
Not enough privileges response
-
errorstringrequired -
messagestringrequired -
statusCodeintegerrequired
List item not found response
-
messagestringrequired -
status_codeintegerrequired
Internal server error response
-
messagestringrequired -
status_codeintegerrequired