Update a list Beta
Update a list using the list ID. The original list is replaced, and all unspecified fields are deleted.
You cannot modify the id
value.
Body Required
List'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:^(?! *$).+$
. -
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.
-
A string that is not empty and does not contain only whitespace
Minimum length is
1
. Format should match the following pattern:^(?! *$).+$
. -
version integer
Minimum value is
1
.
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 not found response
-
500 application/json; Elastic-Api-Version=2023-10-31
Internal server error response
curl \
-X PUT https://<KIBANA_URL>/api/lists \
-H "Content-Type: application/json; Elastic-Api-Version=2023-10-31"
{
"_version": "string",
"description": "string",
"id": "string",
"meta": {},
"name": "string",
"version": 42
}
{
"_version": "string",
"@timestamp": "2024-05-04T09:42:00+00:00",
"created_at": "2024-05-04T09:42:00+00:00",
"created_by": "string",
"description": "string",
"deserializer": "string",
"id": "string",
"immutable": true,
"meta": {},
"name": "string",
"serializer": "string",
"tie_breaker_id": "string",
"type": "binary",
"updated_at": "2024-05-04T09:42:00+00:00",
"updated_by": "string",
"version": 42
}
{
"error": "string",
"message": "string",
"statusCode": 42
}
{
"message": "string",
"status_code": 42
}
{
"error": "string",
"message": "string",
"statusCode": 42
}
{
"error": "string",
"message": "string",
"statusCode": 42
}
{
"message": "string",
"status_code": 42
}
{
"message": "string",
"status_code": 42
}