Import value list items

Server: https://{kibana_url}

POST /api/lists/items/_import
POST /s/{space_id}/api/lists/items/_import

Api key auth Basic auth

Refer to Spaces for more information.

Import value list items from a TXT or CSV file. The maximum file size is 9 million bytes.

You can import items to a new or existing list.

Query Parameters

Request

file string: A .txt or .csv file containing newline separated list items.

Responses

Successful response

application/json

Invalid input data response

application/json

Unsuccessful authentication response

application/json

Not enough privileges response

application/json

List with specified list_id does not exist response

application/json

Internal server error response

application/json

Examples

Request Console 1 / 2 languages

Console Kibana Dev Tools

POST /api/lists/items/_import
{
  "file": "list_values.txt"
}

curl Shell

curl -X POST "https://{kibana_url}/api/lists/items/_import" \
  -H "Content-Type: multipart/form-data" \
  -d '{
  "file": "list_values.txt"
}'

Response

{
  "_version": "WzAsMV0=",
  "@timestamp": "2025-01-08T04:47:34.273Z",
  "created_at": "2025-01-08T04:47:34.273Z",
  "created_by": "elastic",
  "description": "This list describes bad internet ip",
  "id": "ip_list",
  "immutable": false,
  "name": "Simple list with an ip",
  "tie_breaker_id": "f5508188-b1e9-4e6e-9662-d039a7d89899",
  "type": "ip",
  "updated_at": "2025-01-08T04:47:34.273Z",
  "updated_by": "elastic",
  "version": 1
}

{
  "message": "Either type or list_id need to be defined in the query",
  "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 [POST /api/lists/items/_import?list_id=ip_list] is unauthorized for user, this action is granted by the Kibana privileges [lists-all]",
  "statusCode": 403
}

{
  "message": "List with the specified list_id does not exist, create the list or fix list_id to import to an existing one",
  "status_code": 409
}

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

Query Parameters { list_id , type , refresh , }

Request

Responses

Query Parameters