Skip to content

client.env

client.env — the env operations.

On AsyncKindgi every method is the same, awaited.

list(
*,
env_name: str,
scope_kind: Literal['tenant', 'org', 'project'],
scope_id: str | None = None,
inherit: bool | None = None,
limit: int | None = None,
cursor: str | None = None,
name_prefix: str | None = None,
timeout: float | None = None,
) -> EnvCollectionPage

List env entries. GET /v1/env

Cursor-paginated list of env entries at the given (scope, envName). value is present (env is non-sensitive by definition).

get(
*,
env_name: str,
scope_kind: Literal['tenant', 'org', 'project'],
scope_id: str | None = None,
inherit: bool | None = None,
timeout: float | None = None,
) -> EnvRecord

Get one env entry. GET /v1/env/{name}

put(
*,
env_name: str,
scope_kind: Literal['tenant', 'org', 'project'],
scope_id: str | None = None,
idempotency_key: str | None = None,
timeout: float | None = None,
**fields: Any,
) -> EnvRecord

Upsert an env entry. PUT /v1/env/{name}

Requires the env:write capability. Every write bumps revision; optional ifRevision guards against concurrent updates (409 env-write-conflict).

delete(
*,
env_name: str,
scope_kind: Literal['tenant', 'org', 'project'],
scope_id: str | None = None,
timeout: float | None = None,
) -> EnvDeleteResult

Delete an env entry. DELETE /v1/env/{name}

Requires the env:write capability. Idempotent — unknown key returns { deleted: false }.