Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Kibana Security Exceptions API API

Exceptions are associated with detection and endpoint rules, and are used to prevent a rule from generating an alert from incoming events, even when the rule's other criteria are met. They can help reduce the number of false positives and prevent trusted processes and network activity from generating unnecessary alerts.Exceptions are made up of:* **Exception containers**: A container for related exceptions. Generally, a single exception container contains all the exception items relevant for a subset of rules. For example, a container can be used to group together network-related exceptions that are relevant for a large number of network rules. The container can then be associated with all the relevant rules.* **Exception items**: The query (fields, values, and logic) used to prevent rules from generating alerts. When an exception item's query evaluates to `true`, the rule does not generate an alert.For detection rules, you can also use lists to define rule exceptions. A list holds multiple values of the same Elasticsearch data type, such as IP addresses. These values are used to determine when an exception prevents an alert from being generated.> info> You cannot use lists with endpoint rule exceptions.> info> Only exception containers can be associated with rules. You cannot directly associate an exception item or a list container with a rule. To use list exceptions, create an exception item that references the relevant list container.## Exceptions requirementsBefore you can start working with exceptions that use value lists, you must create the `.lists` and `.items` data streams for the relevant Kibana space. To do this, use the [Create list data streams](../operation/operation-createlistindex) endpoint. Once these data streams are created, your role needs privileges to manage rules. For a complete list of requirements, refer to [Enable and access detections](https://www.elastic.co/guide/en/security/current/detections-permissions-section.html#enable-detections-ui).

Kibana Security Exceptions API API is one of 60 APIs that Kibana publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Security Exceptions API. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and authentication docs.

This API exposes 16 operations across 10 paths, and defines 97 schemas. It is described by OpenAPI 3.0.3.

Requests are made against a single base URL, https://{kibana_url}.

16 operations 10 paths 97 schemas 2 DELETE5 GET7 POST2 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.3
Base URL
https://localhost:5601/api
Authentication
API Key, HTTP Basic
Contact
Kibana Team
Resource Areas
1

Authentication & Security 2

Kibana Security Exceptions API API declares 2 security schemes for authenticating requests. An API key is passed in the header as Authorization (apiKeyAuth). It accepts HTTP basic authentication (basicAuth). By default, every request must be authenticated.

  • apiKeyAuth — These APIs use key-based authentication. You must create an API key and use the encoded value in the request header. For example: Authorization: ApiKey base64A…

Paths & Operations 16

Across 10 paths, the API surfaces 16 operations — 2 DELETE, 5 GET, 7 POST, 2 PUT. Each is listed below with its method, path, parameters, and response codes.

Security Exceptions API 16

Exceptions are associated with detection and endpoint rules, and are used to prevent a rule from generating an alert from incoming events, even when the rule's other criteria are…

POST
/api/detection_engine/rules/{id}/exceptions
Create rule exception items
CreateRuleExceptionListItems 1 param body → 200400401403500
DELETE
/api/exception_lists
Delete an exception list
DeleteExceptionList 3 params → 200400401403404500
GET
/api/exception_lists
Get exception list details
ReadExceptionList 3 params → 200400401403404500
POST
/api/exception_lists
Create an exception list
CreateExceptionList body → 200400401403409500
PUT
/api/exception_lists
Update an exception list
UpdateExceptionList body → 200400401403404500
POST
/api/exception_lists/_duplicate
Duplicate an exception list
DuplicateExceptionList 3 params → 200400401403404405500
POST
/api/exception_lists/_export
Export an exception list
ExportExceptionList 4 params → 200400401403404500
GET
/api/exception_lists/_find
Get exception lists
FindExceptionLists 6 params → 200400401403500
POST
/api/exception_lists/_import
Import an exception list
ImportExceptionList 2 params body → 200400401403500
DELETE
/api/exception_lists/items
Delete an exception list item
DeleteExceptionListItem 3 params → 200400401403404500
GET
/api/exception_lists/items
Get an exception list item
ReadExceptionListItem 3 params → 200400401403404500
POST
/api/exception_lists/items
Create an exception list item
CreateExceptionListItem body → 200400401403409500
PUT
/api/exception_lists/items
Update an exception list item
UpdateExceptionListItem body → 200400401403404500
GET
/api/exception_lists/items/_find
Get exception list items
FindExceptionListItems 8 params → 200400401403404500
GET
/api/exception_lists/summary
Get an exception list summary
ReadExceptionListSummary 4 params → 200400401403404500
POST
/api/exceptions/shared
Create a shared exception list
CreateSharedExceptionList body → 200400401403409500

Schemas 97

The contract defines 97 schemas that model the data the API accepts and returns. The most detailed are Security_Exceptions_API_ExceptionListItem (19 properties), Security_Exceptions_API_ExceptionList (17 properties), Security_Exceptions_API_CreateRuleExceptionListItemProps (11 properties), Security_Exceptions_API_UpdateExceptionListItemBase (10 properties). Each schema is shown below with its type and property counts.

Security_Exceptions_API_UpdateExceptionListItemEventFilters
Security_Exceptions_API_ExceptionListItemEntryMatchAny
object
4 properties 4 required
Security_Exceptions_API_ExceptionListTags
array
String array containing words and phrases to help categorize exception containers.
Security_Exceptions_API_TrustedDevicesWindowsMacProperties
object
Trusted devices list item properties (Windows + macOS, username not supported).
4 properties 1 required
Security_Exceptions_API_UpdateExceptionListItemTrustedAppsLinux
Security_Exceptions_API_PlatformErrorResponse
object
3 properties 3 required
Security_Exceptions_API_CreateExceptionListItemTrustedAppsMac
Security_Exceptions_API_CreateRuleExceptionListItemProps
object
11 properties 4 required
Security_Exceptions_API_BlocklistWindowsCodeSignatureEntry
object
3 properties 3 required
Security_Exceptions_API_CreateExceptionListItemTrustedDevicesWindows
Security_Exceptions_API_UpdateExceptionListItemCommentArray
array
Security_Exceptions_API_UUID
string
A universally unique identifier
Security_Exceptions_API_ExceptionNamespaceType
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 K…
Security_Exceptions_API_CreateExceptionListItemTrustedAppsLinux
Security_Exceptions_API_ExceptionListItemEntryOperator
string
Security_Exceptions_API_UpdateExceptionListItemGeneric
Security_Exceptions_API_ExceptionListItemHumanId
string
Human readable string identifier, e.g. trusted-linux-processes
Security_Exceptions_API_UpdateExceptionListItemBase
object
10 properties 3 required
Security_Exceptions_API_CreateRuleExceptionListItemCommentArray
array
Security_Exceptions_API_ExceptionListItemId
string
Exception's identifier.
Security_Exceptions_API_BlocklistWindowsProperties
object
Blocklist list item properties (Windows, supports code signature).
4 properties 1 required
Security_Exceptions_API_UpdateExceptionListItemTrustedDevicesMac
Security_Exceptions_API_UpdateExceptionListItemHostIsolation
Security_Exceptions_API_CreateExceptionListItemTrustedAppsWindows
Security_Exceptions_API_UpdateExceptionListItemBlocklistLinux
Security_Exceptions_API_ExceptionListItemEntryMatch
object
4 properties 4 required
Security_Exceptions_API_HostIsolationProperties
object
Host isolation exceptions list item properties.
4 properties 1 required
Security_Exceptions_API_ExceptionListItemEntryArray
array
Security_Exceptions_API_ExceptionListOsTypeArray
array
Use this field to specify the operating system. Only enter one value.
Security_Exceptions_API_NonEmptyString
string
A string that does not contain only whitespace characters
Security_Exceptions_API_ExceptionListItemEntryNestedEntryItem
Security_Exceptions_API_UpdateExceptionListItemBlocklistWindows
Security_Exceptions_API_BlocklistHashOrPathEntry
object
4 properties 4 required
Security_Exceptions_API_SiemErrorResponse
object
2 properties 2 required
Security_Exceptions_API_ExceptionListItemEntryMatchWildcard
object
4 properties 4 required
Security_Exceptions_API_ExceptionListOsType
string
Use this field to specify the operating system.
Security_Exceptions_API_UpdateExceptionListItemTrustedDevicesWindowsMac
Security_Exceptions_API_ExceptionListItemMeta
object
Security_Exceptions_API_CreateExceptionListItemCommentArray
array
Security_Exceptions_API_ListType
string
Specifies the Elasticsearch data type of excludes the list container holds. Some common examples: - keyword: Many ECS fields are Elasticsearch keywords - ip: I…
Security_Exceptions_API_TrustedDevicesWindowsProperties
object
Trusted devices list item properties (Windows-only, allows username field).
4 properties 1 required
Security_Exceptions_API_EventFiltersProperties
object
Event filters list item properties.
4 properties 1 required
Security_Exceptions_API_EndpointListProperties
object
Elastic Endpoint exception list item properties.
4 properties 1 required
Security_Exceptions_API_ExceptionListVersion
integer
The document version, automatically increasd on updates.
Security_Exceptions_API_CreateExceptionListItemTrustedDevicesMac
Security_Exceptions_API_ExceptionListDescription
string
Describes the exception list.
Security_Exceptions_API_ExceptionListItemExpireTime
string
The exception item’s expiration date, in ISO format. This field is only available for regular exception items, not endpoint exceptions.
Security_Exceptions_API_CreateExceptionListItemTrustedDevicesWindowsMac
Security_Exceptions_API_ExceptionListName
string
The name of the exception list.
Security_Exceptions_API_ExceptionListItemCommentArray
array
Array of comment fields: - comment (string): Comments about the exception item.
Security_Exceptions_API_TrustedAppsWindowsProperties
object
Trusted applications list item properties (Windows).
4 properties 1 required
Security_Exceptions_API_CreateExceptionListItemBlocklistMac
Security_Exceptions_API_FindExceptionListsFilter
string
Security_Exceptions_API_TrustedAppPathEntry
object
4 properties 4 required
Security_Exceptions_API_CreateExceptionListItemHostIsolation
Security_Exceptions_API_UpdateExceptionListItemComment
object
2 properties 1 required
Security_Exceptions_API_TrustedAppWindowsCodeSignatureEntry
object
3 properties 3 required
Security_Exceptions_API_ExceptionListItemComment
object
6 properties 4 required
Security_Exceptions_API_CreateRuleExceptionListItemComment
object
1 property 1 required
Security_Exceptions_API_ExceptionListItemType
string
Security_Exceptions_API_ExceptionListItemEntry
Security_Exceptions_API_ExceptionListItemEntryList
object
4 properties 4 required
Security_Exceptions_API_UpdateExceptionListItemTrustedAppsMac
Security_Exceptions_API_ExceptionListsImportBulkError
object
4 properties 1 required
Security_Exceptions_API_UpdateExceptionListItemTrustedDevicesWindows
Security_Exceptions_API_CreateExceptionListItemEventFilters
Security_Exceptions_API_CreateExceptionListItemBase
object
8 properties 3 required
Security_Exceptions_API_TrustedDevicesMacProperties
object
Trusted devices list item properties (macOS-only, username not supported).
4 properties 1 required
Security_Exceptions_API_ExceptionListsImportBulkErrorArray
array
Security_Exceptions_API_ExceptionListItemEntryNested
object
3 properties 3 required
Security_Exceptions_API_ExceptionListItemOsTypeArray
array
Security_Exceptions_API_UpdateExceptionListItemEndpointList
Security_Exceptions_API_ExceptionListItem
object
19 properties 14 required
Security_Exceptions_API_ExceptionListItemDescription
string
Describes the exception list.
Security_Exceptions_API_ExceptionListType
string
The type of exception list to be created. Different list types may denote where they can be utilized.
Security_Exceptions_API_ExceptionListItemTags
array
Security_Exceptions_API_UpdateExceptionListItemTrustedAppsWindows
Security_Exceptions_API_ExceptionListHumanId
string
The exception list's human-readable string identifier. For endpoint artifacts, use one of the following values: endpointlist: [Elastic Endpoint exception list]…
Security_Exceptions_API_ExceptionListItemEntryExists
object
3 properties 3 required
Security_Exceptions_API_CreateExceptionListItemComment
object
1 property 1 required
Security_Exceptions_API_TrustedAppHashEntry
object
4 properties 4 required
Security_Exceptions_API_ExceptionListId
string
Exception list's identifier.
Security_Exceptions_API_TrustedAppsMacProperties
object
Trusted applications list item properties (macOS).
4 properties 1 required
Security_Exceptions_API_TrustedAppMacCodeSignatureEntry
object
3 properties 3 required
Security_Exceptions_API_CreateExceptionListItemEndpointList
Security_Exceptions_API_CreateExceptionListItemGeneric
Security_Exceptions_API_ExceptionList
object
17 properties 13 required
Security_Exceptions_API_TrustedAppsLinuxProperties
object
Trusted applications list item properties (Linux).
4 properties 1 required
Security_Exceptions_API_ListId
string
Value list's identifier.
Security_Exceptions_API_BlocklistLinuxProperties
object
Blocklist list item properties (Linux, code signature not supported).
4 properties 1 required
Security_Exceptions_API_EndpointArtifactTags
array
Tags for categorization. Special tags for scope control: "policy:all" - Global artifact (applies to all Elastic Defend policies) "policy: " - Private artifact…
Security_Exceptions_API_UpdateExceptionListItemBlocklistMac
Security_Exceptions_API_CreateExceptionListItemBlocklistLinux
Security_Exceptions_API_CreateExceptionListItemBlocklistWindows
Security_Exceptions_API_ExceptionListMeta
object
Placeholder for metadata about the list container.
Security_Exceptions_API_ExceptionListItemName
string
Exception list name.
Security_Exceptions_API_BlocklistMacProperties
object
Blocklist list item properties (macOS, code signature not supported).
4 properties 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

kibana-security-exceptions-api-api-openapi.yml Raw ↑

Other APIs Kibana publishes across the network.

Kibana Actions API
Kibana agent builder API
Kibana alerting API
Kibana APM agent configuration API
Kibana APM agent keys API
Kibana APM annotations API
Kibana APM server schema API
Kibana APM sourcemaps API
Kibana cases API
Kibana connectors API
Kibana Data streams API
Kibana data views API