IMPORTANT: No additional bug fixes or documentation updates will be released for this version. For the latest information, see the current release documentation.

« Create list item Find list containers »

› › ›

Import list items

edit

IMPORTANT: This documentation is no longer updated. Refer to Elastic's version policy and the latest documentation.

Import list items

edit

Imports a list of 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 container.

Request URL

edit

POST <kibana host>:<port>/api/lists/items/_import

The request must include:

The Content-Type: multipart/form-data HTTP header.
A link to the file containing the list items.

For example, using cURL:

curl -X POST "<kibana host>:<port>/api/lists/items/_import"
-u <username>:<password> -H 'kbn-xsrf: true'
-H 'Content-Type: multipart/form-data'
--form "file=@<link to file>"

The relative link to the file containing the list items.

URL query parameters

edit

Name	Type	Description	Required
`list_id`	String	ID of the list container.	Required when importing to an existing container.
`type`	String	The datatype of excludes the list container holds, which can be either `ip` or `keyword`.	Required when importing to a new container.

Example requests

edit

Adds the IP addresses in the internal-IPs.txt to the internal-ip-excludes list container:

curl -X POST "api/lists/items/_import?list_id=internal-ip-excludes"
-H 'kbn-xsrf: true' -H 'Content-Type: multipart/form-data'
--form "[email protected]"

Adds the IP addresses in the internal-IPs.txt to a new list container:

curl -X POST "api/lists/items/_import?type=ip"
-H 'kbn-xsrf: true' -H 'Content-Type: multipart/form-data'
--form "[email protected]"

Response code

edit

200: Indicates a successful call.

Response payload

edit

{
  "_version": "WzcsMV0=",
  "id": "internal-ip-excludes",
  "created_at": "2020-08-11T10:38:51.087Z",
  "created_by": "elastic",
  "description": "Contains list items that exclude internal IP addresses from detection rule matches.",
  "immutable": false,
  "name": "Trusted internal IP addresses",
  "tie_breaker_id": "195f54fb-244d-4f9a-9a5b-e728901347e0",
  "type": "ip",
  "updated_at": "2020-08-11T10:42:30.205Z",
  "updated_by": "elastic",
  "version": 1
}

« Create list item Find list containers »