Update a value list item

Base URL: https://{kibana_url}

PUT /api/lists/items

Update a value list item using the list item ID. The original list item is replaced, and all unspecified fields are deleted.

Note

You cannot modify the id value.

Authentication

Api key

Authorization: <value>

These APIs use key-based authentication. You must create an API key and use the encoded value in the request header. For example: Authorization: ApiKey base64AccessApiKey

Basic

Authorization: Basic <credentials>

Request body

Responses

Successful response

application/json

Invalid input data response

application/json

Unsuccessful authentication response

application/json

Not enough privileges response

application/json

List item not found response

application/json

Internal server error response

application/json

Base URL: https://{kibana_url}

Examples

Request Console 1 / 2 languages

Console Kibana Dev Tools

PUT kbn:/api/lists/items
{
  "id": "ip_item",
  "value": "255.255.255.255"
}

Generated from the API spec

curl Shell

curl -X PUT "${KIBANA_URL}/api/lists/items" \
  -H "Authorization: ApiKey ${API_KEY}" \
  -H "Content-Type: application/json" \
  -d '{
    "id": "ip_item",
    "value": "255.255.255.255"
  }'

Generated from the API spec

Response

{
  "_version": "WzIwLDFd",
  "@timestamp": "2025-01-08T05:15:05.159Z",
  "created_at": "2025-01-08T05:15:05.159Z",
  "created_by": "elastic",
  "id": "pd1WRJQBs4HAK3VQeHFI",
  "list_id": "ip_list",
  "tie_breaker_id": "eee41dc7-1666-4876-982f-8b0f7b59eca3",
  "type": "ip",
  "updated_at": "2025-01-08T05:44:14.009Z",
  "updated_by": "elastic",
  "value": "255.255.255.255"
}

{
  "error": "Bad Request",
  "message": "[request body]: id: Expected string, received number",
  "statusCode": 400
}

{
  "error": "Unauthorized",
  "message": "[security_exception\\n\\tRoot causes:\\n\\t\\tsecurity_exception: unable to authenticate user [elastic] for REST request [/_security/_authenticate]]: unable to authenticate user [elastic] for REST request [/_security/_authenticate]",
  "statusCode": 401
}

{
  "error": "Forbidden",
  "message": "API [PATCH /api/lists/items] is unauthorized for user, this action is granted by the Kibana privileges [lists-all]",
  "statusCode": 403
}

{
  "message": "list item id: \\\u0022foo\\\u0022 not found",
  "status_code": 404
}

{
  "message": "Internal Server Error",
  "status_code": 500
}

Authentication

Request body { }

Responses

Request body