Config

balena.models.config : object

Kind: static namespace


getAll

balena.models.config.getAll()Promise

Kind: static method of config Summary: Get all configuration Access: public Fulfil: Object - configuration Example

balena.models.config.getAll().then(function(config) {
	console.log(config);
});

getConfigVarSchema

balena.models.config.getConfigVarSchema(deviceType)Promise

Kind: static method of config Summary: Get configuration variables schema for a device type Access: public Fulfil: Object[] - configuration options

Param
Type
Description

deviceType

String

device type slug

Example

balena.models.config.getConfigVarSchema('raspberry-pi').then(function(options) {
	console.log(options);
});

getDeviceOptions

balena.models.config.getDeviceOptions(deviceType)Promise

Kind: static method of config Summary: Get configuration/initialization options for a device type Access: public Fulfil: Object[] - configuration options

Param
Type
Description

deviceType

String

device type slug

Example


getDeviceTypeManifestBySlug

balena.models.config.getDeviceTypeManifestBySlug(slugOrName)Promise

use balena.models.deviceType.getBySlugOrName

Kind: static method of config Summary: Get a device type manifest by slug Access: public Fulfil: Object - device type manifest

Param
Type
Description

slugOrName

String

device type slug

Example


getDeviceTypes

balena.models.config.getDeviceTypes()Promise

use balena.models.deviceType.getAll

Kind: static method of config Summary: Get device types Access: public Fulfil: Object[] - device types Example


Last updated

Was this helpful?