pycti.api.opencti_api_notification

Classes

OpenCTIApiNotification

OpenCTI Notification API class.

Module Contents

class pycti.api.opencti_api_notification.OpenCTIApiNotification(api)[source]

OpenCTI Notification API class.

Manages notification operations.

Parameters:

api (OpenCTIApiClient) – instance of OpenCTIApiClient

Initialize the OpenCTIApiNotification instance.

Parameters:

api (OpenCTIApiClient) – OpenCTI API client instance

api[source]
delete(**kwargs)[source]

Delete a notification.

Parameters:

id (str) – the notification id

Returns:

None

Return type:

None

update_field(**kwargs)[source]

Update a notification field.

Parameters:
  • id (str) – the notification id

  • input (list) – the input fields to update (list of key/value dicts)

Returns:

None

Return type:

None

mark_as_read(notification_id: str, read: bool)[source]

Mark a notification as read or unread.

Parameters:
  • notification_id (str) – the notification id

  • read (bool) – whether to mark as read (True) or unread (False)

Returns:

None

Return type:

None