Query parameters

• list_id string(nonempty) Required

  Parent value list's id to page through items for.

  Minimum length is 1.

• page integer

  The page number to return.

• per_page integer

  The number of list items to return per page.

• sort_field string(nonempty)

  Determines which field is used to sort the results.

  Minimum length is 1.

• sort_order string

  Determines the sort order, which can be desc or asc

  Values are desc or asc.

• cursor string(nonempty)

  Opaque cursor returned in a previous response; pass it to continue listing from the next page. Omit on the first request.

  Minimum length is 1.

• filter string

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

Responses

• 200 application/json

  Successful response

  Hide response attributes Show response attributes object

  • cursor string(nonempty) Required

    Returns the items that come after the last item 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 items are sorted and returned correctly.

    Minimum length is 1.

  • data array[object] Required
    Hide data attributes Show data attributes object

    • _version string

      The version id, normally returned by the API when the document is retrieved. Use it ensure updates are done against the latest version.

    • @timestamp string(date-time)
    • created_at string(date-time) Required

      Autogenerated date of object creation.

    • created_by string Required

      Autogenerated value - user that created object.

    • id string(nonempty) Required

      Value list item's identifier.

      Minimum length is 1.

    • list_id string(nonempty) Required

      Value list's identifier.

      Minimum length is 1.

    • meta object

      Placeholder for metadata about the value list item.

      Additional properties are allowed.

    • tie_breaker_id string Required

      Field used in search to ensure all containers are sorted and returned correctly.

    • type string Required

      Specifies the Elasticsearch data type of excludes the list container holds. Some common examples:

      • keyword: Many ECS fields are Elasticsearch keywords
      • ip: IP addresses
      • ip_range: Range of IP addresses (supports IPv4, IPv6, and CIDR notation)

      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

      Autogenerated date of last object update.

    • updated_by string Required

      Autogenerated value - user that last updated object.

    • value string(nonempty) Required

      The value used to evaluate exceptions.

      Minimum length is 1.

  • 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

  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

  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
• 500 application/json

  Internal server error response

  Hide response attributes Show response attributes object

  • message string Required
  • status_code integer Required