Import list items
Import 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
-
list_id string
List's id.
Required when importing to an existing list.
Minimum length is
1
. Format should match the following pattern:^(?! *$).+$
. -
type string
Type of the importing list.
Required when importing a new list that is
list_id
is not specified.Values are
binary
,boolean
,byte
,date
,date_nanos
,date_range
,double
,double_range
,float
,float_range
,geo_point
,geo_shape
,half_float
,integer
,integer_range
,ip
,ip_range
,keyword
,long
,long_range
,shape
,short
, ortext
. -
serializer string
-
deserializer string
-
refresh string
Determines when changes made by the request are made visible to search
Values are
true
,false
, orwait_for
.
Responses
-
200 application/json; Elastic-Api-Version=2023-10-31
Successful response
-
400 application/json; Elastic-Api-Version=2023-10-31
Invalid input data response
-
401 application/json; Elastic-Api-Version=2023-10-31
Unsuccessful authentication response
-
403 application/json; Elastic-Api-Version=2023-10-31
Not enough privileges response
-
409 application/json; Elastic-Api-Version=2023-10-31
List with specified list_id does not exist response
-
500 application/json; Elastic-Api-Version=2023-10-31
Internal server error response
curl \
-X POST https://localhost:5601/api/lists/items/_import \
-H "Content-Type: multipart/form-data; Elastic-Api-Version=2023-10-31"
{
"_version": "string",
"@timestamp": "2024-05-04T09:42:00+00:00",
"created_at": "2024-05-04T09:42:00+00:00",
"created_by": "string",
"description": "string",
"deserializer": "string",
"id": "string",
"immutable": true,
"meta": {},
"name": "string",
"serializer": "string",
"tie_breaker_id": "string",
"type": "binary",
"updated_at": "2024-05-04T09:42:00+00:00",
"updated_by": "string",
"version": 42
}
{
"error": "string",
"message": "string",
"statusCode": 42
}
{
"message": "string",
"status_code": 42
}
{
"error": "string",
"message": "string",
"statusCode": 42
}
{
"error": "string",
"message": "string",
"statusCode": 42
}
{
"message": "string",
"status_code": 42
}
{
"message": "string",
"status_code": 42
}