Delete a list item

DELETE /api/lists/items

Delete a list item using its id, or its list_id and value fields.

Query parameters

id string

Required if list_id and value are not specified

Minimum length is 1. Format should match the following pattern: ^(?! *$).+$.
list_id string

Required if id is not specified

Minimum length is 1. Format should match the following pattern: ^(?! *$).+$.
value string

Required if id is not specified
refresh string

Determines when changes made by the request are made visible to search

Values are true, false, or wait_for. Default value is false.

Responses

200 application/json; Elastic-Api-Version=2023-10-31

Successful response
One of:
Security_Lists_API_ListItem object array-2 array[object]
Hide attributes Show attributes

_version string

@timestamp string(date-time)

created_at string(date-time) Required

created_by string Required

deserializer string

id string Required

A string that is not empty and does not contain only whitespace

Minimum length is 1. Format should match the following pattern: ^(?! *$).+$.

list_id string Required

A string that is not empty and does not contain only whitespace

Minimum length is 1. Format should match the following pattern: ^(?! *$).+$.

meta object

Additional properties are allowed.

serializer string

tie_breaker_id string Required

type string Required

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, or text.

updated_at string(date-time) Required

updated_by string Required

value string Required

A string that is not empty and does not contain only whitespace

Minimum length is 1. Format should match the following pattern: ^(?! *$).+$.
Hide attributes Show attributes object

_version string

@timestamp string(date-time)

created_at string(date-time) Required

created_by string Required

deserializer string

id string Required

A string that is not empty and does not contain only whitespace

Minimum length is 1. Format should match the following pattern: ^(?! *$).+$.

list_id string Required

A string that is not empty and does not contain only whitespace

Minimum length is 1. Format should match the following pattern: ^(?! *$).+$.

meta object

Additional properties are allowed.

serializer string

tie_breaker_id string Required

type string Required

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, or text.

updated_at string(date-time) Required

updated_by string Required

value string Required

A string that is not empty and does not contain only whitespace

Minimum length is 1. Format should match the following pattern: ^(?! *$).+$.
400 application/json; Elastic-Api-Version=2023-10-31

Invalid input data response
One of:
Security_Lists_API_PlatformErrorResponse object Security_Lists_API_SiemErrorResponse object
Hide attributes Show attributes

error string Required

message string Required

statusCode integer Required
Hide attributes Show attributes

message string Required

status_code integer Required
401 application/json; Elastic-Api-Version=2023-10-31

Unsuccessful authentication response
Hide response attributes Show response attributes object
- error string Required
- message string Required
- statusCode integer Required
403 application/json; Elastic-Api-Version=2023-10-31

Not enough privileges response
Hide response attributes Show response attributes object
- error string Required
- message string Required
- statusCode integer Required
404 application/json; Elastic-Api-Version=2023-10-31

List item not found response
Hide response attributes Show response attributes object
- message string Required
- status_code integer Required
500 application/json; Elastic-Api-Version=2023-10-31

Internal server error response
Hide response attributes Show response attributes object
- message string Required
- status_code integer Required

DELETE /api/lists/items

curl \
 -X DELETE https://localhost:5601/api/lists/items

Response examples (200)

{
  "_version": "string",
  "@timestamp": "2024-05-04T09:42:00+00:00",
  "created_at": "2024-05-04T09:42:00+00:00",
  "created_by": "string",
  "deserializer": "string",
  "id": "string",
  "list_id": "string",
  "meta": {},
  "serializer": "string",
  "tie_breaker_id": "string",
  "type": "binary",
  "updated_at": "2024-05-04T09:42:00+00:00",
  "updated_by": "string",
  "value": "string"
}

[
  {
    "_version": "string",
    "@timestamp": "2024-05-04T09:42:00+00:00",
    "created_at": "2024-05-04T09:42:00+00:00",
    "created_by": "string",
    "deserializer": "string",
    "id": "string",
    "list_id": "string",
    "meta": {},
    "serializer": "string",
    "tie_breaker_id": "string",
    "type": "binary",
    "updated_at": "2024-05-04T09:42:00+00:00",
    "updated_by": "string",
    "value": "string"
  }
]

Response examples (400)

{
  "error": "string",
  "message": "string",
  "statusCode": 42
}

{
  "message": "string",
  "status_code": 42
}

Response examples (401)

{
  "error": "string",
  "message": "string",
  "statusCode": 42
}

Response examples (403)

{
  "error": "string",
  "message": "string",
  "statusCode": 42
}

Response examples (404)

{
  "message": "string",
  "status_code": 42
}

Response examples (500)

{
  "message": "string",
  "status_code": 42
}