Update a list
Server:
https://{kibana_url}
- PUT /api/lists
- PUT /s/{space_id}/api/lists
Refer to Spaces for more information.
Update a list using the list ID. The original list is replaced, and all unspecified fields are deleted.
info You cannot modify the
idvalue.
Request
List's properties
-
_versionstring -
descriptionstring · min: 1required -
A string that does not contain only whitespace characters
-
idstring · min: 1required -
A string that does not contain only whitespace characters
-
metaobject -
namestring · min: 1required -
A string that does not contain only whitespace characters
-
versioninteger · min: 1
Responses
Successful response
-
_versionstring -
@timestampstring -
created_atstringrequired -
created_bystringrequired -
descriptionstring · min: 1required -
A string that does not contain only whitespace characters
-
idstring · min: 1required -
A string that does not contain only whitespace characters
-
immutablebooleanrequired -
metaobject -
namestring · min: 1required -
A string that does not contain only whitespace characters
-
tie_breaker_idstringrequired -
typerequired -
Values:
binarybooleanbytedatedate_nanosdate_rangedoubledouble_rangefloatfloat_rangegeo_pointgeo_shapehalf_floatintegerinteger_rangeipip_rangekeywordlonglong_rangeshapeshorttext -
updated_atstringrequired -
updated_bystringrequired -
versioninteger · min: 1required
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 not found response
-
messagestringrequired -
status_codeintegerrequired
Internal server error response
-
messagestringrequired -
status_codeintegerrequired