---
type: api
title: Create a list item
description: **Spaces method and path for this operation:**
url: https://www.elastic.co/elastic/docs-builder/docs/4641/api/doc/kibana/v8/operation/operation-createlistitem
resource: https://www.elastic.co/elastic/docs-builder/docs/4641/api/doc/kibana/v8/operation/operation-createlistitem
products:
  - Kibana
---

# Create a list item

Authentication: required

- Server: `https://{kibana_url}`

## Paths

- `POST` `/api/lists/items`
- `POST` `/s/{space_id}/api/lists/items`

#### Path parameters

- `space_id` (string) — optional
  An identifier for the space. If `space_id` is not provided in the URL, the default space is used. Refer to [Spaces](https://www.elastic.co/docs/deploy-manage/manage-spaces) for more information.

## Description

Create a list item and associate it with the specified list.

All list items in the same list must be the same type. For example, each list item in an `ip` list must define a specific IP address.
> info
> Before creating a list item, you must create a list.

## Request body

List item's properties

`application/json`

- `id` (string · format: nonempty · min length: 1) — optional
  A string that does not contain only whitespace characters
- `list_id` (string · format: nonempty · min length: 1) — required
  A string that does not contain only whitespace characters
- `meta` (object) — optional
- `refresh` (enum) — optional
  Determines when changes made by the request are made visible to search
  Values: `true`, `false`, `wait_for`
- `value` (string · format: nonempty · min length: 1) — required
  A string that does not contain only whitespace characters

## Responses

#### `200`

Successful response

`application/json`

- `_version` (string)
- `@timestamp` (string · format: date-time)
- `created_at` (string · format: date-time)
- `created_by` (string)
- `id` (string · format: nonempty · min length: 1)
  A string that does not contain only whitespace characters
- `list_id` (string · format: nonempty · min length: 1)
  A string that does not contain only whitespace characters
- `meta` (object)
- `tie_breaker_id` (string)
- `type` (enum)
  Values: `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`, `text`
- `updated_at` (string · format: date-time)
- `updated_by` (string)
- `value` (string · format: nonempty · min length: 1)
  A string that does not contain only whitespace characters
#### `400`

Invalid input data response

`application/json`

One of:
- **PlatformErrorResponse**
  - `error` (string)
  - `message` (string)
  - `statusCode` (integer)
- **SiemErrorResponse**
  - `message` (string)
  - `status_code` (integer)
#### `401`

Unsuccessful authentication response

`application/json`

- `error` (string)
- `message` (string)
- `statusCode` (integer)
#### `403`

Not enough privileges response

`application/json`

- `error` (string)
- `message` (string)
- `statusCode` (integer)
#### `409`

List item already exists response

`application/json`

- `message` (string)
- `status_code` (integer)
#### `500`

Internal server error response

`application/json`

- `message` (string)
- `status_code` (integer)
## Code examples

#### Console

```console
POST kbn:/api/lists/items
{
  "list_id": "string",
  "value": "string"
}
```

#### curl

```curl
curl -X POST "${KIBANA_URL}/api/lists/items" \
  -H "Authorization: ApiKey ${API_KEY}" \
  -H "Content-Type: application/json" \
  -d '{
    "list_id": "string",
    "value": "string"
  }'
```

## Response examples

#### 200

`application/json`

Generated from the API spec. Values are representative. Unions use the first variant; deeply nested or large bodies may omit fields.

```json
{
  "_version": "string",
  "@timestamp": "string",
  "created_at": "string",
  "created_by": "string",
  "id": "string",
  "list_id": "string",
  "meta": {},
  "tie_breaker_id": "string",
  "type": "binary",
  "updated_at": "string",
  "updated_by": "string",
  "value": "string"
}
```

#### 400

`application/json`

Generated from the API spec. Values are representative. Unions use the first variant; deeply nested or large bodies may omit fields.

```json
{
  "error": "string",
  "message": "string",
  "statusCode": 0
}
```

#### 401

`application/json`

Generated from the API spec. Values are representative. Unions use the first variant; deeply nested or large bodies may omit fields.

```json
{
  "error": "string",
  "message": "string",
  "statusCode": 0
}
```

#### 403

`application/json`

Generated from the API spec. Values are representative. Unions use the first variant; deeply nested or large bodies may omit fields.

```json
{
  "error": "string",
  "message": "string",
  "statusCode": 0
}
```

#### 409

`application/json`

Generated from the API spec. Values are representative. Unions use the first variant; deeply nested or large bodies may omit fields.

```json
{
  "message": "string",
  "status_code": 0
}
```

#### 500

`application/json`

Generated from the API spec. Values are representative. Unions use the first variant; deeply nested or large bodies may omit fields.

```json
{
  "message": "string",
  "status_code": 0
}
```