@corrreia/hl 0.1.1 → 0.2.0

package/dist/catalogs-BMSq1MuA.mjs

@@ -0,0 +1 @@
+const e=[{path:[`acme`,`dns`,`authenticator`,`authenticator-schemas`],summary:`Get the schemas for all DNS providers we support for ACME DNS Challenge and the respective attributes required for connecting to them while validating a DNS Challenge`,description:`Get the schemas for all DNS providers we support for ACME DNS Challenge and the respective attributes required for connecting to them while validating a DNS Challenge.`,method:`POST`,route:`/acme.dns.authenticator.authenticator_schemas`,params:[],hidden:!1,deprecated:!1,rpc:{method:`acme.dns.authenticator.authenticator_schemas`,params:[],job:!1,defaults:{}}},{path:[`acme`,`dns`,`authenticator`,`create`],summary:`Create a DNS Authenticator`,description:`Create a DNS Authenticator.`,method:`POST`,route:`/acme.dns.authenticator.create`,params:[],body:{required:!0,description:``,fields:[{wireName:`dns_authenticator_create`,flag:`dns-authenticator-create`,required:!0,description:`DNSAuthenticatorCreateArgs parameters.`,type:{kind:`json`}}]},hidden:!1,deprecated:!1,rpc:{method:`acme.dns.authenticator.create`,params:[`dns_authenticator_create`],job:!1,defaults:{}}},{path:[`acme`,`dns`,`authenticator`,`delete`],summary:"Delete DNS Authenticator of ``id``",description:"Delete DNS Authenticator of ``id``.",method:`POST`,route:`/acme.dns.authenticator.delete`,params:[],body:{required:!0,description:``,fields:[{wireName:`id`,flag:`id`,required:!0,description:`ID of the DNS authenticator to delete.`,type:{kind:`integer`}}]},confirmation:``,hidden:!1,deprecated:!1,rpc:{method:`acme.dns.authenticator.delete`,params:[`id`],job:!1,defaults:{}}},{path:[`acme`,`dns`,`authenticator`,`get-instance`],summary:"Returns instance matching `id`",description:"Returns instance matching `id`. If `id` is not found, Validation error is raised.",method:`POST`,route:`/acme.dns.authenticator.get_instance`,params:[],body:{required:!0,description:``,fields:[{wireName:`id`,flag:`id`,required:!0,description:``,type:{kind:`integer`}},{wireName:`options`,flag:`options`,required:!0,description:`Query options customize the results returned by a query method. More complete documentation with examples are covered in the "Query methods" section of the TrueNAS API documentation.`,type:{kind:`json`}}]},hidden:!1,deprecated:!1,rpc:{method:`acme.dns.authenticator.get_instance`,params:[`id`,`options`],job:!1,defaults:{}}},{path:[`acme`,`dns`,`authenticator`,`query`],summary:``,description:``,method:`POST`,route:`/acme.dns.authenticator.query`,params:[],body:{required:!1,description:``,fields:[{wireName:`filters`,flag:`filters`,required:!1,description:`List of filters for query results. See API documentation for "Query Methods" for more guidance.`,type:{kind:`array`,elem:{kind:`json`}}},{wireName:`options`,flag:`options`,required:!1,description:`Query options including pagination, ordering, and additional parameters.`,type:{kind:`json`}}]},hidden:!1,deprecated:!1,rpc:{method:`acme.dns.authenticator.query`,params:[`filters`,`options`],job:!1,defaults:{filters:[],options:{extra:{},order_by:[],select:[],count:!1,get:!1,offset:0,limit:0,force_sql_filters:!1}}}},{path:[`acme`,`dns`,`authenticator`,`update`],summary:"Update DNS Authenticator of ``id``",description:"Update DNS Authenticator of ``id``.",method:`POST`,route:`/acme.dns.authenticator.update`,params:[],body:{required:!0,description:``,fields:[{wireName:`id`,flag:`id`,required:!0,description:`ID of the DNS authenticator to update.`,type:{kind:`integer`}},{wireName:`dns_authenticator_update`,flag:`dns-authenticator-update`,required:!0,description:`Updated DNS authenticator configuration data.`,type:{kind:`json`}}]},hidden:!1,deprecated:!1,rpc:{method:`acme.dns.authenticator.update`,params:[`id`,`dns_authenticator_update`],job:!1,defaults:{}}},{path:[`alert`,`dismiss`],summary:"Dismiss ``id`` alert",description:"Dismiss ``id`` alert.",method:`POST`,route:`/alert.dismiss`,params:[],body:{required:!0,description:``,fields:[{wireName:`uuid`,flag:`uuid`,required:!0,description:`UUID of the alert to dismiss.`,type:{kind:`string`}}]},hidden:!1,deprecated:!1,rpc:{method:`alert.dismiss`,params:[`uuid`],job:!1,defaults:{}}},{path:[`alert`,`list`],summary:`List all types of alerts including active/dismissed currently in the system`,description:`List all types of alerts including active/dismissed currently in the system.`,method:`POST`,route:`/alert.list`,params:[],hidden:!1,deprecated:!1,rpc:{method:`alert.list`,params:[],job:!1,defaults:{}}},{path:[`alert`,`list-categories`],summary:`List all types of alerts which the system can issue`,description:`List all types of alerts which the system can issue.`,method:`POST`,route:`/alert.list_categories`,params:[],hidden:!1,deprecated:!1,rpc:{method:`alert.list_categories`,params:[],job:!1,defaults:{}}},{path:[`alert`,`list-policies`],summary:`List all alert policies which indicate the frequency of the alerts`,description:`List all alert policies which indicate the frequency of the alerts.`,method:`POST`,route:`/alert.list_policies`,params:[],hidden:!1,deprecated:!1,rpc:{method:`alert.list_policies`,params:[],job:!1,defaults:{}}},{path:[`alert`,`restore`],summary:"Restore ``id`` alert which had been dismissed",description:"Restore ``id`` alert which had been dismissed.",method:`POST`,route:`/alert.restore`,params:[],body:{required:!0,description:``,fields:[{wireName:`uuid`,flag:`uuid`,required:!0,description:`UUID of the dismissed alert to restore.`,type:{kind:`string`}}]},hidden:!1,deprecated:!1,rpc:{method:`alert.restore`,params:[`uuid`],job:!1,defaults:{}}},{path:[`alertclasses`,`config`],summary:``,description:``,method:`POST`,route:`/alertclasses.config`,params:[],hidden:!1,deprecated:!1,rpc:{method:`alertclasses.config`,params:[],job:!1,defaults:{}}},{path:[`alertclasses`,`update`],summary:`Update default Alert settings`,description:`Update default Alert settings.`,method:`POST`,route:`/alertclasses.update`,params:[],body:{required:!0,description:``,fields:[{wireName:`alert_class_update`,flag:`alert-class-update`,required:!0,description:`Updated alert class configuration settings.`,type:{kind:`json`}}]},hidden:!1,deprecated:!1,rpc:{method:`alertclasses.update`,params:[`alert_class_update`],job:!1,defaults:{}}},{path:[`alertservice`,`create`],summary:"Create an Alert Service of specified ``type``",description:"Create an Alert Service of specified ``type``.",method:`POST`,route:`/alertservice.create`,params:[],body:{required:!0,description:``,fields:[{wireName:`alert_service_create`,flag:`alert-service-create`,required:!0,description:`Alert service configuration data for the new service.`,type:{kind:`json`}}]},hidden:!1,deprecated:!1,rpc:{method:`alertservice.create`,params:[`alert_service_create`],job:!1,defaults:{}}},{path:[`alertservice`,`delete`],summary:"Delete Alert Service of ``id``",description:"Delete Alert Service of ``id``.",method:`POST`,route:`/alertservice.delete`,params:[],body:{required:!0,description:``,fields:[{wireName:`id`,flag:`id`,required:!0,description:`ID of the alert service to delete.`,type:{kind:`integer`}}]},confirmation:``,hidden:!1,deprecated:!1,rpc:{method:`alertservice.delete`,params:[`id`],job:!1,defaults:{}}},{path:[`alertservice`,`get-instance`],summary:"Returns instance matching `id`",description:"Returns instance matching `id`. If `id` is not found, Validation error is raised.",method:`POST`,route:`/alertservice.get_instance`,params:[],body:{required:!0,description:``,fields:[{wireName:`id`,flag:`id`,required:!0,description:``,type:{kind:`integer`}},{wireName:`options`,flag:`options`,required:!0,description:`Query options customize the results returned by a query method. More complete documentation with examples are covered in the "Query methods" section of the TrueNAS API documentation.`,type:{kind:`json`}}]},hidden:!1,deprecated:!1,rpc:{method:`alertservice.get_instance`,params:[`id`,`options`],job:!1,defaults:{}}},{path:[`alertservice`,`query`],summary:``,description:``,method:`POST`,route:`/alertservice.query`,params:[],body:{required:!1,description:``,fields:[{wireName:`filters`,flag:`filters`,required:!1,description:`List of filters for query results. See API documentation for "Query Methods" for more guidance.`,type:{kind:`array`,elem:{kind:`json`}}},{wireName:`options`,flag:`options`,required:!1,description:`Query options including pagination, ordering, and additional parameters.`,type:{kind:`json`}}]},hidden:!1,deprecated:!1,rpc:{method:`alertservice.query`,params:[`filters`,`options`],job:!1,defaults:{filters:[],options:{extra:{},order_by:[],select:[],count:!1,get:!1,offset:0,limit:0,force_sql_filters:!1}}}},{path:[`alertservice`,`test`],summary:"Send a test alert using ``type`` of Alert Service",description:"Send a test alert using ``type`` of Alert Service.",method:`POST`,route:`/alertservice.test`,params:[],body:{required:!0,description:``,fields:[{wireName:`alert_service_create`,flag:`alert-service-create`,required:!0,description:`Alert service configuration to test for connectivity and functionality.`,type:{kind:`json`}}]},hidden:!1,deprecated:!1,rpc:{method:`alertservice.test`,params:[`alert_service_create`],job:!1,defaults:{}}},{path:[`alertservice`,`update`],summary:"Update Alert Service of ``id``",description:"Update Alert Service of ``id``.",method:`POST`,route:`/alertservice.update`,params:[],body:{required:!0,description:``,fields:[{wireName:`id`,flag:`id`,required:!0,description:`ID of the alert service to update.`,type:{kind:`integer`}},{wireName:`alert_service_update`,flag:`alert-service-update`,required:!0,description:`Updated alert service configuration data.`,type:{kind:`json`}}]},hidden:!1,deprecated:!1,rpc:{method:`alertservice.update`,params:[`id`,`alert_service_update`],job:!1,defaults:{}}},{path:[`api-key`,`create`],summary:`Create an API key`,description:`Create an API key.`,method:`POST`,route:`/api_key.create`,params:[],body:{required:!0,description:``,fields:[{wireName:`api_key_create`,flag:`api-key-create`,required:!0,description:`API key configuration data for the new key.`,type:{kind:`json`}}]},hidden:!1,deprecated:!1,rpc:{method:`api_key.create`,params:[`api_key_create`],job:!1,defaults:{}}},{path:[`api-key`,`delete`],summary:"Delete API Key ``id``",description:"Delete API Key ``id``.",method:`POST`,route:`/api_key.delete`,params:[],body:{required:!0,description:``,fields:[{wireName:`id`,flag:`id`,required:!0,description:`ID of the API key to delete.`,type:{kind:`integer`}}]},confirmation:``,hidden:!1,deprecated:!1,rpc:{method:`api_key.delete`,params:[`id`],job:!1,defaults:{}}},{path:[`api-key`,`get-instance`],summary:"Returns instance matching `id`",description:"Returns instance matching `id`. If `id` is not found, Validation error is raised.",method:`POST`,route:`/api_key.get_instance`,params:[],body:{required:!0,description:``,fields:[{wireName:`id`,flag:`id`,required:!0,description:``,type:{kind:`integer`}},{wireName:`options`,flag:`options`,required:!0,description:`Query options customize the results returned by a query method. More complete documentation with examples are covered in the "Query methods" section of the TrueNAS API documentation.`,type:{kind:`json`}}]},hidden:!1,deprecated:!1,rpc:{method:`api_key.get_instance`,params:[`id`,`options`],job:!1,defaults:{}}},{path:[`api-key`,`my-keys`],summary:`Get the existing API keys for the currently authenticated user`,description:`Get the existing API keys for the currently authenticated user.`,method:`POST`,route:`/api_key.my_keys`,params:[],hidden:!1,deprecated:!1,rpc:{method:`api_key.my_keys`,params:[],job:!1,defaults:{}}},{path:[`api-key`,`query`],summary:``,description:``,method:`POST`,route:`/api_key.query`,params:[],body:{required:!1,description:``,fields:[{wireName:`filters`,flag:`filters`,required:!1,description:`List of filters for query results. See API documentation for "Query Methods" for more guidance.`,type:{kind:`array`,elem:{kind:`json`}}},{wireName:`options`,flag:`options`,required:!1,description:`Query options including pagination, ordering, and additional parameters.`,type:{kind:`json`}}]},hidden:!1,deprecated:!1,rpc:{method:`api_key.query`,params:[`filters`,`options`],job:!1,defaults:{filters:[],options:{extra:{},order_by:[],select:[],count:!1,get:!1,offset:0,limit:0,force_sql_filters:!1}}}},{path:[`api-key`,`update`],summary:"Update API Key ``id``",description:"Update API Key ``id``.",method:`POST`,route:`/api_key.update`,params:[],body:{required:!0,description:``,fields:[{wireName:`id`,flag:`id`,required:!0,description:`ID of the API key to update.`,type:{kind:`integer`}},{wireName:`api_key_update`,flag:`api-key-update`,required:!0,description:`Updated API key configuration data.`,type:{kind:`json`}}]},hidden:!1,deprecated:!1,rpc:{method:`api_key.update`,params:[`id`,`api_key_update`],job:!1,defaults:{}}},{path:[`app`,`available`],summary:`Retrieve all available applications from all configured catalogs`,description:`Retrieve all available applications from all configured catalogs.`,method:`POST`,route:`/app.available`,params:[],body:{required:!1,description:``,fields:[{wireName:`filters`,flag:`filters`,required:!1,description:`List of filters for query results. See API documentation for "Query Methods" for more guidance.`,type:{kind:`array`,elem:{kind:`json`}}},{wireName:`options`,flag:`options`,required:!1,description:`Query options including pagination, ordering, and additional parameters.`,type:{kind:`json`}}]},hidden:!1,deprecated:!1,rpc:{method:`app.available`,params:[`filters`,`options`],job:!1,defaults:{filters:[],options:{extra:{},order_by:[],select:[],count:!1,get:!1,offset:0,limit:0,force_sql_filters:!1}}}},{path:[`app`,`available-space`],summary:`Returns space available in bytes in the configured apps pool which apps can consume`,description:`Returns space available in bytes in the configured apps pool which apps can consume.`,method:`POST`,route:`/app.available_space`,params:[],hidden:!1,deprecated:!1,rpc:{method:`app.available_space`,params:[],job:!1,defaults:{}}},{path:[`app`,`categories`],summary:`Retrieve list of valid categories which have associated applications`,description:`Retrieve list of valid categories which have associated applications.`,method:`POST`,route:`/app.categories`,params:[],hidden:!1,deprecated:!1,rpc:{method:`app.categories`,params:[],job:!1,defaults:{}}},{path:[`app`,`certificate-choices`],summary:`Returns certificates which can be used by applications`,description:`Returns certificates which can be used by applications.`,method:`POST`,route:`/app.certificate_choices`,params:[],hidden:!1,deprecated:!1,rpc:{method:`app.certificate_choices`,params:[],job:!1,defaults:{}}},{path:[`app`,`config`],summary:"Retrieve user specified configuration of ``app_name``",description:"Retrieve user specified configuration of ``app_name``.",method:`POST`,route:`/app.config`,params:[],body:{required:!0,description:``,fields:[{wireName:`app_name`,flag:`app-name`,required:!0,description:`Name of the application to retrieve configuration for.`,type:{kind:`string`}}]},hidden:!1,deprecated:!1,rpc:{method:`app.config`,params:[`app_name`],job:!1,defaults:{}}},{path:[`app`,`container-console-choices`],summary:"Returns container console choices for ``app_name``",description:"Returns container console choices for ``app_name``.",method:`POST`,route:`/app.container_console_choices`,params:[],body:{required:!0,description:``,fields:[{wireName:`app_name`,flag:`app-name`,required:!0,description:`Name of the application to get console choices for.`,type:{kind:`string`}}]},hidden:!1,deprecated:!1,rpc:{method:`app.container_console_choices`,params:[`app_name`],job:!1,defaults:{}}},{path:[`app`,`container-ids`],summary:"Returns container IDs for ``app_name``",description:"Returns container IDs for ``app_name``.",method:`POST`,route:`/app.container_ids`,params:[],body:{required:!0,description:``,fields:[{wireName:`app_name`,flag:`app-name`,required:!0,description:`Name of the application to get container IDs for.`,type:{kind:`string`}},{wireName:`options`,flag:`options`,required:!1,description:`Options for filtering the returned container list.`,type:{kind:`json`}}]},hidden:!1,deprecated:!1,rpc:{method:`app.container_ids`,params:[`app_name`,`options`],job:!1,defaults:{options:{alive_only:!0}}}},{path:[`app`,`convert-to-custom`],summary:"Convert ``app_name`` to a custom app",description:"Convert ``app_name`` to a custom app.",method:`POST`,route:`/app.convert_to_custom`,params:[],body:{required:!0,description:``,fields:[{wireName:`app_name`,flag:`app-name`,required:!0,description:`Name of the catalog application to convert to a custom application.`,type:{kind:`string`}}]},hidden:!1,deprecated:!1,rpc:{method:`app.convert_to_custom`,params:[`app_name`],job:!0,defaults:{}}},{path:[`app`,`create`],summary:"Create an app with ``app_name`` using ``catalog_app`` with ``train`` and ``version``",description:"Create an app with ``app_name`` using ``catalog_app`` with ``train`` and ``version``.",method:`POST`,route:`/app.create`,params:[],body:{required:!0,description:``,fields:[{wireName:`app_create`,flag:`app-create`,required:!0,description:`AppCreateArgs parameters.`,type:{kind:`json`}}]},hidden:!1,deprecated:!1,rpc:{method:`app.create`,params:[`app_create`],job:!0,defaults:{}}},{path:[`app`,`delete`],summary:"Delete ``app_name`` app",description:"Delete ``app_name`` app.",method:`POST`,route:`/app.delete`,params:[],body:{required:!0,description:``,fields:[{wireName:`app_name`,flag:`app-name`,required:!0,description:`Name of the application to delete.`,type:{kind:`string`}},{wireName:`options`,flag:`options`,required:!1,description:`Options controlling what gets removed along with the application.`,type:{kind:`json`}}]},confirmation:``,hidden:!1,deprecated:!1,rpc:{method:`app.delete`,params:[`app_name`,`options`],job:!0,defaults:{options:{remove_images:!0,remove_ix_volumes:!1,force_remove_ix_volumes:!1,force_remove_custom_app:!1}}}},{path:[`app`,`get-instance`],summary:"Returns instance matching `id`",description:"Returns instance matching `id`. If `id` is not found, Validation error is raised.",method:`POST`,route:`/app.get_instance`,params:[],body:{required:!0,description:``,fields:[{wireName:`id`,flag:`id`,required:!0,description:``,type:{kind:`string`}},{wireName:`options`,flag:`options`,required:!0,description:`Query options customize the results returned by a query method. More complete documentation with examples are covered in the "Query methods" section of the TrueNAS API documentation.`,type:{kind:`json`}}]},hidden:!1,deprecated:!1,rpc:{method:`app.get_instance`,params:[`id`,`options`],job:!1,defaults:{}}},{path:[`app`,`gpu-choices`],summary:`Returns GPU choices which can be used by applications`,description:`Returns GPU choices which can be used by applications.`,method:`POST`,route:`/app.gpu_choices`,params:[],hidden:!1,deprecated:!1,rpc:{method:`app.gpu_choices`,params:[],job:!1,defaults:{}}},{path:[`app`,`ip-choices`],summary:`Returns IP choices which can be used by applications`,description:`Returns IP choices which can be used by applications.`,method:`POST`,route:`/app.ip_choices`,params:[],hidden:!1,deprecated:!1,rpc:{method:`app.ip_choices`,params:[],job:!1,defaults:{}}},{path:[`app`,`latest`],summary:`Retrieve latest updated apps`,description:`Retrieve latest updated apps.`,method:`POST`,route:`/app.latest`,params:[],body:{required:!1,description:``,fields:[{wireName:`filters`,flag:`filters`,required:!1,description:`List of filters for query results. See API documentation for "Query Methods" for more guidance.`,type:{kind:`array`,elem:{kind:`json`}}},{wireName:`options`,flag:`options`,required:!1,description:`Query options including pagination, ordering, and additional parameters.`,type:{kind:`json`}}]},hidden:!1,deprecated:!1,rpc:{method:`app.latest`,params:[`filters`,`options`],job:!1,defaults:{filters:[],options:{extra:{},order_by:[],select:[],count:!1,get:!1,offset:0,limit:0,force_sql_filters:!1}}}},{path:[`app`,`outdated-docker-images`],summary:"Returns a list of outdated docker images for the specified app ``name``",description:"Returns a list of outdated docker images for the specified app ``name``.",method:`POST`,route:`/app.outdated_docker_images`,params:[],body:{required:!0,description:``,fields:[{wireName:`app_name`,flag:`app-name`,required:!0,description:`Name of the application to check for outdated Docker images.`,type:{kind:`string`}}]},hidden:!1,deprecated:!1,rpc:{method:`app.outdated_docker_images`,params:[`app_name`],job:!1,defaults:{}}},{path:[`app`,`pull-images`],summary:"Pulls docker images for the specified app ``name``",description:"Pulls docker images for the specified app ``name``.",method:`POST`,route:`/app.pull_images`,params:[],body:{required:!0,description:``,fields:[{wireName:`app_name`,flag:`app-name`,required:!0,description:`Name of the application to pull images for.`,type:{kind:`string`}},{wireName:`options`,flag:`options`,required:!1,description:`Options for pulling images including whether to redeploy.`,type:{kind:`json`}}]},hidden:!1,deprecated:!1,rpc:{method:`app.pull_images`,params:[`app_name`,`options`],job:!0,defaults:{options:{redeploy:!0}}}},{path:[`app`,`query`],summary:"Query all apps with ``query-filters`` and ``query-options``",description:"Query all apps with ``query-filters`` and ``query-options``.",method:`POST`,route:`/app.query`,params:[],body:{required:!1,description:``,fields:[{wireName:`filters`,flag:`filters`,required:!1,description:`List of filters for query results. See API documentation for "Query Methods" for more guidance.`,type:{kind:`array`,elem:{kind:`json`}}},{wireName:`options`,flag:`options`,required:!1,description:`Query options including pagination, ordering, and additional parameters.`,type:{kind:`json`}}]},hidden:!1,deprecated:!1,rpc:{method:`app.query`,params:[`filters`,`options`],job:!1,defaults:{filters:[],options:{extra:{},order_by:[],select:[],count:!1,get:!1,offset:0,limit:0,force_sql_filters:!1}}}},{path:[`app`,`redeploy`],summary:"Redeploy ``app_name`` app",description:"Redeploy ``app_name`` app.",method:`POST`,route:`/app.redeploy`,params:[],body:{required:!0,description:``,fields:[{wireName:`app_name`,flag:`app-name`,required:!0,description:`Name of the application to redeploy (stop, pull latest images, and restart).`,type:{kind:`string`}}]},hidden:!1,deprecated:!1,rpc:{method:`app.redeploy`,params:[`app_name`],job:!0,defaults:{}}},{path:[`app`,`rollback`],summary:"Rollback ``app_name`` app to previous version",description:"Rollback ``app_name`` app to previous version.",method:`POST`,route:`/app.rollback`,params:[],body:{required:!0,description:``,fields:[{wireName:`app_name`,flag:`app-name`,required:!0,description:`Name of the application to rollback.`,type:{kind:`string`}},{wireName:`options`,flag:`options`,required:!0,description:`Rollback options.`,type:{kind:`json`}}]},confirmation:``,hidden:!1,deprecated:!1,rpc:{method:`app.rollback`,params:[`app_name`,`options`],job:!0,defaults:{}}},{path:[`app`,`rollback-versions`],summary:"Retrieve versions available for rollback for ``app_name`` app",description:"Retrieve versions available for rollback for ``app_name`` app.",method:`POST`,route:`/app.rollback_versions`,params:[],body:{required:!0,description:``,fields:[{wireName:`app_name`,flag:`app-name`,required:!0,description:`Name of the application to get rollback versions for.`,type:{kind:`string`}}]},hidden:!1,deprecated:!1,rpc:{method:`app.rollback_versions`,params:[`app_name`],job:!1,defaults:{}}},{path:[`app`,`similar`],summary:"Retrieve applications which are similar to ``app_name``",description:"Retrieve applications which are similar to ``app_name``.",method:`POST`,route:`/app.similar`,params:[],body:{required:!0,description:``,fields:[{wireName:`app_name`,flag:`app-name`,required:!0,description:`Name of the application to find similar apps for.`,type:{kind:`string`}},{wireName:`train`,flag:`train`,required:!0,description:`The catalog train to search within.`,type:{kind:`string`}}]},hidden:!1,deprecated:!1,rpc:{method:`app.similar`,params:[`app_name`,`train`],job:!1,defaults:{}}},{path:[`app`,`start`],summary:"Start ``app_name`` app",description:"Start ``app_name`` app.",method:`POST`,route:`/app.start`,params:[],body:{required:!0,description:``,fields:[{wireName:`app_name`,flag:`app-name`,required:!0,description:`Name of the application to start.`,type:{kind:`string`}}]},hidden:!1,deprecated:!1,rpc:{method:`app.start`,params:[`app_name`],job:!0,defaults:{}}},{path:[`app`,`stop`],summary:"Stop ``app_name`` app",description:"Stop ``app_name`` app.",method:`POST`,route:`/app.stop`,params:[],body:{required:!0,description:``,fields:[{wireName:`app_name`,flag:`app-name`,required:!0,description:`Name of the application to stop.`,type:{kind:`string`}}]},hidden:!1,deprecated:!1,rpc:{method:`app.stop`,params:[`app_name`],job:!0,defaults:{}}},{path:[`app`,`update`],summary:"Update ``app_name`` app with new configuration",description:"Update ``app_name`` app with new configuration.",method:`POST`,route:`/app.update`,params:[],body:{required:!0,description:``,fields:[{wireName:`app_name`,flag:`app-name`,required:!0,description:`Name of the application to update.`,type:{kind:`string`}},{wireName:`update`,flag:`update`,required:!1,description:`Updated configuration and settings for the application.`,type:{kind:`json`}}]},hidden:!1,deprecated:!1,rpc:{method:`app.update`,params:[`app_name`,`update`],job:!0,defaults:{update:{values:`{}`,custom_compose_config:`{}`,custom_compose_config_string:``}}}},{path:[`app`,`upgrade`],summary:"Upgrade ``app_name`` app to ``app_version``",description:"Upgrade ``app_name`` app to ``app_version``.",method:`POST`,route:`/app.upgrade`,params:[],body:{required:!0,description:``,fields:[{wireName:`app_name`,flag:`app-name`,required:!0,description:`Name of the application to upgrade.`,type:{kind:`string`}},{wireName:`options`,flag:`options`,required:!1,description:`Options controlling the upgrade process including target version and snapshot behavior.`,type:{kind:`json`}}]},hidden:!1,deprecated:!1,rpc:{method:`app.upgrade`,params:[`app_name`,`options`],job:!0,defaults:{options:{app_version:`latest`,values:`{}`,snapshot_hostpaths:!1}}}},{path:[`app`,`upgrade-summary`],summary:"Retrieve upgrade summary for ``app_name``",description:"Retrieve upgrade summary for ``app_name``.",method:`POST`,route:`/app.upgrade_summary`,params:[],body:{required:!0,description:``,fields:[{wireName:`app_name`,flag:`app-name`,required:!0,description:`Name of the application to get upgrade summary for.`,type:{kind:`string`}},{wireName:`options`,flag:`options`,required:!1,description:`Options specifying the target version for the summary.`,type:{kind:`json`}}]},hidden:!1,deprecated:!1,rpc:{method:`app.upgrade_summary`,params:[`app_name`,`options`],job:!1,defaults:{options:{app_version:`latest`}}}},{path:[`app`,`used-host-ips`],summary:`Returns host IPs in use by applications`,description:`Returns host IPs in use by applications.`,method:`POST`,route:`/app.used_host_ips`,params:[],hidden:!1,deprecated:!1,rpc:{method:`app.used_host_ips`,params:[],job:!1,defaults:{}}},{path:[`app`,`used-ports`],summary:`Returns ports in use by applications`,description:`Returns ports in use by applications.`,method:`POST`,route:`/app.used_ports`,params:[],hidden:!1,deprecated:!1,rpc:{method:`app.used_ports`,params:[],job:!1,defaults:{}}},{path:[`app`,`image`,`delete`],summary:"Delete docker image ``image_id``",description:"Delete docker image ``image_id``.",method:`POST`,route:`/app.image.delete`,params:[],body:{required:!0,description:``,fields:[{wireName:`image_id`,flag:`image-id`,required:!0,description:`Container image ID or reference to delete.`,type:{kind:`string`}},{wireName:`options`,flag:`options`,required:!1,description:`Deletion options controlling force removal behavior.`,type:{kind:`json`}}]},confirmation:``,hidden:!1,deprecated:!1,rpc:{method:`app.image.delete`,params:[`image_id`,`options`],job:!1,defaults:{options:{force:!1}}}},{path:[`app`,`image`,`dockerhub-rate-limit`],summary:`Returns the current rate-limit information for the Docker Hub registry`,description:`Returns the current rate-limit information for the Docker Hub registry.`,method:`POST`,route:`/app.image.dockerhub_rate_limit`,params:[],hidden:!1,deprecated:!1,rpc:{method:`app.image.dockerhub_rate_limit`,params:[],job:!1,defaults:{}}},{path:[`app`,`image`,`get-instance`],summary:"Returns instance matching `id_`",description:"Returns instance matching `id_`. Raises InstanceNotFound if missing.",method:`POST`,route:`/app.image.get_instance`,params:[],body:{required:!0,description:``,fields:[{wireName:`id`,flag:`id`,required:!0,description:``,type:{kind:`string`}},{wireName:`options`,flag:`options`,required:!0,description:`Query options customize the results returned by a query method. More complete documentation with examples are covered in the "Query methods" section of the TrueNAS API documentation.`,type:{kind:`json`}}]},hidden:!1,deprecated:!1,rpc:{method:`app.image.get_instance`,params:[`id`,`options`],job:!1,defaults:{}}},{path:[`app`,`image`,`pull`],summary:`Pull a docker image`,description:`Pull a docker image.`,method:`POST`,route:`/app.image.pull`,params:[],body:{required:!0,description:``,fields:[{wireName:`image_pull`,flag:`image-pull`,required:!0,description:`AppImagePullArgs parameters.`,type:{kind:`json`}}]},hidden:!1,deprecated:!1,rpc:{method:`app.image.pull`,params:[`image_pull`],job:!0,defaults:{}}},{path:[`app`,`image`,`query`],summary:"Query all docker images with ``query-filters`` and ``query-options``",description:"Query all docker images with ``query-filters`` and ``query-options``.",method:`POST`,route:`/app.image.query`,params:[],body:{required:!1,description:``,fields:[{wireName:`filters`,flag:`filters`,required:!1,description:`List of filters for query results. See API documentation for "Query Methods" for more guidance.`,type:{kind:`array`,elem:{kind:`json`}}},{wireName:`options`,flag:`options`,required:!1,description:`Query options including pagination, ordering, and additional parameters.`,type:{kind:`json`}}]},hidden:!1,deprecated:!1,rpc:{method:`app.image.query`,params:[`filters`,`options`],job:!1,defaults:{filters:[],options:{extra:{},order_by:[],select:[],count:!1,get:!1,offset:0,limit:0,force_sql_filters:!1}}}},{path:[`app`,`ix-volume`,`exists`],summary:"Check if ix-volumes exist for ``name`` application",description:"Check if ix-volumes exist for ``name`` application.",method:`POST`,route:`/app.ix_volume.exists`,params:[],body:{required:!0,description:``,fields:[{wireName:`name`,flag:`name`,required:!0,description:`Name of the iX volume to check for existence.`,type:{kind:`string`}}]},hidden:!1,deprecated:!1,rpc:{method:`app.ix_volume.exists`,params:[`name`],job:!1,defaults:{}}},{path:[`app`,`ix-volume`,`query`],summary:"Query ix-volumes with `filters` and `options`",description:"Query ix-volumes with `filters` and `options`.",method:`POST`,route:`/app.ix_volume.query`,params:[],body:{required:!1,description:``,fields:[{wireName:`filters`,flag:`filters`,required:!1,description:`List of filters for query results. See API documentation for "Query Methods" for more guidance.`,type:{kind:`array`,elem:{kind:`json`}}},{wireName:`options`,flag:`options`,required:!1,description:`Query options including pagination, ordering, and additional parameters.`,type:{kind:`json`}}]},hidden:!1,deprecated:!1,rpc:{method:`app.ix_volume.query`,params:[`filters`,`options`],job:!1,defaults:{filters:[],options:{extra:{},order_by:[],select:[],count:!1,get:!1,offset:0,limit:0,force_sql_filters:!1}}}},{path:[`app`,`registry`,`create`],summary:`Create an app registry entry`,description:`Create an app registry entry.`,method:`POST`,route:`/app.registry.create`,params:[],body:{required:!0,description:``,fields:[{wireName:`app_registry_create`,flag:`app-registry-create`,required:!0,description:`Container registry configuration data for the new registry.`,type:{kind:`json`}}]},hidden:!1,deprecated:!1,rpc:{method:`app.registry.create`,params:[`app_registry_create`],job:!1,defaults:{}}},{path:[`app`,`registry`,`delete`],summary:`Delete an app registry entry`,description:`Delete an app registry entry.`,method:`POST`,route:`/app.registry.delete`,params:[],body:{required:!0,description:``,fields:[{wireName:`id`,flag:`id`,required:!0,description:`ID of the container registry to delete.`,type:{kind:`integer`}}]},confirmation:``,hidden:!1,deprecated:!1,rpc:{method:`app.registry.delete`,params:[`id`],job:!1,defaults:{}}},{path:[`app`,`registry`,`get-instance`],summary:"Returns instance matching `id`",description:"Returns instance matching `id`. If `id` is not found, Validation error is raised.",method:`POST`,route:`/app.registry.get_instance`,params:[],body:{required:!0,description:``,fields:[{wireName:`id`,flag:`id`,required:!0,description:``,type:{kind:`integer`}},{wireName:`options`,flag:`options`,required:!0,description:`Query options customize the results returned by a query method. More complete documentation with examples are covered in the "Query methods" section of the TrueNAS API documentation.`,type:{kind:`json`}}]},hidden:!1,deprecated:!1,rpc:{method:`app.registry.get_instance`,params:[`id`,`options`],job:!1,defaults:{}}},{path:[`app`,`registry`,`query`],summary:``,description:``,method:`POST`,route:`/app.registry.query`,params:[],body:{required:!1,description:``,fields:[{wireName:`filters`,flag:`filters`,required:!1,description:`List of filters for query results. See API documentation for "Query Methods" for more guidance.`,type:{kind:`array`,elem:{kind:`json`}}},{wireName:`options`,flag:`options`,required:!1,description:`Query options including pagination, ordering, and additional parameters.`,type:{kind:`json`}}]},hidden:!1,deprecated:!1,rpc:{method:`app.registry.query`,params:[`filters`,`options`],job:!1,defaults:{filters:[],options:{extra:{},order_by:[],select:[],count:!1,get:!1,offset:0,limit:0,force_sql_filters:!1}}}},{path:[`app`,`registry`,`update`],summary:`Update an app registry entry`,description:`Update an app registry entry.`,method:`POST`,route:`/app.registry.update`,params:[],body:{required:!0,description:``,fields:[{wireName:`id`,flag:`id`,required:!0,description:`ID of the container registry to update.`,type:{kind:`integer`}},{wireName:`data`,flag:`data`,required:!0,description:`Updated container registry configuration data.`,type:{kind:`json`}}]},hidden:!1,deprecated:!1,rpc:{method:`app.registry.update`,params:[`id`,`data`],job:!1,defaults:{}}},{path:[`audit`,`config`],summary:``,description:``,method:`POST`,route:`/audit.config`,params:[],hidden:!1,deprecated:!1,rpc:{method:`audit.config`,params:[],job:!1,defaults:{}}},{path:[`audit`,`export`],summary:"Generate an audit report based on the specified ``query-filters`` and ``query-options`` for the specified ``services`` in the specified ``export_format``",description:"Generate an audit report based on the specified ``query-filters`` and ``query-options`` for the specified ``services`` in the specified ``export_format``.",method:`POST`,route:`/audit.export`,params:[],body:{required:!0,description:``,fields:[{wireName:`data`,flag:`data`,required:!0,description:`Audit export configuration specifying services, filters, and format.`,type:{kind:`json`}}]},confirmation:``,hidden:!1,deprecated:!1,rpc:{method:`audit.export`,params:[`data`],job:!0,defaults:{}}},{path:[`audit`,`query`],summary:"Query contents of audit databases specified by ``services``",description:"Query contents of audit databases specified by ``services``.",method:`POST`,route:`/audit.query`,params:[],body:{required:!0,description:``,fields:[{wireName:`data`,flag:`data`,required:!0,description:`Audit query configuration specifying services, filters, and options.`,type:{kind:`json`}}]},hidden:!1,deprecated:!1,rpc:{method:`audit.query`,params:[`data`],job:!1,defaults:{}}},{path:[`audit`,`update`],summary:`Update default audit settings`,description:`Update default audit settings.`,method:`POST`,route:`/audit.update`,params:[],body:{required:!0,description:``,fields:[{wireName:`data`,flag:`data`,required:!0,description:`Updated audit configuration settings.`,type:{kind:`json`}}]},hidden:!1,deprecated:!1,rpc:{method:`audit.update`,params:[`data`],job:!1,defaults:{}}},{path:[`auth`,`generate-onetime-password`],summary:`Generate a password for the specified username that may be used only a single time to authenticate to TrueNAS`,description:`Generate a password for the specified username that may be used only a single time to authenticate to TrueNAS. This may be used by server administrators to allow users authenticate and then set a proper password and two-factor authentication token.`,method:`POST`,route:`/auth.generate_onetime_password`,params:[],body:{required:!0,description:``,fields:[{wireName:`generate_single_use_password`,flag:`generate-single-use-password`,required:!0,description:`AuthGenerateOnetimePasswordArgs parameters.`,type:{kind:`json`}}]},hidden:!1,deprecated:!1,rpc:{method:`auth.generate_onetime_password`,params:[`generate_single_use_password`],job:!1,defaults:{}}},{path:[`auth`,`generate-token`],summary:`Generate a token to be used for authentication`,description:`Generate a token to be used for authentication.`,method:`POST`,route:`/auth.generate_token`,params:[],body:{required:!1,description:``,fields:[{wireName:`ttl`,flag:`ttl`,required:!1,description:"Time-to-live for the token in seconds or `null` for no expiration (default 600).",type:{kind:`integer`}},{wireName:`attrs`,flag:`attrs`,required:!1,description:`Additional attributes to embed in the token.`,type:{kind:`json`}},{wireName:`match_origin`,flag:`match-origin`,required:!1,description:`Whether the token must be used from the same origin that created it.`,type:{kind:`boolean`}},{wireName:`single_use`,flag:`single-use`,required:!1,description:`Whether the token can only be used once.`,type:{kind:`boolean`}}]},hidden:!1,deprecated:!1,rpc:{method:`auth.generate_token`,params:[`ttl`,`attrs`,`match_origin`,`single_use`],job:!1,defaults:{ttl:600,attrs:{},match_origin:!0,single_use:!1}}},{path:[`auth`,`login`],summary:`Authenticate session using username and password`,description:`Authenticate session using username and password.`,method:`POST`,route:`/auth.login`,params:[],body:{required:!0,description:``,fields:[{wireName:`username`,flag:`username`,required:!0,description:`Username for authentication.`,type:{kind:`string`}},{wireName:`password`,flag:`password`,required:!0,description:`Password for authentication.`,type:{kind:`string`}},{wireName:`otp_token`,flag:`otp-token`,required:!1,description:"One-time password token for two-factor authentication or `null`.",type:{kind:`string`}}]},hidden:!1,deprecated:!1,rpc:{method:`auth.login`,params:[`username`,`password`,`otp_token`],job:!1,defaults:{otp_token:``}}},{path:[`auth`,`login-ex`],summary:`Authenticate using one of a variety of mechanisms`,description:`Authenticate using one of a variety of mechanisms.`,method:`POST`,route:`/auth.login_ex`,params:[],body:{required:!0,description:``,fields:[{wireName:`login_data`,flag:`login-data`,required:!0,description:`Authentication data specifying mechanism and credentials.`,type:{kind:`json`}}]},hidden:!1,deprecated:!1,rpc:{method:`auth.login_ex`,params:[`login_data`],job:!1,defaults:{}}},{path:[`auth`,`login-ex-continue`],summary:`Continue an in-progress authentication attempt`,description:"Continue an in-progress authentication attempt. This endpoint should be called to continue an :doc:`auth.login_ex <api_methods_auth.login_ex>` attempt that returned a ``response_type`` of ``OTP_REQUIRED``, submitting the one-time password via the ``OTP_TOKEN`` mechanism.",method:`POST`,route:`/auth.login_ex_continue`,params:[],body:{required:!0,description:``,fields:[{wireName:`login_data`,flag:`login-data`,required:!0,description:`OTP token data to continue two-factor authentication flow.`,type:{kind:`json`}}]},hidden:!1,deprecated:!1,rpc:{method:`auth.login_ex_continue`,params:[`login_data`],job:!1,defaults:{}}},{path:[`auth`,`login-with-api-key`],summary:`Authenticate session using API Key`,description:`Authenticate session using API Key.`,method:`POST`,route:`/auth.login_with_api_key`,params:[],body:{required:!0,description:``,fields:[{wireName:`api_key`,flag:`api-key`,required:!0,description:`API key for authentication (masked for security).`,type:{kind:`string`}}]},hidden:!1,deprecated:!1,rpc:{method:`auth.login_with_api_key`,params:[`api_key`],job:!1,defaults:{}}},{path:[`auth`,`login-with-token`],summary:"Authenticate session using token generated with :doc:`auth.generate_token <api_methods_auth.generate_token>`",description:"Authenticate session using token generated with :doc:`auth.generate_token <api_methods_auth.generate_token>`.",method:`POST`,route:`/auth.login_with_token`,params:[],body:{required:!0,description:``,fields:[{wireName:`token`,flag:`token`,required:!0,description:`Authentication token (masked for security).`,type:{kind:`string`}}]},hidden:!1,deprecated:!1,rpc:{method:`auth.login_with_token`,params:[`token`],job:!1,defaults:{}}},{path:[`auth`,`logout`],summary:`Deauthenticates an app and if a token exists, removes that from the session`,description:`Deauthenticates an app and if a token exists, removes that from the session.`,method:`POST`,route:`/auth.logout`,params:[],hidden:!1,deprecated:!1,rpc:{method:`auth.logout`,params:[],job:!1,defaults:{}}},{path:[`auth`,`me`],summary:`Returns currently logged-in user`,description:`Returns currently logged-in user.`,method:`POST`,route:`/auth.me`,params:[],hidden:!1,deprecated:!1,rpc:{method:`auth.me`,params:[],job:!1,defaults:{}}},{path:[`auth`,`mechanism-choices`],summary:"Get the list of authentication mechanisms available for :doc:`auth.login_ex <api_methods_auth.login_ex>`",description:"Get the list of authentication mechanisms available for :doc:`auth.login_ex <api_methods_auth.login_ex>`.",method:`POST`,route:`/auth.mechanism_choices`,params:[],hidden:!1,deprecated:!1,rpc:{method:`auth.mechanism_choices`,params:[],job:!1,defaults:{}}},{path:[`auth`,`sessions`],summary:`Returns a list of active auth sessions`,description:`Returns a list of active auth sessions.`,method:`POST`,route:`/auth.sessions`,params:[],body:{required:!1,description:``,fields:[{wireName:`filters`,flag:`filters`,required:!1,description:`List of filters for query results. See API documentation for "Query Methods" for more guidance.`,type:{kind:`array`,elem:{kind:`json`}}},{wireName:`options`,flag:`options`,required:!1,description:`Query options including pagination, ordering, and additional parameters.`,type:{kind:`json`}}]},hidden:!1,deprecated:!1,rpc:{method:`auth.sessions`,params:[`filters`,`options`],job:!1,defaults:{filters:[],options:{extra:{},order_by:[],select:[],count:!1,get:!1,offset:0,limit:0,force_sql_filters:!1}}}},{path:[`auth`,`set-attribute`],summary:"Set current user's ``attributes`` dictionary ``key`` to ``value``",description:"Set current user's ``attributes`` dictionary ``key`` to ``value``.",method:`POST`,route:`/auth.set_attribute`,params:[],body:{required:!0,description:``,fields:[{wireName:`key`,flag:`key`,required:!0,description:`Attribute key name.`,type:{kind:`string`}},{wireName:`value`,flag:`value`,required:!0,description:`Attribute value to set.`,type:{kind:`json`}}]},hidden:!1,deprecated:!1,rpc:{method:`auth.set_attribute`,params:[`key`,`value`],job:!1,defaults:{}}},{path:[`auth`,`terminate-other-sessions`],summary:`Terminates all other sessions (except the current one)`,description:`Terminates all other sessions (except the current one).`,method:`POST`,route:`/auth.terminate_other_sessions`,params:[],hidden:!1,deprecated:!1,rpc:{method:`auth.terminate_other_sessions`,params:[],job:!1,defaults:{}}},{path:[`auth`,`terminate-session`],summary:"Terminates session ``id``",description:"Terminates session ``id``.",method:`POST`,route:`/auth.terminate_session`,params:[],body:{required:!0,description:``,fields:[{wireName:`id`,flag:`id`,required:!0,description:`Session ID to terminate.`,type:{kind:`string`}}]},hidden:!1,deprecated:!1,rpc:{method:`auth.terminate_session`,params:[`id`],job:!1,defaults:{}}},{path:[`auth`,`twofactor`,`config`],summary:``,description:``,method:`POST`,route:`/auth.twofactor.config`,params:[],hidden:!1,deprecated:!1,rpc:{method:`auth.twofactor.config`,params:[],job:!1,defaults:{}}},{path:[`auth`,`twofactor`,`update`],summary:"``window`` extends the validity to ``window`` many counter ticks before and after the current one",description:"``window`` extends the validity to ``window`` many counter ticks before and after the current one.",method:`POST`,route:`/auth.twofactor.update`,params:[],body:{required:!0,description:``,fields:[{wireName:`auth_twofactor_update`,flag:`auth-twofactor-update`,required:!0,description:`Updated two-factor authentication configuration settings.`,type:{kind:`json`}}]},hidden:!1,deprecated:!1,rpc:{method:`auth.twofactor.update`,params:[`auth_twofactor_update`],job:!1,defaults:{}}},{path:[`boot`,`attach`],summary:`Attach a disk to the boot pool, turning a stripe into a mirror`,description:`Attach a disk to the boot pool, turning a stripe into a mirror.`,method:`POST`,route:`/boot.attach`,params:[],body:{required:!0,description:``,fields:[{wireName:`dev`,flag:`dev`,required:!0,description:`Device name or path to attach to the boot pool.`,type:{kind:`string`}},{wireName:`options`,flag:`options`,required:!0,description:`Options for the attach operation.`,type:{kind:`json`}}]},hidden:!1,deprecated:!1,rpc:{method:`boot.attach`,params:[`dev`,`options`],job:!0,defaults:{}}},{path:[`boot`,`detach`],summary:"Detach given ``dev`` from boot pool",description:"Detach given ``dev`` from boot pool.",method:`POST`,route:`/boot.detach`,params:[],body:{required:!0,description:``,fields:[{wireName:`dev`,flag:`dev`,required:!0,description:`Device name or path to detach from the boot pool.`,type:{kind:`string`}}]},confirmation:``,hidden:!1,deprecated:!1,rpc:{method:`boot.detach`,params:[`dev`],job:!1,defaults:{}}},{path:[`boot`,`get-disks`],summary:`Returns disks of the boot pool`,description:`Returns disks of the boot pool.`,method:`POST`,route:`/boot.get_disks`,params:[],hidden:!1,deprecated:!1,rpc:{method:`boot.get_disks`,params:[],job:!1,defaults:{}}},{path:[`boot`,`get-state`],summary:`Returns the current state of the boot pool, including all vdevs, properties and datasets`,description:`Returns the current state of the boot pool, including all vdevs, properties and datasets.`,method:`POST`,route:`/boot.get_state`,params:[],hidden:!1,deprecated:!1,rpc:{method:`boot.get_state`,params:[],job:!1,defaults:{}}},{path:[`boot`,`replace`],summary:"Replace device ``label`` on boot pool with ``dev``",description:"Replace device ``label`` on boot pool with ``dev``.",method:`POST`,route:`/boot.replace`,params:[],body:{required:!0,description:``,fields:[{wireName:`label`,flag:`label`,required:!0,description:`Label of the disk in the boot pool to replace.`,type:{kind:`string`}},{wireName:`dev`,flag:`dev`,required:!0,description:`Device name or path of the replacement disk.`,type:{kind:`string`}}]},hidden:!1,deprecated:!1,rpc:{method:`boot.replace`,params:[`label`,`dev`],job:!0,defaults:{}}},{path:[`boot`,`scrub`],summary:`Scrub on boot pool`,description:`Scrub on boot pool.`,method:`POST`,route:`/boot.scrub`,params:[],hidden:!1,deprecated:!1,rpc:{method:`boot.scrub`,params:[],job:!0,defaults:{}}},{path:[`boot`,`set-scrub-interval`],summary:`Set Automatic Scrub Interval value in days`,description:`Set Automatic Scrub Interval value in days.`,method:`POST`,route:`/boot.set_scrub_interval`,params:[],body:{required:!0,description:``,fields:[{wireName:`interval`,flag:`interval`,required:!0,description:`Scrub interval in days (must be a positive integer).`,type:{kind:`integer`}}]},hidden:!1,deprecated:!1,rpc:{method:`boot.set_scrub_interval`,params:[`interval`],job:!1,defaults:{}}},{path:[`boot`,`environment`,`activate`],summary:"Activate the boot environment identified by ``id`` so that it becomes the default selection on the next boot",description:"Activate the boot environment identified by ``id`` so that it becomes the default selection on the next boot. The currently running boot environment is unaffected until the system is rebooted.",method:`POST`,route:`/boot.environment.activate`,params:[],body:{required:!0,description:``,fields:[{wireName:`boot_environment_activate`,flag:`boot-environment-activate`,required:!0,description:`BootEnvironmentActivateArgs parameters.`,type:{kind:`json`}}]},hidden:!1,deprecated:!1,rpc:{method:`boot.environment.activate`,params:[`boot_environment_activate`],job:!1,defaults:{}}},{path:[`boot`,`environment`,`clone`],summary:"Create a new boot environment named ``target`` as a clone of the existing boot environment identified by ``id``",description:"Create a new boot environment named ``target`` as a clone of the existing boot environment identified by ``id``. The clone is not activated; use :doc:`boot.environment.activate <api_methods_boot.environment.activate>` to boot into it.",method:`POST`,route:`/boot.environment.clone`,params:[],body:{required:!0,description:``,fields:[{wireName:`boot_environment_clone`,flag:`boot-environment-clone`,required:!0,description:`BootEnvironmentCloneArgs parameters.`,type:{kind:`json`}}]},hidden:!1,deprecated:!1,rpc:{method:`boot.environment.clone`,params:[`boot_environment_clone`],job:!1,defaults:{}}},{path:[`boot`,`environment`,`destroy`],summary:"Permanently destroy the boot environment identified by ``id``, freeing the space it consumes",description:"Permanently destroy the boot environment identified by ``id``, freeing the space it consumes.",method:`POST`,route:`/boot.environment.destroy`,params:[],body:{required:!0,description:``,fields:[{wireName:`boot_environment_destroy`,flag:`boot-environment-destroy`,required:!0,description:`BootEnvironmentDestroyArgs parameters.`,type:{kind:`json`}}]},confirmation:``,hidden:!1,deprecated:!1,rpc:{method:`boot.environment.destroy`,params:[`boot_environment_destroy`],job:!1,defaults:{}}},{path:[`boot`,`environment`,`get-instance`],summary:"Returns instance matching `id`",description:"Returns instance matching `id`. If `id` is not found, Validation error is raised.",method:`POST`,route:`/boot.environment.get_instance`,params:[],body:{required:!0,description:``,fields:[{wireName:`id`,flag:`id`,required:!0,description:``,type:{kind:`string`}},{wireName:`options`,flag:`options`,required:!0,description:`Query options customize the results returned by a query method. More complete documentation with examples are covered in the "Query methods" section of the TrueNAS API documentation.`,type:{kind:`json`}}]},hidden:!1,deprecated:!1,rpc:{method:`boot.environment.get_instance`,params:[`id`,`options`],job:!1,defaults:{}}},{path:[`boot`,`environment`,`keep`],summary:'Set or clear the "keep" flag on the boot environment identified by ``id``',description:'Set or clear the "keep" flag on the boot environment identified by ``id``. When ``value`` is ``true``, the boot environment is protected from automatic deletion by the updater when it needs space for an update; when ``false``, the boot environment becomes eligible for such automatic pruning.',method:`POST`,route:`/boot.environment.keep`,params:[],body:{required:!0,description:``,fields:[{wireName:`boot_environment_destroy`,flag:`boot-environment-destroy`,required:!0,description:`BootEnvironmentKeepArgs parameters.`,type:{kind:`json`}}]},hidden:!1,deprecated:!1,rpc:{method:`boot.environment.keep`,params:[`boot_environment_destroy`],job:!1,defaults:{}}},{path:[`boot`,`environment`,`query`],summary:``,description:``,method:`POST`,route:`/boot.environment.query`,params:[],body:{required:!1,description:``,fields:[{wireName:`filters`,flag:`filters`,required:!1,description:`List of filters for query results. See API documentation for "Query Methods" for more guidance.`,type:{kind:`array`,elem:{kind:`json`}}},{wireName:`options`,flag:`options`,required:!1,description:`Query options including pagination, ordering, and additional parameters.`,type:{kind:`json`}}]},hidden:!1,deprecated:!1,rpc:{method:`boot.environment.query`,params:[`filters`,`options`],job:!1,defaults:{filters:[],options:{extra:{},order_by:[],select:[],count:!1,get:!1,offset:0,limit:0,force_sql_filters:!1}}}},{path:[`catalog`,`apps`],summary:"Retrieve apps details for ``label`` catalog",description:"Retrieve apps details for ``label`` catalog.",method:`POST`,route:`/catalog.apps`,params:[],body:{required:!0,description:``,fields:[{wireName:`catalog_apps_options`,flag:`catalog-apps-options`,required:!0,description:`CatalogAppsArgs parameters.`,type:{kind:`json`}}]},hidden:!1,deprecated:!1,rpc:{method:`catalog.apps`,params:[`catalog_apps_options`],job:!1,defaults:{}}},{path:[`catalog`,`config`],summary:``,description:``,method:`POST`,route:`/catalog.config`,params:[],hidden:!1,deprecated:!1,rpc:{method:`catalog.config`,params:[],job:!1,defaults:{}}},{path:[`catalog`,`get-app-details`],summary:"Retrieve information of ``app_name`` ``app_version_details.catalog`` catalog app",description:"Retrieve information of ``app_name`` ``app_version_details.catalog`` catalog app.",method:`POST`,route:`/catalog.get_app_details`,params:[],body:{required:!0,description:``,fields:[{wireName:`app_name`,flag:`app-name`,required:!0,description:`Name of the app to get details for.`,type:{kind:`string`}},{wireName:`app_version_details`,flag:`app-version-details`,required:!0,description:`Version and train information for the specific app.`,type:{kind:`json`}}]},hidden:!1,deprecated:!1,rpc:{method:`catalog.get_app_details`,params:[`app_name`,`app_version_details`],job:!1,defaults:{}}},{path:[`catalog`,`sync`],summary:`Sync truenas catalog to retrieve latest changes from upstream`,description:`Sync truenas catalog to retrieve latest changes from upstream.`,method:`POST`,route:`/catalog.sync`,params:[],hidden:!1,deprecated:!1,rpc:{method:`catalog.sync`,params:[],job:!0,defaults:{}}},{path:[`catalog`,`trains`],summary:`Retrieve available trains`,description:`Retrieve available trains.`,method:`POST`,route:`/catalog.trains`,params:[],hidden:!1,deprecated:!1,rpc:{method:`catalog.trains`,params:[],job:!1,defaults:{}}},{path:[`catalog`,`update`],summary:`Update catalog preferences`,description:`Update catalog preferences.`,method:`POST`,route:`/catalog.update`,params:[],body:{required:!0,description:``,fields:[{wireName:`catalog_update`,flag:`catalog-update`,required:!0,description:`CatalogUpdateArgs parameters.`,type:{kind:`json`}}]},hidden:!1,deprecated:!1,rpc:{method:`catalog.update`,params:[`catalog_update`],job:!1,defaults:{}}},{path:[`certificate`,`acme-server-choices`],summary:`Dictionary of popular ACME Servers with their directory URI endpoints which we display automatically in the UI`,description:`Dictionary of popular ACME Servers with their directory URI endpoints which we display automatically in the UI.`,method:`POST`,route:`/certificate.acme_server_choices`,params:[],hidden:!1,deprecated:!1,rpc:{method:`certificate.acme_server_choices`,params:[],job:!1,defaults:{}}},{path:[`certificate`,`country-choices`],summary:`Returns country choices for creating a certificate/csr`,description:`Returns country choices for creating a certificate/csr.`,method:`POST`,route:`/certificate.country_choices`,params:[],hidden:!1,deprecated:!1,rpc:{method:`certificate.country_choices`,params:[],job:!1,defaults:{}}},{path:[`certificate`,`create`],summary:`Create a new certificate`,description:`Create a new certificate.`,method:`POST`,route:`/certificate.create`,params:[],body:{required:!0,description:``,fields:[{wireName:`certificate_create`,flag:`certificate-create`,required:!0,description:`CertificateCreateArgs parameters.`,type:{kind:`json`}}]},hidden:!1,deprecated:!1,rpc:{method:`certificate.create`,params:[`certificate_create`],job:!0,defaults:{}}},{path:[`certificate`,`delete`],summary:"Delete certificate of ``id``",description:"Delete certificate of ``id``.",method:`POST`,route:`/certificate.delete`,params:[],body:{required:!0,description:``,fields:[{wireName:`id`,flag:`id`,required:!0,description:`ID of the certificate to delete.`,type:{kind:`integer`}},{wireName:`force`,flag:`force`,required:!1,description:`Whether to force deletion even if certificate is in use.`,type:{kind:`boolean`}}]},confirmation:``,hidden:!1,deprecated:!1,rpc:{method:`certificate.delete`,params:[`id`,`force`],job:!0,defaults:{force:!1}}},{path:[`certificate`,`ec-curve-choices`],summary:`Dictionary of supported EC curves`,description:`Dictionary of supported EC curves.`,method:`POST`,route:`/certificate.ec_curve_choices`,params:[],hidden:!1,deprecated:!1,rpc:{method:`certificate.ec_curve_choices`,params:[],job:!1,defaults:{}}},{path:[`certificate`,`extended-key-usage-choices`],summary:`Dictionary of names that can be used in the ExtendedKeyUsage attribute of a certificate request`,description:`Dictionary of names that can be used in the ExtendedKeyUsage attribute of a certificate request.`,method:`POST`,route:`/certificate.extended_key_usage_choices`,params:[],hidden:!1,deprecated:!1,rpc:{method:`certificate.extended_key_usage_choices`,params:[],job:!1,defaults:{}}},{path:[`certificate`,`get-instance`],summary:"Returns instance matching `id`",description:"Returns instance matching `id`. If `id` is not found, Validation error is raised.",method:`POST`,route:`/certificate.get_instance`,params:[],body:{required:!0,description:``,fields:[{wireName:`id`,flag:`id`,required:!0,description:``,type:{kind:`integer`}},{wireName:`options`,flag:`options`,required:!0,description:`Query options customize the results returned by a query method. More complete documentation with examples are covered in the "Query methods" section of the TrueNAS API documentation.`,type:{kind:`json`}}]},hidden:!1,deprecated:!1,rpc:{method:`certificate.get_instance`,params:[`id`,`options`],job:!1,defaults:{}}},{path:[`certificate`,`query`],summary:``,description:``,method:`POST`,route:`/certificate.query`,params:[],body:{required:!1,description:``,fields:[{wireName:`filters`,flag:`filters`,required:!1,description:`List of filters for query results. See API documentation for "Query Methods" for more guidance.`,type:{kind:`array`,elem:{kind:`json`}}},{wireName:`options`,flag:`options`,required:!1,description:`Query options including pagination, ordering, and additional parameters.`,type:{kind:`json`}}]},hidden:!1,deprecated:!1,rpc:{method:`certificate.query`,params:[`filters`,`options`],job:!1,defaults:{filters:[],options:{extra:{},order_by:[],select:[],count:!1,get:!1,offset:0,limit:0,force_sql_filters:!1}}}},{path:[`certificate`,`update`],summary:"Update certificate of ``id``",description:"Update certificate of ``id``.",method:`POST`,route:`/certificate.update`,params:[],body:{required:!0,description:``,fields:[{wireName:`id`,flag:`id`,required:!0,description:`ID of the certificate to update.`,type:{kind:`integer`}},{wireName:`certificate_update`,flag:`certificate-update`,required:!0,description:`Updated certificate configuration data.`,type:{kind:`json`}}]},hidden:!1,deprecated:!1,rpc:{method:`certificate.update`,params:[`id`,`certificate_update`],job:!0,defaults:{}}},{path:[`cloud-backup`,`abort`],summary:`Abort a running cloud backup task`,description:`Abort a running cloud backup task.`,method:`POST`,route:`/cloud_backup.abort`,params:[],body:{required:!0,description:``,fields:[{wireName:`id`,flag:`id`,required:!0,description:`ID of the cloud backup task whose backup job to abort.`,type:{kind:`integer`}}]},hidden:!1,deprecated:!1,rpc:{method:`cloud_backup.abort`,params:[`id`],job:!1,defaults:{}}},{path:[`cloud-backup`,`create`],summary:`Create a new cloud backup task`,description:`Create a new cloud backup task.`,method:`POST`,route:`/cloud_backup.create`,params:[],body:{required:!0,description:``,fields:[{wireName:`cloud_backup`,flag:`cloud-backup`,required:!0,description:`Configuration for the new cloud backup task.`,type:{kind:`json`}}]},hidden:!1,deprecated:!1,rpc:{method:`cloud_backup.create`,params:[`cloud_backup`],job:!1,defaults:{}}},{path:[`cloud-backup`,`delete`],summary:"Delete cloud backup entry ``id``",description:"Delete cloud backup entry ``id``.",method:`POST`,route:`/cloud_backup.delete`,params:[],body:{required:!0,description:``,fields:[{wireName:`id`,flag:`id`,required:!0,description:`ID of the cloud backup task to delete.`,type:{kind:`integer`}}]},confirmation:``,hidden:!1,deprecated:!1,rpc:{method:`cloud_backup.delete`,params:[`id`],job:!1,defaults:{}}},{path:[`cloud-backup`,`delete-snapshot`],summary:"Delete snapshot ``snapshot_id`` created by the cloud backup job ``id``",description:"Delete snapshot ``snapshot_id`` created by the cloud backup job ``id``.",method:`POST`,route:`/cloud_backup.delete_snapshot`,params:[],body:{required:!0,description:``,fields:[{wireName:`id`,flag:`id`,required:!0,description:`The cloud backup task ID.`,type:{kind:`integer`}},{wireName:`snapshot_id`,flag:`snapshot-id`,required:!0,description:`ID of the snapshot to delete.`,type:{kind:`string`}}]},hidden:!1,deprecated:!1,rpc:{method:`cloud_backup.delete_snapshot`,params:[`id`,`snapshot_id`],job:!0,defaults:{}}},{path:[`cloud-backup`,`get-instance`],summary:"Returns instance matching `id`",description:"Returns instance matching `id`. If `id` is not found, Validation error is raised.",method:`POST`,route:`/cloud_backup.get_instance`,params:[],body:{required:!0,description:``,fields:[{wireName:`id`,flag:`id`,required:!0,description:``,type:{kind:`integer`}},{wireName:`options`,flag:`options`,required:!0,description:`Query options customize the results returned by a query method. More complete documentation with examples are covered in the "Query methods" section of the TrueNAS API documentation.`,type:{kind:`json`}}]},hidden:!1,deprecated:!1,rpc:{method:`cloud_backup.get_instance`,params:[`id`,`options`],job:!1,defaults:{}}},{path:[`cloud-backup`,`list-snapshot-directory`],summary:"List files in the directory ``path`` of the ``snapshot_id`` created by the cloud backup job ``id``",description:"List files in the directory ``path`` of the ``snapshot_id`` created by the cloud backup job ``id``.",method:`POST`,route:`/cloud_backup.list_snapshot_directory`,params:[],body:{required:!0,description:``,fields:[{wireName:`id`,flag:`id`,required:!0,description:`The cloud backup task ID.`,type:{kind:`integer`}},{wireName:`snapshot_id`,flag:`snapshot-id`,required:!0,description:`ID of the snapshot whose contents to list.`,type:{kind:`string`}},{wireName:`path`,flag:`path`,required:!0,description:`Path within the snapshot to list the contents of.`,type:{kind:`string`}}]},hidden:!1,deprecated:!1,rpc:{method:`cloud_backup.list_snapshot_directory`,params:[`id`,`snapshot_id`,`path`],job:!1,defaults:{}}},{path:[`cloud-backup`,`list-snapshots`],summary:"List existing snapshots for the cloud backup job ``id``",description:"List existing snapshots for the cloud backup job ``id``.",method:`POST`,route:`/cloud_backup.list_snapshots`,params:[],body:{required:!0,description:``,fields:[{wireName:`id`,flag:`id`,required:!0,description:`The cloud backup task ID.`,type:{kind:`integer`}}]},hidden:!1,deprecated:!1,rpc:{method:`cloud_backup.list_snapshots`,params:[`id`],job:!1,defaults:{}}},{path:[`cloud-backup`,`query`],summary:``,description:``,method:`POST`,route:`/cloud_backup.query`,params:[],body:{required:!1,description:``,fields:[{wireName:`filters`,flag:`filters`,required:!1,description:`List of filters for query results. See API documentation for "Query Methods" for more guidance.`,type:{kind:`array`,elem:{kind:`json`}}},{wireName:`options`,flag:`options`,required:!1,description:`Query options including pagination, ordering, and additional parameters.`,type:{kind:`json`}}]},hidden:!1,deprecated:!1,rpc:{method:`cloud_backup.query`,params:[`filters`,`options`],job:!1,defaults:{filters:[],options:{extra:{},order_by:[],select:[],count:!1,get:!1,offset:0,limit:0,force_sql_filters:!1}}}},{path:[`cloud-backup`,`restore`],summary:"Restore files to the directory ``destination_path`` from the ``snapshot_id`` subfolder ``subfolder`` created by the cloud backup job ``id``",description:"Restore files to the directory ``destination_path`` from the ``snapshot_id`` subfolder ``subfolder`` created by the cloud backup job ``id``.",method:`POST`,route:`/cloud_backup.restore`,params:[],body:{required:!0,description:``,fields:[{wireName:`id`,flag:`id`,required:!0,description:`ID of the cloud backup task.`,type:{kind:`integer`}},{wireName:`snapshot_id`,flag:`snapshot-id`,required:!0,description:`ID of the snapshot to restore.`,type:{kind:`string`}},{wireName:`subfolder`,flag:`subfolder`,required:!0,description:`Path within the snapshot to restore.`,type:{kind:`string`}},{wireName:`destination_path`,flag:`destination-path`,required:!0,description:`Local path to restore to.`,type:{kind:`string`}},{wireName:`options`,flag:`options`,required:!1,description:`Additional restore options.`,type:{kind:`json`}}]},hidden:!1,deprecated:!1,rpc:{method:`cloud_backup.restore`,params:[`id`,`snapshot_id`,`subfolder`,`destination_path`,`options`],job:!0,defaults:{options:{exclude:[],include:[],rate_limit:null}}}},{path:[`cloud-backup`,`sync`],summary:"Run the cloud backup job ``id``",description:"Run the cloud backup job ``id``.",method:`POST`,route:`/cloud_backup.sync`,params:[],body:{required:!0,description:``,fields:[{wireName:`id`,flag:`id`,required:!0,description:`The cloud backup task ID.`,type:{kind:`integer`}},{wireName:`options`,flag:`options`,required:!0,description:`Sync options.`,type:{kind:`json`}}]},hidden:!1,deprecated:!1,rpc:{method:`cloud_backup.sync`,params:[`id`,`options`],job:!0,defaults:{}}},{path:[`cloud-backup`,`transfer-setting-choices`],summary:"Return all possible choices for ``cloud_backup.create.transfer_setting``",description:"Return all possible choices for ``cloud_backup.create.transfer_setting``.",method:`POST`,route:`/cloud_backup.transfer_setting_choices`,params:[],hidden:!1,deprecated:!1,rpc:{method:`cloud_backup.transfer_setting_choices`,params:[],job:!1,defaults:{}}},{path:[`cloud-backup`,`update`],summary:"Update the cloud backup entry ``id`` with ``data``",description:"Update the cloud backup entry ``id`` with ``data``.",method:`POST`,route:`/cloud_backup.update`,params:[],body:{required:!0,description:``,fields:[{wireName:`id`,flag:`id`,required:!0,description:`ID of the cloud backup task to update.`,type:{kind:`integer`}},{wireName:`data`,flag:`data`,required:!0,description:`Updated configuration data for the cloud backup task.`,type:{kind:`json`}}]},hidden:!1,deprecated:!1,rpc:{method:`cloud_backup.update`,params:[`id`,`data`],job:!1,defaults:{}}},{path:[`cloudsync`,`abort`],summary:`Aborts cloud sync task`,description:`Aborts cloud sync task.`,method:`POST`,route:`/cloudsync.abort`,params:[],body:{required:!0,description:``,fields:[{wireName:`id`,flag:`id`,required:!0,description:`ID of the cloud sync task to abort.`,type:{kind:`integer`}}]},hidden:!1,deprecated:!1,rpc:{method:`cloudsync.abort`,params:[`id`],job:!1,defaults:{}}},{path:[`cloudsync`,`create`],summary:`Creates a new cloud_sync entry`,description:`Creates a new cloud_sync entry.`,method:`POST`,route:`/cloudsync.create`,params:[],body:{required:!0,description:``,fields:[{wireName:`cloud_sync_create`,flag:`cloud-sync-create`,required:!0,description:`Cloud sync task configuration data.`,type:{kind:`json`}}]},hidden:!1,deprecated:!1,rpc:{method:`cloudsync.create`,params:[`cloud_sync_create`],job:!1,defaults:{}}},{path:[`cloudsync`,`create-bucket`],summary:"Creates a new bucket ``name`` using ``credentials_id``",description:"Creates a new bucket ``name`` using ``credentials_id``.",method:`POST`,route:`/cloudsync.create_bucket`,params:[],body:{required:!0,description:``,fields:[{wireName:`credentials_id`,flag:`credentials-id`,required:!0,description:`ID of the cloud credential to use for bucket creation.`,type:{kind:`integer`}},{wireName:`name`,flag:`name`,required:!0,description:`Name for the new bucket.`,type:{kind:`string`}}]},hidden:!1,deprecated:!1,rpc:{method:`cloudsync.create_bucket`,params:[`credentials_id`,`name`],job:!1,defaults:{}}},{path:[`cloudsync`,`delete`],summary:"Deletes cloud_sync entry ``id``",description:"Deletes cloud_sync entry ``id``.",method:`POST`,route:`/cloudsync.delete`,params:[],body:{required:!0,description:``,fields:[{wireName:`id`,flag:`id`,required:!0,description:`ID of the cloud sync task to delete.`,type:{kind:`integer`}}]},confirmation:``,hidden:!1,deprecated:!1,rpc:{method:`cloudsync.delete`,params:[`id`],job:!1,defaults:{}}},{path:[`cloudsync`,`get-instance`],summary:"Returns instance matching `id`",description:"Returns instance matching `id`. If `id` is not found, Validation error is raised.",method:`POST`,route:`/cloudsync.get_instance`,params:[],body:{required:!0,description:``,fields:[{wireName:`id`,flag:`id`,required:!0,description:``,type:{kind:`integer`}},{wireName:`options`,flag:`options`,required:!0,description:`Query options customize the results returned by a query method. More complete documentation with examples are covered in the "Query methods" section of the TrueNAS API documentation.`,type:{kind:`json`}}]},hidden:!1,deprecated:!1,rpc:{method:`cloudsync.get_instance`,params:[`id`,`options`],job:!1,defaults:{}}},{path:[`cloudsync`,`list-buckets`],summary:"List the buckets available to the cloud sync credential identified by ``credentials_id``",description:"List the buckets available to the cloud sync credential identified by ``credentials_id``.",method:`POST`,route:`/cloudsync.list_buckets`,params:[],body:{required:!0,description:``,fields:[{wireName:`credentials_id`,flag:`credentials-id`,required:!0,description:`ID of the cloud credential to use for listing buckets.`,type:{kind:`integer`}}]},hidden:!1,deprecated:!1,rpc:{method:`cloudsync.list_buckets`,params:[`credentials_id`],job:!1,defaults:{}}},{path:[`cloudsync`,`list-directory`],summary:`List contents of a remote bucket / directory`,description:`List contents of a remote bucket / directory.`,method:`POST`,route:`/cloudsync.list_directory`,params:[],body:{required:!0,description:``,fields:[{wireName:`cloud_sync_ls`,flag:`cloud-sync-ls`,required:!0,description:`CloudSyncListDirectoryArgs parameters.`,type:{kind:`json`}}]},hidden:!1,deprecated:!1,rpc:{method:`cloudsync.list_directory`,params:[`cloud_sync_ls`],job:!1,defaults:{}}},{path:[`cloudsync`,`onedrive-list-drives`],summary:`Lists all available drives and their types for given Microsoft OneDrive credentials`,description:`Lists all available drives and their types for given Microsoft OneDrive credentials.`,method:`POST`,route:`/cloudsync.onedrive_list_drives`,params:[],body:{required:!0,description:``,fields:[{wireName:`onedrive_list_drives`,flag:`onedrive-list-drives`,required:!0,description:`CloudSyncOneDriveListDrivesArgs parameters.`,type:{kind:`json`}}]},hidden:!1,deprecated:!1,rpc:{method:`cloudsync.onedrive_list_drives`,params:[`onedrive_list_drives`],job:!1,defaults:{}}},{path:[`cloudsync`,`providers`],summary:`Returns a list of dictionaries of supported providers for Cloud Sync Tasks`,description:`Returns a list of dictionaries of supported providers for Cloud Sync Tasks.`,method:`POST`,route:`/cloudsync.providers`,params:[],hidden:!1,deprecated:!1,rpc:{method:`cloudsync.providers`,params:[],job:!1,defaults:{}}},{path:[`cloudsync`,`query`],summary:``,description:``,method:`POST`,route:`/cloudsync.query`,params:[],body:{required:!1,description:``,fields:[{wireName:`filters`,flag:`filters`,required:!1,description:`List of filters for query results. See API documentation for "Query Methods" for more guidance.`,type:{kind:`array`,elem:{kind:`json`}}},{wireName:`options`,flag:`options`,required:!1,description:`Query options including pagination, ordering, and additional parameters.`,type:{kind:`json`}}]},hidden:!1,deprecated:!1,rpc:{method:`cloudsync.query`,params:[`filters`,`options`],job:!1,defaults:{filters:[],options:{extra:{},order_by:[],select:[],count:!1,get:!1,offset:0,limit:0,force_sql_filters:!1}}}},{path:[`cloudsync`,`restore`],summary:"Create the opposite of cloud sync task ``id`` (PULL if it was PUSH and vice versa)",description:"Create the opposite of cloud sync task ``id`` (PULL if it was PUSH and vice versa).",method:`POST`,route:`/cloudsync.restore`,params:[],body:{required:!0,description:``,fields:[{wireName:`id`,flag:`id`,required:!0,description:`ID of the cloud sync task to restore from.`,type:{kind:`integer`}},{wireName:`opts`,flag:`opts`,required:!0,description:`Restore operation configuration options.`,type:{kind:`json`}}]},hidden:!1,deprecated:!1,rpc:{method:`cloudsync.restore`,params:[`id`,`opts`],job:!1,defaults:{}}},{path:[`cloudsync`,`sync`],summary:"Run the cloud_sync job ``id``, syncing the local data to remote",description:"Run the cloud_sync job ``id``, syncing the local data to remote.",method:`POST`,route:`/cloudsync.sync`,params:[],body:{required:!0,description:``,fields:[{wireName:`id`,flag:`id`,required:!0,description:`ID of the cloud sync task to run.`,type:{kind:`integer`}},{wireName:`cloud_sync_sync_options`,flag:`cloud-sync-sync-options`,required:!0,description:`Options for the sync operation.`,type:{kind:`json`}}]},hidden:!1,deprecated:!1,rpc:{method:`cloudsync.sync`,params:[`id`,`cloud_sync_sync_options`],job:!0,defaults:{}}},{path:[`cloudsync`,`sync-onetime`],summary:`Run cloud sync task without creating it`,description:`Run cloud sync task without creating it.`,method:`POST`,route:`/cloudsync.sync_onetime`,params:[],body:{required:!0,description:``,fields:[{wireName:`cloud_sync_sync_onetime`,flag:`cloud-sync-sync-onetime`,required:!0,description:`Cloud sync task configuration for one-time execution.`,type:{kind:`json`}},{wireName:`cloud_sync_sync_onetime_options`,flag:`cloud-sync-sync-onetime-options`,required:!0,description:`Options for the one-time sync operation.`,type:{kind:`json`}}]},hidden:!1,deprecated:!1,rpc:{method:`cloudsync.sync_onetime`,params:[`cloud_sync_sync_onetime`,`cloud_sync_sync_onetime_options`],job:!0,defaults:{}}},{path:[`cloudsync`,`update`],summary:"Updates the cloud_sync entry ``id`` with ``data``",description:"Updates the cloud_sync entry ``id`` with ``data``.",method:`POST`,route:`/cloudsync.update`,params:[],body:{required:!0,description:``,fields:[{wireName:`id`,flag:`id`,required:!0,description:`ID of the cloud sync task to update.`,type:{kind:`integer`}},{wireName:`cloud_sync_update`,flag:`cloud-sync-update`,required:!0,description:`Updated cloud sync task configuration data.`,type:{kind:`json`}}]},hidden:!1,deprecated:!1,rpc:{method:`cloudsync.update`,params:[`id`,`cloud_sync_update`],job:!1,defaults:{}}},{path:[`cloudsync`,`credentials`,`create`],summary:`Create Cloud Sync Credentials`,description:`Create Cloud Sync Credentials.`,method:`POST`,route:`/cloudsync.credentials.create`,params:[],body:{required:!0,description:``,fields:[{wireName:`cloud_sync_credentials_create`,flag:`cloud-sync-credentials-create`,required:!0,description:`Cloud credential configuration data for the new credential.`,type:{kind:`json`}}]},hidden:!1,deprecated:!1,rpc:{method:`cloudsync.credentials.create`,params:[`cloud_sync_credentials_create`],job:!1,defaults:{}}},{path:[`cloudsync`,`credentials`,`delete`],summary:"Delete Cloud Sync Credentials of ``id``",description:"Delete Cloud Sync Credentials of ``id``.",method:`POST`,route:`/cloudsync.credentials.delete`,params:[],body:{required:!0,description:``,fields:[{wireName:`id`,flag:`id`,required:!0,description:`ID of the cloud credential to delete.`,type:{kind:`integer`}}]},confirmation:``,hidden:!1,deprecated:!1,rpc:{method:`cloudsync.credentials.delete`,params:[`id`],job:!1,defaults:{}}},{path:[`cloudsync`,`credentials`,`get-instance`],summary:"Returns instance matching `id`",description:"Returns instance matching `id`. If `id` is not found, Validation error is raised.",method:`POST`,route:`/cloudsync.credentials.get_instance`,params:[],body:{required:!0,description:``,fields:[{wireName:`id`,flag:`id`,required:!0,description:``,type:{kind:`integer`}},{wireName:`options`,flag:`options`,required:!0,description:`Query options customize the results returned by a query method. More complete documentation with examples are covered in the "Query methods" section of the TrueNAS API documentation.`,type:{kind:`json`}}]},hidden:!1,deprecated:!1,rpc:{method:`cloudsync.credentials.get_instance`,params:[`id`,`options`],job:!1,defaults:{}}},{path:[`cloudsync`,`credentials`,`query`],summary:``,description:``,method:`POST`,route:`/cloudsync.credentials.query`,params:[],body:{required:!1,description:``,fields:[{wireName:`filters`,flag:`filters`,required:!1,description:`List of filters for query results. See API documentation for "Query Methods" for more guidance.`,type:{kind:`array`,elem:{kind:`json`}}},{wireName:`options`,flag:`options`,required:!1,description:`Query options including pagination, ordering, and additional parameters.`,type:{kind:`json`}}]},hidden:!1,deprecated:!1,rpc:{method:`cloudsync.credentials.query`,params:[`filters`,`options`],job:!1,defaults:{filters:[],options:{extra:{},order_by:[],select:[],count:!1,get:!1,offset:0,limit:0,force_sql_filters:!1}}}},{path:[`cloudsync`,`credentials`,`update`],summary:"Update Cloud Sync Credentials of ``id``",description:"Update Cloud Sync Credentials of ``id``.",method:`POST`,route:`/cloudsync.credentials.update`,params:[],body:{required:!0,description:``,fields:[{wireName:`id`,flag:`id`,required:!0,description:`ID of the cloud credential to update.`,type:{kind:`integer`}},{wireName:`cloud_sync_credentials_update`,flag:`cloud-sync-credentials-update`,required:!0,description:`Updated cloud credential configuration data.`,type:{kind:`json`}}]},hidden:!1,deprecated:!1,rpc:{method:`cloudsync.credentials.update`,params:[`id`,`cloud_sync_credentials_update`],job:!1,defaults:{}}},{path:[`cloudsync`,`credentials`,`verify`],summary:"Verify if ``attributes`` provided for ``provider`` are authorized by the ``provider``",description:"Verify if ``attributes`` provided for ``provider`` are authorized by the ``provider``.",method:`POST`,route:`/cloudsync.credentials.verify`,params:[],body:{required:!0,description:``,fields:[{wireName:`cloud_sync_credentials_create`,flag:`cloud-sync-credentials-create`,required:!0,description:`Cloud provider configuration to verify connectivity and authentication.`,type:{kind:`json`}}]},hidden:!1,deprecated:!1,rpc:{method:`cloudsync.credentials.verify`,params:[`cloud_sync_credentials_create`],job:!1,defaults:{}}},{path:[`config`,`reset`],summary:`Reset database to configuration defaults`,description:`Reset database to configuration defaults.`,method:`POST`,route:`/config.reset`,params:[],body:{required:!1,description:``,fields:[{wireName:`options`,flag:`options`,required:!1,description:`Options controlling the configuration reset behavior.`,type:{kind:`json`}}]},confirmation:``,hidden:!1,deprecated:!1,rpc:{method:`config.reset`,params:[`options`],job:!0,defaults:{options:{reboot:!0}}}},{path:[`core`,`arp`],summary:`Return the system ARP table as a mapping of IP address to MAC address`,description:`Return the system ARP table as a mapping of IP address to MAC address.`,method:`POST`,route:`/core.arp`,params:[],body:{required:!0,description:``,fields:[{wireName:`options`,flag:`options`,required:!0,description:`CoreArpArgs parameters.`,type:{kind:`json`}}]},hidden:!1,deprecated:!1,rpc:{method:`core.arp`,params:[`options`],job:!1,defaults:{}}},{path:[`core`,`bulk`],summary:"Will sequentially call ``method`` with the arguments from each entry of the ``params`` list",description:"Will sequentially call ``method`` with the arguments from each entry of the ``params`` list. For example, calling :doc:`core.bulk <api_methods_core.bulk>` with these parameters::",method:`POST`,route:`/core.bulk`,params:[],body:{required:!0,description:``,fields:[{wireName:`method`,flag:`method`,required:!0,description:`Method name to execute for each parameter set.`,type:{kind:`string`}},{wireName:`params`,flag:`params`,required:!0,description:`Array of parameter arrays, each representing one method call.`,type:{kind:`json`}},{wireName:`description`,flag:`description`,required:!1,description:`Format string for job progress (e.g. "Deleting snapshot {0[dataset]}@{0[name]}").`,type:{kind:`string`}}]},hidden:!1,deprecated:!1,rpc:{method:`core.bulk`,params:[`method`,`params`,`description`],job:!0,defaults:{description:null}}},{path:[`core`,`download`],summary:`Call a job that produces downloadable output and get a URL to retrieve the result`,description:`Call a job that produces downloadable output and get a URL to retrieve the result.`,method:`POST`,route:`/core.download`,params:[],body:{required:!0,description:``,fields:[{wireName:`method`,flag:`method`,required:!0,description:`Method name to execute for generating download content.`,type:{kind:`string`}},{wireName:`args`,flag:`args`,required:!0,description:`Array of arguments to pass to the method.`,type:{kind:`array`,elem:{kind:`json`}}},{wireName:`filename`,flag:`filename`,required:!0,description:`Filename for the downloaded file.`,type:{kind:`string`}},{wireName:`buffered`,flag:`buffered`,required:!1,description:"Non-`buffered` downloads will allow job to write to pipe as soon as download URL is requested, job will stay blocked meanwhile. `buffered` downloads must wait for job to complete before requesting download URL, job's pipe output will be bu…",type:{kind:`boolean`}}]},hidden:!1,deprecated:!1,rpc:{method:`core.download`,params:[`method`,`args`,`filename`,`buffered`],job:!1,defaults:{buffered:!1}}},{path:[`core`,`get-jobs`],summary:`Get information about long-running jobs`,description:`Get information about long-running jobs. If authenticated session does not have the FULL_ADMIN role, only jobs owned by the current authenticated session will be returned.`,method:`POST`,route:`/core.get_jobs`,params:[],body:{required:!1,description:``,fields:[{wireName:`filters`,flag:`filters`,required:!1,description:`List of filters for query results. See API documentation for "Query Methods" for more guidance.`,type:{kind:`array`,elem:{kind:`json`}}},{wireName:`options`,flag:`options`,required:!1,description:`Query options including pagination, ordering, and additional parameters.`,type:{kind:`json`}}]},hidden:!1,deprecated:!1,rpc:{method:`core.get_jobs`,params:[`filters`,`options`],job:!1,defaults:{filters:[],options:{extra:{},order_by:[],select:[],count:!1,get:!1,offset:0,limit:0,force_sql_filters:!1}}}},{path:[`core`,`get-methods`],summary:`Return methods metadata of every available service`,description:`Return methods metadata of every available service.`,method:`POST`,route:`/core.get_methods`,params:[],body:{required:!1,description:``,fields:[{wireName:`service`,flag:`service`,required:!1,description:`Filters the result for a single service.`,type:{kind:`string`}},{wireName:`target`,flag:`target`,required:!1,description:`Target interface to get methods for.`,type:{kind:`enum`,values:[`WS`,`CLI`,`REST`]}}]},hidden:!1,deprecated:!1,rpc:{method:`core.get_methods`,params:[`service`,`target`],job:!1,defaults:{service:null,target:`WS`}}},{path:[`core`,`get-services`],summary:`Returns a list of all registered services`,description:`Returns a list of all registered services.`,method:`POST`,route:`/core.get_services`,params:[],body:{required:!1,description:``,fields:[{wireName:`target`,flag:`target`,required:!1,description:`Target interface to get services for.`,type:{kind:`enum`,values:[`WS`,`CLI`,`REST`]}}]},hidden:!1,deprecated:!1,rpc:{method:`core.get_services`,params:[`target`],job:!1,defaults:{target:`WS`}}},{path:[`core`,`job-abort`],summary:"Abort the running job identified by ``id``",description:"Abort the running job identified by ``id``.",method:`POST`,route:`/core.job_abort`,params:[],body:{required:!0,description:``,fields:[{wireName:`id`,flag:`id`,required:!0,description:`ID of the job to abort.`,type:{kind:`integer`}}]},hidden:!1,deprecated:!1,rpc:{method:`core.job_abort`,params:[`id`],job:!1,defaults:{}}},{path:[`core`,`job-download-logs`],summary:"Download logs of the job ``id``",description:"Download logs of the job ``id``.",method:`POST`,route:`/core.job_download_logs`,params:[],body:{required:!0,description:``,fields:[{wireName:`id`,flag:`id`,required:!0,description:`ID of the job to download logs for.`,type:{kind:`integer`}},{wireName:`filename`,flag:`filename`,required:!0,description:`Filename for the downloaded log file.`,type:{kind:`string`}},{wireName:`buffered`,flag:`buffered`,required:!1,description:`Whether to buffer the entire log file before download.`,type:{kind:`boolean`}}]},hidden:!1,deprecated:!1,rpc:{method:`core.job_download_logs`,params:[`id`,`filename`,`buffered`],job:!1,defaults:{buffered:!1}}},{path:[`core`,`job-wait`],summary:"Wait for the job identified by ``id`` to finish and return its result",description:"Wait for the job identified by ``id`` to finish and return its result.",method:`POST`,route:`/core.job_wait`,params:[],body:{required:!0,description:``,fields:[{wireName:`id`,flag:`id`,required:!0,description:`ID of the job to wait for completion.`,type:{kind:`integer`}}]},hidden:!1,deprecated:!1,rpc:{method:`core.job_wait`,params:[`id`],job:!0,defaults:{}}},{path:[`core`,`ping`],summary:`Respond to WebSocket ping frames with "pong"`,description:`Respond to WebSocket ping frames with "pong".`,method:`POST`,route:`/core.ping`,params:[],hidden:!1,deprecated:!1,rpc:{method:`core.ping`,params:[],job:!1,defaults:{}}},{path:[`core`,`ping-remote`],summary:`Method that will send an ICMP echo request to "hostname" and will wait up to "timeout" for a reply`,description:`Method that will send an ICMP echo request to "hostname" and will wait up to "timeout" for a reply.`,method:`POST`,route:`/core.ping_remote`,params:[],body:{required:!0,description:``,fields:[{wireName:`options`,flag:`options`,required:!0,description:`CorePingRemoteArgs parameters.`,type:{kind:`json`}}]},hidden:!1,deprecated:!1,rpc:{method:`core.ping_remote`,params:[`options`],job:!1,defaults:{}}},{path:[`core`,`resize-shell`],summary:`Resize terminal session (/websocket/shell) to cols x rows`,description:`Resize terminal session (/websocket/shell) to cols x rows.`,method:`POST`,route:`/core.resize_shell`,params:[],body:{required:!0,description:``,fields:[{wireName:`id`,flag:`id`,required:!0,description:`Shell session identifier.`,type:{kind:`string`}},{wireName:`cols`,flag:`cols`,required:!0,description:`New terminal width in columns.`,type:{kind:`integer`}},{wireName:`rows`,flag:`rows`,required:!0,description:`New terminal height in rows.`,type:{kind:`integer`}}]},hidden:!1,deprecated:!1,rpc:{method:`core.resize_shell`,params:[`id`,`cols`,`rows`],job:!1,defaults:{}}},{path:[`core`,`set-options`],summary:`Set per-connection options for the current API session and return the resulting option values`,description:`Set per-connection options for the current API session and return the resulting option values.`,method:`POST`,route:`/core.set_options`,params:[],body:{required:!0,description:``,fields:[{wireName:`options`,flag:`options`,required:!0,description:`Core system options to update.`,type:{kind:`json`}}]},hidden:!1,deprecated:!1,rpc:{method:`core.set_options`,params:[`options`],job:!1,defaults:{}}},{path:[`core`,`subscribe`],summary:"Subscribe the current connection to the named ``event`` and return a subscription identifier",description:"Subscribe the current connection to the named ``event`` and return a subscription identifier.",method:`POST`,route:`/core.subscribe`,params:[],body:{required:!0,description:``,fields:[{wireName:`event`,flag:`event`,required:!0,description:`Event name to subscribe to for real-time updates.`,type:{kind:`string`}}]},hidden:!1,deprecated:!1,rpc:{method:`core.subscribe`,params:[`event`],job:!1,defaults:{}}},{path:[`core`,`unsubscribe`],summary:"Remove the event subscription identified by ``ident`` (as returned by :doc:`core.subscribe <api_methods_core.subscribe>`) so the current connection no longer receives notifications for it",description:"Remove the event subscription identified by ``ident`` (as returned by :doc:`core.subscribe <api_methods_core.subscribe>`) so the current connection no longer receives notifications for it.",method:`POST`,route:`/core.unsubscribe`,params:[],body:{required:!0,description:``,fields:[{wireName:`id_`,flag:`id`,required:!0,description:`Subscription ID to cancel.`,type:{kind:`string`}}]},hidden:!1,deprecated:!1,rpc:{method:`core.unsubscribe`,params:[`id_`],job:!1,defaults:{}}},{path:[`cronjob`,`create`],summary:`Create a new cron job`,description:`Create a new cron job.`,method:`POST`,route:`/cronjob.create`,params:[],body:{required:!0,description:``,fields:[{wireName:`data`,flag:`data`,required:!0,description:`Cron job configuration data for the new job.`,type:{kind:`json`}}]},hidden:!1,deprecated:!1,rpc:{method:`cronjob.create`,params:[`data`],job:!1,defaults:{}}},{path:[`cronjob`,`delete`],summary:"Delete cronjob of ``id``",description:"Delete cronjob of ``id``.",method:`POST`,route:`/cronjob.delete`,params:[],body:{required:!0,description:``,fields:[{wireName:`id`,flag:`id`,required:!0,description:`ID of the cron job to delete.`,type:{kind:`integer`}}]},confirmation:``,hidden:!1,deprecated:!1,rpc:{method:`cronjob.delete`,params:[`id`],job:!1,defaults:{}}},{path:[`cronjob`,`get-instance`],summary:"Returns instance matching `id`",description:"Returns instance matching `id`. If `id` is not found, Validation error is raised.",method:`POST`,route:`/cronjob.get_instance`,params:[],body:{required:!0,description:``,fields:[{wireName:`id`,flag:`id`,required:!0,description:``,type:{kind:`integer`}},{wireName:`options`,flag:`options`,required:!0,description:`Query options customize the results returned by a query method. More complete documentation with examples are covered in the "Query methods" section of the TrueNAS API documentation.`,type:{kind:`json`}}]},hidden:!1,deprecated:!1,rpc:{method:`cronjob.get_instance`,params:[`id`,`options`],job:!1,defaults:{}}},{path:[`cronjob`,`query`],summary:``,description:``,method:`POST`,route:`/cronjob.query`,params:[],body:{required:!1,description:``,fields:[{wireName:`filters`,flag:`filters`,required:!1,description:`List of filters for query results. See API documentation for "Query Methods" for more guidance.`,type:{kind:`array`,elem:{kind:`json`}}},{wireName:`options`,flag:`options`,required:!1,description:`Query options including pagination, ordering, and additional parameters.`,type:{kind:`json`}}]},hidden:!1,deprecated:!1,rpc:{method:`cronjob.query`,params:[`filters`,`options`],job:!1,defaults:{filters:[],options:{extra:{},order_by:[],select:[],count:!1,get:!1,offset:0,limit:0,force_sql_filters:!1}}}},{path:[`cronjob`,`run`],summary:"Job to run cronjob task of ``id``",description:"Job to run cronjob task of ``id``.",method:`POST`,route:`/cronjob.run`,params:[],body:{required:!0,description:``,fields:[{wireName:`id`,flag:`id`,required:!0,description:`ID of the cron job to run immediately.`,type:{kind:`integer`}},{wireName:`skip_disabled`,flag:`skip-disabled`,required:!1,description:`Whether to skip execution if the cron job is disabled.`,type:{kind:`boolean`}}]},hidden:!1,deprecated:!1,rpc:{method:`cronjob.run`,params:[`id`,`skip_disabled`],job:!0,defaults:{skip_disabled:!1}}},{path:[`cronjob`,`update`],summary:"Update cronjob of ``id``",description:"Update cronjob of ``id``.",method:`POST`,route:`/cronjob.update`,params:[],body:{required:!0,description:``,fields:[{wireName:`id`,flag:`id`,required:!0,description:`ID of the cron job to update.`,type:{kind:`integer`}},{wireName:`data`,flag:`data`,required:!0,description:`Updated cron job configuration data.`,type:{kind:`json`}}]},hidden:!1,deprecated:!1,rpc:{method:`cronjob.update`,params:[`id`,`data`],job:!1,defaults:{}}},{path:[`device`,`get-info`],summary:"Get info for ``type`` device",description:"Get info for ``type`` device.",method:`POST`,route:`/device.get_info`,params:[],body:{required:!0,description:``,fields:[{wireName:`data`,flag:`data`,required:!0,description:`Device information query parameters specifying type and options.`,type:{kind:`json`}}]},hidden:!1,deprecated:!1,rpc:{method:`device.get_info`,params:[`data`],job:!1,defaults:{}}},{path:[`directoryservices`,`cache-refresh`],summary:"This method refreshes the directory services cache for users and groups that is used as a backing for :doc:`user.query <api_methods_user.query>` and :doc:`group.query <api_methods_group.query>` methods",description:"This method refreshes the directory services cache for users and groups that is used as a backing for :doc:`user.query <api_methods_user.query>` and :doc:`group.query <api_methods_group.query>` methods. The first cache fill in an Active Directory domain may take a significant amount of time to complete and so it is performed within a job. The most likely situation in which a user may desire to refresh the directory services cache is after new users or groups are added to a remote directory server with the intention to have said users or groups appear in the results of the aforementioned accou…",method:`POST`,route:`/directoryservices.cache_refresh`,params:[],hidden:!1,deprecated:!1,rpc:{method:`directoryservices.cache_refresh`,params:[],job:!0,defaults:{}}},{path:[`directoryservices`,`certificate-choices`],summary:"Available certificate choices for use with the ``LDAP_MTLS`` ``credential_type``",description:"Available certificate choices for use with the ``LDAP_MTLS`` ``credential_type``. Note that prior configuration of LDAP server is required and uploading a custom certificate to TrueNAS may also be required.",method:`POST`,route:`/directoryservices.certificate_choices`,params:[],hidden:!1,deprecated:!1,rpc:{method:`directoryservices.certificate_choices`,params:[],job:!1,defaults:{}}},{path:[`directoryservices`,`config`],summary:``,description:``,method:`POST`,route:`/directoryservices.config`,params:[],hidden:!1,deprecated:!1,rpc:{method:`directoryservices.config`,params:[],job:!1,defaults:{}}},{path:[`directoryservices`,`leave`],summary:`Leave an Active Directory or IPA domain`,description:"Leave an Active Directory or IPA domain. Calling this endpoint when the directory services status is ``HEALTHY`` will cause TrueNAS to remove its account from the domain and then reset the local directory services configuration on TrueNAS.",method:`POST`,route:`/directoryservices.leave`,params:[],body:{required:!0,description:``,fields:[{wireName:`credential`,flag:`credential`,required:!0,description:`DirectoryServicesLeaveArgs parameters.`,type:{kind:`json`}}]},hidden:!1,deprecated:!1,rpc:{method:`directoryservices.leave`,params:[`credential`],job:!0,defaults:{}}},{path:[`directoryservices`,`status`],summary:`Provide the type and status of the currently-enabled directory service`,description:`Provide the type and status of the currently-enabled directory service.`,method:`POST`,route:`/directoryservices.status`,params:[],hidden:!1,deprecated:!1,rpc:{method:`directoryservices.status`,params:[],job:!1,defaults:{}}},{path:[`directoryservices`,`update`],summary:`Update the directory services configuration that binds TrueNAS to an Active Directory, IPA, or OpenLDAP domain`,description:`Update the directory services configuration that binds TrueNAS to an Active Directory, IPA, or OpenLDAP domain.`,method:`POST`,route:`/directoryservices.update`,params:[],body:{required:!0,description:``,fields:[{wireName:`directoryservices_update`,flag:`directoryservices-update`,required:!0,description:`DirectoryServicesUpdateArgs parameters.`,type:{kind:`json`}}]},hidden:!1,deprecated:!1,rpc:{method:`directoryservices.update`,params:[`directoryservices_update`],job:!0,defaults:{}}},{path:[`disk`,`details`],summary:`Return detailed information for all disks on the system`,description:`Return detailed information for all disks on the system.`,method:`POST`,route:`/disk.details`,params:[],body:{required:!0,description:``,fields:[{wireName:`data`,flag:`data`,required:!0,description:`Disk query parameters specifying which disks to return and options.`,type:{kind:`json`}}]},hidden:!1,deprecated:!1,rpc:{method:`disk.details`,params:[`data`],job:!1,defaults:{}}},{path:[`disk`,`get-used`],summary:`Return disks that are in use by any zpool that is currently imported`,description:`Return disks that are in use by any zpool that is currently imported. It will also return disks that are in use by any zpool that is exported.`,method:`POST`,route:`/disk.get_used`,params:[],body:{required:!1,description:``,fields:[{wireName:`join_partitions`,flag:`join-partitions`,required:!1,description:`Return all partitions currently written to disk.`,type:{kind:`boolean`}}]},hidden:!1,deprecated:!1,rpc:{method:`disk.get_used`,params:[`join_partitions`],job:!1,defaults:{join_partitions:!1}}},{path:[`disk`,`query`],summary:`Query disks`,description:`Query disks.`,method:`POST`,route:`/disk.query`,params:[],body:{required:!1,description:``,fields:[{wireName:`filters`,flag:`filters`,required:!1,description:`List of filters for query results. See API documentation for "Query Methods" for more guidance.`,type:{kind:`array`,elem:{kind:`json`}}},{wireName:`options`,flag:`options`,required:!1,description:`Query options including pagination, ordering, and additional parameters.`,type:{kind:`json`}}]},hidden:!1,deprecated:!1,rpc:{method:`disk.query`,params:[`filters`,`options`],job:!1,defaults:{filters:[],options:{extra:{},order_by:[],select:[],count:!1,get:!1,offset:0,limit:0,force_sql_filters:!1}}}},{path:[`disk`,`temperature-agg`],summary:"Returns min/max/avg temperature for ``names`` disks over the last ``days`` days",description:"Returns min/max/avg temperature for ``names`` disks over the last ``days`` days.",method:`POST`,route:`/disk.temperature_agg`,params:[],body:{required:!0,description:``,fields:[{wireName:`names`,flag:`names`,required:!0,description:`Array of disk names to retrieve temperature aggregates for.`,type:{kind:`array`,elem:{kind:`string`}}},{wireName:`days`,flag:`days`,required:!1,description:`Number of days to aggregate temperature data over.`,type:{kind:`integer`}}]},hidden:!1,deprecated:!1,rpc:{method:`disk.temperature_agg`,params:[`names`,`days`],job:!1,defaults:{days:7}}},{path:[`disk`,`temperature-alerts`],summary:`Returns existing temperature alerts for specified disks`,description:`Returns existing temperature alerts for specified disks.`,method:`POST`,route:`/disk.temperature_alerts`,params:[],body:{required:!0,description:``,fields:[{wireName:`names`,flag:`names`,required:!0,description:`Array of disk names to check for temperature-related alerts.`,type:{kind:`array`,elem:{kind:`string`}}}]},hidden:!1,deprecated:!1,rpc:{method:`disk.temperature_alerts`,params:[`names`],job:!1,defaults:{}}},{path:[`disk`,`temperatures`],summary:`Returns disk temperatures for disks in degrees celsius`,description:`Returns disk temperatures for disks in degrees celsius.`,method:`POST`,route:`/disk.temperatures`,params:[],body:{required:!0,description:``,fields:[{wireName:`name`,flag:`name`,required:!0,description:`List of names of disks to retrieve temperature information. Name should be in the form of "sda", "nvme0n1", etc.`,type:{kind:`array`,elem:{kind:`string`}}},{wireName:`include_thresholds`,flag:`include-thresholds`,required:!1,description:`Include the temperature thresholds as reported by the disk (i.e. the critical temp).`,type:{kind:`boolean`}}]},hidden:!1,deprecated:!1,rpc:{method:`disk.temperatures`,params:[`name`,`include_thresholds`],job:!1,defaults:{include_thresholds:!1}}},{path:[`disk`,`update`],summary:"Update disk of ``id``",description:"Update disk of ``id``.",method:`POST`,route:`/disk.update`,params:[],body:{required:!0,description:``,fields:[{wireName:`id`,flag:`id`,required:!0,description:`Disk identifier to update.`,type:{kind:`string`}},{wireName:`data`,flag:`data`,required:!0,description:`Updated disk configuration data.`,type:{kind:`json`}}]},hidden:!1,deprecated:!1,rpc:{method:`disk.update`,params:[`id`,`data`],job:!1,defaults:{}}},{path:[`disk`,`wipe`],summary:"Performs a wipe of a disk ``dev``",description:"Performs a wipe of a disk ``dev``.",method:`POST`,route:`/disk.wipe`,params:[],body:{required:!0,description:``,fields:[{wireName:`dev`,flag:`dev`,required:!0,description:`The device to perform the disk wipe operation on. May be passed as /dev/sda or just sda.`,type:{kind:`string`}},{wireName:`mode`,flag:`mode`,required:!0,description:`* QUICK: Write zeros to the first and last 32MB of device. * FULL: Write whole disk with zeros. * FULL_RANDOM: Write whole disk with random bytes.`,type:{kind:`enum`,values:[`QUICK`,`FULL`,`FULL_RANDOM`]}},{wireName:`synccache`,flag:`synccache`,required:!1,description:`Synchronize the device with the database.`,type:{kind:`boolean`}}]},confirmation:``,hidden:!1,deprecated:!1,rpc:{method:`disk.wipe`,params:[`dev`,`mode`,`synccache`],job:!0,defaults:{synccache:!0}}},{path:[`dns`,`query`],summary:"Query Name Servers with ``query-filters`` and ``query-options``",description:"Query Name Servers with ``query-filters`` and ``query-options``.",method:`POST`,route:`/dns.query`,params:[],body:{required:!1,description:``,fields:[{wireName:`filters`,flag:`filters`,required:!1,description:`List of filters for query results. See API documentation for "Query Methods" for more guidance.`,type:{kind:`array`,elem:{kind:`json`}}},{wireName:`options`,flag:`options`,required:!1,description:`Query options including pagination, ordering, and additional parameters.`,type:{kind:`json`}}]},hidden:!1,deprecated:!1,rpc:{method:`dns.query`,params:[`filters`,`options`],job:!1,defaults:{filters:[],options:{extra:{},order_by:[],select:[],count:!1,get:!1,offset:0,limit:0,force_sql_filters:!1}}}},{path:[`docker`,`backup`],summary:`Create a backup of existing apps`,description:`Create a backup of existing apps.`,method:`POST`,route:`/docker.backup`,params:[],body:{required:!1,description:``,fields:[{wireName:`backup_name`,flag:`backup-name`,required:!1,description:"Name for the backup or `null` to generate a timestamp-based name.",type:{kind:`string`}}]},hidden:!1,deprecated:!1,rpc:{method:`docker.backup`,params:[`backup_name`],job:!0,defaults:{backup_name:null}}},{path:[`docker`,`backup-to-pool`],summary:"Create a backup of existing apps on ``target_pool``",description:"Create a backup of existing apps on ``target_pool``.",method:`POST`,route:`/docker.backup_to_pool`,params:[],body:{required:!0,description:``,fields:[{wireName:`target_pool`,flag:`target-pool`,required:!0,description:`Name of the storage pool to backup Docker data to.`,type:{kind:`string`}}]},hidden:!1,deprecated:!1,rpc:{method:`docker.backup_to_pool`,params:[`target_pool`],job:!0,defaults:{}}},{path:[`docker`,`config`],summary:``,description:``,method:`POST`,route:`/docker.config`,params:[],hidden:!1,deprecated:!1,rpc:{method:`docker.config`,params:[],job:!1,defaults:{}}},{path:[`docker`,`delete-backup`],summary:"Delete ``backup_name`` app backup",description:"Delete ``backup_name`` app backup.",method:`POST`,route:`/docker.delete_backup`,params:[],body:{required:!0,description:``,fields:[{wireName:`backup_name`,flag:`backup-name`,required:!0,description:`Name of the backup to delete.`,type:{kind:`string`}}]},hidden:!1,deprecated:!1,rpc:{method:`docker.delete_backup`,params:[`backup_name`],job:!1,defaults:{}}},{path:[`docker`,`list-backups`],summary:`List existing app backups`,description:`List existing app backups.`,method:`POST`,route:`/docker.list_backups`,params:[],hidden:!1,deprecated:!1,rpc:{method:`docker.list_backups`,params:[],job:!1,defaults:{}}},{path:[`docker`,`nvidia-present`],summary:`Returns whether a non-isolated NVIDIA GPU is present in the system`,description:`Returns whether a non-isolated NVIDIA GPU is present in the system.`,method:`POST`,route:`/docker.nvidia_present`,params:[],hidden:!1,deprecated:!1,rpc:{method:`docker.nvidia_present`,params:[],job:!1,defaults:{}}},{path:[`docker`,`restore-backup`],summary:`Restore a backup of existing apps`,description:`Restore a backup of existing apps.`,method:`POST`,route:`/docker.restore_backup`,params:[],body:{required:!0,description:``,fields:[{wireName:`backup_name`,flag:`backup-name`,required:!0,description:`Name of the backup to restore.`,type:{kind:`string`}}]},hidden:!1,deprecated:!1,rpc:{method:`docker.restore_backup`,params:[`backup_name`],job:!0,defaults:{}}},{path:[`docker`,`status`],summary:`Returns the status of the docker service`,description:`Returns the status of the docker service.`,method:`POST`,route:`/docker.status`,params:[],hidden:!1,deprecated:!1,rpc:{method:`docker.status`,params:[],job:!1,defaults:{}}},{path:[`docker`,`update`],summary:`Update Docker service configuration`,description:`Update Docker service configuration.`,method:`POST`,route:`/docker.update`,params:[],body:{required:!0,description:``,fields:[{wireName:`docker_update`,flag:`docker-update`,required:!0,description:`DockerUpdateArgs parameters.`,type:{kind:`json`}}]},hidden:!1,deprecated:!1,rpc:{method:`docker.update`,params:[`docker_update`],job:!0,defaults:{}}},{path:[`docker`,`network`,`get-instance`],summary:"Returns instance matching `id`",description:"Returns instance matching `id`. If `id` is not found, Validation error is raised.",method:`POST`,route:`/docker.network.get_instance`,params:[],body:{required:!0,description:``,fields:[{wireName:`id`,flag:`id`,required:!0,description:``,type:{kind:`string`}},{wireName:`options`,flag:`options`,required:!0,description:`Query options customize the results returned by a query method. More complete documentation with examples are covered in the "Query methods" section of the TrueNAS API documentation.`,type:{kind:`json`}}]},hidden:!1,deprecated:!1,rpc:{method:`docker.network.get_instance`,params:[`id`,`options`],job:!1,defaults:{}}},{path:[`docker`,`network`,`query`],summary:``,description:``,method:`POST`,route:`/docker.network.query`,params:[],body:{required:!1,description:``,fields:[{wireName:`filters`,flag:`filters`,required:!1,description:`List of filters for query results. See API documentation for "Query Methods" for more guidance.`,type:{kind:`array`,elem:{kind:`json`}}},{wireName:`options`,flag:`options`,required:!1,description:`Query options including pagination, ordering, and additional parameters.`,type:{kind:`json`}}]},hidden:!1,deprecated:!1,rpc:{method:`docker.network.query`,params:[`filters`,`options`],job:!1,defaults:{filters:[],options:{extra:{},order_by:[],select:[],count:!1,get:!1,offset:0,limit:0,force_sql_filters:!1}}}},{path:[`enclosure`,`label`,`set`],summary:"Set a user-defined label for the enclosure identified by ``id``",description:"Set a user-defined label for the enclosure identified by ``id``.",method:`POST`,route:`/enclosure.label.set`,params:[],body:{required:!0,description:``,fields:[{wireName:`id`,flag:`id`,required:!0,description:`Enclosure identifier to set the label for.`,type:{kind:`string`}},{wireName:`label`,flag:`label`,required:!0,description:`New label to assign to the enclosure.`,type:{kind:`string`}}]},hidden:!1,deprecated:!1,rpc:{method:`enclosure.label.set`,params:[`id`,`label`],job:!1,defaults:{}}},{path:[`enclosure2`,`query`],summary:`Query detected enclosures on TrueNAS hardware`,description:`Query detected enclosures on TrueNAS hardware.`,method:`POST`,route:`/enclosure2.query`,params:[],body:{required:!1,description:``,fields:[{wireName:`filters`,flag:`filters`,required:!1,description:`List of filters for query results. See API documentation for "Query Methods" for more guidance.`,type:{kind:`array`,elem:{kind:`json`}}},{wireName:`options`,flag:`options`,required:!1,description:`Query options including pagination, ordering, and additional parameters.`,type:{kind:`json`}}]},hidden:!1,deprecated:!1,rpc:{method:`enclosure2.query`,params:[`filters`,`options`],job:!1,defaults:{filters:[],options:{extra:{},order_by:[],select:[],count:!1,get:!1,offset:0,limit:0,force_sql_filters:!1}}}},{path:[`enclosure2`,`set-slot-status`],summary:"Set enclosure bay number ``slot`` to ``status`` for ``enclosure_id``",description:"Set enclosure bay number ``slot`` to ``status`` for ``enclosure_id``.",method:`POST`,route:`/enclosure2.set_slot_status`,params:[],body:{required:!0,description:``,fields:[{wireName:`Enclosure2SetSlotStatus`,flag:`enclosure2-set-slot-status`,required:!0,description:`Enclosure2SetSlotStatusArgs parameters.`,type:{kind:`json`}}]},hidden:!1,deprecated:!1,rpc:{method:`enclosure2.set_slot_status`,params:[`Enclosure2SetSlotStatus`],job:!1,defaults:{}}},{path:[`failover`,`become-passive`],summary:`This method is only called manually by the end-user so we fully expect that they know what they're doing`,description:'This method is only called manually by the end-user so we fully expect that they know what they\'re doing. Furthermore, this method will only run if failover has NOT been administratively disabled. The reason why we only allow this in that scenario is because the failover logic (on the other node) will ignore any failover "event" that comes in if failover has been administratively disabled. This immediately causes the HA system to go into a "faulted" state because the other node will get the VIPs but it will not import the zpool and it will not start ``fenced``. Only way out of that situation…',method:`POST`,route:`/failover.become_passive`,params:[],hidden:!1,deprecated:!1,rpc:{method:`failover.become_passive`,params:[],job:!1,defaults:{}}},{path:[`failover`,`config`],summary:``,description:``,method:`POST`,route:`/failover.config`,params:[],hidden:!1,deprecated:!1,rpc:{method:`failover.config`,params:[],job:!1,defaults:{}}},{path:[`failover`,`get-ips`],summary:`Get a list of IPs for which the Web UI can be accessed`,description:`Get a list of IPs for which the Web UI can be accessed.`,method:`POST`,route:`/failover.get_ips`,params:[],hidden:!1,deprecated:!1,rpc:{method:`failover.get_ips`,params:[],job:!1,defaults:{}}},{path:[`failover`,`licensed`],summary:`Checks whether this instance is licensed as an HA unit`,description:`Checks whether this instance is licensed as an HA unit.`,method:`POST`,route:`/failover.licensed`,params:[],hidden:!1,deprecated:!1,rpc:{method:`failover.licensed`,params:[],job:!1,defaults:{}}},{path:[`failover`,`node`],summary:`Returns the slot position in the chassis that the controller is located`,description:`Returns the slot position in the chassis that the controller is located.`,method:`POST`,route:`/failover.node`,params:[],hidden:!1,deprecated:!1,rpc:{method:`failover.node`,params:[],job:!1,defaults:{}}},{path:[`failover`,`status`],summary:`Get the current HA status`,description:`Get the current HA status.`,method:`POST`,route:`/failover.status`,params:[],hidden:!1,deprecated:!1,rpc:{method:`failover.status`,params:[],job:!1,defaults:{}}},{path:[`failover`,`sync-from-peer`],summary:`Sync database and files from the other controller`,description:`Sync database and files from the other controller.`,method:`POST`,route:`/failover.sync_from_peer`,params:[],hidden:!1,deprecated:!1,rpc:{method:`failover.sync_from_peer`,params:[],job:!1,defaults:{}}},{path:[`failover`,`sync-to-peer`],summary:`Sync database and files to the other controller`,description:`Sync database and files to the other controller.`,method:`POST`,route:`/failover.sync_to_peer`,params:[],body:{required:!1,description:``,fields:[{wireName:`options`,flag:`options`,required:!1,description:`Options for syncing configuration to the peer node.`,type:{kind:`json`}}]},hidden:!1,deprecated:!1,rpc:{method:`failover.sync_to_peer`,params:[`options`],job:!1,defaults:{options:{reboot:!1}}}},{path:[`failover`,`update`],summary:`Update failover configuration`,description:`Update failover configuration.`,method:`POST`,route:`/failover.update`,params:[],body:{required:!0,description:``,fields:[{wireName:`data`,flag:`data`,required:!0,description:`Updated failover configuration data.`,type:{kind:`json`}}]},hidden:!1,deprecated:!1,rpc:{method:`failover.update`,params:[`data`],job:!1,defaults:{}}},{path:[`failover`,`disabled`,`reasons`],summary:`Returns a list of reasons why failover is not enabled/functional`,description:"Returns a list of reasons why failover is not enabled/functional. See ``DisabledReasonsEnum`` for the reasons and their explanation.",method:`POST`,route:`/failover.disabled.reasons`,params:[],hidden:!1,deprecated:!1,rpc:{method:`failover.disabled.reasons`,params:[],job:!1,defaults:{}}},{path:[`failover`,`reboot`,`info`],summary:`Return reboot information for both nodes of the failover pair`,description:`Return reboot information for both nodes of the failover pair.`,method:`POST`,route:`/failover.reboot.info`,params:[],hidden:!1,deprecated:!1,rpc:{method:`failover.reboot.info`,params:[],job:!1,defaults:{}}},{path:[`failover`,`reboot`,`other-node`],summary:`Reboot the other node and wait for it to come back online`,description:`Reboot the other node and wait for it to come back online.`,method:`POST`,route:`/failover.reboot.other_node`,params:[],body:{required:!1,description:``,fields:[{wireName:`options`,flag:`options`,required:!1,description:`Options for rebooting the other node.`,type:{kind:`json`}}]},hidden:!1,deprecated:!1,rpc:{method:`failover.reboot.other_node`,params:[`options`],job:!0,defaults:{options:{reason:`System upgrade`,graceful:!1}}}},{path:[`fc`,`capable`],summary:"Returns ``true`` if the system is licensed for FIBRECHANNEL and contains one or more Fibre Channel cards",description:"Returns ``true`` if the system is licensed for FIBRECHANNEL and contains one or more Fibre Channel cards. ``false`` otherwise.",method:`POST`,route:`/fc.capable`,params:[],hidden:!1,deprecated:!1,rpc:{method:`fc.capable`,params:[],job:!1,defaults:{}}},{path:[`fc`,`fc-host`,`create`],summary:`Create an FC host (pairing)`,description:`Create an FC host (pairing).`,method:`POST`,route:`/fc.fc_host.create`,params:[],body:{required:!0,description:``,fields:[{wireName:`fc_host_create`,flag:`fc-host-create`,required:!0,description:`Fibre Channel host configuration data for the new host.`,type:{kind:`json`}}]},hidden:!1,deprecated:!1,rpc:{method:`fc.fc_host.create`,params:[`fc_host_create`],job:!1,defaults:{}}},{path:[`fc`,`fc-host`,`delete`],summary:"Delete FC host ``id``",description:"Delete FC host ``id``.",method:`POST`,route:`/fc.fc_host.delete`,params:[],body:{required:!0,description:``,fields:[{wireName:`id`,flag:`id`,required:!0,description:`ID of the Fibre Channel host to delete.`,type:{kind:`integer`}}]},confirmation:``,hidden:!1,deprecated:!1,rpc:{method:`fc.fc_host.delete`,params:[`id`],job:!1,defaults:{}}},{path:[`fc`,`fc-host`,`get-instance`],summary:"Returns instance matching `id`",description:"Returns instance matching `id`. If `id` is not found, Validation error is raised.",method:`POST`,route:`/fc.fc_host.get_instance`,params:[],body:{required:!0,description:``,fields:[{wireName:`id`,flag:`id`,required:!0,description:``,type:{kind:`integer`}},{wireName:`options`,flag:`options`,required:!0,description:`Query options customize the results returned by a query method. More complete documentation with examples are covered in the "Query methods" section of the TrueNAS API documentation.`,type:{kind:`json`}}]},hidden:!1,deprecated:!1,rpc:{method:`fc.fc_host.get_instance`,params:[`id`,`options`],job:!1,defaults:{}}},{path:[`fc`,`fc-host`,`query`],summary:``,description:``,method:`POST`,route:`/fc.fc_host.query`,params:[],body:{required:!1,description:``,fields:[{wireName:`filters`,flag:`filters`,required:!1,description:`List of filters for query results. See API documentation for "Query Methods" for more guidance.`,type:{kind:`array`,elem:{kind:`json`}}},{wireName:`options`,flag:`options`,required:!1,description:`Query options including pagination, ordering, and additional parameters.`,type:{kind:`json`}}]},hidden:!1,deprecated:!1,rpc:{method:`fc.fc_host.query`,params:[`filters`,`options`],job:!1,defaults:{filters:[],options:{extra:{},order_by:[],select:[],count:!1,get:!1,offset:0,limit:0,force_sql_filters:!1}}}},{path:[`fc`,`fc-host`,`update`],summary:"Update FC host ``id``",description:"Update FC host ``id``.",method:`POST`,route:`/fc.fc_host.update`,params:[],body:{required:!0,description:``,fields:[{wireName:`id`,flag:`id`,required:!0,description:`ID of the Fibre Channel host to update.`,type:{kind:`integer`}},{wireName:`fc_host_update`,flag:`fc-host-update`,required:!0,description:`Updated Fibre Channel host configuration data.`,type:{kind:`json`}}]},hidden:!1,deprecated:!1,rpc:{method:`fc.fc_host.update`,params:[`id`,`fc_host_update`],job:!1,defaults:{}}},{path:[`fcport`,`create`],summary:`Creates mapping between a FC port and a target`,description:`Creates mapping between a FC port and a target.`,method:`POST`,route:`/fcport.create`,params:[],body:{required:!0,description:``,fields:[{wireName:`fc_Port_create`,flag:`fc-port-create`,required:!0,description:`Fibre Channel port configuration data for the new port.`,type:{kind:`json`}}]},hidden:!1,deprecated:!1,rpc:{method:`fcport.create`,params:[`fc_Port_create`],job:!1,defaults:{}}},{path:[`fcport`,`delete`],summary:"Delete FC port mapping ``id``",description:"Delete FC port mapping ``id``.",method:`POST`,route:`/fcport.delete`,params:[],body:{required:!0,description:``,fields:[{wireName:`id`,flag:`id`,required:!0,description:`ID of the Fibre Channel port to delete.`,type:{kind:`integer`}}]},confirmation:``,hidden:!1,deprecated:!1,rpc:{method:`fcport.delete`,params:[`id`],job:!1,defaults:{}}},{path:[`fcport`,`get-instance`],summary:"Returns instance matching `id`",description:"Returns instance matching `id`. If `id` is not found, Validation error is raised.",method:`POST`,route:`/fcport.get_instance`,params:[],body:{required:!0,description:``,fields:[{wireName:`id`,flag:`id`,required:!0,description:``,type:{kind:`integer`}},{wireName:`options`,flag:`options`,required:!0,description:`Query options customize the results returned by a query method. More complete documentation with examples are covered in the "Query methods" section of the TrueNAS API documentation.`,type:{kind:`json`}}]},hidden:!1,deprecated:!1,rpc:{method:`fcport.get_instance`,params:[`id`,`options`],job:!1,defaults:{}}},{path:[`fcport`,`port-choices`],summary:`Return the available Fibre Channel ports that can be assigned to a target`,description:`Return the available Fibre Channel ports that can be assigned to a target.`,method:`POST`,route:`/fcport.port_choices`,params:[],body:{required:!1,description:``,fields:[{wireName:`include_used`,flag:`include-used`,required:!1,description:`Whether to include FC ports that are already in use.`,type:{kind:`boolean`}}]},hidden:!1,deprecated:!1,rpc:{method:`fcport.port_choices`,params:[`include_used`],job:!1,defaults:{include_used:!0}}},{path:[`fcport`,`query`],summary:``,description:``,method:`POST`,route:`/fcport.query`,params:[],body:{required:!1,description:``,fields:[{wireName:`filters`,flag:`filters`,required:!1,description:`List of filters for query results. See API documentation for "Query Methods" for more guidance.`,type:{kind:`array`,elem:{kind:`json`}}},{wireName:`options`,flag:`options`,required:!1,description:`Query options including pagination, ordering, and additional parameters.`,type:{kind:`json`}}]},hidden:!1,deprecated:!1,rpc:{method:`fcport.query`,params:[`filters`,`options`],job:!1,defaults:{filters:[],options:{extra:{},order_by:[],select:[],count:!1,get:!1,offset:0,limit:0,force_sql_filters:!1}}}},{path:[`fcport`,`status`],summary:`Return the runtime status of Fibre Channel ports, including port state, type, speed, and connected sessions`,description:`Return the runtime status of Fibre Channel ports, including port state, type, speed, and connected sessions.`,method:`POST`,route:`/fcport.status`,params:[],body:{required:!1,description:``,fields:[{wireName:`filters`,flag:`filters`,required:!1,description:`List of filters for query results. See API documentation for "Query Methods" for more guidance.`,type:{kind:`array`,elem:{kind:`json`}}},{wireName:`options`,flag:`options`,required:!1,description:`Query options including pagination, ordering, and additional parameters.`,type:{kind:`json`}}]},hidden:!1,deprecated:!1,rpc:{method:`fcport.status`,params:[`filters`,`options`],job:!1,defaults:{filters:[],options:{extra:{},order_by:[],select:[],count:!1,get:!1,offset:0,limit:0,force_sql_filters:!1}}}},{path:[`fcport`,`update`],summary:"Update FC port mapping ``id``",description:"Update FC port mapping ``id``.",method:`POST`,route:`/fcport.update`,params:[],body:{required:!0,description:``,fields:[{wireName:`id`,flag:`id`,required:!0,description:`ID of the Fibre Channel port to update.`,type:{kind:`integer`}},{wireName:`fc_Port_update`,flag:`fc-port-update`,required:!0,description:`Updated Fibre Channel port configuration data.`,type:{kind:`json`}}]},hidden:!1,deprecated:!1,rpc:{method:`fcport.update`,params:[`id`,`fc_Port_update`],job:!1,defaults:{}}},{path:[`filesystem`,`chown`],summary:"Change owner or group of file at ``path``",description:"Change owner or group of file at ``path``.",method:`POST`,route:`/filesystem.chown`,params:[],body:{required:!0,description:``,fields:[{wireName:`filesystem_chown`,flag:`filesystem-chown`,required:!0,description:`FilesystemChownArgs parameters.`,type:{kind:`json`}}]},hidden:!1,deprecated:!1,rpc:{method:`filesystem.chown`,params:[`filesystem_chown`],job:!0,defaults:{}}},{path:[`filesystem`,`get-zfs-attributes`],summary:`Get the current ZFS attributes for the file at the given path`,description:`Get the current ZFS attributes for the file at the given path.`,method:`POST`,route:`/filesystem.get_zfs_attributes`,params:[],body:{required:!0,description:``,fields:[{wireName:`path`,flag:`path`,required:!0,description:`Path to the file to get ZFS attributes for.`,type:{kind:`string`}}]},hidden:!1,deprecated:!1,rpc:{method:`filesystem.get_zfs_attributes`,params:[`path`],job:!1,defaults:{}}},{path:[`filesystem`,`getacl`],summary:`Return ACL of a given path`,description:"Return ACL of a given path. This may return a POSIX1e ACL or a NFSv4 ACL. The ACL type is indicated by the ``acltype`` key.",method:`POST`,route:`/filesystem.getacl`,params:[],body:{required:!0,description:``,fields:[{wireName:`path`,flag:`path`,required:!0,description:`Absolute filesystem path to get ACL information for.`,type:{kind:`string`}},{wireName:`simplified`,flag:`simplified`,required:!1,description:`Whether to return simplified/basic permission sets instead of advanced permissions.`,type:{kind:`boolean`}},{wireName:`resolve_ids`,flag:`resolve-ids`,required:!1,description:`Whether to resolve numeric user/group IDs to names in the response.`,type:{kind:`boolean`}}]},hidden:!1,deprecated:!1,rpc:{method:`filesystem.getacl`,params:[`path`,`simplified`,`resolve_ids`],job:!1,defaults:{simplified:!0,resolve_ids:!1}}},{path:[`filesystem`,`listdir`],summary:`Get the contents of a directory`,description:`Get the contents of a directory.`,method:`POST`,route:`/filesystem.listdir`,params:[],body:{required:!0,description:``,fields:[{wireName:`path`,flag:`path`,required:!0,description:`Directory path to list contents of.`,type:{kind:`string`}},{wireName:`query_filters`,flag:`query-filters`,required:!1,description:`Query filters to apply to the directory listing.`,type:{kind:`array`,elem:{kind:`json`}}},{wireName:`query_options`,flag:`query-options`,required:!1,description:`Query options for sorting and pagination.`,type:{kind:`json`}}]},hidden:!1,deprecated:!1,rpc:{method:`filesystem.listdir`,params:[`path`,`query_filters`,`query_options`],job:!1,defaults:{query_filters:[],query_options:{extra:{},order_by:[],select:[],count:!1,get:!1,offset:0,limit:0,force_sql_filters:!1}}}},{path:[`filesystem`,`mkdir`],summary:`Create a directory at the specified path`,description:`Create a directory at the specified path.`,method:`POST`,route:`/filesystem.mkdir`,params:[],body:{required:!0,description:``,fields:[{wireName:`filesystem_mkdir`,flag:`filesystem-mkdir`,required:!0,description:`FilesystemMkdirArgs parameters.`,type:{kind:`json`}}]},hidden:!1,deprecated:!1,rpc:{method:`filesystem.mkdir`,params:[`filesystem_mkdir`],job:!1,defaults:{}}},{path:[`filesystem`,`set-zfs-attributes`],summary:"Set special ZFS-related file flags (MS-DOS attributes and the BSD-style ``immutable``/``nounlink``/``appendonly`` flags) on the specified path",description:"Set special ZFS-related file flags (MS-DOS attributes and the BSD-style ``immutable``/``nounlink``/``appendonly`` flags) on the specified path.",method:`POST`,route:`/filesystem.set_zfs_attributes`,params:[],body:{required:!0,description:``,fields:[{wireName:`set_zfs_file_attributes`,flag:`set-zfs-file-attributes`,required:!0,description:`FilesystemSetZfsAttributesArgs parameters.`,type:{kind:`json`}}]},hidden:!1,deprecated:!1,rpc:{method:`filesystem.set_zfs_attributes`,params:[`set_zfs_file_attributes`],job:!0,defaults:{}}},{path:[`filesystem`,`setacl`],summary:`Set the ACL of a given path`,description:`Set the ACL of a given path.`,method:`POST`,route:`/filesystem.setacl`,params:[],body:{required:!0,description:``,fields:[{wireName:`filesystem_acl`,flag:`filesystem-acl`,required:!0,description:`FilesystemSetaclArgs parameters.`,type:{kind:`json`}}]},hidden:!1,deprecated:!1,rpc:{method:`filesystem.setacl`,params:[`filesystem_acl`],job:!0,defaults:{}}},{path:[`filesystem`,`setperm`],summary:"Set Unix permissions on the given ``path``",description:"Set Unix permissions on the given ``path``.",method:`POST`,route:`/filesystem.setperm`,params:[],body:{required:!0,description:``,fields:[{wireName:`filesystem_setperm`,flag:`filesystem-setperm`,required:!0,description:`FilesystemSetpermArgs parameters.`,type:{kind:`json`}}]},hidden:!1,deprecated:!1,rpc:{method:`filesystem.setperm`,params:[`filesystem_setperm`],job:!0,defaults:{}}},{path:[`filesystem`,`stat`],summary:`Return filesystem information for a given path`,description:`Return filesystem information for a given path.`,method:`POST`,route:`/filesystem.stat`,params:[],body:{required:!0,description:``,fields:[{wireName:`path`,flag:`path`,required:!0,description:`Absolute filesystem path to get statistics for.`,type:{kind:`string`}}]},hidden:!1,deprecated:!1,rpc:{method:`filesystem.stat`,params:[`path`],job:!1,defaults:{}}},{path:[`filesystem`,`statfs`],summary:`Return stats from the filesystem of a given path`,description:`Return stats from the filesystem of a given path.`,method:`POST`,route:`/filesystem.statfs`,params:[],body:{required:!0,description:``,fields:[{wireName:`path`,flag:`path`,required:!0,description:`Path on the filesystem to get statistics for.`,type:{kind:`string`}}]},hidden:!1,deprecated:!1,rpc:{method:`filesystem.statfs`,params:[`path`],job:!1,defaults:{}}},{path:[`filesystem`,`acltemplate`,`by-path`],summary:"Retrieve list of available ACL templates for a given ``path``",description:"Retrieve list of available ACL templates for a given ``path``. Supports ``query-filters`` and ``query-options``.",method:`POST`,route:`/filesystem.acltemplate.by_path`,params:[],body:{required:!0,description:``,fields:[{wireName:`filesystem_acl`,flag:`filesystem-acl`,required:!0,description:`ACLTemplateByPathArgs parameters.`,type:{kind:`json`}}]},hidden:!1,deprecated:!1,rpc:{method:`filesystem.acltemplate.by_path`,params:[`filesystem_acl`],job:!1,defaults:{}}},{path:[`filesystem`,`acltemplate`,`create`],summary:`Create a new filesystem ACL template`,description:`Create a new filesystem ACL template.`,method:`POST`,route:`/filesystem.acltemplate.create`,params:[],body:{required:!0,description:``,fields:[{wireName:`acltemplate_create`,flag:`acltemplate-create`,required:!0,description:`ACL template configuration data for the new template.`,type:{kind:`json`}}]},hidden:!1,deprecated:!1,rpc:{method:`filesystem.acltemplate.create`,params:[`acltemplate_create`],job:!1,defaults:{}}},{path:[`filesystem`,`acltemplate`,`delete`],summary:"Delete the ACL template identified by ``id``",description:"Delete the ACL template identified by ``id``.",method:`POST`,route:`/filesystem.acltemplate.delete`,params:[],body:{required:!0,description:``,fields:[{wireName:`id`,flag:`id`,required:!0,description:`ID of the ACL template to delete.`,type:{kind:`integer`}}]},confirmation:``,hidden:!1,deprecated:!1,rpc:{method:`filesystem.acltemplate.delete`,params:[`id`],job:!1,defaults:{}}},{path:[`filesystem`,`acltemplate`,`get-instance`],summary:"Returns instance matching `id`",description:"Returns instance matching `id`. If `id` is not found, Validation error is raised.",method:`POST`,route:`/filesystem.acltemplate.get_instance`,params:[],body:{required:!0,description:``,fields:[{wireName:`id`,flag:`id`,required:!0,description:``,type:{kind:`integer`}},{wireName:`options`,flag:`options`,required:!0,description:`Query options customize the results returned by a query method. More complete documentation with examples are covered in the "Query methods" section of the TrueNAS API documentation.`,type:{kind:`json`}}]},hidden:!1,deprecated:!1,rpc:{method:`filesystem.acltemplate.get_instance`,params:[`id`,`options`],job:!1,defaults:{}}},{path:[`filesystem`,`acltemplate`,`query`],summary:`Retrieve the available filesystem ACL templates`,description:`Retrieve the available filesystem ACL templates.`,method:`POST`,route:`/filesystem.acltemplate.query`,params:[],body:{required:!1,description:``,fields:[{wireName:`filters`,flag:`filters`,required:!1,description:`List of filters for query results. See API documentation for "Query Methods" for more guidance.`,type:{kind:`array`,elem:{kind:`json`}}},{wireName:`options`,flag:`options`,required:!1,description:`Query options including pagination, ordering, and additional parameters.`,type:{kind:`json`}}]},hidden:!1,deprecated:!1,rpc:{method:`filesystem.acltemplate.query`,params:[`filters`,`options`],job:!1,defaults:{filters:[],options:{extra:{},order_by:[],select:[],count:!1,get:!1,offset:0,limit:0,force_sql_filters:!1}}}},{path:[`filesystem`,`acltemplate`,`update`],summary:"Update filesystem ACL template with ``id``",description:"Update filesystem ACL template with ``id``.",method:`POST`,route:`/filesystem.acltemplate.update`,params:[],body:{required:!0,description:``,fields:[{wireName:`id`,flag:`id`,required:!0,description:`ID of the ACL template to update.`,type:{kind:`integer`}},{wireName:`acltemplate_update`,flag:`acltemplate-update`,required:!0,description:`Updated ACL template configuration data.`,type:{kind:`json`}}]},hidden:!1,deprecated:!1,rpc:{method:`filesystem.acltemplate.update`,params:[`id`,`acltemplate_update`],job:!1,defaults:{}}},{path:[`ftp`,`config`],summary:``,description:``,method:`POST`,route:`/ftp.config`,params:[],hidden:!1,deprecated:!1,rpc:{method:`ftp.config`,params:[],job:!1,defaults:{}}},{path:[`ftp`,`update`],summary:`Update ftp service configuration`,description:`Update ftp service configuration.`,method:`POST`,route:`/ftp.update`,params:[],body:{required:!0,description:``,fields:[{wireName:`ftp_update`,flag:`ftp-update`,required:!0,description:`FTPUpdateArgs parameters.`,type:{kind:`json`}}]},hidden:!1,deprecated:!1,rpc:{method:`ftp.update`,params:[`ftp_update`],job:!1,defaults:{}}},{path:[`group`,`create`],summary:`Create a new group`,description:`Create a new group.`,method:`POST`,route:`/group.create`,params:[],body:{required:!0,description:``,fields:[{wireName:`group_create`,flag:`group-create`,required:!0,description:`Group configuration data for the new group.`,type:{kind:`json`}}]},hidden:!1,deprecated:!1,rpc:{method:`group.create`,params:[`group_create`],job:!1,defaults:{}}},{path:[`group`,`delete`],summary:"Delete group ``id``",description:"Delete group ``id``.",method:`POST`,route:`/group.delete`,params:[],body:{required:!0,description:``,fields:[{wireName:`id`,flag:`id`,required:!0,description:`API identifier of the group to delete.`,type:{kind:`integer`}},{wireName:`options`,flag:`options`,required:!1,description:`Options controlling group deletion behavior.`,type:{kind:`json`}}]},confirmation:``,hidden:!1,deprecated:!1,rpc:{method:`group.delete`,params:[`id`,`options`],job:!1,defaults:{options:{delete_users:!1}}}},{path:[`group`,`get-group-obj`],summary:"Returns dictionary containing information from struct grp for the group specified by either the ``groupname`` or ``gid``",description:"Returns dictionary containing information from struct grp for the group specified by either the ``groupname`` or ``gid``.",method:`POST`,route:`/group.get_group_obj`,params:[],body:{required:!0,description:``,fields:[{wireName:`get_group_obj`,flag:`get-group-obj`,required:!0,description:`GroupGetGroupObjArgs parameters.`,type:{kind:`json`}}]},hidden:!1,deprecated:!1,rpc:{method:`group.get_group_obj`,params:[`get_group_obj`],job:!1,defaults:{}}},{path:[`group`,`get-instance`],summary:"Returns instance matching `id`",description:"Returns instance matching `id`. If `id` is not found, Validation error is raised.",method:`POST`,route:`/group.get_instance`,params:[],body:{required:!0,description:``,fields:[{wireName:`id`,flag:`id`,required:!0,description:``,type:{kind:`integer`}},{wireName:`options`,flag:`options`,required:!0,description:`Query options customize the results returned by a query method. More complete documentation with examples are covered in the "Query methods" section of the TrueNAS API documentation.`,type:{kind:`json`}}]},hidden:!1,deprecated:!1,rpc:{method:`group.get_instance`,params:[`id`,`options`],job:!1,defaults:{}}},{path:[`group`,`get-next-gid`],summary:`Get the next available/free gid`,description:`Get the next available/free gid.`,method:`POST`,route:`/group.get_next_gid`,params:[],hidden:!1,deprecated:!1,rpc:{method:`group.get_next_gid`,params:[],job:!1,defaults:{}}},{path:[`group`,`has-password-enabled-user`],summary:"Checks whether at least one local user with a password is a member of any of the ``group_ids``",description:"Checks whether at least one local user with a password is a member of any of the ``group_ids``.",method:`POST`,route:`/group.has_password_enabled_user`,params:[],body:{required:!0,description:``,fields:[{wireName:`gids`,flag:`gids`,required:!0,description:`Array of group IDs to check for password-enabled users.`,type:{kind:`array`,elem:{kind:`integer`}}},{wireName:`exclude_user_ids`,flag:`exclude-user-ids`,required:!1,description:`Array of user IDs to exclude from the check.`,type:{kind:`array`,elem:{kind:`integer`}}}]},hidden:!1,deprecated:!1,rpc:{method:`group.has_password_enabled_user`,params:[`gids`,`exclude_user_ids`],job:!1,defaults:{exclude_user_ids:[]}}},{path:[`group`,`query`],summary:"Query groups with `query-filters` and `query-options`",description:"Query groups with `query-filters` and `query-options`.",method:`POST`,route:`/group.query`,params:[],body:{required:!1,description:``,fields:[{wireName:`filters`,flag:`filters`,required:!1,description:`List of filters for query results. See API documentation for "Query Methods" for more guidance.`,type:{kind:`array`,elem:{kind:`json`}}},{wireName:`options`,flag:`options`,required:!1,description:`Query options including pagination, ordering, and additional parameters.`,type:{kind:`json`}}]},hidden:!1,deprecated:!1,rpc:{method:`group.query`,params:[`filters`,`options`],job:!1,defaults:{filters:[],options:{extra:{},order_by:[],select:[],count:!1,get:!1,offset:0,limit:0,force_sql_filters:!1}}}},{path:[`group`,`update`],summary:`Update attributes of an existing group`,description:`Update attributes of an existing group.`,method:`POST`,route:`/group.update`,params:[],body:{required:!0,description:``,fields:[{wireName:`id`,flag:`id`,required:!0,description:`The API identifier of the group to update.`,type:{kind:`integer`}},{wireName:`group_update`,flag:`group-update`,required:!0,description:`Updated group configuration data.`,type:{kind:`json`}}]},hidden:!1,deprecated:!1,rpc:{method:`group.update`,params:[`id`,`group_update`],job:!1,defaults:{}}},{path:[`hardware`,`virtualization`,`variant`],summary:`Report the virtualization variation of TrueNAS system`,description:`Report the virtualization variation of TrueNAS system.`,method:`POST`,route:`/hardware.virtualization.variant`,params:[],hidden:!1,deprecated:!1,rpc:{method:`hardware.virtualization.variant`,params:[],job:!1,defaults:{}}},{path:[`idmap`,`clear-idmap-cache`],summary:`Stop samba, remove the winbindd_cache.tdb file, start samba, flush samba's cache`,description:`Stop samba, remove the winbindd_cache.tdb file, start samba, flush samba's cache. This should be performed after finalizing idmap changes.`,method:`POST`,route:`/idmap.clear_idmap_cache`,params:[],hidden:!1,deprecated:!1,rpc:{method:`idmap.clear_idmap_cache`,params:[],job:!0,defaults:{}}},{path:[`initshutdownscript`,`create`],summary:`Create an initshutdown script task`,description:`Create an initshutdown script task.`,method:`POST`,route:`/initshutdownscript.create`,params:[],body:{required:!0,description:``,fields:[{wireName:`data`,flag:`data`,required:!0,description:`Init/shutdown script configuration data for creation.`,type:{kind:`json`}}]},hidden:!1,deprecated:!1,rpc:{method:`initshutdownscript.create`,params:[`data`],job:!1,defaults:{}}},{path:[`initshutdownscript`,`delete`],summary:"Delete init/shutdown task of ``id``",description:"Delete init/shutdown task of ``id``.",method:`POST`,route:`/initshutdownscript.delete`,params:[],body:{required:!0,description:``,fields:[{wireName:`id`,flag:`id`,required:!0,description:`ID of the init/shutdown script to delete.`,type:{kind:`integer`}}]},confirmation:``,hidden:!1,deprecated:!1,rpc:{method:`initshutdownscript.delete`,params:[`id`],job:!1,defaults:{}}},{path:[`initshutdownscript`,`get-instance`],summary:"Returns instance matching `id`",description:"Returns instance matching `id`. If `id` is not found, Validation error is raised.",method:`POST`,route:`/initshutdownscript.get_instance`,params:[],body:{required:!0,description:``,fields:[{wireName:`id`,flag:`id`,required:!0,description:``,type:{kind:`integer`}},{wireName:`options`,flag:`options`,required:!0,description:`Query options customize the results returned by a query method. More complete documentation with examples are covered in the "Query methods" section of the TrueNAS API documentation.`,type:{kind:`json`}}]},hidden:!1,deprecated:!1,rpc:{method:`initshutdownscript.get_instance`,params:[`id`,`options`],job:!1,defaults:{}}},{path:[`initshutdownscript`,`query`],summary:``,description:``,method:`POST`,route:`/initshutdownscript.query`,params:[],body:{required:!1,description:``,fields:[{wireName:`filters`,flag:`filters`,required:!1,description:`List of filters for query results. See API documentation for "Query Methods" for more guidance.`,type:{kind:`array`,elem:{kind:`json`}}},{wireName:`options`,flag:`options`,required:!1,description:`Query options including pagination, ordering, and additional parameters.`,type:{kind:`json`}}]},hidden:!1,deprecated:!1,rpc:{method:`initshutdownscript.query`,params:[`filters`,`options`],job:!1,defaults:{filters:[],options:{extra:{},order_by:[],select:[],count:!1,get:!1,offset:0,limit:0,force_sql_filters:!1}}}},{path:[`initshutdownscript`,`update`],summary:"Update initshutdown script task of ``id``",description:"Update initshutdown script task of ``id``.",method:`POST`,route:`/initshutdownscript.update`,params:[],body:{required:!0,description:``,fields:[{wireName:`id`,flag:`id`,required:!0,description:`ID of the init/shutdown script to update.`,type:{kind:`integer`}},{wireName:`data`,flag:`data`,required:!0,description:`Updated init/shutdown script configuration data.`,type:{kind:`json`}}]},hidden:!1,deprecated:!1,rpc:{method:`initshutdownscript.update`,params:[`id`,`data`],job:!1,defaults:{}}},{path:[`interface`,`bridge-members-choices`],summary:"Return available interface choices that can be added to a ``br`` (bridge) interface",description:"Return available interface choices that can be added to a ``br`` (bridge) interface.",method:`POST`,route:`/interface.bridge_members_choices`,params:[],body:{required:!1,description:``,fields:[{wireName:`id`,flag:`id`,required:!1,description:`Name of existing bridge interface whose member interfaces should be included in the result.`,type:{kind:`string`}}]},hidden:!1,deprecated:!1,rpc:{method:`interface.bridge_members_choices`,params:[`id`],job:!1,defaults:{id:null}}},{path:[`interface`,`cancel-rollback`],summary:`If this method is called after interface changes have been committed and within the checkin timeout, then the task that automatically rolls back any interface changes is cancelled and the in-memory snapshot of database tables for the vario…`,description:`If this method is called after interface changes have been committed and within the checkin timeout, then the task that automatically rolls back any interface changes is cancelled and the in-memory snapshot of database tables for the various interface tables will NOT be cleared.`,method:`POST`,route:`/interface.cancel_rollback`,params:[],hidden:!1,deprecated:!1,rpc:{method:`interface.cancel_rollback`,params:[],job:!1,defaults:{}}},{path:[`interface`,`checkin`],summary:`If this method is called after interface changes have been committed and within the checkin timeout, then the task that automatically rolls back any interface changes is cancelled and the in-memory snapshot of database tables for the vario…`,description:`If this method is called after interface changes have been committed and within the checkin timeout, then the task that automatically rolls back any interface changes is cancelled and the in-memory snapshot of database tables for the various interface tables will be cleared. The idea is that the end-user has verified the changes work as intended and need to be committed permanently.`,method:`POST`,route:`/interface.checkin`,params:[],hidden:!1,deprecated:!1,rpc:{method:`interface.checkin`,params:[],job:!1,defaults:{}}},{path:[`interface`,`checkin-waiting`],summary:`Returns whether we are waiting for the user to check in the applied network changes before they are rolled back`,description:`Returns whether we are waiting for the user to check in the applied network changes before they are rolled back.`,method:`POST`,route:`/interface.checkin_waiting`,params:[],hidden:!1,deprecated:!1,rpc:{method:`interface.checkin_waiting`,params:[],job:!1,defaults:{}}},{path:[`interface`,`choices`],summary:`Choices of available network interfaces`,description:`Choices of available network interfaces.`,method:`POST`,route:`/interface.choices`,params:[],body:{required:!0,description:``,fields:[{wireName:`options`,flag:`options`,required:!0,description:`Options for filtering interface choices.`,type:{kind:`json`}}]},hidden:!1,deprecated:!1,rpc:{method:`interface.choices`,params:[`options`],job:!1,defaults:{}}},{path:[`interface`,`commit`],summary:`Commit/apply pending interfaces changes`,description:`Commit/apply pending interfaces changes.`,method:`POST`,route:`/interface.commit`,params:[],body:{required:!0,description:``,fields:[{wireName:`options`,flag:`options`,required:!0,description:`Options for committing interface changes.`,type:{kind:`json`}}]},hidden:!1,deprecated:!1,rpc:{method:`interface.commit`,params:[`options`],job:!1,defaults:{}}},{path:[`interface`,`create`],summary:`Create virtual interfaces (Link Aggregation, VLAN)`,description:`Create virtual interfaces (Link Aggregation, VLAN).`,method:`POST`,route:`/interface.create`,params:[],body:{required:!0,description:``,fields:[{wireName:`data`,flag:`data`,required:!0,description:`Configuration data for the new interface.`,type:{kind:`json`}}]},hidden:!1,deprecated:!1,rpc:{method:`interface.create`,params:[`data`],job:!1,defaults:{}}},{path:[`interface`,`delete`],summary:"Delete Interface of ``id``",description:"Delete Interface of ``id``.",method:`POST`,route:`/interface.delete`,params:[],body:{required:!0,description:``,fields:[{wireName:`id`,flag:`id`,required:!0,description:`ID of the interface to delete.`,type:{kind:`string`}}]},confirmation:``,hidden:!1,deprecated:!1,rpc:{method:`interface.delete`,params:[`id`],job:!1,defaults:{}}},{path:[`interface`,`get-instance`],summary:"Returns instance matching `id`",description:"Returns instance matching `id`. If `id` is not found, Validation error is raised.",method:`POST`,route:`/interface.get_instance`,params:[],body:{required:!0,description:``,fields:[{wireName:`id`,flag:`id`,required:!0,description:``,type:{kind:`string`}},{wireName:`options`,flag:`options`,required:!0,description:`Query options customize the results returned by a query method. More complete documentation with examples are covered in the "Query methods" section of the TrueNAS API documentation.`,type:{kind:`json`}}]},hidden:!1,deprecated:!1,rpc:{method:`interface.get_instance`,params:[`id`,`options`],job:!1,defaults:{}}},{path:[`interface`,`has-pending-changes`],summary:`Return whether there are pending interfaces changes to be applied or not`,description:`Return whether there are pending interfaces changes to be applied or not.`,method:`POST`,route:`/interface.has_pending_changes`,params:[],hidden:!1,deprecated:!1,rpc:{method:`interface.has_pending_changes`,params:[],job:!1,defaults:{}}},{path:[`interface`,`ip-in-use`],summary:`Get all IPv4 / IPv6 from all valid interfaces`,description:`Get all IPv4 / IPv6 from all valid interfaces.`,method:`POST`,route:`/interface.ip_in_use`,params:[],body:{required:!0,description:``,fields:[{wireName:`options`,flag:`options`,required:!0,description:`Options for filtering IP addresses in use.`,type:{kind:`json`}}]},hidden:!1,deprecated:!1,rpc:{method:`interface.ip_in_use`,params:[`options`],job:!1,defaults:{}}},{path:[`interface`,`lacpdu-rate-choices`],summary:`Available lacpdu rate policies for the LACP lagg type interfaces`,description:`Available lacpdu rate policies for the LACP lagg type interfaces.`,method:`POST`,route:`/interface.lacpdu_rate_choices`,params:[],hidden:!1,deprecated:!1,rpc:{method:`interface.lacpdu_rate_choices`,params:[],job:!1,defaults:{}}},{path:[`interface`,`lag-ports-choices`],summary:"Return available interface choices that can be added to a ``bond`` (lag) interface",description:"Return available interface choices that can be added to a ``bond`` (lag) interface.",method:`POST`,route:`/interface.lag_ports_choices`,params:[],body:{required:!1,description:``,fields:[{wireName:`id`,flag:`id`,required:!1,description:`Name of existing bond interface whose member interfaces should be included in the result.`,type:{kind:`string`}}]},hidden:!1,deprecated:!1,rpc:{method:`interface.lag_ports_choices`,params:[`id`],job:!1,defaults:{id:null}}},{path:[`interface`,`network-config-to-be-removed`],summary:`Determines which network configuration items will be removed during interface setup`,description:`Determines which network configuration items will be removed during interface setup.`,method:`POST`,route:`/interface.network_config_to_be_removed`,params:[],hidden:!1,deprecated:!1,rpc:{method:`interface.network_config_to_be_removed`,params:[],job:!1,defaults:{}}},{path:[`interface`,`query`],summary:"Query network interfaces with the standard ``query-filters`` and ``query-options``",description:"Query network interfaces with the standard ``query-filters`` and ``query-options``.",method:`POST`,route:`/interface.query`,params:[],body:{required:!1,description:``,fields:[{wireName:`filters`,flag:`filters`,required:!1,description:`List of filters for query results. See API documentation for "Query Methods" for more guidance.`,type:{kind:`array`,elem:{kind:`json`}}},{wireName:`options`,flag:`options`,required:!1,description:`Query options including pagination, ordering, and additional parameters.`,type:{kind:`json`}}]},hidden:!1,deprecated:!1,rpc:{method:`interface.query`,params:[`filters`,`options`],job:!1,defaults:{filters:[],options:{extra:{},order_by:[],select:[],count:!1,get:!1,offset:0,limit:0,force_sql_filters:!1}}}},{path:[`interface`,`rollback`],summary:`Rollback pending interfaces changes`,description:`Rollback pending interfaces changes.`,method:`POST`,route:`/interface.rollback`,params:[],confirmation:``,hidden:!1,deprecated:!1,rpc:{method:`interface.rollback`,params:[],job:!1,defaults:{}}},{path:[`interface`,`save-network-config`],summary:`Saves network configuration settings to prevent network isolation during interface changes`,description:`Saves network configuration settings to prevent network isolation during interface changes.`,method:`POST`,route:`/interface.save_network_config`,params:[],body:{required:!0,description:``,fields:[{wireName:`config`,flag:`config`,required:!0,description:`InterfaceSaveNetworkConfigArgs parameters.`,type:{kind:`json`}}]},hidden:!1,deprecated:!1,rpc:{method:`interface.save_network_config`,params:[`config`],job:!1,defaults:{}}},{path:[`interface`,`services-restarted-on-sync`],summary:`Returns which services will be set to listen on 0.0.0.0 (and, thus, restarted) on sync`,description:`Returns which services will be set to listen on 0.0.0.0 (and, thus, restarted) on sync.`,method:`POST`,route:`/interface.services_restarted_on_sync`,params:[],hidden:!1,deprecated:!1,rpc:{method:`interface.services_restarted_on_sync`,params:[],job:!1,defaults:{}}},{path:[`interface`,`update`],summary:"Update Interface of ``id``",description:"Update Interface of ``id``.",method:`POST`,route:`/interface.update`,params:[],body:{required:!0,description:``,fields:[{wireName:`id`,flag:`id`,required:!0,description:`ID of the interface to update.`,type:{kind:`string`}},{wireName:`data`,flag:`data`,required:!0,description:`Updated interface configuration data.`,type:{kind:`json`}}]},hidden:!1,deprecated:!1,rpc:{method:`interface.update`,params:[`id`,`data`],job:!1,defaults:{}}},{path:[`interface`,`vlan-parent-interface-choices`],summary:"Return available interface choices for ``vlan_parent_interface`` attribute",description:"Return available interface choices for ``vlan_parent_interface`` attribute.",method:`POST`,route:`/interface.vlan_parent_interface_choices`,params:[],hidden:!1,deprecated:!1,rpc:{method:`interface.vlan_parent_interface_choices`,params:[],job:!1,defaults:{}}},{path:[`interface`,`websocket-interface`],summary:`Returns the interface this websocket is connected to`,description:`Returns the interface this websocket is connected to.`,method:`POST`,route:`/interface.websocket_interface`,params:[],hidden:!1,deprecated:!1,rpc:{method:`interface.websocket_interface`,params:[],job:!1,defaults:{}}},{path:[`interface`,`websocket-local-ip`],summary:`Returns the local ip address for this websocket session`,description:`Returns the local ip address for this websocket session.`,method:`POST`,route:`/interface.websocket_local_ip`,params:[],hidden:!1,deprecated:!1,rpc:{method:`interface.websocket_local_ip`,params:[],job:!1,defaults:{}}},{path:[`interface`,`xmit-hash-policy-choices`],summary:`Available transmit hash policies for the LACP or LOADBALANCE lagg type interfaces`,description:`Available transmit hash policies for the LACP or LOADBALANCE lagg type interfaces.`,method:`POST`,route:`/interface.xmit_hash_policy_choices`,params:[],hidden:!1,deprecated:!1,rpc:{method:`interface.xmit_hash_policy_choices`,params:[],job:!1,defaults:{}}},{path:[`ipmi`,`is-loaded`],summary:`Returns a boolean value indicating if /dev/ipmi0 is loaded`,description:`Returns a boolean value indicating if /dev/ipmi0 is loaded.`,method:`POST`,route:`/ipmi.is_loaded`,params:[],hidden:!1,deprecated:!1,rpc:{method:`ipmi.is_loaded`,params:[],job:!1,defaults:{}}},{path:[`ipmi`,`chassis`,`identify`],summary:`Toggle the chassis identify light on or off`,description:`Toggle the chassis identify light on or off.`,method:`POST`,route:`/ipmi.chassis.identify`,params:[],body:{required:!1,description:``,fields:[{wireName:`verb`,flag:`verb`,required:!1,description:`Action to perform on the chassis identify LED.`,type:{kind:`enum`,values:[`ON`,`OFF`]}}]},hidden:!1,deprecated:!1,rpc:{method:`ipmi.chassis.identify`,params:[`verb`],job:!1,defaults:{verb:`ON`}}},{path:[`ipmi`,`chassis`,`info`],summary:`Return IPMI chassis info`,description:`Return IPMI chassis info.`,method:`POST`,route:`/ipmi.chassis.info`,params:[],hidden:!1,deprecated:!1,rpc:{method:`ipmi.chassis.info`,params:[],job:!1,defaults:{}}},{path:[`ipmi`,`lan`,`channels`],summary:`Return a list of available IPMI channels`,description:`Return a list of available IPMI channels.`,method:`POST`,route:`/ipmi.lan.channels`,params:[],hidden:!1,deprecated:!1,rpc:{method:`ipmi.lan.channels`,params:[],job:!1,defaults:{}}},{path:[`ipmi`,`lan`,`query`],summary:"Query available IPMI Channels with ``query-filters`` and ``query-options``",description:"Query available IPMI Channels with ``query-filters`` and ``query-options``.",method:`POST`,route:`/ipmi.lan.query`,params:[],body:{required:!0,description:``,fields:[{wireName:`data`,flag:`data`,required:!0,description:`Query parameters for IPMI LAN configuration.`,type:{kind:`json`}}]},hidden:!1,deprecated:!1,rpc:{method:`ipmi.lan.query`,params:[`data`],job:!1,defaults:{}}},{path:[`ipmi`,`lan`,`update`],summary:`Update IPMI channel configuration`,description:`Update IPMI channel configuration.`,method:`POST`,route:`/ipmi.lan.update`,params:[],body:{required:!0,description:``,fields:[{wireName:`channel`,flag:`channel`,required:!0,description:`IPMI LAN channel number to update.`,type:{kind:`integer`}},{wireName:`data`,flag:`data`,required:!0,description:`IPMI LAN configuration data (DHCP or static IP).`,type:{kind:`json`}}]},hidden:!1,deprecated:!1,rpc:{method:`ipmi.lan.update`,params:[`channel`,`data`],job:!1,defaults:{}}},{path:[`ipmi`,`sel`,`clear`],summary:`Clear all entries from the IPMI System Event Log (SEL)`,description:`Clear all entries from the IPMI System Event Log (SEL).`,method:`POST`,route:`/ipmi.sel.clear`,params:[],hidden:!1,deprecated:!1,rpc:{method:`ipmi.sel.clear`,params:[],job:!0,defaults:{}}},{path:[`ipmi`,`sel`,`elist`],summary:`Query IPMI System Event Log (SEL) extended list`,description:`Query IPMI System Event Log (SEL) extended list.`,method:`POST`,route:`/ipmi.sel.elist`,params:[],body:{required:!1,description:``,fields:[{wireName:`filters`,flag:`filters`,required:!1,description:`List of filters for query results. See API documentation for "Query Methods" for more guidance.`,type:{kind:`array`,elem:{kind:`json`}}},{wireName:`options`,flag:`options`,required:!1,description:`Query options including pagination, ordering, and additional parameters.`,type:{kind:`json`}}]},hidden:!1,deprecated:!1,rpc:{method:`ipmi.sel.elist`,params:[`filters`,`options`],job:!0,defaults:{filters:[],options:{extra:{},order_by:[],select:[],count:!1,get:!1,offset:0,limit:0,force_sql_filters:!1}}}},{path:[`ipmi`,`sel`,`info`],summary:`Query General information about the IPMI System Event Log`,description:`Query General information about the IPMI System Event Log.`,method:`POST`,route:`/ipmi.sel.info`,params:[],hidden:!1,deprecated:!1,rpc:{method:`ipmi.sel.info`,params:[],job:!0,defaults:{}}},{path:[`iscsi`,`auth`,`create`],summary:`Create an iSCSI Authorized Access`,description:`Create an iSCSI Authorized Access.`,method:`POST`,route:`/iscsi.auth.create`,params:[],body:{required:!0,description:``,fields:[{wireName:`data`,flag:`data`,required:!0,description:`iSCSI authentication credential configuration data for creation.`,type:{kind:`json`}}]},hidden:!1,deprecated:!1,rpc:{method:`iscsi.auth.create`,params:[`data`],job:!1,defaults:{}}},{path:[`iscsi`,`auth`,`delete`],summary:"Delete iSCSI Authorized Access of ``id``",description:"Delete iSCSI Authorized Access of ``id``.",method:`POST`,route:`/iscsi.auth.delete`,params:[],body:{required:!0,description:``,fields:[{wireName:`id`,flag:`id`,required:!0,description:`ID of the iSCSI authentication credential to delete.`,type:{kind:`integer`}}]},confirmation:``,hidden:!1,deprecated:!1,rpc:{method:`iscsi.auth.delete`,params:[`id`],job:!1,defaults:{}}},{path:[`iscsi`,`auth`,`get-instance`],summary:"Returns instance matching `id`",description:"Returns instance matching `id`. If `id` is not found, Validation error is raised.",method:`POST`,route:`/iscsi.auth.get_instance`,params:[],body:{required:!0,description:``,fields:[{wireName:`id`,flag:`id`,required:!0,description:``,type:{kind:`integer`}},{wireName:`options`,flag:`options`,required:!0,description:`Query options customize the results returned by a query method. More complete documentation with examples are covered in the "Query methods" section of the TrueNAS API documentation.`,type:{kind:`json`}}]},hidden:!1,deprecated:!1,rpc:{method:`iscsi.auth.get_instance`,params:[`id`,`options`],job:!1,defaults:{}}},{path:[`iscsi`,`auth`,`query`],summary:``,description:``,method:`POST`,route:`/iscsi.auth.query`,params:[],body:{required:!1,description:``,fields:[{wireName:`filters`,flag:`filters`,required:!1,description:`List of filters for query results. See API documentation for "Query Methods" for more guidance.`,type:{kind:`array`,elem:{kind:`json`}}},{wireName:`options`,flag:`options`,required:!1,description:`Query options including pagination, ordering, and additional parameters.`,type:{kind:`json`}}]},hidden:!1,deprecated:!1,rpc:{method:`iscsi.auth.query`,params:[`filters`,`options`],job:!1,defaults:{filters:[],options:{extra:{},order_by:[],select:[],count:!1,get:!1,offset:0,limit:0,force_sql_filters:!1}}}},{path:[`iscsi`,`auth`,`update`],summary:"Update iSCSI Authorized Access of ``id``",description:"Update iSCSI Authorized Access of ``id``.",method:`POST`,route:`/iscsi.auth.update`,params:[],body:{required:!0,description:``,fields:[{wireName:`id`,flag:`id`,required:!0,description:`ID of the iSCSI authentication credential to update.`,type:{kind:`integer`}},{wireName:`data`,flag:`data`,required:!0,description:`Updated iSCSI authentication credential configuration data.`,type:{kind:`json`}}]},hidden:!1,deprecated:!1,rpc:{method:`iscsi.auth.update`,params:[`id`,`data`],job:!1,defaults:{}}},{path:[`iscsi`,`extent`,`create`],summary:`Create an iSCSI Extent`,description:`Create an iSCSI Extent.`,method:`POST`,route:`/iscsi.extent.create`,params:[],body:{required:!0,description:``,fields:[{wireName:`iscsi_extent_create`,flag:`iscsi-extent-create`,required:!0,description:`iSCSI extent configuration data for creation.`,type:{kind:`json`}}]},hidden:!1,deprecated:!1,rpc:{method:`iscsi.extent.create`,params:[`iscsi_extent_create`],job:!1,defaults:{}}},{path:[`iscsi`,`extent`,`delete`],summary:"Delete iSCSI Extent of ``id``",description:"Delete iSCSI Extent of ``id``.",method:`POST`,route:`/iscsi.extent.delete`,params:[],body:{required:!0,description:``,fields:[{wireName:`id`,flag:`id`,required:!0,description:`ID of the iSCSI extent to delete.`,type:{kind:`integer`}},{wireName:`remove`,flag:`remove`,required:!1,description:`Whether to remove the underlying file for file-based extents.`,type:{kind:`boolean`}},{wireName:`force`,flag:`force`,required:!1,description:`Whether to force deletion even if the extent is in use.`,type:{kind:`boolean`}}]},confirmation:``,hidden:!1,deprecated:!1,rpc:{method:`iscsi.extent.delete`,params:[`id`,`remove`,`force`],job:!1,defaults:{remove:!1,force:!1}}},{path:[`iscsi`,`extent`,`disk-choices`],summary:`Return a dict of available zvols that can be used when creating an extent`,description:`Return a dict of available zvols that can be used when creating an extent.`,method:`POST`,route:`/iscsi.extent.disk_choices`,params:[],hidden:!1,deprecated:!1,rpc:{method:`iscsi.extent.disk_choices`,params:[],job:!1,defaults:{}}},{path:[`iscsi`,`extent`,`get-instance`],summary:"Returns instance matching `id`",description:"Returns instance matching `id`. If `id` is not found, Validation error is raised.",method:`POST`,route:`/iscsi.extent.get_instance`,params:[],body:{required:!0,description:``,fields:[{wireName:`id`,flag:`id`,required:!0,description:``,type:{kind:`integer`}},{wireName:`options`,flag:`options`,required:!0,description:`Query options customize the results returned by a query method. More complete documentation with examples are covered in the "Query methods" section of the TrueNAS API documentation.`,type:{kind:`json`}}]},hidden:!1,deprecated:!1,rpc:{method:`iscsi.extent.get_instance`,params:[`id`,`options`],job:!1,defaults:{}}},{path:[`iscsi`,`extent`,`query`],summary:``,description:``,method:`POST`,route:`/iscsi.extent.query`,params:[],body:{required:!1,description:``,fields:[{wireName:`filters`,flag:`filters`,required:!1,description:`List of filters for query results. See API documentation for "Query Methods" for more guidance.`,type:{kind:`array`,elem:{kind:`json`}}},{wireName:`options`,flag:`options`,required:!1,description:`Query options including pagination, ordering, and additional parameters.`,type:{kind:`json`}}]},hidden:!1,deprecated:!1,rpc:{method:`iscsi.extent.query`,params:[`filters`,`options`],job:!1,defaults:{filters:[],options:{extra:{},order_by:[],select:[],count:!1,get:!1,offset:0,limit:0,force_sql_filters:!1}}}},{path:[`iscsi`,`extent`,`update`],summary:"Update iSCSI Extent of ``id``",description:"Update iSCSI Extent of ``id``.",method:`POST`,route:`/iscsi.extent.update`,params:[],body:{required:!0,description:``,fields:[{wireName:`id`,flag:`id`,required:!0,description:`ID of the iSCSI extent to update.`,type:{kind:`integer`}},{wireName:`iscsi_extent_update`,flag:`iscsi-extent-update`,required:!0,description:`Updated iSCSI extent configuration data.`,type:{kind:`json`}}]},hidden:!1,deprecated:!1,rpc:{method:`iscsi.extent.update`,params:[`id`,`iscsi_extent_update`],job:!1,defaults:{}}},{path:[`iscsi`,`global`,`alua-enabled`],summary:`Returns whether iSCSI ALUA is enabled or not`,description:`Returns whether iSCSI ALUA is enabled or not.`,method:`POST`,route:`/iscsi.global.alua_enabled`,params:[],hidden:!1,deprecated:!1,rpc:{method:`iscsi.global.alua_enabled`,params:[],job:!1,defaults:{}}},{path:[`iscsi`,`global`,`client-count`],summary:`Return currently connected clients count`,description:`Return currently connected clients count.`,method:`POST`,route:`/iscsi.global.client_count`,params:[],hidden:!1,deprecated:!1,rpc:{method:`iscsi.global.client_count`,params:[],job:!1,defaults:{}}},{path:[`iscsi`,`global`,`config`],summary:``,description:``,method:`POST`,route:`/iscsi.global.config`,params:[],hidden:!1,deprecated:!1,rpc:{method:`iscsi.global.config`,params:[],job:!1,defaults:{}}},{path:[`iscsi`,`global`,`iser-enabled`],summary:`Returns whether iSER is enabled or not`,description:`Returns whether iSER is enabled or not.`,method:`POST`,route:`/iscsi.global.iser_enabled`,params:[],hidden:!1,deprecated:!1,rpc:{method:`iscsi.global.iser_enabled`,params:[],job:!1,defaults:{}}},{path:[`iscsi`,`global`,`sessions`],summary:`Get a list of currently running iSCSI sessions`,description:`Get a list of currently running iSCSI sessions. This includes initiator and target names and the unique connection IDs.`,method:`POST`,route:`/iscsi.global.sessions`,params:[],body:{required:!1,description:``,fields:[{wireName:`filters`,flag:`filters`,required:!1,description:`List of filters for query results. See API documentation for "Query Methods" for more guidance.`,type:{kind:`array`,elem:{kind:`json`}}},{wireName:`options`,flag:`options`,required:!1,description:`Query options including pagination, ordering, and additional parameters.`,type:{kind:`json`}}]},hidden:!1,deprecated:!1,rpc:{method:`iscsi.global.sessions`,params:[`filters`,`options`],job:!1,defaults:{filters:[],options:{extra:{},order_by:[],select:[],count:!1,get:!1,offset:0,limit:0,force_sql_filters:!1}}}},{path:[`iscsi`,`global`,`update`],summary:`Update the iSCSI global configuration`,description:`Update the iSCSI global configuration.`,method:`POST`,route:`/iscsi.global.update`,params:[],body:{required:!0,description:``,fields:[{wireName:`iscsi_update`,flag:`iscsi-update`,required:!0,description:`ISCSIGlobalUpdateArgs parameters.`,type:{kind:`json`}}]},hidden:!1,deprecated:!1,rpc:{method:`iscsi.global.update`,params:[`iscsi_update`],job:!1,defaults:{}}},{path:[`iscsi`,`initiator`,`create`],summary:`Create an iSCSI Initiator`,description:`Create an iSCSI Initiator.`,method:`POST`,route:`/iscsi.initiator.create`,params:[],body:{required:!0,description:``,fields:[{wireName:`iscsi_initiator_create`,flag:`iscsi-initiator-create`,required:!0,description:`Authorized initiator group configuration data for creation.`,type:{kind:`json`}}]},hidden:!1,deprecated:!1,rpc:{method:`iscsi.initiator.create`,params:[`iscsi_initiator_create`],job:!1,defaults:{}}},{path:[`iscsi`,`initiator`,`delete`],summary:"Delete iSCSI initiator of ``id``",description:"Delete iSCSI initiator of ``id``.",method:`POST`,route:`/iscsi.initiator.delete`,params:[],body:{required:!0,description:``,fields:[{wireName:`id`,flag:`id`,required:!0,description:`ID of the authorized initiator group to delete.`,type:{kind:`integer`}}]},confirmation:``,hidden:!1,deprecated:!1,rpc:{method:`iscsi.initiator.delete`,params:[`id`],job:!1,defaults:{}}},{path:[`iscsi`,`initiator`,`get-instance`],summary:"Returns instance matching `id`",description:"Returns instance matching `id`. If `id` is not found, Validation error is raised.",method:`POST`,route:`/iscsi.initiator.get_instance`,params:[],body:{required:!0,description:``,fields:[{wireName:`id`,flag:`id`,required:!0,description:``,type:{kind:`integer`}},{wireName:`options`,flag:`options`,required:!0,description:`Query options customize the results returned by a query method. More complete documentation with examples are covered in the "Query methods" section of the TrueNAS API documentation.`,type:{kind:`json`}}]},hidden:!1,deprecated:!1,rpc:{method:`iscsi.initiator.get_instance`,params:[`id`,`options`],job:!1,defaults:{}}},{path:[`iscsi`,`initiator`,`query`],summary:``,description:``,method:`POST`,route:`/iscsi.initiator.query`,params:[],body:{required:!1,description:``,fields:[{wireName:`filters`,flag:`filters`,required:!1,description:`List of filters for query results. See API documentation for "Query Methods" for more guidance.`,type:{kind:`array`,elem:{kind:`json`}}},{wireName:`options`,flag:`options`,required:!1,description:`Query options including pagination, ordering, and additional parameters.`,type:{kind:`json`}}]},hidden:!1,deprecated:!1,rpc:{method:`iscsi.initiator.query`,params:[`filters`,`options`],job:!1,defaults:{filters:[],options:{extra:{},order_by:[],select:[],count:!1,get:!1,offset:0,limit:0,force_sql_filters:!1}}}},{path:[`iscsi`,`initiator`,`update`],summary:"Update iSCSI initiator of ``id``",description:"Update iSCSI initiator of ``id``.",method:`POST`,route:`/iscsi.initiator.update`,params:[],body:{required:!0,description:``,fields:[{wireName:`id`,flag:`id`,required:!0,description:`ID of the authorized initiator group to update.`,type:{kind:`integer`}},{wireName:`iscsi_initiator_update`,flag:`iscsi-initiator-update`,required:!0,description:`Updated authorized initiator group configuration data.`,type:{kind:`json`}}]},hidden:!1,deprecated:!1,rpc:{method:`iscsi.initiator.update`,params:[`id`,`iscsi_initiator_update`],job:!1,defaults:{}}},{path:[`iscsi`,`portal`,`create`],summary:`Create a new iSCSI Portal`,description:`Create a new iSCSI Portal.`,method:`POST`,route:`/iscsi.portal.create`,params:[],body:{required:!0,description:``,fields:[{wireName:`iscsi_portal_create`,flag:`iscsi-portal-create`,required:!0,description:`iSCSI portal configuration data for creation.`,type:{kind:`json`}}]},hidden:!1,deprecated:!1,rpc:{method:`iscsi.portal.create`,params:[`iscsi_portal_create`],job:!1,defaults:{}}},{path:[`iscsi`,`portal`,`delete`],summary:"Delete iSCSI Portal ``id``",description:"Delete iSCSI Portal ``id``.",method:`POST`,route:`/iscsi.portal.delete`,params:[],body:{required:!0,description:``,fields:[{wireName:`id`,flag:`id`,required:!0,description:`ID of the iSCSI portal to delete.`,type:{kind:`integer`}}]},confirmation:``,hidden:!1,deprecated:!1,rpc:{method:`iscsi.portal.delete`,params:[`id`],job:!1,defaults:{}}},{path:[`iscsi`,`portal`,`get-instance`],summary:"Returns instance matching `id`",description:"Returns instance matching `id`. If `id` is not found, Validation error is raised.",method:`POST`,route:`/iscsi.portal.get_instance`,params:[],body:{required:!0,description:``,fields:[{wireName:`id`,flag:`id`,required:!0,description:``,type:{kind:`integer`}},{wireName:`options`,flag:`options`,required:!0,description:`Query options customize the results returned by a query method. More complete documentation with examples are covered in the "Query methods" section of the TrueNAS API documentation.`,type:{kind:`json`}}]},hidden:!1,deprecated:!1,rpc:{method:`iscsi.portal.get_instance`,params:[`id`,`options`],job:!1,defaults:{}}},{path:[`iscsi`,`portal`,`listen-ip-choices`],summary:"Returns possible choices for ``listen.ip`` attribute of portal create and update",description:"Returns possible choices for ``listen.ip`` attribute of portal create and update.",method:`POST`,route:`/iscsi.portal.listen_ip_choices`,params:[],hidden:!1,deprecated:!1,rpc:{method:`iscsi.portal.listen_ip_choices`,params:[],job:!1,defaults:{}}},{path:[`iscsi`,`portal`,`query`],summary:``,description:``,method:`POST`,route:`/iscsi.portal.query`,params:[],body:{required:!1,description:``,fields:[{wireName:`filters`,flag:`filters`,required:!1,description:`List of filters for query results. See API documentation for "Query Methods" for more guidance.`,type:{kind:`array`,elem:{kind:`json`}}},{wireName:`options`,flag:`options`,required:!1,description:`Query options including pagination, ordering, and additional parameters.`,type:{kind:`json`}}]},hidden:!1,deprecated:!1,rpc:{method:`iscsi.portal.query`,params:[`filters`,`options`],job:!1,defaults:{filters:[],options:{extra:{},order_by:[],select:[],count:!1,get:!1,offset:0,limit:0,force_sql_filters:!1}}}},{path:[`iscsi`,`portal`,`update`],summary:"Update iSCSI Portal ``id``",description:"Update iSCSI Portal ``id``.",method:`POST`,route:`/iscsi.portal.update`,params:[],body:{required:!0,description:``,fields:[{wireName:`id`,flag:`id`,required:!0,description:`ID of the iSCSI portal to update.`,type:{kind:`integer`}},{wireName:`iscsi_portal_update`,flag:`iscsi-portal-update`,required:!0,description:`Updated iSCSI portal configuration data.`,type:{kind:`json`}}]},hidden:!1,deprecated:!1,rpc:{method:`iscsi.portal.update`,params:[`id`,`iscsi_portal_update`],job:!1,defaults:{}}},{path:[`iscsi`,`target`,`create`],summary:`Create an iSCSI Target`,description:`Create an iSCSI Target.`,method:`POST`,route:`/iscsi.target.create`,params:[],body:{required:!0,description:``,fields:[{wireName:`iscsi_target_create`,flag:`iscsi-target-create`,required:!0,description:`iSCSI target configuration data for creation.`,type:{kind:`json`}}]},hidden:!1,deprecated:!1,rpc:{method:`iscsi.target.create`,params:[`iscsi_target_create`],job:!1,defaults:{}}},{path:[`iscsi`,`target`,`delete`],summary:"Delete iSCSI Target of ``id``",description:"Delete iSCSI Target of ``id``.",method:`POST`,route:`/iscsi.target.delete`,params:[],body:{required:!0,description:``,fields:[{wireName:`id`,flag:`id`,required:!0,description:`ID of the iSCSI target to delete.`,type:{kind:`integer`}},{wireName:`force`,flag:`force`,required:!1,description:`Whether to force deletion even if the target is in use.`,type:{kind:`boolean`}},{wireName:`delete_extents`,flag:`delete-extents`,required:!1,description:`Whether to also delete associated extents.`,type:{kind:`boolean`}}]},confirmation:``,hidden:!1,deprecated:!1,rpc:{method:`iscsi.target.delete`,params:[`id`,`force`,`delete_extents`],job:!1,defaults:{force:!1,delete_extents:!1}}},{path:[`iscsi`,`target`,`get-instance`],summary:"Returns instance matching `id`",description:"Returns instance matching `id`. If `id` is not found, Validation error is raised.",method:`POST`,route:`/iscsi.target.get_instance`,params:[],body:{required:!0,description:``,fields:[{wireName:`id`,flag:`id`,required:!0,description:``,type:{kind:`integer`}},{wireName:`options`,flag:`options`,required:!0,description:`Query options customize the results returned by a query method. More complete documentation with examples are covered in the "Query methods" section of the TrueNAS API documentation.`,type:{kind:`json`}}]},hidden:!1,deprecated:!1,rpc:{method:`iscsi.target.get_instance`,params:[`id`,`options`],job:!1,defaults:{}}},{path:[`iscsi`,`target`,`query`],summary:``,description:``,method:`POST`,route:`/iscsi.target.query`,params:[],body:{required:!1,description:``,fields:[{wireName:`filters`,flag:`filters`,required:!1,description:`List of filters for query results. See API documentation for "Query Methods" for more guidance.`,type:{kind:`array`,elem:{kind:`json`}}},{wireName:`options`,flag:`options`,required:!1,description:`Query options including pagination, ordering, and additional parameters.`,type:{kind:`json`}}]},hidden:!1,deprecated:!1,rpc:{method:`iscsi.target.query`,params:[`filters`,`options`],job:!1,defaults:{filters:[],options:{extra:{},order_by:[],select:[],count:!1,get:!1,offset:0,limit:0,force_sql_filters:!1}}}},{path:[`iscsi`,`target`,`update`],summary:"Update iSCSI Target of ``id``",description:"Update iSCSI Target of ``id``.",method:`POST`,route:`/iscsi.target.update`,params:[],body:{required:!0,description:``,fields:[{wireName:`id`,flag:`id`,required:!0,description:`ID of the iSCSI target to update.`,type:{kind:`integer`}},{wireName:`iscsi_target_update`,flag:`iscsi-target-update`,required:!0,description:`Updated iSCSI target configuration data.`,type:{kind:`json`}}]},hidden:!1,deprecated:!1,rpc:{method:`iscsi.target.update`,params:[`id`,`iscsi_target_update`],job:!1,defaults:{}}},{path:[`iscsi`,`target`,`validate-name`],summary:"Return a validation error message for the given iSCSI target name or ``null`` if the name is valid",description:"Return a validation error message for the given iSCSI target name or ``null`` if the name is valid.",method:`POST`,route:`/iscsi.target.validate_name`,params:[],body:{required:!0,description:``,fields:[{wireName:`name`,flag:`name`,required:!0,description:`Target name to validate.`,type:{kind:`string`}},{wireName:`existing_id`,flag:`existing-id`,required:!1,description:"ID of existing target to exclude from validation or `null` for new targets.",type:{kind:`integer`}}]},hidden:!1,deprecated:!1,rpc:{method:`iscsi.target.validate_name`,params:[`name`,`existing_id`],job:!1,defaults:{existing_id:null}}},{path:[`iscsi`,`targetextent`,`create`],summary:`Create an Associated Target`,description:`Create an Associated Target.`,method:`POST`,route:`/iscsi.targetextent.create`,params:[],body:{required:!0,description:``,fields:[{wireName:`iscsi_target_to_extent_create`,flag:`iscsi-target-to-extent-create`,required:!0,description:`Target-to-extent association configuration data for creation.`,type:{kind:`json`}}]},hidden:!1,deprecated:!1,rpc:{method:`iscsi.targetextent.create`,params:[`iscsi_target_to_extent_create`],job:!1,defaults:{}}},{path:[`iscsi`,`targetextent`,`delete`],summary:"Delete Associated Target of ``id``",description:"Delete Associated Target of ``id``.",method:`POST`,route:`/iscsi.targetextent.delete`,params:[],body:{required:!0,description:``,fields:[{wireName:`id`,flag:`id`,required:!0,description:`ID of the target-to-extent association to delete.`,type:{kind:`integer`}},{wireName:`force`,flag:`force`,required:!1,description:`Whether to force deletion even if the association is in use.`,type:{kind:`boolean`}}]},confirmation:``,hidden:!1,deprecated:!1,rpc:{method:`iscsi.targetextent.delete`,params:[`id`,`force`],job:!1,defaults:{force:!1}}},{path:[`iscsi`,`targetextent`,`get-instance`],summary:"Returns instance matching `id`",description:"Returns instance matching `id`. If `id` is not found, Validation error is raised.",method:`POST`,route:`/iscsi.targetextent.get_instance`,params:[],body:{required:!0,description:``,fields:[{wireName:`id`,flag:`id`,required:!0,description:``,type:{kind:`integer`}},{wireName:`options`,flag:`options`,required:!0,description:`Query options customize the results returned by a query method. More complete documentation with examples are covered in the "Query methods" section of the TrueNAS API documentation.`,type:{kind:`json`}}]},hidden:!1,deprecated:!1,rpc:{method:`iscsi.targetextent.get_instance`,params:[`id`,`options`],job:!1,defaults:{}}},{path:[`iscsi`,`targetextent`,`query`],summary:``,description:``,method:`POST`,route:`/iscsi.targetextent.query`,params:[],body:{required:!1,description:``,fields:[{wireName:`filters`,flag:`filters`,required:!1,description:`List of filters for query results. See API documentation for "Query Methods" for more guidance.`,type:{kind:`array`,elem:{kind:`json`}}},{wireName:`options`,flag:`options`,required:!1,description:`Query options including pagination, ordering, and additional parameters.`,type:{kind:`json`}}]},hidden:!1,deprecated:!1,rpc:{method:`iscsi.targetextent.query`,params:[`filters`,`options`],job:!1,defaults:{filters:[],options:{extra:{},order_by:[],select:[],count:!1,get:!1,offset:0,limit:0,force_sql_filters:!1}}}},{path:[`iscsi`,`targetextent`,`update`],summary:"Update Associated Target of ``id``",description:"Update Associated Target of ``id``.",method:`POST`,route:`/iscsi.targetextent.update`,params:[],body:{required:!0,description:``,fields:[{wireName:`id`,flag:`id`,required:!0,description:`ID of the target-to-extent association to update.`,type:{kind:`integer`}},{wireName:`iscsi_target_to_extent_update`,flag:`iscsi-target-to-extent-update`,required:!0,description:`Updated target-to-extent association configuration data.`,type:{kind:`json`}}]},hidden:!1,deprecated:!1,rpc:{method:`iscsi.targetextent.update`,params:[`id`,`iscsi_target_to_extent_update`],job:!1,defaults:{}}},{path:[`jbof`,`create`],summary:`Create a new JBOF`,description:`Create a new JBOF.`,method:`POST`,route:`/jbof.create`,params:[],body:{required:!0,description:``,fields:[{wireName:`data`,flag:`data`,required:!0,description:`JBOF configuration data for creation.`,type:{kind:`json`}}]},hidden:!1,deprecated:!1,rpc:{method:`jbof.create`,params:[`data`],job:!1,defaults:{}}},{path:[`jbof`,`delete`],summary:`Delete a JBOF by ID`,description:`Delete a JBOF by ID.`,method:`POST`,route:`/jbof.delete`,params:[],body:{required:!0,description:``,fields:[{wireName:`id`,flag:`id`,required:!0,description:`ID of the JBOF to delete.`,type:{kind:`integer`}},{wireName:`force`,flag:`force`,required:!1,description:`Whether to force deletion even if the JBOF is in use.`,type:{kind:`boolean`}}]},confirmation:``,hidden:!1,deprecated:!1,rpc:{method:`jbof.delete`,params:[`id`,`force`],job:!1,defaults:{force:!1}}},{path:[`jbof`,`get-instance`],summary:"Returns instance matching `id`",description:"Returns instance matching `id`. If `id` is not found, Validation error is raised.",method:`POST`,route:`/jbof.get_instance`,params:[],body:{required:!0,description:``,fields:[{wireName:`id`,flag:`id`,required:!0,description:``,type:{kind:`integer`}},{wireName:`options`,flag:`options`,required:!0,description:`Query options customize the results returned by a query method. More complete documentation with examples are covered in the "Query methods" section of the TrueNAS API documentation.`,type:{kind:`json`}}]},hidden:!1,deprecated:!1,rpc:{method:`jbof.get_instance`,params:[`id`,`options`],job:!1,defaults:{}}},{path:[`jbof`,`licensed`],summary:`Return a count of the number of JBOF units licensed`,description:`Return a count of the number of JBOF units licensed.`,method:`POST`,route:`/jbof.licensed`,params:[],hidden:!1,deprecated:!1,rpc:{method:`jbof.licensed`,params:[],job:!1,defaults:{}}},{path:[`jbof`,`query`],summary:``,description:``,method:`POST`,route:`/jbof.query`,params:[],body:{required:!1,description:``,fields:[{wireName:`filters`,flag:`filters`,required:!1,description:`List of filters for query results. See API documentation for "Query Methods" for more guidance.`,type:{kind:`array`,elem:{kind:`json`}}},{wireName:`options`,flag:`options`,required:!1,description:`Query options including pagination, ordering, and additional parameters.`,type:{kind:`json`}}]},hidden:!1,deprecated:!1,rpc:{method:`jbof.query`,params:[`filters`,`options`],job:!1,defaults:{filters:[],options:{extra:{},order_by:[],select:[],count:!1,get:!1,offset:0,limit:0,force_sql_filters:!1}}}},{path:[`jbof`,`reapply-config`],summary:`Reapply the JBOF configuration to attached JBOFs`,description:`Reapply the JBOF configuration to attached JBOFs.`,method:`POST`,route:`/jbof.reapply_config`,params:[],hidden:!1,deprecated:!1,rpc:{method:`jbof.reapply_config`,params:[],job:!1,defaults:{}}},{path:[`jbof`,`update`],summary:"Update JBOF of ``id``",description:"Update JBOF of ``id``.",method:`POST`,route:`/jbof.update`,params:[],body:{required:!0,description:``,fields:[{wireName:`id`,flag:`id`,required:!0,description:`ID of the JBOF to update.`,type:{kind:`integer`}},{wireName:`data`,flag:`data`,required:!0,description:`Updated JBOF configuration data.`,type:{kind:`json`}}]},hidden:!1,deprecated:!1,rpc:{method:`jbof.update`,params:[`id`,`data`],job:!1,defaults:{}}},{path:[`kerberos`,`config`],summary:``,description:``,method:`POST`,route:`/kerberos.config`,params:[],hidden:!1,deprecated:!1,rpc:{method:`kerberos.config`,params:[],job:!1,defaults:{}}},{path:[`kerberos`,`update`],summary:'``appdefaults_aux`` add parameters to "appdefaults" section of the krb5.conf file',description:'``appdefaults_aux`` add parameters to "appdefaults" section of the krb5.conf file.',method:`POST`,route:`/kerberos.update`,params:[],body:{required:!0,description:``,fields:[{wireName:`kerberos_update`,flag:`kerberos-update`,required:!0,description:`KerberosUpdateArgs parameters.`,type:{kind:`json`}}]},hidden:!1,deprecated:!1,rpc:{method:`kerberos.update`,params:[`kerberos_update`],job:!1,defaults:{}}},{path:[`kerberos`,`keytab`,`create`],summary:`Create a Kerberos keytab`,description:"Create a Kerberos keytab. Uploaded keytab files are merged with the system keytab under ``/etc/krb5.keytab``.",method:`POST`,route:`/kerberos.keytab.create`,params:[],body:{required:!0,description:``,fields:[{wireName:`data`,flag:`data`,required:!0,description:`Kerberos keytab configuration data for creation.`,type:{kind:`json`}}]},hidden:!1,deprecated:!1,rpc:{method:`kerberos.keytab.create`,params:[`data`],job:!1,defaults:{}}},{path:[`kerberos`,`keytab`,`delete`],summary:`Delete kerberos keytab by id, and force regeneration of system keytab`,description:`Delete kerberos keytab by id, and force regeneration of system keytab.`,method:`POST`,route:`/kerberos.keytab.delete`,params:[],body:{required:!0,description:``,fields:[{wireName:`id`,flag:`id`,required:!0,description:`ID of the Kerberos keytab entry to delete.`,type:{kind:`integer`}}]},confirmation:``,hidden:!1,deprecated:!1,rpc:{method:`kerberos.keytab.delete`,params:[`id`],job:!1,defaults:{}}},{path:[`kerberos`,`keytab`,`get-instance`],summary:"Returns instance matching `id`",description:"Returns instance matching `id`. If `id` is not found, Validation error is raised.",method:`POST`,route:`/kerberos.keytab.get_instance`,params:[],body:{required:!0,description:``,fields:[{wireName:`id`,flag:`id`,required:!0,description:``,type:{kind:`integer`}},{wireName:`options`,flag:`options`,required:!0,description:`Query options customize the results returned by a query method. More complete documentation with examples are covered in the "Query methods" section of the TrueNAS API documentation.`,type:{kind:`json`}}]},hidden:!1,deprecated:!1,rpc:{method:`kerberos.keytab.get_instance`,params:[`id`,`options`],job:!1,defaults:{}}},{path:[`kerberos`,`keytab`,`query`],summary:``,description:``,method:`POST`,route:`/kerberos.keytab.query`,params:[],body:{required:!1,description:``,fields:[{wireName:`filters`,flag:`filters`,required:!1,description:`List of filters for query results. See API documentation for "Query Methods" for more guidance.`,type:{kind:`array`,elem:{kind:`json`}}},{wireName:`options`,flag:`options`,required:!1,description:`Query options including pagination, ordering, and additional parameters.`,type:{kind:`json`}}]},hidden:!1,deprecated:!1,rpc:{method:`kerberos.keytab.query`,params:[`filters`,`options`],job:!1,defaults:{filters:[],options:{extra:{},order_by:[],select:[],count:!1,get:!1,offset:0,limit:0,force_sql_filters:!1}}}},{path:[`kerberos`,`keytab`,`update`],summary:`Update kerberos keytab by id`,description:`Update kerberos keytab by id.`,method:`POST`,route:`/kerberos.keytab.update`,params:[],body:{required:!0,description:``,fields:[{wireName:`id`,flag:`id`,required:!0,description:`ID of the Kerberos keytab entry to update.`,type:{kind:`integer`}},{wireName:`data`,flag:`data`,required:!0,description:`Updated Kerberos keytab configuration data.`,type:{kind:`json`}}]},hidden:!1,deprecated:!1,rpc:{method:`kerberos.keytab.update`,params:[`id`,`data`],job:!1,defaults:{}}},{path:[`kerberos`,`realm`,`create`],summary:`Create a new kerberos realm`,description:`Create a new kerberos realm. This will be automatically populated during the domain join process in an Active Directory environment. Kerberos realm names are case-sensitive, but convention is to only use upper-case.`,method:`POST`,route:`/kerberos.realm.create`,params:[],body:{required:!0,description:``,fields:[{wireName:`data`,flag:`data`,required:!0,description:`Kerberos realm configuration data for creation.`,type:{kind:`json`}}]},hidden:!1,deprecated:!1,rpc:{method:`kerberos.realm.create`,params:[`data`],job:!1,defaults:{}}},{path:[`kerberos`,`realm`,`delete`],summary:`Delete a kerberos realm by ID`,description:`Delete a kerberos realm by ID.`,method:`POST`,route:`/kerberos.realm.delete`,params:[],body:{required:!0,description:``,fields:[{wireName:`id`,flag:`id`,required:!0,description:`ID of the Kerberos realm to delete.`,type:{kind:`integer`}}]},confirmation:``,hidden:!1,deprecated:!1,rpc:{method:`kerberos.realm.delete`,params:[`id`],job:!1,defaults:{}}},{path:[`kerberos`,`realm`,`get-instance`],summary:"Returns instance matching `id`",description:"Returns instance matching `id`. If `id` is not found, Validation error is raised.",method:`POST`,route:`/kerberos.realm.get_instance`,params:[],body:{required:!0,description:``,fields:[{wireName:`id`,flag:`id`,required:!0,description:``,type:{kind:`integer`}},{wireName:`options`,flag:`options`,required:!0,description:`Query options customize the results returned by a query method. More complete documentation with examples are covered in the "Query methods" section of the TrueNAS API documentation.`,type:{kind:`json`}}]},hidden:!1,deprecated:!1,rpc:{method:`kerberos.realm.get_instance`,params:[`id`,`options`],job:!1,defaults:{}}},{path:[`kerberos`,`realm`,`query`],summary:``,description:``,method:`POST`,route:`/kerberos.realm.query`,params:[],body:{required:!1,description:``,fields:[{wireName:`filters`,flag:`filters`,required:!1,description:`List of filters for query results. See API documentation for "Query Methods" for more guidance.`,type:{kind:`array`,elem:{kind:`json`}}},{wireName:`options`,flag:`options`,required:!1,description:`Query options including pagination, ordering, and additional parameters.`,type:{kind:`json`}}]},hidden:!1,deprecated:!1,rpc:{method:`kerberos.realm.query`,params:[`filters`,`options`],job:!1,defaults:{filters:[],options:{extra:{},order_by:[],select:[],count:!1,get:!1,offset:0,limit:0,force_sql_filters:!1}}}},{path:[`kerberos`,`realm`,`update`],summary:`Update a kerberos realm by id`,description:`Update a kerberos realm by id. This will be automatically populated during the domain join process in an Active Directory environment. Kerberos realm names are case-sensitive, but convention is to only use upper-case.`,method:`POST`,route:`/kerberos.realm.update`,params:[],body:{required:!0,description:``,fields:[{wireName:`id`,flag:`id`,required:!0,description:`ID of the Kerberos realm to update.`,type:{kind:`integer`}},{wireName:`data`,flag:`data`,required:!0,description:`Updated Kerberos realm configuration data.`,type:{kind:`json`}}]},hidden:!1,deprecated:!1,rpc:{method:`kerberos.realm.update`,params:[`id`,`data`],job:!1,defaults:{}}},{path:[`keychaincredential`,`create`],summary:`Create a Keychain Credential`,description:`Create a Keychain Credential.`,method:`POST`,route:`/keychaincredential.create`,params:[],body:{required:!0,description:``,fields:[{wireName:`keychain_credential_create`,flag:`keychain-credential-create`,required:!0,description:`Credential configuration data for the new keychain entry.`,type:{kind:`json`}}]},hidden:!1,deprecated:!1,rpc:{method:`keychaincredential.create`,params:[`keychain_credential_create`],job:!1,defaults:{}}},{path:[`keychaincredential`,`delete`],summary:"Delete Keychain Credential with specific ``id``",description:"Delete Keychain Credential with specific ``id``.",method:`POST`,route:`/keychaincredential.delete`,params:[],body:{required:!0,description:``,fields:[{wireName:`id`,flag:`id`,required:!0,description:`Unique identifier of the keychain credential to delete.`,type:{kind:`integer`}},{wireName:`options`,flag:`options`,required:!1,description:`Options controlling the deletion behavior.`,type:{kind:`json`}}]},confirmation:``,hidden:!1,deprecated:!1,rpc:{method:`keychaincredential.delete`,params:[`id`,`options`],job:!1,defaults:{options:{cascade:!1}}}},{path:[`keychaincredential`,`generate-ssh-key-pair`],summary:"Generate a public/private key pair (useful for ``SSH_KEY_PAIR`` type)",description:"Generate a public/private key pair (useful for ``SSH_KEY_PAIR`` type).",method:`POST`,route:`/keychaincredential.generate_ssh_key_pair`,params:[],hidden:!1,deprecated:!1,rpc:{method:`keychaincredential.generate_ssh_key_pair`,params:[],job:!1,defaults:{}}},{path:[`keychaincredential`,`get-instance`],summary:"Returns instance matching `id`",description:"Returns instance matching `id`. If `id` is not found, Validation error is raised.",method:`POST`,route:`/keychaincredential.get_instance`,params:[],body:{required:!0,description:``,fields:[{wireName:`id`,flag:`id`,required:!0,description:``,type:{kind:`integer`}},{wireName:`options`,flag:`options`,required:!0,description:`Query options customize the results returned by a query method. More complete documentation with examples are covered in the "Query methods" section of the TrueNAS API documentation.`,type:{kind:`json`}}]},hidden:!1,deprecated:!1,rpc:{method:`keychaincredential.get_instance`,params:[`id`,`options`],job:!1,defaults:{}}},{path:[`keychaincredential`,`query`],summary:``,description:``,method:`POST`,route:`/keychaincredential.query`,params:[],body:{required:!1,description:``,fields:[{wireName:`filters`,flag:`filters`,required:!1,description:`List of filters for query results. See API documentation for "Query Methods" for more guidance.`,type:{kind:`array`,elem:{kind:`json`}}},{wireName:`options`,flag:`options`,required:!1,description:`Query options including pagination, ordering, and additional parameters.`,type:{kind:`json`}}]},hidden:!1,deprecated:!1,rpc:{method:`keychaincredential.query`,params:[`filters`,`options`],job:!1,defaults:{filters:[],options:{extra:{},order_by:[],select:[],count:!1,get:!1,offset:0,limit:0,force_sql_filters:!1}}}},{path:[`keychaincredential`,`remote-ssh-host-key-scan`],summary:"Discover a remote host key (useful for ``SSH_CREDENTIALS``)",description:"Discover a remote host key (useful for ``SSH_CREDENTIALS``).",method:`POST`,route:`/keychaincredential.remote_ssh_host_key_scan`,params:[],body:{required:!0,description:``,fields:[{wireName:`keychain_remote_ssh_host_key_scan`,flag:`keychain-remote-ssh-host-key-scan`,required:!0,description:`KeychainCredentialRemoteSshHostKeyScanArgs parameters.`,type:{kind:`json`}}]},hidden:!1,deprecated:!1,rpc:{method:`keychaincredential.remote_ssh_host_key_scan`,params:[`keychain_remote_ssh_host_key_scan`],job:!1,defaults:{}}},{path:[`keychaincredential`,`remote-ssh-semiautomatic-setup`],summary:`Perform semi-automatic SSH connection setup with other TrueNAS machine`,description:`Perform semi-automatic SSH connection setup with other TrueNAS machine.`,method:`POST`,route:`/keychaincredential.remote_ssh_semiautomatic_setup`,params:[],body:{required:!0,description:``,fields:[{wireName:`data`,flag:`data`,required:!0,description:`Configuration data for semi-automatic SSH credential setup.`,type:{kind:`json`}}]},hidden:!1,deprecated:!1,rpc:{method:`keychaincredential.remote_ssh_semiautomatic_setup`,params:[`data`],job:!1,defaults:{}}},{path:[`keychaincredential`,`setup-ssh-connection`],summary:`Create an SSH connection by performing the following steps:`,description:`Create an SSH connection by performing the following steps:`,method:`POST`,route:`/keychaincredential.setup_ssh_connection`,params:[],body:{required:!0,description:``,fields:[{wireName:`options`,flag:`options`,required:!0,description:`SSH connection setup configuration (manual or semi-automatic).`,type:{kind:`json`}}]},hidden:!1,deprecated:!1,rpc:{method:`keychaincredential.setup_ssh_connection`,params:[`options`],job:!1,defaults:{}}},{path:[`keychaincredential`,`update`],summary:"Update a Keychain Credential with specific ``id``",description:"Update a Keychain Credential with specific ``id``.",method:`POST`,route:`/keychaincredential.update`,params:[],body:{required:!0,description:``,fields:[{wireName:`id`,flag:`id`,required:!0,description:`Unique identifier of the keychain credential to update.`,type:{kind:`integer`}},{wireName:`keychain_credential_update`,flag:`keychain-credential-update`,required:!0,description:`Updated credential configuration data.`,type:{kind:`json`}}]},hidden:!1,deprecated:!1,rpc:{method:`keychaincredential.update`,params:[`id`,`keychain_credential_update`],job:!1,defaults:{}}},{path:[`keychaincredential`,`used-by`],summary:`Returns list of objects that use this credential`,description:`Returns list of objects that use this credential.`,method:`POST`,route:`/keychaincredential.used_by`,params:[],body:{required:!0,description:``,fields:[{wireName:`id`,flag:`id`,required:!0,description:`Unique identifier of the keychain credential to check usage for.`,type:{kind:`integer`}}]},hidden:!1,deprecated:!1,rpc:{method:`keychaincredential.used_by`,params:[`id`],job:!1,defaults:{}}},{path:[`kmip`,`clear-sync-pending-keys`],summary:`Clear all keys which are pending to be synced between KMIP server and TN database`,description:`Clear all keys which are pending to be synced between KMIP server and TN database.`,method:`POST`,route:`/kmip.clear_sync_pending_keys`,params:[],hidden:!1,deprecated:!1,rpc:{method:`kmip.clear_sync_pending_keys`,params:[],job:!1,defaults:{}}},{path:[`kmip`,`config`],summary:``,description:``,method:`POST`,route:`/kmip.config`,params:[],hidden:!1,deprecated:!1,rpc:{method:`kmip.config`,params:[],job:!1,defaults:{}}},{path:[`kmip`,`kmip-sync-pending`],summary:`Returns true or false based on if there are keys which are to be synced from local database to remote KMIP server or vice versa`,description:`Returns true or false based on if there are keys which are to be synced from local database to remote KMIP server or vice versa.`,method:`POST`,route:`/kmip.kmip_sync_pending`,params:[],hidden:!1,deprecated:!1,rpc:{method:`kmip.kmip_sync_pending`,params:[],job:!1,defaults:{}}},{path:[`kmip`,`sync-keys`],summary:`Sync ZFS/SED keys between KMIP Server and TN database`,description:`Sync ZFS/SED keys between KMIP Server and TN database.`,method:`POST`,route:`/kmip.sync_keys`,params:[],hidden:!1,deprecated:!1,rpc:{method:`kmip.sync_keys`,params:[],job:!1,defaults:{}}},{path:[`kmip`,`update`],summary:`Update KMIP Server Configuration`,description:`Update KMIP Server Configuration.`,method:`POST`,route:`/kmip.update`,params:[],body:{required:!0,description:``,fields:[{wireName:`kmip_update`,flag:`kmip-update`,required:!0,description:`KMIPUpdateArgs parameters.`,type:{kind:`json`}}]},hidden:!1,deprecated:!1,rpc:{method:`kmip.update`,params:[`kmip_update`],job:!0,defaults:{}}},{path:[`mail`,`config`],summary:``,description:``,method:`POST`,route:`/mail.config`,params:[],hidden:!1,deprecated:!1,rpc:{method:`mail.config`,params:[],job:!1,defaults:{}}},{path:[`mail`,`local-administrator-email`],summary:`Return the email address of the local administrator`,description:`Return the email address of the local administrator.`,method:`POST`,route:`/mail.local_administrator_email`,params:[],hidden:!1,deprecated:!1,rpc:{method:`mail.local_administrator_email`,params:[],job:!1,defaults:{}}},{path:[`mail`,`update`],summary:`Update Mail Service Configuration`,description:`Update Mail Service Configuration.`,method:`POST`,route:`/mail.update`,params:[],body:{required:!0,description:``,fields:[{wireName:`data`,flag:`data`,required:!0,description:`Mail configuration fields to update.`,type:{kind:`json`}}]},hidden:!1,deprecated:!1,rpc:{method:`mail.update`,params:[`data`],job:!1,defaults:{}}},{path:[`network`,`configuration`,`activity-choices`],summary:`Returns allowed/forbidden network activity choices`,description:`Returns allowed/forbidden network activity choices.`,method:`POST`,route:`/network.configuration.activity_choices`,params:[],hidden:!1,deprecated:!1,rpc:{method:`network.configuration.activity_choices`,params:[],job:!1,defaults:{}}},{path:[`network`,`configuration`,`config`],summary:``,description:``,method:`POST`,route:`/network.configuration.config`,params:[],hidden:!1,deprecated:!1,rpc:{method:`network.configuration.config`,params:[],job:!1,defaults:{}}},{path:[`network`,`configuration`,`update`],summary:`Update Network Configuration Service configuration`,description:`Update Network Configuration Service configuration.`,method:`POST`,route:`/network.configuration.update`,params:[],body:{required:!0,description:``,fields:[{wireName:`data`,flag:`data`,required:!0,description:`Network configuration data to update.`,type:{kind:`json`}}]},hidden:!1,deprecated:!1,rpc:{method:`network.configuration.update`,params:[`data`],job:!1,defaults:{}}},{path:[`network`,`general`,`summary`],summary:`Retrieve general information for current Network`,description:`Retrieve general information for current Network.`,method:`POST`,route:`/network.general.summary`,params:[],hidden:!1,deprecated:!1,rpc:{method:`network.general.summary`,params:[],job:!1,defaults:{}}},{path:[`nfs`,`bindip-choices`],summary:`Returns ip choices for NFS service to use`,description:`Returns ip choices for NFS service to use.`,method:`POST`,route:`/nfs.bindip_choices`,params:[],hidden:!1,deprecated:!1,rpc:{method:`nfs.bindip_choices`,params:[],job:!1,defaults:{}}},{path:[`nfs`,`client-count`],summary:`Return currently connected clients count`,description:`Return currently connected clients count. Count may not be accurate if NFSv3 protocol is in use due to potentially stale rmtab entries.`,method:`POST`,route:`/nfs.client_count`,params:[],hidden:!1,deprecated:!1,rpc:{method:`nfs.client_count`,params:[],job:!1,defaults:{}}},{path:[`nfs`,`config`],summary:``,description:``,method:`POST`,route:`/nfs.config`,params:[],hidden:!1,deprecated:!1,rpc:{method:`nfs.config`,params:[],job:!1,defaults:{}}},{path:[`nfs`,`get-nfs3-clients`],summary:`Read contents of rmtab`,description:`Read contents of rmtab. This information may not be accurate due to stale entries. This is ultimately a limitation of the NFSv3 protocol.`,method:`POST`,route:`/nfs.get_nfs3_clients`,params:[],body:{required:!1,description:``,fields:[{wireName:`filters`,flag:`filters`,required:!1,description:`List of filters for query results. See API documentation for "Query Methods" for more guidance.`,type:{kind:`array`,elem:{kind:`json`}}},{wireName:`options`,flag:`options`,required:!1,description:`Query options including pagination, ordering, and additional parameters.`,type:{kind:`json`}}]},hidden:!1,deprecated:!1,rpc:{method:`nfs.get_nfs3_clients`,params:[`filters`,`options`],job:!1,defaults:{filters:[],options:{extra:{},order_by:[],select:[],count:!1,get:!1,offset:0,limit:0,force_sql_filters:!1}}}},{path:[`nfs`,`get-nfs4-clients`],summary:`Read information about NFSv4 clients from /proc/fs/nfsd/clients`,description:`Read information about NFSv4 clients from /proc/fs/nfsd/clients.`,method:`POST`,route:`/nfs.get_nfs4_clients`,params:[],body:{required:!1,description:``,fields:[{wireName:`filters`,flag:`filters`,required:!1,description:`List of filters for query results. See API documentation for "Query Methods" for more guidance.`,type:{kind:`array`,elem:{kind:`json`}}},{wireName:`options`,flag:`options`,required:!1,description:`Query options including pagination, ordering, and additional parameters.`,type:{kind:`json`}}]},hidden:!1,deprecated:!1,rpc:{method:`nfs.get_nfs4_clients`,params:[`filters`,`options`],job:!1,defaults:{filters:[],options:{extra:{},order_by:[],select:[],count:!1,get:!1,offset:0,limit:0,force_sql_filters:!1}}}},{path:[`nfs`,`update`],summary:`Update the NFS service configuration`,description:`Update the NFS service configuration.`,method:`POST`,route:`/nfs.update`,params:[],body:{required:!0,description:``,fields:[{wireName:`nfs_update`,flag:`nfs-update`,required:!0,description:`NFSUpdateArgs parameters.`,type:{kind:`json`}}]},hidden:!1,deprecated:!1,rpc:{method:`nfs.update`,params:[`nfs_update`],job:!1,defaults:{}}},{path:[`nvmet`,`global`,`config`],summary:``,description:``,method:`POST`,route:`/nvmet.global.config`,params:[],hidden:!1,deprecated:!1,rpc:{method:`nvmet.global.config`,params:[],job:!1,defaults:{}}},{path:[`nvmet`,`global`,`sessions`],summary:`Return the NVMe-oF host sessions currently connected to this TrueNAS`,description:`Return the NVMe-oF host sessions currently connected to this TrueNAS.`,method:`POST`,route:`/nvmet.global.sessions`,params:[],body:{required:!1,description:``,fields:[{wireName:`filters`,flag:`filters`,required:!1,description:`List of filters for query results. See API documentation for "Query Methods" for more guidance.`,type:{kind:`array`,elem:{kind:`json`}}},{wireName:`options`,flag:`options`,required:!1,description:`Query options including pagination, ordering, and additional parameters.`,type:{kind:`json`}}]},hidden:!1,deprecated:!1,rpc:{method:`nvmet.global.sessions`,params:[`filters`,`options`],job:!1,defaults:{filters:[],options:{extra:{},order_by:[],select:[],count:!1,get:!1,offset:0,limit:0,force_sql_filters:!1}}}},{path:[`nvmet`,`global`,`update`],summary:`Update NVMe target global config`,description:`Update NVMe target global config.`,method:`POST`,route:`/nvmet.global.update`,params:[],body:{required:!0,description:``,fields:[{wireName:`nvmet_update`,flag:`nvmet-update`,required:!0,description:`NVMetGlobalUpdateArgs parameters.`,type:{kind:`json`}}]},hidden:!1,deprecated:!1,rpc:{method:`nvmet.global.update`,params:[`nvmet_update`],job:!1,defaults:{}}},{path:[`nvmet`,`host`,`create`],summary:"Create an NVMe target ``host``",description:"Create an NVMe target ``host``.",method:`POST`,route:`/nvmet.host.create`,params:[],body:{required:!0,description:``,fields:[{wireName:`nvmet_host_create`,flag:`nvmet-host-create`,required:!0,description:`NVMe-oF host configuration data for creation.`,type:{kind:`json`}}]},hidden:!1,deprecated:!1,rpc:{method:`nvmet.host.create`,params:[`nvmet_host_create`],job:!1,defaults:{}}},{path:[`nvmet`,`host`,`delete`],summary:"Delete NVMe target ``host`` of ``id``",description:"Delete NVMe target ``host`` of ``id``.",method:`POST`,route:`/nvmet.host.delete`,params:[],body:{required:!0,description:``,fields:[{wireName:`id`,flag:`id`,required:!0,description:`ID of the NVMe-oF host to delete.`,type:{kind:`integer`}},{wireName:`options`,flag:`options`,required:!0,description:`Options controlling host deletion behavior.`,type:{kind:`json`}}]},confirmation:``,hidden:!1,deprecated:!1,rpc:{method:`nvmet.host.delete`,params:[`id`,`options`],job:!1,defaults:{}}},{path:[`nvmet`,`host`,`dhchap-dhgroup-choices`],summary:"Returns possible choices for ``dhchap_dhgroup`` attribute of ``host`` create and update",description:"Returns possible choices for ``dhchap_dhgroup`` attribute of ``host`` create and update. None is an additional choice.",method:`POST`,route:`/nvmet.host.dhchap_dhgroup_choices`,params:[],hidden:!1,deprecated:!1,rpc:{method:`nvmet.host.dhchap_dhgroup_choices`,params:[],job:!1,defaults:{}}},{path:[`nvmet`,`host`,`dhchap-hash-choices`],summary:"Returns possible choices for ``dhchap_hash`` attribute of ``host`` create and update",description:"Returns possible choices for ``dhchap_hash`` attribute of ``host`` create and update.",method:`POST`,route:`/nvmet.host.dhchap_hash_choices`,params:[],hidden:!1,deprecated:!1,rpc:{method:`nvmet.host.dhchap_hash_choices`,params:[],job:!1,defaults:{}}},{path:[`nvmet`,`host`,`generate-key`],summary:"Generate a secret key that may be used when configuring ``host`` authentication",description:"Generate a secret key that may be used when configuring ``host`` authentication.",method:`POST`,route:`/nvmet.host.generate_key`,params:[],body:{required:!1,description:``,fields:[{wireName:`dhchap_hash`,flag:`dhchap-hash`,required:!1,description:`Hash to be used with the generated key.`,type:{kind:`enum`,values:[`SHA-256`,`SHA-384`,`SHA-512`]}},{wireName:`nqn`,flag:`nqn`,required:!1,description:`NQN to be used for the transformation.`,type:{kind:`string`}}]},hidden:!1,deprecated:!1,rpc:{method:`nvmet.host.generate_key`,params:[`dhchap_hash`,`nqn`],job:!1,defaults:{dhchap_hash:`SHA-256`,nqn:null}}},{path:[`nvmet`,`host`,`get-instance`],summary:"Returns instance matching `id`",description:"Returns instance matching `id`. If `id` is not found, Validation error is raised.",method:`POST`,route:`/nvmet.host.get_instance`,params:[],body:{required:!0,description:``,fields:[{wireName:`id`,flag:`id`,required:!0,description:``,type:{kind:`integer`}},{wireName:`options`,flag:`options`,required:!0,description:`Query options customize the results returned by a query method. More complete documentation with examples are covered in the "Query methods" section of the TrueNAS API documentation.`,type:{kind:`json`}}]},hidden:!1,deprecated:!1,rpc:{method:`nvmet.host.get_instance`,params:[`id`,`options`],job:!1,defaults:{}}},{path:[`nvmet`,`host`,`query`],summary:``,description:``,method:`POST`,route:`/nvmet.host.query`,params:[],body:{required:!1,description:``,fields:[{wireName:`filters`,flag:`filters`,required:!1,description:`List of filters for query results. See API documentation for "Query Methods" for more guidance.`,type:{kind:`array`,elem:{kind:`json`}}},{wireName:`options`,flag:`options`,required:!1,description:`Query options including pagination, ordering, and additional parameters.`,type:{kind:`json`}}]},hidden:!1,deprecated:!1,rpc:{method:`nvmet.host.query`,params:[`filters`,`options`],job:!1,defaults:{filters:[],options:{extra:{},order_by:[],select:[],count:!1,get:!1,offset:0,limit:0,force_sql_filters:!1}}}},{path:[`nvmet`,`host`,`update`],summary:"Update NVMe target ``host`` of ``id``",description:"Update NVMe target ``host`` of ``id``.",method:`POST`,route:`/nvmet.host.update`,params:[],body:{required:!0,description:``,fields:[{wireName:`id`,flag:`id`,required:!0,description:`ID of the NVMe-oF host to update.`,type:{kind:`integer`}},{wireName:`nvmet_host_update`,flag:`nvmet-host-update`,required:!0,description:`Updated NVMe-oF host configuration data.`,type:{kind:`json`}}]},hidden:!1,deprecated:!1,rpc:{method:`nvmet.host.update`,params:[`id`,`nvmet_host_update`],job:!1,defaults:{}}},{path:[`nvmet`,`host-subsys`,`create`],summary:"Create an association between a ``host`` and a subsystem (``subsys``)",description:"Create an association between a ``host`` and a subsystem (``subsys``).",method:`POST`,route:`/nvmet.host_subsys.create`,params:[],body:{required:!0,description:``,fields:[{wireName:`nvmet_host_subsys_create`,flag:`nvmet-host-subsys-create`,required:!0,description:`Host-subsystem association configuration data for creation.`,type:{kind:`json`}}]},hidden:!1,deprecated:!1,rpc:{method:`nvmet.host_subsys.create`,params:[`nvmet_host_subsys_create`],job:!1,defaults:{}}},{path:[`nvmet`,`host-subsys`,`delete`],summary:"Delete ``host``/``subsys`` association of ``id``",description:"Delete ``host``/``subsys`` association of ``id``.",method:`POST`,route:`/nvmet.host_subsys.delete`,params:[],body:{required:!0,description:``,fields:[{wireName:`id`,flag:`id`,required:!0,description:`ID of the host-subsystem association to delete.`,type:{kind:`integer`}}]},confirmation:``,hidden:!1,deprecated:!1,rpc:{method:`nvmet.host_subsys.delete`,params:[`id`],job:!1,defaults:{}}},{path:[`nvmet`,`host-subsys`,`get-instance`],summary:"Returns instance matching `id`",description:"Returns instance matching `id`. If `id` is not found, Validation error is raised.",method:`POST`,route:`/nvmet.host_subsys.get_instance`,params:[],body:{required:!0,description:``,fields:[{wireName:`id`,flag:`id`,required:!0,description:``,type:{kind:`integer`}},{wireName:`options`,flag:`options`,required:!0,description:`Query options customize the results returned by a query method. More complete documentation with examples are covered in the "Query methods" section of the TrueNAS API documentation.`,type:{kind:`json`}}]},hidden:!1,deprecated:!1,rpc:{method:`nvmet.host_subsys.get_instance`,params:[`id`,`options`],job:!1,defaults:{}}},{path:[`nvmet`,`host-subsys`,`query`],summary:``,description:``,method:`POST`,route:`/nvmet.host_subsys.query`,params:[],body:{required:!1,description:``,fields:[{wireName:`filters`,flag:`filters`,required:!1,description:`List of filters for query results. See API documentation for "Query Methods" for more guidance.`,type:{kind:`array`,elem:{kind:`json`}}},{wireName:`options`,flag:`options`,required:!1,description:`Query options including pagination, ordering, and additional parameters.`,type:{kind:`json`}}]},hidden:!1,deprecated:!1,rpc:{method:`nvmet.host_subsys.query`,params:[`filters`,`options`],job:!1,defaults:{filters:[],options:{extra:{},order_by:[],select:[],count:!1,get:!1,offset:0,limit:0,force_sql_filters:!1}}}},{path:[`nvmet`,`host-subsys`,`update`],summary:"Update ``host``/``subsys`` association of ``id``",description:"Update ``host``/``subsys`` association of ``id``.",method:`POST`,route:`/nvmet.host_subsys.update`,params:[],body:{required:!0,description:``,fields:[{wireName:`id`,flag:`id`,required:!0,description:`ID of the host-subsystem association to update.`,type:{kind:`integer`}},{wireName:`nvmet_host_subsys_update`,flag:`nvmet-host-subsys-update`,required:!0,description:`Updated host-subsystem association configuration data.`,type:{kind:`json`}}]},hidden:!1,deprecated:!1,rpc:{method:`nvmet.host_subsys.update`,params:[`id`,`nvmet_host_subsys_update`],job:!1,defaults:{}}},{path:[`nvmet`,`namespace`,`create`],summary:"Create a NVMe target namespace in a subsystem (``subsys``)",description:"Create a NVMe target namespace in a subsystem (``subsys``).",method:`POST`,route:`/nvmet.namespace.create`,params:[],body:{required:!0,description:``,fields:[{wireName:`nvmet_namespace_create`,flag:`nvmet-namespace-create`,required:!0,description:`NVMe-oF namespace configuration data for creation.`,type:{kind:`json`}}]},hidden:!1,deprecated:!1,rpc:{method:`nvmet.namespace.create`,params:[`nvmet_namespace_create`],job:!1,defaults:{}}},{path:[`nvmet`,`namespace`,`delete`],summary:"Delete NVMe target namespace of ``id``",description:"Delete NVMe target namespace of ``id``.",method:`POST`,route:`/nvmet.namespace.delete`,params:[],body:{required:!0,description:``,fields:[{wireName:`id`,flag:`id`,required:!0,description:`ID of the NVMe-oF namespace to delete.`,type:{kind:`integer`}},{wireName:`options`,flag:`options`,required:!0,description:`Options controlling namespace deletion behavior.`,type:{kind:`json`}}]},confirmation:``,hidden:!1,deprecated:!1,rpc:{method:`nvmet.namespace.delete`,params:[`id`,`options`],job:!1,defaults:{}}},{path:[`nvmet`,`namespace`,`get-instance`],summary:"Returns instance matching `id`",description:"Returns instance matching `id`. If `id` is not found, Validation error is raised.",method:`POST`,route:`/nvmet.namespace.get_instance`,params:[],body:{required:!0,description:``,fields:[{wireName:`id`,flag:`id`,required:!0,description:``,type:{kind:`integer`}},{wireName:`options`,flag:`options`,required:!0,description:`Query options customize the results returned by a query method. More complete documentation with examples are covered in the "Query methods" section of the TrueNAS API documentation.`,type:{kind:`json`}}]},hidden:!1,deprecated:!1,rpc:{method:`nvmet.namespace.get_instance`,params:[`id`,`options`],job:!1,defaults:{}}},{path:[`nvmet`,`namespace`,`query`],summary:``,description:``,method:`POST`,route:`/nvmet.namespace.query`,params:[],body:{required:!1,description:``,fields:[{wireName:`filters`,flag:`filters`,required:!1,description:`List of filters for query results. See API documentation for "Query Methods" for more guidance.`,type:{kind:`array`,elem:{kind:`json`}}},{wireName:`options`,flag:`options`,required:!1,description:`Query options including pagination, ordering, and additional parameters.`,type:{kind:`json`}}]},hidden:!1,deprecated:!1,rpc:{method:`nvmet.namespace.query`,params:[`filters`,`options`],job:!1,defaults:{filters:[],options:{extra:{},order_by:[],select:[],count:!1,get:!1,offset:0,limit:0,force_sql_filters:!1}}}},{path:[`nvmet`,`namespace`,`update`],summary:"Update NVMe target namespace of ``id``",description:"Update NVMe target namespace of ``id``.",method:`POST`,route:`/nvmet.namespace.update`,params:[],body:{required:!0,description:``,fields:[{wireName:`id`,flag:`id`,required:!0,description:`ID of the NVMe-oF namespace to update.`,type:{kind:`integer`}},{wireName:`nvmet_namespace_update`,flag:`nvmet-namespace-update`,required:!0,description:`Updated NVMe-oF namespace configuration data.`,type:{kind:`json`}}]},hidden:!1,deprecated:!1,rpc:{method:`nvmet.namespace.update`,params:[`id`,`nvmet_namespace_update`],job:!1,defaults:{}}},{path:[`nvmet`,`port`,`create`],summary:"Create a NVMe target ``port``",description:"Create a NVMe target ``port``.",method:`POST`,route:`/nvmet.port.create`,params:[],body:{required:!0,description:``,fields:[{wireName:`nvmet_port_create`,flag:`nvmet-port-create`,required:!0,description:`NVMe-oF port configuration data for creation (TCP/RDMA or Fibre Channel).`,type:{kind:`json`}}]},hidden:!1,deprecated:!1,rpc:{method:`nvmet.port.create`,params:[`nvmet_port_create`],job:!1,defaults:{}}},{path:[`nvmet`,`port`,`delete`],summary:"Delete NVMe target ``port`` of ``id``",description:"Delete NVMe target ``port`` of ``id``.",method:`POST`,route:`/nvmet.port.delete`,params:[],body:{required:!0,description:``,fields:[{wireName:`id`,flag:`id`,required:!0,description:`ID of the NVMe-oF port to delete.`,type:{kind:`integer`}},{wireName:`options`,flag:`options`,required:!0,description:`Options controlling port deletion behavior.`,type:{kind:`json`}}]},confirmation:``,hidden:!1,deprecated:!1,rpc:{method:`nvmet.port.delete`,params:[`id`,`options`],job:!1,defaults:{}}},{path:[`nvmet`,`port`,`get-instance`],summary:"Returns instance matching `id`",description:"Returns instance matching `id`. If `id` is not found, Validation error is raised.",method:`POST`,route:`/nvmet.port.get_instance`,params:[],body:{required:!0,description:``,fields:[{wireName:`id`,flag:`id`,required:!0,description:``,type:{kind:`integer`}},{wireName:`options`,flag:`options`,required:!0,description:`Query options customize the results returned by a query method. More complete documentation with examples are covered in the "Query methods" section of the TrueNAS API documentation.`,type:{kind:`json`}}]},hidden:!1,deprecated:!1,rpc:{method:`nvmet.port.get_instance`,params:[`id`,`options`],job:!1,defaults:{}}},{path:[`nvmet`,`port`,`query`],summary:``,description:``,method:`POST`,route:`/nvmet.port.query`,params:[],body:{required:!1,description:``,fields:[{wireName:`filters`,flag:`filters`,required:!1,description:`List of filters for query results. See API documentation for "Query Methods" for more guidance.`,type:{kind:`array`,elem:{kind:`json`}}},{wireName:`options`,flag:`options`,required:!1,description:`Query options including pagination, ordering, and additional parameters.`,type:{kind:`json`}}]},hidden:!1,deprecated:!1,rpc:{method:`nvmet.port.query`,params:[`filters`,`options`],job:!1,defaults:{filters:[],options:{extra:{},order_by:[],select:[],count:!1,get:!1,offset:0,limit:0,force_sql_filters:!1}}}},{path:[`nvmet`,`port`,`transport-address-choices`],summary:"Returns possible choices for ``addr_traddr`` attribute of ``port`` create and update",description:"Returns possible choices for ``addr_traddr`` attribute of ``port`` create and update.",method:`POST`,route:`/nvmet.port.transport_address_choices`,params:[],body:{required:!0,description:``,fields:[{wireName:`addr_trtype`,flag:`addr-trtype`,required:!0,description:`Fabric transport technology name.`,type:{kind:`enum`,values:[`TCP`,`RDMA`,`FC`]}},{wireName:`force_ana`,flag:`force-ana`,required:!1,description:`Return information as if ANA was enabled.`,type:{kind:`boolean`}}]},hidden:!1,deprecated:!1,rpc:{method:`nvmet.port.transport_address_choices`,params:[`addr_trtype`,`force_ana`],job:!1,defaults:{force_ana:!1}}},{path:[`nvmet`,`port`,`update`],summary:"Update NVMe target ``port`` of ``id``",description:"Update NVMe target ``port`` of ``id``.",method:`POST`,route:`/nvmet.port.update`,params:[],body:{required:!0,description:``,fields:[{wireName:`id`,flag:`id`,required:!0,description:`ID of the NVMe-oF port to update.`,type:{kind:`integer`}},{wireName:`nvmet_port_update`,flag:`nvmet-port-update`,required:!0,description:`Updated NVMe-oF port configuration data.`,type:{kind:`json`}}]},hidden:!1,deprecated:!1,rpc:{method:`nvmet.port.update`,params:[`id`,`nvmet_port_update`],job:!1,defaults:{}}},{path:[`nvmet`,`port-subsys`,`create`],summary:"Create an association between a ``port`` and a subsystem (``subsys``)",description:"Create an association between a ``port`` and a subsystem (``subsys``).",method:`POST`,route:`/nvmet.port_subsys.create`,params:[],body:{required:!0,description:``,fields:[{wireName:`nvmet_port_subsys_create`,flag:`nvmet-port-subsys-create`,required:!0,description:`Port-subsystem association configuration data for creation.`,type:{kind:`json`}}]},hidden:!1,deprecated:!1,rpc:{method:`nvmet.port_subsys.create`,params:[`nvmet_port_subsys_create`],job:!1,defaults:{}}},{path:[`nvmet`,`port-subsys`,`delete`],summary:"Delete ``port``/``subsys`` association of ``id``",description:"Delete ``port``/``subsys`` association of ``id``.",method:`POST`,route:`/nvmet.port_subsys.delete`,params:[],body:{required:!0,description:``,fields:[{wireName:`id`,flag:`id`,required:!0,description:`ID of the port-subsystem association to delete.`,type:{kind:`integer`}}]},confirmation:``,hidden:!1,deprecated:!1,rpc:{method:`nvmet.port_subsys.delete`,params:[`id`],job:!1,defaults:{}}},{path:[`nvmet`,`port-subsys`,`get-instance`],summary:"Returns instance matching `id`",description:"Returns instance matching `id`. If `id` is not found, Validation error is raised.",method:`POST`,route:`/nvmet.port_subsys.get_instance`,params:[],body:{required:!0,description:``,fields:[{wireName:`id`,flag:`id`,required:!0,description:``,type:{kind:`integer`}},{wireName:`options`,flag:`options`,required:!0,description:`Query options customize the results returned by a query method. More complete documentation with examples are covered in the "Query methods" section of the TrueNAS API documentation.`,type:{kind:`json`}}]},hidden:!1,deprecated:!1,rpc:{method:`nvmet.port_subsys.get_instance`,params:[`id`,`options`],job:!1,defaults:{}}},{path:[`nvmet`,`port-subsys`,`query`],summary:``,description:``,method:`POST`,route:`/nvmet.port_subsys.query`,params:[],body:{required:!1,description:``,fields:[{wireName:`filters`,flag:`filters`,required:!1,description:`List of filters for query results. See API documentation for "Query Methods" for more guidance.`,type:{kind:`array`,elem:{kind:`json`}}},{wireName:`options`,flag:`options`,required:!1,description:`Query options including pagination, ordering, and additional parameters.`,type:{kind:`json`}}]},hidden:!1,deprecated:!1,rpc:{method:`nvmet.port_subsys.query`,params:[`filters`,`options`],job:!1,defaults:{filters:[],options:{extra:{},order_by:[],select:[],count:!1,get:!1,offset:0,limit:0,force_sql_filters:!1}}}},{path:[`nvmet`,`port-subsys`,`update`],summary:"Update ``port``/``subsys`` association of ``id``",description:"Update ``port``/``subsys`` association of ``id``.",method:`POST`,route:`/nvmet.port_subsys.update`,params:[],body:{required:!0,description:``,fields:[{wireName:`id`,flag:`id`,required:!0,description:`ID of the port-subsystem association to update.`,type:{kind:`integer`}},{wireName:`nvmet_port_subsys_update`,flag:`nvmet-port-subsys-update`,required:!0,description:`Updated port-subsystem association configuration data.`,type:{kind:`json`}}]},hidden:!1,deprecated:!1,rpc:{method:`nvmet.port_subsys.update`,params:[`id`,`nvmet_port_subsys_update`],job:!1,defaults:{}}},{path:[`nvmet`,`subsys`,`create`],summary:"Create a NVMe target subsystem (``subsys``)",description:"Create a NVMe target subsystem (``subsys``).",method:`POST`,route:`/nvmet.subsys.create`,params:[],body:{required:!0,description:``,fields:[{wireName:`nvmet_subsys_create`,flag:`nvmet-subsys-create`,required:!0,description:`Configuration data for creating a new NVMe-oF subsystem.`,type:{kind:`json`}}]},hidden:!1,deprecated:!1,rpc:{method:`nvmet.subsys.create`,params:[`nvmet_subsys_create`],job:!1,defaults:{}}},{path:[`nvmet`,`subsys`,`delete`],summary:"Delete NVMe target subsystem (``subsys``) of ``id``",description:"Delete NVMe target subsystem (``subsys``) of ``id``.",method:`POST`,route:`/nvmet.subsys.delete`,params:[],body:{required:!0,description:``,fields:[{wireName:`id`,flag:`id`,required:!0,description:`ID of the subsystem to delete.`,type:{kind:`integer`}},{wireName:`options`,flag:`options`,required:!0,description:`Options for subsystem deletion behavior.`,type:{kind:`json`}}]},confirmation:``,hidden:!1,deprecated:!1,rpc:{method:`nvmet.subsys.delete`,params:[`id`,`options`],job:!1,defaults:{}}},{path:[`nvmet`,`subsys`,`get-instance`],summary:"Returns instance matching `id`",description:"Returns instance matching `id`. If `id` is not found, Validation error is raised.",method:`POST`,route:`/nvmet.subsys.get_instance`,params:[],body:{required:!0,description:``,fields:[{wireName:`id`,flag:`id`,required:!0,description:``,type:{kind:`integer`}},{wireName:`options`,flag:`options`,required:!0,description:`Query options customize the results returned by a query method. More complete documentation with examples are covered in the "Query methods" section of the TrueNAS API documentation.`,type:{kind:`json`}}]},hidden:!1,deprecated:!1,rpc:{method:`nvmet.subsys.get_instance`,params:[`id`,`options`],job:!1,defaults:{}}},{path:[`nvmet`,`subsys`,`query`],summary:``,description:``,method:`POST`,route:`/nvmet.subsys.query`,params:[],body:{required:!1,description:``,fields:[{wireName:`filters`,flag:`filters`,required:!1,description:`List of filters for query results. See API documentation for "Query Methods" for more guidance.`,type:{kind:`array`,elem:{kind:`json`}}},{wireName:`options`,flag:`options`,required:!1,description:`Query options including pagination, ordering, and additional parameters.`,type:{kind:`json`}}]},hidden:!1,deprecated:!1,rpc:{method:`nvmet.subsys.query`,params:[`filters`,`options`],job:!1,defaults:{filters:[],options:{extra:{},order_by:[],select:[],count:!1,get:!1,offset:0,limit:0,force_sql_filters:!1}}}},{path:[`nvmet`,`subsys`,`update`],summary:"Update NVMe target subsystem (``subsys``) of ``id``",description:"Update NVMe target subsystem (``subsys``) of ``id``.",method:`POST`,route:`/nvmet.subsys.update`,params:[],body:{required:!0,description:``,fields:[{wireName:`id`,flag:`id`,required:!0,description:`ID of the subsystem to update.`,type:{kind:`integer`}},{wireName:`nvmet_subsys_update`,flag:`nvmet-subsys-update`,required:!0,description:`Updated configuration data for the NVMe-oF subsystem.`,type:{kind:`json`}}]},hidden:!1,deprecated:!1,rpc:{method:`nvmet.subsys.update`,params:[`id`,`nvmet_subsys_update`],job:!1,defaults:{}}},{path:[`pool`,`attach`],summary:`Attach a disk to an existing vdev in a pool, converting a striped vdev to a mirror or extending an existing mirror to an n-way mirror`,description:`Attach a disk to an existing vdev in a pool, converting a striped vdev to a mirror or extending an existing mirror to an n-way mirror.`,method:`POST`,route:`/pool.attach`,params:[],body:{required:!0,description:``,fields:[{wireName:`oid`,flag:`oid`,required:!0,description:`ID of the pool to attach a disk to.`,type:{kind:`integer`}},{wireName:`options`,flag:`options`,required:!0,description:`Configuration for the disk attachment operation.`,type:{kind:`json`}}]},hidden:!1,deprecated:!1,rpc:{method:`pool.attach`,params:[`oid`,`options`],job:!0,defaults:{}}},{path:[`pool`,`attachments`],summary:`Return a list of services dependent of this pool`,description:`Return a list of services dependent of this pool.`,method:`POST`,route:`/pool.attachments`,params:[],body:{required:!0,description:``,fields:[{wireName:`id`,flag:`id`,required:!0,description:`ID of the pool to retrieve attachments for.`,type:{kind:`integer`}}]},hidden:!1,deprecated:!1,rpc:{method:`pool.attachments`,params:[`id`],job:!1,defaults:{}}},{path:[`pool`,`create`],summary:`Create a new ZFS Pool`,description:`Create a new ZFS Pool.`,method:`POST`,route:`/pool.create`,params:[],body:{required:!0,description:``,fields:[{wireName:`data`,flag:`data`,required:!0,description:`Configuration for creating a new storage pool.`,type:{kind:`json`}}]},hidden:!1,deprecated:!1,rpc:{method:`pool.create`,params:[`data`],job:!0,defaults:{}}},{path:[`pool`,`ddt-prefetch`],summary:"Prefetch DDT entries in pool ``pool_name``",description:"Prefetch DDT entries in pool ``pool_name``.",method:`POST`,route:`/pool.ddt_prefetch`,params:[],body:{required:!0,description:``,fields:[{wireName:`pool_name`,flag:`pool-name`,required:!0,description:`Name of the pool to prefetch deduplication table entries for.`,type:{kind:`string`}}]},hidden:!1,deprecated:!1,rpc:{method:`pool.ddt_prefetch`,params:[`pool_name`],job:!0,defaults:{}}},{path:[`pool`,`ddt-prune`],summary:"Prune DDT entries in pool ``pool_name`` based on the specified options",description:"Prune DDT entries in pool ``pool_name`` based on the specified options.",method:`POST`,route:`/pool.ddt_prune`,params:[],body:{required:!0,description:``,fields:[{wireName:`options`,flag:`options`,required:!0,description:`PoolDdtPruneArgs parameters.`,type:{kind:`json`}}]},hidden:!1,deprecated:!1,rpc:{method:`pool.ddt_prune`,params:[`options`],job:!0,defaults:{}}},{path:[`pool`,`detach`],summary:"Detach a disk from pool of id ``id``",description:"Detach a disk from pool of id ``id``.",method:`POST`,route:`/pool.detach`,params:[],body:{required:!0,description:``,fields:[{wireName:`id`,flag:`id`,required:!0,description:`ID of the pool to detach a disk from.`,type:{kind:`integer`}},{wireName:`options`,flag:`options`,required:!0,description:`Configuration for the disk detachment operation.`,type:{kind:`json`}}]},confirmation:``,hidden:!1,deprecated:!1,rpc:{method:`pool.detach`,params:[`id`,`options`],job:!1,defaults:{}}},{path:[`pool`,`expand`],summary:`Expand pool to fit all available disk space`,description:`Expand pool to fit all available disk space.`,method:`POST`,route:`/pool.expand`,params:[],body:{required:!0,description:``,fields:[{wireName:`id`,flag:`id`,required:!0,description:`ID of the pool to expand.`,type:{kind:`integer`}}]},hidden:!1,deprecated:!1,rpc:{method:`pool.expand`,params:[`id`],job:!0,defaults:{}}},{path:[`pool`,`export`],summary:"Export pool of ``id``",description:"Export pool of ``id``.",method:`POST`,route:`/pool.export`,params:[],body:{required:!0,description:``,fields:[{wireName:`id`,flag:`id`,required:!0,description:`ID of the pool to export.`,type:{kind:`integer`}},{wireName:`options`,flag:`options`,required:!0,description:`Options for controlling the pool export process.`,type:{kind:`json`}}]},confirmation:``,hidden:!1,deprecated:!1,rpc:{method:`pool.export`,params:[`id`,`options`],job:!0,defaults:{}}},{path:[`pool`,`filesystem-choices`],summary:"Returns all available zfs resources based on ``types``",description:"Returns all available zfs resources based on ``types``.",method:`POST`,route:`/pool.filesystem_choices`,params:[],body:{required:!1,description:``,fields:[{wireName:`types`,flag:`types`,required:!1,description:`Dataset types to include in the results.`,type:{kind:`array`,elem:{kind:`enum`,values:[`FILESYSTEM`,`VOLUME`]}}}]},hidden:!1,deprecated:!1,rpc:{method:`pool.filesystem_choices`,params:[`types`],job:!1,defaults:{types:[`FILESYSTEM`,`VOLUME`]}}},{path:[`pool`,`get-disks`],summary:`Return the device names of all disks belonging to a pool`,description:`Return the device names of all disks belonging to a pool.`,method:`POST`,route:`/pool.get_disks`,params:[],body:{required:!1,description:``,fields:[{wireName:`id`,flag:`id`,required:!1,description:"ID of the pool to get disks for. If `null`, returns disks from all pools.",type:{kind:`integer`}}]},hidden:!1,deprecated:!1,rpc:{method:`pool.get_disks`,params:[`id`],job:!1,defaults:{id:null}}},{path:[`pool`,`get-instance`],summary:"Returns instance matching `id`",description:"Returns instance matching `id`. If `id` is not found, Validation error is raised.",method:`POST`,route:`/pool.get_instance`,params:[],body:{required:!0,description:``,fields:[{wireName:`id`,flag:`id`,required:!0,description:``,type:{kind:`integer`}},{wireName:`options`,flag:`options`,required:!0,description:`Query options customize the results returned by a query method. More complete documentation with examples are covered in the "Query methods" section of the TrueNAS API documentation.`,type:{kind:`json`}}]},hidden:!1,deprecated:!1,rpc:{method:`pool.get_instance`,params:[`id`,`options`],job:!1,defaults:{}}},{path:[`pool`,`import-find`],summary:`Returns a job id which can be used to retrieve a list of pools available for import with the following details as a result of the job: name, guid, status, hostname`,description:`Returns a job id which can be used to retrieve a list of pools available for import with the following details as a result of the job: name, guid, status, hostname.`,method:`POST`,route:`/pool.import_find`,params:[],hidden:!1,deprecated:!1,rpc:{method:`pool.import_find`,params:[],job:!0,defaults:{}}},{path:[`pool`,`import-pool`],summary:"Import a pool found with :doc:`pool.import_find <api_methods_pool.import_find>`",description:"Import a pool found with :doc:`pool.import_find <api_methods_pool.import_find>`.",method:`POST`,route:`/pool.import_pool`,params:[],body:{required:!0,description:``,fields:[{wireName:`pool_import`,flag:`pool-import`,required:!0,description:`PoolImportPoolArgs parameters.`,type:{kind:`json`}}]},hidden:!1,deprecated:!1,rpc:{method:`pool.import_pool`,params:[`pool_import`],job:!0,defaults:{}}},{path:[`pool`,`is-upgraded`],summary:"Returns whether the pool of ``id`` is on the latest version and with all feature flags enabled",description:"Returns whether the pool of ``id`` is on the latest version and with all feature flags enabled.",method:`POST`,route:`/pool.is_upgraded`,params:[],body:{required:!0,description:``,fields:[{wireName:`id`,flag:`id`,required:!0,description:`ID of the pool to check upgrade status for.`,type:{kind:`integer`}}]},hidden:!1,deprecated:!1,rpc:{method:`pool.is_upgraded`,params:[`id`],job:!1,defaults:{}}},{path:[`pool`,`offline`],summary:"Offline a disk from pool of id ``id``",description:"Offline a disk from pool of id ``id``.",method:`POST`,route:`/pool.offline`,params:[],body:{required:!0,description:``,fields:[{wireName:`id`,flag:`id`,required:!0,description:`ID of the pool to modify.`,type:{kind:`integer`}},{wireName:`options`,flag:`options`,required:!0,description:`Disk identifier to take offline.`,type:{kind:`json`}}]},hidden:!1,deprecated:!1,rpc:{method:`pool.offline`,params:[`id`,`options`],job:!1,defaults:{}}},{path:[`pool`,`online`],summary:"Online a disk from pool of id ``id``",description:"Online a disk from pool of id ``id``.",method:`POST`,route:`/pool.online`,params:[],body:{required:!0,description:``,fields:[{wireName:`id`,flag:`id`,required:!0,description:`ID of the pool to bring a disk online in.`,type:{kind:`integer`}},{wireName:`options`,flag:`options`,required:!0,description:`Disk identifier to bring online.`,type:{kind:`json`}}]},hidden:!1,deprecated:!1,rpc:{method:`pool.online`,params:[`id`,`options`],job:!1,defaults:{}}},{path:[`pool`,`processes`],summary:`Returns a list of running processes using this pool`,description:`Returns a list of running processes using this pool.`,method:`POST`,route:`/pool.processes`,params:[],body:{required:!0,description:``,fields:[{wireName:`id`,flag:`id`,required:!0,description:`ID of the pool to get processes for.`,type:{kind:`integer`}}]},hidden:!1,deprecated:!1,rpc:{method:`pool.processes`,params:[`id`],job:!1,defaults:{}}},{path:[`pool`,`query`],summary:``,description:``,method:`POST`,route:`/pool.query`,params:[],body:{required:!1,description:``,fields:[{wireName:`filters`,flag:`filters`,required:!1,description:`List of filters for query results. See API documentation for "Query Methods" for more guidance.`,type:{kind:`array`,elem:{kind:`json`}}},{wireName:`options`,flag:`options`,required:!1,description:`Query options including pagination, ordering, and additional parameters.`,type:{kind:`json`}}]},hidden:!1,deprecated:!1,rpc:{method:`pool.query`,params:[`filters`,`options`],job:!1,defaults:{filters:[],options:{extra:{},order_by:[],select:[],count:!1,get:!1,offset:0,limit:0,force_sql_filters:!1}}}},{path:[`pool`,`remove`],summary:"Remove a disk from pool of id ``id``",description:"Remove a disk from pool of id ``id``.",method:`POST`,route:`/pool.remove`,params:[],body:{required:!0,description:``,fields:[{wireName:`id`,flag:`id`,required:!0,description:`ID of the pool to remove a disk from.`,type:{kind:`integer`}},{wireName:`options`,flag:`options`,required:!0,description:`Disk identifier to remove from the pool.`,type:{kind:`json`}}]},confirmation:``,hidden:!1,deprecated:!1,rpc:{method:`pool.remove`,params:[`id`,`options`],job:!0,defaults:{}}},{path:[`pool`,`replace`],summary:`Replace a disk on a pool`,description:`Replace a disk on a pool.`,method:`POST`,route:`/pool.replace`,params:[],body:{required:!0,description:``,fields:[{wireName:`id`,flag:`id`,required:!0,description:`ID of the pool to replace a disk in.`,type:{kind:`integer`}},{wireName:`options`,flag:`options`,required:!0,description:`Configuration for the disk replacement operation.`,type:{kind:`json`}}]},hidden:!1,deprecated:!1,rpc:{method:`pool.replace`,params:[`id`,`options`],job:!0,defaults:{}}},{path:[`pool`,`update`],summary:"Update pool of ``id``, adding the new topology",description:"Update pool of ``id``, adding the new topology.",method:`POST`,route:`/pool.update`,params:[],body:{required:!0,description:``,fields:[{wireName:`id`,flag:`id`,required:!0,description:`ID of the pool to update.`,type:{kind:`integer`}},{wireName:`data`,flag:`data`,required:!0,description:`Updated configuration for the pool.`,type:{kind:`json`}}]},hidden:!1,deprecated:!1,rpc:{method:`pool.update`,params:[`id`,`data`],job:!0,defaults:{}}},{path:[`pool`,`upgrade`],summary:"Upgrade pool of ``id`` to latest version with all feature flags",description:"Upgrade pool of ``id`` to latest version with all feature flags.",method:`POST`,route:`/pool.upgrade`,params:[],body:{required:!0,description:``,fields:[{wireName:`id`,flag:`id`,required:!0,description:`ID of the pool to upgrade to the latest feature flags.`,type:{kind:`integer`}}]},hidden:!1,deprecated:!1,rpc:{method:`pool.upgrade`,params:[`id`],job:!1,defaults:{}}},{path:[`pool`,`validate-name`],summary:"Validates ``pool_name`` is a valid name for a pool",description:"Validates ``pool_name`` is a valid name for a pool.",method:`POST`,route:`/pool.validate_name`,params:[],body:{required:!0,description:``,fields:[{wireName:`pool_name`,flag:`pool-name`,required:!0,description:`Pool name to validate for compliance with naming rules.`,type:{kind:`string`}}]},hidden:!1,deprecated:!1,rpc:{method:`pool.validate_name`,params:[`pool_name`],job:!1,defaults:{}}},{path:[`pool`,`dataset`,`attachments`],summary:`Return a list of services dependent of this dataset`,description:`Return a list of services dependent of this dataset.`,method:`POST`,route:`/pool.dataset.attachments`,params:[],body:{required:!0,description:``,fields:[{wireName:`id`,flag:`id`,required:!0,description:`The dataset ID (full path) to retrieve attachments for.`,type:{kind:`string`}}]},hidden:!1,deprecated:!1,rpc:{method:`pool.dataset.attachments`,params:[`id`],job:!1,defaults:{}}},{path:[`pool`,`dataset`,`checksum-choices`],summary:`Retrieve checksums supported for ZFS dataset`,description:`Retrieve checksums supported for ZFS dataset.`,method:`POST`,route:`/pool.dataset.checksum_choices`,params:[],hidden:!1,deprecated:!1,rpc:{method:`pool.dataset.checksum_choices`,params:[],job:!1,defaults:{}}},{path:[`pool`,`dataset`,`compression-choices`],summary:`Retrieve compression algorithm supported by ZFS`,description:`Retrieve compression algorithm supported by ZFS.`,method:`POST`,route:`/pool.dataset.compression_choices`,params:[],hidden:!1,deprecated:!1,rpc:{method:`pool.dataset.compression_choices`,params:[],job:!1,defaults:{}}},{path:[`pool`,`dataset`,`create`],summary:`Creates a dataset/zvol`,description:`Creates a dataset/zvol.`,method:`POST`,route:`/pool.dataset.create`,params:[],body:{required:!0,description:``,fields:[{wireName:`data`,flag:`data`,required:!0,description:`Configuration data for creating a new ZFS dataset.`,type:{kind:`json`}}]},hidden:!1,deprecated:!1,rpc:{method:`pool.dataset.create`,params:[`data`],job:!1,defaults:{}}},{path:[`pool`,`dataset`,`delete`],summary:"Delete dataset/zvol ``id``",description:"Delete dataset/zvol ``id``.",method:`POST`,route:`/pool.dataset.delete`,params:[],body:{required:!0,description:``,fields:[{wireName:`id`,flag:`id`,required:!0,description:`The dataset ID (full path) to delete.`,type:{kind:`string`}},{wireName:`options`,flag:`options`,required:!0,description:`Options controlling the deletion behavior such as recursive and force flags.`,type:{kind:`json`}}]},confirmation:``,hidden:!1,deprecated:!1,rpc:{method:`pool.dataset.delete`,params:[`id`,`options`],job:!1,defaults:{}}},{path:[`pool`,`dataset`,`details`],summary:`Retrieve all dataset(s) details outlining any services/tasks which might be consuming them`,description:`Retrieve all dataset(s) details outlining any services/tasks which might be consuming them.`,method:`POST`,route:`/pool.dataset.details`,params:[],hidden:!1,deprecated:!1,rpc:{method:`pool.dataset.details`,params:[],job:!1,defaults:{}}},{path:[`pool`,`dataset`,`get-instance`],summary:"Returns instance matching `id`",description:"Returns instance matching `id`. If `id` is not found, Validation error is raised.",method:`POST`,route:`/pool.dataset.get_instance`,params:[],body:{required:!0,description:``,fields:[{wireName:`id`,flag:`id`,required:!0,description:``,type:{kind:`string`}},{wireName:`options`,flag:`options`,required:!0,description:`Query options customize the results returned by a query method. More complete documentation with examples are covered in the "Query methods" section of the TrueNAS API documentation.`,type:{kind:`json`}}]},hidden:!1,deprecated:!1,rpc:{method:`pool.dataset.get_instance`,params:[`id`,`options`],job:!1,defaults:{}}},{path:[`pool`,`dataset`,`get-quota`],summary:"Return a list of the specified ``quota_type`` of quotas on the ZFS dataset ``ds``",description:"Return a list of the specified ``quota_type`` of quotas on the ZFS dataset ``ds``. Supports ``query-filters`` and ``query-options``.",method:`POST`,route:`/pool.dataset.get_quota`,params:[],body:{required:!0,description:``,fields:[{wireName:`dataset`,flag:`dataset`,required:!0,description:`The dataset path to retrieve quotas for.`,type:{kind:`string`}},{wireName:`quota_type`,flag:`quota-type`,required:!0,description:`The type of quotas to retrieve.`,type:{kind:`enum`,values:[`USER`,`GROUP`,`DATASET`,`PROJECT`]}},{wireName:`filters`,flag:`filters`,required:!1,description:`Query filters to limit the results returned.`,type:{kind:`array`,elem:{kind:`json`}}},{wireName:`options`,flag:`options`,required:!0,description:`Query options such as sorting and pagination.`,type:{kind:`json`}}]},hidden:!1,deprecated:!1,rpc:{method:`pool.dataset.get_quota`,params:[`dataset`,`quota_type`,`filters`,`options`],job:!1,defaults:{filters:[]}}},{path:[`pool`,`dataset`,`inherit-parent-encryption-properties`],summary:`Allows inheriting parent's encryption root discarding its current encryption settings`,description:"Allows inheriting parent's encryption root discarding its current encryption settings. This can only be done where ``id`` has an encrypted parent and ``id`` itself is an encryption root.",method:`POST`,route:`/pool.dataset.inherit_parent_encryption_properties`,params:[],body:{required:!0,description:``,fields:[{wireName:`id`,flag:`id`,required:!0,description:`The dataset ID (full path) to inherit encryption properties from its parent.`,type:{kind:`string`}}]},hidden:!1,deprecated:!1,rpc:{method:`pool.dataset.inherit_parent_encryption_properties`,params:[`id`],job:!1,defaults:{}}},{path:[`pool`,`dataset`,`lock`],summary:"Locks ``id`` dataset",description:"Locks ``id`` dataset. It will unmount the dataset and its children before locking.",method:`POST`,route:`/pool.dataset.lock`,params:[],body:{required:!0,description:``,fields:[{wireName:`id`,flag:`id`,required:!0,description:`The dataset ID (full path) to lock.`,type:{kind:`string`}},{wireName:`options`,flag:`options`,required:!0,description:`Options for locking the dataset, such as force unmount settings.`,type:{kind:`json`}}]},hidden:!1,deprecated:!1,rpc:{method:`pool.dataset.lock`,params:[`id`,`options`],job:!0,defaults:{}}},{path:[`pool`,`dataset`,`processes`],summary:`Return a list of processes using this dataset`,description:`Return a list of processes using this dataset.`,method:`POST`,route:`/pool.dataset.processes`,params:[],body:{required:!0,description:``,fields:[{wireName:`id`,flag:`id`,required:!0,description:`The dataset ID (full path) to list processes for.`,type:{kind:`string`}}]},hidden:!1,deprecated:!1,rpc:{method:`pool.dataset.processes`,params:[`id`],job:!1,defaults:{}}},{path:[`pool`,`dataset`,`promote`],summary:`Promote a cloned dataset`,description:`Promote a cloned dataset.`,method:`POST`,route:`/pool.dataset.promote`,params:[],body:{required:!0,description:``,fields:[{wireName:`id`,flag:`id`,required:!0,description:`The clone dataset ID (full path) to promote to become the parent.`,type:{kind:`string`}}]},hidden:!1,deprecated:!1,rpc:{method:`pool.dataset.promote`,params:[`id`],job:!1,defaults:{}}},{path:[`pool`,`dataset`,`query`],summary:"Query pool datasets with ``query-filters`` and ``query-options``",description:"Query pool datasets with ``query-filters`` and ``query-options``.",method:`POST`,route:`/pool.dataset.query`,params:[],body:{required:!1,description:``,fields:[{wireName:`filters`,flag:`filters`,required:!1,description:`List of filters for query results. See API documentation for "Query Methods" for more guidance.`,type:{kind:`array`,elem:{kind:`json`}}},{wireName:`options`,flag:`options`,required:!1,description:`Query options including pagination, ordering, and additional parameters.`,type:{kind:`json`}}]},hidden:!1,deprecated:!1,rpc:{method:`pool.dataset.query`,params:[`filters`,`options`],job:!1,defaults:{filters:[],options:{extra:{},order_by:[],select:[],count:!1,get:!1,offset:0,limit:0,force_sql_filters:!1}}}},{path:[`pool`,`dataset`,`recommended-zvol-blocksize`],summary:`Helper method to get recommended size for a new zvol (dataset of type VOLUME)`,description:`Helper method to get recommended size for a new zvol (dataset of type VOLUME).`,method:`POST`,route:`/pool.dataset.recommended_zvol_blocksize`,params:[],body:{required:!0,description:``,fields:[{wireName:`pool`,flag:`pool`,required:!0,description:`The pool name to get the recommended volume block size for.`,type:{kind:`string`}}]},hidden:!1,deprecated:!1,rpc:{method:`pool.dataset.recommended_zvol_blocksize`,params:[`pool`],job:!1,defaults:{}}},{path:[`pool`,`dataset`,`recordsize-choices`],summary:`Retrieve recordsize choices for datasets`,description:`Retrieve recordsize choices for datasets.`,method:`POST`,route:`/pool.dataset.recordsize_choices`,params:[],body:{required:!1,description:``,fields:[{wireName:`pool_name`,flag:`pool-name`,required:!1,description:`Optional pool name to get record size choices for. If not provided, returns general choices.`,type:{kind:`string`}}]},hidden:!1,deprecated:!1,rpc:{method:`pool.dataset.recordsize_choices`,params:[`pool_name`],job:!1,defaults:{pool_name:null}}},{path:[`pool`,`dataset`,`rename`],summary:"Rename a ZFS resource (filesystem, snapshot, or zvolume) identified by ``id``",description:"Rename a ZFS resource (filesystem, snapshot, or zvolume) identified by ``id``.",method:`POST`,route:`/pool.dataset.rename`,params:[],body:{required:!0,description:``,fields:[{wireName:`id`,flag:`id`,required:!0,description:`The current dataset ID (full path) to rename.`,type:{kind:`string`}},{wireName:`data`,flag:`data`,required:!0,description:`The rename operation options including the new name and safety flags.`,type:{kind:`json`}}]},hidden:!1,deprecated:!1,rpc:{method:`pool.dataset.rename`,params:[`id`,`data`],job:!1,defaults:{}}},{path:[`pool`,`dataset`,`set-quota`],summary:`Allow users to set multiple quotas simultaneously by submitting a list of quotas`,description:`Allow users to set multiple quotas simultaneously by submitting a list of quotas.`,method:`POST`,route:`/pool.dataset.set_quota`,params:[],body:{required:!0,description:``,fields:[{wireName:`dataset`,flag:`dataset`,required:!0,description:`The name of the target ZFS dataset.`,type:{kind:`string`}},{wireName:`quotas`,flag:`quotas`,required:!1,description:`Specify an array of quota entries to apply to dataset. The array may contain all supported quota types.`,type:{kind:`array`,elem:{kind:`json`}}}]},hidden:!1,deprecated:!1,rpc:{method:`pool.dataset.set_quota`,params:[`dataset`,`quotas`],job:!1,defaults:{quotas:[{quota_type:`USER`,id:`0`,quota_value:0}]}}},{path:[`pool`,`dataset`,`snapshot-count`],summary:"Returns snapshot count for specified ``dataset``",description:"Returns snapshot count for specified ``dataset``.",method:`POST`,route:`/pool.dataset.snapshot_count`,params:[],body:{required:!0,description:``,fields:[{wireName:`dataset`,flag:`dataset`,required:!0,description:`The dataset path to count snapshots for.`,type:{kind:`string`}}]},hidden:!1,deprecated:!1,rpc:{method:`pool.dataset.snapshot_count`,params:[`dataset`],job:!1,defaults:{}}},{path:[`pool`,`dataset`,`update`],summary:"Updates a dataset/zvol ``id``",description:"Updates a dataset/zvol ``id``.",method:`POST`,route:`/pool.dataset.update`,params:[],body:{required:!0,description:``,fields:[{wireName:`id`,flag:`id`,required:!0,description:`The dataset ID (full path) to update.`,type:{kind:`string`}},{wireName:`data`,flag:`data`,required:!0,description:`The dataset properties to update.`,type:{kind:`json`}}]},hidden:!1,deprecated:!1,rpc:{method:`pool.dataset.update`,params:[`id`,`data`],job:!1,defaults:{}}},{path:[`pool`,`resilver`,`config`],summary:``,description:``,method:`POST`,route:`/pool.resilver.config`,params:[],hidden:!1,deprecated:!1,rpc:{method:`pool.resilver.config`,params:[],job:!1,defaults:{}}},{path:[`pool`,`resilver`,`update`],summary:`Configure Pool Resilver Priority`,description:`Configure Pool Resilver Priority.`,method:`POST`,route:`/pool.resilver.update`,params:[],body:{required:!0,description:``,fields:[{wireName:`data`,flag:`data`,required:!0,description:`The resilver schedule configuration to update.`,type:{kind:`json`}}]},hidden:!1,deprecated:!1,rpc:{method:`pool.resilver.update`,params:[`data`],job:!1,defaults:{}}},{path:[`pool`,`scrub`,`call`],summary:"Performs a scrub action to pool of ``id``",description:"Performs a scrub action to pool of ``id``.",method:`POST`,route:`/pool.scrub`,params:[],body:{required:!0,description:``,fields:[{wireName:`id`,flag:`id`,required:!0,description:`ID of the pool to perform scrub action on.`,type:{kind:`integer`}},{wireName:`action`,flag:`action`,required:!0,description:`The scrub action to perform.`,type:{kind:`enum`,values:[`START`,`STOP`,`PAUSE`]}}]},hidden:!1,deprecated:!1,rpc:{method:`pool.scrub`,params:[`id`,`action`],job:!0,defaults:{}}},{path:[`pool`,`scrub`,`create`],summary:`Create a scrub task for a pool`,description:`Create a scrub task for a pool.`,method:`POST`,route:`/pool.scrub.create`,params:[],body:{required:!0,description:``,fields:[{wireName:`data`,flag:`data`,required:!0,description:`Configuration for the new scrub schedule.`,type:{kind:`json`}}]},hidden:!1,deprecated:!1,rpc:{method:`pool.scrub.create`,params:[`data`],job:!1,defaults:{}}},{path:[`pool`,`scrub`,`delete`],summary:"Delete scrub task of ``id``",description:"Delete scrub task of ``id``.",method:`POST`,route:`/pool.scrub.delete`,params:[],body:{required:!0,description:``,fields:[{wireName:`id_`,flag:`id`,required:!0,description:`ID of the scrub schedule to delete.`,type:{kind:`integer`}}]},confirmation:``,hidden:!1,deprecated:!1,rpc:{method:`pool.scrub.delete`,params:[`id_`],job:!1,defaults:{}}},{path:[`pool`,`scrub`,`get-instance`],summary:"Returns instance matching `id`",description:"Returns instance matching `id`. If `id` is not found, Validation error is raised.",method:`POST`,route:`/pool.scrub.get_instance`,params:[],body:{required:!0,description:``,fields:[{wireName:`id`,flag:`id`,required:!0,description:``,type:{kind:`integer`}},{wireName:`options`,flag:`options`,required:!0,description:`Query options customize the results returned by a query method. More complete documentation with examples are covered in the "Query methods" section of the TrueNAS API documentation.`,type:{kind:`json`}}]},hidden:!1,deprecated:!1,rpc:{method:`pool.scrub.get_instance`,params:[`id`,`options`],job:!1,defaults:{}}},{path:[`pool`,`scrub`,`query`],summary:``,description:``,method:`POST`,route:`/pool.scrub.query`,params:[],body:{required:!1,description:``,fields:[{wireName:`filters`,flag:`filters`,required:!1,description:`List of filters for query results. See API documentation for "Query Methods" for more guidance.`,type:{kind:`array`,elem:{kind:`json`}}},{wireName:`options`,flag:`options`,required:!1,description:`Query options including pagination, ordering, and additional parameters.`,type:{kind:`json`}}]},hidden:!1,deprecated:!1,rpc:{method:`pool.scrub.query`,params:[`filters`,`options`],job:!1,defaults:{filters:[],options:{extra:{},order_by:[],select:[],count:!1,get:!1,offset:0,limit:0,force_sql_filters:!1}}}},{path:[`pool`,`scrub`,`run`],summary:"Initiate a scrub of pool ``name`` if the most recent scrub finished more than ``threshold`` days ago",description:"Initiate a scrub of pool ``name`` if the most recent scrub finished more than ``threshold`` days ago. Does nothing if the scrub is not yet due or if this node is not the active controller on an HA system.",method:`POST`,route:`/pool.scrub.run`,params:[],body:{required:!0,description:``,fields:[{wireName:`name`,flag:`name`,required:!0,description:`Name of the pool to run scrub on.`,type:{kind:`string`}},{wireName:`threshold`,flag:`threshold`,required:!1,description:`Days before a scrub is due when the scrub should start.`,type:{kind:`integer`}}]},hidden:!1,deprecated:!1,rpc:{method:`pool.scrub.run`,params:[`name`,`threshold`],job:!1,defaults:{threshold:35}}},{path:[`pool`,`scrub`,`scrub`],summary:"Start, stop, or pause a scrub on pool ``name``",description:"Start, stop, or pause a scrub on pool ``name``.",method:`POST`,route:`/pool.scrub.scrub`,params:[],body:{required:!0,description:``,fields:[{wireName:`name`,flag:`name`,required:!0,description:`Name of the pool to perform scrub action on.`,type:{kind:`string`}},{wireName:`action`,flag:`action`,required:!1,description:`The scrub action to perform on the pool.`,type:{kind:`enum`,values:[`START`,`STOP`,`PAUSE`]}}]},hidden:!1,deprecated:!1,rpc:{method:`pool.scrub.scrub`,params:[`name`,`action`],job:!0,defaults:{action:`START`}}},{path:[`pool`,`scrub`,`update`],summary:"Update scrub task of ``id``",description:"Update scrub task of ``id``.",method:`POST`,route:`/pool.scrub.update`,params:[],body:{required:!0,description:``,fields:[{wireName:`id_`,flag:`id`,required:!0,description:`ID of the scrub schedule to update.`,type:{kind:`integer`}},{wireName:`data`,flag:`data`,required:!0,description:`Updated configuration for the scrub schedule.`,type:{kind:`json`}}]},hidden:!1,deprecated:!1,rpc:{method:`pool.scrub.update`,params:[`id_`,`data`],job:!1,defaults:{}}},{path:[`pool`,`snapshot`,`clone`],summary:`Clone a given snapshot to a new dataset`,description:`Clone a given snapshot to a new dataset.`,method:`POST`,route:`/pool.snapshot.clone`,params:[],body:{required:!0,description:``,fields:[{wireName:`data`,flag:`data`,required:!0,description:`PoolSnapshotCloneArgs parameters.`,type:{kind:`json`}}]},hidden:!1,deprecated:!1,rpc:{method:`pool.snapshot.clone`,params:[`data`],job:!1,defaults:{}}},{path:[`pool`,`snapshot`,`create`],summary:`Take a snapshot from a given dataset`,description:`Take a snapshot from a given dataset.`,method:`POST`,route:`/pool.snapshot.create`,params:[],body:{required:!0,description:``,fields:[{wireName:`data`,flag:`data`,required:!0,description:`Configuration for creating a snapshot with either an explicit name or naming schema.`,type:{kind:`json`}}]},hidden:!1,deprecated:!1,rpc:{method:`pool.snapshot.create`,params:[`data`],job:!1,defaults:{}}},{path:[`pool`,`snapshot`,`delete`],summary:"Delete the snapshot identified by ``id``",description:"Delete the snapshot identified by ``id``.",method:`POST`,route:`/pool.snapshot.delete`,params:[],body:{required:!0,description:``,fields:[{wireName:`id`,flag:`id`,required:!0,description:`ID of the snapshot to delete.`,type:{kind:`string`}},{wireName:`options`,flag:`options`,required:!0,description:`Options for controlling snapshot deletion behavior.`,type:{kind:`json`}}]},confirmation:``,hidden:!1,deprecated:!1,rpc:{method:`pool.snapshot.delete`,params:[`id`,`options`],job:!1,defaults:{}}},{path:[`pool`,`snapshot`,`get-instance`],summary:"Returns instance matching `id`",description:"Returns instance matching `id`. If `id` is not found, Validation error is raised.",method:`POST`,route:`/pool.snapshot.get_instance`,params:[],body:{required:!0,description:``,fields:[{wireName:`id`,flag:`id`,required:!0,description:``,type:{kind:`string`}},{wireName:`options`,flag:`options`,required:!0,description:`Query options customize the results returned by a query method. More complete documentation with examples are covered in the "Query methods" section of the TrueNAS API documentation.`,type:{kind:`json`}}]},hidden:!1,deprecated:!1,rpc:{method:`pool.snapshot.get_instance`,params:[`id`,`options`],job:!1,defaults:{}}},{path:[`pool`,`snapshot`,`hold`],summary:"Hold snapshot ``id``",description:"Hold snapshot ``id``.",method:`POST`,route:`/pool.snapshot.hold`,params:[],body:{required:!0,description:``,fields:[{wireName:`id`,flag:`id`,required:!0,description:`ID of the snapshot to hold.`,type:{kind:`string`}},{wireName:`options`,flag:`options`,required:!0,description:`Options for controlling snapshot hold behavior.`,type:{kind:`json`}}]},hidden:!1,deprecated:!1,rpc:{method:`pool.snapshot.hold`,params:[`id`,`options`],job:!1,defaults:{}}},{path:[`pool`,`snapshot`,`query`],summary:"Query all ZFS snapshots with the standard ``query-filters`` and ``query-options``",description:"Query all ZFS snapshots with the standard ``query-filters`` and ``query-options``.",method:`POST`,route:`/pool.snapshot.query`,params:[],body:{required:!1,description:``,fields:[{wireName:`filters`,flag:`filters`,required:!1,description:`List of filters for query results. See API documentation for "Query Methods" for more guidance.`,type:{kind:`array`,elem:{kind:`json`}}},{wireName:`options`,flag:`options`,required:!1,description:`Query options including pagination, ordering, and additional parameters.`,type:{kind:`json`}}]},hidden:!1,deprecated:!1,rpc:{method:`pool.snapshot.query`,params:[`filters`,`options`],job:!1,defaults:{filters:[],options:{extra:{},order_by:[],select:[],count:!1,get:!1,offset:0,limit:0,force_sql_filters:!1}}}},{path:[`pool`,`snapshot`,`release`],summary:"Release hold on snapshot ``id``",description:"Release hold on snapshot ``id``.",method:`POST`,route:`/pool.snapshot.release`,params:[],body:{required:!0,description:``,fields:[{wireName:`id`,flag:`id`,required:!0,description:`ID of the held snapshot to release.`,type:{kind:`string`}},{wireName:`options`,flag:`options`,required:!0,description:`Options for controlling snapshot release behavior.`,type:{kind:`json`}}]},hidden:!1,deprecated:!1,rpc:{method:`pool.snapshot.release`,params:[`id`,`options`],job:!1,defaults:{}}},{path:[`pool`,`snapshot`,`rename`],summary:"Rename a snapshot ``id`` to ``new_name``",description:"Rename a snapshot ``id`` to ``new_name``.",method:`POST`,route:`/pool.snapshot.rename`,params:[],body:{required:!0,description:``,fields:[{wireName:`id`,flag:`id`,required:!0,description:`Current ID of the snapshot to rename.`,type:{kind:`string`}},{wireName:`options`,flag:`options`,required:!0,description:`The rename operation options including the new name and force flag.`,type:{kind:`json`}}]},hidden:!1,deprecated:!1,rpc:{method:`pool.snapshot.rename`,params:[`id`,`options`],job:!1,defaults:{}}},{path:[`pool`,`snapshot`,`rollback`],summary:"Roll the dataset of snapshot ``id`` back to the state captured by that snapshot",description:"Roll the dataset of snapshot ``id`` back to the state captured by that snapshot.",method:`POST`,route:`/pool.snapshot.rollback`,params:[],body:{required:!0,description:``,fields:[{wireName:`id`,flag:`id`,required:!0,description:`ID of the snapshot to rollback to.`,type:{kind:`string`}},{wireName:`options`,flag:`options`,required:!0,description:`Options for controlling snapshot rollback behavior.`,type:{kind:`json`}}]},confirmation:``,hidden:!1,deprecated:!1,rpc:{method:`pool.snapshot.rollback`,params:[`id`,`options`],job:!1,defaults:{}}},{path:[`pool`,`snapshot`,`update`],summary:"Changing the user properties of a snapshot is not supported; the call always fails with ``EOPNOTSUPP``",description:"Changing the user properties of a snapshot is not supported; the call always fails with ``EOPNOTSUPP``.",method:`POST`,route:`/pool.snapshot.update`,params:[],body:{required:!0,description:``,fields:[{wireName:`id`,flag:`id`,required:!0,description:`ID of the snapshot to update.`,type:{kind:`string`}},{wireName:`data`,flag:`data`,required:!0,description:`The property updates to apply to the snapshot.`,type:{kind:`json`}}]},hidden:!1,deprecated:!1,rpc:{method:`pool.snapshot.update`,params:[`id`,`data`],job:!1,defaults:{}}},{path:[`pool`,`snapshottask`,`create`],summary:`Create a periodic snapshot task`,description:`Create a periodic snapshot task.`,method:`POST`,route:`/pool.snapshottask.create`,params:[],body:{required:!0,description:``,fields:[{wireName:`data`,flag:`data`,required:!0,description:`Configuration for the new periodic snapshot task.`,type:{kind:`json`}}]},hidden:!1,deprecated:!1,rpc:{method:`pool.snapshottask.create`,params:[`data`],job:!1,defaults:{}}},{path:[`pool`,`snapshottask`,`delete`],summary:"Delete a Periodic Snapshot Task with specific ``id``",description:"Delete a Periodic Snapshot Task with specific ``id``.",method:`POST`,route:`/pool.snapshottask.delete`,params:[],body:{required:!0,description:``,fields:[{wireName:`id`,flag:`id`,required:!0,description:`ID of the periodic snapshot task to delete.`,type:{kind:`integer`}},{wireName:`options`,flag:`options`,required:!0,description:`Options for controlling task deletion behavior.`,type:{kind:`json`}}]},confirmation:``,hidden:!1,deprecated:!1,rpc:{method:`pool.snapshottask.delete`,params:[`id`,`options`],job:!1,defaults:{}}},{path:[`pool`,`snapshottask`,`delete-will-change-retention-for`],summary:"Returns a list of snapshots which will change the retention if periodic snapshot task ``id`` is deleted",description:"Returns a list of snapshots which will change the retention if periodic snapshot task ``id`` is deleted.",method:`POST`,route:`/pool.snapshottask.delete_will_change_retention_for`,params:[],body:{required:!0,description:``,fields:[{wireName:`id`,flag:`id`,required:!0,description:`ID of the periodic snapshot task to analyze for deletion impact.`,type:{kind:`integer`}}]},hidden:!1,deprecated:!1,rpc:{method:`pool.snapshottask.delete_will_change_retention_for`,params:[`id`],job:!1,defaults:{}}},{path:[`pool`,`snapshottask`,`get-instance`],summary:"Returns instance matching `id`",description:"Returns instance matching `id`. If `id` is not found, Validation error is raised.",method:`POST`,route:`/pool.snapshottask.get_instance`,params:[],body:{required:!0,description:``,fields:[{wireName:`id`,flag:`id`,required:!0,description:``,type:{kind:`integer`}},{wireName:`options`,flag:`options`,required:!0,description:`Query options customize the results returned by a query method. More complete documentation with examples are covered in the "Query methods" section of the TrueNAS API documentation.`,type:{kind:`json`}}]},hidden:!1,deprecated:!1,rpc:{method:`pool.snapshottask.get_instance`,params:[`id`,`options`],job:!1,defaults:{}}},{path:[`pool`,`snapshottask`,`max-count`],summary:`Returns a maximum amount of snapshots (per-dataset) the system can sustain`,description:`Returns a maximum amount of snapshots (per-dataset) the system can sustain.`,method:`POST`,route:`/pool.snapshottask.max_count`,params:[],hidden:!1,deprecated:!1,rpc:{method:`pool.snapshottask.max_count`,params:[],job:!1,defaults:{}}},{path:[`pool`,`snapshottask`,`max-total-count`],summary:`Returns a maximum amount of snapshots (total) the system can sustain`,description:`Returns a maximum amount of snapshots (total) the system can sustain.`,method:`POST`,route:`/pool.snapshottask.max_total_count`,params:[],hidden:!1,deprecated:!1,rpc:{method:`pool.snapshottask.max_total_count`,params:[],job:!1,defaults:{}}},{path:[`pool`,`snapshottask`,`query`],summary:``,description:``,method:`POST`,route:`/pool.snapshottask.query`,params:[],body:{required:!1,description:``,fields:[{wireName:`filters`,flag:`filters`,required:!1,description:`List of filters for query results. See API documentation for "Query Methods" for more guidance.`,type:{kind:`array`,elem:{kind:`json`}}},{wireName:`options`,flag:`options`,required:!1,description:`Query options including pagination, ordering, and additional parameters.`,type:{kind:`json`}}]},hidden:!1,deprecated:!1,rpc:{method:`pool.snapshottask.query`,params:[`filters`,`options`],job:!1,defaults:{filters:[],options:{extra:{},order_by:[],select:[],count:!1,get:!1,offset:0,limit:0,force_sql_filters:!1}}}},{path:[`pool`,`snapshottask`,`run`],summary:"Execute a Periodic Snapshot Task of ``id``",description:"Execute a Periodic Snapshot Task of ``id``.",method:`POST`,route:`/pool.snapshottask.run`,params:[],body:{required:!0,description:``,fields:[{wireName:`id`,flag:`id`,required:!0,description:`ID of the periodic snapshot task to run immediately.`,type:{kind:`integer`}}]},hidden:!1,deprecated:!1,rpc:{method:`pool.snapshottask.run`,params:[`id`],job:!0,defaults:{}}},{path:[`pool`,`snapshottask`,`update`],summary:"Update a Periodic Snapshot Task with specific ``id``",description:"Update a Periodic Snapshot Task with specific ``id``.",method:`POST`,route:`/pool.snapshottask.update`,params:[],body:{required:!0,description:``,fields:[{wireName:`id`,flag:`id`,required:!0,description:`ID of the periodic snapshot task to update.`,type:{kind:`integer`}},{wireName:`data`,flag:`data`,required:!0,description:`Updated configuration for the periodic snapshot task.`,type:{kind:`json`}}]},hidden:!1,deprecated:!1,rpc:{method:`pool.snapshottask.update`,params:[`id`,`data`],job:!1,defaults:{}}},{path:[`pool`,`snapshottask`,`update-will-change-retention-for`],summary:"Returns a list of snapshots which will change the retention if periodic snapshot task ``id`` is updated with ``data``",description:"Returns a list of snapshots which will change the retention if periodic snapshot task ``id`` is updated with ``data``.",method:`POST`,route:`/pool.snapshottask.update_will_change_retention_for`,params:[],body:{required:!0,description:``,fields:[{wireName:`id`,flag:`id`,required:!0,description:`ID of the periodic snapshot task to analyze.`,type:{kind:`integer`}},{wireName:`data`,flag:`data`,required:!0,description:`Proposed configuration changes to analyze.`,type:{kind:`json`}}]},hidden:!1,deprecated:!1,rpc:{method:`pool.snapshottask.update_will_change_retention_for`,params:[`id`,`data`],job:!1,defaults:{}}},{path:[`privilege`,`create`],summary:`Create a privilege`,description:`Create a privilege.`,method:`POST`,route:`/privilege.create`,params:[],body:{required:!0,description:``,fields:[{wireName:`privilege_create`,flag:`privilege-create`,required:!0,description:`Configuration for creating a new privilege.`,type:{kind:`json`}}]},hidden:!1,deprecated:!1,rpc:{method:`privilege.create`,params:[`privilege_create`],job:!1,defaults:{}}},{path:[`privilege`,`delete`],summary:"Delete the privilege ``id``",description:"Delete the privilege ``id``.",method:`POST`,route:`/privilege.delete`,params:[],body:{required:!0,description:``,fields:[{wireName:`id`,flag:`id`,required:!0,description:`ID of the privilege to delete.`,type:{kind:`integer`}}]},confirmation:``,hidden:!1,deprecated:!1,rpc:{method:`privilege.delete`,params:[`id`],job:!1,defaults:{}}},{path:[`privilege`,`get-instance`],summary:"Returns instance matching `id`",description:"Returns instance matching `id`. If `id` is not found, Validation error is raised.",method:`POST`,route:`/privilege.get_instance`,params:[],body:{required:!0,description:``,fields:[{wireName:`id`,flag:`id`,required:!0,description:``,type:{kind:`integer`}},{wireName:`options`,flag:`options`,required:!0,description:`Query options customize the results returned by a query method. More complete documentation with examples are covered in the "Query methods" section of the TrueNAS API documentation.`,type:{kind:`json`}}]},hidden:!1,deprecated:!1,rpc:{method:`privilege.get_instance`,params:[`id`,`options`],job:!1,defaults:{}}},{path:[`privilege`,`query`],summary:``,description:``,method:`POST`,route:`/privilege.query`,params:[],body:{required:!1,description:``,fields:[{wireName:`filters`,flag:`filters`,required:!1,description:`List of filters for query results. See API documentation for "Query Methods" for more guidance.`,type:{kind:`array`,elem:{kind:`json`}}},{wireName:`options`,flag:`options`,required:!1,description:`Query options including pagination, ordering, and additional parameters.`,type:{kind:`json`}}]},hidden:!1,deprecated:!1,rpc:{method:`privilege.query`,params:[`filters`,`options`],job:!1,defaults:{filters:[],options:{extra:{},order_by:[],select:[],count:!1,get:!1,offset:0,limit:0,force_sql_filters:!1}}}},{path:[`privilege`,`roles`],summary:`Get all available roles`,description:`Get all available roles.`,method:`POST`,route:`/privilege.roles`,params:[],body:{required:!1,description:``,fields:[{wireName:`filters`,flag:`filters`,required:!1,description:`List of filters for query results. See API documentation for "Query Methods" for more guidance.`,type:{kind:`array`,elem:{kind:`json`}}},{wireName:`options`,flag:`options`,required:!1,description:`Query options including pagination, ordering, and additional parameters.`,type:{kind:`json`}}]},hidden:!1,deprecated:!1,rpc:{method:`privilege.roles`,params:[`filters`,`options`],job:!1,defaults:{filters:[],options:{extra:{},order_by:[],select:[],count:!1,get:!1,offset:0,limit:0,force_sql_filters:!1}}}},{path:[`privilege`,`update`],summary:"Update the privilege ``id``",description:"Update the privilege ``id``.",method:`POST`,route:`/privilege.update`,params:[],body:{required:!0,description:``,fields:[{wireName:`id`,flag:`id`,required:!0,description:`ID of the privilege to update.`,type:{kind:`integer`}},{wireName:`privilege_update`,flag:`privilege-update`,required:!0,description:`Updated configuration for the privilege.`,type:{kind:`json`}}]},hidden:!1,deprecated:!1,rpc:{method:`privilege.update`,params:[`id`,`privilege_update`],job:!1,defaults:{}}},{path:[`rdma`,`capable-protocols`],summary:`Return the list of RDMA-capable protocols supported by this system`,description:`Return the list of RDMA-capable protocols supported by this system.`,method:`POST`,route:`/rdma.capable_protocols`,params:[],hidden:!1,deprecated:!1,rpc:{method:`rdma.capable_protocols`,params:[],job:!1,defaults:{}}},{path:[`rdma`,`get-card-choices`],summary:`Return an array containing details about each RDMA card`,description:`Return an array containing details about each RDMA card. Dual cards will contain two RDMA links.`,method:`POST`,route:`/rdma.get_card_choices`,params:[],hidden:!1,deprecated:!1,rpc:{method:`rdma.get_card_choices`,params:[],job:!1,defaults:{}}},{path:[`replication`,`count-eligible-manual-snapshots`],summary:"Count how many existing snapshots of ``dataset`` match ``naming_schema``",description:"Count how many existing snapshots of ``dataset`` match ``naming_schema``.",method:`POST`,route:`/replication.count_eligible_manual_snapshots`,params:[],body:{required:!0,description:``,fields:[{wireName:`count_eligible_manual_snapshots`,flag:`count-eligible-manual-snapshots`,required:!0,description:`ReplicationCountEligibleManualSnapshotsArgs parameters.`,type:{kind:`json`}}]},hidden:!1,deprecated:!1,rpc:{method:`replication.count_eligible_manual_snapshots`,params:[`count_eligible_manual_snapshots`],job:!1,defaults:{}}},{path:[`replication`,`create`],summary:`Create a Replication Task that will push or pull ZFS snapshots to or from remote host`,description:`Create a Replication Task that will push or pull ZFS snapshots to or from remote host.`,method:`POST`,route:`/replication.create`,params:[],body:{required:!0,description:``,fields:[{wireName:`replication_create`,flag:`replication-create`,required:!0,description:`Configuration for creating a new replication task.`,type:{kind:`json`}}]},hidden:!1,deprecated:!1,rpc:{method:`replication.create`,params:[`replication_create`],job:!1,defaults:{}}},{path:[`replication`,`create-dataset`],summary:`Creates dataset on remote side`,description:`Creates dataset on remote side.`,method:`POST`,route:`/replication.create_dataset`,params:[],body:{required:!0,description:``,fields:[{wireName:`dataset`,flag:`dataset`,required:!0,description:`Name of the dataset to create.`,type:{kind:`string`}},{wireName:`transport`,flag:`transport`,required:!0,description:`Transport method to use for dataset creation.`,type:{kind:`enum`,values:[`SSH`,`SSH+NETCAT`,`LOCAL`]}},{wireName:`ssh_credentials`,flag:`ssh-credentials`,required:!1,description:"Keychain credential ID for SSH access. `null` for local transport.",type:{kind:`integer`}}]},hidden:!1,deprecated:!1,rpc:{method:`replication.create_dataset`,params:[`dataset`,`transport`,`ssh_credentials`],job:!1,defaults:{ssh_credentials:null}}},{path:[`replication`,`delete`],summary:"Delete a replication task with the given ``id``",description:"Delete a replication task with the given ``id``.",method:`POST`,route:`/replication.delete`,params:[],body:{required:!0,description:``,fields:[{wireName:`id`,flag:`id`,required:!0,description:`ID of the replication task to delete.`,type:{kind:`integer`}}]},confirmation:``,hidden:!1,deprecated:!1,rpc:{method:`replication.delete`,params:[`id`],job:!1,defaults:{}}},{path:[`replication`,`get-instance`],summary:"Returns instance matching `id`",description:"Returns instance matching `id`. If `id` is not found, Validation error is raised.",method:`POST`,route:`/replication.get_instance`,params:[],body:{required:!0,description:``,fields:[{wireName:`id`,flag:`id`,required:!0,description:``,type:{kind:`integer`}},{wireName:`options`,flag:`options`,required:!0,description:`Query options customize the results returned by a query method. More complete documentation with examples are covered in the "Query methods" section of the TrueNAS API documentation.`,type:{kind:`json`}}]},hidden:!1,deprecated:!1,rpc:{method:`replication.get_instance`,params:[`id`,`options`],job:!1,defaults:{}}},{path:[`replication`,`list-datasets`],summary:`List datasets on remote side`,description:`List datasets on remote side.`,method:`POST`,route:`/replication.list_datasets`,params:[],body:{required:!0,description:``,fields:[{wireName:`transport`,flag:`transport`,required:!0,description:`Transport method to use for listing datasets.`,type:{kind:`enum`,values:[`SSH`,`SSH+NETCAT`,`LOCAL`]}},{wireName:`ssh_credentials`,flag:`ssh-credentials`,required:!1,description:"Keychain credential ID for SSH access. `null` for local transport.",type:{kind:`integer`}}]},hidden:!1,deprecated:!1,rpc:{method:`replication.list_datasets`,params:[`transport`,`ssh_credentials`],job:!1,defaults:{ssh_credentials:null}}},{path:[`replication`,`list-naming-schemas`],summary:`List all naming schemas used in periodic snapshot and replication tasks`,description:`List all naming schemas used in periodic snapshot and replication tasks.`,method:`POST`,route:`/replication.list_naming_schemas`,params:[],hidden:!1,deprecated:!1,rpc:{method:`replication.list_naming_schemas`,params:[],job:!1,defaults:{}}},{path:[`replication`,`query`],summary:``,description:``,method:`POST`,route:`/replication.query`,params:[],body:{required:!1,description:``,fields:[{wireName:`filters`,flag:`filters`,required:!1,description:`List of filters for query results. See API documentation for "Query Methods" for more guidance.`,type:{kind:`array`,elem:{kind:`json`}}},{wireName:`options`,flag:`options`,required:!1,description:`Query options including pagination, ordering, and additional parameters.`,type:{kind:`json`}}]},hidden:!1,deprecated:!1,rpc:{method:`replication.query`,params:[`filters`,`options`],job:!1,defaults:{filters:[],options:{extra:{},order_by:[],select:[],count:!1,get:!1,offset:0,limit:0,force_sql_filters:!1}}}},{path:[`replication`,`restore`],summary:"Create the opposite of replication task ``id`` (PULL if it was PUSH and vice versa)",description:"Create the opposite of replication task ``id`` (PULL if it was PUSH and vice versa).",method:`POST`,route:`/replication.restore`,params:[],body:{required:!0,description:``,fields:[{wireName:`id`,flag:`id`,required:!0,description:`ID of the replication task to restore.`,type:{kind:`integer`}},{wireName:`replication_restore`,flag:`replication-restore`,required:!0,description:`Configuration options for restoring the replication task.`,type:{kind:`json`}}]},hidden:!1,deprecated:!1,rpc:{method:`replication.restore`,params:[`id`,`replication_restore`],job:!1,defaults:{}}},{path:[`replication`,`run`],summary:"Run Replication Task of ``id``",description:"Run Replication Task of ``id``.",method:`POST`,route:`/replication.run`,params:[],body:{required:!0,description:``,fields:[{wireName:`id`,flag:`id`,required:!0,description:`ID of the replication task to run.`,type:{kind:`integer`}}]},hidden:!1,deprecated:!1,rpc:{method:`replication.run`,params:[`id`],job:!0,defaults:{}}},{path:[`replication`,`run-onetime`],summary:`Run replication task without creating it`,description:`Run replication task without creating it.`,method:`POST`,route:`/replication.run_onetime`,params:[],body:{required:!0,description:``,fields:[{wireName:`replication_run_onetime`,flag:`replication-run-onetime`,required:!0,description:`ReplicationRunOnetimeArgs parameters.`,type:{kind:`json`}}]},hidden:!1,deprecated:!1,rpc:{method:`replication.run_onetime`,params:[`replication_run_onetime`],job:!0,defaults:{}}},{path:[`replication`,`target-unmatched-snapshots`],summary:`Check if target has any snapshots that do not exist on source`,description:`Check if target has any snapshots that do not exist on source. Returns these snapshots grouped by dataset.`,method:`POST`,route:`/replication.target_unmatched_snapshots`,params:[],body:{required:!0,description:``,fields:[{wireName:`direction`,flag:`direction`,required:!0,description:`Direction of replication to check for unmatched snapshots.`,type:{kind:`enum`,values:[`PUSH`,`PULL`]}},{wireName:`source_datasets`,flag:`source-datasets`,required:!0,description:`Array of source dataset names.`,type:{kind:`array`,elem:{kind:`string`}}},{wireName:`target_dataset`,flag:`target-dataset`,required:!0,description:`Target dataset name to check for unmatched snapshots.`,type:{kind:`string`}},{wireName:`transport`,flag:`transport`,required:!0,description:`Transport method to use for accessing snapshots.`,type:{kind:`enum`,values:[`SSH`,`SSH+NETCAT`,`LOCAL`]}},{wireName:`ssh_credentials`,flag:`ssh-credentials`,required:!1,description:"Keychain credential ID for SSH access. `null` for local transport.",type:{kind:`integer`}}]},hidden:!1,deprecated:!1,rpc:{method:`replication.target_unmatched_snapshots`,params:[`direction`,`source_datasets`,`target_dataset`,`transport`,`ssh_credentials`],job:!1,defaults:{ssh_credentials:null}}},{path:[`replication`,`update`],summary:"Update a Replication Task with specific ``id``",description:"Update a Replication Task with specific ``id``.",method:`POST`,route:`/replication.update`,params:[],body:{required:!0,description:``,fields:[{wireName:`id`,flag:`id`,required:!0,description:`ID of the replication task to update.`,type:{kind:`integer`}},{wireName:`replication_update`,flag:`replication-update`,required:!0,description:`Updated configuration for the replication task.`,type:{kind:`json`}}]},hidden:!1,deprecated:!1,rpc:{method:`replication.update`,params:[`id`,`replication_update`],job:!1,defaults:{}}},{path:[`replication`,`config`,`config`],summary:``,description:``,method:`POST`,route:`/replication.config.config`,params:[],hidden:!1,deprecated:!1,rpc:{method:`replication.config.config`,params:[],job:!1,defaults:{}}},{path:[`replication`,`config`,`update`],summary:`Update the global replication configuration shared by all replication tasks`,description:`Update the global replication configuration shared by all replication tasks.`,method:`POST`,route:`/replication.config.update`,params:[],body:{required:!0,description:``,fields:[{wireName:`replication_config_update`,flag:`replication-config-update`,required:!0,description:`ReplicationConfigUpdateArgs parameters.`,type:{kind:`json`}}]},hidden:!1,deprecated:!1,rpc:{method:`replication.config.update`,params:[`replication_config_update`],job:!1,defaults:{}}},{path:[`reporting`,`config`],summary:``,description:``,method:`POST`,route:`/reporting.config`,params:[],hidden:!1,deprecated:!1,rpc:{method:`reporting.config`,params:[],job:!1,defaults:{}}},{path:[`reporting`,`get-data`],summary:`Get reporting data for given graphs`,description:`Get reporting data for given graphs.`,method:`POST`,route:`/reporting.get_data`,params:[],body:{required:!0,description:``,fields:[{wireName:`graphs`,flag:`graphs`,required:!0,description:`Array of graph identifiers specifying which metrics to retrieve.`,type:{kind:`array`,elem:{kind:`json`}}},{wireName:`query`,flag:`query`,required:!0,description:`Query parameters for filtering and formatting the returned data.`,type:{kind:`json`}}]},hidden:!1,deprecated:!1,rpc:{method:`reporting.get_data`,params:[`graphs`,`query`],job:!1,defaults:{}}},{path:[`reporting`,`graph`],summary:"Get reporting data for ``name`` graph",description:"Get reporting data for ``name`` graph.",method:`POST`,route:`/reporting.graph`,params:[],body:{required:!0,description:``,fields:[{wireName:`str`,flag:`str`,required:!0,description:`String identifier for the specific graph to retrieve.`,type:{kind:`string`}},{wireName:`query`,flag:`query`,required:!0,description:`Query parameters for filtering and formatting the returned data.`,type:{kind:`json`}}]},hidden:!1,deprecated:!1,rpc:{method:`reporting.graph`,params:[`str`,`query`],job:!1,defaults:{}}},{path:[`reporting`,`graphs`],summary:`List the reporting graphs available to be queried, each describing a metric type along with the instance identifiers (if any) that can be reported on`,description:"List the reporting graphs available to be queried, each describing a metric type along with the instance identifiers (if any) that can be reported on. Pass the resulting graph names to :doc:`reporting.get_data <api_methods_reporting.get_data>` to retrieve the corresponding data points.",method:`POST`,route:`/reporting.graphs`,params:[],body:{required:!1,description:``,fields:[{wireName:`filters`,flag:`filters`,required:!1,description:`List of filters for query results. See API documentation for "Query Methods" for more guidance.`,type:{kind:`array`,elem:{kind:`json`}}},{wireName:`options`,flag:`options`,required:!1,description:`Query options including pagination, ordering, and additional parameters.`,type:{kind:`json`}}]},hidden:!1,deprecated:!1,rpc:{method:`reporting.graphs`,params:[`filters`,`options`],job:!1,defaults:{filters:[],options:{extra:{},order_by:[],select:[],count:!1,get:!1,offset:0,limit:0,force_sql_filters:!1}}}},{path:[`reporting`,`netdata-get-data`],summary:`Get reporting data for given graphs`,description:`Get reporting data for given graphs.`,method:`POST`,route:`/reporting.netdata_get_data`,params:[],body:{required:!0,description:``,fields:[{wireName:`graphs`,flag:`graphs`,required:!0,description:`Array of graph identifiers specifying which metrics to retrieve.`,type:{kind:`array`,elem:{kind:`json`}}},{wireName:`query`,flag:`query`,required:!0,description:`Query parameters for filtering and formatting the returned data.`,type:{kind:`json`}}]},hidden:!1,deprecated:!1,rpc:{method:`reporting.netdata_get_data`,params:[`graphs`,`query`],job:!1,defaults:{}}},{path:[`reporting`,`netdata-graph`],summary:"Get reporting data for ``name`` graph",description:"Get reporting data for ``name`` graph.",method:`POST`,route:`/reporting.netdata_graph`,params:[],body:{required:!0,description:``,fields:[{wireName:`str`,flag:`str`,required:!0,description:`String identifier for the specific graph to retrieve.`,type:{kind:`string`}},{wireName:`query`,flag:`query`,required:!0,description:`Query parameters for filtering and formatting the returned data.`,type:{kind:`json`}}]},hidden:!1,deprecated:!1,rpc:{method:`reporting.netdata_graph`,params:[`str`,`query`],job:!1,defaults:{}}},{path:[`reporting`,`netdata-graphs`],summary:`Get reporting netdata graphs`,description:`Get reporting netdata graphs.`,method:`POST`,route:`/reporting.netdata_graphs`,params:[],body:{required:!1,description:``,fields:[{wireName:`filters`,flag:`filters`,required:!1,description:`List of filters for query results. See API documentation for "Query Methods" for more guidance.`,type:{kind:`array`,elem:{kind:`json`}}},{wireName:`options`,flag:`options`,required:!1,description:`Query options including pagination, ordering, and additional parameters.`,type:{kind:`json`}}]},hidden:!1,deprecated:!1,rpc:{method:`reporting.netdata_graphs`,params:[`filters`,`options`],job:!1,defaults:{filters:[],options:{extra:{},order_by:[],select:[],count:!1,get:!1,offset:0,limit:0,force_sql_filters:!1}}}},{path:[`reporting`,`update`],summary:`Update reporting configuration settings`,description:`Update reporting configuration settings.`,method:`POST`,route:`/reporting.update`,params:[],body:{required:!0,description:``,fields:[{wireName:`reporting_update`,flag:`reporting-update`,required:!0,description:`ReportingUpdateArgs parameters.`,type:{kind:`json`}}]},hidden:!1,deprecated:!1,rpc:{method:`reporting.update`,params:[`reporting_update`],job:!1,defaults:{}}},{path:[`reporting`,`exporters`,`create`],summary:`Create a specific reporting exporter configuration containing required details for exporting reporting metrics`,description:`Create a specific reporting exporter configuration containing required details for exporting reporting metrics.`,method:`POST`,route:`/reporting.exporters.create`,params:[],body:{required:!0,description:``,fields:[{wireName:`reporting_exporter_create`,flag:`reporting-exporter-create`,required:!0,description:`ReportingExportsCreateArgs parameters.`,type:{kind:`json`}}]},hidden:!1,deprecated:!1,rpc:{method:`reporting.exporters.create`,params:[`reporting_exporter_create`],job:!1,defaults:{}}},{path:[`reporting`,`exporters`,`delete`],summary:"Delete Reporting Exporter of ``id``",description:"Delete Reporting Exporter of ``id``.",method:`POST`,route:`/reporting.exporters.delete`,params:[],body:{required:!0,description:``,fields:[{wireName:`id`,flag:`id`,required:!0,description:`ID of the reporting exporter to delete.`,type:{kind:`integer`}}]},confirmation:``,hidden:!1,deprecated:!1,rpc:{method:`reporting.exporters.delete`,params:[`id`],job:!1,defaults:{}}},{path:[`reporting`,`exporters`,`exporter-schemas`],summary:`Get the schemas for all the reporting export types we support with their respective attributes required for successfully exporting reporting metrics to them`,description:`Get the schemas for all the reporting export types we support with their respective attributes required for successfully exporting reporting metrics to them.`,method:`POST`,route:`/reporting.exporters.exporter_schemas`,params:[],hidden:!1,deprecated:!1,rpc:{method:`reporting.exporters.exporter_schemas`,params:[],job:!1,defaults:{}}},{path:[`reporting`,`exporters`,`get-instance`],summary:"Returns instance matching `id`",description:"Returns instance matching `id`. If `id` is not found, Validation error is raised.",method:`POST`,route:`/reporting.exporters.get_instance`,params:[],body:{required:!0,description:``,fields:[{wireName:`id`,flag:`id`,required:!0,description:``,type:{kind:`integer`}},{wireName:`options`,flag:`options`,required:!0,description:`Query options customize the results returned by a query method. More complete documentation with examples are covered in the "Query methods" section of the TrueNAS API documentation.`,type:{kind:`json`}}]},hidden:!1,deprecated:!1,rpc:{method:`reporting.exporters.get_instance`,params:[`id`,`options`],job:!1,defaults:{}}},{path:[`reporting`,`exporters`,`query`],summary:``,description:``,method:`POST`,route:`/reporting.exporters.query`,params:[],body:{required:!1,description:``,fields:[{wireName:`filters`,flag:`filters`,required:!1,description:`List of filters for query results. See API documentation for "Query Methods" for more guidance.`,type:{kind:`array`,elem:{kind:`json`}}},{wireName:`options`,flag:`options`,required:!1,description:`Query options including pagination, ordering, and additional parameters.`,type:{kind:`json`}}]},hidden:!1,deprecated:!1,rpc:{method:`reporting.exporters.query`,params:[`filters`,`options`],job:!1,defaults:{filters:[],options:{extra:{},order_by:[],select:[],count:!1,get:!1,offset:0,limit:0,force_sql_filters:!1}}}},{path:[`reporting`,`exporters`,`update`],summary:"Update Reporting Exporter of ``id``",description:"Update Reporting Exporter of ``id``.",method:`POST`,route:`/reporting.exporters.update`,params:[],body:{required:!0,description:``,fields:[{wireName:`id`,flag:`id`,required:!0,description:`ID of the reporting exporter to update.`,type:{kind:`integer`}},{wireName:`reporting_exporter_update`,flag:`reporting-exporter-update`,required:!0,description:`Updated configuration for the reporting exporter.`,type:{kind:`json`}}]},hidden:!1,deprecated:!1,rpc:{method:`reporting.exporters.update`,params:[`id`,`reporting_exporter_update`],job:!1,defaults:{}}},{path:[`route`,`ipv4gw-reachable`],summary:`Get the IPv4 gateway and verify if it is reachable by any interface`,description:`Get the IPv4 gateway and verify if it is reachable by any interface.`,method:`POST`,route:`/route.ipv4gw_reachable`,params:[],body:{required:!0,description:``,fields:[{wireName:`ipv4_gateway`,flag:`ipv4-gateway`,required:!0,description:`IPv4 gateway address to test for reachability.`,type:{kind:`string`}}]},hidden:!1,deprecated:!1,rpc:{method:`route.ipv4gw_reachable`,params:[`ipv4_gateway`],job:!1,defaults:{}}},{path:[`route`,`system-routes`],summary:`Query IPv4 and IPv6 routes from the kernel's main routing table`,description:`Query IPv4 and IPv6 routes from the kernel's main routing table.`,method:`POST`,route:`/route.system_routes`,params:[],body:{required:!1,description:``,fields:[{wireName:`filters`,flag:`filters`,required:!1,description:`List of filters for query results. See API documentation for "Query Methods" for more guidance.`,type:{kind:`array`,elem:{kind:`json`}}},{wireName:`options`,flag:`options`,required:!1,description:`Query options including pagination, ordering, and additional parameters.`,type:{kind:`json`}}]},hidden:!1,deprecated:!1,rpc:{method:`route.system_routes`,params:[`filters`,`options`],job:!1,defaults:{filters:[],options:{extra:{},order_by:[],select:[],count:!1,get:!1,offset:0,limit:0,force_sql_filters:!1}}}},{path:[`rsynctask`,`create`],summary:`Create a Rsync Task`,description:`Create a Rsync Task.`,method:`POST`,route:`/rsynctask.create`,params:[],body:{required:!0,description:``,fields:[{wireName:`rsync_task_create`,flag:`rsync-task-create`,required:!0,description:`Configuration for creating a new rsync task.`,type:{kind:`json`}}]},hidden:!1,deprecated:!1,rpc:{method:`rsynctask.create`,params:[`rsync_task_create`],job:!1,defaults:{}}},{path:[`rsynctask`,`delete`],summary:"Delete Rsync Task of ``id``",description:"Delete Rsync Task of ``id``.",method:`POST`,route:`/rsynctask.delete`,params:[],body:{required:!0,description:``,fields:[{wireName:`id`,flag:`id`,required:!0,description:`ID of the rsync task to delete.`,type:{kind:`integer`}}]},confirmation:``,hidden:!1,deprecated:!1,rpc:{method:`rsynctask.delete`,params:[`id`],job:!1,defaults:{}}},{path:[`rsynctask`,`get-instance`],summary:"Returns instance matching `id`",description:"Returns instance matching `id`. If `id` is not found, Validation error is raised.",method:`POST`,route:`/rsynctask.get_instance`,params:[],body:{required:!0,description:``,fields:[{wireName:`id`,flag:`id`,required:!0,description:``,type:{kind:`integer`}},{wireName:`options`,flag:`options`,required:!0,description:`Query options customize the results returned by a query method. More complete documentation with examples are covered in the "Query methods" section of the TrueNAS API documentation.`,type:{kind:`json`}}]},hidden:!1,deprecated:!1,rpc:{method:`rsynctask.get_instance`,params:[`id`,`options`],job:!1,defaults:{}}},{path:[`rsynctask`,`query`],summary:``,description:``,method:`POST`,route:`/rsynctask.query`,params:[],body:{required:!1,description:``,fields:[{wireName:`filters`,flag:`filters`,required:!1,description:`List of filters for query results. See API documentation for "Query Methods" for more guidance.`,type:{kind:`array`,elem:{kind:`json`}}},{wireName:`options`,flag:`options`,required:!1,description:`Query options including pagination, ordering, and additional parameters.`,type:{kind:`json`}}]},hidden:!1,deprecated:!1,rpc:{method:`rsynctask.query`,params:[`filters`,`options`],job:!1,defaults:{filters:[],options:{extra:{},order_by:[],select:[],count:!1,get:!1,offset:0,limit:0,force_sql_filters:!1}}}},{path:[`rsynctask`,`run`],summary:"Job to run rsync task of ``id``",description:"Job to run rsync task of ``id``. Output is saved to the job log excerpt (not syslog).",method:`POST`,route:`/rsynctask.run`,params:[],body:{required:!0,description:``,fields:[{wireName:`id`,flag:`id`,required:!0,description:`ID of the rsync task to run immediately.`,type:{kind:`integer`}}]},hidden:!1,deprecated:!1,rpc:{method:`rsynctask.run`,params:[`id`],job:!0,defaults:{}}},{path:[`rsynctask`,`update`],summary:"Update Rsync Task of ``id``",description:"Update Rsync Task of ``id``.",method:`POST`,route:`/rsynctask.update`,params:[],body:{required:!0,description:``,fields:[{wireName:`id`,flag:`id`,required:!0,description:`ID of the rsync task to update.`,type:{kind:`integer`}},{wireName:`rsync_task_update`,flag:`rsync-task-update`,required:!0,description:`Updated configuration for the rsync task.`,type:{kind:`json`}}]},hidden:!1,deprecated:!1,rpc:{method:`rsynctask.update`,params:[`id`,`rsync_task_update`],job:!1,defaults:{}}},{path:[`service`,`control`],summary:"Perform the control operation given by ``verb`` (``START``, ``STOP``, ``RESTART``, or ``RELOAD``) on the system service named ``service``",description:"Perform the control operation given by ``verb`` (``START``, ``STOP``, ``RESTART``, or ``RELOAD``) on the system service named ``service``. This is the general entry point for managing the running state of a service; the configured enable-on-boot setting is changed separately via :doc:`service.update <api_methods_service.update>`.",method:`POST`,route:`/service.control`,params:[],body:{required:!0,description:``,fields:[{wireName:`verb`,flag:`verb`,required:!0,description:`The service operation to perform.`,type:{kind:`enum`,values:[`START`,`STOP`,`RESTART`,`RELOAD`]}},{wireName:`service`,flag:`service`,required:!0,description:`Name of the service to control.`,type:{kind:`string`}},{wireName:`options`,flag:`options`,required:!0,description:`Options for controlling the service operation behavior.`,type:{kind:`json`}}]},hidden:!1,deprecated:!1,rpc:{method:`service.control`,params:[`verb`,`service`,`options`],job:!0,defaults:{}}},{path:[`service`,`get-instance`],summary:"Returns instance matching `id`",description:"Returns instance matching `id`. If `id` is not found, Validation error is raised.",method:`POST`,route:`/service.get_instance`,params:[],body:{required:!0,description:``,fields:[{wireName:`id`,flag:`id`,required:!0,description:``,type:{kind:`integer`}},{wireName:`options`,flag:`options`,required:!0,description:`Query options customize the results returned by a query method. More complete documentation with examples are covered in the "Query methods" section of the TrueNAS API documentation.`,type:{kind:`json`}}]},hidden:!1,deprecated:!1,rpc:{method:`service.get_instance`,params:[`id`,`options`],job:!1,defaults:{}}},{path:[`service`,`query`],summary:"Query all system services with ``query-filters`` and ``query-options``",description:"Query all system services with ``query-filters`` and ``query-options``.",method:`POST`,route:`/service.query`,params:[],body:{required:!1,description:``,fields:[{wireName:`filters`,flag:`filters`,required:!1,description:`List of filters for query results. See API documentation for "Query Methods" for more guidance.`,type:{kind:`array`,elem:{kind:`json`}}},{wireName:`options`,flag:`options`,required:!1,description:`Query options including pagination, ordering, and additional parameters.`,type:{kind:`json`}}]},hidden:!1,deprecated:!1,rpc:{method:`service.query`,params:[`filters`,`options`],job:!1,defaults:{filters:[],options:{extra:{},order_by:[],select:[],count:!1,get:!1,offset:0,limit:0,force_sql_filters:!1}}}},{path:[`service`,`reload`],summary:"Reload the service specified by ``service``",description:"Reload the service specified by ``service``.",method:`POST`,route:`/service.reload`,params:[],body:{required:!0,description:``,fields:[{wireName:`service`,flag:`service`,required:!0,description:`Name of the service to reload.`,type:{kind:`string`}},{wireName:`options`,flag:`options`,required:!0,description:`Options for controlling the reload operation behavior.`,type:{kind:`json`}}]},hidden:!1,deprecated:!1,rpc:{method:`service.reload`,params:[`service`,`options`],job:!1,defaults:{}}},{path:[`service`,`restart`],summary:"Restart the service specified by ``service``",description:"Restart the service specified by ``service``.",method:`POST`,route:`/service.restart`,params:[],body:{required:!0,description:``,fields:[{wireName:`service`,flag:`service`,required:!0,description:`Name of the service to restart.`,type:{kind:`string`}},{wireName:`options`,flag:`options`,required:!0,description:`Options for controlling the restart operation behavior.`,type:{kind:`json`}}]},hidden:!1,deprecated:!1,rpc:{method:`service.restart`,params:[`service`,`options`],job:!1,defaults:{}}},{path:[`service`,`start`],summary:"Start the service specified by ``service``",description:"Start the service specified by ``service``.",method:`POST`,route:`/service.start`,params:[],body:{required:!0,description:``,fields:[{wireName:`service`,flag:`service`,required:!0,description:`Name of the service to start.`,type:{kind:`string`}},{wireName:`options`,flag:`options`,required:!0,description:`Options for controlling the start operation behavior.`,type:{kind:`json`}}]},hidden:!1,deprecated:!1,rpc:{method:`service.start`,params:[`service`,`options`],job:!1,defaults:{}}},{path:[`service`,`started`],summary:"Test if service specified by ``service`` has been started",description:"Test if service specified by ``service`` has been started.",method:`POST`,route:`/service.started`,params:[],body:{required:!0,description:``,fields:[{wireName:`service`,flag:`service`,required:!0,description:`Name of the service to check if running.`,type:{kind:`string`}}]},hidden:!1,deprecated:!1,rpc:{method:`service.started`,params:[`service`],job:!1,defaults:{}}},{path:[`service`,`started-or-enabled`],summary:"Test if service specified by ``service`` is started or enabled to start automatically",description:"Test if service specified by ``service`` is started or enabled to start automatically.",method:`POST`,route:`/service.started_or_enabled`,params:[],body:{required:!0,description:``,fields:[{wireName:`service`,flag:`service`,required:!0,description:`Name of the service to check if running or enabled.`,type:{kind:`string`}}]},hidden:!1,deprecated:!1,rpc:{method:`service.started_or_enabled`,params:[`service`],job:!1,defaults:{}}},{path:[`service`,`stop`],summary:"Stop the service specified by ``service``",description:"Stop the service specified by ``service``.",method:`POST`,route:`/service.stop`,params:[],body:{required:!0,description:``,fields:[{wireName:`service`,flag:`service`,required:!0,description:`Name of the service to stop.`,type:{kind:`string`}},{wireName:`options`,flag:`options`,required:!0,description:`Options for controlling the stop operation behavior.`,type:{kind:`json`}}]},hidden:!1,deprecated:!1,rpc:{method:`service.stop`,params:[`service`,`options`],job:!1,defaults:{}}},{path:[`service`,`update`],summary:"Update service entry of ``id_or_name``",description:"Update service entry of ``id_or_name``.",method:`POST`,route:`/service.update`,params:[],body:{required:!0,description:``,fields:[{wireName:`id_or_name`,flag:`id-or-name`,required:!0,description:`ID or name of the service to update.`,type:{kind:`json`}},{wireName:`service_update`,flag:`service-update`,required:!0,description:`Updated configuration for the service.`,type:{kind:`json`}}]},hidden:!1,deprecated:!1,rpc:{method:`service.update`,params:[`id_or_name`,`service_update`],job:!1,defaults:{}}},{path:[`sharing`,`nfs`,`create`],summary:`Create a NFS Share`,description:`Create a NFS Share.`,method:`POST`,route:`/sharing.nfs.create`,params:[],body:{required:!0,description:``,fields:[{wireName:`data`,flag:`data`,required:!0,description:`NFS share configuration data for the new share.`,type:{kind:`json`}}]},hidden:!1,deprecated:!1,rpc:{method:`sharing.nfs.create`,params:[`data`],job:!1,defaults:{}}},{path:[`sharing`,`nfs`,`delete`],summary:"Delete NFS Share of ``id``",description:"Delete NFS Share of ``id``.",method:`POST`,route:`/sharing.nfs.delete`,params:[],body:{required:!0,description:``,fields:[{wireName:`id`,flag:`id`,required:!0,description:`ID of the NFS share to delete.`,type:{kind:`integer`}}]},confirmation:``,hidden:!1,deprecated:!1,rpc:{method:`sharing.nfs.delete`,params:[`id`],job:!1,defaults:{}}},{path:[`sharing`,`nfs`,`get-instance`],summary:"Returns instance matching `id`",description:"Returns instance matching `id`. If `id` is not found, Validation error is raised.",method:`POST`,route:`/sharing.nfs.get_instance`,params:[],body:{required:!0,description:``,fields:[{wireName:`id`,flag:`id`,required:!0,description:``,type:{kind:`integer`}},{wireName:`options`,flag:`options`,required:!0,description:`Query options customize the results returned by a query method. More complete documentation with examples are covered in the "Query methods" section of the TrueNAS API documentation.`,type:{kind:`json`}}]},hidden:!1,deprecated:!1,rpc:{method:`sharing.nfs.get_instance`,params:[`id`,`options`],job:!1,defaults:{}}},{path:[`sharing`,`nfs`,`query`],summary:``,description:``,method:`POST`,route:`/sharing.nfs.query`,params:[],body:{required:!1,description:``,fields:[{wireName:`filters`,flag:`filters`,required:!1,description:`List of filters for query results. See API documentation for "Query Methods" for more guidance.`,type:{kind:`array`,elem:{kind:`json`}}},{wireName:`options`,flag:`options`,required:!1,description:`Query options including pagination, ordering, and additional parameters.`,type:{kind:`json`}}]},hidden:!1,deprecated:!1,rpc:{method:`sharing.nfs.query`,params:[`filters`,`options`],job:!1,defaults:{filters:[],options:{extra:{},order_by:[],select:[],count:!1,get:!1,offset:0,limit:0,force_sql_filters:!1}}}},{path:[`sharing`,`nfs`,`update`],summary:"Update NFS Share of ``id``",description:"Update NFS Share of ``id``.",method:`POST`,route:`/sharing.nfs.update`,params:[],body:{required:!0,description:``,fields:[{wireName:`id`,flag:`id`,required:!0,description:`ID of the NFS share to update.`,type:{kind:`integer`}},{wireName:`data`,flag:`data`,required:!0,description:`Updated NFS share configuration data.`,type:{kind:`json`}}]},hidden:!1,deprecated:!1,rpc:{method:`sharing.nfs.update`,params:[`id`,`data`],job:!1,defaults:{}}},{path:[`sharing`,`smb`,`create`],summary:`Create an SMB share`,description:`Create an SMB share.`,method:`POST`,route:`/sharing.smb.create`,params:[],body:{required:!0,description:``,fields:[{wireName:`data`,flag:`data`,required:!0,description:`SMB share configuration data for the new share.`,type:{kind:`json`}}]},hidden:!1,deprecated:!1,rpc:{method:`sharing.smb.create`,params:[`data`],job:!1,defaults:{}}},{path:[`sharing`,`smb`,`delete`],summary:"Delete SMB Share of ``id``",description:"Delete SMB Share of ``id``. This will forcibly disconnect SMB clients that are accessing the share.",method:`POST`,route:`/sharing.smb.delete`,params:[],body:{required:!0,description:``,fields:[{wireName:`id`,flag:`id`,required:!0,description:`ID of the SMB share to delete.`,type:{kind:`integer`}}]},confirmation:``,hidden:!1,deprecated:!1,rpc:{method:`sharing.smb.delete`,params:[`id`],job:!1,defaults:{}}},{path:[`sharing`,`smb`,`get-instance`],summary:"Returns instance matching `id`",description:"Returns instance matching `id`. If `id` is not found, Validation error is raised.",method:`POST`,route:`/sharing.smb.get_instance`,params:[],body:{required:!0,description:``,fields:[{wireName:`id`,flag:`id`,required:!0,description:``,type:{kind:`integer`}},{wireName:`options`,flag:`options`,required:!0,description:`Query options customize the results returned by a query method. More complete documentation with examples are covered in the "Query methods" section of the TrueNAS API documentation.`,type:{kind:`json`}}]},hidden:!1,deprecated:!1,rpc:{method:`sharing.smb.get_instance`,params:[`id`,`options`],job:!1,defaults:{}}},{path:[`sharing`,`smb`,`getacl`],summary:"Retrieve the share-level ACL for the SMB share named ``share_name``",description:"Retrieve the share-level ACL for the SMB share named ``share_name``.",method:`POST`,route:`/sharing.smb.getacl`,params:[],body:{required:!0,description:``,fields:[{wireName:`smb_getacl`,flag:`smb-getacl`,required:!0,description:`SharingSMBGetaclArgs parameters.`,type:{kind:`json`}}]},hidden:!1,deprecated:!1,rpc:{method:`sharing.smb.getacl`,params:[`smb_getacl`],job:!1,defaults:{}}},{path:[`sharing`,`smb`,`presets`],summary:`Retrieve pre-defined configuration sets for specific use-cases`,description:`Retrieve pre-defined configuration sets for specific use-cases. These parameter combinations are often non-obvious, but beneficial in these scenarios.`,method:`POST`,route:`/sharing.smb.presets`,params:[],hidden:!1,deprecated:!1,rpc:{method:`sharing.smb.presets`,params:[],job:!1,defaults:{}}},{path:[`sharing`,`smb`,`query`],summary:``,description:``,method:`POST`,route:`/sharing.smb.query`,params:[],body:{required:!1,description:``,fields:[{wireName:`filters`,flag:`filters`,required:!1,description:`List of filters for query results. See API documentation for "Query Methods" for more guidance.`,type:{kind:`array`,elem:{kind:`json`}}},{wireName:`options`,flag:`options`,required:!1,description:`Query options including pagination, ordering, and additional parameters.`,type:{kind:`json`}}]},hidden:!1,deprecated:!1,rpc:{method:`sharing.smb.query`,params:[`filters`,`options`],job:!1,defaults:{filters:[],options:{extra:{},order_by:[],select:[],count:!1,get:!1,offset:0,limit:0,force_sql_filters:!1}}}},{path:[`sharing`,`smb`,`setacl`],summary:"Set an ACL on ``share_name``",description:"Set an ACL on ``share_name``. This only impacts access through the SMB protocol.",method:`POST`,route:`/sharing.smb.setacl`,params:[],body:{required:!0,description:``,fields:[{wireName:`smb_setacl`,flag:`smb-setacl`,required:!0,description:`SharingSMBSetaclArgs parameters.`,type:{kind:`json`}}]},hidden:!1,deprecated:!1,rpc:{method:`sharing.smb.setacl`,params:[`smb_setacl`],job:!1,defaults:{}}},{path:[`sharing`,`smb`,`share-precheck`],summary:"Validate prerequisites for creating an SMB share before calling :doc:`sharing.smb.create <api_methods_sharing.smb.create>`",description:"Validate prerequisites for creating an SMB share before calling :doc:`sharing.smb.create <api_methods_sharing.smb.create>`.",method:`POST`,route:`/sharing.smb.share_precheck`,params:[],body:{required:!0,description:``,fields:[{wireName:`smb_share_precheck`,flag:`smb-share-precheck`,required:!0,description:`SharingSMBSharePrecheckArgs parameters.`,type:{kind:`json`}}]},hidden:!1,deprecated:!1,rpc:{method:`sharing.smb.share_precheck`,params:[`smb_share_precheck`],job:!1,defaults:{}}},{path:[`sharing`,`smb`,`update`],summary:"Update the SMB share identified by ``id``",description:"Update the SMB share identified by ``id``.",method:`POST`,route:`/sharing.smb.update`,params:[],body:{required:!0,description:``,fields:[{wireName:`id`,flag:`id`,required:!0,description:`ID of the SMB share to update.`,type:{kind:`integer`}},{wireName:`data`,flag:`data`,required:!0,description:`Updated SMB share configuration data.`,type:{kind:`json`}}]},hidden:!1,deprecated:!1,rpc:{method:`sharing.smb.update`,params:[`id`,`data`],job:!1,defaults:{}}},{path:[`smb`,`bindip-choices`],summary:`List of valid choices for IP addresses to which to bind the SMB service`,description:`List of valid choices for IP addresses to which to bind the SMB service. Addresses assigned by DHCP are excluded from the results.`,method:`POST`,route:`/smb.bindip_choices`,params:[],hidden:!1,deprecated:!1,rpc:{method:`smb.bindip_choices`,params:[],job:!1,defaults:{}}},{path:[`smb`,`config`],summary:``,description:``,method:`POST`,route:`/smb.config`,params:[],hidden:!1,deprecated:!1,rpc:{method:`smb.config`,params:[],job:!1,defaults:{}}},{path:[`smb`,`unixcharset-choices`],summary:"Return the available UNIX character set choices for the ``unixcharset`` field in the SMB service configuration",description:"Return the available UNIX character set choices for the ``unixcharset`` field in the SMB service configuration.",method:`POST`,route:`/smb.unixcharset_choices`,params:[],hidden:!1,deprecated:!1,rpc:{method:`smb.unixcharset_choices`,params:[],job:!1,defaults:{}}},{path:[`smb`,`update`],summary:`Update the SMB service configuration`,description:`Update the SMB service configuration.`,method:`POST`,route:`/smb.update`,params:[],body:{required:!0,description:``,fields:[{wireName:`smb_update`,flag:`smb-update`,required:!0,description:`SMBUpdateArgs parameters.`,type:{kind:`json`}}]},hidden:!1,deprecated:!1,rpc:{method:`smb.update`,params:[`smb_update`],job:!1,defaults:{}}},{path:[`snmp`,`config`],summary:``,description:``,method:`POST`,route:`/snmp.config`,params:[],hidden:!1,deprecated:!1,rpc:{method:`snmp.config`,params:[],job:!1,defaults:{}}},{path:[`snmp`,`update`],summary:`Update SNMP Service Configuration`,description:`Update SNMP Service Configuration.`,method:`POST`,route:`/snmp.update`,params:[],body:{required:!0,description:``,fields:[{wireName:`snmp_update`,flag:`snmp-update`,required:!0,description:`SNMPUpdateArgs parameters.`,type:{kind:`json`}}]},hidden:!1,deprecated:!1,rpc:{method:`snmp.update`,params:[`snmp_update`],job:!1,defaults:{}}},{path:[`ssh`,`bindiface-choices`],summary:`Available choices for the bindiface attribute of SSH service`,description:`Available choices for the bindiface attribute of SSH service.`,method:`POST`,route:`/ssh.bindiface_choices`,params:[],hidden:!1,deprecated:!1,rpc:{method:`ssh.bindiface_choices`,params:[],job:!1,defaults:{}}},{path:[`ssh`,`config`],summary:``,description:``,method:`POST`,route:`/ssh.config`,params:[],hidden:!1,deprecated:!1,rpc:{method:`ssh.config`,params:[],job:!1,defaults:{}}},{path:[`ssh`,`update`],summary:`Update settings of SSH daemon service`,description:`Update settings of SSH daemon service.`,method:`POST`,route:`/ssh.update`,params:[],body:{required:!0,description:``,fields:[{wireName:`data`,flag:`data`,required:!0,description:`Updated SSH service configuration.`,type:{kind:`json`}}]},hidden:!1,deprecated:!1,rpc:{method:`ssh.update`,params:[`data`],job:!1,defaults:{}}},{path:[`staticroute`,`create`],summary:`Create a Static Route`,description:`Create a Static Route.`,method:`POST`,route:`/staticroute.create`,params:[],body:{required:!0,description:``,fields:[{wireName:`data`,flag:`data`,required:!0,description:`Configuration for the new static route.`,type:{kind:`json`}}]},hidden:!1,deprecated:!1,rpc:{method:`staticroute.create`,params:[`data`],job:!1,defaults:{}}},{path:[`staticroute`,`delete`],summary:"Delete Static Route of ``id``",description:"Delete Static Route of ``id``.",method:`POST`,route:`/staticroute.delete`,params:[],body:{required:!0,description:``,fields:[{wireName:`id`,flag:`id`,required:!0,description:`ID of the static route to delete.`,type:{kind:`integer`}}]},confirmation:``,hidden:!1,deprecated:!1,rpc:{method:`staticroute.delete`,params:[`id`],job:!1,defaults:{}}},{path:[`staticroute`,`get-instance`],summary:"Returns instance matching `id`",description:"Returns instance matching `id`. If `id` is not found, Validation error is raised.",method:`POST`,route:`/staticroute.get_instance`,params:[],body:{required:!0,description:``,fields:[{wireName:`id`,flag:`id`,required:!0,description:``,type:{kind:`integer`}},{wireName:`options`,flag:`options`,required:!0,description:`Query options customize the results returned by a query method. More complete documentation with examples are covered in the "Query methods" section of the TrueNAS API documentation.`,type:{kind:`json`}}]},hidden:!1,deprecated:!1,rpc:{method:`staticroute.get_instance`,params:[`id`,`options`],job:!1,defaults:{}}},{path:[`staticroute`,`query`],summary:``,description:``,method:`POST`,route:`/staticroute.query`,params:[],body:{required:!1,description:``,fields:[{wireName:`filters`,flag:`filters`,required:!1,description:`List of filters for query results. See API documentation for "Query Methods" for more guidance.`,type:{kind:`array`,elem:{kind:`json`}}},{wireName:`options`,flag:`options`,required:!1,description:`Query options including pagination, ordering, and additional parameters.`,type:{kind:`json`}}]},hidden:!1,deprecated:!1,rpc:{method:`staticroute.query`,params:[`filters`,`options`],job:!1,defaults:{filters:[],options:{extra:{},order_by:[],select:[],count:!1,get:!1,offset:0,limit:0,force_sql_filters:!1}}}},{path:[`staticroute`,`update`],summary:"Update Static Route of ``id``",description:"Update Static Route of ``id``.",method:`POST`,route:`/staticroute.update`,params:[],body:{required:!0,description:``,fields:[{wireName:`id`,flag:`id`,required:!0,description:`ID of the static route to update.`,type:{kind:`integer`}},{wireName:`data`,flag:`data`,required:!0,description:`Updated configuration for the static route.`,type:{kind:`json`}}]},hidden:!1,deprecated:!1,rpc:{method:`staticroute.update`,params:[`id`,`data`],job:!1,defaults:{}}},{path:[`support`,`attach-ticket-max-size`],summary:"Returns maximum uploaded file size for :doc:`support.attach_ticket <api_methods_support.attach_ticket>`",description:"Returns maximum uploaded file size for :doc:`support.attach_ticket <api_methods_support.attach_ticket>`.",method:`POST`,route:`/support.attach_ticket_max_size`,params:[],hidden:!1,deprecated:!1,rpc:{method:`support.attach_ticket_max_size`,params:[],job:!1,defaults:{}}},{path:[`support`,`config`],summary:``,description:``,method:`POST`,route:`/support.config`,params:[],hidden:!1,deprecated:!1,rpc:{method:`support.config`,params:[],job:!1,defaults:{}}},{path:[`support`,`fields`],summary:`Returns list of pairs of field names and field titles for Proactive Support`,description:`Returns list of pairs of field names and field titles for Proactive Support.`,method:`POST`,route:`/support.fields`,params:[],hidden:!1,deprecated:!1,rpc:{method:`support.fields`,params:[],job:!1,defaults:{}}},{path:[`support`,`is-available`],summary:`Returns whether Proactive Support is available for the current license`,description:`Returns whether Proactive Support is available for the current license.`,method:`POST`,route:`/support.is_available`,params:[],hidden:!1,deprecated:!1,rpc:{method:`support.is_available`,params:[],job:!1,defaults:{}}},{path:[`support`,`is-available-and-enabled`],summary:`Returns whether Proactive Support is available and enabled`,description:`Returns whether Proactive Support is available and enabled.`,method:`POST`,route:`/support.is_available_and_enabled`,params:[],hidden:!1,deprecated:!1,rpc:{method:`support.is_available_and_enabled`,params:[],job:!1,defaults:{}}},{path:[`support`,`new-ticket`],summary:`Creates a new ticket for support`,description:`Creates a new ticket for support. This is done using the support proxy API. For TrueNAS Community Edition it will be created on JIRA and for TrueNAS Enterprise on Salesforce.`,method:`POST`,route:`/support.new_ticket`,params:[],body:{required:!0,description:``,fields:[{wireName:`data`,flag:`data`,required:!0,description:`Support ticket data for either enterprise or community support.`,type:{kind:`json`}}]},hidden:!1,deprecated:!1,rpc:{method:`support.new_ticket`,params:[`data`],job:!0,defaults:{}}},{path:[`support`,`similar-issues`],summary:"Returns a list of similar issues for the given ``query`` from the support knowledge base",description:"Returns a list of similar issues for the given ``query`` from the support knowledge base.",method:`POST`,route:`/support.similar_issues`,params:[],body:{required:!0,description:``,fields:[{wireName:`query`,flag:`query`,required:!0,description:`Search query to find similar issues or knowledge base articles.`,type:{kind:`string`}}]},hidden:!1,deprecated:!1,rpc:{method:`support.similar_issues`,params:[`query`],job:!1,defaults:{}}},{path:[`support`,`update`],summary:`Update Proactive Support settings`,description:`Update Proactive Support settings.`,method:`POST`,route:`/support.update`,params:[],body:{required:!0,description:``,fields:[{wireName:`data`,flag:`data`,required:!0,description:`Updated support configuration data.`,type:{kind:`json`}}]},hidden:!1,deprecated:!1,rpc:{method:`support.update`,params:[`data`],job:!1,defaults:{}}},{path:[`system`,`boot-id`],summary:`Returns a unique boot identifier`,description:`Returns a unique boot identifier.`,method:`POST`,route:`/system.boot_id`,params:[],hidden:!1,deprecated:!1,rpc:{method:`system.boot_id`,params:[],job:!1,defaults:{}}},{path:[`system`,`feature-enabled`],summary:"Returns whether the ``feature`` is enabled",description:"Returns whether the ``feature`` is enabled.",method:`POST`,route:`/system.feature_enabled`,params:[],body:{required:!0,description:``,fields:[{wireName:`feature`,flag:`feature`,required:!0,description:`Feature to check for availability on this system.`,type:{kind:`enum`,values:[`DEDUP`,`FIBRECHANNEL`,`VM`]}}]},hidden:!1,deprecated:!1,rpc:{method:`system.feature_enabled`,params:[`feature`],job:!1,defaults:{}}},{path:[`system`,`host-id`],summary:"Retrieve a hex string that is generated based on the contents of the ``/etc/hostid`` file",description:"Retrieve a hex string that is generated based on the contents of the ``/etc/hostid`` file. This is a permanent value that persists across reboots/upgrades and can be used as a unique identifier for the machine.",method:`POST`,route:`/system.host_id`,params:[],hidden:!1,deprecated:!1,rpc:{method:`system.host_id`,params:[],job:!1,defaults:{}}},{path:[`system`,`info`],summary:`Returns basic system information`,description:`Returns basic system information.`,method:`POST`,route:`/system.info`,params:[],hidden:!1,deprecated:!1,rpc:{method:`system.info`,params:[],job:!1,defaults:{}}},{path:[`system`,`license-update`],summary:`Update license file`,description:`Update license file.`,method:`POST`,route:`/system.license_update`,params:[],body:{required:!0,description:``,fields:[{wireName:`license`,flag:`license`,required:!0,description:`License key to apply to the system.`,type:{kind:`string`}}]},hidden:!1,deprecated:!1,rpc:{method:`system.license_update`,params:[`license`],job:!1,defaults:{}}},{path:[`system`,`product-type`],summary:`Returns the type of the product`,description:`Returns the type of the product.`,method:`POST`,route:`/system.product_type`,params:[],hidden:!1,deprecated:!1,rpc:{method:`system.product_type`,params:[],job:!1,defaults:{}}},{path:[`system`,`ready`],summary:`Returns whether the system completed boot and is ready to use`,description:`Returns whether the system completed boot and is ready to use.`,method:`POST`,route:`/system.ready`,params:[],hidden:!1,deprecated:!1,rpc:{method:`system.ready`,params:[],job:!1,defaults:{}}},{path:[`system`,`release-notes-url`],summary:`Returns the release notes URL for a version of SCALE`,description:`Returns the release notes URL for a version of SCALE.`,method:`POST`,route:`/system.release_notes_url`,params:[],body:{required:!1,description:``,fields:[{wireName:`version_str`,flag:`version-str`,required:!1,description:"Version string to get release notes for. `null` for current version.",type:{kind:`string`}}]},hidden:!1,deprecated:!1,rpc:{method:`system.release_notes_url`,params:[`version_str`],job:!1,defaults:{version_str:null}}},{path:[`system`,`shutdown`],summary:`Shuts down the operating system`,description:`Shuts down the operating system.`,method:`POST`,route:`/system.shutdown`,params:[],body:{required:!0,description:``,fields:[{wireName:`reason`,flag:`reason`,required:!0,description:`Reason for the system shutdown.`,type:{kind:`string`}},{wireName:`options`,flag:`options`,required:!0,description:`Options for controlling the shutdown process.`,type:{kind:`json`}}]},confirmation:``,hidden:!1,deprecated:!1,rpc:{method:`system.shutdown`,params:[`reason`,`options`],job:!0,defaults:{}}},{path:[`system`,`state`],summary:`Returns the current system state`,description:`Returns the current system state.`,method:`POST`,route:`/system.state`,params:[],hidden:!1,deprecated:!1,rpc:{method:`system.state`,params:[],job:!1,defaults:{}}},{path:[`system`,`version`],summary:`Returns the full name of the software version of the system`,description:`Returns the full name of the software version of the system.`,method:`POST`,route:`/system.version`,params:[],hidden:!1,deprecated:!1,rpc:{method:`system.version`,params:[],job:!1,defaults:{}}},{path:[`system`,`version-short`],summary:`Returns the short name of the software version of the system`,description:`Returns the short name of the software version of the system.`,method:`POST`,route:`/system.version_short`,params:[],hidden:!1,deprecated:!1,rpc:{method:`system.version_short`,params:[],job:!1,defaults:{}}},{path:[`system`,`advanced`,`config`],summary:``,description:``,method:`POST`,route:`/system.advanced.config`,params:[],hidden:!1,deprecated:!1,rpc:{method:`system.advanced.config`,params:[],job:!1,defaults:{}}},{path:[`system`,`advanced`,`get-gpu-pci-choices`],summary:`This endpoint gives all the gpu pci ids/slots that can be isolated`,description:`This endpoint gives all the gpu pci ids/slots that can be isolated.`,method:`POST`,route:`/system.advanced.get_gpu_pci_choices`,params:[],hidden:!1,deprecated:!1,rpc:{method:`system.advanced.get_gpu_pci_choices`,params:[],job:!1,defaults:{}}},{path:[`system`,`advanced`,`login-banner`],summary:`Returns user set login banner`,description:`Returns user set login banner.`,method:`POST`,route:`/system.advanced.login_banner`,params:[],hidden:!1,deprecated:!1,rpc:{method:`system.advanced.login_banner`,params:[],job:!1,defaults:{}}},{path:[`system`,`advanced`,`sed-global-password`],summary:`Returns configured global SED password in clear-text if one is configured, otherwise an empty string`,description:`Returns configured global SED password in clear-text if one is configured, otherwise an empty string.`,method:`POST`,route:`/system.advanced.sed_global_password`,params:[],hidden:!1,deprecated:!1,rpc:{method:`system.advanced.sed_global_password`,params:[],job:!1,defaults:{}}},{path:[`system`,`advanced`,`sed-global-password-is-set`],summary:`Returns a boolean identifying whether or not a global SED password has been set`,description:`Returns a boolean identifying whether or not a global SED password has been set.`,method:`POST`,route:`/system.advanced.sed_global_password_is_set`,params:[],hidden:!1,deprecated:!1,rpc:{method:`system.advanced.sed_global_password_is_set`,params:[],job:!1,defaults:{}}},{path:[`system`,`advanced`,`serial-port-choices`],summary:"Get available choices for ``serialport``",description:"Get available choices for ``serialport``.",method:`POST`,route:`/system.advanced.serial_port_choices`,params:[],hidden:!1,deprecated:!1,rpc:{method:`system.advanced.serial_port_choices`,params:[],job:!1,defaults:{}}},{path:[`system`,`advanced`,`syslog-certificate-authority-choices`],summary:"Return choices of certificate authorities which can be used for ``syslog_tls_certificate_authority``",description:"Return choices of certificate authorities which can be used for ``syslog_tls_certificate_authority``.",method:`POST`,route:`/system.advanced.syslog_certificate_authority_choices`,params:[],hidden:!1,deprecated:!1,rpc:{method:`system.advanced.syslog_certificate_authority_choices`,params:[],job:!1,defaults:{}}},{path:[`system`,`advanced`,`syslog-certificate-choices`],summary:"Return choices of certificates which can be used for ``syslogservers.N.tls_certificate``",description:"Return choices of certificates which can be used for ``syslogservers.N.tls_certificate``.",method:`POST`,route:`/system.advanced.syslog_certificate_choices`,params:[],hidden:!1,deprecated:!1,rpc:{method:`system.advanced.syslog_certificate_choices`,params:[],job:!1,defaults:{}}},{path:[`system`,`advanced`,`update`],summary:`Update System Advanced Service Configuration`,description:`Update System Advanced Service Configuration.`,method:`POST`,route:`/system.advanced.update`,params:[],body:{required:!0,description:``,fields:[{wireName:`data`,flag:`data`,required:!0,description:`Updated system advanced configuration data.`,type:{kind:`json`}}]},hidden:!1,deprecated:!1,rpc:{method:`system.advanced.update`,params:[`data`],job:!1,defaults:{}}},{path:[`system`,`advanced`,`update-gpu-pci-ids`],summary:`Update the list of GPU PCI IDs isolated from the host system`,description:`Update the list of GPU PCI IDs isolated from the host system.`,method:`POST`,route:`/system.advanced.update_gpu_pci_ids`,params:[],body:{required:!0,description:``,fields:[{wireName:`data`,flag:`data`,required:!0,description:`List of GPU PCI IDs to isolate for VM passthrough.`,type:{kind:`array`,elem:{kind:`string`}}}]},hidden:!1,deprecated:!1,rpc:{method:`system.advanced.update_gpu_pci_ids`,params:[`data`],job:!1,defaults:{}}},{path:[`system`,`general`,`checkin`],summary:"After UI settings are saved with ``rollback_timeout`` this method needs to be called within that timeout limit to prevent reverting the changes",description:"After UI settings are saved with ``rollback_timeout`` this method needs to be called within that timeout limit to prevent reverting the changes.",method:`POST`,route:`/system.general.checkin`,params:[],hidden:!1,deprecated:!1,rpc:{method:`system.general.checkin`,params:[],job:!1,defaults:{}}},{path:[`system`,`general`,`checkin-waiting`],summary:`Determines whether we are waiting user to check in the applied UI settings changes before they are rolled back`,description:`Determines whether we are waiting user to check in the applied UI settings changes before they are rolled back. Returns a number of seconds before the automatic rollback or null if there are no changes pending.`,method:`POST`,route:`/system.general.checkin_waiting`,params:[],hidden:!1,deprecated:!1,rpc:{method:`system.general.checkin_waiting`,params:[],job:!1,defaults:{}}},{path:[`system`,`general`,`config`],summary:``,description:``,method:`POST`,route:`/system.general.config`,params:[],hidden:!1,deprecated:!1,rpc:{method:`system.general.config`,params:[],job:!1,defaults:{}}},{path:[`system`,`general`,`country-choices`],summary:`Return a dictionary whose keys represent the ISO 3166-1 alpha 2 country code and values represent the English short name (used in ISO 3166/MA)`,description:`Return a dictionary whose keys represent the ISO 3166-1 alpha 2 country code and values represent the English short name (used in ISO 3166/MA).`,method:`POST`,route:`/system.general.country_choices`,params:[],hidden:!1,deprecated:!1,rpc:{method:`system.general.country_choices`,params:[],job:!1,defaults:{}}},{path:[`system`,`general`,`kbdmap-choices`],summary:`Returns keyboard map choices`,description:`Returns keyboard map choices.`,method:`POST`,route:`/system.general.kbdmap_choices`,params:[],hidden:!1,deprecated:!1,rpc:{method:`system.general.kbdmap_choices`,params:[],job:!1,defaults:{}}},{path:[`system`,`general`,`local-url`],summary:`Returns configured local url in the format of protocol://host:port`,description:`Returns configured local url in the format of protocol://host:port.`,method:`POST`,route:`/system.general.local_url`,params:[],hidden:!1,deprecated:!1,rpc:{method:`system.general.local_url`,params:[],job:!1,defaults:{}}},{path:[`system`,`general`,`timezone-choices`],summary:`Returns available timezones`,description:`Returns available timezones.`,method:`POST`,route:`/system.general.timezone_choices`,params:[],hidden:!1,deprecated:!1,rpc:{method:`system.general.timezone_choices`,params:[],job:!1,defaults:{}}},{path:[`system`,`general`,`ui-address-choices`],summary:`Returns network interfaces that have statically configured IPv4 address(es)`,description:`Returns network interfaces that have statically configured IPv4 address(es). These addresses can be used to bind the UI server.`,method:`POST`,route:`/system.general.ui_address_choices`,params:[],hidden:!1,deprecated:!1,rpc:{method:`system.general.ui_address_choices`,params:[],job:!1,defaults:{}}},{path:[`system`,`general`,`ui-certificate-choices`],summary:`Return available certificates that may be used to bind the webserver to when connecting via HTTPS protocol`,description:`Return available certificates that may be used to bind the webserver to when connecting via HTTPS protocol.`,method:`POST`,route:`/system.general.ui_certificate_choices`,params:[],hidden:!1,deprecated:!1,rpc:{method:`system.general.ui_certificate_choices`,params:[],job:!1,defaults:{}}},{path:[`system`,`general`,`ui-httpsprotocols-choices`],summary:`Returns available HTTPS protocols`,description:`Returns available HTTPS protocols.`,method:`POST`,route:`/system.general.ui_httpsprotocols_choices`,params:[],hidden:!1,deprecated:!1,rpc:{method:`system.general.ui_httpsprotocols_choices`,params:[],job:!1,defaults:{}}},{path:[`system`,`general`,`ui-restart`],summary:`Restart HTTP server to use latest UI settings`,description:`Restart HTTP server to use latest UI settings.`,method:`POST`,route:`/system.general.ui_restart`,params:[],body:{required:!1,description:``,fields:[{wireName:`delay`,flag:`delay`,required:!1,description:`How long to wait before the UI is restarted.`,type:{kind:`integer`}}]},hidden:!1,deprecated:!1,rpc:{method:`system.general.ui_restart`,params:[`delay`],job:!1,defaults:{delay:3}}},{path:[`system`,`general`,`ui-v6address-choices`],summary:`Returns network interfaces that have statically configured IPv6 address(es)`,description:`Returns network interfaces that have statically configured IPv6 address(es). These addresses can be used to bind the UI server.`,method:`POST`,route:`/system.general.ui_v6address_choices`,params:[],hidden:!1,deprecated:!1,rpc:{method:`system.general.ui_v6address_choices`,params:[],job:!1,defaults:{}}},{path:[`system`,`general`,`update`],summary:`Update System General Service Configuration`,description:`Update System General Service Configuration.`,method:`POST`,route:`/system.general.update`,params:[],body:{required:!0,description:``,fields:[{wireName:`general_settings`,flag:`general-settings`,required:!0,description:`SystemGeneralUpdateArgs parameters.`,type:{kind:`json`}}]},hidden:!1,deprecated:!1,rpc:{method:`system.general.update`,params:[`general_settings`],job:!1,defaults:{}}},{path:[`system`,`global`,`id`],summary:`Retrieve a 128 bit hexadecimal UUID value unique for each TrueNAS system`,description:`Retrieve a 128 bit hexadecimal UUID value unique for each TrueNAS system.`,method:`POST`,route:`/system.global.id`,params:[],hidden:!1,deprecated:!1,rpc:{method:`system.global.id`,params:[],job:!1,defaults:{}}},{path:[`system`,`ntpserver`,`create`],summary:`Add an NTP Server`,description:`Add an NTP Server.`,method:`POST`,route:`/system.ntpserver.create`,params:[],body:{required:!0,description:``,fields:[{wireName:`ntp_server_create`,flag:`ntp-server-create`,required:!0,description:`Configuration for creating a new NTP server.`,type:{kind:`json`}}]},hidden:!1,deprecated:!1,rpc:{method:`system.ntpserver.create`,params:[`ntp_server_create`],job:!1,defaults:{}}},{path:[`system`,`ntpserver`,`delete`],summary:"Delete NTP server of ``id``",description:"Delete NTP server of ``id``.",method:`POST`,route:`/system.ntpserver.delete`,params:[],body:{required:!0,description:``,fields:[{wireName:`id`,flag:`id`,required:!0,description:`ID of the NTP server to delete.`,type:{kind:`integer`}}]},confirmation:``,hidden:!1,deprecated:!1,rpc:{method:`system.ntpserver.delete`,params:[`id`],job:!1,defaults:{}}},{path:[`system`,`ntpserver`,`get-instance`],summary:"Returns instance matching `id`",description:"Returns instance matching `id`. If `id` is not found, Validation error is raised.",method:`POST`,route:`/system.ntpserver.get_instance`,params:[],body:{required:!0,description:``,fields:[{wireName:`id`,flag:`id`,required:!0,description:``,type:{kind:`integer`}},{wireName:`options`,flag:`options`,required:!0,description:`Query options customize the results returned by a query method. More complete documentation with examples are covered in the "Query methods" section of the TrueNAS API documentation.`,type:{kind:`json`}}]},hidden:!1,deprecated:!1,rpc:{method:`system.ntpserver.get_instance`,params:[`id`,`options`],job:!1,defaults:{}}},{path:[`system`,`ntpserver`,`query`],summary:``,description:``,method:`POST`,route:`/system.ntpserver.query`,params:[],body:{required:!1,description:``,fields:[{wireName:`filters`,flag:`filters`,required:!1,description:`List of filters for query results. See API documentation for "Query Methods" for more guidance.`,type:{kind:`array`,elem:{kind:`json`}}},{wireName:`options`,flag:`options`,required:!1,description:`Query options including pagination, ordering, and additional parameters.`,type:{kind:`json`}}]},hidden:!1,deprecated:!1,rpc:{method:`system.ntpserver.query`,params:[`filters`,`options`],job:!1,defaults:{filters:[],options:{extra:{},order_by:[],select:[],count:!1,get:!1,offset:0,limit:0,force_sql_filters:!1}}}},{path:[`system`,`ntpserver`,`update`],summary:"Update NTP server of ``id``",description:"Update NTP server of ``id``.",method:`POST`,route:`/system.ntpserver.update`,params:[],body:{required:!0,description:``,fields:[{wireName:`id`,flag:`id`,required:!0,description:`ID of the NTP server to update.`,type:{kind:`integer`}},{wireName:`ntp_server_update`,flag:`ntp-server-update`,required:!0,description:`Updated configuration for the NTP server.`,type:{kind:`json`}}]},hidden:!1,deprecated:!1,rpc:{method:`system.ntpserver.update`,params:[`id`,`ntp_server_update`],job:!1,defaults:{}}},{path:[`system`,`reboot`,`info`],summary:`Return information about whether the system requires a reboot, including the current boot session identifier and the list of pending reasons a reboot is required (for example, a FIPS or STIG configuration change or a pending system upgrade)`,description:`Return information about whether the system requires a reboot, including the current boot session identifier and the list of pending reasons a reboot is required (for example, a FIPS or STIG configuration change or a pending system upgrade). An empty list of reasons indicates no reboot is currently required.`,method:`POST`,route:`/system.reboot.info`,params:[],hidden:!1,deprecated:!1,rpc:{method:`system.reboot.info`,params:[],job:!1,defaults:{}}},{path:[`system`,`reboot`,`run`],summary:`Reboots the operating system`,description:`Reboots the operating system.`,method:`POST`,route:`/system.reboot`,params:[],body:{required:!0,description:``,fields:[{wireName:`reason`,flag:`reason`,required:!0,description:`Reason for the system reboot.`,type:{kind:`string`}},{wireName:`options`,flag:`options`,required:!0,description:`Options for controlling the reboot process.`,type:{kind:`json`}}]},confirmation:``,hidden:!1,deprecated:!1,rpc:{method:`system.reboot`,params:[`reason`,`options`],job:!0,defaults:{}}},{path:[`system`,`security`,`config`],summary:``,description:``,method:`POST`,route:`/system.security.config`,params:[],hidden:!1,deprecated:!1,rpc:{method:`system.security.config`,params:[],job:!1,defaults:{}}},{path:[`system`,`security`,`update`],summary:`Update System Security Service Configuration`,description:`Update System Security Service Configuration.`,method:`POST`,route:`/system.security.update`,params:[],body:{required:!0,description:``,fields:[{wireName:`system_security_update`,flag:`system-security-update`,required:!0,description:`SystemSecurityUpdateArgs parameters.`,type:{kind:`json`}}]},hidden:!1,deprecated:!1,rpc:{method:`system.security.update`,params:[`system_security_update`],job:!0,defaults:{}}},{path:[`system`,`security`,`info`,`fips-available`],summary:`Returns a boolean identifying whether FIPS mode may be toggled on this system`,description:`Returns a boolean identifying whether FIPS mode may be toggled on this system.`,method:`POST`,route:`/system.security.info.fips_available`,params:[],hidden:!1,deprecated:!1,rpc:{method:`system.security.info.fips_available`,params:[],job:!1,defaults:{}}},{path:[`system`,`security`,`info`,`fips-enabled`],summary:`Returns a boolean identifying whether FIPS mode has been enabled on this system`,description:`Returns a boolean identifying whether FIPS mode has been enabled on this system.`,method:`POST`,route:`/system.security.info.fips_enabled`,params:[],hidden:!1,deprecated:!1,rpc:{method:`system.security.info.fips_enabled`,params:[],job:!1,defaults:{}}},{path:[`systemdataset`,`config`],summary:``,description:``,method:`POST`,route:`/systemdataset.config`,params:[],hidden:!1,deprecated:!1,rpc:{method:`systemdataset.config`,params:[],job:!1,defaults:{}}},{path:[`systemdataset`,`pool-choices`],summary:`Retrieve pool choices which can be used for configuring system dataset`,description:`Retrieve pool choices which can be used for configuring system dataset.`,method:`POST`,route:`/systemdataset.pool_choices`,params:[],body:{required:!1,description:``,fields:[{wireName:`include_current_pool`,flag:`include-current-pool`,required:!1,description:`Include the currently set pool in the result.`,type:{kind:`boolean`}}]},hidden:!1,deprecated:!1,rpc:{method:`systemdataset.pool_choices`,params:[`include_current_pool`],job:!1,defaults:{include_current_pool:!0}}},{path:[`systemdataset`,`update`],summary:`Update System Dataset Service Configuration`,description:`Update System Dataset Service Configuration.`,method:`POST`,route:`/systemdataset.update`,params:[],body:{required:!0,description:``,fields:[{wireName:`data`,flag:`data`,required:!0,description:`Updated configuration for the system dataset.`,type:{kind:`json`}}]},hidden:!1,deprecated:!1,rpc:{method:`systemdataset.update`,params:[`data`],job:!0,defaults:{}}},{path:[`tn-connect`,`config`],summary:``,description:``,method:`POST`,route:`/tn_connect.config`,params:[],hidden:!1,deprecated:!1,rpc:{method:`tn_connect.config`,params:[],job:!1,defaults:{}}},{path:[`tn-connect`,`generate-claim-token`],summary:`Generate a claim token for TrueNAS Connect`,description:`Generate a claim token for TrueNAS Connect.`,method:`POST`,route:`/tn_connect.generate_claim_token`,params:[],hidden:!1,deprecated:!1,rpc:{method:`tn_connect.generate_claim_token`,params:[],job:!1,defaults:{}}},{path:[`tn-connect`,`get-registration-uri`],summary:`Return the registration URI for TrueNAS Connect`,description:`Return the registration URI for TrueNAS Connect.`,method:`POST`,route:`/tn_connect.get_registration_uri`,params:[],hidden:!1,deprecated:!1,rpc:{method:`tn_connect.get_registration_uri`,params:[],job:!1,defaults:{}}},{path:[`tn-connect`,`update`],summary:`Update TrueNAS Connect configuration`,description:`Update TrueNAS Connect configuration.`,method:`POST`,route:`/tn_connect.update`,params:[],body:{required:!0,description:``,fields:[{wireName:`tn_connect_update`,flag:`tn-connect-update`,required:!0,description:`TrueNASConnectUpdateArgs parameters.`,type:{kind:`json`}}]},hidden:!1,deprecated:!1,rpc:{method:`tn_connect.update`,params:[`tn_connect_update`],job:!1,defaults:{}}},{path:[`truecommand`,`config`],summary:``,description:``,method:`POST`,route:`/truecommand.config`,params:[],hidden:!1,deprecated:!1,rpc:{method:`truecommand.config`,params:[],job:!1,defaults:{}}},{path:[`truecommand`,`update`],summary:`Update Truecommand service settings`,description:`Update Truecommand service settings.`,method:`POST`,route:`/truecommand.update`,params:[],body:{required:!0,description:``,fields:[{wireName:`truecommand_update`,flag:`truecommand-update`,required:!0,description:`TruecommandUpdateArgs parameters.`,type:{kind:`json`}}]},hidden:!1,deprecated:!1,rpc:{method:`truecommand.update`,params:[`truecommand_update`],job:!1,defaults:{}}},{path:[`truenas`,`accept-eula`],summary:`Accept TrueNAS EULA`,description:`Accept TrueNAS EULA.`,method:`POST`,route:`/truenas.accept_eula`,params:[],hidden:!1,deprecated:!1,rpc:{method:`truenas.accept_eula`,params:[],job:!1,defaults:{}}},{path:[`truenas`,`get-chassis-hardware`],summary:`Returns what type of hardware this is, detected from SMBIOS strings`,description:`Returns what type of hardware this is, detected from SMBIOS strings.`,method:`POST`,route:`/truenas.get_chassis_hardware`,params:[],hidden:!1,deprecated:!1,rpc:{method:`truenas.get_chassis_hardware`,params:[],job:!1,defaults:{}}},{path:[`truenas`,`get-eula`],summary:`Returns the TrueNAS End-User License Agreement (EULA)`,description:`Returns the TrueNAS End-User License Agreement (EULA).`,method:`POST`,route:`/truenas.get_eula`,params:[],hidden:!1,deprecated:!1,rpc:{method:`truenas.get_eula`,params:[],job:!1,defaults:{}}},{path:[`truenas`,`is-eula-accepted`],summary:`Returns whether the EULA is accepted or not`,description:`Returns whether the EULA is accepted or not.`,method:`POST`,route:`/truenas.is_eula_accepted`,params:[],hidden:!1,deprecated:!1,rpc:{method:`truenas.is_eula_accepted`,params:[],job:!1,defaults:{}}},{path:[`truenas`,`is-ix-hardware`],summary:`Return a boolean value on whether this is hardware that iXsystems sells`,description:`Return a boolean value on whether this is hardware that iXsystems sells.`,method:`POST`,route:`/truenas.is_ix_hardware`,params:[],hidden:!1,deprecated:!1,rpc:{method:`truenas.is_ix_hardware`,params:[],job:!1,defaults:{}}},{path:[`truenas`,`is-production`],summary:`Returns if system is marked as production`,description:`Returns if system is marked as production.`,method:`POST`,route:`/truenas.is_production`,params:[],hidden:!1,deprecated:!1,rpc:{method:`truenas.is_production`,params:[],job:!1,defaults:{}}},{path:[`truenas`,`managed-by-truecommand`],summary:`Returns whether TrueNAS is being managed by TrueCommand`,description:`Returns whether TrueNAS is being managed by TrueCommand.`,method:`POST`,route:`/truenas.managed_by_truecommand`,params:[],hidden:!1,deprecated:!1,rpc:{method:`truenas.managed_by_truecommand`,params:[],job:!1,defaults:{}}},{path:[`truenas`,`set-production`],summary:`Sets system production state and optionally sends initial debug`,description:`Sets system production state and optionally sends initial debug.`,method:`POST`,route:`/truenas.set_production`,params:[],body:{required:!0,description:``,fields:[{wireName:`production`,flag:`production`,required:!0,description:`Whether to configure the system for production use.`,type:{kind:`boolean`}},{wireName:`attach_debug`,flag:`attach-debug`,required:!1,description:`Whether to attach debug information when transitioning to production mode.`,type:{kind:`boolean`}}]},hidden:!1,deprecated:!1,rpc:{method:`truenas.set_production`,params:[`production`,`attach_debug`],job:!0,defaults:{attach_debug:!1}}},{path:[`tunable`,`create`],summary:`Create a tunable`,description:`Create a tunable.`,method:`POST`,route:`/tunable.create`,params:[],body:{required:!0,description:``,fields:[{wireName:`data`,flag:`data`,required:!0,description:`Configuration for creating a new system tunable.`,type:{kind:`json`}}]},hidden:!1,deprecated:!1,rpc:{method:`tunable.create`,params:[`data`],job:!0,defaults:{}}},{path:[`tunable`,`delete`],summary:"Delete Tunable of ``id``",description:"Delete Tunable of ``id``.",method:`POST`,route:`/tunable.delete`,params:[],body:{required:!0,description:``,fields:[{wireName:`id`,flag:`id`,required:!0,description:`ID of the tunable to delete.`,type:{kind:`integer`}}]},confirmation:``,hidden:!1,deprecated:!1,rpc:{method:`tunable.delete`,params:[`id`],job:!0,defaults:{}}},{path:[`tunable`,`get-instance`],summary:"Returns instance matching `id`",description:"Returns instance matching `id`. If `id` is not found, Validation error is raised.",method:`POST`,route:`/tunable.get_instance`,params:[],body:{required:!0,description:``,fields:[{wireName:`id`,flag:`id`,required:!0,description:``,type:{kind:`integer`}},{wireName:`options`,flag:`options`,required:!0,description:`Query options customize the results returned by a query method. More complete documentation with examples are covered in the "Query methods" section of the TrueNAS API documentation.`,type:{kind:`json`}}]},hidden:!1,deprecated:!1,rpc:{method:`tunable.get_instance`,params:[`id`,`options`],job:!1,defaults:{}}},{path:[`tunable`,`query`],summary:``,description:``,method:`POST`,route:`/tunable.query`,params:[],body:{required:!1,description:``,fields:[{wireName:`filters`,flag:`filters`,required:!1,description:`List of filters for query results. See API documentation for "Query Methods" for more guidance.`,type:{kind:`array`,elem:{kind:`json`}}},{wireName:`options`,flag:`options`,required:!1,description:`Query options including pagination, ordering, and additional parameters.`,type:{kind:`json`}}]},hidden:!1,deprecated:!1,rpc:{method:`tunable.query`,params:[`filters`,`options`],job:!1,defaults:{filters:[],options:{extra:{},order_by:[],select:[],count:!1,get:!1,offset:0,limit:0,force_sql_filters:!1}}}},{path:[`tunable`,`tunable-type-choices`],summary:`Retrieve the supported tunable types that can be changed`,description:`Retrieve the supported tunable types that can be changed.`,method:`POST`,route:`/tunable.tunable_type_choices`,params:[],hidden:!1,deprecated:!1,rpc:{method:`tunable.tunable_type_choices`,params:[],job:!1,defaults:{}}},{path:[`tunable`,`update`],summary:"Update Tunable of ``id``",description:"Update Tunable of ``id``.",method:`POST`,route:`/tunable.update`,params:[],body:{required:!0,description:``,fields:[{wireName:`id`,flag:`id`,required:!0,description:`ID of the tunable to update.`,type:{kind:`integer`}},{wireName:`data`,flag:`data`,required:!0,description:`Updated configuration for the tunable.`,type:{kind:`json`}}]},hidden:!1,deprecated:!1,rpc:{method:`tunable.update`,params:[`id`,`data`],job:!0,defaults:{}}},{path:[`update`,`available-versions`],summary:`TrueNAS versions available for update`,description:`TrueNAS versions available for update.`,method:`POST`,route:`/update.available_versions`,params:[],hidden:!1,deprecated:!1,rpc:{method:`update.available_versions`,params:[],job:!1,defaults:{}}},{path:[`update`,`config`],summary:``,description:``,method:`POST`,route:`/update.config`,params:[],hidden:!1,deprecated:!1,rpc:{method:`update.config`,params:[],job:!1,defaults:{}}},{path:[`update`,`download`],summary:`Download updates`,description:`Download updates.`,method:`POST`,route:`/update.download`,params:[],body:{required:!1,description:``,fields:[{wireName:`train`,flag:`train`,required:!1,description:"Specifies the train from which to download the update. If both `train` and `version` are `null``, the most recent version that matches the currently selected update profile is used.",type:{kind:`string`}},{wireName:`version`,flag:`version`,required:!1,description:"Specific version to download. `null` to download the latest version from the specified train.",type:{kind:`string`}}]},hidden:!1,deprecated:!1,rpc:{method:`update.download`,params:[`train`,`version`],job:!0,defaults:{train:null,version:null}}},{path:[`update`,`file`],summary:`Updates the system using the uploaded .tar file`,description:`Updates the system using the uploaded .tar file.`,method:`POST`,route:`/update.file`,params:[],body:{required:!1,description:``,fields:[{wireName:`options`,flag:`options`,required:!1,description:`Options for controlling the manual update file upload process.`,type:{kind:`json`}}]},hidden:!1,deprecated:!1,rpc:{method:`update.file`,params:[`options`],job:!0,defaults:{options:{resume:!1,destination:null}}}},{path:[`update`,`manual`],summary:`Update the system using a manual update file`,description:`Update the system using a manual update file.`,method:`POST`,route:`/update.manual`,params:[],body:{required:!0,description:``,fields:[{wireName:`path`,flag:`path`,required:!0,description:`The absolute path to the update file.`,type:{kind:`string`}},{wireName:`options`,flag:`options`,required:!1,description:`Options for controlling the manual update process.`,type:{kind:`json`}}]},hidden:!1,deprecated:!1,rpc:{method:`update.manual`,params:[`path`,`options`],job:!0,defaults:{options:{dataset_name:null,resume:!1,cleanup:!0}}}},{path:[`update`,`profile-choices`],summary:"``profile`` choices for configuration update",description:"``profile`` choices for configuration update.",method:`POST`,route:`/update.profile_choices`,params:[],hidden:!1,deprecated:!1,rpc:{method:`update.profile_choices`,params:[],job:!1,defaults:{}}},{path:[`update`,`run`],summary:`Downloads (if not already in cache) and apply an update`,description:`Downloads (if not already in cache) and apply an update.`,method:`POST`,route:`/update.run`,params:[],body:{required:!1,description:``,fields:[{wireName:`attrs`,flag:`attrs`,required:!1,description:`Attributes controlling the system update execution process.`,type:{kind:`json`}}]},hidden:!1,deprecated:!1,rpc:{method:`update.run`,params:[`attrs`],job:!0,defaults:{attrs:{dataset_name:null,resume:!1,train:null,version:null,reboot:!1}}}},{path:[`update`,`status`],summary:`Update status`,description:`Update status.`,method:`POST`,route:`/update.status`,params:[],hidden:!1,deprecated:!1,rpc:{method:`update.status`,params:[],job:!1,defaults:{}}},{path:[`update`,`update`],summary:`Update update configuration`,description:`Update update configuration.`,method:`POST`,route:`/update.update`,params:[],body:{required:!0,description:``,fields:[{wireName:`data`,flag:`data`,required:!0,description:`Updated configuration for system update settings.`,type:{kind:`json`}}]},hidden:!1,deprecated:!1,rpc:{method:`update.update`,params:[`data`],job:!1,defaults:{}}},{path:[`ups`,`config`],summary:``,description:``,method:`POST`,route:`/ups.config`,params:[],hidden:!1,deprecated:!1,rpc:{method:`ups.config`,params:[],job:!1,defaults:{}}},{path:[`ups`,`driver-choices`],summary:`Returns choices of UPS drivers supported by the system`,description:`Returns choices of UPS drivers supported by the system.`,method:`POST`,route:`/ups.driver_choices`,params:[],hidden:!1,deprecated:!1,rpc:{method:`ups.driver_choices`,params:[],job:!1,defaults:{}}},{path:[`ups`,`port-choices`],summary:`Returns available UPS device ports for the system (serial ports, USB HID devices, and "auto")`,description:`Returns available UPS device ports for the system (serial ports, USB HID devices, and "auto").`,method:`POST`,route:`/ups.port_choices`,params:[],hidden:!1,deprecated:!1,rpc:{method:`ups.port_choices`,params:[],job:!1,defaults:{}}},{path:[`ups`,`update`],summary:`Update UPS Service Configuration`,description:`Update UPS Service Configuration.`,method:`POST`,route:`/ups.update`,params:[],body:{required:!0,description:``,fields:[{wireName:`ups_update`,flag:`ups-update`,required:!0,description:`UPSUpdateArgs parameters.`,type:{kind:`json`}}]},hidden:!1,deprecated:!1,rpc:{method:`ups.update`,params:[`ups_update`],job:!1,defaults:{}}},{path:[`user`,`create`],summary:`Create a new user`,description:`Create a new user.`,method:`POST`,route:`/user.create`,params:[],body:{required:!0,description:``,fields:[{wireName:`user_create`,flag:`user-create`,required:!0,description:`Configuration for creating a new user account.`,type:{kind:`json`}}]},hidden:!1,deprecated:!1,rpc:{method:`user.create`,params:[`user_create`],job:!1,defaults:{}}},{path:[`user`,`delete`],summary:"Delete user ``id``",description:"Delete user ``id``.",method:`POST`,route:`/user.delete`,params:[],body:{required:!0,description:``,fields:[{wireName:`id`,flag:`id`,required:!0,description:`ID of the user account to delete.`,type:{kind:`integer`}},{wireName:`options`,flag:`options`,required:!0,description:`Options controlling the user deletion process.`,type:{kind:`json`}}]},confirmation:``,hidden:!1,deprecated:!1,rpc:{method:`user.delete`,params:[`id`,`options`],job:!1,defaults:{}}},{path:[`user`,`get-instance`],summary:"Returns instance matching `id`",description:"Returns instance matching `id`. If `id` is not found, Validation error is raised.",method:`POST`,route:`/user.get_instance`,params:[],body:{required:!0,description:``,fields:[{wireName:`id`,flag:`id`,required:!0,description:``,type:{kind:`integer`}},{wireName:`options`,flag:`options`,required:!0,description:`Query options customize the results returned by a query method. More complete documentation with examples are covered in the "Query methods" section of the TrueNAS API documentation.`,type:{kind:`json`}}]},hidden:!1,deprecated:!1,rpc:{method:`user.get_instance`,params:[`id`,`options`],job:!1,defaults:{}}},{path:[`user`,`get-next-uid`],summary:`Get the next available/free uid`,description:`Get the next available/free uid.`,method:`POST`,route:`/user.get_next_uid`,params:[],hidden:!1,deprecated:!1,rpc:{method:`user.get_next_uid`,params:[],job:!1,defaults:{}}},{path:[`user`,`get-user-obj`],summary:"Returns dictionary containing information from struct passwd for the user specified by either the ``username`` or ``uid``",description:"Returns dictionary containing information from struct passwd for the user specified by either the ``username`` or ``uid``. Bypasses user cache.",method:`POST`,route:`/user.get_user_obj`,params:[],body:{required:!0,description:``,fields:[{wireName:`get_user_obj`,flag:`get-user-obj`,required:!0,description:`UserGetUserObjArgs parameters.`,type:{kind:`json`}}]},hidden:!1,deprecated:!1,rpc:{method:`user.get_user_obj`,params:[`get_user_obj`],job:!1,defaults:{}}},{path:[`user`,`has-local-administrator-set-up`],summary:`Return whether a local administrator with a valid password exists`,description:`Return whether a local administrator with a valid password exists.`,method:`POST`,route:`/user.has_local_administrator_set_up`,params:[],hidden:!1,deprecated:!1,rpc:{method:`user.has_local_administrator_set_up`,params:[],job:!1,defaults:{}}},{path:[`user`,`query`],summary:"Query users with `query-filters` and `query-options`",description:"Query users with `query-filters` and `query-options`.",method:`POST`,route:`/user.query`,params:[],body:{required:!1,description:``,fields:[{wireName:`filters`,flag:`filters`,required:!1,description:`List of filters for query results. See API documentation for "Query Methods" for more guidance.`,type:{kind:`array`,elem:{kind:`json`}}},{wireName:`options`,flag:`options`,required:!1,description:`Query options including pagination, ordering, and additional parameters.`,type:{kind:`json`}}]},hidden:!1,deprecated:!1,rpc:{method:`user.query`,params:[`filters`,`options`],job:!1,defaults:{filters:[],options:{extra:{},order_by:[],select:[],count:!1,get:!1,offset:0,limit:0,force_sql_filters:!1}}}},{path:[`user`,`renew-2fa-secret`],summary:"Renew ``username`` user's two-factor authentication secret",description:"Renew ``username`` user's two-factor authentication secret.",method:`POST`,route:`/user.renew_2fa_secret`,params:[],body:{required:!0,description:``,fields:[{wireName:`username`,flag:`username`,required:!0,description:`Username to renew two-factor authentication secret for.`,type:{kind:`string`}},{wireName:`twofactor_options`,flag:`twofactor-options`,required:!0,description:`Configuration options for the new two-factor authentication setup.`,type:{kind:`json`}}]},hidden:!1,deprecated:!1,rpc:{method:`user.renew_2fa_secret`,params:[`username`,`twofactor_options`],job:!1,defaults:{}}},{path:[`user`,`set-password`],summary:"Set the password of the specified ``username`` to the ``new_password`` specified in payload",description:"Set the password of the specified ``username`` to the ``new_password`` specified in payload.",method:`POST`,route:`/user.set_password`,params:[],body:{required:!0,description:``,fields:[{wireName:`set_password_data`,flag:`set-password-data`,required:!0,description:`UserSetPasswordArgs parameters.`,type:{kind:`json`}}]},hidden:!1,deprecated:!1,rpc:{method:`user.set_password`,params:[`set_password_data`],job:!1,defaults:{}}},{path:[`user`,`setup-local-administrator`],summary:`Set up local administrator (this method does not require authentication if local administrator is not already set up)`,description:`Set up local administrator (this method does not require authentication if local administrator is not already set up).`,method:`POST`,route:`/user.setup_local_administrator`,params:[],body:{required:!0,description:``,fields:[{wireName:`username`,flag:`username`,required:!0,description:`Administrator username to configure.`,type:{kind:`enum`,values:[`root`,`truenas_admin`]}},{wireName:`password`,flag:`password`,required:!0,description:`Password for the administrator account.`,type:{kind:`string`}},{wireName:`options`,flag:`options`,required:!0,description:`Additional options for cloud or specialized administrator setup.`,type:{kind:`json`}}]},hidden:!1,deprecated:!1,rpc:{method:`user.setup_local_administrator`,params:[`username`,`password`,`options`],job:!1,defaults:{}}},{path:[`user`,`shell-choices`],summary:"Return the available shell choices to be used in :doc:`user.create <api_methods_user.create>` and :doc:`user.update <api_methods_user.update>`",description:"Return the available shell choices to be used in :doc:`user.create <api_methods_user.create>` and :doc:`user.update <api_methods_user.update>`.",method:`POST`,route:`/user.shell_choices`,params:[],body:{required:!1,description:``,fields:[{wireName:`group_ids`,flag:`group-ids`,required:!1,description:`Array of group IDs to filter shell choices. Empty array returns all shells.`,type:{kind:`array`,elem:{kind:`integer`}}}]},hidden:!1,deprecated:!1,rpc:{method:`user.shell_choices`,params:[`group_ids`],job:!1,defaults:{group_ids:[]}}},{path:[`user`,`unset-2fa-secret`],summary:"Unset two-factor authentication secret for ``username``",description:"Unset two-factor authentication secret for ``username``.",method:`POST`,route:`/user.unset_2fa_secret`,params:[],body:{required:!0,description:``,fields:[{wireName:`username`,flag:`username`,required:!0,description:`Username to disable two-factor authentication for.`,type:{kind:`string`}}]},hidden:!1,deprecated:!1,rpc:{method:`user.unset_2fa_secret`,params:[`username`],job:!1,defaults:{}}},{path:[`user`,`update`],summary:`Update attributes of an existing user`,description:`Update attributes of an existing user.`,method:`POST`,route:`/user.update`,params:[],body:{required:!0,description:``,fields:[{wireName:`id`,flag:`id`,required:!0,description:`ID of the user account to update.`,type:{kind:`integer`}},{wireName:`user_update`,flag:`user-update`,required:!0,description:`Updated configuration for the user account.`,type:{kind:`json`}}]},hidden:!1,deprecated:!1,rpc:{method:`user.update`,params:[`id`,`user_update`],job:!1,defaults:{}}},{path:[`vm`,`bootloader-options`],summary:`Supported motherboard firmware options`,description:`Supported motherboard firmware options.`,method:`POST`,route:`/vm.bootloader_options`,params:[],hidden:!1,deprecated:!1,rpc:{method:`vm.bootloader_options`,params:[],job:!1,defaults:{}}},{path:[`vm`,`bootloader-ovmf-choices`],summary:`Retrieve bootloader ovmf choices`,description:`Retrieve bootloader ovmf choices.`,method:`POST`,route:`/vm.bootloader_ovmf_choices`,params:[],hidden:!1,deprecated:!1,rpc:{method:`vm.bootloader_ovmf_choices`,params:[],job:!1,defaults:{}}},{path:[`vm`,`clone`],summary:"Clone the VM ``id``",description:"Clone the VM ``id``.",method:`POST`,route:`/vm.clone`,params:[],body:{required:!0,description:``,fields:[{wireName:`id`,flag:`id`,required:!0,description:`ID of the virtual machine to clone.`,type:{kind:`integer`}},{wireName:`name`,flag:`name`,required:!1,description:"Name for the cloned virtual machine. `null` to auto-generate.",type:{kind:`string`}}]},hidden:!1,deprecated:!1,rpc:{method:`vm.clone`,params:[`id`,`name`],job:!1,defaults:{name:null}}},{path:[`vm`,`cpu-model-choices`],summary:`Retrieve CPU Model choices which can be used with a VM guest to emulate the CPU in the guest`,description:`Retrieve CPU Model choices which can be used with a VM guest to emulate the CPU in the guest.`,method:`POST`,route:`/vm.cpu_model_choices`,params:[],hidden:!1,deprecated:!1,rpc:{method:`vm.cpu_model_choices`,params:[],job:!1,defaults:{}}},{path:[`vm`,`create`],summary:`Create a Virtual Machine (VM)`,description:`Create a Virtual Machine (VM).`,method:`POST`,route:`/vm.create`,params:[],body:{required:!0,description:``,fields:[{wireName:`vm_create`,flag:`vm-create`,required:!0,description:`VMCreateArgs parameters.`,type:{kind:`json`}}]},hidden:!1,deprecated:!1,rpc:{method:`vm.create`,params:[`vm_create`],job:!1,defaults:{}}},{path:[`vm`,`delete`],summary:`Delete a VM`,description:`Delete a VM.`,method:`POST`,route:`/vm.delete`,params:[],body:{required:!0,description:``,fields:[{wireName:`id`,flag:`id`,required:!0,description:`ID of the virtual machine to delete.`,type:{kind:`integer`}},{wireName:`options`,flag:`options`,required:!1,description:`Options controlling the VM deletion process.`,type:{kind:`json`}}]},confirmation:``,hidden:!1,deprecated:!1,rpc:{method:`vm.delete`,params:[`id`,`options`],job:!1,defaults:{options:{zvols:!1,force:!1}}}},{path:[`vm`,`flags`],summary:`Returns a dictionary with CPU flags for the hypervisor`,description:`Returns a dictionary with CPU flags for the hypervisor.`,method:`POST`,route:`/vm.flags`,params:[],hidden:!1,deprecated:!1,rpc:{method:`vm.flags`,params:[],job:!1,defaults:{}}},{path:[`vm`,`get-available-memory`],summary:`Get the current maximum amount of available memory to be allocated for VMs`,description:`Get the current maximum amount of available memory to be allocated for VMs.`,method:`POST`,route:`/vm.get_available_memory`,params:[],body:{required:!1,description:``,fields:[{wireName:`overcommit`,flag:`overcommit`,required:!1,description:`Whether to include overcommitted memory in available memory calculation.`,type:{kind:`boolean`}}]},hidden:!1,deprecated:!1,rpc:{method:`vm.get_available_memory`,params:[`overcommit`],job:!1,defaults:{overcommit:!1}}},{path:[`vm`,`get-console`],summary:`Get the console device from a given guest`,description:`Get the console device from a given guest.`,method:`POST`,route:`/vm.get_console`,params:[],body:{required:!0,description:``,fields:[{wireName:`id`,flag:`id`,required:!0,description:`ID of the virtual machine to get console connection information for.`,type:{kind:`integer`}}]},hidden:!1,deprecated:!1,rpc:{method:`vm.get_console`,params:[`id`],job:!1,defaults:{}}},{path:[`vm`,`get-display-devices`],summary:`Get the display devices from a given guest`,description:`Get the display devices from a given guest.`,method:`POST`,route:`/vm.get_display_devices`,params:[],body:{required:!0,description:``,fields:[{wireName:`id`,flag:`id`,required:!0,description:`ID of the virtual machine to get display devices for.`,type:{kind:`integer`}}]},hidden:!1,deprecated:!1,rpc:{method:`vm.get_display_devices`,params:[`id`],job:!1,defaults:{}}},{path:[`vm`,`get-display-web-uri`],summary:`Retrieve Display URI for a given VM or appropriate error if there is no display device available or if it is not configured to use web interface`,description:`Retrieve Display URI for a given VM or appropriate error if there is no display device available or if it is not configured to use web interface.`,method:`POST`,route:`/vm.get_display_web_uri`,params:[],body:{required:!0,description:``,fields:[{wireName:`id`,flag:`id`,required:!0,description:`ID of the virtual machine to get display web URI for.`,type:{kind:`integer`}},{wireName:`host`,flag:`host`,required:!1,description:`Hostname or IP address to use in the URI. Empty string for automatic detection.`,type:{kind:`string`}},{wireName:`options`,flag:`options`,required:!1,description:`Options for generating the web display URI.`,type:{kind:`json`}}]},hidden:!1,deprecated:!1,rpc:{method:`vm.get_display_web_uri`,params:[`id`,`host`,`options`],job:!1,defaults:{host:``,options:{protocol:`HTTP`}}}},{path:[`vm`,`get-instance`],summary:"Returns instance matching `id`",description:"Returns instance matching `id`. If `id` is not found, Validation error is raised.",method:`POST`,route:`/vm.get_instance`,params:[],body:{required:!0,description:``,fields:[{wireName:`id`,flag:`id`,required:!0,description:``,type:{kind:`integer`}},{wireName:`options`,flag:`options`,required:!0,description:`Query options customize the results returned by a query method. More complete documentation with examples are covered in the "Query methods" section of the TrueNAS API documentation.`,type:{kind:`json`}}]},hidden:!1,deprecated:!1,rpc:{method:`vm.get_instance`,params:[`id`,`options`],job:!1,defaults:{}}},{path:[`vm`,`get-memory-usage`],summary:`Get the memory usage of a given VM`,description:`Get the memory usage of a given VM.`,method:`POST`,route:`/vm.get_memory_usage`,params:[],body:{required:!0,description:``,fields:[{wireName:`id`,flag:`id`,required:!0,description:`ID of the virtual machine to get memory usage for.`,type:{kind:`integer`}}]},hidden:!1,deprecated:!1,rpc:{method:`vm.get_memory_usage`,params:[`id`],job:!1,defaults:{}}},{path:[`vm`,`get-vm-memory-info`],summary:"Returns memory information for ``vm_id`` VM if it is going to be started",description:"Returns memory information for ``vm_id`` VM if it is going to be started.",method:`POST`,route:`/vm.get_vm_memory_info`,params:[],body:{required:!0,description:``,fields:[{wireName:`id`,flag:`id`,required:!0,description:`ID of the virtual machine to get memory information for.`,type:{kind:`integer`}}]},hidden:!1,deprecated:!1,rpc:{method:`vm.get_vm_memory_info`,params:[`id`],job:!1,defaults:{}}},{path:[`vm`,`get-vmemory-in-use`],summary:`Return the total amount of virtual memory, in bytes, used by guests`,description:`Return the total amount of virtual memory, in bytes, used by guests.`,method:`POST`,route:`/vm.get_vmemory_in_use`,params:[],hidden:!1,deprecated:!1,rpc:{method:`vm.get_vmemory_in_use`,params:[],job:!1,defaults:{}}},{path:[`vm`,`guest-architecture-and-machine-choices`],summary:`Retrieve choices for supported guest architecture types and machine choices`,description:`Retrieve choices for supported guest architecture types and machine choices.`,method:`POST`,route:`/vm.guest_architecture_and_machine_choices`,params:[],hidden:!1,deprecated:!1,rpc:{method:`vm.guest_architecture_and_machine_choices`,params:[],job:!1,defaults:{}}},{path:[`vm`,`log-file-path`],summary:"Retrieve log file path of ``id`` VM",description:"Retrieve log file path of ``id`` VM.",method:`POST`,route:`/vm.log_file_path`,params:[],body:{required:!0,description:``,fields:[{wireName:`id`,flag:`id`,required:!0,description:`ID of the virtual machine to get log file path for.`,type:{kind:`integer`}}]},hidden:!1,deprecated:!1,rpc:{method:`vm.log_file_path`,params:[`id`],job:!1,defaults:{}}},{path:[`vm`,`maximum-supported-vcpus`],summary:`Returns maximum supported VCPU's`,description:`Returns maximum supported VCPU's.`,method:`POST`,route:`/vm.maximum_supported_vcpus`,params:[],hidden:!1,deprecated:!1,rpc:{method:`vm.maximum_supported_vcpus`,params:[],job:!1,defaults:{}}},{path:[`vm`,`port-wizard`],summary:`It returns the next available Display Server Port and Web Port`,description:`It returns the next available Display Server Port and Web Port.`,method:`POST`,route:`/vm.port_wizard`,params:[],hidden:!1,deprecated:!1,rpc:{method:`vm.port_wizard`,params:[],job:!1,defaults:{}}},{path:[`vm`,`poweroff`],summary:`Poweroff a VM`,description:`Poweroff a VM.`,method:`POST`,route:`/vm.poweroff`,params:[],body:{required:!0,description:``,fields:[{wireName:`id`,flag:`id`,required:!0,description:`ID of the virtual machine to power off forcefully.`,type:{kind:`integer`}}]},hidden:!1,deprecated:!1,rpc:{method:`vm.poweroff`,params:[`id`],job:!1,defaults:{}}},{path:[`vm`,`query`],summary:``,description:``,method:`POST`,route:`/vm.query`,params:[],body:{required:!1,description:``,fields:[{wireName:`filters`,flag:`filters`,required:!1,description:`List of filters for query results. See API documentation for "Query Methods" for more guidance.`,type:{kind:`array`,elem:{kind:`json`}}},{wireName:`options`,flag:`options`,required:!1,description:`Query options including pagination, ordering, and additional parameters.`,type:{kind:`json`}}]},hidden:!1,deprecated:!1,rpc:{method:`vm.query`,params:[`filters`,`options`],job:!1,defaults:{filters:[],options:{extra:{},order_by:[],select:[],count:!1,get:!1,offset:0,limit:0,force_sql_filters:!1}}}},{path:[`vm`,`random-mac`],summary:`Create a random mac address`,description:`Create a random mac address.`,method:`POST`,route:`/vm.random_mac`,params:[],hidden:!1,deprecated:!1,rpc:{method:`vm.random_mac`,params:[],job:!1,defaults:{}}},{path:[`vm`,`resolution-choices`],summary:`Retrieve supported resolution choices for VM Display devices`,description:`Retrieve supported resolution choices for VM Display devices.`,method:`POST`,route:`/vm.resolution_choices`,params:[],hidden:!1,deprecated:!1,rpc:{method:`vm.resolution_choices`,params:[],job:!1,defaults:{}}},{path:[`vm`,`restart`],summary:`Restart a VM`,description:`Restart a VM.`,method:`POST`,route:`/vm.restart`,params:[],body:{required:!0,description:``,fields:[{wireName:`id`,flag:`id`,required:!0,description:`ID of the virtual machine to restart.`,type:{kind:`integer`}}]},hidden:!1,deprecated:!1,rpc:{method:`vm.restart`,params:[`id`],job:!0,defaults:{}}},{path:[`vm`,`resume`],summary:"Resume suspended ``id`` VM",description:"Resume suspended ``id`` VM.",method:`POST`,route:`/vm.resume`,params:[],body:{required:!0,description:``,fields:[{wireName:`id`,flag:`id`,required:!0,description:`ID of the virtual machine to resume from suspended state.`,type:{kind:`integer`}}]},hidden:!1,deprecated:!1,rpc:{method:`vm.resume`,params:[`id`],job:!1,defaults:{}}},{path:[`vm`,`start`],summary:`Start a VM`,description:`Start a VM.`,method:`POST`,route:`/vm.start`,params:[],body:{required:!0,description:``,fields:[{wireName:`id`,flag:`id`,required:!0,description:`ID of the virtual machine to start.`,type:{kind:`integer`}},{wireName:`options`,flag:`options`,required:!1,description:`Options controlling the VM start process.`,type:{kind:`json`}}]},hidden:!1,deprecated:!1,rpc:{method:`vm.start`,params:[`id`,`options`],job:!1,defaults:{options:{overcommit:!1}}}},{path:[`vm`,`status`],summary:"Get the status of ``id`` VM",description:"Get the status of ``id`` VM.",method:`POST`,route:`/vm.status`,params:[],body:{required:!0,description:``,fields:[{wireName:`id`,flag:`id`,required:!0,description:`ID of the virtual machine to get status for.`,type:{kind:`integer`}}]},hidden:!1,deprecated:!1,rpc:{method:`vm.status`,params:[`id`],job:!1,defaults:{}}},{path:[`vm`,`stop`],summary:`Stops a VM`,description:`Stops a VM.`,method:`POST`,route:`/vm.stop`,params:[],body:{required:!0,description:``,fields:[{wireName:`id`,flag:`id`,required:!0,description:`ID of the virtual machine to stop.`,type:{kind:`integer`}},{wireName:`options`,flag:`options`,required:!1,description:`Options controlling the VM stop process.`,type:{kind:`json`}}]},hidden:!1,deprecated:!1,rpc:{method:`vm.stop`,params:[`id`,`options`],job:!0,defaults:{options:{force:!1,force_after_timeout:!1}}}},{path:[`vm`,`supports-virtualization`],summary:`Returns "true" if system supports virtualization, "false" otherwise`,description:`Returns "true" if system supports virtualization, "false" otherwise.`,method:`POST`,route:`/vm.supports_virtualization`,params:[],hidden:!1,deprecated:!1,rpc:{method:`vm.supports_virtualization`,params:[],job:!1,defaults:{}}},{path:[`vm`,`suspend`],summary:"Suspend ``id`` VM",description:"Suspend ``id`` VM.",method:`POST`,route:`/vm.suspend`,params:[],body:{required:!0,description:``,fields:[{wireName:`id`,flag:`id`,required:!0,description:`ID of the virtual machine to suspend.`,type:{kind:`integer`}}]},hidden:!1,deprecated:!1,rpc:{method:`vm.suspend`,params:[`id`],job:!1,defaults:{}}},{path:[`vm`,`update`],summary:`Update all information of a specific VM`,description:`Update all information of a specific VM.`,method:`POST`,route:`/vm.update`,params:[],body:{required:!0,description:``,fields:[{wireName:`id`,flag:`id`,required:!0,description:`ID of the virtual machine to update.`,type:{kind:`integer`}},{wireName:`vm_update`,flag:`vm-update`,required:!0,description:`Updated configuration for the virtual machine.`,type:{kind:`json`}}]},hidden:!1,deprecated:!1,rpc:{method:`vm.update`,params:[`id`,`vm_update`],job:!1,defaults:{}}},{path:[`vm`,`virtualization-details`],summary:`Retrieve details if virtualization is supported on the system and in case why it's not supported if it isn't`,description:`Retrieve details if virtualization is supported on the system and in case why it's not supported if it isn't.`,method:`POST`,route:`/vm.virtualization_details`,params:[],hidden:!1,deprecated:!1,rpc:{method:`vm.virtualization_details`,params:[],job:!1,defaults:{}}},{path:[`vm`,`device`,`bind-choices`],summary:`Available choices for Bind attribute`,description:`Available choices for Bind attribute.`,method:`POST`,route:`/vm.device.bind_choices`,params:[],hidden:!1,deprecated:!1,rpc:{method:`vm.device.bind_choices`,params:[],job:!1,defaults:{}}},{path:[`vm`,`device`,`convert`],summary:`Convert between disk images and ZFS volumes`,description:`Convert between disk images and ZFS volumes. Supported disk image formats are qcow2, qed, raw, vdi, vhdx, and vmdk. The conversion direction is determined automatically based on file extension.`,method:`POST`,route:`/vm.device.convert`,params:[],body:{required:!0,description:``,fields:[{wireName:`vm_convert`,flag:`vm-convert`,required:!0,description:`VMDeviceConvertArgs parameters.`,type:{kind:`json`}}]},hidden:!1,deprecated:!1,rpc:{method:`vm.device.convert`,params:[`vm_convert`],job:!0,defaults:{}}},{path:[`vm`,`device`,`create`],summary:"Create a new device for the VM of id ``vm``",description:"Create a new device for the VM of id ``vm``.",method:`POST`,route:`/vm.device.create`,params:[],body:{required:!0,description:``,fields:[{wireName:`vm_device_create`,flag:`vm-device-create`,required:!0,description:`VMDeviceCreateArgs parameters.`,type:{kind:`json`}}]},hidden:!1,deprecated:!1,rpc:{method:`vm.device.create`,params:[`vm_device_create`],job:!1,defaults:{}}},{path:[`vm`,`device`,`delete`],summary:"Delete a VM device of ``id``",description:"Delete a VM device of ``id``.",method:`POST`,route:`/vm.device.delete`,params:[],body:{required:!0,description:``,fields:[{wireName:`id`,flag:`id`,required:!0,description:`ID of the VM device to delete.`,type:{kind:`integer`}},{wireName:`options`,flag:`options`,required:!1,description:`Options controlling the device deletion process.`,type:{kind:`json`}}]},confirmation:``,hidden:!1,deprecated:!1,rpc:{method:`vm.device.delete`,params:[`id`,`options`],job:!1,defaults:{options:{force:!1,raw_file:!1,zvol:!1}}}},{path:[`vm`,`device`,`disk-choices`],summary:`Returns disk choices for device type "DISK"`,description:`Returns disk choices for device type "DISK".`,method:`POST`,route:`/vm.device.disk_choices`,params:[],hidden:!1,deprecated:!1,rpc:{method:`vm.device.disk_choices`,params:[],job:!1,defaults:{}}},{path:[`vm`,`device`,`get-instance`],summary:"Returns instance matching `id`",description:"Returns instance matching `id`. If `id` is not found, Validation error is raised.",method:`POST`,route:`/vm.device.get_instance`,params:[],body:{required:!0,description:``,fields:[{wireName:`id`,flag:`id`,required:!0,description:``,type:{kind:`integer`}},{wireName:`options`,flag:`options`,required:!0,description:`Query options customize the results returned by a query method. More complete documentation with examples are covered in the "Query methods" section of the TrueNAS API documentation.`,type:{kind:`json`}}]},hidden:!1,deprecated:!1,rpc:{method:`vm.device.get_instance`,params:[`id`,`options`],job:!1,defaults:{}}},{path:[`vm`,`device`,`iommu-enabled`],summary:`Returns "true" if iommu is enabled, "false" otherwise`,description:`Returns "true" if iommu is enabled, "false" otherwise.`,method:`POST`,route:`/vm.device.iommu_enabled`,params:[],hidden:!1,deprecated:!1,rpc:{method:`vm.device.iommu_enabled`,params:[],job:!1,defaults:{}}},{path:[`vm`,`device`,`iotype-choices`],summary:`IO-type choices for storage devices`,description:`IO-type choices for storage devices.`,method:`POST`,route:`/vm.device.iotype_choices`,params:[],hidden:!1,deprecated:!1,rpc:{method:`vm.device.iotype_choices`,params:[],job:!1,defaults:{}}},{path:[`vm`,`device`,`nic-attach-choices`],summary:`Available choices for NIC Attach attribute`,description:`Available choices for NIC Attach attribute.`,method:`POST`,route:`/vm.device.nic_attach_choices`,params:[],hidden:!1,deprecated:!1,rpc:{method:`vm.device.nic_attach_choices`,params:[],job:!1,defaults:{}}},{path:[`vm`,`device`,`passthrough-device`],summary:"Retrieve details about ``device`` PCI device",description:"Retrieve details about ``device`` PCI device.",method:`POST`,route:`/vm.device.passthrough_device`,params:[],body:{required:!0,description:``,fields:[{wireName:`device`,flag:`device`,required:!0,description:`PCI device identifier to get passthrough information for.`,type:{kind:`string`}}]},hidden:!1,deprecated:!1,rpc:{method:`vm.device.passthrough_device`,params:[`device`],job:!1,defaults:{}}},{path:[`vm`,`device`,`passthrough-device-choices`],summary:`Available choices for PCI passthru devices`,description:`Available choices for PCI passthru devices.`,method:`POST`,route:`/vm.device.passthrough_device_choices`,params:[],hidden:!1,deprecated:!1,rpc:{method:`vm.device.passthrough_device_choices`,params:[],job:!1,defaults:{}}},{path:[`vm`,`device`,`query`],summary:``,description:``,method:`POST`,route:`/vm.device.query`,params:[],body:{required:!1,description:``,fields:[{wireName:`filters`,flag:`filters`,required:!1,description:`List of filters for query results. See API documentation for "Query Methods" for more guidance.`,type:{kind:`array`,elem:{kind:`json`}}},{wireName:`options`,flag:`options`,required:!1,description:`Query options including pagination, ordering, and additional parameters.`,type:{kind:`json`}}]},hidden:!1,deprecated:!1,rpc:{method:`vm.device.query`,params:[`filters`,`options`],job:!1,defaults:{filters:[],options:{extra:{},order_by:[],select:[],count:!1,get:!1,offset:0,limit:0,force_sql_filters:!1}}}},{path:[`vm`,`device`,`update`],summary:"Update a VM device of ``id``",description:"Update a VM device of ``id``.",method:`POST`,route:`/vm.device.update`,params:[],body:{required:!0,description:``,fields:[{wireName:`id`,flag:`id`,required:!0,description:`ID of the VM device to update.`,type:{kind:`integer`}},{wireName:`vm_device_update`,flag:`vm-device-update`,required:!0,description:`Updated configuration for the VM device.`,type:{kind:`json`}}]},hidden:!1,deprecated:!1,rpc:{method:`vm.device.update`,params:[`id`,`vm_device_update`],job:!1,defaults:{}}},{path:[`vm`,`device`,`usb-controller-choices`],summary:`Retrieve USB controller type choices`,description:`Retrieve USB controller type choices.`,method:`POST`,route:`/vm.device.usb_controller_choices`,params:[],hidden:!1,deprecated:!1,rpc:{method:`vm.device.usb_controller_choices`,params:[],job:!1,defaults:{}}},{path:[`vm`,`device`,`usb-passthrough-choices`],summary:`Available choices for USB passthrough devices`,description:`Available choices for USB passthrough devices.`,method:`POST`,route:`/vm.device.usb_passthrough_choices`,params:[],hidden:!1,deprecated:!1,rpc:{method:`vm.device.usb_passthrough_choices`,params:[],job:!1,defaults:{}}},{path:[`vm`,`device`,`usb-passthrough-device`],summary:"Retrieve details about ``device`` USB device",description:"Retrieve details about ``device`` USB device.",method:`POST`,route:`/vm.device.usb_passthrough_device`,params:[],body:{required:!0,description:``,fields:[{wireName:`device`,flag:`device`,required:!0,description:`USB device identifier to get passthrough information for.`,type:{kind:`string`}}]},hidden:!1,deprecated:!1,rpc:{method:`vm.device.usb_passthrough_device`,params:[`device`],job:!1,defaults:{}}},{path:[`vmware`,`create`],summary:`Create VMWare snapshot`,description:`Create VMWare snapshot.`,method:`POST`,route:`/vmware.create`,params:[],body:{required:!0,description:``,fields:[{wireName:`vmware_create`,flag:`vmware-create`,required:!0,description:`Configuration for creating a new VMware integration.`,type:{kind:`json`}}]},hidden:!1,deprecated:!1,rpc:{method:`vmware.create`,params:[`vmware_create`],job:!1,defaults:{}}},{path:[`vmware`,`dataset-has-vms`],summary:'Returns "true" if ``dataset`` is configured with a VMWare snapshot',description:'Returns "true" if ``dataset`` is configured with a VMWare snapshot.',method:`POST`,route:`/vmware.dataset_has_vms`,params:[],body:{required:!0,description:``,fields:[{wireName:`dataset`,flag:`dataset`,required:!0,description:`ZFS dataset path to check for VMware virtual machines.`,type:{kind:`string`}},{wireName:`recursive`,flag:`recursive`,required:!0,description:`Whether to check child datasets recursively.`,type:{kind:`boolean`}}]},hidden:!1,deprecated:!1,rpc:{method:`vmware.dataset_has_vms`,params:[`dataset`,`recursive`],job:!1,defaults:{}}},{path:[`vmware`,`delete`],summary:"Delete VMWare snapshot of ``id``",description:"Delete VMWare snapshot of ``id``.",method:`POST`,route:`/vmware.delete`,params:[],body:{required:!0,description:``,fields:[{wireName:`id`,flag:`id`,required:!0,description:`ID of the VMware configuration to delete.`,type:{kind:`integer`}}]},confirmation:``,hidden:!1,deprecated:!1,rpc:{method:`vmware.delete`,params:[`id`],job:!1,defaults:{}}},{path:[`vmware`,`get-datastores`],summary:`Get datastores from VMWare`,description:`Get datastores from VMWare.`,method:`POST`,route:`/vmware.get_datastores`,params:[],body:{required:!0,description:``,fields:[{wireName:`vmware-creds`,flag:`vmware-creds`,required:!0,description:`VMWareGetDatastoresArgs parameters.`,type:{kind:`json`}}]},hidden:!1,deprecated:!1,rpc:{method:`vmware.get_datastores`,params:[`vmware-creds`],job:!1,defaults:{}}},{path:[`vmware`,`get-instance`],summary:"Returns instance matching `id`",description:"Returns instance matching `id`. If `id` is not found, Validation error is raised.",method:`POST`,route:`/vmware.get_instance`,params:[],body:{required:!0,description:``,fields:[{wireName:`id`,flag:`id`,required:!0,description:``,type:{kind:`integer`}},{wireName:`options`,flag:`options`,required:!0,description:`Query options customize the results returned by a query method. More complete documentation with examples are covered in the "Query methods" section of the TrueNAS API documentation.`,type:{kind:`json`}}]},hidden:!1,deprecated:!1,rpc:{method:`vmware.get_instance`,params:[`id`,`options`],job:!1,defaults:{}}},{path:[`vmware`,`match-datastores-with-datasets`],summary:`Requests datastores from vCenter server and tries to match them with local filesystems`,description:`Requests datastores from vCenter server and tries to match them with local filesystems.`,method:`POST`,route:`/vmware.match_datastores_with_datasets`,params:[],body:{required:!0,description:``,fields:[{wireName:`vmware-creds`,flag:`vmware-creds`,required:!0,description:`VMWareMatchDatastoresWithDatasetsArgs parameters.`,type:{kind:`json`}}]},hidden:!1,deprecated:!1,rpc:{method:`vmware.match_datastores_with_datasets`,params:[`vmware-creds`],job:!1,defaults:{}}},{path:[`vmware`,`query`],summary:``,description:``,method:`POST`,route:`/vmware.query`,params:[],body:{required:!1,description:``,fields:[{wireName:`filters`,flag:`filters`,required:!1,description:`List of filters for query results. See API documentation for "Query Methods" for more guidance.`,type:{kind:`array`,elem:{kind:`json`}}},{wireName:`options`,flag:`options`,required:!1,description:`Query options including pagination, ordering, and additional parameters.`,type:{kind:`json`}}]},hidden:!1,deprecated:!1,rpc:{method:`vmware.query`,params:[`filters`,`options`],job:!1,defaults:{filters:[],options:{extra:{},order_by:[],select:[],count:!1,get:!1,offset:0,limit:0,force_sql_filters:!1}}}},{path:[`vmware`,`update`],summary:"Update VMWare snapshot of ``id``",description:"Update VMWare snapshot of ``id``.",method:`POST`,route:`/vmware.update`,params:[],body:{required:!0,description:``,fields:[{wireName:`id`,flag:`id`,required:!0,description:`ID of the VMware configuration to update.`,type:{kind:`integer`}},{wireName:`vmware_update`,flag:`vmware-update`,required:!0,description:`Updated configuration for the VMware integration.`,type:{kind:`json`}}]},hidden:!1,deprecated:!1,rpc:{method:`vmware.update`,params:[`id`,`vmware_update`],job:!1,defaults:{}}},{path:[`webui`,`crypto`,`csr-profiles`],summary:`Return predefined CSR profiles for common certificate roles`,description:`Return predefined CSR profiles for common certificate roles.`,method:`POST`,route:`/webui.crypto.csr_profiles`,params:[],hidden:!1,deprecated:!1,rpc:{method:`webui.crypto.csr_profiles`,params:[],job:!1,defaults:{}}},{path:[`webui`,`crypto`,`get-certificate-domain-names`],summary:`Return the domain names associated with a certificate`,description:`Return the domain names associated with a certificate.`,method:`POST`,route:`/webui.crypto.get_certificate_domain_names`,params:[],body:{required:!0,description:``,fields:[{wireName:`cert_id`,flag:`cert-id`,required:!0,description:`ID of the certificate to extract domain names from.`,type:{kind:`integer`}}]},hidden:!1,deprecated:!1,rpc:{method:`webui.crypto.get_certificate_domain_names`,params:[`cert_id`],job:!1,defaults:{}}},{path:[`webui`,`enclosure`,`dashboard`],summary:`This endpoint is used by the webUI for the enclosure dashboard page for TrueNAS sold hardware`,description:`This endpoint is used by the webUI for the enclosure dashboard page for TrueNAS sold hardware.`,method:`POST`,route:`/webui.enclosure.dashboard`,params:[],hidden:!1,deprecated:!1,rpc:{method:`webui.enclosure.dashboard`,params:[],job:!1,defaults:{}}},{path:[`webui`,`main`,`dashboard`,`sys-info`],summary:`This endpoint was designed to be exclusively consumed by the webUI`,description:`This endpoint was designed to be exclusively consumed by the webUI. This is what makes up the System Information card on the main dashboard after a user logs in.`,method:`POST`,route:`/webui.main.dashboard.sys_info`,params:[],hidden:!1,deprecated:!1,rpc:{method:`webui.main.dashboard.sys_info`,params:[],job:!1,defaults:{}}},{path:[`zfs`,`resource`,`query`],summary:`List ZFS resources (datasets and volumes) with flexible filtering options`,description:`List ZFS resources (datasets and volumes) with flexible filtering options.`,method:`POST`,route:`/zfs.resource.query`,params:[],body:{required:!1,description:``,fields:[{wireName:`data`,flag:`data`,required:!1,description:`Query parameters for retrieving ZFS resource information.`,type:{kind:`json`}}]},hidden:!1,deprecated:!1,rpc:{method:`zfs.resource.query`,params:[`data`],job:!1,defaults:{data:{paths:[],properties:[],get_user_properties:!1,get_source:!0,nest_results:!1,get_children:!1}}}},{path:[`alert`,`list-categories`],summary:`List all types of alerts which the system can issue`,description:`List all types of alerts which the system can issue.`,method:`POST`,route:`/alert.list_categories`,params:[],body:{required:!1,description:``,fields:[{wireName:`options`,flag:`options`,required:!1,description:`List options.`,type:{kind:`json`}}]},hidden:!1,deprecated:!1,rpc:{method:`alert.list_categories`,params:[`options`],job:!1,defaults:{options:{include_all_products:!1,include_hidden_classes:!1}}}},{path:[`api-key`,`convert-raw-key`],summary:`Convert a raw API key into its SCRAM authentication components`,description:`Convert a raw API key into its SCRAM authentication components.`,method:`POST`,route:`/api_key.convert_raw_key`,params:[],body:{required:!0,description:``,fields:[{wireName:`raw_key`,flag:`raw-key`,required:!0,description:`The raw API key to convert (format: id-key).`,type:{kind:`string`}}]},hidden:!1,deprecated:!1,rpc:{method:`api_key.convert_raw_key`,params:[`raw_key`],job:!1,defaults:{}}},{path:[`app`,`delete`],summary:"Delete ``app_name`` app",description:"Delete ``app_name`` app.",method:`POST`,route:`/app.delete`,params:[],body:{required:!0,description:``,fields:[{wireName:`app_name`,flag:`app-name`,required:!0,description:`Name of the application to delete.`,type:{kind:`string`}},{wireName:`options`,flag:`options`,required:!1,description:`Options controlling what gets removed along with the application.`,type:{kind:`json`}}]},confirmation:``,hidden:!1,deprecated:!1,rpc:{method:`app.delete`,params:[`app_name`,`options`],job:!0,defaults:{options:{remove_images:!0,remove_ix_volumes:!1,force_remove_custom_app:!1}}}},{path:[`app`,`upgrade-bulk`],summary:`Upgrade multiple apps sequentially, each with its own options, emitting a single consolidated alert once all upgrades have completed`,description:`Upgrade multiple apps sequentially, each with its own options, emitting a single consolidated alert once all upgrades have completed.`,method:`POST`,route:`/app.upgrade_bulk`,params:[],body:{required:!0,description:``,fields:[{wireName:`apps`,flag:`apps`,required:!0,description:`List of applications to upgrade, each with its own options.`,type:{kind:`array`,elem:{kind:`json`}}}]},hidden:!1,deprecated:!1,rpc:{method:`app.upgrade_bulk`,params:[`apps`],job:!0,defaults:{}}},{path:[`audit`,`export`],summary:"Generate an audit report based on the specified ``query-filters`` and ``query-options`` for the specified ``services`` in the specified ``export_format``",description:"Generate an audit report based on the specified ``query-filters`` and ``query-options`` for the specified ``services`` in the specified ``export_format``.",method:`POST`,route:`/audit.export`,params:[],body:{required:!1,description:``,fields:[{wireName:`data`,flag:`data`,required:!1,description:`Audit export configuration specifying services, filters, and format.`,type:{kind:`json`}}]},confirmation:``,hidden:!1,deprecated:!1,rpc:{method:`audit.export`,params:[`data`],job:!0,defaults:{data:{services:[`MIDDLEWARE`],"query-filters":[],"query-options":{force_sql_filters:!1,limit:0,offset:0,order_by:[],select:[]},remote_controller:!1,export_format:`JSON`}}}},{path:[`audit`,`query`],summary:"Query contents of audit databases specified by ``services``",description:"Query contents of audit databases specified by ``services``.",method:`POST`,route:`/audit.query`,params:[],body:{required:!1,description:``,fields:[{wireName:`data`,flag:`data`,required:!1,description:`Audit query configuration specifying services, filters, and options.`,type:{kind:`json`}}]},hidden:!1,deprecated:!1,rpc:{method:`audit.query`,params:[`data`],job:!1,defaults:{data:{services:[`MIDDLEWARE`],"query-filters":[],"query-options":{count:!1,extra:{},force_sql_filters:!1,get:!1,limit:0,offset:0,order_by:[],select:[]},remote_controller:!1}}}},{path:[`catalog`,`apps`],summary:"Retrieve apps details for ``label`` catalog",description:"Retrieve apps details for ``label`` catalog.",method:`POST`,route:`/catalog.apps`,params:[],body:{required:!0,description:``,fields:[{wireName:`data`,flag:`data`,required:!0,description:`Catalog apps query parameters.`,type:{kind:`json`}}]},hidden:!1,deprecated:!1,rpc:{method:`catalog.apps`,params:[`data`],job:!1,defaults:{}}},{path:[`catalog`,`synced`],summary:`Return whether the catalog has been synced at least once`,description:`Return whether the catalog has been synced at least once.`,method:`POST`,route:`/catalog.synced`,params:[],hidden:!1,deprecated:!1,rpc:{method:`catalog.synced`,params:[],job:!1,defaults:{}}},{path:[`catalog`,`update`],summary:`Update catalog preferences`,description:`Update catalog preferences.`,method:`POST`,route:`/catalog.update`,params:[],body:{required:!0,description:``,fields:[{wireName:`data`,flag:`data`,required:!0,description:`Catalog update parameters.`,type:{kind:`json`}}]},hidden:!1,deprecated:!1,rpc:{method:`catalog.update`,params:[`data`],job:!1,defaults:{}}},{path:[`cloudsync`,`credentials`,`s3-provider-choices`],summary:"Provide choices for S3 provider ``provider`` field",description:"Provide choices for S3 provider ``provider`` field.",method:`POST`,route:`/cloudsync.credentials.s3_provider_choices`,params:[],hidden:!1,deprecated:!1,rpc:{method:`cloudsync.credentials.s3_provider_choices`,params:[],job:!1,defaults:{}}},{path:[`container`,`create`],summary:`Create a Container`,description:`Create a Container.`,method:`POST`,route:`/container.create`,params:[],body:{required:!0,description:``,fields:[{wireName:`container_create`,flag:`container-create`,required:!0,description:`ContainerCreateArgs parameters.`,type:{kind:`json`}}]},hidden:!1,deprecated:!1,rpc:{method:`container.create`,params:[`container_create`],job:!0,defaults:{}}},{path:[`container`,`delete`],summary:`Delete a Container`,description:`Delete a Container.`,method:`POST`,route:`/container.delete`,params:[],body:{required:!0,description:``,fields:[{wireName:`id`,flag:`id`,required:!0,description:`Container ID.`,type:{kind:`integer`}},{wireName:`options`,flag:`options`,required:!1,description:`Container deletion options.`,type:{kind:`json`}}]},confirmation:``,hidden:!1,deprecated:!1,rpc:{method:`container.delete`,params:[`id`,`options`],job:!0,defaults:{options:{force:!1,recursive:!1}}}},{path:[`container`,`get-instance`],summary:"Returns instance matching `id`",description:"Returns instance matching `id`. If `id` is not found, Validation error is raised.",method:`POST`,route:`/container.get_instance`,params:[],body:{required:!0,description:``,fields:[{wireName:`id`,flag:`id`,required:!0,description:``,type:{kind:`integer`}},{wireName:`options`,flag:`options`,required:!0,description:`Query options customize the results returned by a query method. More complete documentation with examples are covered in the "Query methods" section of the TrueNAS API documentation.`,type:{kind:`json`}}]},hidden:!1,deprecated:!1,rpc:{method:`container.get_instance`,params:[`id`,`options`],job:!1,defaults:{}}},{path:[`container`,`migrate`],summary:`Migrate incus containers to new API`,description:`Migrate incus containers to new API.`,method:`POST`,route:`/container.migrate`,params:[],hidden:!1,deprecated:!1,rpc:{method:`container.migrate`,params:[],job:!0,defaults:{}}},{path:[`container`,`pool-choices`],summary:`Pool choices for container creation`,description:`Pool choices for container creation.`,method:`POST`,route:`/container.pool_choices`,params:[],hidden:!1,deprecated:!1,rpc:{method:`container.pool_choices`,params:[],job:!1,defaults:{}}},{path:[`container`,`query`],summary:``,description:``,method:`POST`,route:`/container.query`,params:[],body:{required:!1,description:``,fields:[{wireName:`filters`,flag:`filters`,required:!1,description:`List of filters for query results. See API documentation for "Query Methods" for more guidance.`,type:{kind:`array`,elem:{kind:`json`}}},{wireName:`options`,flag:`options`,required:!1,description:`Query options including pagination, ordering, and additional parameters.`,type:{kind:`json`}}]},hidden:!1,deprecated:!1,rpc:{method:`container.query`,params:[`filters`,`options`],job:!1,defaults:{filters:[],options:{extra:{},order_by:[],select:[],count:!1,get:!1,offset:0,limit:0,force_sql_filters:!1}}}},{path:[`container`,`start`],summary:`Start container`,description:`Start container.`,method:`POST`,route:`/container.start`,params:[],body:{required:!0,description:``,fields:[{wireName:`id`,flag:`id`,required:!0,description:`Container ID.`,type:{kind:`integer`}}]},hidden:!1,deprecated:!1,rpc:{method:`container.start`,params:[`id`],job:!1,defaults:{}}},{path:[`container`,`stop`],summary:"Stop ``id`` container",description:"Stop ``id`` container.",method:`POST`,route:`/container.stop`,params:[],body:{required:!0,description:``,fields:[{wireName:`id`,flag:`id`,required:!0,description:`Container ID.`,type:{kind:`integer`}},{wireName:`options`,flag:`options`,required:!1,description:`Container stop options.`,type:{kind:`json`}}]},hidden:!1,deprecated:!1,rpc:{method:`container.stop`,params:[`id`,`options`],job:!0,defaults:{options:{force:!1,force_after_timeout:!1}}}},{path:[`container`,`update`],summary:`Update a Container`,description:`Update a Container.`,method:`POST`,route:`/container.update`,params:[],body:{required:!0,description:``,fields:[{wireName:`id`,flag:`id`,required:!0,description:`Container ID.`,type:{kind:`integer`}},{wireName:`container_update`,flag:`container-update`,required:!0,description:`New container parameters.`,type:{kind:`json`}}]},hidden:!1,deprecated:!1,rpc:{method:`container.update`,params:[`id`,`container_update`],job:!1,defaults:{}}},{path:[`container`,`device`,`create`],summary:"Create a new device for the container of id ``container``",description:"Create a new device for the container of id ``container``.",method:`POST`,route:`/container.device.create`,params:[],body:{required:!0,description:``,fields:[{wireName:`container_device_create`,flag:`container-device-create`,required:!0,description:`ContainerDeviceCreateArgs parameters.`,type:{kind:`json`}}]},hidden:!1,deprecated:!1,rpc:{method:`container.device.create`,params:[`container_device_create`],job:!1,defaults:{}}},{path:[`container`,`device`,`delete`],summary:"Delete a container device of ``id``",description:"Delete a container device of ``id``.",method:`POST`,route:`/container.device.delete`,params:[],body:{required:!0,description:``,fields:[{wireName:`id`,flag:`id`,required:!0,description:`ID of the container device to delete.`,type:{kind:`integer`}},{wireName:`options`,flag:`options`,required:!1,description:`Options controlling the device deletion process.`,type:{kind:`json`}}]},confirmation:``,hidden:!1,deprecated:!1,rpc:{method:`container.device.delete`,params:[`id`,`options`],job:!1,defaults:{options:{force:!1,raw_file:!1,zvol:!1}}}},{path:[`container`,`device`,`get-instance`],summary:"Returns instance matching `id`",description:"Returns instance matching `id`. If `id` is not found, Validation error is raised.",method:`POST`,route:`/container.device.get_instance`,params:[],body:{required:!0,description:``,fields:[{wireName:`id`,flag:`id`,required:!0,description:``,type:{kind:`integer`}},{wireName:`options`,flag:`options`,required:!0,description:`Query options customize the results returned by a query method. More complete documentation with examples are covered in the "Query methods" section of the TrueNAS API documentation.`,type:{kind:`json`}}]},hidden:!1,deprecated:!1,rpc:{method:`container.device.get_instance`,params:[`id`,`options`],job:!1,defaults:{}}},{path:[`container`,`device`,`gpu-choices`],summary:`Available choices for GPU devices`,description:`Available choices for GPU devices.`,method:`POST`,route:`/container.device.gpu_choices`,params:[],hidden:!1,deprecated:!1,rpc:{method:`container.device.gpu_choices`,params:[],job:!1,defaults:{}}},{path:[`container`,`device`,`nic-attach-choices`],summary:`Available choices for NIC Attach attribute`,description:`Available choices for NIC Attach attribute.`,method:`POST`,route:`/container.device.nic_attach_choices`,params:[],hidden:!1,deprecated:!1,rpc:{method:`container.device.nic_attach_choices`,params:[],job:!1,defaults:{}}},{path:[`container`,`device`,`query`],summary:``,description:``,method:`POST`,route:`/container.device.query`,params:[],body:{required:!1,description:``,fields:[{wireName:`filters`,flag:`filters`,required:!1,description:`List of filters for query results. See API documentation for "Query Methods" for more guidance.`,type:{kind:`array`,elem:{kind:`json`}}},{wireName:`options`,flag:`options`,required:!1,description:`Query options including pagination, ordering, and additional parameters.`,type:{kind:`json`}}]},hidden:!1,deprecated:!1,rpc:{method:`container.device.query`,params:[`filters`,`options`],job:!1,defaults:{filters:[],options:{extra:{},order_by:[],select:[],count:!1,get:!1,offset:0,limit:0,force_sql_filters:!1}}}},{path:[`container`,`device`,`update`],summary:"Update a container device of ``id``",description:"Update a container device of ``id``.",method:`POST`,route:`/container.device.update`,params:[],body:{required:!0,description:``,fields:[{wireName:`id`,flag:`id`,required:!0,description:`ID of the container device to update.`,type:{kind:`integer`}},{wireName:`container_device_update`,flag:`container-device-update`,required:!0,description:`Updated configuration for the container device.`,type:{kind:`json`}}]},hidden:!1,deprecated:!1,rpc:{method:`container.device.update`,params:[`id`,`container_device_update`],job:!1,defaults:{}}},{path:[`container`,`device`,`usb-choices`],summary:`Available choices for USB passthrough devices`,description:`Available choices for USB passthrough devices.`,method:`POST`,route:`/container.device.usb_choices`,params:[],hidden:!1,deprecated:!1,rpc:{method:`container.device.usb_choices`,params:[],job:!1,defaults:{}}},{path:[`container`,`image`,`query-registry`],summary:`Query images available in the images registry`,description:`Query images available in the images registry.`,method:`POST`,route:`/container.image.query_registry`,params:[],hidden:!1,deprecated:!1,rpc:{method:`container.image.query_registry`,params:[],job:!1,defaults:{}}},{path:[`core`,`download`],summary:`Call a job that produces downloadable output and get a URL to retrieve the result`,description:`Call a job that produces downloadable output and get a URL to retrieve the result.`,method:`POST`,route:`/core.download`,params:[],body:{required:!0,description:``,fields:[{wireName:`method`,flag:`method`,required:!0,description:`Name of the job method to execute.`,type:{kind:`string`}},{wireName:`args`,flag:`args`,required:!0,description:`Arguments to pass to the job method.`,type:{kind:`array`,elem:{kind:`json`}}},{wireName:`filename`,flag:`filename`,required:!0,description:"Suggested filename for the downloaded file. Sets the `Content-Disposition` header.",type:{kind:`string`}},{wireName:`buffered`,flag:`buffered`,required:!1,description:`Whether to buffer the job's output.`,type:{kind:`boolean`}}]},hidden:!1,deprecated:!1,rpc:{method:`core.download`,params:[`method`,`args`,`filename`,`buffered`],job:!1,defaults:{buffered:!1}}},{path:[`directoryservices`,`sync-keytab`],summary:`Sync local keytab with remote domain controller`,description:`Sync local keytab with remote domain controller. This is required if additional kerberos SPNs were added to the truenas account in the remote domain controller after joining the directory service.`,method:`POST`,route:`/directoryservices.sync_keytab`,params:[],hidden:!1,deprecated:!1,rpc:{method:`directoryservices.sync_keytab`,params:[],job:!0,defaults:{}}},{path:[`disk`,`reset-sed`],summary:`Reset SED disk`,description:`Reset SED disk.`,method:`POST`,route:`/disk.reset_sed`,params:[],body:{required:!0,description:``,fields:[{wireName:`disk_sed_reset`,flag:`disk-sed-reset`,required:!0,description:`DiskResetSedArgs parameters.`,type:{kind:`json`}}]},hidden:!1,deprecated:!1,rpc:{method:`disk.reset_sed`,params:[`disk_sed_reset`],job:!1,defaults:{}}},{path:[`disk`,`setup-sed`],summary:"Setup specified ``options.name`` SED disk",description:"Setup specified ``options.name`` SED disk.",method:`POST`,route:`/disk.setup_sed`,params:[],body:{required:!0,description:``,fields:[{wireName:`disk_sed_setup`,flag:`disk-sed-setup`,required:!0,description:`DiskSetupSedArgs parameters.`,type:{kind:`json`}}]},hidden:!1,deprecated:!1,rpc:{method:`disk.setup_sed`,params:[`disk_sed_setup`],job:!1,defaults:{}}},{path:[`disk`,`unlock-sed`],summary:"Unlock specified ``options.name`` SED disk",description:"Unlock specified ``options.name`` SED disk.",method:`POST`,route:`/disk.unlock_sed`,params:[],body:{required:!0,description:``,fields:[{wireName:`disk_sed_unlock`,flag:`disk-sed-unlock`,required:!0,description:`DiskUnlockSedArgs parameters.`,type:{kind:`json`}}]},hidden:!1,deprecated:!1,rpc:{method:`disk.unlock_sed`,params:[`disk_sed_unlock`],job:!1,defaults:{}}},{path:[`fcport`,`status`],summary:`Return the runtime status of Fibre Channel ports, including port state, type, speed, and connected sessions`,description:`Return the runtime status of Fibre Channel ports, including port state, type, speed, and connected sessions.`,method:`POST`,route:`/fcport.status`,params:[],body:{required:!1,description:``,fields:[{wireName:`filters`,flag:`filters`,required:!1,description:`List of filters for query results. See API documentation for "Query Methods" for more guidance.`,type:{kind:`array`,elem:{kind:`json`}}},{wireName:`options`,flag:`options`,required:!1,description:``,type:{kind:`json`}}]},hidden:!1,deprecated:!1,rpc:{method:`fcport.status`,params:[`filters`,`options`],job:!1,defaults:{filters:[],options:{extra:{with_lun_access:!0},order_by:[],select:[],count:!1,get:!1,offset:0,limit:0,force_sql_filters:!1}}}},{path:[`interface`,`available-fec-modes`],summary:"Returns FEC modes supported by interface ``id``",description:"Returns FEC modes supported by interface ``id``.",method:`POST`,route:`/interface.available_fec_modes`,params:[],body:{required:!0,description:``,fields:[{wireName:`id`,flag:`id`,required:!0,description:`ID of the interface to query for supported FEC modes.`,type:{kind:`string`}}]},hidden:!1,deprecated:!1,rpc:{method:`interface.available_fec_modes`,params:[`id`],job:!1,defaults:{}}},{path:[`ipmi`,`chassis`,`identify`],summary:`Toggle the chassis identify light on or off`,description:`Toggle the chassis identify light on or off.`,method:`POST`,route:`/ipmi.chassis.identify`,params:[],body:{required:!0,description:``,fields:[{wireName:`data`,flag:`data`,required:!0,description:`Request parameters for IPMI chassis identify operation.`,type:{kind:`json`}}]},hidden:!1,deprecated:!1,rpc:{method:`ipmi.chassis.identify`,params:[`data`],job:!1,defaults:{}}},{path:[`ipmi`,`chassis`,`info`],summary:`Return IPMI chassis info`,description:`Return IPMI chassis info.`,method:`POST`,route:`/ipmi.chassis.info`,params:[],body:{required:!0,description:``,fields:[{wireName:`data`,flag:`data`,required:!0,description:`Request parameters for IPMI chassis information.`,type:{kind:`json`}}]},hidden:!1,deprecated:!1,rpc:{method:`ipmi.chassis.info`,params:[`data`],job:!1,defaults:{}}},{path:[`lxc`,`bridge-choices`],summary:`Bridge choices for virtualization purposes`,description:`Bridge choices for virtualization purposes.`,method:`POST`,route:`/lxc.bridge_choices`,params:[],hidden:!1,deprecated:!1,rpc:{method:`lxc.bridge_choices`,params:[],job:!1,defaults:{}}},{path:[`lxc`,`config`],summary:``,description:``,method:`POST`,route:`/lxc.config`,params:[],hidden:!1,deprecated:!1,rpc:{method:`lxc.config`,params:[],job:!1,defaults:{}}},{path:[`lxc`,`update`],summary:`Update container config`,description:`Update container config.`,method:`POST`,route:`/lxc.update`,params:[],body:{required:!0,description:``,fields:[{wireName:`lxc_config_update`,flag:`lxc-config-update`,required:!0,description:`LXCConfigUpdateArgs parameters.`,type:{kind:`json`}}]},hidden:!1,deprecated:!1,rpc:{method:`lxc.update`,params:[`lxc_config_update`],job:!1,defaults:{}}},{path:[`pool`,`prefetch`],summary:`Prefetch pool metadata (DDT and BRT) into ARC`,description:`Prefetch pool metadata (DDT and BRT) into ARC.`,method:`POST`,route:`/pool.prefetch`,params:[],body:{required:!0,description:``,fields:[{wireName:`pool_name`,flag:`pool-name`,required:!0,description:`Name of the pool to prefetch metadata for.`,type:{kind:`string`}}]},hidden:!1,deprecated:!1,rpc:{method:`pool.prefetch`,params:[`pool_name`],job:!0,defaults:{}}},{path:[`pool`,`reimport`],summary:`Attempt to import a pool that exists in database but is currently OFFLINE`,description:`Attempt to import a pool that exists in database but is currently OFFLINE.`,method:`POST`,route:`/pool.reimport`,params:[],body:{required:!0,description:``,fields:[{wireName:`id`,flag:`id`,required:!0,description:`ID of the pool to reimport.`,type:{kind:`integer`}}]},hidden:!1,deprecated:!1,rpc:{method:`pool.reimport`,params:[`id`],job:!0,defaults:{}}},{path:[`pool`,`dataset`,`get-quota`],summary:"Return a list of the specified ``quota_type`` of quotas on the ZFS dataset ``ds``",description:"Return a list of the specified ``quota_type`` of quotas on the ZFS dataset ``ds``. Supports ``query-filters`` and ``query-options``.",method:`POST`,route:`/pool.dataset.get_quota`,params:[],body:{required:!0,description:``,fields:[{wireName:`dataset`,flag:`dataset`,required:!0,description:`The dataset path to retrieve quotas for.`,type:{kind:`string`}},{wireName:`quota_type`,flag:`quota-type`,required:!0,description:`The type of quotas to retrieve.`,type:{kind:`enum`,values:[`USER`,`GROUP`,`DATASET`,`PROJECT`]}},{wireName:`filters`,flag:`filters`,required:!1,description:`Query filters to limit the results returned.`,type:{kind:`array`,elem:{kind:`json`}}},{wireName:`options`,flag:`options`,required:!1,description:`Query options such as sorting and pagination.`,type:{kind:`json`}}]},hidden:!1,deprecated:!1,rpc:{method:`pool.dataset.get_quota`,params:[`dataset`,`quota_type`,`filters`,`options`],job:!1,defaults:{filters:[],options:{extra:{},order_by:[],select:[],count:!1,get:!1,offset:0,limit:0,force_sql_filters:!1}}}},{path:[`privilege`,`become-readonly`],summary:"Reduce the privileges of the current user credentials to ``READONLY_ADMINS``",description:"Reduce the privileges of the current user credentials to ``READONLY_ADMINS``. This action prevents the session from making configuration changes. It also redacts sensitive data in API output.",method:`POST`,route:`/privilege.become_readonly`,params:[],hidden:!1,deprecated:!1,rpc:{method:`privilege.become_readonly`,params:[],job:!1,defaults:{}}},{path:[`replication`,`run`],summary:"Run Replication Task of ``id``",description:"Run Replication Task of ``id``.",method:`POST`,route:`/replication.run`,params:[],body:{required:!0,description:``,fields:[{wireName:`id`,flag:`id`,required:!0,description:`ID of the replication task to run.`,type:{kind:`integer`}},{wireName:`options`,flag:`options`,required:!0,description:`Options for running the replication task.`,type:{kind:`json`}}]},hidden:!1,deprecated:!1,rpc:{method:`replication.run`,params:[`id`,`options`],job:!0,defaults:{}}},{path:[`s3`,`bindip-choices`],summary:`Returns the IP addresses a listener may name`,description:`Returns the IP addresses a listener may name.`,method:`POST`,route:`/s3.bindip_choices`,params:[],hidden:!1,deprecated:!1,rpc:{method:`s3.bindip_choices`,params:[],job:!1,defaults:{}}},{path:[`s3`,`config`],summary:``,description:``,method:`POST`,route:`/s3.config`,params:[],hidden:!1,deprecated:!1,rpc:{method:`s3.config`,params:[],job:!1,defaults:{}}},{path:[`s3`,`update`],summary:`Update the S3 service configuration`,description:`Update the S3 service configuration.`,method:`POST`,route:`/s3.update`,params:[],body:{required:!0,description:``,fields:[{wireName:`data`,flag:`data`,required:!0,description:`S3 service configuration changes to apply.`,type:{kind:`json`}}]},hidden:!1,deprecated:!1,rpc:{method:`s3.update`,params:[`data`],job:!1,defaults:{}}},{path:[`s3`,`accesskey`,`create`],summary:`Create an S3 access key`,description:`Create an S3 access key.`,method:`POST`,route:`/s3.accesskey.create`,params:[],body:{required:!0,description:``,fields:[{wireName:`data`,flag:`data`,required:!0,description:`Configuration for the new access key.`,type:{kind:`json`}}]},hidden:!1,deprecated:!1,rpc:{method:`s3.accesskey.create`,params:[`data`],job:!1,defaults:{}}},{path:[`s3`,`accesskey`,`delete`],summary:"Delete S3 access key ``id``",description:"Delete S3 access key ``id``.",method:`POST`,route:`/s3.accesskey.delete`,params:[],body:{required:!0,description:``,fields:[{wireName:`id`,flag:`id`,required:!0,description:`ID of the access key to delete.`,type:{kind:`integer`}}]},confirmation:``,hidden:!1,deprecated:!1,rpc:{method:`s3.accesskey.delete`,params:[`id`],job:!1,defaults:{}}},{path:[`s3`,`accesskey`,`get-instance`],summary:"Returns instance matching `id`",description:"Returns instance matching `id`. If `id` is not found, Validation error is raised.",method:`POST`,route:`/s3.accesskey.get_instance`,params:[],body:{required:!0,description:``,fields:[{wireName:`id`,flag:`id`,required:!0,description:``,type:{kind:`integer`}},{wireName:`options`,flag:`options`,required:!0,description:`Query options customize the results returned by a query method. More complete documentation with examples are covered in the "Query methods" section of the TrueNAS API documentation.`,type:{kind:`json`}}]},hidden:!1,deprecated:!1,rpc:{method:`s3.accesskey.get_instance`,params:[`id`,`options`],job:!1,defaults:{}}},{path:[`s3`,`accesskey`,`query`],summary:``,description:``,method:`POST`,route:`/s3.accesskey.query`,params:[],body:{required:!1,description:``,fields:[{wireName:`filters`,flag:`filters`,required:!1,description:`List of filters for query results. See API documentation for "Query Methods" for more guidance.`,type:{kind:`array`,elem:{kind:`json`}}},{wireName:`options`,flag:`options`,required:!1,description:`Query options including pagination, ordering, and additional parameters.`,type:{kind:`json`}}]},hidden:!1,deprecated:!1,rpc:{method:`s3.accesskey.query`,params:[`filters`,`options`],job:!1,defaults:{filters:[],options:{extra:{},order_by:[],select:[],count:!1,get:!1,offset:0,limit:0,force_sql_filters:!1}}}},{path:[`s3`,`accesskey`,`update`],summary:"Update S3 access key ``id``",description:"Update S3 access key ``id``.",method:`POST`,route:`/s3.accesskey.update`,params:[],body:{required:!0,description:``,fields:[{wireName:`id`,flag:`id`,required:!0,description:`ID of the access key to update.`,type:{kind:`integer`}},{wireName:`data`,flag:`data`,required:!0,description:`Access key changes to apply.`,type:{kind:`json`}}]},hidden:!1,deprecated:!1,rpc:{method:`s3.accesskey.update`,params:[`id`,`data`],job:!1,defaults:{}}},{path:[`sharing`,`s3`,`audit-choices`],summary:`Returns the actions an audit mask may name`,description:`Returns the actions an audit mask may name.`,method:`POST`,route:`/sharing.s3.audit_choices`,params:[],hidden:!1,deprecated:!1,rpc:{method:`sharing.s3.audit_choices`,params:[],job:!1,defaults:{}}},{path:[`sharing`,`s3`,`create`],summary:`Create an S3 bucket`,description:`Create an S3 bucket.`,method:`POST`,route:`/sharing.s3.create`,params:[],body:{required:!0,description:``,fields:[{wireName:`data`,flag:`data`,required:!0,description:`Configuration for the new bucket.`,type:{kind:`json`}}]},hidden:!1,deprecated:!1,rpc:{method:`sharing.s3.create`,params:[`data`],job:!1,defaults:{}}},{path:[`sharing`,`s3`,`delete`],summary:"Deregister S3 bucket ``id``",description:"Deregister S3 bucket ``id``.",method:`POST`,route:`/sharing.s3.delete`,params:[],body:{required:!0,description:``,fields:[{wireName:`id`,flag:`id`,required:!0,description:`ID of the bucket to delete.`,type:{kind:`integer`}}]},confirmation:``,hidden:!1,deprecated:!1,rpc:{method:`sharing.s3.delete`,params:[`id`],job:!1,defaults:{}}},{path:[`sharing`,`s3`,`force-disable-versioning`],summary:"Force versioning off for S3 bucket ``id``, destroying its version history",description:"Force versioning off for S3 bucket ``id``, destroying its version history.",method:`POST`,route:`/sharing.s3.force_disable_versioning`,params:[],body:{required:!0,description:``,fields:[{wireName:`id`,flag:`id`,required:!0,description:`ID of the bucket whose versioning is forced off.`,type:{kind:`integer`}}]},hidden:!1,deprecated:!1,rpc:{method:`sharing.s3.force_disable_versioning`,params:[`id`],job:!1,defaults:{}}},{path:[`sharing`,`s3`,`get-instance`],summary:"Returns instance matching `id`",description:"Returns instance matching `id`. If `id` is not found, Validation error is raised.",method:`POST`,route:`/sharing.s3.get_instance`,params:[],body:{required:!0,description:``,fields:[{wireName:`id`,flag:`id`,required:!0,description:``,type:{kind:`integer`}},{wireName:`options`,flag:`options`,required:!0,description:`Query options customize the results returned by a query method. More complete documentation with examples are covered in the "Query methods" section of the TrueNAS API documentation.`,type:{kind:`json`}}]},hidden:!1,deprecated:!1,rpc:{method:`sharing.s3.get_instance`,params:[`id`,`options`],job:!1,defaults:{}}},{path:[`sharing`,`s3`,`query`],summary:``,description:``,method:`POST`,route:`/sharing.s3.query`,params:[],body:{required:!1,description:``,fields:[{wireName:`filters`,flag:`filters`,required:!1,description:`List of filters for query results. See API documentation for "Query Methods" for more guidance.`,type:{kind:`array`,elem:{kind:`json`}}},{wireName:`options`,flag:`options`,required:!1,description:`Query options including pagination, ordering, and additional parameters.`,type:{kind:`json`}}]},hidden:!1,deprecated:!1,rpc:{method:`sharing.s3.query`,params:[`filters`,`options`],job:!1,defaults:{filters:[],options:{extra:{},order_by:[],select:[],count:!1,get:!1,offset:0,limit:0,force_sql_filters:!1}}}},{path:[`sharing`,`s3`,`recover`],summary:`Recover buckets from datasets that already hold their objects`,description:`Recover buckets from datasets that already hold their objects.`,method:`POST`,route:`/sharing.s3.recover`,params:[],body:{required:!0,description:``,fields:[{wireName:`buckets`,flag:`buckets`,required:!0,description:`Array of datasets to recover. Each dataset gets a separate success / failure answer.`,type:{kind:`array`,elem:{kind:`json`}}}]},hidden:!1,deprecated:!1,rpc:{method:`sharing.s3.recover`,params:[`buckets`],job:!1,defaults:{}}},{path:[`sharing`,`s3`,`recoverable-buckets`],summary:`Returns buckets that are no longer registered but whose datasets still exist`,description:`Returns buckets that are no longer registered but whose datasets still exist.`,method:`POST`,route:`/sharing.s3.recoverable_buckets`,params:[],hidden:!1,deprecated:!1,rpc:{method:`sharing.s3.recoverable_buckets`,params:[],job:!1,defaults:{}}},{path:[`sharing`,`s3`,`update`],summary:"Update S3 bucket ``id``",description:"Update S3 bucket ``id``.",method:`POST`,route:`/sharing.s3.update`,params:[],body:{required:!0,description:``,fields:[{wireName:`id`,flag:`id`,required:!0,description:`ID of the bucket to update.`,type:{kind:`integer`}},{wireName:`data`,flag:`data`,required:!0,description:"Bucket changes to apply. `grants` replaces the whole list.",type:{kind:`json`}}]},hidden:!1,deprecated:!1,rpc:{method:`sharing.s3.update`,params:[`id`,`data`],job:!1,defaults:{}}},{path:[`sharing`,`webshare`,`create`],summary:`Create a Webshare share that exposes a local ZFS path over the Webshare protocol`,description:`Create a Webshare share that exposes a local ZFS path over the Webshare protocol.`,method:`POST`,route:`/sharing.webshare.create`,params:[],body:{required:!0,description:``,fields:[{wireName:`data`,flag:`data`,required:!0,description:`Webshare share configuration data for the new share.`,type:{kind:`json`}}]},hidden:!1,deprecated:!1,rpc:{method:`sharing.webshare.create`,params:[`data`],job:!1,defaults:{}}},{path:[`sharing`,`webshare`,`delete`],summary:"Delete SMB Share of ``id``",description:"Delete SMB Share of ``id``. This will forcibly disconnect SMB clients that are accessing the share.",method:`POST`,route:`/sharing.webshare.delete`,params:[],body:{required:!0,description:``,fields:[{wireName:`id`,flag:`id`,required:!0,description:`ID of the Webshare share to delete.`,type:{kind:`integer`}}]},confirmation:``,hidden:!1,deprecated:!1,rpc:{method:`sharing.webshare.delete`,params:[`id`],job:!1,defaults:{}}},{path:[`sharing`,`webshare`,`get-instance`],summary:"Returns instance matching `id`",description:"Returns instance matching `id`. If `id` is not found, Validation error is raised.",method:`POST`,route:`/sharing.webshare.get_instance`,params:[],body:{required:!0,description:``,fields:[{wireName:`id`,flag:`id`,required:!0,description:``,type:{kind:`integer`}},{wireName:`options`,flag:`options`,required:!0,description:`Query options customize the results returned by a query method. More complete documentation with examples are covered in the "Query methods" section of the TrueNAS API documentation.`,type:{kind:`json`}}]},hidden:!1,deprecated:!1,rpc:{method:`sharing.webshare.get_instance`,params:[`id`,`options`],job:!1,defaults:{}}},{path:[`sharing`,`webshare`,`query`],summary:``,description:``,method:`POST`,route:`/sharing.webshare.query`,params:[],body:{required:!1,description:``,fields:[{wireName:`filters`,flag:`filters`,required:!1,description:`List of filters for query results. See API documentation for "Query Methods" for more guidance.`,type:{kind:`array`,elem:{kind:`json`}}},{wireName:`options`,flag:`options`,required:!1,description:`Query options including pagination, ordering, and additional parameters.`,type:{kind:`json`}}]},hidden:!1,deprecated:!1,rpc:{method:`sharing.webshare.query`,params:[`filters`,`options`],job:!1,defaults:{filters:[],options:{extra:{},order_by:[],select:[],count:!1,get:!1,offset:0,limit:0,force_sql_filters:!1}}}},{path:[`sharing`,`webshare`,`update`],summary:"Update the Webshare share identified by ``id``",description:"Update the Webshare share identified by ``id``.",method:`POST`,route:`/sharing.webshare.update`,params:[],body:{required:!0,description:``,fields:[{wireName:`id`,flag:`id`,required:!0,description:`ID of the Webshare share to update.`,type:{kind:`integer`}},{wireName:`data`,flag:`data`,required:!0,description:`Updated Webshare share configuration data.`,type:{kind:`json`}}]},hidden:!1,deprecated:!1,rpc:{method:`sharing.webshare.update`,params:[`id`,`data`],job:!1,defaults:{}}},{path:[`smb`,`status`],summary:`Returns SMB server status (sessions, open files, locks, notifications)`,description:`Returns SMB server status (sessions, open files, locks, notifications).`,method:`POST`,route:`/smb.status`,params:[],body:{required:!1,description:``,fields:[{wireName:`info_level`,flag:`info-level`,required:!1,description:`Type of information requests. Defaults to "ALL".`,type:{kind:`enum`,values:[`ALL`,`SESSIONS`,`SHARES`,`LOCKS`,`BYTERANGE`,`NOTIFICATIONS`]}},{wireName:`filters`,flag:`filters`,required:!1,description:`Query filters to apply to the status results.`,type:{kind:`array`,elem:{kind:`json`}}},{wireName:`options`,flag:`options`,required:!1,description:`Query options for controlling result pagination and ordering.`,type:{kind:`json`}},{wireName:`status_options`,flag:`status-options`,required:!1,description:`Additional options for retrieving and formatting SMB status information.`,type:{kind:`json`}}]},hidden:!1,deprecated:!1,rpc:{method:`smb.status`,params:[`info_level`,`filters`,`options`,`status_options`],job:!1,defaults:{info_level:`ALL`,filters:[],options:{extra:{},order_by:[],select:[],count:!1,get:!1,offset:0,limit:0,force_sql_filters:!1},status_options:{verbose:!0,fast:!1,restrict_user:``,restrict_session:``,resolve_uids:!0}}}},{path:[`system`,`feature-enabled`],summary:"Returns whether the ``feature`` is enabled",description:"Returns whether the ``feature`` is enabled.",method:`POST`,route:`/system.feature_enabled`,params:[],body:{required:!0,description:``,fields:[{wireName:`feature`,flag:`feature`,required:!0,description:`Feature to check for availability on this system. A feature this system does not recognize or does not gate is reported as available.`,type:{kind:`string`}}]},hidden:!1,deprecated:!1,rpc:{method:`system.feature_enabled`,params:[`feature`],job:!1,defaults:{}}},{path:[`system`,`advanced`,`nvidia-present`],summary:`Returns whether a non-isolated NVIDIA GPU is present in the system`,description:`Returns whether a non-isolated NVIDIA GPU is present in the system.`,method:`POST`,route:`/system.advanced.nvidia_present`,params:[],hidden:!1,deprecated:!1,rpc:{method:`system.advanced.nvidia_present`,params:[],job:!1,defaults:{}}},{path:[`tn-connect`,`ips-with-hostnames`],summary:`Returns current mapping of ips configured with truenas connect against their hostnames`,description:`Returns current mapping of ips configured with truenas connect against their hostnames.`,method:`POST`,route:`/tn_connect.ips_with_hostnames`,params:[],hidden:!1,deprecated:!1,rpc:{method:`tn_connect.ips_with_hostnames`,params:[],job:!1,defaults:{}}},{path:[`truenas`,`entitlements`,`check`],summary:"Return the entitlement for ``feature`` computed from current system facts",description:"Return the entitlement for ``feature`` computed from current system facts.",method:`POST`,route:`/truenas.entitlements.check`,params:[],body:{required:!0,description:``,fields:[{wireName:`feature`,flag:`feature`,required:!0,description:"Feature identifier to evaluate. A feature this system does not gate is reported as `NOT_GATED`, the same as its absence from the `truenas.entitlements.info` map.",type:{kind:`string`}}]},hidden:!1,deprecated:!1,rpc:{method:`truenas.entitlements.check`,params:[`feature`],job:!1,defaults:{}}},{path:[`truenas`,`entitlements`,`facts`],summary:`Return the hardware and license facts every entitlement decision is computed from`,description:`Return the hardware and license facts every entitlement decision is computed from.`,method:`POST`,route:`/truenas.entitlements.facts`,params:[],hidden:!1,deprecated:!1,rpc:{method:`truenas.entitlements.facts`,params:[],job:!1,defaults:{}}},{path:[`truenas`,`entitlements`,`info`],summary:`Return the entitlement decision for every gated feature`,description:`Return the entitlement decision for every gated feature.`,method:`POST`,route:`/truenas.entitlements.info`,params:[],hidden:!1,deprecated:!1,rpc:{method:`truenas.entitlements.info`,params:[],job:!1,defaults:{}}},{path:[`truenas`,`license`,`fingerprint`],summary:`Return the system hardware fingerprint as a base64-encoded JSON string`,description:`Return the system hardware fingerprint as a base64-encoded JSON string.`,method:`POST`,route:`/truenas.license.fingerprint`,params:[],hidden:!1,deprecated:!1,rpc:{method:`truenas.license.fingerprint`,params:[],job:!1,defaults:{}}},{path:[`truenas`,`license`,`info`],summary:`Returns the parsed license object, or null if no license exists`,description:`Returns the parsed license object, or null if no license exists.`,method:`POST`,route:`/truenas.license.info`,params:[],hidden:!1,deprecated:!1,rpc:{method:`truenas.license.info`,params:[],job:!1,defaults:{}}},{path:[`truenas`,`license`,`upload`],summary:`Upload a PEM-wrapped license file`,description:`Upload a PEM-wrapped license file.`,method:`POST`,route:`/truenas.license.upload`,params:[],body:{required:!0,description:``,fields:[{wireName:`license`,flag:`license`,required:!0,description:`PEM-wrapped license to apply to the system.`,type:{kind:`string`}},{wireName:`options`,flag:`options`,required:!1,description:`Options.`,type:{kind:`json`}}]},hidden:!1,deprecated:!1,rpc:{method:`truenas.license.upload`,params:[`license`,`options`],job:!1,defaults:{options:{ha_propagate:!0}}}},{path:[`ups`,`update`],summary:`Update UPS Service Configuration`,description:`Update UPS Service Configuration.`,method:`POST`,route:`/ups.update`,params:[],body:{required:!0,description:``,fields:[{wireName:`data`,flag:`data`,required:!0,description:`Data to update the UPS configuration.`,type:{kind:`json`}}]},hidden:!1,deprecated:!1,rpc:{method:`ups.update`,params:[`data`],job:!1,defaults:{}}},{path:[`vm`,`device`,`virtual-size`],summary:`Get the virtual size of a disk image using qemu-img info`,description:`Get the virtual size of a disk image using qemu-img info.`,method:`POST`,route:`/vm.device.virtual_size`,params:[],body:{required:!0,description:``,fields:[{wireName:`vm_virtual_size`,flag:`vm-virtual-size`,required:!0,description:`VMDeviceVirtualSizeArgs parameters.`,type:{kind:`json`}}]},hidden:!1,deprecated:!1,rpc:{method:`vm.device.virtual_size`,params:[`vm_virtual_size`],job:!1,defaults:{}}},{path:[`webshare`,`bindip-choices`],summary:`Returns ip choices for Webshare service to use`,description:`Returns ip choices for Webshare service to use.`,method:`POST`,route:`/webshare.bindip_choices`,params:[],hidden:!1,deprecated:!1,rpc:{method:`webshare.bindip_choices`,params:[],job:!1,defaults:{}}},{path:[`webshare`,`config`],summary:``,description:``,method:`POST`,route:`/webshare.config`,params:[],hidden:!1,deprecated:!1,rpc:{method:`webshare.config`,params:[],job:!1,defaults:{}}},{path:[`webshare`,`update`],summary:`Update Webshare Service Configuration`,description:`Update Webshare Service Configuration.`,method:`POST`,route:`/webshare.update`,params:[],body:{required:!0,description:``,fields:[{wireName:`webshare_update`,flag:`webshare-update`,required:!0,description:`Updated webshare configuration data.`,type:{kind:`json`}}]},hidden:!1,deprecated:!1,rpc:{method:`webshare.update`,params:[`webshare_update`],job:!1,defaults:{}}},{path:[`zfs`,`resource`,`destroy`],summary:`Destroy a ZFS resource (filesystem or volume), optionally recursing into its descendants`,description:`Destroy a ZFS resource (filesystem or volume), optionally recursing into its descendants.`,method:`POST`,route:`/zfs.resource.destroy`,params:[],body:{required:!0,description:``,fields:[{wireName:`data`,flag:`data`,required:!0,description:`Parameters.`,type:{kind:`json`}}]},confirmation:``,hidden:!1,deprecated:!1,rpc:{method:`zfs.resource.destroy`,params:[`data`],job:!1,defaults:{}}},{path:[`zfs`,`resource`,`query`],summary:`List ZFS resources (datasets and volumes) with flexible filtering options`,description:`List ZFS resources (datasets and volumes) with flexible filtering options.`,method:`POST`,route:`/zfs.resource.query`,params:[],body:{required:!1,description:``,fields:[{wireName:`data`,flag:`data`,required:!1,description:`Query parameters for retrieving ZFS resource information.`,type:{kind:`json`}}]},hidden:!1,deprecated:!1,rpc:{method:`zfs.resource.query`,params:[`data`],job:!1,defaults:{data:{paths:[],properties:[],get_user_properties:!1,get_source:!1,nest_results:!1,get_children:!1,max_depth:0,exclude_internal_paths:!0,get_tier:!1}}}},{path:[`zfs`,`resource`,`snapshot`,`clone`],summary:`Clone a ZFS snapshot to create a new filesystem or volume, of the type the snapshot was taken of`,description:`Clone a ZFS snapshot to create a new filesystem or volume, of the type the snapshot was taken of.`,method:`POST`,route:`/zfs.resource.snapshot.clone`,params:[],body:{required:!0,description:``,fields:[{wireName:`data`,flag:`data`,required:!0,description:`Clone parameters for cloning ZFS snapshots.`,type:{kind:`json`}}]},hidden:!1,deprecated:!1,rpc:{method:`zfs.resource.snapshot.clone`,params:[`data`],job:!1,defaults:{}}},{path:[`zfs`,`resource`,`snapshot`,`count`],summary:`Count ZFS snapshots per dataset`,description:`Count ZFS snapshots per dataset.`,method:`POST`,route:`/zfs.resource.snapshot.count`,params:[],body:{required:!1,description:``,fields:[{wireName:`data`,flag:`data`,required:!1,description:`Count parameters for counting ZFS snapshots.`,type:{kind:`json`}}]},hidden:!1,deprecated:!1,rpc:{method:`zfs.resource.snapshot.count`,params:[`data`],job:!1,defaults:{data:{paths:[],recursive:!1}}}},{path:[`zfs`,`resource`,`snapshot`,`create`],summary:"Create a ZFS snapshot, and with ``recursive`` the same-named snapshot of every descendant not listed in ``exclude``",description:"Create a ZFS snapshot, and with ``recursive`` the same-named snapshot of every descendant not listed in ``exclude``. All of them are created atomically.",method:`POST`,route:`/zfs.resource.snapshot.create`,params:[],body:{required:!0,description:``,fields:[{wireName:`data`,flag:`data`,required:!0,description:`Create parameters for creating ZFS snapshots.`,type:{kind:`json`}}]},hidden:!1,deprecated:!1,rpc:{method:`zfs.resource.snapshot.create`,params:[`data`],job:!1,defaults:{}}},{path:[`zfs`,`resource`,`snapshot`,`destroy`],summary:`Destroy ZFS snapshots`,description:`Destroy ZFS snapshots.`,method:`POST`,route:`/zfs.resource.snapshot.destroy`,params:[],body:{required:!0,description:``,fields:[{wireName:`data`,flag:`data`,required:!0,description:`Destroy parameters for removing ZFS snapshots.`,type:{kind:`json`}}]},confirmation:``,hidden:!1,deprecated:!1,rpc:{method:`zfs.resource.snapshot.destroy`,params:[`data`],job:!1,defaults:{}}},{path:[`zfs`,`resource`,`snapshot`,`hold`],summary:`Create a hold on a ZFS snapshot`,description:`Create a hold on a ZFS snapshot.`,method:`POST`,route:`/zfs.resource.snapshot.hold`,params:[],body:{required:!0,description:``,fields:[{wireName:`data`,flag:`data`,required:!0,description:`Hold parameters for holding ZFS snapshots.`,type:{kind:`json`}}]},hidden:!1,deprecated:!1,rpc:{method:`zfs.resource.snapshot.hold`,params:[`data`],job:!1,defaults:{}}},{path:[`zfs`,`resource`,`snapshot`,`holds`],summary:`Get holds on a ZFS snapshot`,description:`Get holds on a ZFS snapshot.`,method:`POST`,route:`/zfs.resource.snapshot.holds`,params:[],body:{required:!0,description:``,fields:[{wireName:`data`,flag:`data`,required:!0,description:`Query parameters for getting holds on a ZFS snapshot.`,type:{kind:`json`}}]},hidden:!1,deprecated:!1,rpc:{method:`zfs.resource.snapshot.holds`,params:[`data`],job:!1,defaults:{}}},{path:[`zfs`,`resource`,`snapshot`,`query`],summary:`Retrieve information about ZFS snapshots, including their properties and user properties`,description:`Retrieve information about ZFS snapshots, including their properties and user properties.`,method:`POST`,route:`/zfs.resource.snapshot.query`,params:[],body:{required:!1,description:``,fields:[{wireName:`data`,flag:`data`,required:!1,description:`Query parameters for retrieving ZFS snapshot information.`,type:{kind:`json`}}]},hidden:!1,deprecated:!1,rpc:{method:`zfs.resource.snapshot.query`,params:[`data`],job:!1,defaults:{data:{paths:[],recursive:!1,properties:[],get_user_properties:!1,get_source:!1,get_holds:!1,min_txg:0,max_txg:0}}}},{path:[`zfs`,`resource`,`snapshot`,`release`],summary:`Release hold(s) from a ZFS snapshot`,description:`Release hold(s) from a ZFS snapshot.`,method:`POST`,route:`/zfs.resource.snapshot.release`,params:[],body:{required:!0,description:``,fields:[{wireName:`data`,flag:`data`,required:!0,description:`Release parameters for releasing holds on ZFS snapshots.`,type:{kind:`json`}}]},hidden:!1,deprecated:!1,rpc:{method:`zfs.resource.snapshot.release`,params:[`data`],job:!1,defaults:{}}},{path:[`zfs`,`resource`,`snapshot`,`rename`],summary:`Rename a ZFS snapshot`,description:`Rename a ZFS snapshot. The new name must stay on the same dataset.`,method:`POST`,route:`/zfs.resource.snapshot.rename`,params:[],body:{required:!0,description:``,fields:[{wireName:`data`,flag:`data`,required:!0,description:`Rename parameters for renaming ZFS snapshots.`,type:{kind:`json`}}]},hidden:!1,deprecated:!1,rpc:{method:`zfs.resource.snapshot.rename`,params:[`data`],job:!1,defaults:{}}},{path:[`zfs`,`resource`,`snapshot`,`rollback`],summary:`Rollback a ZFS dataset to a snapshot`,description:`Rollback a ZFS dataset to a snapshot.`,method:`POST`,route:`/zfs.resource.snapshot.rollback`,params:[],body:{required:!0,description:``,fields:[{wireName:`data`,flag:`data`,required:!0,description:`Rollback parameters for rolling back to ZFS snapshots.`,type:{kind:`json`}}]},confirmation:``,hidden:!1,deprecated:!1,rpc:{method:`zfs.resource.snapshot.rollback`,params:[`data`],job:!1,defaults:{}}},{path:[`zfs`,`tier`,`config`],summary:``,description:``,method:`POST`,route:`/zfs.tier.config`,params:[],hidden:!1,deprecated:!1,rpc:{method:`zfs.tier.config`,params:[],job:!1,defaults:{}}},{path:[`zfs`,`tier`,`dataset-set-tier`],summary:`Set the performance tier for a ZFS dataset, optionally migrating existing data`,description:`Set the performance tier for a ZFS dataset, optionally migrating existing data.`,method:`POST`,route:`/zfs.tier.dataset_set_tier`,params:[],body:{required:!0,description:``,fields:[{wireName:`zfs_tier_dataset_set_tier`,flag:`zfs-tier-dataset-set-tier`,required:!0,description:`ZfsTierDatasetSetTierArgs parameters.`,type:{kind:`json`}}]},hidden:!1,deprecated:!1,rpc:{method:`zfs.tier.dataset_set_tier`,params:[`zfs_tier_dataset_set_tier`],job:!1,defaults:{}}},{path:[`zfs`,`tier`,`rewrite-job-cancel`],summary:`Cancel a running or queued rewrite job`,description:`Cancel a running or queued rewrite job.`,method:`POST`,route:`/zfs.tier.rewrite_job_cancel`,params:[],body:{required:!0,description:``,fields:[{wireName:`zfs_tier_rewrite_job_cancel`,flag:`zfs-tier-rewrite-job-cancel`,required:!0,description:`ZfsTierRewriteJobCancelArgs parameters.`,type:{kind:`json`}}]},hidden:!1,deprecated:!1,rpc:{method:`zfs.tier.rewrite_job_cancel`,params:[`zfs_tier_rewrite_job_cancel`],job:!1,defaults:{}}},{path:[`zfs`,`tier`,`rewrite-job-create`],summary:`Create a new rewrite job for the specified ZFS dataset`,description:`Create a new rewrite job for the specified ZFS dataset.`,method:`POST`,route:`/zfs.tier.rewrite_job_create`,params:[],body:{required:!0,description:``,fields:[{wireName:`zfs_tier_rewrite_job_create`,flag:`zfs-tier-rewrite-job-create`,required:!0,description:`ZfsTierRewriteJobCreateArgs parameters.`,type:{kind:`json`}}]},hidden:!1,deprecated:!1,rpc:{method:`zfs.tier.rewrite_job_create`,params:[`zfs_tier_rewrite_job_create`],job:!1,defaults:{}}},{path:[`zfs`,`tier`,`rewrite-job-failures`],summary:`List files that failed to be rewritten during a rewrite job`,description:`List files that failed to be rewritten during a rewrite job.`,method:`POST`,route:`/zfs.tier.rewrite_job_failures`,params:[],body:{required:!0,description:``,fields:[{wireName:`zfs_tier_rewrite_job_failures`,flag:`zfs-tier-rewrite-job-failures`,required:!0,description:`ZfsTierRewriteJobFailuresArgs parameters.`,type:{kind:`json`}}]},hidden:!1,deprecated:!1,rpc:{method:`zfs.tier.rewrite_job_failures`,params:[`zfs_tier_rewrite_job_failures`],job:!1,defaults:{}}},{path:[`zfs`,`tier`,`rewrite-job-query`],summary:`Query rewrite jobs, optionally filtered by status`,description:`Query rewrite jobs, optionally filtered by status.`,method:`POST`,route:`/zfs.tier.rewrite_job_query`,params:[],body:{required:!0,description:``,fields:[{wireName:`zfs_tier_rewrite_job_query`,flag:`zfs-tier-rewrite-job-query`,required:!0,description:`ZfsTierRewriteJobQueryArgs parameters.`,type:{kind:`json`}}]},hidden:!1,deprecated:!1,rpc:{method:`zfs.tier.rewrite_job_query`,params:[`zfs_tier_rewrite_job_query`],job:!1,defaults:{}}},{path:[`zfs`,`tier`,`rewrite-job-recover`],summary:`Recover a rewrite job in ERROR state by reissuing failed rewrites`,description:`Recover a rewrite job in ERROR state by reissuing failed rewrites.`,method:`POST`,route:`/zfs.tier.rewrite_job_recover`,params:[],body:{required:!0,description:``,fields:[{wireName:`zfs_tier_rewrite_job_recover`,flag:`zfs-tier-rewrite-job-recover`,required:!0,description:`ZfsTierRewriteJobRecoverArgs parameters.`,type:{kind:`json`}}]},hidden:!1,deprecated:!1,rpc:{method:`zfs.tier.rewrite_job_recover`,params:[`zfs_tier_rewrite_job_recover`],job:!1,defaults:{}}},{path:[`zfs`,`tier`,`rewrite-job-status`],summary:`Get detailed status and statistics for a specific rewrite job`,description:`Get detailed status and statistics for a specific rewrite job.`,method:`POST`,route:`/zfs.tier.rewrite_job_status`,params:[],body:{required:!0,description:``,fields:[{wireName:`zfs_tier_rewrite_job_status`,flag:`zfs-tier-rewrite-job-status`,required:!0,description:`ZfsTierRewriteJobStatusArgs parameters.`,type:{kind:`json`}}]},hidden:!1,deprecated:!1,rpc:{method:`zfs.tier.rewrite_job_status`,params:[`zfs_tier_rewrite_job_status`],job:!1,defaults:{}}},{path:[`zfs`,`tier`,`update`],summary:`Update the global ZFS tiering configuration`,description:`Update the global ZFS tiering configuration.`,method:`POST`,route:`/zfs.tier.update`,params:[],body:{required:!0,description:``,fields:[{wireName:`zfs_tier_update`,flag:`zfs-tier-update`,required:!0,description:`ZfsTierUpdateArgs parameters.`,type:{kind:`json`}}]},hidden:!1,deprecated:!1,rpc:{method:`zfs.tier.update`,params:[`zfs_tier_update`],job:!1,defaults:{}}},{path:[`zpool`,`query`],summary:`Query ZFS pools with flexible options for properties, topology, scan, and features`,description:`Query ZFS pools with flexible options for properties, topology, scan, and features.`,method:`POST`,route:`/zpool.query`,params:[],body:{required:!1,description:``,fields:[{wireName:`data`,flag:`data`,required:!1,description:`Query parameters.`,type:{kind:`json`}}]},hidden:!1,deprecated:!1,rpc:{method:`zpool.query`,params:[`data`],job:!1,defaults:{data:{pool_names:null,properties:null,topology:!1,scan:!1,expand:!1,features:!1}}}},{path:[`zpool`,`scrub`,`run`],summary:`Start, pause, or cancel a scrub on a ZFS pool`,description:`Start, pause, or cancel a scrub on a ZFS pool.`,method:`POST`,route:`/zpool.scrub.run`,params:[],body:{required:!0,description:``,fields:[{wireName:`data`,flag:`data`,required:!0,description:`Scrub run parameters.`,type:{kind:`json`}}]},hidden:!1,deprecated:!1,rpc:{method:`zpool.scrub.run`,params:[`data`],job:!0,defaults:{}}},{path:[`acme`,`dns`,`authenticator`,`create`],summary:`Create a DNS Authenticator`,description:`Create a DNS Authenticator.`,method:`POST`,route:`/acme.dns.authenticator.create`,params:[],body:{required:!0,description:``,fields:[{wireName:`dns_authenticator_create`,flag:`dns-authenticator-create`,required:!0,description:`DNS authenticator creation parameters.`,type:{kind:`json`}}]},hidden:!1,deprecated:!1,rpc:{method:`acme.dns.authenticator.create`,params:[`dns_authenticator_create`],job:!1,defaults:{}}},{path:[`acme`,`dns`,`authenticator`,`query`],summary:``,description:``,method:`POST`,route:`/acme.dns.authenticator.query`,params:[],body:{required:!1,description:``,fields:[{wireName:`filters`,flag:`filters`,required:!1,description:`List of filters for query results. See API documentation for "Query Methods" for more guidance.`,type:{kind:`array`,elem:{kind:`json`}}},{wireName:`options`,flag:`options`,required:!1,description:`Query options including pagination, ordering, and additional parameters.`,type:{kind:`json`}}]},hidden:!1,deprecated:!1,rpc:{method:`acme.dns.authenticator.query`,params:[`filters`,`options`],job:!1,defaults:{filters:[],options:{extra:{},order_by:[],select:[],count:!1,get:!1,offset:0,limit:0,force_sql_filters:!1,delete_invalid_rows:!1}}}},{path:[`alertservice`,`query`],summary:``,description:``,method:`POST`,route:`/alertservice.query`,params:[],body:{required:!1,description:``,fields:[{wireName:`filters`,flag:`filters`,required:!1,description:`List of filters for query results. See API documentation for "Query Methods" for more guidance.`,type:{kind:`array`,elem:{kind:`json`}}},{wireName:`options`,flag:`options`,required:!1,description:`Query options including pagination, ordering, and additional parameters.`,type:{kind:`json`}}]},hidden:!1,deprecated:!1,rpc:{method:`alertservice.query`,params:[`filters`,`options`],job:!1,defaults:{filters:[],options:{extra:{},order_by:[],select:[],count:!1,get:!1,offset:0,limit:0,force_sql_filters:!1,delete_invalid_rows:!1}}}},{path:[`api-key`,`query`],summary:``,description:``,method:`POST`,route:`/api_key.query`,params:[],body:{required:!1,description:``,fields:[{wireName:`filters`,flag:`filters`,required:!1,description:`List of filters for query results. See API documentation for "Query Methods" for more guidance.`,type:{kind:`array`,elem:{kind:`json`}}},{wireName:`options`,flag:`options`,required:!1,description:`Query options including pagination, ordering, and additional parameters.`,type:{kind:`json`}}]},hidden:!1,deprecated:!1,rpc:{method:`api_key.query`,params:[`filters`,`options`],job:!1,defaults:{filters:[],options:{extra:{},order_by:[],select:[],count:!1,get:!1,offset:0,limit:0,force_sql_filters:!1,delete_invalid_rows:!1}}}},{path:[`app`,`available`],summary:`Retrieve all available applications from all configured catalogs`,description:`Retrieve all available applications from all configured catalogs.`,method:`POST`,route:`/app.available`,params:[],body:{required:!1,description:``,fields:[{wireName:`filters`,flag:`filters`,required:!1,description:`List of filters for query results. See API documentation for "Query Methods" for more guidance.`,type:{kind:`array`,elem:{kind:`json`}}},{wireName:`options`,flag:`options`,required:!1,description:`Query options including pagination, ordering, and additional parameters.`,type:{kind:`json`}}]},hidden:!1,deprecated:!1,rpc:{method:`app.available`,params:[`filters`,`options`],job:!1,defaults:{filters:[],options:{extra:{},order_by:[],select:[],count:!1,get:!1,offset:0,limit:0,force_sql_filters:!1,delete_invalid_rows:!1}}}},{path:[`app`,`create`],summary:"Create an app with ``app_name`` using ``catalog_app`` with ``train`` and ``version``",description:"Create an app with ``app_name`` using ``catalog_app`` with ``train`` and ``version``.",method:`POST`,route:`/app.create`,params:[],body:{required:!0,description:``,fields:[{wireName:`app_create`,flag:`app-create`,required:!0,description:`AppCreate parameters.`,type:{kind:`json`}}]},hidden:!1,deprecated:!1,rpc:{method:`app.create`,params:[`app_create`],job:!0,defaults:{}}},{path:[`app`,`latest`],summary:`Retrieve latest updated apps`,description:`Retrieve latest updated apps.`,method:`POST`,route:`/app.latest`,params:[],body:{required:!1,description:``,fields:[{wireName:`filters`,flag:`filters`,required:!1,description:`List of filters for query results. See API documentation for "Query Methods" for more guidance.`,type:{kind:`array`,elem:{kind:`json`}}},{wireName:`options`,flag:`options`,required:!1,description:`Query options including pagination, ordering, and additional parameters.`,type:{kind:`json`}}]},hidden:!1,deprecated:!1,rpc:{method:`app.latest`,params:[`filters`,`options`],job:!1,defaults:{filters:[],options:{extra:{},order_by:[],select:[],count:!1,get:!1,offset:0,limit:0,force_sql_filters:!1,delete_invalid_rows:!1}}}},{path:[`app`,`query`],summary:"Query all apps with ``query-filters`` and ``query-options``",description:"Query all apps with ``query-filters`` and ``query-options``.",method:`POST`,route:`/app.query`,params:[],body:{required:!1,description:``,fields:[{wireName:`filters`,flag:`filters`,required:!1,description:`List of filters for query results. See API documentation for "Query Methods" for more guidance.`,type:{kind:`array`,elem:{kind:`json`}}},{wireName:`options`,flag:`options`,required:!1,description:`Query options including pagination, ordering, and additional parameters.`,type:{kind:`json`}}]},hidden:!1,deprecated:!1,rpc:{method:`app.query`,params:[`filters`,`options`],job:!1,defaults:{filters:[],options:{extra:{},order_by:[],select:[],count:!1,get:!1,offset:0,limit:0,force_sql_filters:!1,delete_invalid_rows:!1}}}},{path:[`app`,`update`],summary:"Update ``app_name`` app with new configuration",description:"Update ``app_name`` app with new configuration.",method:`POST`,route:`/app.update`,params:[],body:{required:!0,description:``,fields:[{wireName:`app_name`,flag:`app-name`,required:!0,description:`Name of the application to update.`,type:{kind:`string`}},{wireName:`update`,flag:`update`,required:!1,description:`Updated configuration and settings for the application.`,type:{kind:`json`}}]},hidden:!1,deprecated:!1,rpc:{method:`app.update`,params:[`app_name`,`update`],job:!0,defaults:{update:{values:``,custom_compose_config:``,custom_compose_config_string:``}}}},{path:[`app`,`upgrade`],summary:"Upgrade ``app_name`` app to ``app_version``",description:"Upgrade ``app_name`` app to ``app_version``.",method:`POST`,route:`/app.upgrade`,params:[],body:{required:!0,description:``,fields:[{wireName:`app_name`,flag:`app-name`,required:!0,description:`Name of the application to upgrade.`,type:{kind:`string`}},{wireName:`options`,flag:`options`,required:!1,description:`Options controlling the upgrade process including target version and snapshot behavior.`,type:{kind:`json`}}]},hidden:!1,deprecated:!1,rpc:{method:`app.upgrade`,params:[`app_name`,`options`],job:!0,defaults:{options:{app_version:`latest`,values:``,snapshot_hostpaths:!1}}}},{path:[`app`,`image`,`pull`],summary:`Pull a docker image`,description:`Pull a docker image.`,method:`POST`,route:`/app.image.pull`,params:[],body:{required:!0,description:``,fields:[{wireName:`image_pull`,flag:`image-pull`,required:!0,description:`Container image pull parameters.`,type:{kind:`json`}}]},hidden:!1,deprecated:!1,rpc:{method:`app.image.pull`,params:[`image_pull`],job:!0,defaults:{}}},{path:[`app`,`image`,`query`],summary:"Query all docker images with ``query-filters`` and ``query-options``",description:"Query all docker images with ``query-filters`` and ``query-options``.",method:`POST`,route:`/app.image.query`,params:[],body:{required:!1,description:``,fields:[{wireName:`filters`,flag:`filters`,required:!1,description:`List of filters for query results. See API documentation for "Query Methods" for more guidance.`,type:{kind:`array`,elem:{kind:`json`}}},{wireName:`options`,flag:`options`,required:!1,description:`Query options including pagination, ordering, and additional parameters.`,type:{kind:`json`}}]},hidden:!1,deprecated:!1,rpc:{method:`app.image.query`,params:[`filters`,`options`],job:!1,defaults:{filters:[],options:{extra:{},order_by:[],select:[],count:!1,get:!1,offset:0,limit:0,force_sql_filters:!1,delete_invalid_rows:!1}}}},{path:[`app`,`ix-volume`,`get-instance`],summary:"Returns instance matching `id`",description:"Returns instance matching `id`. If `id` is not found, Validation error is raised.",method:`POST`,route:`/app.ix_volume.get_instance`,params:[],body:{required:!0,description:``,fields:[{wireName:`id`,flag:`id`,required:!0,description:``,type:{kind:`string`}},{wireName:`options`,flag:`options`,required:!0,description:`Query options customize the results returned by a query method. More complete documentation with examples are covered in the "Query methods" section of the TrueNAS API documentation.`,type:{kind:`json`}}]},hidden:!1,deprecated:!1,rpc:{method:`app.ix_volume.get_instance`,params:[`id`,`options`],job:!1,defaults:{}}},{path:[`app`,`ix-volume`,`query`],summary:"Query ix-volumes with `filters` and `options`",description:"Query ix-volumes with `filters` and `options`.",method:`POST`,route:`/app.ix_volume.query`,params:[],body:{required:!1,description:``,fields:[{wireName:`filters`,flag:`filters`,required:!1,description:`List of filters for query results. See API documentation for "Query Methods" for more guidance.`,type:{kind:`array`,elem:{kind:`json`}}},{wireName:`options`,flag:`options`,required:!1,description:`Query options including pagination, ordering, and additional parameters.`,type:{kind:`json`}}]},hidden:!1,deprecated:!1,rpc:{method:`app.ix_volume.query`,params:[`filters`,`options`],job:!1,defaults:{filters:[],options:{extra:{},order_by:[],select:[],count:!1,get:!1,offset:0,limit:0,force_sql_filters:!1,delete_invalid_rows:!1}}}},{path:[`app`,`registry`,`query`],summary:``,description:``,method:`POST`,route:`/app.registry.query`,params:[],body:{required:!1,description:``,fields:[{wireName:`filters`,flag:`filters`,required:!1,description:`List of filters for query results. See API documentation for "Query Methods" for more guidance.`,type:{kind:`array`,elem:{kind:`json`}}},{wireName:`options`,flag:`options`,required:!1,description:`Query options including pagination, ordering, and additional parameters.`,type:{kind:`json`}}]},hidden:!1,deprecated:!1,rpc:{method:`app.registry.query`,params:[`filters`,`options`],job:!1,defaults:{filters:[],options:{extra:{},order_by:[],select:[],count:!1,get:!1,offset:0,limit:0,force_sql_filters:!1,delete_invalid_rows:!1}}}},{path:[`audit`,`export`],summary:"Generate an audit report based on the specified ``query-filters`` and ``query-options`` for the specified ``services`` in the specified ``export_format``",description:"Generate an audit report based on the specified ``query-filters`` and ``query-options`` for the specified ``services`` in the specified ``export_format``.",method:`POST`,route:`/audit.export`,params:[],body:{required:!1,description:``,fields:[{wireName:`data`,flag:`data`,required:!1,description:`Audit export configuration specifying services, filters, and format.`,type:{kind:`json`}}]},confirmation:``,hidden:!1,deprecated:!1,rpc:{method:`audit.export`,params:[`data`],job:!0,defaults:{data:{services:[`MIDDLEWARE`],"query-filters":[],"query-options":{delete_invalid_rows:!1,force_sql_filters:!1,limit:0,offset:0,order_by:[],select:[]},remote_controller:!1,export_format:`JSON`}}}},{path:[`audit`,`query`],summary:"Query contents of audit databases specified by ``services``",description:"Query contents of audit databases specified by ``services``.",method:`POST`,route:`/audit.query`,params:[],body:{required:!1,description:``,fields:[{wireName:`data`,flag:`data`,required:!1,description:`Audit query configuration specifying services, filters, and options.`,type:{kind:`json`}}]},hidden:!1,deprecated:!1,rpc:{method:`audit.query`,params:[`data`],job:!1,defaults:{data:{services:[`MIDDLEWARE`],"query-filters":[],"query-options":{count:!1,delete_invalid_rows:!1,extra:{},force_sql_filters:!1,get:!1,limit:0,offset:0,order_by:[],select:[]},remote_controller:!1}}}},{path:[`auth`,`sessions`],summary:`Returns a list of active auth sessions`,description:`Returns a list of active auth sessions.`,method:`POST`,route:`/auth.sessions`,params:[],body:{required:!1,description:``,fields:[{wireName:`filters`,flag:`filters`,required:!1,description:`List of filters for query results. See API documentation for "Query Methods" for more guidance.`,type:{kind:`array`,elem:{kind:`json`}}},{wireName:`options`,flag:`options`,required:!1,description:`Query options including pagination, ordering, and additional parameters.`,type:{kind:`json`}}]},hidden:!1,deprecated:!1,rpc:{method:`auth.sessions`,params:[`filters`,`options`],job:!1,defaults:{filters:[],options:{extra:{},order_by:[],select:[],count:!1,get:!1,offset:0,limit:0,force_sql_filters:!1,delete_invalid_rows:!1}}}},{path:[`boot`,`environment`,`activate`],summary:"Activate the boot environment identified by ``id`` so that it becomes the default selection on the next boot",description:"Activate the boot environment identified by ``id`` so that it becomes the default selection on the next boot. The currently running boot environment is unaffected until the system is rebooted.",method:`POST`,route:`/boot.environment.activate`,params:[],body:{required:!0,description:``,fields:[{wireName:`boot_environment_activate`,flag:`boot-environment-activate`,required:!0,description:`Boot environment activate parameters.`,type:{kind:`json`}}]},hidden:!1,deprecated:!1,rpc:{method:`boot.environment.activate`,params:[`boot_environment_activate`],job:!1,defaults:{}}},{path:[`boot`,`environment`,`clone`],summary:"Create a new boot environment named ``target`` as a clone of the existing boot environment identified by ``id``",description:"Create a new boot environment named ``target`` as a clone of the existing boot environment identified by ``id``. The clone is not activated; use :doc:`boot.environment.activate <api_methods_boot.environment.activate>` to boot into it.",method:`POST`,route:`/boot.environment.clone`,params:[],body:{required:!0,description:``,fields:[{wireName:`boot_environment_clone`,flag:`boot-environment-clone`,required:!0,description:`Boot environment clone parameters.`,type:{kind:`json`}}]},hidden:!1,deprecated:!1,rpc:{method:`boot.environment.clone`,params:[`boot_environment_clone`],job:!1,defaults:{}}},{path:[`boot`,`environment`,`destroy`],summary:"Permanently destroy the boot environment identified by ``id``, freeing the space it consumes",description:"Permanently destroy the boot environment identified by ``id``, freeing the space it consumes.",method:`POST`,route:`/boot.environment.destroy`,params:[],body:{required:!0,description:``,fields:[{wireName:`boot_environment_destroy`,flag:`boot-environment-destroy`,required:!0,description:`Boot environment destroy parameters.`,type:{kind:`json`}}]},confirmation:``,hidden:!1,deprecated:!1,rpc:{method:`boot.environment.destroy`,params:[`boot_environment_destroy`],job:!1,defaults:{}}},{path:[`boot`,`environment`,`keep`],summary:'Set or clear the "keep" flag on the boot environment identified by ``id``',description:'Set or clear the "keep" flag on the boot environment identified by ``id``. When ``value`` is ``true``, the boot environment is protected from automatic deletion by the updater when it needs space for an update; when ``false``, the boot environment becomes eligible for such automatic pruning.',method:`POST`,route:`/boot.environment.keep`,params:[],body:{required:!0,description:``,fields:[{wireName:`boot_environment_destroy`,flag:`boot-environment-destroy`,required:!0,description:`Boot environment keep parameters.`,type:{kind:`json`}}]},hidden:!1,deprecated:!1,rpc:{method:`boot.environment.keep`,params:[`boot_environment_destroy`],job:!1,defaults:{}}},{path:[`boot`,`environment`,`query`],summary:``,description:``,method:`POST`,route:`/boot.environment.query`,params:[],body:{required:!1,description:``,fields:[{wireName:`filters`,flag:`filters`,required:!1,description:`List of filters for query results. See API documentation for "Query Methods" for more guidance.`,type:{kind:`array`,elem:{kind:`json`}}},{wireName:`options`,flag:`options`,required:!1,description:`Query options including pagination, ordering, and additional parameters.`,type:{kind:`json`}}]},hidden:!1,deprecated:!1,rpc:{method:`boot.environment.query`,params:[`filters`,`options`],job:!1,defaults:{filters:[],options:{extra:{},order_by:[],select:[],count:!1,get:!1,offset:0,limit:0,force_sql_filters:!1,delete_invalid_rows:!1}}}},{path:[`certificate`,`create`],summary:`Create a new certificate`,description:`Create a new certificate.`,method:`POST`,route:`/certificate.create`,params:[],body:{required:!0,description:``,fields:[{wireName:`certificate_create`,flag:`certificate-create`,required:!0,description:`Certificate create parameters.`,type:{kind:`json`}}]},hidden:!1,deprecated:!1,rpc:{method:`certificate.create`,params:[`certificate_create`],job:!0,defaults:{}}},{path:[`certificate`,`query`],summary:``,description:``,method:`POST`,route:`/certificate.query`,params:[],body:{required:!1,description:``,fields:[{wireName:`filters`,flag:`filters`,required:!1,description:`List of filters for query results. See API documentation for "Query Methods" for more guidance.`,type:{kind:`array`,elem:{kind:`json`}}},{wireName:`options`,flag:`options`,required:!1,description:`Query options including pagination, ordering, and additional parameters.`,type:{kind:`json`}}]},hidden:!1,deprecated:!1,rpc:{method:`certificate.query`,params:[`filters`,`options`],job:!1,defaults:{filters:[],options:{extra:{},order_by:[],select:[],count:!1,get:!1,offset:0,limit:0,force_sql_filters:!1,delete_invalid_rows:!1}}}},{path:[`cloud-backup`,`query`],summary:``,description:``,method:`POST`,route:`/cloud_backup.query`,params:[],body:{required:!1,description:``,fields:[{wireName:`filters`,flag:`filters`,required:!1,description:`List of filters for query results. See API documentation for "Query Methods" for more guidance.`,type:{kind:`array`,elem:{kind:`json`}}},{wireName:`options`,flag:`options`,required:!1,description:`Query options including pagination, ordering, and additional parameters.`,type:{kind:`json`}}]},hidden:!1,deprecated:!1,rpc:{method:`cloud_backup.query`,params:[`filters`,`options`],job:!1,defaults:{filters:[],options:{extra:{},order_by:[],select:[],count:!1,get:!1,offset:0,limit:0,force_sql_filters:!1,delete_invalid_rows:!1}}}},{path:[`cloudsync`,`list-directory`],summary:`List contents of a remote bucket / directory`,description:`List contents of a remote bucket / directory.`,method:`POST`,route:`/cloudsync.list_directory`,params:[],body:{required:!0,description:``,fields:[{wireName:`cloud_sync_ls`,flag:`cloud-sync-ls`,required:!0,description:`Parameters describing the remote directory to list.`,type:{kind:`json`}}]},hidden:!1,deprecated:!1,rpc:{method:`cloudsync.list_directory`,params:[`cloud_sync_ls`],job:!1,defaults:{}}},{path:[`cloudsync`,`query`],summary:``,description:``,method:`POST`,route:`/cloudsync.query`,params:[],body:{required:!1,description:``,fields:[{wireName:`filters`,flag:`filters`,required:!1,description:`List of filters for query results. See API documentation for "Query Methods" for more guidance.`,type:{kind:`array`,elem:{kind:`json`}}},{wireName:`options`,flag:`options`,required:!1,description:`Query options including pagination, ordering, and additional parameters.`,type:{kind:`json`}}]},hidden:!1,deprecated:!1,rpc:{method:`cloudsync.query`,params:[`filters`,`options`],job:!1,defaults:{filters:[],options:{extra:{},order_by:[],select:[],count:!1,get:!1,offset:0,limit:0,force_sql_filters:!1,delete_invalid_rows:!1}}}},{path:[`cloudsync`,`credentials`,`query`],summary:``,description:``,method:`POST`,route:`/cloudsync.credentials.query`,params:[],body:{required:!1,description:``,fields:[{wireName:`filters`,flag:`filters`,required:!1,description:`List of filters for query results. See API documentation for "Query Methods" for more guidance.`,type:{kind:`array`,elem:{kind:`json`}}},{wireName:`options`,flag:`options`,required:!1,description:`Query options including pagination, ordering, and additional parameters.`,type:{kind:`json`}}]},hidden:!1,deprecated:!1,rpc:{method:`cloudsync.credentials.query`,params:[`filters`,`options`],job:!1,defaults:{filters:[],options:{extra:{},order_by:[],select:[],count:!1,get:!1,offset:0,limit:0,force_sql_filters:!1,delete_invalid_rows:!1}}}},{path:[`container`,`create`],summary:`Create a Container`,description:`Create a Container.`,method:`POST`,route:`/container.create`,params:[],body:{required:!0,description:``,fields:[{wireName:`container_create`,flag:`container-create`,required:!0,description:`Container creation parameters.`,type:{kind:`json`}}]},hidden:!1,deprecated:!1,rpc:{method:`container.create`,params:[`container_create`],job:!0,defaults:{}}},{path:[`container`,`query`],summary:``,description:``,method:`POST`,route:`/container.query`,params:[],body:{required:!1,description:``,fields:[{wireName:`filters`,flag:`filters`,required:!1,description:`List of filters for query results. See API documentation for "Query Methods" for more guidance.`,type:{kind:`array`,elem:{kind:`json`}}},{wireName:`options`,flag:`options`,required:!1,description:`Query options including pagination, ordering, and additional parameters.`,type:{kind:`json`}}]},hidden:!1,deprecated:!1,rpc:{method:`container.query`,params:[`filters`,`options`],job:!1,defaults:{filters:[],options:{extra:{},order_by:[],select:[],count:!1,get:!1,offset:0,limit:0,force_sql_filters:!1,delete_invalid_rows:!1}}}},{path:[`container`,`device`,`create`],summary:"Create a new device for the container of id ``container``",description:"Create a new device for the container of id ``container``.",method:`POST`,route:`/container.device.create`,params:[],body:{required:!0,description:``,fields:[{wireName:`container_device_create`,flag:`container-device-create`,required:!0,description:`Container device creation parameters.`,type:{kind:`json`}}]},hidden:!1,deprecated:!1,rpc:{method:`container.device.create`,params:[`container_device_create`],job:!1,defaults:{}}},{path:[`container`,`device`,`query`],summary:``,description:``,method:`POST`,route:`/container.device.query`,params:[],body:{required:!1,description:``,fields:[{wireName:`filters`,flag:`filters`,required:!1,description:`List of filters for query results. See API documentation for "Query Methods" for more guidance.`,type:{kind:`array`,elem:{kind:`json`}}},{wireName:`options`,flag:`options`,required:!1,description:`Query options including pagination, ordering, and additional parameters.`,type:{kind:`json`}}]},hidden:!1,deprecated:!1,rpc:{method:`container.device.query`,params:[`filters`,`options`],job:!1,defaults:{filters:[],options:{extra:{},order_by:[],select:[],count:!1,get:!1,offset:0,limit:0,force_sql_filters:!1,delete_invalid_rows:!1}}}},{path:[`core`,`get-jobs`],summary:`Get information about long-running jobs`,description:`Get information about long-running jobs. If authenticated session does not have the FULL_ADMIN role, only jobs owned by the current authenticated session will be returned.`,method:`POST`,route:`/core.get_jobs`,params:[],body:{required:!1,description:``,fields:[{wireName:`filters`,flag:`filters`,required:!1,description:`List of filters for query results. See API documentation for "Query Methods" for more guidance.`,type:{kind:`array`,elem:{kind:`json`}}},{wireName:`options`,flag:`options`,required:!1,description:`Query options including pagination, ordering, and additional parameters.`,type:{kind:`json`}}]},hidden:!1,deprecated:!1,rpc:{method:`core.get_jobs`,params:[`filters`,`options`],job:!1,defaults:{filters:[],options:{extra:{},order_by:[],select:[],count:!1,get:!1,offset:0,limit:0,force_sql_filters:!1,delete_invalid_rows:!1}}}},{path:[`cronjob`,`query`],summary:``,description:``,method:`POST`,route:`/cronjob.query`,params:[],body:{required:!1,description:``,fields:[{wireName:`filters`,flag:`filters`,required:!1,description:`List of filters for query results. See API documentation for "Query Methods" for more guidance.`,type:{kind:`array`,elem:{kind:`json`}}},{wireName:`options`,flag:`options`,required:!1,description:`Query options including pagination, ordering, and additional parameters.`,type:{kind:`json`}}]},hidden:!1,deprecated:!1,rpc:{method:`cronjob.query`,params:[`filters`,`options`],job:!1,defaults:{filters:[],options:{extra:{},order_by:[],select:[],count:!1,get:!1,offset:0,limit:0,force_sql_filters:!1,delete_invalid_rows:!1}}}},{path:[`disk`,`get-instance`],summary:"Returns instance matching `id`",description:"Returns instance matching `id`. If `id` is not found, Validation error is raised.",method:`POST`,route:`/disk.get_instance`,params:[],body:{required:!0,description:``,fields:[{wireName:`id`,flag:`id`,required:!0,description:``,type:{kind:`string`}},{wireName:`options`,flag:`options`,required:!0,description:`Query options customize the results returned by a query method. More complete documentation with examples are covered in the "Query methods" section of the TrueNAS API documentation.`,type:{kind:`json`}}]},hidden:!1,deprecated:!1,rpc:{method:`disk.get_instance`,params:[`id`,`options`],job:!1,defaults:{}}},{path:[`disk`,`query`],summary:`Query disks`,description:`Query disks.`,method:`POST`,route:`/disk.query`,params:[],body:{required:!1,description:``,fields:[{wireName:`filters`,flag:`filters`,required:!1,description:`List of filters for query results. See API documentation for "Query Methods" for more guidance.`,type:{kind:`array`,elem:{kind:`json`}}},{wireName:`options`,flag:`options`,required:!1,description:`Query options including pagination, ordering, and additional parameters.`,type:{kind:`json`}}]},hidden:!1,deprecated:!1,rpc:{method:`disk.query`,params:[`filters`,`options`],job:!1,defaults:{filters:[],options:{extra:{},order_by:[],select:[],count:!1,get:!1,offset:0,limit:0,force_sql_filters:!1,delete_invalid_rows:!1}}}},{path:[`dns`,`query`],summary:"Query Name Servers with ``query-filters`` and ``query-options``",description:"Query Name Servers with ``query-filters`` and ``query-options``.",method:`POST`,route:`/dns.query`,params:[],body:{required:!1,description:``,fields:[{wireName:`filters`,flag:`filters`,required:!1,description:`List of filters for query results. See API documentation for "Query Methods" for more guidance.`,type:{kind:`array`,elem:{kind:`json`}}},{wireName:`options`,flag:`options`,required:!1,description:`Query options including pagination, ordering, and additional parameters.`,type:{kind:`json`}}]},hidden:!1,deprecated:!1,rpc:{method:`dns.query`,params:[`filters`,`options`],job:!1,defaults:{filters:[],options:{extra:{},order_by:[],select:[],count:!1,get:!1,offset:0,limit:0,force_sql_filters:!1,delete_invalid_rows:!1}}}},{path:[`docker`,`update`],summary:`Update Docker service configuration`,description:`Update Docker service configuration.`,method:`POST`,route:`/docker.update`,params:[],body:{required:!0,description:``,fields:[{wireName:`docker_update`,flag:`docker-update`,required:!0,description:`Docker update arguments.`,type:{kind:`json`}}]},hidden:!1,deprecated:!1,rpc:{method:`docker.update`,params:[`docker_update`],job:!0,defaults:{}}},{path:[`docker`,`network`,`query`],summary:``,description:``,method:`POST`,route:`/docker.network.query`,params:[],body:{required:!1,description:``,fields:[{wireName:`filters`,flag:`filters`,required:!1,description:`List of filters for query results. See API documentation for "Query Methods" for more guidance.`,type:{kind:`array`,elem:{kind:`json`}}},{wireName:`options`,flag:`options`,required:!1,description:`Query options including pagination, ordering, and additional parameters.`,type:{kind:`json`}}]},hidden:!1,deprecated:!1,rpc:{method:`docker.network.query`,params:[`filters`,`options`],job:!1,defaults:{filters:[],options:{extra:{},order_by:[],select:[],count:!1,get:!1,offset:0,limit:0,force_sql_filters:!1,delete_invalid_rows:!1}}}},{path:[`enclosure2`,`query`],summary:`Query detected enclosures on TrueNAS hardware`,description:`Query detected enclosures on TrueNAS hardware.`,method:`POST`,route:`/enclosure2.query`,params:[],body:{required:!1,description:``,fields:[{wireName:`filters`,flag:`filters`,required:!1,description:`List of filters for query results. See API documentation for "Query Methods" for more guidance.`,type:{kind:`array`,elem:{kind:`json`}}},{wireName:`options`,flag:`options`,required:!1,description:`Query options including pagination, ordering, and additional parameters.`,type:{kind:`json`}}]},hidden:!1,deprecated:!1,rpc:{method:`enclosure2.query`,params:[`filters`,`options`],job:!1,defaults:{filters:[],options:{extra:{},order_by:[],select:[],count:!1,get:!1,offset:0,limit:0,force_sql_filters:!1,delete_invalid_rows:!1}}}},{path:[`enclosure2`,`set-slot-status`],summary:"Set enclosure bay number ``slot`` to ``status`` for ``enclosure_id``",description:"Set enclosure bay number ``slot`` to ``status`` for ``enclosure_id``.",method:`POST`,route:`/enclosure2.set_slot_status`,params:[],body:{required:!0,description:``,fields:[{wireName:`enclosure2_set_slot_status`,flag:`enclosure2-set-slot-status`,required:!0,description:`Enclosure2SetSlotStatusArgs parameters.`,type:{kind:`json`}}]},hidden:!1,deprecated:!1,rpc:{method:`enclosure2.set_slot_status`,params:[`enclosure2_set_slot_status`],job:!1,defaults:{}}},{path:[`fc`,`fc-host`,`query`],summary:``,description:``,method:`POST`,route:`/fc.fc_host.query`,params:[],body:{required:!1,description:``,fields:[{wireName:`filters`,flag:`filters`,required:!1,description:`List of filters for query results. See API documentation for "Query Methods" for more guidance.`,type:{kind:`array`,elem:{kind:`json`}}},{wireName:`options`,flag:`options`,required:!1,description:`Query options including pagination, ordering, and additional parameters.`,type:{kind:`json`}}]},hidden:!1,deprecated:!1,rpc:{method:`fc.fc_host.query`,params:[`filters`,`options`],job:!1,defaults:{filters:[],options:{extra:{},order_by:[],select:[],count:!1,get:!1,offset:0,limit:0,force_sql_filters:!1,delete_invalid_rows:!1}}}},{path:[`fcport`,`query`],summary:``,description:``,method:`POST`,route:`/fcport.query`,params:[],body:{required:!1,description:``,fields:[{wireName:`filters`,flag:`filters`,required:!1,description:`List of filters for query results. See API documentation for "Query Methods" for more guidance.`,type:{kind:`array`,elem:{kind:`json`}}},{wireName:`options`,flag:`options`,required:!1,description:`Query options including pagination, ordering, and additional parameters.`,type:{kind:`json`}}]},hidden:!1,deprecated:!1,rpc:{method:`fcport.query`,params:[`filters`,`options`],job:!1,defaults:{filters:[],options:{extra:{},order_by:[],select:[],count:!1,get:!1,offset:0,limit:0,force_sql_filters:!1,delete_invalid_rows:!1}}}},{path:[`fcport`,`status`],summary:`Return the runtime status of Fibre Channel ports, including port state, type, speed, and connected sessions`,description:`Return the runtime status of Fibre Channel ports, including port state, type, speed, and connected sessions.`,method:`POST`,route:`/fcport.status`,params:[],body:{required:!1,description:``,fields:[{wireName:`filters`,flag:`filters`,required:!1,description:`List of filters for query results. See API documentation for "Query Methods" for more guidance.`,type:{kind:`array`,elem:{kind:`json`}}},{wireName:`options`,flag:`options`,required:!1,description:``,type:{kind:`json`}}]},hidden:!1,deprecated:!1,rpc:{method:`fcport.status`,params:[`filters`,`options`],job:!1,defaults:{filters:[],options:{extra:{with_lun_access:!0},order_by:[],select:[],count:!1,get:!1,offset:0,limit:0,force_sql_filters:!1,delete_invalid_rows:!1}}}},{path:[`filesystem`,`getacl`],summary:`Return ACL of a given path`,description:"Return ACL of a given path. This may return a POSIX1e ACL or a NFSv4 ACL. The ACL type is indicated by the ``acltype`` key.",method:`POST`,route:`/filesystem.getacl`,params:[],body:{required:!0,description:``,fields:[{wireName:`path`,flag:`path`,required:!0,description:`Absolute filesystem path to get ACL information for.`,type:{kind:`string`}},{wireName:`simplified`,flag:`simplified`,required:!1,description:`Whether to return simplified permission sets. For NFSv4 ACLs, simplified mode returns only basic ALLOW entries, stripping DENY entries and inheritance flags. For POSIX ACLs, returns only the access ACL without default entries.`,type:{kind:`boolean`}},{wireName:`resolve_ids`,flag:`resolve-ids`,required:!1,description:`Whether to resolve numeric user/group IDs to names in the response.`,type:{kind:`boolean`}}]},hidden:!1,deprecated:!1,rpc:{method:`filesystem.getacl`,params:[`path`,`simplified`,`resolve_ids`],job:!1,defaults:{simplified:!0,resolve_ids:!1}}},{path:[`filesystem`,`listdir`],summary:`Get the contents of a directory`,description:`Get the contents of a directory.`,method:`POST`,route:`/filesystem.listdir`,params:[],body:{required:!0,description:``,fields:[{wireName:`path`,flag:`path`,required:!0,description:`Directory path to list contents of.`,type:{kind:`string`}},{wireName:`query_filters`,flag:`query-filters`,required:!1,description:`Query filters to apply to the directory listing.`,type:{kind:`array`,elem:{kind:`json`}}},{wireName:`query_options`,flag:`query-options`,required:!1,description:`Query options for sorting and pagination.`,type:{kind:`json`}}]},hidden:!1,deprecated:!1,rpc:{method:`filesystem.listdir`,params:[`path`,`query_filters`,`query_options`],job:!1,defaults:{query_filters:[],query_options:{extra:{},order_by:[],select:[],count:!1,get:!1,offset:0,limit:0,force_sql_filters:!1,delete_invalid_rows:!1}}}},{path:[`filesystem`,`mkdir`],summary:`Create a directory at the specified path`,description:`Create a directory at the specified path.`,method:`POST`,route:`/filesystem.mkdir`,params:[],body:{required:!0,description:``,fields:[{wireName:`data`,flag:`data`,required:!0,description:`Directory creation options.`,type:{kind:`json`}}]},hidden:!1,deprecated:!1,rpc:{method:`filesystem.mkdir`,params:[`data`],job:!1,defaults:{}}},{path:[`filesystem`,`set-zfs-attributes`],summary:"Set special ZFS-related file flags (MS-DOS attributes and the BSD-style ``immutable``/``nounlink``/``appendonly`` flags) on the specified path",description:"Set special ZFS-related file flags (MS-DOS attributes and the BSD-style ``immutable``/``nounlink``/``appendonly`` flags) on the specified path.",method:`POST`,route:`/filesystem.set_zfs_attributes`,params:[],body:{required:!0,description:``,fields:[{wireName:`data`,flag:`data`,required:!0,description:`ZFS attribute set parameters.`,type:{kind:`json`}}]},hidden:!1,deprecated:!1,rpc:{method:`filesystem.set_zfs_attributes`,params:[`data`],job:!0,defaults:{}}},{path:[`filesystem`,`acltemplate`,`query`],summary:`Retrieve the available filesystem ACL templates`,description:`Retrieve the available filesystem ACL templates.`,method:`POST`,route:`/filesystem.acltemplate.query`,params:[],body:{required:!1,description:``,fields:[{wireName:`filters`,flag:`filters`,required:!1,description:`List of filters for query results. See API documentation for "Query Methods" for more guidance.`,type:{kind:`array`,elem:{kind:`json`}}},{wireName:`options`,flag:`options`,required:!1,description:`Query options including pagination, ordering, and additional parameters.`,type:{kind:`json`}}]},hidden:!1,deprecated:!1,rpc:{method:`filesystem.acltemplate.query`,params:[`filters`,`options`],job:!1,defaults:{filters:[],options:{extra:{},order_by:[],select:[],count:!1,get:!1,offset:0,limit:0,force_sql_filters:!1,delete_invalid_rows:!1}}}},{path:[`ftp`,`update`],summary:`Update ftp service configuration`,description:`Update ftp service configuration.`,method:`POST`,route:`/ftp.update`,params:[],body:{required:!0,description:``,fields:[{wireName:`data`,flag:`data`,required:!0,description:`FTP service configuration changes to apply.`,type:{kind:`json`}}]},hidden:!1,deprecated:!1,rpc:{method:`ftp.update`,params:[`data`],job:!1,defaults:{}}},{path:[`group`,`query`],summary:"Query groups with `query-filters` and `query-options`",description:"Query groups with `query-filters` and `query-options`.",method:`POST`,route:`/group.query`,params:[],body:{required:!1,description:``,fields:[{wireName:`filters`,flag:`filters`,required:!1,description:`List of filters for query results. See API documentation for "Query Methods" for more guidance.`,type:{kind:`array`,elem:{kind:`json`}}},{wireName:`options`,flag:`options`,required:!1,description:`Query options including pagination, ordering, and additional parameters.`,type:{kind:`json`}}]},hidden:!1,deprecated:!1,rpc:{method:`group.query`,params:[`filters`,`options`],job:!1,defaults:{filters:[],options:{extra:{},order_by:[],select:[],count:!1,get:!1,offset:0,limit:0,force_sql_filters:!1,delete_invalid_rows:!1}}}},{path:[`initshutdownscript`,`query`],summary:``,description:``,method:`POST`,route:`/initshutdownscript.query`,params:[],body:{required:!1,description:``,fields:[{wireName:`filters`,flag:`filters`,required:!1,description:`List of filters for query results. See API documentation for "Query Methods" for more guidance.`,type:{kind:`array`,elem:{kind:`json`}}},{wireName:`options`,flag:`options`,required:!1,description:`Query options including pagination, ordering, and additional parameters.`,type:{kind:`json`}}]},hidden:!1,deprecated:!1,rpc:{method:`initshutdownscript.query`,params:[`filters`,`options`],job:!1,defaults:{filters:[],options:{extra:{},order_by:[],select:[],count:!1,get:!1,offset:0,limit:0,force_sql_filters:!1,delete_invalid_rows:!1}}}},{path:[`interface`,`query`],summary:"Query network interfaces with the standard ``query-filters`` and ``query-options``",description:"Query network interfaces with the standard ``query-filters`` and ``query-options``.",method:`POST`,route:`/interface.query`,params:[],body:{required:!1,description:``,fields:[{wireName:`filters`,flag:`filters`,required:!1,description:`List of filters for query results. See API documentation for "Query Methods" for more guidance.`,type:{kind:`array`,elem:{kind:`json`}}},{wireName:`options`,flag:`options`,required:!1,description:`Query options including pagination, ordering, and additional parameters.`,type:{kind:`json`}}]},hidden:!1,deprecated:!1,rpc:{method:`interface.query`,params:[`filters`,`options`],job:!1,defaults:{filters:[],options:{extra:{},order_by:[],select:[],count:!1,get:!1,offset:0,limit:0,force_sql_filters:!1,delete_invalid_rows:!1}}}},{path:[`ipmi`,`sel`,`elist`],summary:`Query IPMI System Event Log (SEL) extended list`,description:`Query IPMI System Event Log (SEL) extended list.`,method:`POST`,route:`/ipmi.sel.elist`,params:[],body:{required:!1,description:``,fields:[{wireName:`filters`,flag:`filters`,required:!1,description:`List of filters for query results. See API documentation for "Query Methods" for more guidance.`,type:{kind:`array`,elem:{kind:`json`}}},{wireName:`options`,flag:`options`,required:!1,description:`Query options including pagination, ordering, and additional parameters.`,type:{kind:`json`}}]},hidden:!1,deprecated:!1,rpc:{method:`ipmi.sel.elist`,params:[`filters`,`options`],job:!0,defaults:{filters:[],options:{extra:{},order_by:[],select:[],count:!1,get:!1,offset:0,limit:0,force_sql_filters:!1,delete_invalid_rows:!1}}}},{path:[`iscsi`,`auth`,`query`],summary:``,description:``,method:`POST`,route:`/iscsi.auth.query`,params:[],body:{required:!1,description:``,fields:[{wireName:`filters`,flag:`filters`,required:!1,description:`List of filters for query results. See API documentation for "Query Methods" for more guidance.`,type:{kind:`array`,elem:{kind:`json`}}},{wireName:`options`,flag:`options`,required:!1,description:`Query options including pagination, ordering, and additional parameters.`,type:{kind:`json`}}]},hidden:!1,deprecated:!1,rpc:{method:`iscsi.auth.query`,params:[`filters`,`options`],job:!1,defaults:{filters:[],options:{extra:{},order_by:[],select:[],count:!1,get:!1,offset:0,limit:0,force_sql_filters:!1,delete_invalid_rows:!1}}}},{path:[`iscsi`,`extent`,`query`],summary:``,description:``,method:`POST`,route:`/iscsi.extent.query`,params:[],body:{required:!1,description:``,fields:[{wireName:`filters`,flag:`filters`,required:!1,description:`List of filters for query results. See API documentation for "Query Methods" for more guidance.`,type:{kind:`array`,elem:{kind:`json`}}},{wireName:`options`,flag:`options`,required:!1,description:`Query options including pagination, ordering, and additional parameters.`,type:{kind:`json`}}]},hidden:!1,deprecated:!1,rpc:{method:`iscsi.extent.query`,params:[`filters`,`options`],job:!1,defaults:{filters:[],options:{extra:{},order_by:[],select:[],count:!1,get:!1,offset:0,limit:0,force_sql_filters:!1,delete_invalid_rows:!1}}}},{path:[`iscsi`,`global`,`sessions`],summary:`Get a list of currently running iSCSI sessions`,description:`Get a list of currently running iSCSI sessions. This includes initiator and target names and the unique connection IDs.`,method:`POST`,route:`/iscsi.global.sessions`,params:[],body:{required:!1,description:``,fields:[{wireName:`filters`,flag:`filters`,required:!1,description:`List of filters for query results. See API documentation for "Query Methods" for more guidance.`,type:{kind:`array`,elem:{kind:`json`}}},{wireName:`options`,flag:`options`,required:!1,description:`Query options including pagination, ordering, and additional parameters.`,type:{kind:`json`}}]},hidden:!1,deprecated:!1,rpc:{method:`iscsi.global.sessions`,params:[`filters`,`options`],job:!1,defaults:{filters:[],options:{extra:{},order_by:[],select:[],count:!1,get:!1,offset:0,limit:0,force_sql_filters:!1,delete_invalid_rows:!1}}}},{path:[`iscsi`,`initiator`,`query`],summary:``,description:``,method:`POST`,route:`/iscsi.initiator.query`,params:[],body:{required:!1,description:``,fields:[{wireName:`filters`,flag:`filters`,required:!1,description:`List of filters for query results. See API documentation for "Query Methods" for more guidance.`,type:{kind:`array`,elem:{kind:`json`}}},{wireName:`options`,flag:`options`,required:!1,description:`Query options including pagination, ordering, and additional parameters.`,type:{kind:`json`}}]},hidden:!1,deprecated:!1,rpc:{method:`iscsi.initiator.query`,params:[`filters`,`options`],job:!1,defaults:{filters:[],options:{extra:{},order_by:[],select:[],count:!1,get:!1,offset:0,limit:0,force_sql_filters:!1,delete_invalid_rows:!1}}}},{path:[`iscsi`,`portal`,`query`],summary:``,description:``,method:`POST`,route:`/iscsi.portal.query`,params:[],body:{required:!1,description:``,fields:[{wireName:`filters`,flag:`filters`,required:!1,description:`List of filters for query results. See API documentation for "Query Methods" for more guidance.`,type:{kind:`array`,elem:{kind:`json`}}},{wireName:`options`,flag:`options`,required:!1,description:`Query options including pagination, ordering, and additional parameters.`,type:{kind:`json`}}]},hidden:!1,deprecated:!1,rpc:{method:`iscsi.portal.query`,params:[`filters`,`options`],job:!1,defaults:{filters:[],options:{extra:{},order_by:[],select:[],count:!1,get:!1,offset:0,limit:0,force_sql_filters:!1,delete_invalid_rows:!1}}}},{path:[`iscsi`,`target`,`query`],summary:``,description:``,method:`POST`,route:`/iscsi.target.query`,params:[],body:{required:!1,description:``,fields:[{wireName:`filters`,flag:`filters`,required:!1,description:`List of filters for query results. See API documentation for "Query Methods" for more guidance.`,type:{kind:`array`,elem:{kind:`json`}}},{wireName:`options`,flag:`options`,required:!1,description:`Query options including pagination, ordering, and additional parameters.`,type:{kind:`json`}}]},hidden:!1,deprecated:!1,rpc:{method:`iscsi.target.query`,params:[`filters`,`options`],job:!1,defaults:{filters:[],options:{extra:{},order_by:[],select:[],count:!1,get:!1,offset:0,limit:0,force_sql_filters:!1,delete_invalid_rows:!1}}}},{path:[`iscsi`,`targetextent`,`query`],summary:``,description:``,method:`POST`,route:`/iscsi.targetextent.query`,params:[],body:{required:!1,description:``,fields:[{wireName:`filters`,flag:`filters`,required:!1,description:`List of filters for query results. See API documentation for "Query Methods" for more guidance.`,type:{kind:`array`,elem:{kind:`json`}}},{wireName:`options`,flag:`options`,required:!1,description:`Query options including pagination, ordering, and additional parameters.`,type:{kind:`json`}}]},hidden:!1,deprecated:!1,rpc:{method:`iscsi.targetextent.query`,params:[`filters`,`options`],job:!1,defaults:{filters:[],options:{extra:{},order_by:[],select:[],count:!1,get:!1,offset:0,limit:0,force_sql_filters:!1,delete_invalid_rows:!1}}}},{path:[`jbof`,`query`],summary:``,description:``,method:`POST`,route:`/jbof.query`,params:[],body:{required:!1,description:``,fields:[{wireName:`filters`,flag:`filters`,required:!1,description:`List of filters for query results. See API documentation for "Query Methods" for more guidance.`,type:{kind:`array`,elem:{kind:`json`}}},{wireName:`options`,flag:`options`,required:!1,description:`Query options including pagination, ordering, and additional parameters.`,type:{kind:`json`}}]},hidden:!1,deprecated:!1,rpc:{method:`jbof.query`,params:[`filters`,`options`],job:!1,defaults:{filters:[],options:{extra:{},order_by:[],select:[],count:!1,get:!1,offset:0,limit:0,force_sql_filters:!1,delete_invalid_rows:!1}}}},{path:[`kerberos`,`keytab`,`query`],summary:``,description:``,method:`POST`,route:`/kerberos.keytab.query`,params:[],body:{required:!1,description:``,fields:[{wireName:`filters`,flag:`filters`,required:!1,description:`List of filters for query results. See API documentation for "Query Methods" for more guidance.`,type:{kind:`array`,elem:{kind:`json`}}},{wireName:`options`,flag:`options`,required:!1,description:`Query options including pagination, ordering, and additional parameters.`,type:{kind:`json`}}]},hidden:!1,deprecated:!1,rpc:{method:`kerberos.keytab.query`,params:[`filters`,`options`],job:!1,defaults:{filters:[],options:{extra:{},order_by:[],select:[],count:!1,get:!1,offset:0,limit:0,force_sql_filters:!1,delete_invalid_rows:!1}}}},{path:[`kerberos`,`realm`,`query`],summary:``,description:``,method:`POST`,route:`/kerberos.realm.query`,params:[],body:{required:!1,description:``,fields:[{wireName:`filters`,flag:`filters`,required:!1,description:`List of filters for query results. See API documentation for "Query Methods" for more guidance.`,type:{kind:`array`,elem:{kind:`json`}}},{wireName:`options`,flag:`options`,required:!1,description:`Query options including pagination, ordering, and additional parameters.`,type:{kind:`json`}}]},hidden:!1,deprecated:!1,rpc:{method:`kerberos.realm.query`,params:[`filters`,`options`],job:!1,defaults:{filters:[],options:{extra:{},order_by:[],select:[],count:!1,get:!1,offset:0,limit:0,force_sql_filters:!1,delete_invalid_rows:!1}}}},{path:[`keychaincredential`,`query`],summary:``,description:``,method:`POST`,route:`/keychaincredential.query`,params:[],body:{required:!1,description:``,fields:[{wireName:`filters`,flag:`filters`,required:!1,description:`List of filters for query results. See API documentation for "Query Methods" for more guidance.`,type:{kind:`array`,elem:{kind:`json`}}},{wireName:`options`,flag:`options`,required:!1,description:`Query options including pagination, ordering, and additional parameters.`,type:{kind:`json`}}]},hidden:!1,deprecated:!1,rpc:{method:`keychaincredential.query`,params:[`filters`,`options`],job:!1,defaults:{filters:[],options:{extra:{},order_by:[],select:[],count:!1,get:!1,offset:0,limit:0,force_sql_filters:!1,delete_invalid_rows:!1}}}},{path:[`kmip`,`update`],summary:`Update KMIP Server Configuration`,description:`Update KMIP Server Configuration.`,method:`POST`,route:`/kmip.update`,params:[],body:{required:!0,description:``,fields:[{wireName:`kmip_update`,flag:`kmip-update`,required:!0,description:`KMIP configuration update arguments.`,type:{kind:`json`}}]},hidden:!1,deprecated:!1,rpc:{method:`kmip.update`,params:[`kmip_update`],job:!0,defaults:{}}},{path:[`lxc`,`update`],summary:`Update container config`,description:`Update container config.`,method:`POST`,route:`/lxc.update`,params:[],body:{required:!0,description:``,fields:[{wireName:`data`,flag:`data`,required:!0,description:`LXC config update parameters.`,type:{kind:`json`}}]},hidden:!1,deprecated:!1,rpc:{method:`lxc.update`,params:[`data`],job:!1,defaults:{}}},{path:[`nfs`,`get-nfs3-clients`],summary:`Read contents of rmtab`,description:`Read contents of rmtab. This information may not be accurate due to stale entries. This is ultimately a limitation of the NFSv3 protocol.`,method:`POST`,route:`/nfs.get_nfs3_clients`,params:[],body:{required:!1,description:``,fields:[{wireName:`filters`,flag:`filters`,required:!1,description:`List of filters for query results. See API documentation for "Query Methods" for more guidance.`,type:{kind:`array`,elem:{kind:`json`}}},{wireName:`options`,flag:`options`,required:!1,description:`Query options including pagination, ordering, and additional parameters.`,type:{kind:`json`}}]},hidden:!1,deprecated:!1,rpc:{method:`nfs.get_nfs3_clients`,params:[`filters`,`options`],job:!1,defaults:{filters:[],options:{extra:{},order_by:[],select:[],count:!1,get:!1,offset:0,limit:0,force_sql_filters:!1,delete_invalid_rows:!1}}}},{path:[`nfs`,`get-nfs4-clients`],summary:`Read information about NFSv4 clients from /proc/fs/nfsd/clients`,description:`Read information about NFSv4 clients from /proc/fs/nfsd/clients.`,method:`POST`,route:`/nfs.get_nfs4_clients`,params:[],body:{required:!1,description:``,fields:[{wireName:`filters`,flag:`filters`,required:!1,description:`List of filters for query results. See API documentation for "Query Methods" for more guidance.`,type:{kind:`array`,elem:{kind:`json`}}},{wireName:`options`,flag:`options`,required:!1,description:`Query options including pagination, ordering, and additional parameters.`,type:{kind:`json`}}]},hidden:!1,deprecated:!1,rpc:{method:`nfs.get_nfs4_clients`,params:[`filters`,`options`],job:!1,defaults:{filters:[],options:{extra:{},order_by:[],select:[],count:!1,get:!1,offset:0,limit:0,force_sql_filters:!1,delete_invalid_rows:!1}}}},{path:[`nfs`,`update`],summary:`Update the NFS service configuration`,description:`Update the NFS service configuration.`,method:`POST`,route:`/nfs.update`,params:[],body:{required:!0,description:``,fields:[{wireName:`nfs_update`,flag:`nfs-update`,required:!0,description:`Data to update the NFS service configuration.`,type:{kind:`json`}}]},hidden:!1,deprecated:!1,rpc:{method:`nfs.update`,params:[`nfs_update`],job:!1,defaults:{}}},{path:[`nvmet`,`global`,`sessions`],summary:`Return the NVMe-oF host sessions currently connected to this TrueNAS`,description:`Return the NVMe-oF host sessions currently connected to this TrueNAS.`,method:`POST`,route:`/nvmet.global.sessions`,params:[],body:{required:!1,description:``,fields:[{wireName:`filters`,flag:`filters`,required:!1,description:`List of filters for query results. See API documentation for "Query Methods" for more guidance.`,type:{kind:`array`,elem:{kind:`json`}}},{wireName:`options`,flag:`options`,required:!1,description:`Query options including pagination, ordering, and additional parameters.`,type:{kind:`json`}}]},hidden:!1,deprecated:!1,rpc:{method:`nvmet.global.sessions`,params:[`filters`,`options`],job:!1,defaults:{filters:[],options:{extra:{},order_by:[],select:[],count:!1,get:!1,offset:0,limit:0,force_sql_filters:!1,delete_invalid_rows:!1}}}},{path:[`nvmet`,`host`,`query`],summary:``,description:``,method:`POST`,route:`/nvmet.host.query`,params:[],body:{required:!1,description:``,fields:[{wireName:`filters`,flag:`filters`,required:!1,description:`List of filters for query results. See API documentation for "Query Methods" for more guidance.`,type:{kind:`array`,elem:{kind:`json`}}},{wireName:`options`,flag:`options`,required:!1,description:`Query options including pagination, ordering, and additional parameters.`,type:{kind:`json`}}]},hidden:!1,deprecated:!1,rpc:{method:`nvmet.host.query`,params:[`filters`,`options`],job:!1,defaults:{filters:[],options:{extra:{},order_by:[],select:[],count:!1,get:!1,offset:0,limit:0,force_sql_filters:!1,delete_invalid_rows:!1}}}},{path:[`nvmet`,`host-subsys`,`query`],summary:``,description:``,method:`POST`,route:`/nvmet.host_subsys.query`,params:[],body:{required:!1,description:``,fields:[{wireName:`filters`,flag:`filters`,required:!1,description:`List of filters for query results. See API documentation for "Query Methods" for more guidance.`,type:{kind:`array`,elem:{kind:`json`}}},{wireName:`options`,flag:`options`,required:!1,description:`Query options including pagination, ordering, and additional parameters.`,type:{kind:`json`}}]},hidden:!1,deprecated:!1,rpc:{method:`nvmet.host_subsys.query`,params:[`filters`,`options`],job:!1,defaults:{filters:[],options:{extra:{},order_by:[],select:[],count:!1,get:!1,offset:0,limit:0,force_sql_filters:!1,delete_invalid_rows:!1}}}},{path:[`nvmet`,`namespace`,`query`],summary:``,description:``,method:`POST`,route:`/nvmet.namespace.query`,params:[],body:{required:!1,description:``,fields:[{wireName:`filters`,flag:`filters`,required:!1,description:`List of filters for query results. See API documentation for "Query Methods" for more guidance.`,type:{kind:`array`,elem:{kind:`json`}}},{wireName:`options`,flag:`options`,required:!1,description:`Query options including pagination, ordering, and additional parameters.`,type:{kind:`json`}}]},hidden:!1,deprecated:!1,rpc:{method:`nvmet.namespace.query`,params:[`filters`,`options`],job:!1,defaults:{filters:[],options:{extra:{},order_by:[],select:[],count:!1,get:!1,offset:0,limit:0,force_sql_filters:!1,delete_invalid_rows:!1}}}},{path:[`nvmet`,`port`,`query`],summary:``,description:``,method:`POST`,route:`/nvmet.port.query`,params:[],body:{required:!1,description:``,fields:[{wireName:`filters`,flag:`filters`,required:!1,description:`List of filters for query results. See API documentation for "Query Methods" for more guidance.`,type:{kind:`array`,elem:{kind:`json`}}},{wireName:`options`,flag:`options`,required:!1,description:`Query options including pagination, ordering, and additional parameters.`,type:{kind:`json`}}]},hidden:!1,deprecated:!1,rpc:{method:`nvmet.port.query`,params:[`filters`,`options`],job:!1,defaults:{filters:[],options:{extra:{},order_by:[],select:[],count:!1,get:!1,offset:0,limit:0,force_sql_filters:!1,delete_invalid_rows:!1}}}},{path:[`nvmet`,`port-subsys`,`query`],summary:``,description:``,method:`POST`,route:`/nvmet.port_subsys.query`,params:[],body:{required:!1,description:``,fields:[{wireName:`filters`,flag:`filters`,required:!1,description:`List of filters for query results. See API documentation for "Query Methods" for more guidance.`,type:{kind:`array`,elem:{kind:`json`}}},{wireName:`options`,flag:`options`,required:!1,description:`Query options including pagination, ordering, and additional parameters.`,type:{kind:`json`}}]},hidden:!1,deprecated:!1,rpc:{method:`nvmet.port_subsys.query`,params:[`filters`,`options`],job:!1,defaults:{filters:[],options:{extra:{},order_by:[],select:[],count:!1,get:!1,offset:0,limit:0,force_sql_filters:!1,delete_invalid_rows:!1}}}},{path:[`nvmet`,`subsys`,`query`],summary:``,description:``,method:`POST`,route:`/nvmet.subsys.query`,params:[],body:{required:!1,description:``,fields:[{wireName:`filters`,flag:`filters`,required:!1,description:`List of filters for query results. See API documentation for "Query Methods" for more guidance.`,type:{kind:`array`,elem:{kind:`json`}}},{wireName:`options`,flag:`options`,required:!1,description:`Query options including pagination, ordering, and additional parameters.`,type:{kind:`json`}}]},hidden:!1,deprecated:!1,rpc:{method:`nvmet.subsys.query`,params:[`filters`,`options`],job:!1,defaults:{filters:[],options:{extra:{},order_by:[],select:[],count:!1,get:!1,offset:0,limit:0,force_sql_filters:!1,delete_invalid_rows:!1}}}},{path:[`pool`,`query`],summary:``,description:``,method:`POST`,route:`/pool.query`,params:[],body:{required:!1,description:``,fields:[{wireName:`filters`,flag:`filters`,required:!1,description:`List of filters for query results. See API documentation for "Query Methods" for more guidance.`,type:{kind:`array`,elem:{kind:`json`}}},{wireName:`options`,flag:`options`,required:!1,description:`Query options including pagination, ordering, and additional parameters.`,type:{kind:`json`}}]},hidden:!1,deprecated:!1,rpc:{method:`pool.query`,params:[`filters`,`options`],job:!1,defaults:{filters:[],options:{extra:{},order_by:[],select:[],count:!1,get:!1,offset:0,limit:0,force_sql_filters:!1,delete_invalid_rows:!1}}}},{path:[`pool`,`dataset`,`get-quota`],summary:"Return a list of the specified ``quota_type`` of quotas on the ZFS dataset ``ds``",description:"Return a list of the specified ``quota_type`` of quotas on the ZFS dataset ``ds``. Supports ``query-filters`` and ``query-options``.",method:`POST`,route:`/pool.dataset.get_quota`,params:[],body:{required:!0,description:``,fields:[{wireName:`dataset`,flag:`dataset`,required:!0,description:`The dataset path to retrieve quotas for.`,type:{kind:`string`}},{wireName:`quota_type`,flag:`quota-type`,required:!0,description:`The type of quotas to retrieve.`,type:{kind:`enum`,values:[`USER`,`GROUP`,`DATASET`,`PROJECT`]}},{wireName:`filters`,flag:`filters`,required:!1,description:`Query filters to limit the results returned.`,type:{kind:`array`,elem:{kind:`json`}}},{wireName:`options`,flag:`options`,required:!1,description:`Query options such as sorting and pagination.`,type:{kind:`json`}}]},hidden:!1,deprecated:!1,rpc:{method:`pool.dataset.get_quota`,params:[`dataset`,`quota_type`,`filters`,`options`],job:!1,defaults:{filters:[],options:{extra:{},order_by:[],select:[],count:!1,get:!1,offset:0,limit:0,force_sql_filters:!1,delete_invalid_rows:!1}}}},{path:[`pool`,`dataset`,`query`],summary:"Query pool datasets with ``query-filters`` and ``query-options``",description:"Query pool datasets with ``query-filters`` and ``query-options``.",method:`POST`,route:`/pool.dataset.query`,params:[],body:{required:!1,description:``,fields:[{wireName:`filters`,flag:`filters`,required:!1,description:`List of filters for query results. See API documentation for "Query Methods" for more guidance.`,type:{kind:`array`,elem:{kind:`json`}}},{wireName:`options`,flag:`options`,required:!1,description:`Query options including pagination, ordering, and additional parameters.`,type:{kind:`json`}}]},hidden:!1,deprecated:!1,rpc:{method:`pool.dataset.query`,params:[`filters`,`options`],job:!1,defaults:{filters:[],options:{extra:{},order_by:[],select:[],count:!1,get:!1,offset:0,limit:0,force_sql_filters:!1,delete_invalid_rows:!1}}}},{path:[`pool`,`scrub`,`query`],summary:``,description:``,method:`POST`,route:`/pool.scrub.query`,params:[],body:{required:!1,description:``,fields:[{wireName:`filters`,flag:`filters`,required:!1,description:`List of filters for query results. See API documentation for "Query Methods" for more guidance.`,type:{kind:`array`,elem:{kind:`json`}}},{wireName:`options`,flag:`options`,required:!1,description:`Query options including pagination, ordering, and additional parameters.`,type:{kind:`json`}}]},hidden:!1,deprecated:!1,rpc:{method:`pool.scrub.query`,params:[`filters`,`options`],job:!1,defaults:{filters:[],options:{extra:{},order_by:[],select:[],count:!1,get:!1,offset:0,limit:0,force_sql_filters:!1,delete_invalid_rows:!1}}}},{path:[`pool`,`snapshot`,`query`],summary:"Query all ZFS snapshots with the standard ``query-filters`` and ``query-options``",description:"Query all ZFS snapshots with the standard ``query-filters`` and ``query-options``.",method:`POST`,route:`/pool.snapshot.query`,params:[],body:{required:!1,description:``,fields:[{wireName:`filters`,flag:`filters`,required:!1,description:`List of filters for query results. See API documentation for "Query Methods" for more guidance.`,type:{kind:`array`,elem:{kind:`json`}}},{wireName:`options`,flag:`options`,required:!1,description:`Query options including pagination, ordering, and additional parameters.`,type:{kind:`json`}}]},hidden:!1,deprecated:!1,rpc:{method:`pool.snapshot.query`,params:[`filters`,`options`],job:!1,defaults:{filters:[],options:{extra:{},order_by:[],select:[],count:!1,get:!1,offset:0,limit:0,force_sql_filters:!1,delete_invalid_rows:!1}}}},{path:[`pool`,`snapshottask`,`query`],summary:``,description:``,method:`POST`,route:`/pool.snapshottask.query`,params:[],body:{required:!1,description:``,fields:[{wireName:`filters`,flag:`filters`,required:!1,description:`List of filters for query results. See API documentation for "Query Methods" for more guidance.`,type:{kind:`array`,elem:{kind:`json`}}},{wireName:`options`,flag:`options`,required:!1,description:`Query options including pagination, ordering, and additional parameters.`,type:{kind:`json`}}]},hidden:!1,deprecated:!1,rpc:{method:`pool.snapshottask.query`,params:[`filters`,`options`],job:!1,defaults:{filters:[],options:{extra:{},order_by:[],select:[],count:!1,get:!1,offset:0,limit:0,force_sql_filters:!1,delete_invalid_rows:!1}}}},{path:[`privilege`,`query`],summary:``,description:``,method:`POST`,route:`/privilege.query`,params:[],body:{required:!1,description:``,fields:[{wireName:`filters`,flag:`filters`,required:!1,description:`List of filters for query results. See API documentation for "Query Methods" for more guidance.`,type:{kind:`array`,elem:{kind:`json`}}},{wireName:`options`,flag:`options`,required:!1,description:`Query options including pagination, ordering, and additional parameters.`,type:{kind:`json`}}]},hidden:!1,deprecated:!1,rpc:{method:`privilege.query`,params:[`filters`,`options`],job:!1,defaults:{filters:[],options:{extra:{},order_by:[],select:[],count:!1,get:!1,offset:0,limit:0,force_sql_filters:!1,delete_invalid_rows:!1}}}},{path:[`privilege`,`roles`],summary:`Get all available roles`,description:`Get all available roles.`,method:`POST`,route:`/privilege.roles`,params:[],body:{required:!1,description:``,fields:[{wireName:`filters`,flag:`filters`,required:!1,description:`List of filters for query results. See API documentation for "Query Methods" for more guidance.`,type:{kind:`array`,elem:{kind:`json`}}},{wireName:`options`,flag:`options`,required:!1,description:`Query options including pagination, ordering, and additional parameters.`,type:{kind:`json`}}]},hidden:!1,deprecated:!1,rpc:{method:`privilege.roles`,params:[`filters`,`options`],job:!1,defaults:{filters:[],options:{extra:{},order_by:[],select:[],count:!1,get:!1,offset:0,limit:0,force_sql_filters:!1,delete_invalid_rows:!1}}}},{path:[`replication`,`query`],summary:``,description:``,method:`POST`,route:`/replication.query`,params:[],body:{required:!1,description:``,fields:[{wireName:`filters`,flag:`filters`,required:!1,description:`List of filters for query results. See API documentation for "Query Methods" for more guidance.`,type:{kind:`array`,elem:{kind:`json`}}},{wireName:`options`,flag:`options`,required:!1,description:`Query options including pagination, ordering, and additional parameters.`,type:{kind:`json`}}]},hidden:!1,deprecated:!1,rpc:{method:`replication.query`,params:[`filters`,`options`],job:!1,defaults:{filters:[],options:{extra:{},order_by:[],select:[],count:!1,get:!1,offset:0,limit:0,force_sql_filters:!1,delete_invalid_rows:!1}}}},{path:[`reporting`,`graphs`],summary:`List the reporting graphs available to be queried, each describing a metric type along with the instance identifiers (if any) that can be reported on`,description:"List the reporting graphs available to be queried, each describing a metric type along with the instance identifiers (if any) that can be reported on. Pass the resulting graph names to :doc:`reporting.get_data <api_methods_reporting.get_data>` to retrieve the corresponding data points.",method:`POST`,route:`/reporting.graphs`,params:[],body:{required:!1,description:``,fields:[{wireName:`filters`,flag:`filters`,required:!1,description:`List of filters for query results. See API documentation for "Query Methods" for more guidance.`,type:{kind:`array`,elem:{kind:`json`}}},{wireName:`options`,flag:`options`,required:!1,description:`Query options including pagination, ordering, and additional parameters.`,type:{kind:`json`}}]},hidden:!1,deprecated:!1,rpc:{method:`reporting.graphs`,params:[`filters`,`options`],job:!1,defaults:{filters:[],options:{extra:{},order_by:[],select:[],count:!1,get:!1,offset:0,limit:0,force_sql_filters:!1,delete_invalid_rows:!1}}}},{path:[`reporting`,`netdata-graphs`],summary:`Get reporting netdata graphs`,description:`Get reporting netdata graphs.`,method:`POST`,route:`/reporting.netdata_graphs`,params:[],body:{required:!1,description:``,fields:[{wireName:`filters`,flag:`filters`,required:!1,description:`List of filters for query results. See API documentation for "Query Methods" for more guidance.`,type:{kind:`array`,elem:{kind:`json`}}},{wireName:`options`,flag:`options`,required:!1,description:`Query options including pagination, ordering, and additional parameters.`,type:{kind:`json`}}]},hidden:!1,deprecated:!1,rpc:{method:`reporting.netdata_graphs`,params:[`filters`,`options`],job:!1,defaults:{filters:[],options:{extra:{},order_by:[],select:[],count:!1,get:!1,offset:0,limit:0,force_sql_filters:!1,delete_invalid_rows:!1}}}},{path:[`reporting`,`update`],summary:`Update reporting configuration settings`,description:`Update reporting configuration settings.`,method:`POST`,route:`/reporting.update`,params:[],body:{required:!0,description:``,fields:[{wireName:`reporting_update`,flag:`reporting-update`,required:!0,description:`Updated reporting configuration.`,type:{kind:`json`}}]},hidden:!1,deprecated:!1,rpc:{method:`reporting.update`,params:[`reporting_update`],job:!1,defaults:{}}},{path:[`reporting`,`exporters`,`create`],summary:`Create a specific reporting exporter configuration containing required details for exporting reporting metrics`,description:`Create a specific reporting exporter configuration containing required details for exporting reporting metrics.`,method:`POST`,route:`/reporting.exporters.create`,params:[],body:{required:!0,description:``,fields:[{wireName:`reporting_exporter_create`,flag:`reporting-exporter-create`,required:!0,description:`Configuration for the new reporting exporter.`,type:{kind:`json`}}]},hidden:!1,deprecated:!1,rpc:{method:`reporting.exporters.create`,params:[`reporting_exporter_create`],job:!1,defaults:{}}},{path:[`reporting`,`exporters`,`query`],summary:``,description:``,method:`POST`,route:`/reporting.exporters.query`,params:[],body:{required:!1,description:``,fields:[{wireName:`filters`,flag:`filters`,required:!1,description:`List of filters for query results. See API documentation for "Query Methods" for more guidance.`,type:{kind:`array`,elem:{kind:`json`}}},{wireName:`options`,flag:`options`,required:!1,description:`Query options including pagination, ordering, and additional parameters.`,type:{kind:`json`}}]},hidden:!1,deprecated:!1,rpc:{method:`reporting.exporters.query`,params:[`filters`,`options`],job:!1,defaults:{filters:[],options:{extra:{},order_by:[],select:[],count:!1,get:!1,offset:0,limit:0,force_sql_filters:!1,delete_invalid_rows:!1}}}},{path:[`route`,`system-routes`],summary:`Query IPv4 and IPv6 routes from the kernel's main routing table`,description:`Query IPv4 and IPv6 routes from the kernel's main routing table.`,method:`POST`,route:`/route.system_routes`,params:[],body:{required:!1,description:``,fields:[{wireName:`filters`,flag:`filters`,required:!1,description:`List of filters for query results. See API documentation for "Query Methods" for more guidance.`,type:{kind:`array`,elem:{kind:`json`}}},{wireName:`options`,flag:`options`,required:!1,description:`Query options including pagination, ordering, and additional parameters.`,type:{kind:`json`}}]},hidden:!1,deprecated:!1,rpc:{method:`route.system_routes`,params:[`filters`,`options`],job:!1,defaults:{filters:[],options:{extra:{},order_by:[],select:[],count:!1,get:!1,offset:0,limit:0,force_sql_filters:!1,delete_invalid_rows:!1}}}},{path:[`rsynctask`,`query`],summary:``,description:``,method:`POST`,route:`/rsynctask.query`,params:[],body:{required:!1,description:``,fields:[{wireName:`filters`,flag:`filters`,required:!1,description:`List of filters for query results. See API documentation for "Query Methods" for more guidance.`,type:{kind:`array`,elem:{kind:`json`}}},{wireName:`options`,flag:`options`,required:!1,description:`Query options including pagination, ordering, and additional parameters.`,type:{kind:`json`}}]},hidden:!1,deprecated:!1,rpc:{method:`rsynctask.query`,params:[`filters`,`options`],job:!1,defaults:{filters:[],options:{extra:{},order_by:[],select:[],count:!1,get:!1,offset:0,limit:0,force_sql_filters:!1,delete_invalid_rows:!1}}}},{path:[`s3`,`accesskey`,`query`],summary:``,description:``,method:`POST`,route:`/s3.accesskey.query`,params:[],body:{required:!1,description:``,fields:[{wireName:`filters`,flag:`filters`,required:!1,description:`List of filters for query results. See API documentation for "Query Methods" for more guidance.`,type:{kind:`array`,elem:{kind:`json`}}},{wireName:`options`,flag:`options`,required:!1,description:`Query options including pagination, ordering, and additional parameters.`,type:{kind:`json`}}]},hidden:!1,deprecated:!1,rpc:{method:`s3.accesskey.query`,params:[`filters`,`options`],job:!1,defaults:{filters:[],options:{extra:{},order_by:[],select:[],count:!1,get:!1,offset:0,limit:0,force_sql_filters:!1,delete_invalid_rows:!1}}}},{path:[`service`,`query`],summary:"Query all system services with ``query-filters`` and ``query-options``",description:"Query all system services with ``query-filters`` and ``query-options``.",method:`POST`,route:`/service.query`,params:[],body:{required:!1,description:``,fields:[{wireName:`filters`,flag:`filters`,required:!1,description:`List of filters for query results. See API documentation for "Query Methods" for more guidance.`,type:{kind:`array`,elem:{kind:`json`}}},{wireName:`options`,flag:`options`,required:!1,description:`Query options including pagination, ordering, and additional parameters.`,type:{kind:`json`}}]},hidden:!1,deprecated:!1,rpc:{method:`service.query`,params:[`filters`,`options`],job:!1,defaults:{filters:[],options:{extra:{},order_by:[],select:[],count:!1,get:!1,offset:0,limit:0,force_sql_filters:!1,delete_invalid_rows:!1}}}},{path:[`sharing`,`nfs`,`query`],summary:``,description:``,method:`POST`,route:`/sharing.nfs.query`,params:[],body:{required:!1,description:``,fields:[{wireName:`filters`,flag:`filters`,required:!1,description:`List of filters for query results. See API documentation for "Query Methods" for more guidance.`,type:{kind:`array`,elem:{kind:`json`}}},{wireName:`options`,flag:`options`,required:!1,description:`Query options including pagination, ordering, and additional parameters.`,type:{kind:`json`}}]},hidden:!1,deprecated:!1,rpc:{method:`sharing.nfs.query`,params:[`filters`,`options`],job:!1,defaults:{filters:[],options:{extra:{},order_by:[],select:[],count:!1,get:!1,offset:0,limit:0,force_sql_filters:!1,delete_invalid_rows:!1}}}},{path:[`sharing`,`s3`,`query`],summary:``,description:``,method:`POST`,route:`/sharing.s3.query`,params:[],body:{required:!1,description:``,fields:[{wireName:`filters`,flag:`filters`,required:!1,description:`List of filters for query results. See API documentation for "Query Methods" for more guidance.`,type:{kind:`array`,elem:{kind:`json`}}},{wireName:`options`,flag:`options`,required:!1,description:`Query options including pagination, ordering, and additional parameters.`,type:{kind:`json`}}]},hidden:!1,deprecated:!1,rpc:{method:`sharing.s3.query`,params:[`filters`,`options`],job:!1,defaults:{filters:[],options:{extra:{},order_by:[],select:[],count:!1,get:!1,offset:0,limit:0,force_sql_filters:!1,delete_invalid_rows:!1}}}},{path:[`sharing`,`smb`,`query`],summary:``,description:``,method:`POST`,route:`/sharing.smb.query`,params:[],body:{required:!1,description:``,fields:[{wireName:`filters`,flag:`filters`,required:!1,description:`List of filters for query results. See API documentation for "Query Methods" for more guidance.`,type:{kind:`array`,elem:{kind:`json`}}},{wireName:`options`,flag:`options`,required:!1,description:`Query options including pagination, ordering, and additional parameters.`,type:{kind:`json`}}]},hidden:!1,deprecated:!1,rpc:{method:`sharing.smb.query`,params:[`filters`,`options`],job:!1,defaults:{filters:[],options:{extra:{},order_by:[],select:[],count:!1,get:!1,offset:0,limit:0,force_sql_filters:!1,delete_invalid_rows:!1}}}},{path:[`sharing`,`webshare`,`query`],summary:``,description:``,method:`POST`,route:`/sharing.webshare.query`,params:[],body:{required:!1,description:``,fields:[{wireName:`filters`,flag:`filters`,required:!1,description:`List of filters for query results. See API documentation for "Query Methods" for more guidance.`,type:{kind:`array`,elem:{kind:`json`}}},{wireName:`options`,flag:`options`,required:!1,description:`Query options including pagination, ordering, and additional parameters.`,type:{kind:`json`}}]},hidden:!1,deprecated:!1,rpc:{method:`sharing.webshare.query`,params:[`filters`,`options`],job:!1,defaults:{filters:[],options:{extra:{},order_by:[],select:[],count:!1,get:!1,offset:0,limit:0,force_sql_filters:!1,delete_invalid_rows:!1}}}},{path:[`smb`,`status`],summary:`Returns SMB server status (sessions, open files, locks, notifications)`,description:`Returns SMB server status (sessions, open files, locks, notifications).`,method:`POST`,route:`/smb.status`,params:[],body:{required:!1,description:``,fields:[{wireName:`info_level`,flag:`info-level`,required:!1,description:`Type of information requests. Defaults to "ALL".`,type:{kind:`enum`,values:[`ALL`,`SESSIONS`,`SHARES`,`LOCKS`,`BYTERANGE`,`NOTIFICATIONS`]}},{wireName:`filters`,flag:`filters`,required:!1,description:`Query filters to apply to the status results.`,type:{kind:`array`,elem:{kind:`json`}}},{wireName:`options`,flag:`options`,required:!1,description:`Query options for controlling result pagination and ordering.`,type:{kind:`json`}},{wireName:`status_options`,flag:`status-options`,required:!1,description:`Additional options for retrieving and formatting SMB status information.`,type:{kind:`json`}}]},hidden:!1,deprecated:!1,rpc:{method:`smb.status`,params:[`info_level`,`filters`,`options`,`status_options`],job:!1,defaults:{info_level:`ALL`,filters:[],options:{extra:{},order_by:[],select:[],count:!1,get:!1,offset:0,limit:0,force_sql_filters:!1,delete_invalid_rows:!1},status_options:{verbose:!0,fast:!1,restrict_user:``,restrict_session:``,resolve_uids:!0}}}},{path:[`snmp`,`update`],summary:`Update SNMP Service Configuration`,description:`Update SNMP Service Configuration.`,method:`POST`,route:`/snmp.update`,params:[],body:{required:!0,description:``,fields:[{wireName:`snmp_update`,flag:`snmp-update`,required:!0,description:`Data to update the SNMP service configuration.`,type:{kind:`json`}}]},hidden:!1,deprecated:!1,rpc:{method:`snmp.update`,params:[`snmp_update`],job:!1,defaults:{}}},{path:[`staticroute`,`query`],summary:``,description:``,method:`POST`,route:`/staticroute.query`,params:[],body:{required:!1,description:``,fields:[{wireName:`filters`,flag:`filters`,required:!1,description:`List of filters for query results. See API documentation for "Query Methods" for more guidance.`,type:{kind:`array`,elem:{kind:`json`}}},{wireName:`options`,flag:`options`,required:!1,description:`Query options including pagination, ordering, and additional parameters.`,type:{kind:`json`}}]},hidden:!1,deprecated:!1,rpc:{method:`staticroute.query`,params:[`filters`,`options`],job:!1,defaults:{filters:[],options:{extra:{},order_by:[],select:[],count:!1,get:!1,offset:0,limit:0,force_sql_filters:!1,delete_invalid_rows:!1}}}},{path:[`support`,`new-ticket`],summary:`Creates a new ticket for support`,description:`Creates a new ticket for support. This is done using the support proxy API. For TrueNAS Community Edition it will be created on JIRA and for TrueNAS Enterprise on Salesforce.`,method:`POST`,route:`/support.new_ticket`,params:[],body:{required:!0,description:``,fields:[{wireName:`data`,flag:`data`,required:!0,description:"Support ticket data for either Enterprise or Community Edition. Community Edition tickets do not require `criticality`, `environment`, `phone`, `name`, or `email`; Enterprise tickets do not require `token` or `type`.",type:{kind:`json`}}]},hidden:!1,deprecated:!1,rpc:{method:`support.new_ticket`,params:[`data`],job:!0,defaults:{}}},{path:[`system`,`ntpserver`,`query`],summary:``,description:``,method:`POST`,route:`/system.ntpserver.query`,params:[],body:{required:!1,description:``,fields:[{wireName:`filters`,flag:`filters`,required:!1,description:`List of filters for query results. See API documentation for "Query Methods" for more guidance.`,type:{kind:`array`,elem:{kind:`json`}}},{wireName:`options`,flag:`options`,required:!1,description:`Query options including pagination, ordering, and additional parameters.`,type:{kind:`json`}}]},hidden:!1,deprecated:!1,rpc:{method:`system.ntpserver.query`,params:[`filters`,`options`],job:!1,defaults:{filters:[],options:{extra:{},order_by:[],select:[],count:!1,get:!1,offset:0,limit:0,force_sql_filters:!1,delete_invalid_rows:!1}}}},{path:[`system`,`security`,`update`],summary:`Update System Security Service Configuration`,description:`Update System Security Service Configuration.`,method:`POST`,route:`/system.security.update`,params:[],body:{required:!0,description:``,fields:[{wireName:`data`,flag:`data`,required:!0,description:`Data to update the system security configuration.`,type:{kind:`json`}}]},hidden:!1,deprecated:!1,rpc:{method:`system.security.update`,params:[`data`],job:!0,defaults:{}}},{path:[`tn-connect`,`update`],summary:`Update TrueNAS Connect configuration`,description:`Update TrueNAS Connect configuration.`,method:`POST`,route:`/tn_connect.update`,params:[],body:{required:!0,description:``,fields:[{wireName:`tn_connect_update`,flag:`tn-connect-update`,required:!0,description:`Updated TrueNAS Connect configuration.`,type:{kind:`json`}}]},hidden:!1,deprecated:!1,rpc:{method:`tn_connect.update`,params:[`tn_connect_update`],job:!1,defaults:{}}},{path:[`truecommand`,`update`],summary:`Update Truecommand service settings`,description:`Update Truecommand service settings.`,method:`POST`,route:`/truecommand.update`,params:[],body:{required:!0,description:``,fields:[{wireName:`truecommand_update`,flag:`truecommand-update`,required:!0,description:`TrueCommand configuration changes to apply.`,type:{kind:`json`}}]},hidden:!1,deprecated:!1,rpc:{method:`truecommand.update`,params:[`truecommand_update`],job:!1,defaults:{}}},{path:[`tunable`,`query`],summary:``,description:``,method:`POST`,route:`/tunable.query`,params:[],body:{required:!1,description:``,fields:[{wireName:`filters`,flag:`filters`,required:!1,description:`List of filters for query results. See API documentation for "Query Methods" for more guidance.`,type:{kind:`array`,elem:{kind:`json`}}},{wireName:`options`,flag:`options`,required:!1,description:`Query options including pagination, ordering, and additional parameters.`,type:{kind:`json`}}]},hidden:!1,deprecated:!1,rpc:{method:`tunable.query`,params:[`filters`,`options`],job:!1,defaults:{filters:[],options:{extra:{},order_by:[],select:[],count:!1,get:!1,offset:0,limit:0,force_sql_filters:!1,delete_invalid_rows:!1}}}},{path:[`user`,`query`],summary:"Query users with `query-filters` and `query-options`",description:"Query users with `query-filters` and `query-options`.",method:`POST`,route:`/user.query`,params:[],body:{required:!1,description:``,fields:[{wireName:`filters`,flag:`filters`,required:!1,description:`List of filters for query results. See API documentation for "Query Methods" for more guidance.`,type:{kind:`array`,elem:{kind:`json`}}},{wireName:`options`,flag:`options`,required:!1,description:`Query options including pagination, ordering, and additional parameters.`,type:{kind:`json`}}]},hidden:!1,deprecated:!1,rpc:{method:`user.query`,params:[`filters`,`options`],job:!1,defaults:{filters:[],options:{extra:{},order_by:[],select:[],count:!1,get:!1,offset:0,limit:0,force_sql_filters:!1,delete_invalid_rows:!1}}}},{path:[`user`,`renew-2fa-secret`],summary:"Renew ``username`` user's two-factor authentication secret",description:"Renew ``username`` user's two-factor authentication secret.",method:`POST`,route:`/user.renew_2fa_secret`,params:[],body:{required:!0,description:``,fields:[{wireName:`username`,flag:`username`,required:!0,description:`Username to renew two-factor authentication secret for.`,type:{kind:`string`}},{wireName:`twofactor_options`,flag:`twofactor-options`,required:!0,description:`Configuration options for the new two-factor authentication setup.`,type:{kind:`json`}},{wireName:`force`,flag:`force`,required:!1,description:`Allow updating security settings even if HA standby node is down.`,type:{kind:`boolean`}}]},hidden:!1,deprecated:!1,rpc:{method:`user.renew_2fa_secret`,params:[`username`,`twofactor_options`,`force`],job:!1,defaults:{force:!1}}},{path:[`user`,`unset-2fa-secret`],summary:"Unset two-factor authentication secret for ``username``",description:"Unset two-factor authentication secret for ``username``.",method:`POST`,route:`/user.unset_2fa_secret`,params:[],body:{required:!0,description:``,fields:[{wireName:`username`,flag:`username`,required:!0,description:`Username to disable two-factor authentication for.`,type:{kind:`string`}},{wireName:`force`,flag:`force`,required:!1,description:`Allow updating security settings even if HA standby node is down.`,type:{kind:`boolean`}}]},hidden:!1,deprecated:!1,rpc:{method:`user.unset_2fa_secret`,params:[`username`,`force`],job:!1,defaults:{force:!1}}},{path:[`vm`,`bootloader-aavmf-choices`],summary:`Retrieve bootloader AAVMF (aarch64) firmware choices`,description:`Retrieve bootloader AAVMF (aarch64) firmware choices.`,method:`POST`,route:`/vm.bootloader_aavmf_choices`,params:[],hidden:!1,deprecated:!1,rpc:{method:`vm.bootloader_aavmf_choices`,params:[],job:!1,defaults:{}}},{path:[`vm`,`clone`],summary:"Clone the VM ``id``",description:"Clone the VM ``id``.",method:`POST`,route:`/vm.clone`,params:[],body:{required:!0,description:``,fields:[{wireName:`id`,flag:`id`,required:!0,description:`ID of the virtual machine to clone.`,type:{kind:`integer`}},{wireName:`name`,flag:`name`,required:!1,description:"Name for the cloned virtual machine. `null` to append the next available number to the original VM name.",type:{kind:`string`}}]},hidden:!1,deprecated:!1,rpc:{method:`vm.clone`,params:[`id`,`name`],job:!1,defaults:{name:null}}},{path:[`vm`,`cpu-model-choices`],summary:`Retrieve CPU Model choices which can be used with a VM guest to emulate the CPU in the guest`,description:`Retrieve CPU Model choices which can be used with a VM guest to emulate the CPU in the guest.`,method:`POST`,route:`/vm.cpu_model_choices`,params:[],body:{required:!1,description:``,fields:[{wireName:`arch`,flag:`arch`,required:!1,description:`Guest architecture to return CPU model choices for (e.g. 'x86_64', 'aarch64').`,type:{kind:`string`}}]},hidden:!1,deprecated:!1,rpc:{method:`vm.cpu_model_choices`,params:[`arch`],job:!1,defaults:{arch:`x86_64`}}},{path:[`vm`,`create`],summary:`Create a Virtual Machine (VM)`,description:`Create a Virtual Machine (VM).`,method:`POST`,route:`/vm.create`,params:[],body:{required:!0,description:``,fields:[{wireName:`vm_create`,flag:`vm-create`,required:!0,description:`VM creation parameters.`,type:{kind:`json`}}]},hidden:!1,deprecated:!1,rpc:{method:`vm.create`,params:[`vm_create`],job:!1,defaults:{}}},{path:[`vm`,`get-guest-network-interfaces`],summary:`Return the network interfaces visible inside a running VM as reported by the QEMU guest agent`,description:`Return the network interfaces visible inside a running VM as reported by the QEMU guest agent.`,method:`POST`,route:`/vm.get_guest_network_interfaces`,params:[],body:{required:!0,description:``,fields:[{wireName:`id`,flag:`id`,required:!0,description:`ID of the virtual machine.`,type:{kind:`integer`}}]},hidden:!1,deprecated:!1,rpc:{method:`vm.get_guest_network_interfaces`,params:[`id`],job:!1,defaults:{}}},{path:[`vm`,`query`],summary:``,description:``,method:`POST`,route:`/vm.query`,params:[],body:{required:!1,description:``,fields:[{wireName:`filters`,flag:`filters`,required:!1,description:`List of filters for query results. See API documentation for "Query Methods" for more guidance.`,type:{kind:`array`,elem:{kind:`json`}}},{wireName:`options`,flag:`options`,required:!1,description:`Query options including pagination, ordering, and additional parameters.`,type:{kind:`json`}}]},hidden:!1,deprecated:!1,rpc:{method:`vm.query`,params:[`filters`,`options`],job:!1,defaults:{filters:[],options:{extra:{},order_by:[],select:[],count:!1,get:!1,offset:0,limit:0,force_sql_filters:!1,delete_invalid_rows:!1}}}},{path:[`vm`,`reset`],summary:"Reset ``id`` VM",description:"Reset ``id`` VM.",method:`POST`,route:`/vm.reset`,params:[],body:{required:!0,description:``,fields:[{wireName:`id`,flag:`id`,required:!0,description:`ID of the virtual machine to reset.`,type:{kind:`integer`}}]},confirmation:``,hidden:!1,deprecated:!1,rpc:{method:`vm.reset`,params:[`id`],job:!1,defaults:{}}},{path:[`vm`,`device`,`convert`],summary:`Convert between disk images and ZFS volumes`,description:`Convert between disk images and ZFS volumes. Supported disk image formats are qcow2, qed, raw, vdi, vhdx, and vmdk. The conversion direction is determined automatically based on file extension.`,method:`POST`,route:`/vm.device.convert`,params:[],body:{required:!0,description:``,fields:[{wireName:`vm_convert`,flag:`vm-convert`,required:!0,description:`VM device conversion parameters.`,type:{kind:`json`}}]},hidden:!1,deprecated:!1,rpc:{method:`vm.device.convert`,params:[`vm_convert`],job:!0,defaults:{}}},{path:[`vm`,`device`,`create`],summary:"Create a new device for the VM of id ``vm``",description:"Create a new device for the VM of id ``vm``.",method:`POST`,route:`/vm.device.create`,params:[],body:{required:!0,description:``,fields:[{wireName:`vm_device_create`,flag:`vm-device-create`,required:!0,description:`VM device creation parameters.`,type:{kind:`json`}}]},hidden:!1,deprecated:!1,rpc:{method:`vm.device.create`,params:[`vm_device_create`],job:!1,defaults:{}}},{path:[`vm`,`device`,`query`],summary:``,description:``,method:`POST`,route:`/vm.device.query`,params:[],body:{required:!1,description:``,fields:[{wireName:`filters`,flag:`filters`,required:!1,description:`List of filters for query results. See API documentation for "Query Methods" for more guidance.`,type:{kind:`array`,elem:{kind:`json`}}},{wireName:`options`,flag:`options`,required:!1,description:`Query options including pagination, ordering, and additional parameters.`,type:{kind:`json`}}]},hidden:!1,deprecated:!1,rpc:{method:`vm.device.query`,params:[`filters`,`options`],job:!1,defaults:{filters:[],options:{extra:{},order_by:[],select:[],count:!1,get:!1,offset:0,limit:0,force_sql_filters:!1,delete_invalid_rows:!1}}}},{path:[`vm`,`device`,`virtual-size`],summary:`Get the virtual size of a disk image using qemu-img info`,description:`Get the virtual size of a disk image using qemu-img info.`,method:`POST`,route:`/vm.device.virtual_size`,params:[],body:{required:!0,description:``,fields:[{wireName:`vm_virtual_size`,flag:`vm-virtual-size`,required:!0,description:`VM device virtual size parameters.`,type:{kind:`json`}}]},hidden:!1,deprecated:!1,rpc:{method:`vm.device.virtual_size`,params:[`vm_virtual_size`],job:!1,defaults:{}}},{path:[`vmware`,`query`],summary:``,description:``,method:`POST`,route:`/vmware.query`,params:[],body:{required:!1,description:``,fields:[{wireName:`filters`,flag:`filters`,required:!1,description:`List of filters for query results. See API documentation for "Query Methods" for more guidance.`,type:{kind:`array`,elem:{kind:`json`}}},{wireName:`options`,flag:`options`,required:!1,description:`Query options including pagination, ordering, and additional parameters.`,type:{kind:`json`}}]},hidden:!1,deprecated:!1,rpc:{method:`vmware.query`,params:[`filters`,`options`],job:!1,defaults:{filters:[],options:{extra:{},order_by:[],select:[],count:!1,get:!1,offset:0,limit:0,force_sql_filters:!1,delete_invalid_rows:!1}}}},{path:[`zfs`,`resource`,`attachments`],summary:"Retrieve the shares, tasks and services that depend on the ZFS resource named by ``path``",description:"Retrieve the shares, tasks and services that depend on the ZFS resource named by ``path``.",method:`POST`,route:`/zfs.resource.attachments`,params:[],body:{required:!0,description:``,fields:[{wireName:`path`,flag:`path`,required:!0,description:`Path of the zfs resource (filesystem or volume) whose dependents to list.`,type:{kind:`string`}}]},hidden:!1,deprecated:!1,rpc:{method:`zfs.resource.attachments`,params:[`path`],job:!1,defaults:{}}},{path:[`zfs`,`resource`,`checksum-choices`],summary:`Retrieve the checksum algorithms a ZFS resource may use`,description:`Retrieve the checksum algorithms a ZFS resource may use.`,method:`POST`,route:`/zfs.resource.checksum_choices`,params:[],hidden:!1,deprecated:!1,rpc:{method:`zfs.resource.checksum_choices`,params:[],job:!1,defaults:{}}},{path:[`zfs`,`resource`,`compression-choices`],summary:`Retrieve the compression algorithms a ZFS resource may use`,description:`Retrieve the compression algorithms a ZFS resource may use.`,method:`POST`,route:`/zfs.resource.compression_choices`,params:[],hidden:!1,deprecated:!1,rpc:{method:`zfs.resource.compression_choices`,params:[],job:!1,defaults:{}}},{path:[`zfs`,`resource`,`create`],summary:`Create a ZFS resource (filesystem or volume) and mount it`,description:`Create a ZFS resource (filesystem or volume) and mount it.`,method:`POST`,route:`/zfs.resource.create`,params:[],body:{required:!0,description:``,fields:[{wireName:`data`,flag:`data`,required:!0,description:`Create parameters for creating a ZFS resource.`,type:{kind:`json`}}]},hidden:!1,deprecated:!1,rpc:{method:`zfs.resource.create`,params:[`data`],job:!1,defaults:{}}},{path:[`zfs`,`resource`,`list`],summary:`List ZFS resources (datasets and volumes)`,description:`List ZFS resources (datasets and volumes).`,method:`POST`,route:`/zfs.resource.list`,params:[],body:{required:!0,description:``,fields:[{wireName:`data`,flag:`data`,required:!0,description:`Query parameters for retrieving ZFS resource information.`,type:{kind:`json`}}]},hidden:!1,deprecated:!1,rpc:{method:`zfs.resource.list`,params:[`data`],job:!1,defaults:{}}},{path:[`zfs`,`resource`,`processes`],summary:"Retrieve the processes holding open files on the ZFS resource named by ``path``",description:"Retrieve the processes holding open files on the ZFS resource named by ``path``.",method:`POST`,route:`/zfs.resource.processes`,params:[],body:{required:!0,description:``,fields:[{wireName:`path`,flag:`path`,required:!0,description:`Path of the zfs resource to list processes for.`,type:{kind:`string`}}]},hidden:!1,deprecated:!1,rpc:{method:`zfs.resource.processes`,params:[`path`],job:!1,defaults:{}}},{path:[`zfs`,`resource`,`promote`],summary:`Promote a cloned ZFS resource so that it no longer depends on the snapshot it was cloned from`,description:`Promote a cloned ZFS resource so that it no longer depends on the snapshot it was cloned from.`,method:`POST`,route:`/zfs.resource.promote`,params:[],body:{required:!0,description:``,fields:[{wireName:`data`,flag:`data`,required:!0,description:`Promote parameters for promoting a ZFS clone.`,type:{kind:`json`}}]},hidden:!1,deprecated:!1,rpc:{method:`zfs.resource.promote`,params:[`data`],job:!1,defaults:{}}},{path:[`zfs`,`resource`,`query`],summary:`List ZFS resources (datasets and volumes) with flexible filtering options`,description:`List ZFS resources (datasets and volumes) with flexible filtering options.`,method:`POST`,route:`/zfs.resource.query`,params:[],body:{required:!0,description:``,fields:[{wireName:`data`,flag:`data`,required:!0,description:`Query parameters for retrieving ZFS resource information.`,type:{kind:`json`}}]},hidden:!1,deprecated:!1,rpc:{method:`zfs.resource.query`,params:[`data`],job:!1,defaults:{}}},{path:[`zfs`,`resource`,`recommended-zvol-blocksize`],summary:"Retrieve the recommended ``volblocksize`` for a new volume on the given pool",description:"Retrieve the recommended ``volblocksize`` for a new volume on the given pool.",method:`POST`,route:`/zfs.resource.recommended_zvol_blocksize`,params:[],body:{required:!0,description:``,fields:[{wireName:`pool`,flag:`pool`,required:!0,description:`The pool name to get the recommended volume block size for.`,type:{kind:`string`}}]},hidden:!1,deprecated:!1,rpc:{method:`zfs.resource.recommended_zvol_blocksize`,params:[`pool`],job:!1,defaults:{}}},{path:[`zfs`,`resource`,`recordsize-choices`],summary:`Retrieve the record sizes a filesystem may be given`,description:`Retrieve the record sizes a filesystem may be given.`,method:`POST`,route:`/zfs.resource.recordsize_choices`,params:[],body:{required:!1,description:``,fields:[{wireName:`pool_name`,flag:`pool-name`,required:!1,description:`Optional pool name to get record size choices for. If not provided, returns general choices.`,type:{kind:`string`}}]},hidden:!1,deprecated:!1,rpc:{method:`zfs.resource.recordsize_choices`,params:[`pool_name`],job:!1,defaults:{pool_name:null}}},{path:[`zfs`,`resource`,`rename`],summary:`Rename a ZFS resource (filesystem or volume), remounting it at its new location`,description:`Rename a ZFS resource (filesystem or volume), remounting it at its new location.`,method:`POST`,route:`/zfs.resource.rename`,params:[],body:{required:!0,description:``,fields:[{wireName:`data`,flag:`data`,required:!0,description:`Rename parameters for renaming a ZFS resource.`,type:{kind:`json`}}]},hidden:!1,deprecated:!1,rpc:{method:`zfs.resource.rename`,params:[`data`],job:!1,defaults:{}}},{path:[`zfs`,`resource`,`set`],summary:`Change the properties of a ZFS resource (filesystem or volume)`,description:`Change the properties of a ZFS resource (filesystem or volume).`,method:`POST`,route:`/zfs.resource.set`,params:[],body:{required:!0,description:``,fields:[{wireName:`data`,flag:`data`,required:!0,description:`Set parameters for changing a ZFS resource.`,type:{kind:`json`}}]},hidden:!1,deprecated:!1,rpc:{method:`zfs.resource.set`,params:[`data`],job:!1,defaults:{}}},{path:[`zfs`,`resource`,`share-type-choices`],summary:"Retrieve the ``share_type`` presets :doc:`zfs.resource.create <api_methods_zfs.resource.create>` accepts and the native properties each one sets",description:"Retrieve the ``share_type`` presets :doc:`zfs.resource.create <api_methods_zfs.resource.create>` accepts and the native properties each one sets.",method:`POST`,route:`/zfs.resource.share_type_choices`,params:[],hidden:!1,deprecated:!1,rpc:{method:`zfs.resource.share_type_choices`,params:[],job:!1,defaults:{}}},{path:[`zfs`,`resource`,`encryption`,`inherit`],summary:`Make an unlocked encryption root part of its parent's encryption root, discarding its own key`,description:`Make an unlocked encryption root part of its parent's encryption root, discarding its own key.`,method:`POST`,route:`/zfs.resource.encryption.inherit`,params:[],body:{required:!0,description:``,fields:[{wireName:`data`,flag:`data`,required:!0,description:`Inherit parameters.`,type:{kind:`json`}}]},hidden:!1,deprecated:!1,rpc:{method:`zfs.resource.encryption.inherit`,params:[`data`],job:!1,defaults:{}}},{path:[`zfs`,`resource`,`encryption`,`lock`],summary:`Lock an encryption root that is encrypted with a passphrase`,description:`Lock an encryption root that is encrypted with a passphrase.`,method:`POST`,route:`/zfs.resource.encryption.lock`,params:[],body:{required:!0,description:``,fields:[{wireName:`data`,flag:`data`,required:!0,description:`Lock parameters.`,type:{kind:`json`}}]},hidden:!1,deprecated:!1,rpc:{method:`zfs.resource.encryption.lock`,params:[`data`],job:!0,defaults:{}}},{path:[`zfs`,`resource`,`snapshot`,`list`],summary:`List ZFS snapshots and, on request, their properties, user properties and holds`,description:`List ZFS snapshots and, on request, their properties, user properties and holds.`,method:`POST`,route:`/zfs.resource.snapshot.list`,params:[],body:{required:!0,description:``,fields:[{wireName:`data`,flag:`data`,required:!0,description:`Parameters selecting the snapshots to list and the information to retrieve.`,type:{kind:`json`}}]},hidden:!1,deprecated:!1,rpc:{method:`zfs.resource.snapshot.list`,params:[`data`],job:!1,defaults:{}}},{path:[`zfs`,`resource`,`snapshot`,`query`],summary:`Retrieve information about ZFS snapshots, including their properties and user properties`,description:`Retrieve information about ZFS snapshots, including their properties and user properties.`,method:`POST`,route:`/zfs.resource.snapshot.query`,params:[],body:{required:!0,description:``,fields:[{wireName:`data`,flag:`data`,required:!0,description:`Parameters selecting the snapshots to list and the information to retrieve.`,type:{kind:`json`}}]},hidden:!1,deprecated:!1,rpc:{method:`zfs.resource.snapshot.query`,params:[`data`],job:!1,defaults:{}}}],t=[{path:[`acme`],description:``},{path:[`acme`,`dns`],description:``},{path:[`acme`,`dns`,`authenticator`],description:``},{path:[`alert`],description:``},{path:[`alertclasses`],description:``},{path:[`alertservice`],description:``},{path:[`api-key`],description:``},{path:[`app`],description:``},{path:[`app`,`image`],description:``},{path:[`app`,`ix-volume`],description:``},{path:[`app`,`registry`],description:``},{path:[`audit`],description:``},{path:[`auth`],description:``},{path:[`auth`,`twofactor`],description:``},{path:[`boot`],description:``},{path:[`boot`,`environment`],description:``},{path:[`catalog`],description:``},{path:[`certificate`],description:``},{path:[`cloud-backup`],description:``},{path:[`cloudsync`],description:``},{path:[`cloudsync`,`credentials`],description:``},{path:[`config`],description:``},{path:[`core`],description:``},{path:[`cronjob`],description:``},{path:[`device`],description:``},{path:[`directoryservices`],description:``},{path:[`disk`],description:``},{path:[`dns`],description:``},{path:[`docker`],description:``},{path:[`docker`,`network`],description:``},{path:[`enclosure`],description:``},{path:[`enclosure`,`label`],description:``},{path:[`enclosure2`],description:``},{path:[`failover`],description:``},{path:[`failover`,`disabled`],description:``},{path:[`failover`,`reboot`],description:``},{path:[`fc`],description:``},{path:[`fc`,`fc-host`],description:``},{path:[`fcport`],description:``},{path:[`filesystem`],description:``},{path:[`filesystem`,`acltemplate`],description:``},{path:[`ftp`],description:``},{path:[`group`],description:``},{path:[`hardware`],description:``},{path:[`hardware`,`virtualization`],description:``},{path:[`idmap`],description:``},{path:[`initshutdownscript`],description:``},{path:[`interface`],description:``},{path:[`ipmi`],description:``},{path:[`ipmi`,`chassis`],description:``},{path:[`ipmi`,`lan`],description:``},{path:[`ipmi`,`sel`],description:``},{path:[`iscsi`],description:``},{path:[`iscsi`,`auth`],description:``},{path:[`iscsi`,`extent`],description:``},{path:[`iscsi`,`global`],description:``},{path:[`iscsi`,`initiator`],description:``},{path:[`iscsi`,`portal`],description:``},{path:[`iscsi`,`target`],description:``},{path:[`iscsi`,`targetextent`],description:``},{path:[`jbof`],description:``},{path:[`kerberos`],description:``},{path:[`kerberos`,`keytab`],description:``},{path:[`kerberos`,`realm`],description:``},{path:[`keychaincredential`],description:``},{path:[`kmip`],description:``},{path:[`mail`],description:``},{path:[`network`],description:``},{path:[`network`,`configuration`],description:``},{path:[`network`,`general`],description:``},{path:[`nfs`],description:``},{path:[`nvmet`],description:``},{path:[`nvmet`,`global`],description:``},{path:[`nvmet`,`host`],description:``},{path:[`nvmet`,`host-subsys`],description:``},{path:[`nvmet`,`namespace`],description:``},{path:[`nvmet`,`port`],description:``},{path:[`nvmet`,`port-subsys`],description:``},{path:[`nvmet`,`subsys`],description:``},{path:[`pool`],description:``},{path:[`pool`,`dataset`],description:``},{path:[`pool`,`resilver`],description:``},{path:[`pool`,`scrub`],description:``},{path:[`pool`,`snapshot`],description:``},{path:[`pool`,`snapshottask`],description:``},{path:[`privilege`],description:``},{path:[`rdma`],description:``},{path:[`replication`],description:``},{path:[`replication`,`config`],description:``},{path:[`reporting`],description:``},{path:[`reporting`,`exporters`],description:``},{path:[`route`],description:``},{path:[`rsynctask`],description:``},{path:[`service`],description:``},{path:[`sharing`],description:``},{path:[`sharing`,`nfs`],description:``},{path:[`sharing`,`smb`],description:``},{path:[`smb`],description:``},{path:[`snmp`],description:``},{path:[`ssh`],description:``},{path:[`staticroute`],description:``},{path:[`support`],description:``},{path:[`system`],description:``},{path:[`system`,`advanced`],description:``},{path:[`system`,`general`],description:``},{path:[`system`,`global`],description:``},{path:[`system`,`ntpserver`],description:``},{path:[`system`,`reboot`],description:``},{path:[`system`,`security`],description:``},{path:[`system`,`security`,`info`],description:``},{path:[`systemdataset`],description:``},{path:[`tn-connect`],description:``},{path:[`truecommand`],description:``},{path:[`truenas`],description:``},{path:[`tunable`],description:``},{path:[`update`],description:``},{path:[`ups`],description:``},{path:[`user`],description:``},{path:[`vm`],description:``},{path:[`vm`,`device`],description:``},{path:[`vmware`],description:``},{path:[`webui`],description:``},{path:[`webui`,`crypto`],description:``},{path:[`webui`,`enclosure`],description:``},{path:[`webui`,`main`],description:``},{path:[`webui`,`main`,`dashboard`],description:``},{path:[`zfs`],description:``},{path:[`zfs`,`resource`],description:``},{path:[`container`],description:``},{path:[`container`,`device`],description:``},{path:[`container`,`image`],description:``},{path:[`lxc`],description:``},{path:[`s3`],description:``},{path:[`s3`,`accesskey`],description:``},{path:[`sharing`,`s3`],description:``},{path:[`sharing`,`webshare`],description:``},{path:[`truenas`,`entitlements`],description:``},{path:[`truenas`,`license`],description:``},{path:[`webshare`],description:``},{path:[`zfs`,`resource`,`snapshot`],description:``},{path:[`zfs`,`tier`],description:``},{path:[`zpool`],description:``},{path:[`zpool`,`scrub`],description:``},{path:[`zfs`,`resource`,`encryption`],description:``}],n={"25.10.0":[[0,1,2,3,4,5,6,7,8,9,10,11,12,13,14,15,16,17,18,19,20,21,22,23,24,25,26,27,28,29,30,31,32,33,34,35,36,37,38,39,40,41,42,43,44,45,46,47,48,49,50,51,52,53,54,55,56,57,58,59,60,61,62,63,64,65,66,67,68,69,70,71,72,73,74,75,76,77,78,79,80,81,82,83,84,85,86,87,88,89,90,91,92,93,94,95,96,97,98,99,100,101,102,103,104,105,106,107,108,109,110,111,112,113,114,115,116,117,118,119,120,121,122,123,124,125,126,127,128,129,130,131,132,133,134,135,136,137,138,139,140,141,142,143,144,145,146,147,148,149,150,151,152,153,154,155,156,157,158,159,160,161,162,163,164,165,166,167,168,169,170,171,172,173,174,175,176,177,178,179,180,181,182,183,184,185,186,187,188,189,190,191,192,193,194,195,196,197,198,199,200,201,202,203,204,205,206,207,208,209,210,211,212,213,214,215,216,217,218,219,220,221,222,223,224,225,226,227,228,229,230,231,232,233,234,235,236,237,238,239,240,241,242,243,244,245,246,247,248,249,250,251,252,253,254,255,256,257,258,259,260,261,262,263,264,265,266,267,268,269,270,271,272,273,274,275,276,277,278,279,280,281,282,283,284,285,286,287,288,289,290,291,292,293,294,295,296,297,298,299,300,301,302,303,304,305,306,307,308,309,310,311,312,313,314,315,316,317,318,319,320,321,322,323,324,325,326,327,328,329,330,331,332,333,334,335,336,337,338,339,340,341,342,343,344,345,346,347,348,349,350,351,352,353,354,355,356,357,358,359,360,361,362,363,364,365,366,367,368,369,370,371,372,373,374,375,376,377,378,379,380,381,382,383,384,385,386,387,388,389,390,391,392,393,394,395,396,397,398,399,400,401,402,403,404,405,406,407,408,409,410,411,412,413,414,415,416,417,418,419,420,421,422,423,424,425,426,427,428,429,430,431,432,433,434,435,436,437,438,439,440,441,442,443,444,445,446,447,448,449,450,451,452,453,454,455,456,457,458,459,460,461,462,463,464,465,466,467,468,469,470,471,472,473,474,475,476,477,478,479,480,481,482,483,484,485,486,487,488,489,490,491,492,493,494,495,496,497,498,499,500,501,502,503,504,505,506,507,508,509,510,511,512,513,514,515,516,517,518,519,520,521,522,523,524,525,526,527,528,529,530,531,532,533,534,535,536,537,538,539,540,541,542,543,544,545,546,547,548,549,550,551,552,553,554,555,556,557,558,559,560,561,562,563,564,565,566,567,568,569,570,571,572,573,574,575,576,577,578,579,580,581,582,583,584,585,586,587,588,589,590,591,592,593,594,595,596,597,598,599,600,601,602,603,604,605,606,607,608,609,610,611,612,613,614,615,616,617,618,619,620,621,622,623,624,625,626,627,628,629,630,631,632,633,634,635,636,637,638,639,640,641,642,643,644,645,646,647,648,649,650,651,652,653,654,655,656,657,658,659,660,661,662,663,664,665,666,667,668,669,670,671,672,673,674,675,676,677,678,679,680,681,682,683,684,685,686,687,688,689,690,691,692,693,694,695,696,697,698,699,700,701,702,703,704,705,706,707,708,709,710,711,712,713,714,715,716,717,718,719,720,721,722,723,724,725,726,727,728,729],[0,1,2,3,4,5,6,7,8,9,10,11,12,13,14,15,16,17,18,19,20,21,22,23,24,25,26,27,28,29,30,31,32,33,34,35,36,37,38,39,40,41,42,43,44,45,46,47,48,49,50,51,52,53,54,55,56,57,58,59,60,61,62,63,64,65,66,67,68,69,70,71,72,73,74,75,76,77,78,79,80,81,82,83,84,85,86,87,88,89,90,91,92,93,94,95,96,97,98,99,100,101,102,103,104,105,106,107,108,109,110,111,112,113,114,115,116,117,118,119,120,121,122,123,124,125,126,127]],"27.0.0":[[0,1,2,3,4,5,6,7,730,9,10,11,12,13,14,15,16,17,18,731,19,20,21,22,23,24,25,26,27,28,29,30,31,32,33,732,35,36,37,38,39,40,41,42,43,44,45,46,47,48,49,733,50,51,52,53,54,55,56,57,58,59,60,61,62,63,64,65,734,735,68,69,70,71,72,73,74,75,76,77,78,79,80,81,82,83,84,85,86,87,88,89,90,91,92,93,94,95,96,97,736,99,100,101,737,102,738,104,105,106,107,108,109,110,111,112,113,114,115,116,117,118,119,120,121,122,123,124,125,126,127,128,129,130,131,132,133,134,135,136,137,138,139,140,141,142,739,143,144,145,740,741,742,743,744,745,746,747,748,749,750,751,752,753,754,755,756,757,146,147,758,149,150,151,152,153,154,155,156,157,158,159,160,161,162,163,164,165,166,167,168,169,170,171,172,759,173,174,175,176,760,761,177,178,179,762,180,181,182,183,184,185,186,187,188,189,190,191,192,193,194,195,196,197,198,199,200,201,202,203,204,205,206,207,208,209,210,211,212,213,214,215,216,217,218,219,763,221,222,223,224,225,226,227,228,229,230,231,232,233,234,235,236,237,238,239,240,241,242,243,244,245,246,247,248,249,250,251,252,253,254,764,255,256,257,258,259,260,261,262,263,264,265,266,267,268,269,270,271,272,273,274,275,276,277,278,765,766,281,282,283,284,285,286,287,288,289,290,291,292,293,294,295,296,297,298,299,300,301,302,303,304,305,306,307,308,309,310,311,312,313,314,315,316,317,318,319,320,321,322,323,324,325,326,327,328,329,330,331,332,333,334,335,336,337,338,339,340,341,342,343,344,345,346,347,348,349,350,351,352,353,354,355,356,357,358,359,767,768,769,360,361,362,363,364,365,366,367,368,369,370,371,372,373,374,375,376,377,378,379,380,381,382,383,384,385,386,387,388,389,390,391,392,393,394,395,396,397,398,399,400,401,402,403,404,405,406,407,408,409,410,411,412,413,414,415,416,417,418,419,420,421,422,423,424,425,770,426,427,771,428,429,430,431,432,433,434,435,436,437,438,439,772,441,442,443,444,445,446,447,448,449,450,451,452,453,454,455,456,457,458,459,460,461,462,463,464,465,466,467,468,469,470,471,472,473,474,475,476,477,478,479,480,481,773,482,483,484,485,486,487,488,489,490,491,492,493,494,495,496,497,498,774,500,501,502,503,504,505,506,507,508,509,510,511,512,513,514,515,516,517,518,519,520,521,522,523,524,525,526,775,776,777,778,779,780,781,782,527,528,529,530,531,532,533,534,535,536,537,538,539,540,541,783,784,785,786,787,788,789,790,791,542,543,544,545,546,547,548,549,550,792,793,794,795,796,551,552,797,553,554,555,556,557,558,559,560,561,562,563,564,565,566,567,568,569,570,571,572,573,798,575,576,577,578,579,580,581,582,583,584,585,586,587,799,588,589,590,591,592,593,594,595,596,597,598,599,600,601,602,603,604,605,606,607,608,609,610,611,612,613,614,615,616,617,618,619,620,621,622,623,624,625,800,626,627,628,629,630,631,632,633,634,635,636,801,802,803,804,805,806,637,638,639,640,641,642,643,644,645,646,647,648,649,650,651,652,653,654,807,656,657,658,659,660,661,662,663,664,665,666,667,668,669,670,671,672,673,674,675,676,677,678,679,680,681,682,683,684,685,686,687,688,689,690,691,692,693,694,695,696,697,698,699,700,701,702,703,704,705,706,707,708,709,710,711,712,713,714,715,716,808,717,718,719,720,721,722,723,724,809,810,811,725,726,727,728,812,813,814,815,816,817,818,819,820,821,822,823,824,825,826,827,828,829,830,831,832,833,834],[0,1,2,3,4,5,6,7,8,9,10,11,12,13,14,15,16,17,18,19,20,21,128,129,130,22,23,24,25,26,27,28,29,30,31,32,33,34,35,36,37,38,39,40,41,42,43,44,45,46,47,48,49,50,51,52,53,54,55,56,57,58,59,60,61,62,63,64,65,131,66,67,68,69,70,71,72,73,74,75,76,77,78,79,80,81,82,83,84,85,86,87,88,89,90,91,92,132,133,93,94,95,134,96,135,97,98,99,100,101,102,103,104,105,106,107,108,109,110,111,112,113,136,137,114,115,116,117,118,119,120,138,121,122,123,124,125,126,127,139,140,141,142]],"28.0.0":[[0,835,2,3,836,5,6,7,730,9,10,11,12,13,14,15,837,17,18,731,19,20,21,22,838,24,839,26,27,28,29,30,31,32,840,732,35,36,37,841,39,40,842,42,43,44,45,46,47,843,844,733,50,51,52,53,54,55,845,846,58,847,848,60,61,62,849,64,65,850,851,68,69,70,71,72,73,74,75,76,77,78,852,80,81,82,83,84,85,86,87,88,89,90,91,853,854,855,95,856,857,736,99,100,101,737,102,738,104,105,858,107,108,109,110,859,112,113,114,115,116,117,118,119,860,121,122,123,124,125,126,127,128,129,130,861,132,133,862,135,136,137,138,139,140,141,863,739,143,144,145,864,741,742,743,744,865,746,747,748,866,750,751,752,753,867,755,756,757,146,147,758,868,150,151,152,153,154,155,156,157,158,159,160,161,162,163,869,165,166,167,168,169,170,171,172,759,173,174,870,175,871,760,761,177,178,179,762,180,181,872,183,184,185,186,187,188,189,190,873,192,874,194,875,876,197,198,199,200,201,202,203,204,205,206,207,208,209,210,211,212,877,214,215,216,217,218,878,879,221,222,223,880,881,882,883,228,229,230,231,232,233,234,235,884,237,238,885,240,241,242,243,244,245,886,247,248,249,250,251,252,887,254,764,255,256,257,258,259,260,261,262,263,264,265,266,267,268,888,270,271,272,273,274,275,276,277,278,765,766,281,282,283,284,889,286,287,288,289,890,291,292,293,294,295,891,297,298,299,300,301,892,303,304,305,306,893,308,309,310,311,312,894,314,315,316,317,895,319,320,321,322,323,896,325,326,327,328,329,897,331,332,333,334,335,336,337,898,339,340,341,342,899,344,345,346,347,348,900,350,351,352,353,354,355,356,357,358,901,767,768,902,360,361,362,363,364,365,366,367,368,369,903,904,905,373,906,375,376,377,378,379,380,381,907,383,384,385,386,908,388,389,390,391,909,393,394,395,396,910,398,399,400,401,402,911,404,405,406,407,912,409,410,411,412,413,414,415,416,417,418,419,420,421,422,423,424,425,770,426,913,771,428,429,430,431,432,433,434,435,436,437,438,439,914,441,442,443,444,915,446,447,448,449,450,451,452,453,454,455,456,457,916,459,460,461,462,463,464,465,466,917,468,469,470,471,472,473,474,475,476,477,918,479,480,481,773,482,483,484,919,920,487,488,489,490,491,492,493,494,495,496,921,498,774,500,501,502,503,504,505,506,507,922,509,510,923,924,925,514,515,516,926,518,519,927,521,522,523,928,525,526,775,776,777,778,779,780,929,782,527,528,930,530,531,532,533,534,535,536,537,538,539,931,541,783,784,785,786,787,932,789,790,791,542,543,544,545,546,933,548,549,550,792,793,794,934,796,551,552,935,553,554,555,936,557,558,559,560,561,562,937,564,565,566,567,568,569,938,571,572,573,798,575,576,577,578,579,580,581,582,583,584,585,586,587,799,588,589,590,591,592,593,594,595,596,597,598,599,600,601,602,603,604,605,606,607,608,609,610,611,939,613,614,615,616,940,618,619,620,621,622,623,624,625,800,941,627,942,629,630,631,632,633,634,635,636,801,802,803,804,805,806,637,638,639,943,641,642,643,644,645,646,647,648,649,650,651,652,653,654,807,656,657,658,659,660,661,944,945,664,665,666,946,668,947,669,670,948,949,950,674,675,676,677,678,679,951,680,681,682,683,684,685,686,687,688,952,690,953,691,692,693,694,695,696,697,698,699,700,701,954,955,704,705,706,707,708,709,710,711,956,713,714,715,716,957,717,718,719,720,721,722,958,724,809,810,811,725,726,727,728,959,960,961,962,812,963,964,965,966,967,968,969,970,971,972,973,814,815,816,817,818,819,974,975,821,822,823,824,825,826,827,828,829,830,831,832,833,834],[0,1,2,3,4,5,6,7,8,9,10,11,12,13,14,15,16,17,18,19,20,21,128,129,130,22,23,24,25,26,27,28,29,30,31,32,33,34,35,36,37,38,39,40,41,42,43,44,45,46,47,48,49,50,51,52,53,54,55,56,57,58,59,60,61,62,63,64,65,131,66,67,68,69,70,71,72,73,74,75,76,77,78,79,80,81,82,83,84,85,86,87,88,89,90,91,92,132,133,93,94,95,134,96,135,97,98,99,100,101,102,103,104,105,106,107,108,109,110,111,112,113,136,137,114,115,116,117,118,119,120,138,121,122,123,124,125,126,127,143,139,140,141,142]]};function r(r){let i=n[r];if(i===void 0)throw Error(`no catalogue for ${r}`);let a=(e,t)=>t.flatMap(t=>e[t]??[]);return{version:r,commands:a(e,i[0]),groups:a(t,i[1])}}export{r as catalog};