Changelog
=========

Summary of API changes since version v25.10.5.

Methods Added
-------------

**api_key**

- :doc:`api_key.convert_raw_key <api_methods_api_key.convert_raw_key>`

**app**

- :doc:`app.upgrade_bulk <api_methods_app.upgrade_bulk>`

**catalog**

- :doc:`catalog.synced <api_methods_catalog.synced>`

**cloudsync.credentials**

- :doc:`cloudsync.credentials.s3_provider_choices <api_methods_cloudsync.credentials.s3_provider_choices>`

**container**

- :doc:`container.create <api_methods_container.create>`
- :doc:`container.delete <api_methods_container.delete>`
- :doc:`container.get_instance <api_methods_container.get_instance>`
- :doc:`container.migrate <api_methods_container.migrate>`
- :doc:`container.pool_choices <api_methods_container.pool_choices>`
- :doc:`container.query <api_methods_container.query>`
- :doc:`container.start <api_methods_container.start>`
- :doc:`container.stop <api_methods_container.stop>`
- :doc:`container.update <api_methods_container.update>`

**container.device**

- :doc:`container.device.create <api_methods_container.device.create>`
- :doc:`container.device.delete <api_methods_container.device.delete>`
- :doc:`container.device.get_instance <api_methods_container.device.get_instance>`
- :doc:`container.device.gpu_choices <api_methods_container.device.gpu_choices>`
- :doc:`container.device.nic_attach_choices <api_methods_container.device.nic_attach_choices>`
- :doc:`container.device.query <api_methods_container.device.query>`
- :doc:`container.device.update <api_methods_container.device.update>`
- :doc:`container.device.usb_choices <api_methods_container.device.usb_choices>`

**container.image**

- :doc:`container.image.query_registry <api_methods_container.image.query_registry>`

**disk**

- :doc:`disk.reset_sed <api_methods_disk.reset_sed>`
- :doc:`disk.setup_sed <api_methods_disk.setup_sed>`
- :doc:`disk.unlock_sed <api_methods_disk.unlock_sed>`

**interface**

- :doc:`interface.available_fec_modes <api_methods_interface.available_fec_modes>`

**lxc**

- :doc:`lxc.bridge_choices <api_methods_lxc.bridge_choices>`
- :doc:`lxc.config <api_methods_lxc.config>`
- :doc:`lxc.update <api_methods_lxc.update>`

**pool**

- :doc:`pool.prefetch <api_methods_pool.prefetch>`
- :doc:`pool.reimport <api_methods_pool.reimport>`

**privilege**

- :doc:`privilege.become_readonly <api_methods_privilege.become_readonly>`

**sharing.webshare**

- :doc:`sharing.webshare.create <api_methods_sharing.webshare.create>`
- :doc:`sharing.webshare.delete <api_methods_sharing.webshare.delete>`
- :doc:`sharing.webshare.get_instance <api_methods_sharing.webshare.get_instance>`
- :doc:`sharing.webshare.query <api_methods_sharing.webshare.query>`
- :doc:`sharing.webshare.update <api_methods_sharing.webshare.update>`

**smb**

- :doc:`smb.status <api_methods_smb.status>`

**system.advanced**

- :doc:`system.advanced.nvidia_present <api_methods_system.advanced.nvidia_present>`

**tn_connect**

- :doc:`tn_connect.ips_with_hostnames <api_methods_tn_connect.ips_with_hostnames>`

**truenas.license**

- :doc:`truenas.license.fingerprint <api_methods_truenas.license.fingerprint>`
- :doc:`truenas.license.info <api_methods_truenas.license.info>`
- :doc:`truenas.license.upload <api_methods_truenas.license.upload>`

**webshare**

- :doc:`webshare.bindip_choices <api_methods_webshare.bindip_choices>`
- :doc:`webshare.config <api_methods_webshare.config>`
- :doc:`webshare.update <api_methods_webshare.update>`

**zfs.resource**

- :doc:`zfs.resource.destroy <api_methods_zfs.resource.destroy>`

**zfs.resource.snapshot**

- :doc:`zfs.resource.snapshot.clone <api_methods_zfs.resource.snapshot.clone>`
- :doc:`zfs.resource.snapshot.count <api_methods_zfs.resource.snapshot.count>`
- :doc:`zfs.resource.snapshot.create <api_methods_zfs.resource.snapshot.create>`
- :doc:`zfs.resource.snapshot.destroy <api_methods_zfs.resource.snapshot.destroy>`
- :doc:`zfs.resource.snapshot.hold <api_methods_zfs.resource.snapshot.hold>`
- :doc:`zfs.resource.snapshot.holds <api_methods_zfs.resource.snapshot.holds>`
- :doc:`zfs.resource.snapshot.query <api_methods_zfs.resource.snapshot.query>`
- :doc:`zfs.resource.snapshot.release <api_methods_zfs.resource.snapshot.release>`
- :doc:`zfs.resource.snapshot.rename <api_methods_zfs.resource.snapshot.rename>`
- :doc:`zfs.resource.snapshot.rollback <api_methods_zfs.resource.snapshot.rollback>`

**zfs.tier**

- :doc:`zfs.tier.config <api_methods_zfs.tier.config>`
- :doc:`zfs.tier.dataset_set_tier <api_methods_zfs.tier.dataset_set_tier>`
- :doc:`zfs.tier.rewrite_job_cancel <api_methods_zfs.tier.rewrite_job_cancel>`
- :doc:`zfs.tier.rewrite_job_create <api_methods_zfs.tier.rewrite_job_create>`
- :doc:`zfs.tier.rewrite_job_failures <api_methods_zfs.tier.rewrite_job_failures>`
- :doc:`zfs.tier.rewrite_job_query <api_methods_zfs.tier.rewrite_job_query>`
- :doc:`zfs.tier.rewrite_job_recover <api_methods_zfs.tier.rewrite_job_recover>`
- :doc:`zfs.tier.rewrite_job_status <api_methods_zfs.tier.rewrite_job_status>`
- :doc:`zfs.tier.update <api_methods_zfs.tier.update>`

**zpool**

- :doc:`zpool.query <api_methods_zpool.query>`

**zpool.scrub**

- :doc:`zpool.scrub.run <api_methods_zpool.scrub.run>`

Methods with Schema Changes
---------------------------

**alert**

- :doc:`alert.list_categories <api_methods_alert.list_categories>`

  - Call parameters:

    - added parameter `options` (optional)

  - Return value:

    - added `[].classes[].product_types` (required)

**api_key**

- :doc:`api_key.create <api_methods_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`

- :doc:`api_key.get_instance <api_methods_api_key.get_instance>`

  - Return value:

    - added `iterations` (required)
    - added `salt` (required)
    - added `server_key` (required)
    - added `stored_key` (required)
    - removed `keyhash`

- :doc:`api_key.my_keys <api_methods_api_key.my_keys>`

  - Return value:

    - added `[].iterations` (required)
    - added `[].salt` (required)
    - added `[].server_key` (required)
    - added `[].stored_key` (required)
    - removed `[].keyhash`

- :doc:`api_key.query <api_methods_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`

- :doc:`api_key.update <api_methods_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**

- :doc:`app.convert_to_custom <api_methods_app.convert_to_custom>`

  - Return value:

    - added `action_required` (required)
    - added `latest_app_version` (required)

- :doc:`app.create <api_methods_app.create>`

  - Return value:

    - added `action_required` (required)
    - added `latest_app_version` (required)

- :doc:`app.get_instance <api_methods_app.get_instance>`

  - Return value:

    - added `action_required` (required)
    - added `latest_app_version` (required)

- :doc:`app.query <api_methods_app.query>`

  - Return value:

    - added `AppEntry.action_required` (required)
    - added `AppEntry.latest_app_version` (required)
    - added `[].action_required` (required)
    - added `[].latest_app_version` (required)

- :doc:`app.redeploy <api_methods_app.redeploy>`

  - Return value:

    - added `action_required` (required)
    - added `latest_app_version` (required)

- :doc:`app.rollback <api_methods_app.rollback>`

  - Return value:

    - added `action_required` (required)
    - added `latest_app_version` (required)

- :doc:`app.update <api_methods_app.update>`

  - Return value:

    - added `action_required` (required)
    - added `latest_app_version` (required)

- :doc:`app.upgrade <api_methods_app.upgrade>`

  - Return value:

    - added `action_required` (required)
    - added `latest_app_version` (required)

**app.image**

- :doc:`app.image.get_instance <api_methods_app.image.get_instance>`

  - Return value:

    - `author` type changed (string → string | null)
    - `comment` type changed (string → string | null)
    - `created` type changed (string → string | null)

- :doc:`app.image.query <api_methods_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**

- :doc:`audit.export <api_methods_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

- :doc:`audit.query <api_methods_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**

- :doc:`auth.login_ex <api_methods_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)

- :doc:`auth.login_ex_continue <api_methods_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**

- :doc:`boot.get_state <api_methods_boot.get_state>`

  - Return value:

    - added `all_sed` (required)
    - `scan`: added variant `PoolScan`
    - `scan`: removed variant `object`

**catalog**

- :doc:`catalog.apps <api_methods_catalog.apps>`

  - Call parameters:

    - parameter `catalog_apps_options` renamed to `data`

- :doc:`catalog.get_app_details <api_methods_catalog.get_app_details>`

  - Return value:

    - added `versions` (required)

- :doc:`catalog.update <api_methods_catalog.update>`

  - Call parameters:

    - parameter `catalog_update` renamed to `data`

**cloud_backup**

- :doc:`cloud_backup.create <api_methods_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`

- :doc:`cloud_backup.get_instance <api_methods_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`

- :doc:`cloud_backup.query <api_methods_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`

- :doc:`cloud_backup.update <api_methods_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**

- :doc:`cloudsync.create <api_methods_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`

- :doc:`cloudsync.get_instance <api_methods_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`

- :doc:`cloudsync.query <api_methods_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`

- :doc:`cloudsync.restore <api_methods_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`

- :doc:`cloudsync.update <api_methods_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**

- :doc:`cloudsync.credentials.create <api_methods_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`

- :doc:`cloudsync.credentials.get_instance <api_methods_cloudsync.credentials.get_instance>`

  - Return value:

    - added `provider.S3CredentialsModel.force_path_style`
    - added `provider.S3CredentialsModel.provider`
    - added `provider.S3CredentialsModel.sign_accept_encoding`

- :doc:`cloudsync.credentials.query <api_methods_cloudsync.credentials.query>`

  - Return value:

    - added `[].provider.S3CredentialsModel.force_path_style`
    - added `[].provider.S3CredentialsModel.provider`
    - added `[].provider.S3CredentialsModel.sign_accept_encoding`

- :doc:`cloudsync.credentials.update <api_methods_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`

- :doc:`cloudsync.credentials.verify <api_methods_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**

- :doc:`disk.update <api_methods_disk.update>`

  - Call parameters:

    - added `data.sed`
    - added `data.sed_status`

**docker**

- :doc:`docker.config <api_methods_docker.config>`

  - Return value:

    - added `registry_mirrors` (required)
    - removed `insecure_registry_mirrors`
    - removed `nvidia`
    - removed `secure_registry_mirrors`

- :doc:`docker.update <api_methods_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**

- :doc:`fcport.status <api_methods_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**

- :doc:`filesystem.set_zfs_attributes <api_methods_filesystem.set_zfs_attributes>`

  - Call parameters:

    - added `set_zfs_file_attributes.options`

- :doc:`filesystem.setacl <api_methods_filesystem.setacl>`

  - Call parameters:

    - removed `filesystem_acl.options.canonicalize`
    - `filesystem_acl.options` default value changed

**filesystem.acltemplate**

- :doc:`filesystem.acltemplate.by_path <api_methods_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**

- :doc:`interface.update <api_methods_interface.update>`

  - Call parameters:

    - added `data.fec_mode`

**iscsi.extent**

- :doc:`iscsi.extent.create <api_methods_iscsi.extent.create>`

  - Return value:

    - added `dataset` (required)
    - added `relative_path` (required)

- :doc:`iscsi.extent.get_instance <api_methods_iscsi.extent.get_instance>`

  - Return value:

    - added `dataset` (required)
    - added `relative_path` (required)

- :doc:`iscsi.extent.query <api_methods_iscsi.extent.query>`

  - Return value:

    - added `[].dataset` (required)
    - added `[].relative_path` (required)
    - added `iSCSITargetExtentEntry.dataset` (required)
    - added `iSCSITargetExtentEntry.relative_path` (required)

- :doc:`iscsi.extent.update <api_methods_iscsi.extent.update>`

  - Return value:

    - added `dataset` (required)
    - added `relative_path` (required)

**iscsi.global**

- :doc:`iscsi.global.config <api_methods_iscsi.global.config>`

  - Return value:

    - added `direct_config` (required)
    - added `mode` (required)

- :doc:`iscsi.global.sessions <api_methods_iscsi.global.sessions>`

  - Return value:

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

- :doc:`iscsi.global.update <api_methods_iscsi.global.update>`

  - Call parameters:

    - added `iscsi_update.direct_config`
    - added `iscsi_update.mode`

  - Return value:

    - added `direct_config` (required)
    - added `mode` (required)

**mail**

- :doc:`mail.send <api_methods_mail.send>`

  - Return value:

    - type changed (boolean → null)

**nvmet.host**

- :doc:`nvmet.host.create <api_methods_nvmet.host.create>`

  - Call parameters:

    - added `nvmet_host_create.description`

  - Return value:

    - added `description`

- :doc:`nvmet.host.get_instance <api_methods_nvmet.host.get_instance>`

  - Return value:

    - added `description`

- :doc:`nvmet.host.query <api_methods_nvmet.host.query>`

  - Return value:

    - added `NVMetHostEntry.description`
    - added `[].description`

- :doc:`nvmet.host.update <api_methods_nvmet.host.update>`

  - Call parameters:

    - added `nvmet_host_update.description`

  - Return value:

    - added `description`

**nvmet.host_subsys**

- :doc:`nvmet.host_subsys.create <api_methods_nvmet.host_subsys.create>`

  - Return value:

    - added `host.description`

- :doc:`nvmet.host_subsys.get_instance <api_methods_nvmet.host_subsys.get_instance>`

  - Return value:

    - added `host.description`

- :doc:`nvmet.host_subsys.query <api_methods_nvmet.host_subsys.query>`

  - Return value:

    - added `[].host.description`

- :doc:`nvmet.host_subsys.update <api_methods_nvmet.host_subsys.update>`

  - Return value:

    - added `host.description`

**nvmet.namespace**

- :doc:`nvmet.namespace.create <api_methods_nvmet.namespace.create>`

  - Return value:

    - added `dataset` (required)
    - added `relative_path` (required)

- :doc:`nvmet.namespace.get_instance <api_methods_nvmet.namespace.get_instance>`

  - Return value:

    - added `dataset` (required)
    - added `relative_path` (required)

- :doc:`nvmet.namespace.query <api_methods_nvmet.namespace.query>`

  - Return value:

    - added `NVMetNamespaceEntry.dataset` (required)
    - added `NVMetNamespaceEntry.relative_path` (required)
    - added `[].dataset` (required)
    - added `[].relative_path` (required)

- :doc:`nvmet.namespace.update <api_methods_nvmet.namespace.update>`

  - Return value:

    - added `dataset` (required)
    - added `relative_path` (required)

**pool**

- :doc:`pool.create <api_methods_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`

- :doc:`pool.get_instance <api_methods_pool.get_instance>`

  - Return value:

    - added `all_sed` (required)
    - `scan`: added variant `PoolScan`
    - `scan`: removed variant `object`

- :doc:`pool.query <api_methods_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`

- :doc:`pool.update <api_methods_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**

- :doc:`pool.dataset.change_key <api_methods_pool.dataset.change_key>`

  - Call parameters:

    - `options.pbkdf2iters` default value changed (350000 → 1300000)

- :doc:`pool.dataset.create <api_methods_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)

- :doc:`pool.dataset.get_quota <api_methods_pool.dataset.get_quota>`

  - Call parameters:

    - parameter `options` became optional

  - Return value:

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

**pool.snapshot**

- :doc:`pool.snapshot.create <api_methods_pool.snapshot.create>`

  - Call parameters:

    - added `data.PoolSnapshotCreateWithName.suspend_vms`
    - added `data.PoolSnapshotCreateWithSchema.suspend_vms`

- :doc:`pool.snapshot.rename <api_methods_pool.snapshot.rename>`

  - Call parameters:

    - added `options.recursive`

**replication**

- :doc:`replication.target_unmatched_snapshots <api_methods_replication.target_unmatched_snapshots>`

  - Return value:

    - `[*]` type changed (string → array)

**reporting**

- :doc:`reporting.get_data <api_methods_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)

- :doc:`reporting.graph <api_methods_reporting.graph>`

  - Return value:

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

- :doc:`reporting.netdata_get_data <api_methods_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)

- :doc:`reporting.netdata_graph <api_methods_reporting.netdata_graph>`

  - Return value:

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

**rsynctask**

- :doc:`rsynctask.create <api_methods_rsynctask.create>`

  - Return value:

    - added `dataset` (required)
    - added `relative_path` (required)

- :doc:`rsynctask.get_instance <api_methods_rsynctask.get_instance>`

  - Return value:

    - added `dataset` (required)
    - added `relative_path` (required)

- :doc:`rsynctask.query <api_methods_rsynctask.query>`

  - Return value:

    - added `RsyncTaskEntry.dataset` (required)
    - added `RsyncTaskEntry.relative_path` (required)
    - added `[].dataset` (required)
    - added `[].relative_path` (required)

- :doc:`rsynctask.update <api_methods_rsynctask.update>`

  - Return value:

    - added `dataset` (required)
    - added `relative_path` (required)

**sharing.nfs**

- :doc:`sharing.nfs.create <api_methods_sharing.nfs.create>`

  - Return value:

    - added `dataset` (required)
    - added `relative_path` (required)
    - added `tier`

- :doc:`sharing.nfs.get_instance <api_methods_sharing.nfs.get_instance>`

  - Return value:

    - added `dataset` (required)
    - added `relative_path` (required)
    - added `tier`

- :doc:`sharing.nfs.query <api_methods_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`

- :doc:`sharing.nfs.update <api_methods_sharing.nfs.update>`

  - Return value:

    - added `dataset` (required)
    - added `relative_path` (required)
    - added `tier`

**sharing.smb**

- :doc:`sharing.smb.create <api_methods_sharing.smb.create>`

  - Return value:

    - added `dataset` (required)
    - added `relative_path` (required)
    - added `tier`

- :doc:`sharing.smb.get_instance <api_methods_sharing.smb.get_instance>`

  - Return value:

    - added `dataset` (required)
    - added `relative_path` (required)
    - added `tier`

- :doc:`sharing.smb.getacl <api_methods_sharing.smb.getacl>`

  - Return value:

    - `share_acl[].ae_perm`: added enum value "CUSTOM"

- :doc:`sharing.smb.query <api_methods_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`

- :doc:`sharing.smb.setacl <api_methods_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"

- :doc:`sharing.smb.update <api_methods_sharing.smb.update>`

  - Return value:

    - added `dataset` (required)
    - added `relative_path` (required)
    - added `tier`

**smb**

- :doc:`smb.config <api_methods_smb.config>`

  - Return value:

    - added `minimum_protocol` (required)
    - added `search_protocols`
    - added `stateful_failover` (required)
    - removed `enable_smb1`

- :doc:`smb.update <api_methods_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**

- :doc:`support.new_ticket <api_methods_support.new_ticket>`

  - Return value:

    - added `debug_attach_error` (required)

**system**

- :doc:`system.feature_enabled <api_methods_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**

- :doc:`system.advanced.update <api_methods_system.advanced.update>`

  - Call parameters:

    - added `data.nvidia`

**system.general**

- :doc:`system.general.config <api_methods_system.general.config>`

  - Return value:

    - added `ui_certificate_name` (required)
    - `ui_certificate` type changed (object | null → integer | null)

- :doc:`system.general.update <api_methods_system.general.update>`

  - Return value:

    - added `ui_certificate_name` (required)
    - `ui_certificate` type changed (object | null → integer | null)

**tn_connect**

- :doc:`tn_connect.config <api_methods_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`

- :doc:`tn_connect.update <api_methods_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**

- :doc:`truecommand.config <api_methods_truecommand.config>`

  - Return value:

    - `status_reason`: added enum value "Truecommand service is disabled on standby controller"

- :doc:`truecommand.update <api_methods_truecommand.update>`

  - Return value:

    - `status_reason`: added enum value "Truecommand service is disabled on standby controller"

**truenas**

- :doc:`truenas.set_production <api_methods_truenas.set_production>`

  - Return value:

    - added variant `SupportNewTicket`
    - removed variant `object`

**ups**

- :doc:`ups.update <api_methods_ups.update>`

  - Call parameters:

    - parameter `ups_update` renamed to `data`

**user**

- :doc:`user.create <api_methods_user.create>`

  - Call parameters:

    - added `user_create.webshare`

  - Return value:

    - added `webshare`

- :doc:`user.get_instance <api_methods_user.get_instance>`

  - Return value:

    - added `webshare`

- :doc:`user.query <api_methods_user.query>`

  - Return value:

    - added `UserEntry.webshare`
    - added `[].webshare`

- :doc:`user.renew_2fa_secret <api_methods_user.renew_2fa_secret>`

  - Call parameters:

    - `twofactor_options.interval`: added enum value 30
    - `twofactor_options.interval`: added enum value 60

  - Return value:

    - added `webshare`

- :doc:`user.update <api_methods_user.update>`

  - Call parameters:

    - added `user_update.webshare`

  - Return value:

    - added `webshare`

**vm**

- :doc:`vm.create <api_methods_vm.create>`

  - Return value:

    - `status.domain_state` type changed (string → string | null)

- :doc:`vm.delete <api_methods_vm.delete>`

  - Return value:

    - type changed (boolean → null)

- :doc:`vm.get_instance <api_methods_vm.get_instance>`

  - Return value:

    - `status.domain_state` type changed (string → string | null)

- :doc:`vm.query <api_methods_vm.query>`

  - Return value:

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

- :doc:`vm.status <api_methods_vm.status>`

  - Return value:

    - `domain_state` type changed (string → string | null)

- :doc:`vm.update <api_methods_vm.update>`

  - Return value:

    - `status.domain_state` type changed (string → string | null)

**vm.device**

- :doc:`vm.device.nic_attach_choices <api_methods_vm.device.nic_attach_choices>`

  - Return value:

    - added `BRIDGE` (required)
    - added `MACVLAN` (required)
    - additional properties no longer allowed

- :doc:`vm.device.usb_controller_choices <api_methods_vm.device.usb_controller_choices>`

  - Return value:

    - `[*]` type changed (any → string)

- :doc:`vm.device.usb_passthrough_choices <api_methods_vm.device.usb_passthrough_choices>`

  - Return value:

    - added `[*].description` (required)

- :doc:`vm.device.usb_passthrough_device <api_methods_vm.device.usb_passthrough_device>`

  - Return value:

    - added `description` (required)

**vmware**

- :doc:`vmware.query <api_methods_vmware.query>`

  - Return value:

    - `VMWareEntry.state` type changed (object → any)

**webui.main.dashboard**

- :doc:`webui.main.dashboard.sys_info <api_methods_webui.main.dashboard.sys_info>`

  - Return value:

    - removed `codename`
    - removed `remote_info.RemoteInfo.codename`

**zfs.resource**

- :doc:`zfs.resource.query <api_methods_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)