Export value list items

Base URL: https://{kibana_url}

POST /api/lists/items/_export

Auth

Export list item values from the specified value list.

Query parameters

list_id string · format: nonempty · min length: 1 required: Value list's id to export.; Example: 21b01cfb-058d-44b9-838c-282be16c91cd

Responses

Successful response

application/ndjson

Response Type: string · format: binary

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

View as Markdown

Base URL: https://{kibana_url}

Examples

Request Console 1 / 2 languages

Console Kibana Dev Tools

POST kbn:/api/lists/items/_export?list_id=21b01cfb-058d-44b9-838c-282be16c91cd

Generated from the API spec

curl Shell

curl -X POST "${KIBANA_URL}/api/lists/items/_export?list_id=21b01cfb-058d-44b9-838c-282be16c91cd" \
  -H "Authorization: ApiKey ${API_KEY}"

Generated from the API spec

Response

0.0.1
0.0.2
0.0.3

{
  "error": "Bad Request\u0022,\u0022message\u0022:\u0022[request query]: list_id: Required",
  "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 [POST /api/lists/items/_export?list_id=ips.txt] is unauthorized for user, this action is granted by the Kibana privileges [lists-read]",
  "statusCode": 403
}

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

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