Delete events

async AsyncCogniteClient.events.delete(
id: int | Sequence[int] | None = None,
external_id: str | SequenceNotStr[str] | None = None,
ignore_unknown_ids: bool = False,
) → None

Delete one or more events.

Deprecated since version 8.23.0: The Events API is deprecated and is scheduled for removal on 2027-12-31. Move events to records, CogniteActivity or CogniteMaintenanceOrder in the core data model. See https://docs.cognite.com/cdf/deprecated for details and migration guidance.

Parameters:

  • id (int | Sequence[int] | None) – Id or list of ids

  • external_id (str | SequenceNotStr[str] | None) – External ID or list of external ids

  • ignore_unknown_ids (bool) – Ignore IDs and external IDs that are not found rather than throw an exception.

Examples

Delete events by id or external id:

>>> from cognite.client import CogniteClient, AsyncCogniteClient
>>> client = CogniteClient()
>>> # async_client = AsyncCogniteClient()  # another option
>>> client.events.delete(id=[1, 2, 3], external_id="3")