Create rule exception list items

View as Markdown
POST /api/detection_engine/rules/{id}/exceptions
Api key auth Basic auth

Spaces method and path for this operation:

post /s/{space_id}/api/detection_engine/rules/{id}/exceptions

Refer to Spaces for more information.

Create exception items that apply to a single detection rule.

Path parameters

  • id string(uuid)

    Detection rule's identifier

application/json

Body Required

Rule exception list items

  • items array[object] Required
    Hide items attributes Show items attributes object
    • comments array[object]
      Hide comments attribute Show comments attribute object
      • comment string(nonempty) Required

        A string that does not contain only whitespace characters

        Minimum length is 1.

    • 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
    • expire_time string(date-time)
    • item_id string(nonempty)

      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

      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.

    • type string Required

      Value is simple.

Responses

  • 200 application/json

    Successful response

    Hide response attributes Show response 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
    • 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
  • 400 application/json

    Invalid input data response

    One of:
    Security_Exceptions_API_PlatformErrorResponse object Security_Exceptions_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
  • 500 application/json

    Internal server error response

    Hide response attributes Show response attributes object
    • message string Required
    • status_code integer Required
POST /api/detection_engine/rules/{id}/exceptions 
curl \
 --request POST 'https://localhost:5601/api/detection_engine/rules/{id}/exceptions' \
 --header "Authorization: $API_KEY" \
 --header "Content-Type: application/json" \
 --data '{"items":[{"comments":[{"comment":"string"}],"description":"string","entries":[{"field":"string","operator":"excluded","type":"string","value":"string"}],"expire_time":"2025-05-04T09:42:00Z","item_id":"string","meta":{},"name":"string","namespace_type":"agnostic","os_types":["linux"],"tags":["string"],"type":"simple"}]}'