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 ClientException/ValidationErrors.
  • Auth — Credentials and the credential types.
  • Filesystem — LocalPath / TruenasPath.
  • Host — TrueNASHost / TrueNASConfig, the transport providers, and the web-shell executor.