Limits

Limits API

AsyncCogniteClient.limits.list([filter, limit])

List all limit values.

AsyncCogniteClient.limits.retrieve(id)

Retrieve a limit value by its id.

Limits Data Classes

class cognite.client.data_classes.limits.Limit(limit_id: str, value: float | int)

Bases: CogniteResource

A singular representation of a Limit.

Limits are identified by an id containing the service name and a service-scoped limit name. For instance atlas.monthly_ai_tokens is the id of the atlas service limit monthly_ai_tokens. Service and limit names are always in lower_snake_case.

Parameters:
  • limit_id (str) – Limits are identified by an id containing the service name and a service-scoped limit name.

  • value (float | int) – The numeric value of the limit.

as_id() str

Returns the limit ID.

class cognite.client.data_classes.limits.LimitList(
resources: Sequence[T_CogniteResource],
)

Bases: CogniteResourceList[Limit]

as_ids() list[str]

Returns a list of limit IDs.