Skip to content

API Reference

Generated from docstrings, organized by module:

  • Client — TrueNASClient: connection, api, path, run, upload/download.
  • Namespace — the dynamic API proxy and the _get/_query/_create/_update/_upsert helpers.
  • Connection — the lean middleware client, extended-JSON (dumps/loads), and the errors (pytruenas.exceptions): TrueNASError and its subclasses.
  • Auth — Credentials and the credential types.
  • Filesystem — TrueNASWSPath, the websocket leg of client.path().
  • Host — TrueNASClient's hostctl half and TrueNASConfig, the transport providers, and the web-shell executor.