Changelog

Summary of API changes since version v27.0.0.

Methods Added

app.ix_volume

• app.ix_volume.get_instance

disk

• disk.get_instance

vm

• vm.bootloader_aavmf_choices

• vm.get_guest_network_interfaces

• vm.reset

zfs.resource

• zfs.resource.attachments

• zfs.resource.checksum_choices

• zfs.resource.compression_choices

• zfs.resource.create

• zfs.resource.list

• zfs.resource.processes

• zfs.resource.promote

• zfs.resource.recommended_zvol_blocksize

• zfs.resource.recordsize_choices

• zfs.resource.rename

• zfs.resource.set

• zfs.resource.share_type_choices

Methods with Schema Changes

acme.dns.authenticator

• acme.dns.authenticator.query

  • Call parameters:

    • parameter options default value changed

alertservice

• alertservice.query

  • Call parameters:

    • parameter options default value changed

api_key

• api_key.query

  • Call parameters:

    • parameter options default value changed

app

• app.available

  • Call parameters:

    • parameter options default value changed

• app.convert_to_custom

  • Return value:

    • added error_reason

    • human_version type changed (string → string | null)

    • state: added enum value “ERROR”

    • version type changed (string → string | null)

• app.create

  • Return value:

    • added error_reason

    • human_version type changed (string → string | null)

    • state: added enum value “ERROR”

    • version type changed (string → string | null)

• app.get_instance

  • Return value:

    • added error_reason

    • human_version type changed (string → string | null)

    • state: added enum value “ERROR”

    • version type changed (string → string | null)

• app.latest

  • Call parameters:

    • parameter options default value changed

• app.query

  • Call parameters:

    • parameter options default value changed

  • Return value:

    • added AppEntry.error_reason

    • AppEntry.human_version type changed (string → string | null)

    • AppEntry.state: added enum value “ERROR”

    • AppEntry.version type changed (string → string | null)

    • added AppQueryResultItem.error_reason

    • AppQueryResultItem.human_version type changed (string → string | null)

    • AppQueryResultItem.state: added enum value “ERROR”

    • AppQueryResultItem.version type changed (string → string | null)

    • added [].error_reason

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

    • [].state: added enum value “ERROR”

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

    • added [].error_reason

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

    • [].state: added enum value “ERROR”

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

• app.redeploy

  • Return value:

    • added error_reason

    • human_version type changed (string → string | null)

    • state: added enum value “ERROR”

    • version type changed (string → string | null)

• app.rollback

  • Return value:

    • added error_reason

    • human_version type changed (string → string | null)

    • state: added enum value “ERROR”

    • version type changed (string → string | null)

• app.update

  • Call parameters:

    • parameter update default value changed

  • Return value:

    • added error_reason

    • human_version type changed (string → string | null)

    • state: added enum value “ERROR”

    • version type changed (string → string | null)

• app.upgrade

  • Call parameters:

    • parameter options default value changed

  • Return value:

    • added error_reason

    • human_version type changed (string → string | null)

    • state: added enum value “ERROR”

    • version type changed (string → string | null)

• app.upgrade_bulk

  • Call parameters:

    • apps[].options default value changed

  • Return value:

    • added [].result.AppEntry.error_reason

    • [].result.AppEntry.human_version type changed (string → string | null)

    • [].result.AppEntry.state: added enum value “ERROR”

    • [].result.AppEntry.version type changed (string → string | null)

app.image

• app.image.query

  • Call parameters:

    • parameter options default value changed

app.ix_volume

• app.ix_volume.query

  • Call parameters:

    • parameter options default value changed

app.registry

• app.registry.query

  • Call parameters:

    • parameter options default value changed

audit

• audit.config

  • Return value:

    • added enabled_services.S3 (required)

• audit.export

  • Call parameters:

    • data.query-options default value changed

    • data.services[]: added enum value “S3”

    • parameter data default value changed

• audit.query

  • Call parameters:

    • data.query-options default value changed

    • data.services[]: added enum value “S3”

    • parameter data default value changed

  • Return value:

    • AuditQueryResultItem.service: added enum value “S3”

    • AuditQueryResultItemQueryResultItem.service: added enum value “S3”

    • [].service: added enum value “S3”

    • [].service: added enum value “S3”

• audit.update

  • Return value:

    • added enabled_services.S3 (required)

auth

• auth.sessions

  • Call parameters:

    • parameter options default value changed

boot.environment

• boot.environment.query

  • Call parameters:

    • parameter options default value changed

certificate

• certificate.query

  • Call parameters:

    • parameter options default value changed

cloud_backup

• cloud_backup.query

  • Call parameters:

    • parameter options default value changed

cloudsync

• cloudsync.query

  • Call parameters:

    • parameter options default value changed

cloudsync.credentials

• cloudsync.credentials.query

  • Call parameters:

    • parameter options default value changed

config

• config.save

  • Call parameters:

    • options.secretseed default value changed (false → true)

    • parameter options default value changed

container

• container.pool_choices

  • Return value:

    • [*] type changed (any → string)

• container.query

  • Call parameters:

    • parameter options default value changed

container.device

• container.device.gpu_choices

  • Return value:

    • [*] type changed (any → string)

• container.device.query

  • Call parameters:

    • parameter options default value changed

core

• core.get_jobs

  • Call parameters:

    • parameter options default value changed

cronjob

• cronjob.query

  • Call parameters:

    • parameter options default value changed

disk

• disk.query

  • Call parameters:

    • parameter options default value changed

dns

• dns.query

  • Call parameters:

    • parameter options default value changed

docker

• docker.config

  • Return value:

    • added address_pools[].base (required)

    • added address_pools[].size (required)

    • address_pools[]: additional properties no longer allowed

• docker.update

  • Return value:

    • added address_pools[].base (required)

    • added address_pools[].size (required)

    • address_pools[]: additional properties no longer allowed

docker.network

• docker.network.query

  • Call parameters:

    • parameter options default value changed

enclosure2

• enclosure2.query

  • Call parameters:

    • parameter options default value changed

• enclosure2.set_slot_status

  • Call parameters:

    • parameter Enclosure2SetSlotStatus renamed to enclosure2_set_slot_status

fc.fc_host

• fc.fc_host.query

  • Call parameters:

    • parameter options default value changed

fcport

• fcport.query

  • Call parameters:

    • parameter options default value changed

• fcport.status

  • Call parameters:

    • parameter options default value changed

filesystem

• filesystem.listdir

  • Call parameters:

    • parameter query_options default value changed

  • Return value:

    • FilesystemDirEntry.acl type changed (boolean → boolean | null)

    • FilesystemDirEntry.is_ctldir type changed (boolean → boolean | null)

    • FilesystemDirEntry.realpath type changed (string → string | null)

    • FilesystemDirEntry.xattrs type changed (array → array | null)

    • FilesystemDirQueryResultItem.acl type changed (boolean → boolean | null)

    • FilesystemDirQueryResultItem.is_ctldir type changed (boolean → boolean | null)

    • FilesystemDirQueryResultItem.realpath type changed (string → string | null)

    • FilesystemDirQueryResultItem.xattrs type changed (array → array | null)

    • [].acl type changed (boolean → boolean | null)

    • [].is_ctldir type changed (boolean → boolean | null)

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

    • [].xattrs type changed (array → array | null)

    • [].acl type changed (boolean → boolean | null)

    • [].is_ctldir type changed (boolean → boolean | null)

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

    • [].xattrs type changed (array → array | null)

• filesystem.mkdir

  • Call parameters:

    • parameter filesystem_mkdir renamed to data

  • Return value:

    • acl type changed (boolean → boolean | null)

    • is_ctldir type changed (boolean → boolean | null)

    • realpath type changed (string → string | null)

    • xattrs type changed (array → array | null)

• filesystem.set_zfs_attributes

  • Call parameters:

    • parameter set_zfs_file_attributes renamed to data

filesystem.acltemplate

• filesystem.acltemplate.by_path

  • Call parameters:

    • filesystem_acl.query-options default value changed

• filesystem.acltemplate.query

  • Call parameters:

    • parameter options default value changed

ftp

• ftp.update

  • Call parameters:

    • parameter ftp_update renamed to data

group

• group.query

  • Call parameters:

    • parameter options default value changed

initshutdownscript

• initshutdownscript.query

  • Call parameters:

    • parameter options default value changed

interface

• interface.create

  • Call parameters:

    • data.bridge_members[] type changed (any → string)

  • Return value:

    • added failover_aliases

    • added failover_critical

    • added failover_group

    • added failover_vhid

    • added failover_virtual_aliases

    • added lacpdu_rate

    • added stp

    • added xmit_hash_policy

    • additional properties no longer allowed

• interface.get_instance

  • Return value:

    • added failover_aliases

    • added failover_critical

    • added failover_group

    • added failover_vhid

    • added failover_virtual_aliases

    • added lacpdu_rate

    • added stp

    • added xmit_hash_policy

    • additional properties no longer allowed

• interface.query

  • Call parameters:

    • parameter options default value changed

  • Return value:

    • added InterfaceEntry.failover_aliases

    • added InterfaceEntry.failover_critical

    • added InterfaceEntry.failover_group

    • added InterfaceEntry.failover_vhid

    • added InterfaceEntry.failover_virtual_aliases

    • added InterfaceEntry.lacpdu_rate

    • added InterfaceEntry.stp

    • added InterfaceEntry.xmit_hash_policy

    • InterfaceEntry: additional properties no longer allowed

    • added InterfaceQueryResultItem.failover_aliases

    • added InterfaceQueryResultItem.failover_critical

    • added InterfaceQueryResultItem.failover_group

    • added InterfaceQueryResultItem.failover_vhid

    • added InterfaceQueryResultItem.failover_virtual_aliases

    • added InterfaceQueryResultItem.lacpdu_rate

    • added InterfaceQueryResultItem.stp

    • added InterfaceQueryResultItem.xmit_hash_policy

    • InterfaceQueryResultItem: additional properties no longer allowed

    • added [].failover_aliases

    • added [].failover_critical

    • added [].failover_group

    • added [].failover_vhid

    • added [].failover_virtual_aliases

    • added [].lacpdu_rate

    • added [].stp

    • added [].xmit_hash_policy

    • []: additional properties no longer allowed

    • added [].failover_aliases

    • added [].failover_critical

    • added [].failover_group

    • added [].failover_vhid

    • added [].failover_virtual_aliases

    • added [].lacpdu_rate

    • added [].stp

    • added [].xmit_hash_policy

    • []: additional properties no longer allowed

• interface.update

  • Call parameters:

    • data.bridge_members[] type changed (any → string)

  • Return value:

    • added failover_aliases

    • added failover_critical

    • added failover_group

    • added failover_vhid

    • added failover_virtual_aliases

    • added lacpdu_rate

    • added stp

    • added xmit_hash_policy

    • additional properties no longer allowed

• interface.websocket_interface

  • Return value:

    • added InterfaceEntry.failover_aliases

    • added InterfaceEntry.failover_critical

    • added InterfaceEntry.failover_group

    • added InterfaceEntry.failover_vhid

    • added InterfaceEntry.failover_virtual_aliases

    • added InterfaceEntry.lacpdu_rate

    • added InterfaceEntry.stp

    • added InterfaceEntry.xmit_hash_policy

    • InterfaceEntry: additional properties no longer allowed

ipmi.sel

• ipmi.sel.elist

  • Call parameters:

    • parameter options default value changed

iscsi.auth

• iscsi.auth.query

  • Call parameters:

    • parameter options default value changed

iscsi.extent

• iscsi.extent.query

  • Call parameters:

    • parameter options default value changed

iscsi.global

• iscsi.global.sessions

  • Call parameters:

    • parameter options default value changed

iscsi.initiator

• iscsi.initiator.query

  • Call parameters:

    • parameter options default value changed

iscsi.portal

• iscsi.portal.query

  • Call parameters:

    • parameter options default value changed

iscsi.target

• iscsi.target.query

  • Call parameters:

    • parameter options default value changed

iscsi.targetextent

• iscsi.targetextent.query

  • Call parameters:

    • parameter options default value changed

jbof

• jbof.query

  • Call parameters:

    • parameter options default value changed

kerberos.keytab

• kerberos.keytab.query

  • Call parameters:

    • parameter options default value changed

kerberos.realm

• kerberos.realm.query

  • Call parameters:

    • parameter options default value changed

keychaincredential

• keychaincredential.create

  • Return value:

    • type changed (SSHKeyPairEntry | SSHCredentialsEntry → object)

• keychaincredential.generate_ssh_key_pair

  • Return value:

    • private_key became optional

    • private_key type changed (string → string | null)

    • public_key became optional

    • public_key type changed (string → string | null)

• keychaincredential.query

  • Call parameters:

    • parameter options default value changed

• keychaincredential.update

  • Return value:

    • type changed (SSHKeyPairEntry | SSHCredentialsEntry → object)

lxc

• lxc.update

  • Call parameters:

    • parameter lxc_config_update renamed to data

mail

• mail.config

  • Return value:

    • oauth: removed variant EmptyDict

• mail.send

  • Call parameters:

    • config.oauth: removed variant EmptyDict

    • removed message.channel

    • removed message.interval

• mail.update

  • Call parameters:

    • data.oauth: removed variant EmptyDict

  • Return value:

    • oauth: removed variant EmptyDict

nfs

• nfs.get_nfs3_clients

  • Call parameters:

    • parameter options default value changed

• nfs.get_nfs4_clients

  • Call parameters:

    • parameter options default value changed

nvmet.global

• nvmet.global.sessions

  • Call parameters:

    • parameter options default value changed

nvmet.host

• nvmet.host.query

  • Call parameters:

    • parameter options default value changed

nvmet.host_subsys

• nvmet.host_subsys.query

  • Call parameters:

    • parameter options default value changed

nvmet.namespace

• nvmet.namespace.query

  • Call parameters:

    • parameter options default value changed

nvmet.port

• nvmet.port.query

  • Call parameters:

    • parameter options default value changed

nvmet.port_subsys

• nvmet.port_subsys.query

  • Call parameters:

    • parameter options default value changed

nvmet.subsys

• nvmet.subsys.query

  • Call parameters:

    • parameter options default value changed

pool

• pool.query

  • Call parameters:

    • parameter options default value changed

pool.dataset

• pool.dataset.checksum_choices

  • Return value:

    • added OFF (required)

• pool.dataset.create

  • Call parameters:

    • data.PoolDatasetCreateFilesystem.compression: added enum value “GZIP-2”

    • data.PoolDatasetCreateFilesystem.compression: added enum value “GZIP-3”

    • data.PoolDatasetCreateFilesystem.compression: added enum value “GZIP-4”

    • data.PoolDatasetCreateFilesystem.compression: added enum value “GZIP-5”

    • data.PoolDatasetCreateFilesystem.compression: added enum value “GZIP-6”

    • data.PoolDatasetCreateFilesystem.compression: added enum value “GZIP-7”

    • data.PoolDatasetCreateFilesystem.compression: added enum value “GZIP-8”

    • data.PoolDatasetCreateVolume.compression: added enum value “GZIP-2”

    • data.PoolDatasetCreateVolume.compression: added enum value “GZIP-3”

    • data.PoolDatasetCreateVolume.compression: added enum value “GZIP-4”

    • data.PoolDatasetCreateVolume.compression: added enum value “GZIP-5”

    • data.PoolDatasetCreateVolume.compression: added enum value “GZIP-6”

    • data.PoolDatasetCreateVolume.compression: added enum value “GZIP-7”

    • data.PoolDatasetCreateVolume.compression: added enum value “GZIP-8”

• pool.dataset.get_quota

  • Call parameters:

    • parameter options default value changed

• pool.dataset.query

  • Call parameters:

    • parameter options default value changed

• pool.dataset.update

  • Call parameters:

    • data.compression: added enum value “GZIP-2”

    • data.compression: added enum value “GZIP-3”

    • data.compression: added enum value “GZIP-4”

    • data.compression: added enum value “GZIP-5”

    • data.compression: added enum value “GZIP-6”

    • data.compression: added enum value “GZIP-7”

    • data.compression: added enum value “GZIP-8”

pool.scrub

• pool.scrub.query

  • Call parameters:

    • parameter options default value changed

pool.snapshot

• pool.snapshot.query

  • Call parameters:

    • parameter options default value changed

pool.snapshottask

• pool.snapshottask.query

  • Call parameters:

    • parameter options default value changed

privilege

• privilege.query

  • Call parameters:

    • parameter options default value changed

• privilege.roles

  • Call parameters:

    • parameter options default value changed

replication

• replication.query

  • Call parameters:

    • parameter options default value changed

reporting

• reporting.get_data

  • Return value:

    • [].aggregations.Aggregations.max[*] type changed (any → number)

    • [].aggregations.Aggregations.mean[*] type changed (any → number)

    • [].aggregations.Aggregations.min[*] type changed (any → number)

• reporting.graph

  • Return value:

    • [].aggregations.Aggregations.max[*] type changed (any → number)

    • [].aggregations.Aggregations.mean[*] type changed (any → number)

    • [].aggregations.Aggregations.min[*] type changed (any → number)

• reporting.graphs

  • Call parameters:

    • parameter options default value changed

• reporting.netdata_get_data

  • Return value:

    • [].aggregations.Aggregations.max[*] type changed (any → number)

    • [].aggregations.Aggregations.mean[*] type changed (any → number)

    • [].aggregations.Aggregations.min[*] type changed (any → number)

• reporting.netdata_graph

  • Return value:

    • [].aggregations.Aggregations.max[*] type changed (any → number)

    • [].aggregations.Aggregations.mean[*] type changed (any → number)

    • [].aggregations.Aggregations.min[*] type changed (any → number)

• reporting.netdata_graphs

  • Call parameters:

    • parameter options default value changed

reporting.exporters

• reporting.exporters.query

  • Call parameters:

    • parameter options default value changed

route

• route.system_routes

  • Call parameters:

    • parameter options default value changed

rsynctask

• rsynctask.query

  • Call parameters:

    • parameter options default value changed

s3.accesskey

• s3.accesskey.query

  • Call parameters:

    • parameter options default value changed

service

• service.query

  • Call parameters:

    • parameter options default value changed

sharing.nfs

• sharing.nfs.query

  • Call parameters:

    • parameter options default value changed

sharing.s3

• sharing.s3.query

  • Call parameters:

    • parameter options default value changed

sharing.smb

• sharing.smb.query

  • Call parameters:

    • parameter options default value changed

sharing.webshare

• sharing.webshare.query

  • Call parameters:

    • parameter options default value changed

smb

• smb.status

  • Call parameters:

    • parameter options default value changed

snmp

• snmp.config

  • Return value:

    • removed loglevel

• snmp.update

  • Call parameters:

    • removed snmp_update.loglevel

  • Return value:

    • removed loglevel

staticroute

• staticroute.query

  • Call parameters:

    • parameter options default value changed

system.ntpserver

• system.ntpserver.query

  • Call parameters:

    • parameter options default value changed

system.security

• system.security.update

  • Call parameters:

    • parameter system_security_update renamed to data

tunable

• tunable.create

  • Return value:

    • removed update_initramfs

• tunable.get_instance

  • Return value:

    • removed update_initramfs

• tunable.query

  • Call parameters:

    • parameter options default value changed

  • Return value:

    • removed TunableEntry.update_initramfs

    • removed TunableQueryResultItem.update_initramfs

    • removed [].update_initramfs

    • removed [].update_initramfs

• tunable.update

  • Return value:

    • removed update_initramfs

user

• user.query

  • Call parameters:

    • parameter options default value changed

vm

• vm.bootloader_ovmf_choices

  • Return value:

    • [*] type changed (any → string)

• vm.cpu_model_choices

  • Call parameters:

    • added parameter arch (optional)

  • Return value:

    • [*] type changed (any → string)

• vm.create

  • Return value:

    • devices[].attributes: added variant VMISCSIDiskDevice

    • added devices[].attributes.VMNICDevice.pci_address

    • uuid became required

    • uuid type changed (string | null → string)

• vm.get_instance

  • Return value:

    • devices[].attributes: added variant VMISCSIDiskDevice

    • added devices[].attributes.VMNICDevice.pci_address

    • uuid became required

    • uuid type changed (string | null → string)

• vm.guest_architecture_and_machine_choices

  • Return value:

    • [*] type changed (any → array)

• vm.query

  • Call parameters:

    • parameter options default value changed

  • Return value:

    • VMEntry.uuid became required

    • VMEntry.uuid type changed (string | null → string)

    • VMQueryResultItem.uuid type changed (string | null → string)

    • [].devices[].attributes: added variant VMISCSIDiskDevice

    • added [].devices[].attributes.VMNICDevice.pci_address

    • [].uuid became required

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

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

• vm.update

  • Return value:

    • devices[].attributes: added variant VMISCSIDiskDevice

    • added devices[].attributes.VMNICDevice.pci_address

    • uuid became required

    • uuid type changed (string | null → string)

vm.device

• vm.device.bind_choices

  • Return value:

    • [*] type changed (any → string)

• vm.device.create

  • Call parameters:

    • vm_device_create.attributes: added variant VMISCSIDiskDevice

    • added vm_device_create.attributes.VMNICDevice.pci_address

  • Return value:

    • attributes: added variant VMISCSIDiskDevice

    • added attributes.VMNICDevice.pci_address

• vm.device.disk_choices

  • Return value:

    • [*] type changed (any → string)

• vm.device.get_instance

  • Return value:

    • attributes: added variant VMISCSIDiskDevice

    • added attributes.VMNICDevice.pci_address

• vm.device.query

  • Call parameters:

    • parameter options default value changed

  • Return value:

    • [].attributes: added variant VMISCSIDiskDevice

    • added [].attributes.VMNICDevice.pci_address

    • [].attributes: added variant VMISCSIDiskDevice

    • added [].attributes.VMNICDevice.pci_address

• vm.device.update

  • Return value:

    • attributes: added variant VMISCSIDiskDevice

    • added attributes.VMNICDevice.pci_address

vmware

• vmware.query

  • Call parameters:

    • parameter options default value changed

webshare

• webshare.config

  • Return value:

    • added mcp_allow_write (required)

    • added mcp_allowed_groups (required)

    • added mcp_enabled (required)

• webshare.update

  • Call parameters:

    • added webshare_update.mcp_allow_write

    • added webshare_update.mcp_allowed_groups

    • added webshare_update.mcp_enabled

  • Return value:

    • added mcp_allow_write (required)

    • added mcp_allowed_groups (required)

    • added mcp_enabled (required)

zfs.resource

• zfs.resource.query

  • Call parameters:

    • parameter data became required

zfs.resource.snapshot

• zfs.resource.snapshot.clone

  • Call parameters:

    • added data.no_mount

zfs.tier

• zfs.tier.rewrite_job_failures

  • Call parameters:

    • zfs_tier_rewrite_job_failures.query-options default value changed

• zfs.tier.rewrite_job_query

  • Call parameters:

    • zfs_tier_rewrite_job_query.query-options default value changed