TrueNAS API v25.04.1
  1. TrueNAS API v25.04.1 documentation
  2. API Methods
  3. system.general
« system.shutdown system.genera... »

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
    • acme.dns.authenticator
      • acme.dns.authenticator.authenticator_schemas
      • acme.dns.authenticator.create
      • acme.dns.authenticator.delete
      • acme.dns.authenticator.get_instance
      • acme.dns.authenticator.query
      • acme.dns.authenticator.update
    • alert
      • alert.dismiss
      • alert.list
      • alert.list_categories
      • alert.list_policies
      • alert.restore
    • alertclasses
      • alertclasses.update
    • alertservice
      • alertservice.create
      • alertservice.delete
      • alertservice.get_instance
      • alertservice.query
      • alertservice.test
      • alertservice.update
    • api_key
      • api_key.create
      • api_key.delete
      • api_key.get_instance
      • api_key.my_keys
      • api_key.query
      • api_key.update
    • app
      • app.available
      • app.available_space
      • app.categories
      • app.certificate_choices
      • app.config
      • app.container_console_choices
      • app.container_ids
      • app.convert_to_custom
      • app.create
      • app.delete
      • app.get_instance
      • app.gpu_choices
      • app.ip_choices
      • app.latest
      • app.outdated_docker_images
      • app.pull_images
      • app.query
      • app.redeploy
      • app.rollback
      • app.rollback_versions
      • app.similar
      • app.start
      • app.stop
      • app.update
      • app.upgrade
      • app.upgrade_summary
      • app.used_ports
    • app.image
      • app.image.delete
      • app.image.dockerhub_rate_limit
      • app.image.get_instance
      • app.image.pull
      • app.image.query
    • app.ix_volume
      • app.ix_volume.exists
      • app.ix_volume.query
    • app.registry
      • app.registry.create
      • app.registry.delete
      • app.registry.get_instance
      • app.registry.query
      • app.registry.update
    • auth
      • auth.generate_onetime_password
      • auth.generate_token
      • auth.login
      • auth.login_ex
      • auth.logout
      • auth.me
      • auth.mechanism_choices
      • auth.sessions
      • auth.set_attribute
      • auth.terminate_other_sessions
      • auth.terminate_session
    • boot.environment
      • boot.environment.activate
      • boot.environment.clone
      • boot.environment.destroy
      • boot.environment.keep
      • boot.environment.query
    • catalog
      • catalog.apps
      • catalog.get_app_details
      • catalog.sync
      • catalog.trains
      • catalog.update
    • certificate
      • certificate.acme_server_choices
      • certificate.ec_curve_choices
      • certificate.extended_key_usage_choices
    • cloud_backup
      • cloud_backup.abort
      • cloud_backup.create
      • cloud_backup.delete
      • cloud_backup.delete_snapshot
      • cloud_backup.get_instance
      • cloud_backup.list_snapshot_directory
      • cloud_backup.list_snapshots
      • cloud_backup.query
      • cloud_backup.restore
      • cloud_backup.sync
      • cloud_backup.transfer_setting_choices
      • cloud_backup.update
    • cloudsync
      • cloudsync.onedrive_list_drives
    • cloudsync.credentials
      • cloudsync.credentials.create
      • cloudsync.credentials.delete
      • cloudsync.credentials.get_instance
      • cloudsync.credentials.query
      • cloudsync.credentials.update
      • cloudsync.credentials.verify
    • config
      • config.reset
      • config.save
      • config.upload
    • core
      • core.ping
      • core.set_options
      • core.subscribe
      • core.unsubscribe
    • cronjob
      • cronjob.create
      • cronjob.delete
      • cronjob.get_instance
      • cronjob.query
      • cronjob.run
      • cronjob.update
    • device
      • device.get_info
    • disk
      • disk.temperature_alerts
    • docker
      • docker.backup
      • docker.delete_backup
      • docker.list_backups
      • docker.nvidia_present
      • docker.restore_backup
      • docker.status
      • docker.update
    • docker.network
      • docker.network.get_instance
      • docker.network.query
    • enclosure.label
      • enclosure.label.set
    • failover.reboot
      • failover.reboot.info
      • failover.reboot.other_node
    • fc.fc_host
      • fc.fc_host.create
      • fc.fc_host.delete
      • fc.fc_host.get_instance
      • fc.fc_host.query
      • fc.fc_host.update
    • fcport
      • fcport.create
      • fcport.delete
      • fcport.get_instance
      • fcport.port_choices
      • fcport.query
      • fcport.status
      • fcport.update
    • filesystem
      • filesystem.chown
      • filesystem.get
      • filesystem.get_zfs_attributes
      • filesystem.getacl
      • filesystem.listdir
      • filesystem.mkdir
      • filesystem.put
      • filesystem.set_zfs_attributes
      • filesystem.setacl
      • filesystem.setperm
      • filesystem.stat
      • filesystem.statfs
    • filesystem.acltemplate
      • filesystem.acltemplate.by_path
      • filesystem.acltemplate.create
      • filesystem.acltemplate.delete
      • filesystem.acltemplate.get_instance
      • filesystem.acltemplate.query
      • filesystem.acltemplate.update
    • ftp
      • ftp.update
    • group
      • group.create
      • group.delete
      • group.get_group_obj
      • group.get_instance
      • group.get_next_gid
      • group.has_password_enabled_user
      • group.query
      • group.update
    • initshutdownscript
      • initshutdownscript.create
      • initshutdownscript.delete
      • initshutdownscript.get_instance
      • initshutdownscript.query
      • initshutdownscript.update
    • ipmi
      • ipmi.is_loaded
    • iscsi.auth
      • iscsi.auth.create
      • iscsi.auth.delete
      • iscsi.auth.get_instance
      • iscsi.auth.query
      • iscsi.auth.update
    • iscsi.extent
      • iscsi.extent.create
      • iscsi.extent.delete
      • iscsi.extent.disk_choices
      • iscsi.extent.get_instance
      • iscsi.extent.query
      • iscsi.extent.update
    • iscsi.global
      • iscsi.global.alua_enabled
      • iscsi.global.client_count
      • iscsi.global.iser_enabled
      • iscsi.global.sessions
      • iscsi.global.update
    • iscsi.initiator
      • iscsi.initiator.create
      • iscsi.initiator.delete
      • iscsi.initiator.get_instance
      • iscsi.initiator.query
      • iscsi.initiator.update
    • iscsi.portal
      • iscsi.portal.create
      • iscsi.portal.delete
      • iscsi.portal.get_instance
      • iscsi.portal.listen_ip_choices
      • iscsi.portal.query
      • iscsi.portal.update
    • iscsi.target
      • iscsi.target.create
      • iscsi.target.delete
      • iscsi.target.get_instance
      • iscsi.target.query
      • iscsi.target.update
      • iscsi.target.validate_name
    • iscsi.targetextent
      • iscsi.targetextent.create
      • iscsi.targetextent.delete
      • iscsi.targetextent.get_instance
      • iscsi.targetextent.query
      • iscsi.targetextent.update
    • k8s_to_docker
      • k8s_to_docker.list_backups
      • k8s_to_docker.migrate
    • keychaincredential
      • keychaincredential.create
      • keychaincredential.delete
      • keychaincredential.generate_ssh_key_pair
      • keychaincredential.get_instance
      • keychaincredential.query
      • keychaincredential.remote_ssh_host_key_scan
      • keychaincredential.remote_ssh_semiautomatic_setup
      • keychaincredential.setup_ssh_connection
      • keychaincredential.update
      • keychaincredential.used_by
    • nfs
      • nfs.bindip_choices
      • nfs.update
    • pool
      • pool.ddt_prefetch
      • pool.ddt_prune
    • pool.dataset
      • pool.dataset.destroy_snapshots
      • pool.dataset.details
      • pool.dataset.snapshot_count
    • pool.resilver
      • pool.resilver.update
    • pool.scrub
      • pool.scrub.create
      • pool.scrub.delete
      • pool.scrub.get_instance
      • pool.scrub.query
      • pool.scrub.run
      • pool.scrub.scrub
      • pool.scrub.update
    • pool.snapshottask
      • pool.snapshottask.create
      • pool.snapshottask.delete
      • pool.snapshottask.delete_will_change_retention_for
      • pool.snapshottask.get_instance
      • pool.snapshottask.max_count
      • pool.snapshottask.max_total_count
      • pool.snapshottask.query
      • pool.snapshottask.run
      • pool.snapshottask.update
      • pool.snapshottask.update_will_change_retention_for
    • privilege
      • privilege.create
      • privilege.delete
      • privilege.get_instance
      • privilege.query
      • privilege.roles
      • privilege.update
    • reporting
      • reporting.graphs
      • reporting.netdata_graph
      • reporting.netdata_graphs
      • reporting.update
    • reporting.exporters
      • reporting.exporters.create
      • reporting.exporters.delete
      • reporting.exporters.exporter_schemas
      • reporting.exporters.get_instance
      • reporting.exporters.query
      • reporting.exporters.update
    • sharing.nfs
      • sharing.nfs.create
      • sharing.nfs.delete
      • sharing.nfs.get_instance
      • sharing.nfs.query
      • sharing.nfs.update
    • sharing.smb
      • sharing.smb.getacl
      • sharing.smb.presets
      • sharing.smb.setacl
    • smb
      • smb.bindip_choices
      • smb.unixcharset_choices
      • smb.update
    • snmp
      • snmp.update
    • staticroute
      • staticroute.create
      • staticroute.delete
      • staticroute.get_instance
      • staticroute.query
      • staticroute.update
    • system
      • system.reboot
        • system.reboot.info
      • system.shutdown
    • system.general
      • system.general.country_choices
    • system.ntpserver
      • system.ntpserver.create
      • system.ntpserver.delete
      • system.ntpserver.get_instance
      • system.ntpserver.query
      • system.ntpserver.update
    • system.reboot
      • system.reboot.info
    • system.security
      • system.security.update
    • system.security.info
      • system.security.info.fips_available
      • system.security.info.fips_enabled
    • tn_connect
      • tn_connect.generate_claim_token
      • tn_connect.get_registration_uri
      • tn_connect.ip_choices
      • tn_connect.update
    • truenas
      • truenas.accept_eula
      • truenas.get_chassis_hardware
      • truenas.get_eula
      • truenas.is_eula_accepted
      • truenas.is_ix_hardware
      • truenas.is_production
      • truenas.managed_by_truecommand
      • truenas.set_production
    • user
      • user.create
      • user.delete
      • user.get_instance
      • user.get_next_uid
      • user.get_user_obj
      • user.has_local_administrator_set_up
      • user.query
      • user.renew_2fa_secret
      • user.set_password
      • user.setup_local_administrator
      • user.shell_choices
      • user.unset_2fa_secret
      • user.update
    • virt.device
      • virt.device.disk_choices
      • virt.device.export_disk_image
      • virt.device.gpu_choices
      • virt.device.import_disk_image
      • virt.device.nic_choices
      • virt.device.pci_choices
      • virt.device.usb_choices
    • virt.global
      • virt.global.bridge_choices
      • virt.global.get_network
      • virt.global.pool_choices
      • virt.global.update
    • virt.instance
      • virt.instance.create
      • virt.instance.delete
      • virt.instance.device_add
      • virt.instance.device_delete
      • virt.instance.device_list
      • virt.instance.device_update
      • virt.instance.get_instance
      • virt.instance.image_choices
      • virt.instance.query
      • virt.instance.restart
      • virt.instance.start
      • virt.instance.stop
      • virt.instance.update
    • virt.volume
      • virt.volume.create
      • virt.volume.delete
      • virt.volume.get_instance
      • virt.volume.import_iso
      • virt.volume.import_zvol
      • virt.volume.query
      • virt.volume.update
  • 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
    • update
      • update.status
    • 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);”

Previous topic

system.shutdown

Next topic

system.general.country_choices

  • Show Source

system.general¶

  • system.general.country_choices
© Copyright 2025, iXsystems, Inc. dba TrueNAS.
Back to top