Query parameters

• list_id array Required

  List's id

  Minimum length of each is 1.

• filter array

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

  Minimum length of each is 1. Default value is [] (empty).

• namespace_type array[string]

  Determines whether the returned containers are Kibana associated with a Kibana space or available in all spaces (agnostic or single)

  Values are agnostic or single. Default value is ["single"].

• search string
• page integer

  The page number to return

  Minimum value is 0.

• per_page integer

  The number of exception list items to return per page

  Minimum value is 0.

• 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.

Responses

• 200 application/json

  Successful response

  Hide response attributes Show response attributes object

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

    • _version string
    • comments array[object] Required
      Hide comments attributes Show comments attributes object

      • comment string(nonempty) Required

        A string that does not contain only whitespace characters

        Minimum length is 1.

      • created_at string(date-time) Required
      • created_by 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.

      • updated_at string(date-time)
      • updated_by string(nonempty)

        A string that does not contain only whitespace characters

        Minimum length is 1.

    • created_at string(date-time) Required
    • created_by string Required
    • description string Required
    • entries array[object] Required
      Any of:

      Security_Exceptions_API_ExceptionListItemEntryMatch object Security_Exceptions_API_ExceptionListItemEntryMatchAny object Security_Exceptions_API_ExceptionListItemEntryList object Security_Exceptions_API_ExceptionListItemEntryExists object Security_Exceptions_API_ExceptionListItemEntryNested object Security_Exceptions_API_ExceptionListItemEntryMatchWildcard object

      Hide attributes Show attributes

      • field string(nonempty) Required

        A string that does not contain only whitespace characters

        Minimum length is 1.

      • operator string Required

        Values are excluded or included.

      • type string Required Discriminator
      • value string(nonempty) Required

        A string that does not contain only whitespace characters

        Minimum length is 1.

      Hide attributes Show attributes

      • field string(nonempty) Required

        A string that does not contain only whitespace characters

        Minimum length is 1.

      • operator string Required

        Values are excluded or included.

      • type string Required Discriminator
      • value array[string(nonempty)] Required

        A string that does not contain only whitespace characters

        At least 1 element. Minimum length of each is 1.

      Hide attributes Show attributes

      • field string(nonempty) Required

        A string that does not contain only whitespace characters

        Minimum length is 1.

      • list object Required
        Hide list attributes Show list attributes object

        • id string(nonempty) Required

          A string that does not contain only whitespace characters

          Minimum length is 1.

        • 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.

      • operator string Required

        Values are excluded or included.

      • type string Required Discriminator

      Hide attributes Show attributes

      • field string(nonempty) Required

        A string that does not contain only whitespace characters

        Minimum length is 1.

      • operator string Required

        Values are excluded or included.

      • type string Required Discriminator

      Hide attributes Show attributes

      • entries array[object] Required

        At least 1 element.

        One of:

        Security_Exceptions_API_ExceptionListItemEntryMatch object Security_Exceptions_API_ExceptionListItemEntryMatchAny object Security_Exceptions_API_ExceptionListItemEntryExists object

        Hide attributes Show attributes

        • field string(nonempty) Required

          A string that does not contain only whitespace characters

          Minimum length is 1.

        • operator string Required

          Values are excluded or included.

        • type string Required

          Value is match.

        • value string(nonempty) Required

          A string that does not contain only whitespace characters

          Minimum length is 1.

        Hide attributes Show attributes

        • field string(nonempty) Required

          A string that does not contain only whitespace characters

          Minimum length is 1.

        • operator string Required

          Values are excluded or included.

        • type string Required

          Value is match_any.

        • value array[string(nonempty)] Required

          A string that does not contain only whitespace characters

          At least 1 element. Minimum length of each is 1.

        Hide attributes Show attributes

        • field string(nonempty) Required

          A string that does not contain only whitespace characters

          Minimum length is 1.

        • operator string Required

          Values are excluded or included.

        • type string Required

          Value is exists.

      • field string(nonempty) Required

        A string that does not contain only whitespace characters

        Minimum length is 1.

      • type string Required Discriminator

      Hide attributes Show attributes

      • field string(nonempty) Required

        A string that does not contain only whitespace characters

        Minimum length is 1.

      • operator string Required

        Values are excluded or included.

      • type string Required Discriminator
      • value string(nonempty) Required

        A string that does not contain only whitespace characters

        Minimum length is 1.

    • expire_time string(date-time)
    • id string(nonempty) Required

      A string that does not contain only whitespace characters

      Minimum length is 1.

    • item_id string(nonempty) Required

      A string that does not contain only whitespace characters

      Minimum length is 1.

    • list_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.

    • namespace_type string Required

      Determines whether the exception container is available in all Kibana spaces or just the space in which it is created, where:

      • single: Only available in the Kibana space in which it is created.
      • agnostic: Available in all Kibana spaces.

      Values are agnostic or single.

    • os_types array[string]

      Values are linux, macos, or windows.

    • tags array[string(nonempty)]

      A string that does not contain only whitespace characters

      Minimum length of each is 1.

    • tie_breaker_id string Required
    • type string Required

      Value is simple.

    • updated_at string(date-time) Required
    • updated_by string Required
  • page integer Required

    Minimum value is 1.

  • per_page integer Required

    Minimum value is 1.

  • pit string
  • total integer Required

    Minimum value is 0.

• 400 application/json

  Invalid input data response

  One of:

  Security_Exceptions_API_PlatformErrorResponse object Security_Exceptions_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
• 404 application/json

  Exception 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