Update a list

PUT /api/lists
Api key auth Basic auth

Spaces method and path for this operation:

put /s/{space_id}/api/lists

Refer to Spaces for more information.

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

Body Required

List's properties

  • _version string
  • description string(nonempty) Required

    A string that does not contain only whitespace characters

    Minimum length is 1.

  • id string(nonempty) Required

    A string that does not contain only whitespace characters

    Minimum length is 1.

  • meta object

    Additional properties are allowed.

  • name string(nonempty) Required

    A string that does not contain only whitespace characters

    Minimum length is 1.

  • version integer

    Minimum value is 1.

Responses

  • 200 application/json

    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(nonempty) Required

      A string that does not contain only whitespace characters

      Minimum length is 1.

    • deserializer string
    • id string(nonempty) Required

      A string that does not contain only whitespace characters

      Minimum length is 1.

    • immutable boolean Required
    • meta object

      Additional properties are allowed.

    • name string(nonempty) Required

      A string that does not contain only whitespace characters

      Minimum length is 1.

    • 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

    Invalid input data response

    One of:
    Security_Lists_API_PlatformErrorResponse object Security_Lists_API_SiemErrorResponse object
  • 401 application/json

    Unsuccessful authentication response

    Hide response attributes Show response attributes object
    • error string Required
    • message string Required
    • statusCode integer Required
  • 403 application/json

    Not enough privileges response

    Hide response attributes Show response attributes object
    • error string Required
    • message string Required
    • statusCode integer Required
  • 404 application/json

    List not found response

    Hide response attributes Show response attributes object
    • message string Required
    • status_code integer Required
  • 500 application/json

    Internal server error response

    Hide response attributes Show response attributes object
    • message string Required
    • status_code integer Required
PUT /api/lists 
curl \
 --request PUT 'https://localhost:5601/api/lists' \
 --header "Authorization: $API_KEY" \
 --header "Content-Type: application/json" \
 --data '{"_version":"string","description":"string","id":"string","meta":{},"name":"string","version":42}'