List

async AsyncCogniteClient.limits.list(
filter: Prefix | None = None,
limit: int | None = 25,
) → LimitList

List all limit values.

Retrieves all limit values for a specific project. Optionally filter by limit ID prefix using a Prefix filter.

Parameters:

  • filter (Prefix | None) – Optional Prefix filter to apply on the limitId property (only Prefix filters are supported).

  • limit (int | None) – Maximum number of limits to return. Defaults to 25. Set to None or -1 to return all limits

Returns:

List of all limit values in the project.

Return type:

LimitList

Examples

List all limits:

>>> from cognite.client import CogniteClient, AsyncCogniteClient
>>> client = CogniteClient()
>>> # async_client = AsyncCogniteClient()  # another option
>>> limits = client.limits.list(limit=None)

List limits filtered by prefix (e.g., all limits for the ‘atlas’ service):

>>> from cognite.client.data_classes.filters import Prefix
>>> prefix_filter = Prefix("limitId", "atlas.")
>>> limits = client.limits.list(filter=prefix_filter)