Query parameters

• list_id string Required

  List's id

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

• page integer

  The page number to return

• per_page integer

  The number of list items to return per page

• sort_field string

  Determines which field is used to sort the results

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

• sort_order string

  Determines the sort order, which can be desc or asc

  Values are desc or asc.

• cursor string

  Returns the list that come after the last list returned in the previous call (use the cursor value returned in the previous call). This parameter uses the tie_breaker_id field to ensure all lists are sorted and returned correctly.

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

• filter string

  Filters the returned results according to the value of the specified field, using the : syntax.

Responses

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

  Successful response

  Hide response attributes Show response attributes object

  • cursor string Required

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

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

  • data array[object] Required
    Hide data attributes Show data 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
      Hide meta attribute Show meta attribute 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: ^(?! *$).+$.

  • page integer Required

    Minimum value is 0.

  • per_page integer Required

    Minimum value is 0.

  • total integer Required

    Minimum value is 0.

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

  Invalid input data response

  One of:

  Security_Solution_Lists_API_PlatformErrorResponse object Security_Solution_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
• 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