Table Of Contents
- JSON-RPC 2.0 over WebSocket API
- API Methods
- acme.dns.authenticator
- alert
- alertclasses
- alertservice
- api_key
- app
- app.available
- app.available_space
- app.categories
- app.certificate_authority_choices
- app.certificate_choices
- app.config
- app.container_console_choices
- app.container_ids
- app.convert_to_custom
- app.create
- app.delete
- app.get_instance
- app.gpu_choices
- app.ip_choices
- app.latest
- app.outdated_docker_images
- app.pull_images
- app.query
- app.redeploy
- app.rollback
- app.rollback_versions
- app.similar
- app.start
- app.stop
- app.update
- app.upgrade
- app.upgrade_summary
- app.used_ports
- app.image
- app.ix_volume
- app.registry
- auth
- boot.environment
- catalog
- certificate
- cloud_backup
- cloudsync
- cloudsync.credentials
- config
- core
- cronjob
- device
- disk
- docker
- docker.network
- enclosure.label
- failover.reboot
- filesystem
- filesystem.acltemplate
- ftp
- group
- initshutdownscript
- ipmi
- iscsi.auth
- iscsi.extent
- iscsi.global
- iscsi.initiator
- iscsi.portal
- iscsi.target
- iscsi.targetextent
- k8s_to_docker
- keychaincredential
- keychaincredential.create
- keychaincredential.delete
- keychaincredential.generate_ssh_key_pair
- keychaincredential.get_instance
- keychaincredential.query
- keychaincredential.remote_ssh_host_key_scan
- keychaincredential.remote_ssh_semiautomatic_setup
- keychaincredential.setup_ssh_connection
- keychaincredential.update
- keychaincredential.used_by
- nfs
- pool
- pool.dataset
- pool.resilver
- pool.scrub
- pool.snapshottask
- pool.snapshottask.create
- pool.snapshottask.delete
- pool.snapshottask.delete_will_change_retention_for
- pool.snapshottask.get_instance
- pool.snapshottask.max_count
- pool.snapshottask.max_total_count
- pool.snapshottask.query
- pool.snapshottask.run
- pool.snapshottask.update
- pool.snapshottask.update_will_change_retention_for
- privilege
- reporting
- reporting.exporters
- sharing.nfs
- sharing.smb
- smb
- snmp
- staticroute
- system
- system.general
- system.ntpserver
- system.reboot
- system.security
- system.security.info
- tn_connect
- truenas
- user
- virt.device
- virt.global
- virt.instance
- virt.instance.create
- virt.instance.delete
- virt.instance.device_add
- virt.instance.device_delete
- virt.instance.device_list
- virt.instance.device_update
- virt.instance.get_instance
- virt.instance.image_choices
- virt.instance.query
- virt.instance.restart
- virt.instance.start
- virt.instance.stop
- virt.instance.update
- virt.volume
- API Events
- acme.dns.authenticator
- alert
- alertservice
- api_key
- app
- app.image
- app.registry
- cloud_backup
- cloudsync.credentials
- cronjob
- docker.network
- filesystem.acltemplate
- group
- initshutdownscript
- iscsi.auth
- iscsi.extent
- iscsi.initiator
- iscsi.portal
- iscsi.target
- iscsi.targetextent
- keychaincredential
- pool.scrub
- pool.snapshottask
- privilege
- reporting.exporters
- sharing.nfs
- staticroute
- system.ntpserver
- user
- virt.instance
- virt.volume
- Jobs
- Query Methods
Previous topic
Next topic
catalog.apps¶
Retrieve apps details for label catalog.
options.cache is a boolean which when set will try to get apps details for label catalog from cache if available.
options.cache_only is a boolean which when set will force usage of cache only for retrieving catalog information. If the content for the catalog in question is not cached, no content would be returned. If options.cache is unset, this attribute has no effect.
options.retrieve_all_trains is a boolean value which when set will retrieve information for all the trains present in the catalog ( it is set by default ).
options.trains is a list of train name(s) which will allow selective filtering to retrieve only information of desired trains in a catalog. If options.retrieve_all_trains is set, it has precedence over options.train.
No Additional Items
Tuple Validation
Parameter 1: catalog_apps_options
catalog_apps_options
Type: objectNo Additional Properties
Cache
Type: boolean Default: trueCache Only
Type: boolean Default: falseRetrieve All Trains
Type: boolean Default: trueTrains
Type: array of stringNo Additional Items
Each item of this array must be:
Must be at least 1
characters long
Result
Type: objectEach additional property must conform to the following schema
CatalogTrainInfo
Type: objectEach additional property must conform to the following schema
Type: objectRequired roles: CATALOG_READ