Patch a value list item

Base URL: https://{kibana_url}

PATCH /api/lists/items

Update specific fields of an existing value list item using the item id.

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

PATCH kbn:/api/lists/items
{
  "id": "pd1WRJQBs4HAK3VQeHFI",
  "value": "255.255.255.255"
}

Generated from the API spec

curl Shell

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

Generated from the API spec

Response

{
  "_version": "WzE5LDFd",
  "@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:23:37.602Z",
  "updated_by": "elastic",
  "value": "255.255.255.255"
}

{
  "message": "{\u0022took\u0022:15,\u0022timed_out\u0022:false,\u0022total\u0022:1,\u0022updated\u0022:0,\u0022deleted\u0022:0,\u0022batches\u0022:1,\u0022version_conflicts\u0022:0,\u0022noops\u0022:0,\u0022retries\u0022:{\u0022bulk\u0022:0,\u0022search\u0022:0},\u0022throttled_millis\u0022:0,\u0022requests_per_second\u0022:-1,\u0022throttled_until_millis\u0022:0,\u0022failures\u0022:[{\u0022index\u0022:\u0022.ds-.items-default-2025.01.09-000001\u0022,\u0022id\u0022:\u0022ip_item\u0022,\u0022cause\u0022:{\u0022type\u0022:\u0022document_parsing_exception\u0022,\u0022reason\u0022:\u0022[1:107] failed to parse field [ip] of type [ip] in document with id ip_item. Preview of fields value: 2\u0022,\u0022caused_by\u0022:{\u0022type\u0022:\u0022illegal_argument_exception\u0022,\u0022reason\u0022:\u00222 is not an IP string literal.\u0022}},\u0022status\u0022:400}]}",
  "status_code": 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