Patch a value list

Server: https://{kibana_url}

PATCH /api/lists

Api key auth Basic auth

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

Request

Responses

Successful response

application/json

Invalid input data response

application/json

Unsuccessful authentication response

application/json

Not enough privileges response

application/json

List not found response

application/json

Internal server error response

application/json

Examples

Request Console 1 / 2 languages

Console Kibana Dev Tools

PATCH /api/lists
{
  "id": "ip_list",
  "name": "Bad ips list - UPDATED"
}

curl Shell

curl -X PATCH "https://{kibana_url}/api/lists" \
  -H "Content-Type: application/json" \
  -d '{
  "id": "ip_list",
  "name": "Bad ips list - UPDATED"
}'

Response

{
  "_version": "WzEsMV0=",
  "@timestamp": "2025-01-08T04:47:34.273Z",
  "created_at": "2025-01-08T04:47:34.273Z",
  "created_by": "elastic",
  "description": "This list describes bad internet ips",
  "id": "ip_list",
  "immutable": false,
  "name": "Bad ips list - UPDATED",
  "tie_breaker_id": "f5508188-b1e9-4e6e-9662-d039a7d89899",
  "type": "ip",
  "updated_at": "2025-01-08T05:21:53.843Z",
  "updated_by": "elastic",
  "version": 2
}

{
  "error": "Bad Request",
  "message": "[request body]: name: 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] is unauthorized for user, this action is granted by the Kibana privileges [lists-all]",
  "statusCode": 403
}

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

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

Request { _version , description , id , meta , name , version , }

Responses

Request