Patch a list item Beta
Update specific fields of an existing list item using the list item ID.
Body Required
List item's properties
-
_version string
-
A string that is not empty and does not contain only whitespace
Minimum length is
1
. Format should match the following pattern:^(?! *$).+$
. -
meta object
Additional properties are allowed.
-
refresh string
Determines when changes made by the request are made visible to search
Values are
true
,false
, orwait_for
. -
value string
A string that is not empty and does not contain only whitespace
Minimum length is
1
. Format should match the following pattern:^(?! *$).+$
.
Responses
-
200 application/json; Elastic-Api-Version=2023-10-31
Successful response
-
400 application/json; Elastic-Api-Version=2023-10-31
Invalid input data response
-
401 application/json; Elastic-Api-Version=2023-10-31
Unsuccessful authentication response
-
403 application/json; Elastic-Api-Version=2023-10-31
Not enough privileges response
-
404 application/json; Elastic-Api-Version=2023-10-31
List item not found response
-
500 application/json; Elastic-Api-Version=2023-10-31
Internal server error response
PATCH /api/lists/items
curl \
-X PATCH https://<KIBANA_URL>/api/lists/items \
-H "Content-Type: application/json; Elastic-Api-Version=2023-10-31"
Request examples
{
"_version": "string",
"id": "string",
"meta": {},
"refresh": "true",
"value": "string"
}
Response examples (200)
{
"_version": "string",
"@timestamp": "2024-05-04T09:42:00+00:00",
"created_at": "2024-05-04T09:42:00+00:00",
"created_by": "string",
"deserializer": "string",
"id": "string",
"list_id": "string",
"meta": {},
"serializer": "string",
"tie_breaker_id": "string",
"type": "binary",
"updated_at": "2024-05-04T09:42:00+00:00",
"updated_by": "string",
"value": "string"
}
Response examples (400)
Security_lists_api_platformerrorresponse (generated)
{
"error": "string",
"message": "string",
"statusCode": 42
}
{
"message": "string",
"status_code": 42
}
Response examples (401)
{
"error": "string",
"message": "string",
"statusCode": 42
}
Response examples (403)
{
"error": "string",
"message": "string",
"statusCode": 42
}
Response examples (404)
{
"message": "string",
"status_code": 42
}
Response examples (500)
{
"message": "string",
"status_code": 42
}