Query parameters

• id string(nonempty)

  Exception list's identifier. Either id or list_id must be specified.

  Minimum length is 1.

• list_id string(nonempty)

  Human readable exception list string identifier, e.g. trusted-linux-processes. Either id or list_id must be specified.

  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.

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.

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

  • id string(nonempty) Required

    Exception list's identifier.

    Minimum length is 1.

  • immutable boolean Required
  • list_id string(nonempty) Required

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

    Minimum length is 1.

  • meta object

    Placeholder for metadata about the list container.

    Additional properties are allowed.

  • name string Required

    The name of the exception list.

  • 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. Only enter one value.

    Values are linux, macos, or windows.

  • tags array[string]

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

  • tie_breaker_id string Required

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

  • type string Required

    The type of exception list to be created. Different list types may denote where they can be utilized.

    Values are detection, rule_default, endpoint, endpoint_trusted_apps, endpoint_trusted_devices, endpoint_events, endpoint_host_isolation_exceptions, or endpoint_blocklists.

  • updated_at string(date-time) Required

    Autogenerated date of last object update.

  • updated_by string Required

    Autogenerated value - user that last updated object.

  • version integer Required

    The document version, automatically increasd on updates.

    Minimum value is 1.

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