Create a list

Base URL: https://{kibana_url}

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

Refer to Spaces for more information.

Create a new list.

Authentication

Api key

Authorization: <value>

These APIs use key-based authentication. You must create an API key and use the encoded value in the request header. For example: Authorization: ApiKey base64AccessApiKey

Basic

Authorization: Basic <credentials>

Request body

Responses

Successful response

application/json

Invalid input data response

application/json

Unsuccessful authentication response

application/json

Not enough privileges response

application/json

List already exists response

application/json

Internal server error response

application/json

Base URL: https://{kibana_url}

Examples

Request Console 1 / 2 languages

Console Kibana Dev Tools

POST kbn:/api/lists
{
  "description": "This list describes bad internet ips",
  "id": "ip_list",
  "name": "Simple list with ips",
  "type": "ip"
}

Generated from the API spec

curl Shell

curl -X POST "${KIBANA_URL}/api/lists" \
  -H "Authorization: ApiKey ${API_KEY}" \
  -H "Content-Type: application/json" \
  -d '{
    "description": "This list describes bad internet ips",
    "id": "ip_list",
    "name": "Simple list with ips",
    "type": "ip"
  }'

Generated from the API spec

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 ips",
  "id": "ip_list",
  "immutable": false,
  "name": "Simple list with ips",
  "tie_breaker_id": "f5508188-b1e9-4e6e-9662-d039a7d89899",
  "type": "ip",
  "updated_at": "2025-01-08T04:47:34.273Z",
  "updated_by": "elastic",
  "version": 1
}

Request Console 1 / 2 languages

Console Kibana Dev Tools

POST kbn:/api/lists
{
  "description": "This list has ip ranges",
  "id": "ip_range_list",
  "name": "Simple list with ip ranges",
  "type": "ip_range"
}

Generated from the API spec

curl Shell

curl -X POST "${KIBANA_URL}/api/lists" \
  -H "Authorization: ApiKey ${API_KEY}" \
  -H "Content-Type: application/json" \
  -d '{
    "description": "This list has ip ranges",
    "id": "ip_range_list",
    "name": "Simple list with ip ranges",
    "type": "ip_range"
  }'

Generated from the API spec

Response

{
  "_version": "WzAsMV0=",
  "@timestamp": "2025-01-09T18:23:52.241Z",
  "created_at": "2025-01-09T18:23:52.241Z",
  "created_by": "elastic",
  "description": "This list has ip ranges",
  "id": "ip_range_list",
  "immutable": false,
  "name": "Simple list with ip ranges",
  "tie_breaker_id": "74aebdaf-601f-4940-b351-155728ff7003",
  "type": "ip_range",
  "updated_at": "2025-01-09T18:23:52.241Z",
  "updated_by": "elastic",
  "version": 1
}

Request Console 1 / 2 languages

Console Kibana Dev Tools

POST kbn:/api/lists
{
  "description": "This list describes bad host names",
  "id": "keyword_list",
  "name": "Simple list with a keyword",
  "type": "keyword"
}

Generated from the API spec

curl Shell

curl -X POST "${KIBANA_URL}/api/lists" \
  -H "Authorization: ApiKey ${API_KEY}" \
  -H "Content-Type: application/json" \
  -d '{
    "description": "This list describes bad host names",
    "id": "keyword_list",
    "name": "Simple list with a keyword",
    "type": "keyword"
  }'

Generated from the API spec

Response

{
  "_version": "WzEsMV0=",
  "@timestamp": "2025-01-09T18:24:55.786Z",
  "created_at": "2025-01-09T18:24:55.786Z",
  "created_by": "elastic",
  "description": "This list describes bad host names",
  "id": "keyword_list",
  "immutable": false,
  "name": "Simple list with a keyword",
  "tie_breaker_id": "f7e7dbaa-daf7-4c9a-a3dc-56643923ef68",
  "type": "keyword",
  "updated_at": "2025-01-09T18:24:55.786Z",
  "updated_by": "elastic",
  "version": 1
}

Request Console 1 / 2 languages

Console Kibana Dev Tools

POST kbn:/api/lists
{
  "description": "This parses the first found ipv4 only",
  "id": "keyword_custom_format_list",
  "name": "Simple list with a keyword using a custom format",
  "type": "keyword"
}

Generated from the API spec

curl Shell

curl -X POST "${KIBANA_URL}/api/lists" \
  -H "Authorization: ApiKey ${API_KEY}" \
  -H "Content-Type: application/json" \
  -d '{
    "description": "This parses the first found ipv4 only",
    "id": "keyword_custom_format_list",
    "name": "Simple list with a keyword using a custom format",
    "type": "keyword"
  }'

Generated from the API spec

Response

{
  "_version": "WzIsMV0=",
  "@timestamp": "2025-01-09T18:25:39.604Z",
  "created_at": "2025-01-09T18:25:39.604Z",
  "created_by": "elastic",
  "description": "This parses the first found ipv4 only",
  "id": "keyword_custom_format_list",
  "immutable": false,
  "name": "Simple list with a keyword using a custom format",
  "tie_breaker_id": "8247ae63-b780-47b8-9a89-948b643e9ec2",
  "type": "keyword",
  "updated_at": "2025-01-09T18:25:39.604Z",
  "updated_by": "elastic",
  "version": 1
}

Authentication

Request body { }

Responses

Request body