Delete labels

async AsyncCogniteClient.labels.delete(

external_id: str | SequenceNotStr[str] | None = None,

) → None

Delete one or more label definitions.

Deprecated since version 8.23.0: The Labels API is deprecated and is scheduled for removal on 2027-12-31. There is no direct replacement; model labels as a concept in your data model. See https://docs.cognite.com/cdf/deprecated for details and migration guidance.

Parameters:

external_id (str | SequenceNotStr[str] | None) – One or more label external ids

Examples

Delete label definitions by external id:

>>> from cognite.client import CogniteClient, AsyncCogniteClient
>>> client = CogniteClient()
>>> # async_client = AsyncCogniteClient()  # another option
>>> client.labels.delete(external_id=["big_pump", "small_pump"])