Changelog

Summary of API changes since version v25.10.5.

Methods Added

api_key

app

catalog

cloudsync.credentials

container

container.device

container.image

disk

interface

lxc

pool

privilege

sharing.webshare

smb

system.advanced

tn_connect

truenas.license

webshare

zfs.resource

zfs.resource.snapshot

zfs.tier

zpool

zpool.scrub

Methods with Schema Changes

alert

  • alert.list_categories
    • Call parameters:

      • added parameter options (optional)

    • Return value:

      • added [].classes[].product_types (required)

api_key

  • api_key.create
    • Return value:

      • added client_key (required)

      • added iterations (required)

      • added salt (required)

      • added server_key (required)

      • added stored_key (required)

      • removed keyhash

  • api_key.get_instance
    • Return value:

      • added iterations (required)

      • added salt (required)

      • added server_key (required)

      • added stored_key (required)

      • removed keyhash

  • api_key.my_keys
    • Return value:

      • added [].iterations (required)

      • added [].salt (required)

      • added [].server_key (required)

      • added [].stored_key (required)

      • removed [].keyhash

  • api_key.query
    • Return value:

      • added ApiKeyEntry.iterations (required)

      • added ApiKeyEntry.salt (required)

      • added ApiKeyEntry.server_key (required)

      • added ApiKeyEntry.stored_key (required)

      • removed ApiKeyEntry.keyhash

      • added [].iterations (required)

      • added [].salt (required)

      • added [].server_key (required)

      • added [].stored_key (required)

      • removed [].keyhash

  • api_key.update
    • Return value:

      • added ApiKeyEntry.iterations (required)

      • added ApiKeyEntry.salt (required)

      • added ApiKeyEntry.server_key (required)

      • added ApiKeyEntry.stored_key (required)

      • removed ApiKeyEntry.keyhash

      • added ApiKeyEntryWithKey.client_key (required)

      • added ApiKeyEntryWithKey.iterations (required)

      • added ApiKeyEntryWithKey.salt (required)

      • added ApiKeyEntryWithKey.server_key (required)

      • added ApiKeyEntryWithKey.stored_key (required)

      • removed ApiKeyEntryWithKey.keyhash

app

  • app.convert_to_custom
    • Return value:

      • added action_required (required)

      • added latest_app_version (required)

  • app.create
    • Return value:

      • added action_required (required)

      • added latest_app_version (required)

  • app.get_instance
    • Return value:

      • added action_required (required)

      • added latest_app_version (required)

  • app.query
    • Return value:

      • added AppEntry.action_required (required)

      • added AppEntry.latest_app_version (required)

      • added [].action_required (required)

      • added [].latest_app_version (required)

  • app.redeploy
    • Return value:

      • added action_required (required)

      • added latest_app_version (required)

  • app.rollback
    • Return value:

      • added action_required (required)

      • added latest_app_version (required)

  • app.update
    • Return value:

      • added action_required (required)

      • added latest_app_version (required)

  • app.upgrade
    • Return value:

      • added action_required (required)

      • added latest_app_version (required)

app.image

  • app.image.get_instance
    • Return value:

      • author type changed (string → string | null)

      • comment type changed (string → string | null)

      • created type changed (string → string | null)

  • app.image.query
    • Return value:

      • AppImageEntry.author type changed (string → string | null)

      • AppImageEntry.comment type changed (string → string | null)

      • AppImageEntry.created type changed (string → string | null)

      • [].author type changed (string → string | null)

      • [].comment type changed (string → string | null)

      • [].created type changed (string → string | null)

audit

  • audit.export
    • Call parameters:

      • parameter data became optional

      • removed data.query-options.count

      • removed data.query-options.extra

      • removed data.query-options.get

      • data.query-options default value added

  • audit.query
    • Call parameters:

      • parameter data became optional

      • data.query-options default value added

    • Return value:

      • added variant AuditQueryResultItem

      • added [].address (required)

      • added [].audit_id (required)

      • added [].event (required)

      • added [].event_data (required)

      • added [].message_timestamp (required)

      • added [].service (required)

      • added [].service_data (required)

      • added [].session (required)

      • added [].success (required)

      • added [].timestamp (required)

      • added [].username (required)

      • added variant array

auth

  • auth.login_ex
    • Call parameters:

      • parameter login_data: added variant AuthSCRAM

      • added login_data.AuthApiKeyPlain.login_options.reconnect_token

      • login_data.AuthApiKeyPlain.login_options default value changed ({“user_info”: true} → {“user_info”: true, “reconnect_token”: false})

      • added login_data.AuthOTPToken.login_options.reconnect_token

      • login_data.AuthOTPToken.login_options default value changed ({“user_info”: true} → {“user_info”: true, “reconnect_token”: false})

      • added login_data.AuthPasswordPlain.login_options.reconnect_token

      • login_data.AuthPasswordPlain.login_options default value changed ({“user_info”: true} → {“user_info”: true, “reconnect_token”: false})

      • added login_data.AuthTokenPlain.login_options.reconnect_token

      • login_data.AuthTokenPlain.login_options default value changed ({“user_info”: true} → {“user_info”: true, “reconnect_token”: false})

    • Return value:

      • added variant AuthRespDenied

      • added variant AuthRespScram

      • added AuthRespSuccess.reconnect_token (required)

  • auth.login_ex_continue
    • Call parameters:

      • added login_data.login_options.reconnect_token

      • login_data.login_options default value changed ({“user_info”: true} → {“user_info”: true, “reconnect_token”: false})

    • Return value:

      • added variant AuthRespDenied

      • added AuthRespSuccess.reconnect_token (required)

boot

  • boot.get_state
    • Return value:

      • added all_sed (required)

      • scan: added variant PoolScan

      • scan: removed variant object

catalog

cloud_backup

  • cloud_backup.create
    • Return value:

      • added dataset (required)

      • added relative_path (required)

      • added credentials.provider.S3CredentialsModel.force_path_style

      • added credentials.provider.S3CredentialsModel.provider

      • added credentials.provider.S3CredentialsModel.sign_accept_encoding

  • cloud_backup.get_instance
    • Return value:

      • added dataset (required)

      • added relative_path (required)

      • added credentials.provider.S3CredentialsModel.force_path_style

      • added credentials.provider.S3CredentialsModel.provider

      • added credentials.provider.S3CredentialsModel.sign_accept_encoding

  • cloud_backup.query
    • Return value:

      • added CloudBackupEntry.dataset (required)

      • added CloudBackupEntry.relative_path (required)

      • added [].dataset (required)

      • added [].relative_path (required)

      • added [].credentials.provider.S3CredentialsModel.force_path_style

      • added [].credentials.provider.S3CredentialsModel.provider

      • added [].credentials.provider.S3CredentialsModel.sign_accept_encoding

  • cloud_backup.update
    • Return value:

      • added dataset (required)

      • added relative_path (required)

      • added credentials.provider.S3CredentialsModel.force_path_style

      • added credentials.provider.S3CredentialsModel.provider

      • added credentials.provider.S3CredentialsModel.sign_accept_encoding

cloudsync

  • cloudsync.create
    • Return value:

      • added dataset (required)

      • added relative_path (required)

      • added credentials.provider.S3CredentialsModel.force_path_style

      • added credentials.provider.S3CredentialsModel.provider

      • added credentials.provider.S3CredentialsModel.sign_accept_encoding

  • cloudsync.get_instance
    • Return value:

      • added dataset (required)

      • added relative_path (required)

      • added credentials.provider.S3CredentialsModel.force_path_style

      • added credentials.provider.S3CredentialsModel.provider

      • added credentials.provider.S3CredentialsModel.sign_accept_encoding

  • cloudsync.query
    • Return value:

      • added CloudSyncEntry.dataset (required)

      • added CloudSyncEntry.relative_path (required)

      • added [].dataset (required)

      • added [].relative_path (required)

      • added [].credentials.provider.S3CredentialsModel.force_path_style

      • added [].credentials.provider.S3CredentialsModel.provider

      • added [].credentials.provider.S3CredentialsModel.sign_accept_encoding

  • cloudsync.restore
    • Return value:

      • added dataset (required)

      • added relative_path (required)

      • added credentials.provider.S3CredentialsModel.force_path_style

      • added credentials.provider.S3CredentialsModel.provider

      • added credentials.provider.S3CredentialsModel.sign_accept_encoding

  • cloudsync.update
    • Return value:

      • added dataset (required)

      • added relative_path (required)

      • added credentials.provider.S3CredentialsModel.force_path_style

      • added credentials.provider.S3CredentialsModel.provider

      • added credentials.provider.S3CredentialsModel.sign_accept_encoding

cloudsync.credentials

  • cloudsync.credentials.create
    • Call parameters:

      • added cloud_sync_credentials_create.provider.S3CredentialsModel.force_path_style

      • added cloud_sync_credentials_create.provider.S3CredentialsModel.provider

      • added cloud_sync_credentials_create.provider.S3CredentialsModel.sign_accept_encoding

    • Return value:

      • added provider.S3CredentialsModel.force_path_style

      • added provider.S3CredentialsModel.provider

      • added provider.S3CredentialsModel.sign_accept_encoding

  • cloudsync.credentials.get_instance
    • Return value:

      • added provider.S3CredentialsModel.force_path_style

      • added provider.S3CredentialsModel.provider

      • added provider.S3CredentialsModel.sign_accept_encoding

  • cloudsync.credentials.query
    • Return value:

      • added [].provider.S3CredentialsModel.force_path_style

      • added [].provider.S3CredentialsModel.provider

      • added [].provider.S3CredentialsModel.sign_accept_encoding

  • cloudsync.credentials.update
    • Call parameters:

      • added cloud_sync_credentials_update.provider.S3CredentialsModel.force_path_style

      • added cloud_sync_credentials_update.provider.S3CredentialsModel.provider

      • added cloud_sync_credentials_update.provider.S3CredentialsModel.sign_accept_encoding

    • Return value:

      • added provider.S3CredentialsModel.force_path_style

      • added provider.S3CredentialsModel.provider

      • added provider.S3CredentialsModel.sign_accept_encoding

  • cloudsync.credentials.verify
    • Call parameters:

      • added cloud_sync_credentials_create.S3CredentialsModel.force_path_style

      • added cloud_sync_credentials_create.S3CredentialsModel.provider

      • added cloud_sync_credentials_create.S3CredentialsModel.sign_accept_encoding

disk

  • disk.update
    • Call parameters:

      • added data.sed

      • added data.sed_status

docker

  • docker.config
    • Return value:

      • added registry_mirrors (required)

      • removed insecure_registry_mirrors

      • removed nvidia

      • removed secure_registry_mirrors

  • docker.update
    • Call parameters:

      • added docker_update.registry_mirrors

      • removed docker_update.insecure_registry_mirrors

      • removed docker_update.nvidia

      • removed docker_update.secure_registry_mirrors

    • Return value:

      • added registry_mirrors (required)

      • removed insecure_registry_mirrors

      • removed nvidia

      • removed secure_registry_mirrors

fcport

  • fcport.status
    • Call parameters:

      • added options.extra.with_lun_access

      • options.extra: additional properties no longer allowed

      • options.extra default value changed ({} → {“with_lun_access”: true})

      • parameter options default value changed

filesystem

filesystem.acltemplate

  • filesystem.acltemplate.by_path
    • Call parameters:

      • removed filesystem_acl.format-options.canonicalize

      • filesystem_acl.format-options default value changed

      • removed filesystem_acl.query-options.count

      • removed filesystem_acl.query-options.extra

      • removed filesystem_acl.query-options.get

      • removed filesystem_acl.query-options.select

      • filesystem_acl.query-options default value changed

interface

iscsi.extent

  • iscsi.extent.create
    • Return value:

      • added dataset (required)

      • added relative_path (required)

  • iscsi.extent.get_instance
    • Return value:

      • added dataset (required)

      • added relative_path (required)

  • iscsi.extent.query
    • Return value:

      • added [].dataset (required)

      • added [].relative_path (required)

      • added iSCSITargetExtentEntry.dataset (required)

      • added iSCSITargetExtentEntry.relative_path (required)

  • iscsi.extent.update
    • Return value:

      • added dataset (required)

      • added relative_path (required)

iscsi.global

  • iscsi.global.config
    • Return value:

      • added direct_config (required)

      • added mode (required)

  • iscsi.global.sessions
    • Return value:

      • type changed (array → array | ISCSIGlobalSessionsItem | object | integer)

  • iscsi.global.update
    • Call parameters:

      • added iscsi_update.direct_config

      • added iscsi_update.mode

    • Return value:

      • added direct_config (required)

      • added mode (required)

mail

  • mail.send
    • Return value:

      • type changed (boolean → null)

nvmet.host

nvmet.host_subsys

nvmet.namespace

  • nvmet.namespace.create
    • Return value:

      • added dataset (required)

      • added relative_path (required)

  • nvmet.namespace.get_instance
    • Return value:

      • added dataset (required)

      • added relative_path (required)

  • nvmet.namespace.query
    • Return value:

      • added NVMetNamespaceEntry.dataset (required)

      • added NVMetNamespaceEntry.relative_path (required)

      • added [].dataset (required)

      • added [].relative_path (required)

  • nvmet.namespace.update
    • Return value:

      • added dataset (required)

      • added relative_path (required)

pool

  • pool.create
    • Call parameters:

      • added data.all_sed

      • added data.force_topology

      • data.encryption_options.pbkdf2iters default value changed (350000 → 1300000)

      • data.topology.data[]: added variant PoolCreateTopologyVdevDRAID

      • data.topology.data[]: added variant PoolCreateTopologyVdevNonDRAID

      • data.topology.data[]: removed variant PoolCreateTopologyDataVdevDRAID

      • data.topology.data[]: removed variant PoolCreateTopologyDataVdevNonDRAID

      • data.topology.special[] type changed (object → PoolCreateTopologyVdevDRAID | PoolCreateTopologyVdevNonDRAID)

    • Return value:

      • added all_sed (required)

      • scan: added variant PoolScan

      • scan: removed variant object

  • pool.get_instance
    • Return value:

      • added all_sed (required)

      • scan: added variant PoolScan

      • scan: removed variant object

  • pool.query
    • Return value:

      • added PoolEntry.all_sed (required)

      • PoolEntry.scan type changed (object | null → any | null)

      • added [].all_sed (required)

      • [].scan: added variant PoolScan

      • [].scan: removed variant object

  • pool.update
    • Call parameters:

      • added data.all_sed

      • added data.force_topology

      • data.topology.data[]: added variant PoolCreateTopologyVdevDRAID

      • data.topology.data[]: added variant PoolCreateTopologyVdevNonDRAID

      • data.topology.data[]: removed variant PoolCreateTopologyDataVdevDRAID

      • data.topology.data[]: removed variant PoolCreateTopologyDataVdevNonDRAID

      • data.topology.special[] type changed (object → PoolCreateTopologyVdevDRAID | PoolCreateTopologyVdevNonDRAID)

    • Return value:

      • added all_sed (required)

      • scan: added variant PoolScan

      • scan: removed variant object

pool.dataset

  • pool.dataset.change_key
    • Call parameters:

      • options.pbkdf2iters default value changed (350000 → 1300000)

  • pool.dataset.create
    • Call parameters:

      • data.PoolDatasetCreateFilesystem.encryption_options.pbkdf2iters default value changed (350000 → 1300000)

      • data.PoolDatasetCreateVolume.encryption_options.pbkdf2iters default value changed (350000 → 1300000)

  • pool.dataset.get_quota
    • Call parameters:

      • parameter options became optional

    • Return value:

      • type changed (array → array | object | integer)

pool.snapshot

  • pool.snapshot.create
    • Call parameters:

      • added data.PoolSnapshotCreateWithName.suspend_vms

      • added data.PoolSnapshotCreateWithSchema.suspend_vms

  • pool.snapshot.rename
    • Call parameters:

      • added options.recursive

replication

reporting

  • reporting.get_data
    • Call parameters:

      • graphs[].name: removed enum value “arcactualrate”

      • graphs[].name: removed enum value “arcrate”

      • graphs[].name: removed enum value “arcresult”

    • Return value:

      • [].aggregations type changed (object → Aggregations | null)

  • reporting.graph
    • Return value:

      • [].aggregations type changed (object → Aggregations | null)

  • reporting.netdata_get_data
    • Call parameters:

      • graphs[].name: removed enum value “arcactualrate”

      • graphs[].name: removed enum value “arcrate”

      • graphs[].name: removed enum value “arcresult”

    • Return value:

      • [].aggregations type changed (object → Aggregations | null)

  • reporting.netdata_graph
    • Return value:

      • [].aggregations type changed (object → Aggregations | null)

rsynctask

  • rsynctask.create
    • Return value:

      • added dataset (required)

      • added relative_path (required)

  • rsynctask.get_instance
    • Return value:

      • added dataset (required)

      • added relative_path (required)

  • rsynctask.query
    • Return value:

      • added RsyncTaskEntry.dataset (required)

      • added RsyncTaskEntry.relative_path (required)

      • added [].dataset (required)

      • added [].relative_path (required)

  • rsynctask.update
    • Return value:

      • added dataset (required)

      • added relative_path (required)

sharing.nfs

  • sharing.nfs.create
    • Return value:

      • added dataset (required)

      • added relative_path (required)

      • added tier

  • sharing.nfs.get_instance
    • Return value:

      • added dataset (required)

      • added relative_path (required)

      • added tier

  • sharing.nfs.query
    • Return value:

      • added SharingNFSEntry.dataset (required)

      • added SharingNFSEntry.relative_path (required)

      • added SharingNFSEntry.tier

      • added [].dataset (required)

      • added [].relative_path (required)

      • added [].tier

  • sharing.nfs.update
    • Return value:

      • added dataset (required)

      • added relative_path (required)

      • added tier

sharing.smb

  • sharing.smb.create
    • Return value:

      • added dataset (required)

      • added relative_path (required)

      • added tier

  • sharing.smb.get_instance
    • Return value:

      • added dataset (required)

      • added relative_path (required)

      • added tier

  • sharing.smb.getacl
    • Return value:

      • share_acl[].ae_perm: added enum value “CUSTOM”

  • sharing.smb.query
    • Return value:

      • added SharingSMBEntry.dataset (required)

      • added SharingSMBEntry.relative_path (required)

      • added SharingSMBEntry.tier

      • added [].dataset (required)

      • added [].relative_path (required)

      • added [].tier

  • sharing.smb.setacl
    • Call parameters:

      • smb_setacl.share_acl[].ae_perm: added enum value “CUSTOM”

    • Return value:

      • share_acl[].ae_perm: added enum value “CUSTOM”

  • sharing.smb.update
    • Return value:

      • added dataset (required)

      • added relative_path (required)

      • added tier

smb

  • smb.config
    • Return value:

      • added minimum_protocol (required)

      • added search_protocols

      • added stateful_failover (required)

      • removed enable_smb1

  • smb.update
    • Call parameters:

      • added smb_update.minimum_protocol

      • added smb_update.search_protocols

      • added smb_update.stateful_failover

      • removed smb_update.enable_smb1

    • Return value:

      • added minimum_protocol (required)

      • added search_protocols

      • added stateful_failover (required)

      • removed enable_smb1

support

system

  • system.feature_enabled
    • Call parameters:

      • parameter feature: added enum value “APPS”

      • parameter feature: added enum value “SED”

      • parameter feature: added enum value “SUPPORT”

      • parameter feature: added enum value “VMS”

      • parameter feature: added enum value “ZFSTIER”

      • parameter feature: removed enum value “VM”

system.advanced

system.general

  • system.general.config
    • Return value:

      • added ui_certificate_name (required)

      • ui_certificate type changed (object | null → integer | null)

  • system.general.update
    • Return value:

      • added ui_certificate_name (required)

      • ui_certificate type changed (object | null → integer | null)

tn_connect

  • tn_connect.config
    • Return value:

      • added last_heartbeat_failure_datetime (required)

      • added tier (required)

      • removed interfaces

      • removed interfaces_ips

      • removed ips

      • removed use_all_interfaces

  • tn_connect.update
    • Call parameters:

      • removed tn_connect_update.interfaces

      • removed tn_connect_update.ips

      • removed tn_connect_update.use_all_interfaces

    • Return value:

      • added last_heartbeat_failure_datetime (required)

      • added tier (required)

      • removed interfaces

      • removed interfaces_ips

      • removed ips

      • removed use_all_interfaces

truecommand

  • truecommand.config
    • Return value:

      • status_reason: added enum value “Truecommand service is disabled on standby controller”

  • truecommand.update
    • Return value:

      • status_reason: added enum value “Truecommand service is disabled on standby controller”

truenas

ups

  • ups.update
    • Call parameters:

      • parameter ups_update renamed to data

user

  • user.create
    • Call parameters:

      • added user_create.webshare

    • Return value:

      • added webshare

  • user.get_instance
    • Return value:

      • added webshare

  • user.query
    • Return value:

      • added UserEntry.webshare

      • added [].webshare

  • user.renew_2fa_secret
    • Call parameters:

      • twofactor_options.interval: added enum value 30

      • twofactor_options.interval: added enum value 60

    • Return value:

      • added webshare

  • user.update
    • Call parameters:

      • added user_update.webshare

    • Return value:

      • added webshare

vm

  • vm.create
    • Return value:

      • status.domain_state type changed (string → string | null)

  • vm.delete
    • Return value:

      • type changed (boolean → null)

  • vm.get_instance
    • Return value:

      • status.domain_state type changed (string → string | null)

  • vm.query
    • Return value:

      • [].status.domain_state type changed (string → string | null)

  • vm.status
    • Return value:

      • domain_state type changed (string → string | null)

  • vm.update
    • Return value:

      • status.domain_state type changed (string → string | null)

vm.device

vmware

  • vmware.query
    • Return value:

      • VMWareEntry.state type changed (object → any)

webui.main.dashboard

zfs.resource

  • zfs.resource.query
    • Call parameters:

      • added data.get_tier

      • added data.max_depth

      • data.get_source default value changed (true → false)

      • parameter data default value changed

    • Return value:

      • added [].tier

      • [].properties type changed (object → object | null)