TrueNAS API v24.10
  1. TrueNAS API v24.10 documentation
  2. Contents
JSON-RPC 2.0 ... »

Table Of Contents

  • JSON-RPC 2.0 over WebSocket API
    • Overview
    • JSON-RPC 2.0 Protocol
      • Communication Mechanism
    • Request and Response Format
      • JSON-RPC Request Structure
        • Example Request:
      • JSON-RPC Response Structure
        • Example Response:
      • Error Response
        • Custom Error Codes
    • Event Notifications
      • JSON-RPC Notification Structure
        • Example Notification:
      • Important Notes on Notifications
    • Limitations
  • API Methods
    • cloudsync.credentials
      • cloudsync.credentials.create
      • cloudsync.credentials.delete
      • cloudsync.credentials.get_instance
      • cloudsync.credentials.update
      • cloudsync.credentials.verify
  • API Events
    • acme.dns.authenticator
      • acme.dns.authenticator.query
    • alert
      • alert.list
    • alertservice
      • alertservice.query
    • api_key
      • api_key.query
    • app
      • app.container_log_follow
      • app.query
      • app.stats
    • app.image
      • app.image.query
    • app.registry
      • app.registry.query
    • certificate
      • certificate.query
    • cloud_backup
      • cloud_backup.query
    • cloudsync
      • cloudsync.query
    • cloudsync.credentials
      • cloudsync.credentials.query
    • core
      • core.get_jobs
    • cronjob
      • cronjob.query
    • docker.network
      • docker.network.query
    • fc.fc_host
      • fc.fc_host.query
    • fcport
      • fcport.query
    • filesystem
      • filesystem.file_tail_follow
    • filesystem.acltemplate
      • filesystem.acltemplate.query
    • group
      • group.query
    • initshutdownscript
      • initshutdownscript.query
    • interface
      • interface.query
    • iscsi.auth
      • iscsi.auth.query
    • iscsi.extent
      • iscsi.extent.query
    • iscsi.initiator
      • iscsi.initiator.query
    • iscsi.portal
      • iscsi.portal.query
    • iscsi.target
      • iscsi.target.query
    • iscsi.targetextent
      • iscsi.targetextent.query
    • jbof
      • jbof.query
    • kerberos.keytab
      • kerberos.keytab.query
    • kerberos.realm
      • kerberos.realm.query
    • keychaincredential
      • keychaincredential.query
    • nvmet.host
      • nvmet.host.query
    • nvmet.host_subsys
      • nvmet.host_subsys.query
    • nvmet.namespace
      • nvmet.namespace.query
    • nvmet.port
      • nvmet.port.query
    • nvmet.port_subsys
      • nvmet.port_subsys.query
    • nvmet.subsys
      • nvmet.subsys.query
    • pool
      • pool.query
    • pool.dataset
      • pool.dataset.query
    • pool.scrub
      • pool.scrub.query
    • pool.snapshot
      • pool.snapshot.query
    • pool.snapshottask
      • pool.snapshottask.query
    • privilege
      • privilege.query
    • replication
      • replication.query
    • reporting
      • reporting.realtime
    • reporting.exporters
      • reporting.exporters.query
    • rsynctask
      • rsynctask.query
    • service
      • service.query
    • sharing.nfs
      • sharing.nfs.query
    • sharing.smb
      • sharing.smb.query
    • staticroute
      • staticroute.query
    • system.ntpserver
      • system.ntpserver.query
    • tunable
      • tunable.query
    • user
      • user.query
    • virt.instance
      • virt.instance.metrics
      • virt.instance.query
    • virt.volume
      • virt.volume.query
    • vm
      • vm.query
    • vm.device
      • vm.device.query
    • vmware
      • vmware.query
  • Jobs
    • Example of Calling a Job Method
    • Query Job Status
    • Uploading / Downloading Files
      • Downloading a File
      • Uploading a File
  • Query Methods
    • Query Filters
      • Basic Usage
      • Supported Operators
      • Multiple Filters
      • Connectives
      • Datetime information
    • Query Options
      • Count
      • Limit
      • Offset
      • Select
      • Order By
      • Sample SQL statements translated into Query Filters and Query Options
        • “SELECT * FROM table;”
        • “SELECT username,uid FROM table WHERE builtin=FALSE ORDER BY -uid;”
        • “SELECT username AS locked_user,uid FROM table WHERE builtin=FALSE AND locked=TRUE;”
        • “SELECT username FROM table WHERE builtin=False OR (locked=FALSE AND ssh=TRUE);”

Next topic

JSON-RPC 2.0 over WebSocket API

  • Show Source

Contents¶

  • JSON-RPC 2.0 over WebSocket API
  • API Methods
  • API Events
  • Jobs
  • Query Methods

You can also download this documentation.

© Copyright 2025, iXsystems, Inc. dba TrueNAS.
Back to top