Update a list

PUT /api/lists

Update a list using the list ID. The original list is replaced, and all unspecified fields are deleted.

You cannot modify the id value.

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

Body Required

List's properties

_version string
description string Required

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

Minimum length is 1. Format should match the following pattern: ^(?! *$).+$.
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.
name string Required

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

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

Minimum value is 1.

Responses

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

Successful response
Hide response attributes Show response attributes object
- _version string
- @timestamp string(date-time)
- created_at string(date-time) Required
- created_by string Required
- description string Required
  
  A string that is not empty and does not contain only whitespace
  
  Minimum length is 1. Format should match the following pattern: ^(?! *$).+$.
- 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: ^(?! *$).+$.
- immutable boolean Required
- meta object
  
  Additional properties are allowed.
- name string Required
  
  A string that is not empty and does not contain only whitespace
  
  Minimum length is 1. Format should match the following pattern: ^(?! *$).+$.
- 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
- version integer Required
  
  Minimum value is 1.
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 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

PUT /api/lists

curl \
 -X PUT https://localhost:5601/api/lists \
 -H "Content-Type: application/json; Elastic-Api-Version=2023-10-31"

Request examples

{
  "_version": "string",
  "description": "string",
  "id": "string",
  "meta": {},
  "name": "string",
  "version": 42
}

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",
  "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
}

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
}