Query parameters

• id string(nonempty)

  Either id or item_id must be specified

  Minimum length is 1.

• item_id string(nonempty)

  Either id or item_id must be specified

  Minimum length is 1.

Responses

• 200 application/json

  Successful response

  Hide response attributes Show response attributes object

  • _version string

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

  • comments array[object] Required

    Array of comment fields:

    • comment (string): Comments about the exception item.
    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

      Autogenerated date of object creation.

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

      Autogenerated date of last object update.

    • updated_by string(nonempty)

      A string that does not contain only whitespace characters

      Minimum length is 1.

  • created_at string(date-time) Required

    Autogenerated date of object creation.

  • created_by string Required

    Autogenerated value - user that created object.

  • description string Required

    Describes the exception list.

  • entries array[object] Required
    Any of:

    Security_Endpoint_Exceptions_API_ExceptionListItemEntryMatch object Security_Endpoint_Exceptions_API_ExceptionListItemEntryMatchAny object Security_Endpoint_Exceptions_API_ExceptionListItemEntryList object Security_Endpoint_Exceptions_API_ExceptionListItemEntryExists object Security_Endpoint_Exceptions_API_ExceptionListItemEntryNested object Security_Endpoint_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

        Value list's identifier.

        Minimum length is 1.

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

    • 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_Endpoint_Exceptions_API_ExceptionListItemEntryMatch object Security_Endpoint_Exceptions_API_ExceptionListItemEntryMatchAny object Security_Endpoint_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)

    The exception item’s expiration date, in ISO format. This field is only available for regular exception items, not endpoint exceptions.

  • id string(nonempty) Required

    Exception's identifier.

    Minimum length is 1.

  • item_id string(nonempty) Required

    Human readable string identifier, e.g. trusted-linux-processes

    Minimum length is 1.

  • list_id string(nonempty) Required

    The exception list's human readable string identifier, endpoint_list.

    Minimum length is 1.

  • meta object

    Additional properties are allowed.

  • name string(nonempty) Required

    Exception list name.

    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]

    Use this field to specify the operating system.

    Values are linux, macos, or windows.

  • tags array[string(nonempty)]

    String array containing words and phrases to help categorize exception items.

    Minimum length of each is 1.

  • tie_breaker_id string Required

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

  • type string Required

    Value is simple.

  • updated_at string(date-time) Required

    Autogenerated date of last object update.

  • updated_by string Required

    Autogenerated value - user that last updated object.

• 400 application/json

  Invalid input data

  One of:

  Security_Endpoint_Exceptions_API_PlatformErrorResponse object Security_Endpoint_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

  Hide response attributes Show response attributes object

  • error string Required
  • message string Required
  • statusCode integer Required
• 403 application/json

  Insufficient privileges

  Hide response attributes Show response attributes object

  • error string Required
  • message string Required
  • statusCode integer Required
• 404 application/json

  Endpoint list item not found

  Hide response attributes Show response attributes object

  • message string Required
  • status_code integer Required
• 500 application/json

  Internal server error

  Hide response attributes Show response attributes object

  • message string Required
  • status_code integer Required