balena-sdk 16.9.4 → 16.11.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +10 -0
- package/DOCUMENTATION.md +325 -287
- package/es2015/balena-browser.js +221 -193
- package/es2015/balena-browser.min.js +1 -1
- package/es2015/index.d.ts +40 -42
- package/es2015/models/api-key.d.ts +2 -2
- package/es2015/models/api-key.js +3 -3
- package/es2015/models/application-invite.d.ts +5 -5
- package/es2015/models/application-invite.js +6 -6
- package/es2015/models/application-membership.d.ts +3 -3
- package/es2015/models/application-membership.js +3 -3
- package/es2015/models/application.d.ts +60 -55
- package/es2015/models/application.js +107 -106
- package/es2015/models/config.d.ts +24 -0
- package/es2015/models/config.js +40 -5
- package/es2015/models/device.d.ts +20 -19
- package/es2015/models/device.js +35 -43
- package/es2015/models/index.d.ts +39 -38
- package/es2015/models/os.d.ts +1 -1
- package/es2015/models/os.js +4 -4
- package/es2015/models/release.d.ts +5 -5
- package/es2015/models/release.js +12 -12
- package/es2015/models/service.d.ts +4 -4
- package/es2015/models/service.js +6 -6
- package/es2015/util/index.d.ts +1 -1
- package/es2015/util/index.js +2 -2
- package/es2015/util/sdk-version.js +1 -1
- package/es2018/balena-browser.js +220 -192
- package/es2018/balena-browser.min.js +1 -1
- package/es2018/index.d.ts +40 -42
- package/es2018/models/api-key.d.ts +2 -2
- package/es2018/models/api-key.js +3 -3
- package/es2018/models/application-invite.d.ts +5 -5
- package/es2018/models/application-invite.js +6 -6
- package/es2018/models/application-membership.d.ts +3 -3
- package/es2018/models/application-membership.js +3 -3
- package/es2018/models/application.d.ts +60 -55
- package/es2018/models/application.js +107 -106
- package/es2018/models/config.d.ts +24 -0
- package/es2018/models/config.js +39 -4
- package/es2018/models/device.d.ts +20 -19
- package/es2018/models/device.js +35 -43
- package/es2018/models/index.d.ts +39 -38
- package/es2018/models/os.d.ts +1 -1
- package/es2018/models/os.js +4 -4
- package/es2018/models/release.d.ts +5 -5
- package/es2018/models/release.js +12 -12
- package/es2018/models/service.d.ts +4 -4
- package/es2018/models/service.js +6 -6
- package/es2018/util/index.d.ts +1 -1
- package/es2018/util/index.js +2 -2
- package/es2018/util/sdk-version.js +1 -1
- package/package.json +4 -4
package/DOCUMENTATION.md
CHANGED
|
@@ -107,94 +107,94 @@ const sdk = fromSharedOptions();
|
|
|
107
107
|
* [.models](#balena.models) : <code>object</code>
|
|
108
108
|
* [.application](#balena.models.application) : <code>object</code>
|
|
109
109
|
* [.tags](#balena.models.application.tags) : <code>object</code>
|
|
110
|
-
* [.getAllByApplication(
|
|
110
|
+
* [.getAllByApplication(slugOrUuidOrId, [options])](#balena.models.application.tags.getAllByApplication) ⇒ <code>Promise</code>
|
|
111
111
|
* [.getAll([options])](#balena.models.application.tags.getAll) ⇒ <code>Promise</code>
|
|
112
|
-
* [.set(
|
|
113
|
-
* [.remove(
|
|
112
|
+
* [.set(slugOrUuidOrId, tagKey, value)](#balena.models.application.tags.set) ⇒ <code>Promise</code>
|
|
113
|
+
* [.remove(slugOrUuidOrId, tagKey)](#balena.models.application.tags.remove) ⇒ <code>Promise</code>
|
|
114
114
|
* [.configVar](#balena.models.application.configVar) : <code>object</code>
|
|
115
|
-
* [.getAllByApplication(
|
|
116
|
-
* [.get(
|
|
117
|
-
* [.set(
|
|
118
|
-
* [.remove(
|
|
115
|
+
* [.getAllByApplication(slugOrUuidOrId, [options])](#balena.models.application.configVar.getAllByApplication) ⇒ <code>Promise</code>
|
|
116
|
+
* [.get(slugOrUuidOrId, key)](#balena.models.application.configVar.get) ⇒ <code>Promise</code>
|
|
117
|
+
* [.set(slugOrUuidOrId, key, value)](#balena.models.application.configVar.set) ⇒ <code>Promise</code>
|
|
118
|
+
* [.remove(slugOrUuidOrId, key)](#balena.models.application.configVar.remove) ⇒ <code>Promise</code>
|
|
119
119
|
* [.envVar](#balena.models.application.envVar) : <code>object</code>
|
|
120
|
-
* [.getAllByApplication(
|
|
121
|
-
* [.get(
|
|
122
|
-
* [.set(
|
|
123
|
-
* [.remove(
|
|
120
|
+
* [.getAllByApplication(slugOrUuidOrId, [options])](#balena.models.application.envVar.getAllByApplication) ⇒ <code>Promise</code>
|
|
121
|
+
* [.get(slugOrUuidOrId, key)](#balena.models.application.envVar.get) ⇒ <code>Promise</code>
|
|
122
|
+
* [.set(slugOrUuidOrId, key, value)](#balena.models.application.envVar.set) ⇒ <code>Promise</code>
|
|
123
|
+
* [.remove(slugOrUuidOrId, key)](#balena.models.application.envVar.remove) ⇒ <code>Promise</code>
|
|
124
124
|
* [.buildVar](#balena.models.application.buildVar) : <code>object</code>
|
|
125
|
-
* [.getAllByApplication(
|
|
126
|
-
* [.get(
|
|
127
|
-
* [.set(
|
|
128
|
-
* [.remove(
|
|
125
|
+
* [.getAllByApplication(slugOrUuidOrId, [options])](#balena.models.application.buildVar.getAllByApplication) ⇒ <code>Promise</code>
|
|
126
|
+
* [.get(slugOrUuidOrId, key)](#balena.models.application.buildVar.get) ⇒ <code>Promise</code>
|
|
127
|
+
* [.set(slugOrUuidOrId, key, value)](#balena.models.application.buildVar.set) ⇒ <code>Promise</code>
|
|
128
|
+
* [.remove(slugOrUuidOrId, key)](#balena.models.application.buildVar.remove) ⇒ <code>Promise</code>
|
|
129
129
|
* [.membership](#balena.models.application.membership) : <code>object</code>
|
|
130
130
|
* [.get(membershipId, [options])](#balena.models.application.membership.get) ⇒ <code>Promise</code>
|
|
131
131
|
* [.getAll([options])](#balena.models.application.membership.getAll) ⇒ <code>Promise</code>
|
|
132
|
-
* [.getAllByApplication(
|
|
132
|
+
* [.getAllByApplication(slugOrUuidOrId, [options])](#balena.models.application.membership.getAllByApplication) ⇒ <code>Promise</code>
|
|
133
133
|
* [.create(options)](#balena.models.application.membership.create) ⇒ <code>Promise</code>
|
|
134
134
|
* [.changeRole(idOrUniqueKey, roleName)](#balena.models.application.membership.changeRole) ⇒ <code>Promise</code>
|
|
135
135
|
* [.remove(idOrUniqueKey)](#balena.models.application.membership.remove) ⇒ <code>Promise</code>
|
|
136
136
|
* [.invite](#balena.models.application.invite) : <code>object</code>
|
|
137
137
|
* [.getAll([options])](#balena.models.application.invite.getAll) ⇒ <code>Promise</code>
|
|
138
|
-
* [.getAllByApplication(
|
|
139
|
-
* [.create(
|
|
138
|
+
* [.getAllByApplication(slugOrUuidOrId, [options])](#balena.models.application.invite.getAllByApplication) ⇒ <code>Promise</code>
|
|
139
|
+
* [.create(slugOrUuidOrId, options, [message])](#balena.models.application.invite.create) ⇒ <code>Promise</code>
|
|
140
140
|
* [.revoke(id)](#balena.models.application.invite.revoke) ⇒ <code>Promise</code>
|
|
141
141
|
* [.accept(invitationToken)](#balena.models.application.invite.accept) ⇒ <code>Promise</code>
|
|
142
142
|
* [.getDashboardUrl(id)](#balena.models.application.getDashboardUrl) ⇒ <code>String</code>
|
|
143
143
|
* [.getAll([options], [context])](#balena.models.application.getAll) ⇒ <code>Promise</code>
|
|
144
144
|
* [.getAllDirectlyAccessible([options])](#balena.models.application.getAllDirectlyAccessible) ⇒ <code>Promise</code>
|
|
145
|
-
* [.get(
|
|
146
|
-
* [.getDirectlyAccessible(
|
|
147
|
-
* [.getWithDeviceServiceDetails(
|
|
145
|
+
* [.get(slugOrUuidOrId, [options], [context])](#balena.models.application.get) ⇒ <code>Promise</code>
|
|
146
|
+
* [.getDirectlyAccessible(slugOrUuidOrId, [options])](#balena.models.application.getDirectlyAccessible) ⇒ <code>Promise</code>
|
|
147
|
+
* [.getWithDeviceServiceDetails(slugOrUuidOrId, [options])](#balena.models.application.getWithDeviceServiceDetails) ⇒ <code>Promise</code>
|
|
148
148
|
* [.getAppByName(appName, [options], [context])](#balena.models.application.getAppByName) ⇒ <code>Promise</code>
|
|
149
149
|
* [.getAppByOwner(appName, owner, [options])](#balena.models.application.getAppByOwner) ⇒ <code>Promise</code>
|
|
150
|
-
* [.has(
|
|
150
|
+
* [.has(slugOrUuidOrId)](#balena.models.application.has) ⇒ <code>Promise</code>
|
|
151
151
|
* [.hasAny()](#balena.models.application.hasAny) ⇒ <code>Promise</code>
|
|
152
152
|
* [.create(options)](#balena.models.application.create) ⇒ <code>Promise</code>
|
|
153
|
-
* [.remove(
|
|
154
|
-
* [.rename(
|
|
155
|
-
* [.restart(
|
|
156
|
-
* ~~[.generateApiKey(
|
|
157
|
-
* [.generateProvisioningKey(
|
|
153
|
+
* [.remove(slugOrUuidOrId)](#balena.models.application.remove) ⇒ <code>Promise</code>
|
|
154
|
+
* [.rename(slugOrUuidOrId, newName)](#balena.models.application.rename) ⇒ <code>Promise</code>
|
|
155
|
+
* [.restart(slugOrUuidOrId)](#balena.models.application.restart) ⇒ <code>Promise</code>
|
|
156
|
+
* ~~[.generateApiKey(slugOrUuidOrId)](#balena.models.application.generateApiKey) ⇒ <code>Promise</code>~~
|
|
157
|
+
* [.generateProvisioningKey(slugOrUuidOrId, [keyName], [keyDescription])](#balena.models.application.generateProvisioningKey) ⇒ <code>Promise</code>
|
|
158
158
|
* [.purge(appId)](#balena.models.application.purge) ⇒ <code>Promise</code>
|
|
159
159
|
* [.shutdown(appId, [options])](#balena.models.application.shutdown) ⇒ <code>Promise</code>
|
|
160
160
|
* [.reboot(appId, [options])](#balena.models.application.reboot) ⇒ <code>Promise</code>
|
|
161
|
-
* [.willTrackNewReleases(
|
|
162
|
-
* [.isTrackingLatestRelease(
|
|
163
|
-
* [.pinToRelease(
|
|
164
|
-
* [.getTargetReleaseHash(
|
|
165
|
-
* [.trackLatestRelease(
|
|
166
|
-
* [.enableDeviceUrls(
|
|
167
|
-
* [.disableDeviceUrls(
|
|
168
|
-
* [.grantSupportAccess(
|
|
169
|
-
* [.revokeSupportAccess(
|
|
161
|
+
* [.willTrackNewReleases(slugOrUuidOrId)](#balena.models.application.willTrackNewReleases) ⇒ <code>Promise</code>
|
|
162
|
+
* [.isTrackingLatestRelease(slugOrUuidOrId)](#balena.models.application.isTrackingLatestRelease) ⇒ <code>Promise</code>
|
|
163
|
+
* [.pinToRelease(slugOrUuidOrId, fullReleaseHash)](#balena.models.application.pinToRelease) ⇒ <code>Promise</code>
|
|
164
|
+
* [.getTargetReleaseHash(slugOrUuidOrId)](#balena.models.application.getTargetReleaseHash) ⇒ <code>Promise</code>
|
|
165
|
+
* [.trackLatestRelease(slugOrUuidOrId)](#balena.models.application.trackLatestRelease) ⇒ <code>Promise</code>
|
|
166
|
+
* [.enableDeviceUrls(slugOrUuidOrId)](#balena.models.application.enableDeviceUrls) ⇒ <code>Promise</code>
|
|
167
|
+
* [.disableDeviceUrls(slugOrUuidOrId)](#balena.models.application.disableDeviceUrls) ⇒ <code>Promise</code>
|
|
168
|
+
* [.grantSupportAccess(slugOrUuidOrId, expiryTimestamp)](#balena.models.application.grantSupportAccess) ⇒ <code>Promise</code>
|
|
169
|
+
* [.revokeSupportAccess(slugOrUuidOrId)](#balena.models.application.revokeSupportAccess) ⇒ <code>Promise</code>
|
|
170
170
|
* [.device](#balena.models.device) : <code>object</code>
|
|
171
171
|
* [.tags](#balena.models.device.tags) : <code>object</code>
|
|
172
|
-
* [.getAllByApplication(
|
|
172
|
+
* [.getAllByApplication(slugOrUuidOrId, [options])](#balena.models.device.tags.getAllByApplication) ⇒ <code>Promise</code>
|
|
173
173
|
* [.getAllByDevice(uuidOrId, [options])](#balena.models.device.tags.getAllByDevice) ⇒ <code>Promise</code>
|
|
174
174
|
* [.getAll([options])](#balena.models.device.tags.getAll) ⇒ <code>Promise</code>
|
|
175
175
|
* [.set(uuidOrId, tagKey, value)](#balena.models.device.tags.set) ⇒ <code>Promise</code>
|
|
176
176
|
* [.remove(uuidOrId, tagKey)](#balena.models.device.tags.remove) ⇒ <code>Promise</code>
|
|
177
177
|
* [.configVar](#balena.models.device.configVar) : <code>object</code>
|
|
178
178
|
* [.getAllByDevice(uuidOrId, [options])](#balena.models.device.configVar.getAllByDevice) ⇒ <code>Promise</code>
|
|
179
|
-
* [.getAllByApplication(
|
|
179
|
+
* [.getAllByApplication(slugOrUuidOrId, [options])](#balena.models.device.configVar.getAllByApplication) ⇒ <code>Promise</code>
|
|
180
180
|
* [.get(uuidOrId, key)](#balena.models.device.configVar.get) ⇒ <code>Promise</code>
|
|
181
181
|
* [.set(uuidOrId, key, value)](#balena.models.device.configVar.set) ⇒ <code>Promise</code>
|
|
182
182
|
* [.remove(uuidOrId, key)](#balena.models.device.configVar.remove) ⇒ <code>Promise</code>
|
|
183
183
|
* [.envVar](#balena.models.device.envVar) : <code>object</code>
|
|
184
184
|
* [.getAllByDevice(uuidOrId, [options])](#balena.models.device.envVar.getAllByDevice) ⇒ <code>Promise</code>
|
|
185
|
-
* [.getAllByApplication(
|
|
185
|
+
* [.getAllByApplication(slugOrUuidOrId, [options])](#balena.models.device.envVar.getAllByApplication) ⇒ <code>Promise</code>
|
|
186
186
|
* [.get(uuidOrId, key)](#balena.models.device.envVar.get) ⇒ <code>Promise</code>
|
|
187
187
|
* [.set(uuidOrId, key, value)](#balena.models.device.envVar.set) ⇒ <code>Promise</code>
|
|
188
188
|
* [.remove(uuidOrId, key)](#balena.models.device.envVar.remove) ⇒ <code>Promise</code>
|
|
189
189
|
* [.serviceVar](#balena.models.device.serviceVar) : <code>object</code>
|
|
190
190
|
* [.getAllByDevice(uuidOrId, [options])](#balena.models.device.serviceVar.getAllByDevice) ⇒ <code>Promise</code>
|
|
191
|
-
* [.getAllByApplication(
|
|
191
|
+
* [.getAllByApplication(slugOrUuidOrId, [options])](#balena.models.device.serviceVar.getAllByApplication) ⇒ <code>Promise</code>
|
|
192
192
|
* [.get(uuidOrId, id, key)](#balena.models.device.serviceVar.get) ⇒ <code>Promise</code>
|
|
193
193
|
* [.set(uuidOrId, id, key, value)](#balena.models.device.serviceVar.set) ⇒ <code>Promise</code>
|
|
194
194
|
* [.remove(uuidOrId, id, key)](#balena.models.device.serviceVar.remove) ⇒ <code>Promise</code>
|
|
195
195
|
* [.getDashboardUrl(uuid)](#balena.models.device.getDashboardUrl) ⇒ <code>String</code>
|
|
196
196
|
* [.getAll([options])](#balena.models.device.getAll) ⇒ <code>Promise</code>
|
|
197
|
-
* [.getAllByApplication(
|
|
197
|
+
* [.getAllByApplication(slugOrUuidOrId, [options])](#balena.models.device.getAllByApplication) ⇒ <code>Promise</code>
|
|
198
198
|
* [.getAllByParentDevice(parentUuidOrId, [options])](#balena.models.device.getAllByParentDevice) ⇒ <code>Promise</code>
|
|
199
199
|
* [.get(uuidOrId, [options])](#balena.models.device.get) ⇒ <code>Promise</code>
|
|
200
200
|
* [.getWithServiceDetails(uuidOrId, [options])](#balena.models.device.getWithServiceDetails) ⇒ <code>Promise</code>
|
|
@@ -212,13 +212,13 @@ const sdk = fromSharedOptions();
|
|
|
212
212
|
* [.note(uuidOrId, note)](#balena.models.device.note) ⇒ <code>Promise</code>
|
|
213
213
|
* [.setCustomLocation(uuidOrId, location)](#balena.models.device.setCustomLocation) ⇒ <code>Promise</code>
|
|
214
214
|
* [.unsetCustomLocation(uuidOrId)](#balena.models.device.unsetCustomLocation) ⇒ <code>Promise</code>
|
|
215
|
-
* [.move(uuidOrId,
|
|
215
|
+
* [.move(uuidOrId, applicationSlugOrUuidOrId)](#balena.models.device.move) ⇒ <code>Promise</code>
|
|
216
216
|
* [.restartApplication(uuidOrId)](#balena.models.device.restartApplication) ⇒ <code>Promise</code>
|
|
217
217
|
* [.getSupervisorTargetState(uuidOrId)](#balena.models.device.getSupervisorTargetState) ⇒ <code>Promise</code>
|
|
218
218
|
* ~~[.getManifestBySlug(slugOrName)](#balena.models.device.getManifestBySlug) ⇒ <code>Promise</code>~~
|
|
219
|
-
* [.getManifestByApplication(
|
|
219
|
+
* ~~[.getManifestByApplication(slugOrUuidOrId)](#balena.models.device.getManifestByApplication) ⇒ <code>Promise</code>~~
|
|
220
220
|
* [.generateUniqueKey()](#balena.models.device.generateUniqueKey) ⇒ <code>String</code>
|
|
221
|
-
* [.register(
|
|
221
|
+
* [.register(applicationSlugOrUuidOrId, uuid)](#balena.models.device.register) ⇒ <code>Promise</code>
|
|
222
222
|
* [.generateDeviceKey(uuidOrId)](#balena.models.device.generateDeviceKey) ⇒ <code>Promise</code>
|
|
223
223
|
* [.hasDeviceUrl(uuidOrId)](#balena.models.device.hasDeviceUrl) ⇒ <code>Promise</code>
|
|
224
224
|
* [.getDeviceUrl(uuidOrId)](#balena.models.device.getDeviceUrl) ⇒ <code>Promise</code>
|
|
@@ -268,7 +268,7 @@ const sdk = fromSharedOptions();
|
|
|
268
268
|
* [.create(name, [description])](#balena.models.apiKey.create) ⇒ <code>Promise</code>
|
|
269
269
|
* [.getAll([options])](#balena.models.apiKey.getAll) ⇒ <code>Promise</code>
|
|
270
270
|
* [.getAllNamedUserApiKeys([options])](#balena.models.apiKey.getAllNamedUserApiKeys) ⇒ <code>Promise</code>
|
|
271
|
-
* [.getProvisioningApiKeysByApplication(
|
|
271
|
+
* [.getProvisioningApiKeysByApplication(slugOrUuidOrId, [options])](#balena.models.apiKey.getProvisioningApiKeysByApplication) ⇒ <code>Promise</code>
|
|
272
272
|
* [.getDeviceApiKeysByDevice(uuidOrId, [options])](#balena.models.apiKey.getDeviceApiKeysByDevice) ⇒ <code>Promise</code>
|
|
273
273
|
* [.update(id, apiKeyInfo)](#balena.models.apiKey.update) ⇒ <code>Promise</code>
|
|
274
274
|
* [.revoke(id)](#balena.models.apiKey.revoke) ⇒ <code>Promise</code>
|
|
@@ -302,38 +302,39 @@ const sdk = fromSharedOptions();
|
|
|
302
302
|
* [.getMaxSatisfyingVersion(deviceType, versionOrRange, [osType])](#balena.models.os.getMaxSatisfyingVersion) ⇒ <code>Promise</code>
|
|
303
303
|
* [.getLastModified(deviceType, [version])](#balena.models.os.getLastModified) ⇒ <code>Promise</code>
|
|
304
304
|
* [.download(deviceType, [version], options)](#balena.models.os.download) ⇒ <code>Promise</code>
|
|
305
|
-
* [.getConfig(
|
|
305
|
+
* [.getConfig(slugOrUuidOrId, options)](#balena.models.os.getConfig) ⇒ <code>Promise</code>
|
|
306
306
|
* [.isSupportedOsUpdate(deviceType, currentVersion, targetVersion)](#balena.models.os.isSupportedOsUpdate) ⇒ <code>Promise</code>
|
|
307
307
|
* [.getSupportedOsUpdateVersions(deviceType, currentVersion)](#balena.models.os.getSupportedOsUpdateVersions) ⇒ <code>Promise</code>
|
|
308
308
|
* [.isArchitectureCompatibleWith(osArchitecture, applicationArchitecture)](#balena.models.os.isArchitectureCompatibleWith) ⇒ <code>Boolean</code>
|
|
309
309
|
* [.config](#balena.models.config) : <code>object</code>
|
|
310
310
|
* [.getAll()](#balena.models.config.getAll) ⇒ <code>Promise</code>
|
|
311
311
|
* ~~[.getDeviceTypes()](#balena.models.config.getDeviceTypes) ⇒ <code>Promise</code>~~
|
|
312
|
+
* ~~[.getDeviceTypeManifestBySlug(slugOrName)](#balena.models.config.getDeviceTypeManifestBySlug) ⇒ <code>Promise</code>~~
|
|
312
313
|
* [.getDeviceOptions(deviceType)](#balena.models.config.getDeviceOptions) ⇒ <code>Promise</code>
|
|
313
314
|
* [.getConfigVarSchema(deviceType)](#balena.models.config.getConfigVarSchema) ⇒ <code>Promise</code>
|
|
314
315
|
* [.release](#balena.models.release) : <code>object</code>
|
|
315
316
|
* [.tags](#balena.models.release.tags) : <code>object</code>
|
|
316
|
-
* [.getAllByApplication(
|
|
317
|
+
* [.getAllByApplication(slugOrUuidOrId, [options])](#balena.models.release.tags.getAllByApplication) ⇒ <code>Promise</code>
|
|
317
318
|
* [.getAllByRelease(commitOrId, [options])](#balena.models.release.tags.getAllByRelease) ⇒ <code>Promise</code>
|
|
318
319
|
* [.getAll([options])](#balena.models.release.tags.getAll) ⇒ <code>Promise</code>
|
|
319
320
|
* [.set(commitOrId, tagKey, value)](#balena.models.release.tags.set) ⇒ <code>Promise</code>
|
|
320
321
|
* [.remove(commitOrId, tagKey)](#balena.models.release.tags.remove) ⇒ <code>Promise</code>
|
|
321
322
|
* [.get(commitOrId, [options])](#balena.models.release.get) ⇒ <code>Promise</code>
|
|
322
323
|
* [.getWithImageDetails(commitOrId, [options])](#balena.models.release.getWithImageDetails) ⇒ <code>Promise</code>
|
|
323
|
-
* [.getAllByApplication(
|
|
324
|
-
* [.getLatestByApplication(
|
|
325
|
-
* [.createFromUrl(
|
|
324
|
+
* [.getAllByApplication(slugOrUuidOrId, [options])](#balena.models.release.getAllByApplication) ⇒ <code>Promise</code>
|
|
325
|
+
* [.getLatestByApplication(slugOrUuidOrId, [options])](#balena.models.release.getLatestByApplication) ⇒ <code>Promise</code>
|
|
326
|
+
* [.createFromUrl(slugOrUuidOrId, urlDeployOptions)](#balena.models.release.createFromUrl) ⇒ <code>Promise</code>
|
|
326
327
|
* [.finalize(commitOrId)](#balena.models.release.finalize) ⇒ <code>Promise</code>
|
|
327
328
|
* [.setIsInvalidated(commitOrId, isInvalidated)](#balena.models.release.setIsInvalidated) ⇒ <code>Promise</code>
|
|
328
329
|
* [.note(commitOrId, note)](#balena.models.release.note) ⇒ <code>Promise</code>
|
|
329
330
|
* [.service](#balena.models.service) : <code>object</code>
|
|
330
331
|
* [.var](#balena.models.service.var) : <code>object</code>
|
|
331
332
|
* [.getAllByService(id, [options])](#balena.models.service.var.getAllByService) ⇒ <code>Promise</code>
|
|
332
|
-
* [.getAllByApplication(
|
|
333
|
+
* [.getAllByApplication(slugOrUuidOrId, [options])](#balena.models.service.var.getAllByApplication) ⇒ <code>Promise</code>
|
|
333
334
|
* [.get(id, key)](#balena.models.service.var.get) ⇒ <code>Promise</code>
|
|
334
335
|
* [.set(id, key, value)](#balena.models.service.var.set) ⇒ <code>Promise</code>
|
|
335
336
|
* [.remove(id, key)](#balena.models.service.var.remove) ⇒ <code>Promise</code>
|
|
336
|
-
* [.getAllByApplication(
|
|
337
|
+
* [.getAllByApplication(slugOrUuidOrId, [options])](#balena.models.service.getAllByApplication) ⇒ <code>Promise</code>
|
|
337
338
|
* [.image](#balena.models.image) : <code>object</code>
|
|
338
339
|
* [.get(id, [options])](#balena.models.image.get) ⇒ <code>Promise</code>
|
|
339
340
|
* [.getLogs(id)](#balena.models.image.getLogs) ⇒ <code>Promise</code>
|
|
@@ -482,94 +483,94 @@ balena.models.device.get(123).catch(function (error) {
|
|
|
482
483
|
* [.models](#balena.models) : <code>object</code>
|
|
483
484
|
* [.application](#balena.models.application) : <code>object</code>
|
|
484
485
|
* [.tags](#balena.models.application.tags) : <code>object</code>
|
|
485
|
-
* [.getAllByApplication(
|
|
486
|
+
* [.getAllByApplication(slugOrUuidOrId, [options])](#balena.models.application.tags.getAllByApplication) ⇒ <code>Promise</code>
|
|
486
487
|
* [.getAll([options])](#balena.models.application.tags.getAll) ⇒ <code>Promise</code>
|
|
487
|
-
* [.set(
|
|
488
|
-
* [.remove(
|
|
488
|
+
* [.set(slugOrUuidOrId, tagKey, value)](#balena.models.application.tags.set) ⇒ <code>Promise</code>
|
|
489
|
+
* [.remove(slugOrUuidOrId, tagKey)](#balena.models.application.tags.remove) ⇒ <code>Promise</code>
|
|
489
490
|
* [.configVar](#balena.models.application.configVar) : <code>object</code>
|
|
490
|
-
* [.getAllByApplication(
|
|
491
|
-
* [.get(
|
|
492
|
-
* [.set(
|
|
493
|
-
* [.remove(
|
|
491
|
+
* [.getAllByApplication(slugOrUuidOrId, [options])](#balena.models.application.configVar.getAllByApplication) ⇒ <code>Promise</code>
|
|
492
|
+
* [.get(slugOrUuidOrId, key)](#balena.models.application.configVar.get) ⇒ <code>Promise</code>
|
|
493
|
+
* [.set(slugOrUuidOrId, key, value)](#balena.models.application.configVar.set) ⇒ <code>Promise</code>
|
|
494
|
+
* [.remove(slugOrUuidOrId, key)](#balena.models.application.configVar.remove) ⇒ <code>Promise</code>
|
|
494
495
|
* [.envVar](#balena.models.application.envVar) : <code>object</code>
|
|
495
|
-
* [.getAllByApplication(
|
|
496
|
-
* [.get(
|
|
497
|
-
* [.set(
|
|
498
|
-
* [.remove(
|
|
496
|
+
* [.getAllByApplication(slugOrUuidOrId, [options])](#balena.models.application.envVar.getAllByApplication) ⇒ <code>Promise</code>
|
|
497
|
+
* [.get(slugOrUuidOrId, key)](#balena.models.application.envVar.get) ⇒ <code>Promise</code>
|
|
498
|
+
* [.set(slugOrUuidOrId, key, value)](#balena.models.application.envVar.set) ⇒ <code>Promise</code>
|
|
499
|
+
* [.remove(slugOrUuidOrId, key)](#balena.models.application.envVar.remove) ⇒ <code>Promise</code>
|
|
499
500
|
* [.buildVar](#balena.models.application.buildVar) : <code>object</code>
|
|
500
|
-
* [.getAllByApplication(
|
|
501
|
-
* [.get(
|
|
502
|
-
* [.set(
|
|
503
|
-
* [.remove(
|
|
501
|
+
* [.getAllByApplication(slugOrUuidOrId, [options])](#balena.models.application.buildVar.getAllByApplication) ⇒ <code>Promise</code>
|
|
502
|
+
* [.get(slugOrUuidOrId, key)](#balena.models.application.buildVar.get) ⇒ <code>Promise</code>
|
|
503
|
+
* [.set(slugOrUuidOrId, key, value)](#balena.models.application.buildVar.set) ⇒ <code>Promise</code>
|
|
504
|
+
* [.remove(slugOrUuidOrId, key)](#balena.models.application.buildVar.remove) ⇒ <code>Promise</code>
|
|
504
505
|
* [.membership](#balena.models.application.membership) : <code>object</code>
|
|
505
506
|
* [.get(membershipId, [options])](#balena.models.application.membership.get) ⇒ <code>Promise</code>
|
|
506
507
|
* [.getAll([options])](#balena.models.application.membership.getAll) ⇒ <code>Promise</code>
|
|
507
|
-
* [.getAllByApplication(
|
|
508
|
+
* [.getAllByApplication(slugOrUuidOrId, [options])](#balena.models.application.membership.getAllByApplication) ⇒ <code>Promise</code>
|
|
508
509
|
* [.create(options)](#balena.models.application.membership.create) ⇒ <code>Promise</code>
|
|
509
510
|
* [.changeRole(idOrUniqueKey, roleName)](#balena.models.application.membership.changeRole) ⇒ <code>Promise</code>
|
|
510
511
|
* [.remove(idOrUniqueKey)](#balena.models.application.membership.remove) ⇒ <code>Promise</code>
|
|
511
512
|
* [.invite](#balena.models.application.invite) : <code>object</code>
|
|
512
513
|
* [.getAll([options])](#balena.models.application.invite.getAll) ⇒ <code>Promise</code>
|
|
513
|
-
* [.getAllByApplication(
|
|
514
|
-
* [.create(
|
|
514
|
+
* [.getAllByApplication(slugOrUuidOrId, [options])](#balena.models.application.invite.getAllByApplication) ⇒ <code>Promise</code>
|
|
515
|
+
* [.create(slugOrUuidOrId, options, [message])](#balena.models.application.invite.create) ⇒ <code>Promise</code>
|
|
515
516
|
* [.revoke(id)](#balena.models.application.invite.revoke) ⇒ <code>Promise</code>
|
|
516
517
|
* [.accept(invitationToken)](#balena.models.application.invite.accept) ⇒ <code>Promise</code>
|
|
517
518
|
* [.getDashboardUrl(id)](#balena.models.application.getDashboardUrl) ⇒ <code>String</code>
|
|
518
519
|
* [.getAll([options], [context])](#balena.models.application.getAll) ⇒ <code>Promise</code>
|
|
519
520
|
* [.getAllDirectlyAccessible([options])](#balena.models.application.getAllDirectlyAccessible) ⇒ <code>Promise</code>
|
|
520
|
-
* [.get(
|
|
521
|
-
* [.getDirectlyAccessible(
|
|
522
|
-
* [.getWithDeviceServiceDetails(
|
|
521
|
+
* [.get(slugOrUuidOrId, [options], [context])](#balena.models.application.get) ⇒ <code>Promise</code>
|
|
522
|
+
* [.getDirectlyAccessible(slugOrUuidOrId, [options])](#balena.models.application.getDirectlyAccessible) ⇒ <code>Promise</code>
|
|
523
|
+
* [.getWithDeviceServiceDetails(slugOrUuidOrId, [options])](#balena.models.application.getWithDeviceServiceDetails) ⇒ <code>Promise</code>
|
|
523
524
|
* [.getAppByName(appName, [options], [context])](#balena.models.application.getAppByName) ⇒ <code>Promise</code>
|
|
524
525
|
* [.getAppByOwner(appName, owner, [options])](#balena.models.application.getAppByOwner) ⇒ <code>Promise</code>
|
|
525
|
-
* [.has(
|
|
526
|
+
* [.has(slugOrUuidOrId)](#balena.models.application.has) ⇒ <code>Promise</code>
|
|
526
527
|
* [.hasAny()](#balena.models.application.hasAny) ⇒ <code>Promise</code>
|
|
527
528
|
* [.create(options)](#balena.models.application.create) ⇒ <code>Promise</code>
|
|
528
|
-
* [.remove(
|
|
529
|
-
* [.rename(
|
|
530
|
-
* [.restart(
|
|
531
|
-
* ~~[.generateApiKey(
|
|
532
|
-
* [.generateProvisioningKey(
|
|
529
|
+
* [.remove(slugOrUuidOrId)](#balena.models.application.remove) ⇒ <code>Promise</code>
|
|
530
|
+
* [.rename(slugOrUuidOrId, newName)](#balena.models.application.rename) ⇒ <code>Promise</code>
|
|
531
|
+
* [.restart(slugOrUuidOrId)](#balena.models.application.restart) ⇒ <code>Promise</code>
|
|
532
|
+
* ~~[.generateApiKey(slugOrUuidOrId)](#balena.models.application.generateApiKey) ⇒ <code>Promise</code>~~
|
|
533
|
+
* [.generateProvisioningKey(slugOrUuidOrId, [keyName], [keyDescription])](#balena.models.application.generateProvisioningKey) ⇒ <code>Promise</code>
|
|
533
534
|
* [.purge(appId)](#balena.models.application.purge) ⇒ <code>Promise</code>
|
|
534
535
|
* [.shutdown(appId, [options])](#balena.models.application.shutdown) ⇒ <code>Promise</code>
|
|
535
536
|
* [.reboot(appId, [options])](#balena.models.application.reboot) ⇒ <code>Promise</code>
|
|
536
|
-
* [.willTrackNewReleases(
|
|
537
|
-
* [.isTrackingLatestRelease(
|
|
538
|
-
* [.pinToRelease(
|
|
539
|
-
* [.getTargetReleaseHash(
|
|
540
|
-
* [.trackLatestRelease(
|
|
541
|
-
* [.enableDeviceUrls(
|
|
542
|
-
* [.disableDeviceUrls(
|
|
543
|
-
* [.grantSupportAccess(
|
|
544
|
-
* [.revokeSupportAccess(
|
|
537
|
+
* [.willTrackNewReleases(slugOrUuidOrId)](#balena.models.application.willTrackNewReleases) ⇒ <code>Promise</code>
|
|
538
|
+
* [.isTrackingLatestRelease(slugOrUuidOrId)](#balena.models.application.isTrackingLatestRelease) ⇒ <code>Promise</code>
|
|
539
|
+
* [.pinToRelease(slugOrUuidOrId, fullReleaseHash)](#balena.models.application.pinToRelease) ⇒ <code>Promise</code>
|
|
540
|
+
* [.getTargetReleaseHash(slugOrUuidOrId)](#balena.models.application.getTargetReleaseHash) ⇒ <code>Promise</code>
|
|
541
|
+
* [.trackLatestRelease(slugOrUuidOrId)](#balena.models.application.trackLatestRelease) ⇒ <code>Promise</code>
|
|
542
|
+
* [.enableDeviceUrls(slugOrUuidOrId)](#balena.models.application.enableDeviceUrls) ⇒ <code>Promise</code>
|
|
543
|
+
* [.disableDeviceUrls(slugOrUuidOrId)](#balena.models.application.disableDeviceUrls) ⇒ <code>Promise</code>
|
|
544
|
+
* [.grantSupportAccess(slugOrUuidOrId, expiryTimestamp)](#balena.models.application.grantSupportAccess) ⇒ <code>Promise</code>
|
|
545
|
+
* [.revokeSupportAccess(slugOrUuidOrId)](#balena.models.application.revokeSupportAccess) ⇒ <code>Promise</code>
|
|
545
546
|
* [.device](#balena.models.device) : <code>object</code>
|
|
546
547
|
* [.tags](#balena.models.device.tags) : <code>object</code>
|
|
547
|
-
* [.getAllByApplication(
|
|
548
|
+
* [.getAllByApplication(slugOrUuidOrId, [options])](#balena.models.device.tags.getAllByApplication) ⇒ <code>Promise</code>
|
|
548
549
|
* [.getAllByDevice(uuidOrId, [options])](#balena.models.device.tags.getAllByDevice) ⇒ <code>Promise</code>
|
|
549
550
|
* [.getAll([options])](#balena.models.device.tags.getAll) ⇒ <code>Promise</code>
|
|
550
551
|
* [.set(uuidOrId, tagKey, value)](#balena.models.device.tags.set) ⇒ <code>Promise</code>
|
|
551
552
|
* [.remove(uuidOrId, tagKey)](#balena.models.device.tags.remove) ⇒ <code>Promise</code>
|
|
552
553
|
* [.configVar](#balena.models.device.configVar) : <code>object</code>
|
|
553
554
|
* [.getAllByDevice(uuidOrId, [options])](#balena.models.device.configVar.getAllByDevice) ⇒ <code>Promise</code>
|
|
554
|
-
* [.getAllByApplication(
|
|
555
|
+
* [.getAllByApplication(slugOrUuidOrId, [options])](#balena.models.device.configVar.getAllByApplication) ⇒ <code>Promise</code>
|
|
555
556
|
* [.get(uuidOrId, key)](#balena.models.device.configVar.get) ⇒ <code>Promise</code>
|
|
556
557
|
* [.set(uuidOrId, key, value)](#balena.models.device.configVar.set) ⇒ <code>Promise</code>
|
|
557
558
|
* [.remove(uuidOrId, key)](#balena.models.device.configVar.remove) ⇒ <code>Promise</code>
|
|
558
559
|
* [.envVar](#balena.models.device.envVar) : <code>object</code>
|
|
559
560
|
* [.getAllByDevice(uuidOrId, [options])](#balena.models.device.envVar.getAllByDevice) ⇒ <code>Promise</code>
|
|
560
|
-
* [.getAllByApplication(
|
|
561
|
+
* [.getAllByApplication(slugOrUuidOrId, [options])](#balena.models.device.envVar.getAllByApplication) ⇒ <code>Promise</code>
|
|
561
562
|
* [.get(uuidOrId, key)](#balena.models.device.envVar.get) ⇒ <code>Promise</code>
|
|
562
563
|
* [.set(uuidOrId, key, value)](#balena.models.device.envVar.set) ⇒ <code>Promise</code>
|
|
563
564
|
* [.remove(uuidOrId, key)](#balena.models.device.envVar.remove) ⇒ <code>Promise</code>
|
|
564
565
|
* [.serviceVar](#balena.models.device.serviceVar) : <code>object</code>
|
|
565
566
|
* [.getAllByDevice(uuidOrId, [options])](#balena.models.device.serviceVar.getAllByDevice) ⇒ <code>Promise</code>
|
|
566
|
-
* [.getAllByApplication(
|
|
567
|
+
* [.getAllByApplication(slugOrUuidOrId, [options])](#balena.models.device.serviceVar.getAllByApplication) ⇒ <code>Promise</code>
|
|
567
568
|
* [.get(uuidOrId, id, key)](#balena.models.device.serviceVar.get) ⇒ <code>Promise</code>
|
|
568
569
|
* [.set(uuidOrId, id, key, value)](#balena.models.device.serviceVar.set) ⇒ <code>Promise</code>
|
|
569
570
|
* [.remove(uuidOrId, id, key)](#balena.models.device.serviceVar.remove) ⇒ <code>Promise</code>
|
|
570
571
|
* [.getDashboardUrl(uuid)](#balena.models.device.getDashboardUrl) ⇒ <code>String</code>
|
|
571
572
|
* [.getAll([options])](#balena.models.device.getAll) ⇒ <code>Promise</code>
|
|
572
|
-
* [.getAllByApplication(
|
|
573
|
+
* [.getAllByApplication(slugOrUuidOrId, [options])](#balena.models.device.getAllByApplication) ⇒ <code>Promise</code>
|
|
573
574
|
* [.getAllByParentDevice(parentUuidOrId, [options])](#balena.models.device.getAllByParentDevice) ⇒ <code>Promise</code>
|
|
574
575
|
* [.get(uuidOrId, [options])](#balena.models.device.get) ⇒ <code>Promise</code>
|
|
575
576
|
* [.getWithServiceDetails(uuidOrId, [options])](#balena.models.device.getWithServiceDetails) ⇒ <code>Promise</code>
|
|
@@ -587,13 +588,13 @@ balena.models.device.get(123).catch(function (error) {
|
|
|
587
588
|
* [.note(uuidOrId, note)](#balena.models.device.note) ⇒ <code>Promise</code>
|
|
588
589
|
* [.setCustomLocation(uuidOrId, location)](#balena.models.device.setCustomLocation) ⇒ <code>Promise</code>
|
|
589
590
|
* [.unsetCustomLocation(uuidOrId)](#balena.models.device.unsetCustomLocation) ⇒ <code>Promise</code>
|
|
590
|
-
* [.move(uuidOrId,
|
|
591
|
+
* [.move(uuidOrId, applicationSlugOrUuidOrId)](#balena.models.device.move) ⇒ <code>Promise</code>
|
|
591
592
|
* [.restartApplication(uuidOrId)](#balena.models.device.restartApplication) ⇒ <code>Promise</code>
|
|
592
593
|
* [.getSupervisorTargetState(uuidOrId)](#balena.models.device.getSupervisorTargetState) ⇒ <code>Promise</code>
|
|
593
594
|
* ~~[.getManifestBySlug(slugOrName)](#balena.models.device.getManifestBySlug) ⇒ <code>Promise</code>~~
|
|
594
|
-
* [.getManifestByApplication(
|
|
595
|
+
* ~~[.getManifestByApplication(slugOrUuidOrId)](#balena.models.device.getManifestByApplication) ⇒ <code>Promise</code>~~
|
|
595
596
|
* [.generateUniqueKey()](#balena.models.device.generateUniqueKey) ⇒ <code>String</code>
|
|
596
|
-
* [.register(
|
|
597
|
+
* [.register(applicationSlugOrUuidOrId, uuid)](#balena.models.device.register) ⇒ <code>Promise</code>
|
|
597
598
|
* [.generateDeviceKey(uuidOrId)](#balena.models.device.generateDeviceKey) ⇒ <code>Promise</code>
|
|
598
599
|
* [.hasDeviceUrl(uuidOrId)](#balena.models.device.hasDeviceUrl) ⇒ <code>Promise</code>
|
|
599
600
|
* [.getDeviceUrl(uuidOrId)](#balena.models.device.getDeviceUrl) ⇒ <code>Promise</code>
|
|
@@ -643,7 +644,7 @@ balena.models.device.get(123).catch(function (error) {
|
|
|
643
644
|
* [.create(name, [description])](#balena.models.apiKey.create) ⇒ <code>Promise</code>
|
|
644
645
|
* [.getAll([options])](#balena.models.apiKey.getAll) ⇒ <code>Promise</code>
|
|
645
646
|
* [.getAllNamedUserApiKeys([options])](#balena.models.apiKey.getAllNamedUserApiKeys) ⇒ <code>Promise</code>
|
|
646
|
-
* [.getProvisioningApiKeysByApplication(
|
|
647
|
+
* [.getProvisioningApiKeysByApplication(slugOrUuidOrId, [options])](#balena.models.apiKey.getProvisioningApiKeysByApplication) ⇒ <code>Promise</code>
|
|
647
648
|
* [.getDeviceApiKeysByDevice(uuidOrId, [options])](#balena.models.apiKey.getDeviceApiKeysByDevice) ⇒ <code>Promise</code>
|
|
648
649
|
* [.update(id, apiKeyInfo)](#balena.models.apiKey.update) ⇒ <code>Promise</code>
|
|
649
650
|
* [.revoke(id)](#balena.models.apiKey.revoke) ⇒ <code>Promise</code>
|
|
@@ -677,38 +678,39 @@ balena.models.device.get(123).catch(function (error) {
|
|
|
677
678
|
* [.getMaxSatisfyingVersion(deviceType, versionOrRange, [osType])](#balena.models.os.getMaxSatisfyingVersion) ⇒ <code>Promise</code>
|
|
678
679
|
* [.getLastModified(deviceType, [version])](#balena.models.os.getLastModified) ⇒ <code>Promise</code>
|
|
679
680
|
* [.download(deviceType, [version], options)](#balena.models.os.download) ⇒ <code>Promise</code>
|
|
680
|
-
* [.getConfig(
|
|
681
|
+
* [.getConfig(slugOrUuidOrId, options)](#balena.models.os.getConfig) ⇒ <code>Promise</code>
|
|
681
682
|
* [.isSupportedOsUpdate(deviceType, currentVersion, targetVersion)](#balena.models.os.isSupportedOsUpdate) ⇒ <code>Promise</code>
|
|
682
683
|
* [.getSupportedOsUpdateVersions(deviceType, currentVersion)](#balena.models.os.getSupportedOsUpdateVersions) ⇒ <code>Promise</code>
|
|
683
684
|
* [.isArchitectureCompatibleWith(osArchitecture, applicationArchitecture)](#balena.models.os.isArchitectureCompatibleWith) ⇒ <code>Boolean</code>
|
|
684
685
|
* [.config](#balena.models.config) : <code>object</code>
|
|
685
686
|
* [.getAll()](#balena.models.config.getAll) ⇒ <code>Promise</code>
|
|
686
687
|
* ~~[.getDeviceTypes()](#balena.models.config.getDeviceTypes) ⇒ <code>Promise</code>~~
|
|
688
|
+
* ~~[.getDeviceTypeManifestBySlug(slugOrName)](#balena.models.config.getDeviceTypeManifestBySlug) ⇒ <code>Promise</code>~~
|
|
687
689
|
* [.getDeviceOptions(deviceType)](#balena.models.config.getDeviceOptions) ⇒ <code>Promise</code>
|
|
688
690
|
* [.getConfigVarSchema(deviceType)](#balena.models.config.getConfigVarSchema) ⇒ <code>Promise</code>
|
|
689
691
|
* [.release](#balena.models.release) : <code>object</code>
|
|
690
692
|
* [.tags](#balena.models.release.tags) : <code>object</code>
|
|
691
|
-
* [.getAllByApplication(
|
|
693
|
+
* [.getAllByApplication(slugOrUuidOrId, [options])](#balena.models.release.tags.getAllByApplication) ⇒ <code>Promise</code>
|
|
692
694
|
* [.getAllByRelease(commitOrId, [options])](#balena.models.release.tags.getAllByRelease) ⇒ <code>Promise</code>
|
|
693
695
|
* [.getAll([options])](#balena.models.release.tags.getAll) ⇒ <code>Promise</code>
|
|
694
696
|
* [.set(commitOrId, tagKey, value)](#balena.models.release.tags.set) ⇒ <code>Promise</code>
|
|
695
697
|
* [.remove(commitOrId, tagKey)](#balena.models.release.tags.remove) ⇒ <code>Promise</code>
|
|
696
698
|
* [.get(commitOrId, [options])](#balena.models.release.get) ⇒ <code>Promise</code>
|
|
697
699
|
* [.getWithImageDetails(commitOrId, [options])](#balena.models.release.getWithImageDetails) ⇒ <code>Promise</code>
|
|
698
|
-
* [.getAllByApplication(
|
|
699
|
-
* [.getLatestByApplication(
|
|
700
|
-
* [.createFromUrl(
|
|
700
|
+
* [.getAllByApplication(slugOrUuidOrId, [options])](#balena.models.release.getAllByApplication) ⇒ <code>Promise</code>
|
|
701
|
+
* [.getLatestByApplication(slugOrUuidOrId, [options])](#balena.models.release.getLatestByApplication) ⇒ <code>Promise</code>
|
|
702
|
+
* [.createFromUrl(slugOrUuidOrId, urlDeployOptions)](#balena.models.release.createFromUrl) ⇒ <code>Promise</code>
|
|
701
703
|
* [.finalize(commitOrId)](#balena.models.release.finalize) ⇒ <code>Promise</code>
|
|
702
704
|
* [.setIsInvalidated(commitOrId, isInvalidated)](#balena.models.release.setIsInvalidated) ⇒ <code>Promise</code>
|
|
703
705
|
* [.note(commitOrId, note)](#balena.models.release.note) ⇒ <code>Promise</code>
|
|
704
706
|
* [.service](#balena.models.service) : <code>object</code>
|
|
705
707
|
* [.var](#balena.models.service.var) : <code>object</code>
|
|
706
708
|
* [.getAllByService(id, [options])](#balena.models.service.var.getAllByService) ⇒ <code>Promise</code>
|
|
707
|
-
* [.getAllByApplication(
|
|
709
|
+
* [.getAllByApplication(slugOrUuidOrId, [options])](#balena.models.service.var.getAllByApplication) ⇒ <code>Promise</code>
|
|
708
710
|
* [.get(id, key)](#balena.models.service.var.get) ⇒ <code>Promise</code>
|
|
709
711
|
* [.set(id, key, value)](#balena.models.service.var.set) ⇒ <code>Promise</code>
|
|
710
712
|
* [.remove(id, key)](#balena.models.service.var.remove) ⇒ <code>Promise</code>
|
|
711
|
-
* [.getAllByApplication(
|
|
713
|
+
* [.getAllByApplication(slugOrUuidOrId, [options])](#balena.models.service.getAllByApplication) ⇒ <code>Promise</code>
|
|
712
714
|
* [.image](#balena.models.image) : <code>object</code>
|
|
713
715
|
* [.get(id, [options])](#balena.models.image.get) ⇒ <code>Promise</code>
|
|
714
716
|
* [.getLogs(id)](#balena.models.image.getLogs) ⇒ <code>Promise</code>
|
|
@@ -728,66 +730,66 @@ balena.models.device.get(123).catch(function (error) {
|
|
|
728
730
|
|
|
729
731
|
* [.application](#balena.models.application) : <code>object</code>
|
|
730
732
|
* [.tags](#balena.models.application.tags) : <code>object</code>
|
|
731
|
-
* [.getAllByApplication(
|
|
733
|
+
* [.getAllByApplication(slugOrUuidOrId, [options])](#balena.models.application.tags.getAllByApplication) ⇒ <code>Promise</code>
|
|
732
734
|
* [.getAll([options])](#balena.models.application.tags.getAll) ⇒ <code>Promise</code>
|
|
733
|
-
* [.set(
|
|
734
|
-
* [.remove(
|
|
735
|
+
* [.set(slugOrUuidOrId, tagKey, value)](#balena.models.application.tags.set) ⇒ <code>Promise</code>
|
|
736
|
+
* [.remove(slugOrUuidOrId, tagKey)](#balena.models.application.tags.remove) ⇒ <code>Promise</code>
|
|
735
737
|
* [.configVar](#balena.models.application.configVar) : <code>object</code>
|
|
736
|
-
* [.getAllByApplication(
|
|
737
|
-
* [.get(
|
|
738
|
-
* [.set(
|
|
739
|
-
* [.remove(
|
|
738
|
+
* [.getAllByApplication(slugOrUuidOrId, [options])](#balena.models.application.configVar.getAllByApplication) ⇒ <code>Promise</code>
|
|
739
|
+
* [.get(slugOrUuidOrId, key)](#balena.models.application.configVar.get) ⇒ <code>Promise</code>
|
|
740
|
+
* [.set(slugOrUuidOrId, key, value)](#balena.models.application.configVar.set) ⇒ <code>Promise</code>
|
|
741
|
+
* [.remove(slugOrUuidOrId, key)](#balena.models.application.configVar.remove) ⇒ <code>Promise</code>
|
|
740
742
|
* [.envVar](#balena.models.application.envVar) : <code>object</code>
|
|
741
|
-
* [.getAllByApplication(
|
|
742
|
-
* [.get(
|
|
743
|
-
* [.set(
|
|
744
|
-
* [.remove(
|
|
743
|
+
* [.getAllByApplication(slugOrUuidOrId, [options])](#balena.models.application.envVar.getAllByApplication) ⇒ <code>Promise</code>
|
|
744
|
+
* [.get(slugOrUuidOrId, key)](#balena.models.application.envVar.get) ⇒ <code>Promise</code>
|
|
745
|
+
* [.set(slugOrUuidOrId, key, value)](#balena.models.application.envVar.set) ⇒ <code>Promise</code>
|
|
746
|
+
* [.remove(slugOrUuidOrId, key)](#balena.models.application.envVar.remove) ⇒ <code>Promise</code>
|
|
745
747
|
* [.buildVar](#balena.models.application.buildVar) : <code>object</code>
|
|
746
|
-
* [.getAllByApplication(
|
|
747
|
-
* [.get(
|
|
748
|
-
* [.set(
|
|
749
|
-
* [.remove(
|
|
748
|
+
* [.getAllByApplication(slugOrUuidOrId, [options])](#balena.models.application.buildVar.getAllByApplication) ⇒ <code>Promise</code>
|
|
749
|
+
* [.get(slugOrUuidOrId, key)](#balena.models.application.buildVar.get) ⇒ <code>Promise</code>
|
|
750
|
+
* [.set(slugOrUuidOrId, key, value)](#balena.models.application.buildVar.set) ⇒ <code>Promise</code>
|
|
751
|
+
* [.remove(slugOrUuidOrId, key)](#balena.models.application.buildVar.remove) ⇒ <code>Promise</code>
|
|
750
752
|
* [.membership](#balena.models.application.membership) : <code>object</code>
|
|
751
753
|
* [.get(membershipId, [options])](#balena.models.application.membership.get) ⇒ <code>Promise</code>
|
|
752
754
|
* [.getAll([options])](#balena.models.application.membership.getAll) ⇒ <code>Promise</code>
|
|
753
|
-
* [.getAllByApplication(
|
|
755
|
+
* [.getAllByApplication(slugOrUuidOrId, [options])](#balena.models.application.membership.getAllByApplication) ⇒ <code>Promise</code>
|
|
754
756
|
* [.create(options)](#balena.models.application.membership.create) ⇒ <code>Promise</code>
|
|
755
757
|
* [.changeRole(idOrUniqueKey, roleName)](#balena.models.application.membership.changeRole) ⇒ <code>Promise</code>
|
|
756
758
|
* [.remove(idOrUniqueKey)](#balena.models.application.membership.remove) ⇒ <code>Promise</code>
|
|
757
759
|
* [.invite](#balena.models.application.invite) : <code>object</code>
|
|
758
760
|
* [.getAll([options])](#balena.models.application.invite.getAll) ⇒ <code>Promise</code>
|
|
759
|
-
* [.getAllByApplication(
|
|
760
|
-
* [.create(
|
|
761
|
+
* [.getAllByApplication(slugOrUuidOrId, [options])](#balena.models.application.invite.getAllByApplication) ⇒ <code>Promise</code>
|
|
762
|
+
* [.create(slugOrUuidOrId, options, [message])](#balena.models.application.invite.create) ⇒ <code>Promise</code>
|
|
761
763
|
* [.revoke(id)](#balena.models.application.invite.revoke) ⇒ <code>Promise</code>
|
|
762
764
|
* [.accept(invitationToken)](#balena.models.application.invite.accept) ⇒ <code>Promise</code>
|
|
763
765
|
* [.getDashboardUrl(id)](#balena.models.application.getDashboardUrl) ⇒ <code>String</code>
|
|
764
766
|
* [.getAll([options], [context])](#balena.models.application.getAll) ⇒ <code>Promise</code>
|
|
765
767
|
* [.getAllDirectlyAccessible([options])](#balena.models.application.getAllDirectlyAccessible) ⇒ <code>Promise</code>
|
|
766
|
-
* [.get(
|
|
767
|
-
* [.getDirectlyAccessible(
|
|
768
|
-
* [.getWithDeviceServiceDetails(
|
|
768
|
+
* [.get(slugOrUuidOrId, [options], [context])](#balena.models.application.get) ⇒ <code>Promise</code>
|
|
769
|
+
* [.getDirectlyAccessible(slugOrUuidOrId, [options])](#balena.models.application.getDirectlyAccessible) ⇒ <code>Promise</code>
|
|
770
|
+
* [.getWithDeviceServiceDetails(slugOrUuidOrId, [options])](#balena.models.application.getWithDeviceServiceDetails) ⇒ <code>Promise</code>
|
|
769
771
|
* [.getAppByName(appName, [options], [context])](#balena.models.application.getAppByName) ⇒ <code>Promise</code>
|
|
770
772
|
* [.getAppByOwner(appName, owner, [options])](#balena.models.application.getAppByOwner) ⇒ <code>Promise</code>
|
|
771
|
-
* [.has(
|
|
773
|
+
* [.has(slugOrUuidOrId)](#balena.models.application.has) ⇒ <code>Promise</code>
|
|
772
774
|
* [.hasAny()](#balena.models.application.hasAny) ⇒ <code>Promise</code>
|
|
773
775
|
* [.create(options)](#balena.models.application.create) ⇒ <code>Promise</code>
|
|
774
|
-
* [.remove(
|
|
775
|
-
* [.rename(
|
|
776
|
-
* [.restart(
|
|
777
|
-
* ~~[.generateApiKey(
|
|
778
|
-
* [.generateProvisioningKey(
|
|
776
|
+
* [.remove(slugOrUuidOrId)](#balena.models.application.remove) ⇒ <code>Promise</code>
|
|
777
|
+
* [.rename(slugOrUuidOrId, newName)](#balena.models.application.rename) ⇒ <code>Promise</code>
|
|
778
|
+
* [.restart(slugOrUuidOrId)](#balena.models.application.restart) ⇒ <code>Promise</code>
|
|
779
|
+
* ~~[.generateApiKey(slugOrUuidOrId)](#balena.models.application.generateApiKey) ⇒ <code>Promise</code>~~
|
|
780
|
+
* [.generateProvisioningKey(slugOrUuidOrId, [keyName], [keyDescription])](#balena.models.application.generateProvisioningKey) ⇒ <code>Promise</code>
|
|
779
781
|
* [.purge(appId)](#balena.models.application.purge) ⇒ <code>Promise</code>
|
|
780
782
|
* [.shutdown(appId, [options])](#balena.models.application.shutdown) ⇒ <code>Promise</code>
|
|
781
783
|
* [.reboot(appId, [options])](#balena.models.application.reboot) ⇒ <code>Promise</code>
|
|
782
|
-
* [.willTrackNewReleases(
|
|
783
|
-
* [.isTrackingLatestRelease(
|
|
784
|
-
* [.pinToRelease(
|
|
785
|
-
* [.getTargetReleaseHash(
|
|
786
|
-
* [.trackLatestRelease(
|
|
787
|
-
* [.enableDeviceUrls(
|
|
788
|
-
* [.disableDeviceUrls(
|
|
789
|
-
* [.grantSupportAccess(
|
|
790
|
-
* [.revokeSupportAccess(
|
|
784
|
+
* [.willTrackNewReleases(slugOrUuidOrId)](#balena.models.application.willTrackNewReleases) ⇒ <code>Promise</code>
|
|
785
|
+
* [.isTrackingLatestRelease(slugOrUuidOrId)](#balena.models.application.isTrackingLatestRelease) ⇒ <code>Promise</code>
|
|
786
|
+
* [.pinToRelease(slugOrUuidOrId, fullReleaseHash)](#balena.models.application.pinToRelease) ⇒ <code>Promise</code>
|
|
787
|
+
* [.getTargetReleaseHash(slugOrUuidOrId)](#balena.models.application.getTargetReleaseHash) ⇒ <code>Promise</code>
|
|
788
|
+
* [.trackLatestRelease(slugOrUuidOrId)](#balena.models.application.trackLatestRelease) ⇒ <code>Promise</code>
|
|
789
|
+
* [.enableDeviceUrls(slugOrUuidOrId)](#balena.models.application.enableDeviceUrls) ⇒ <code>Promise</code>
|
|
790
|
+
* [.disableDeviceUrls(slugOrUuidOrId)](#balena.models.application.disableDeviceUrls) ⇒ <code>Promise</code>
|
|
791
|
+
* [.grantSupportAccess(slugOrUuidOrId, expiryTimestamp)](#balena.models.application.grantSupportAccess) ⇒ <code>Promise</code>
|
|
792
|
+
* [.revokeSupportAccess(slugOrUuidOrId)](#balena.models.application.revokeSupportAccess) ⇒ <code>Promise</code>
|
|
791
793
|
|
|
792
794
|
<a name="balena.models.application.tags"></a>
|
|
793
795
|
|
|
@@ -795,14 +797,14 @@ balena.models.device.get(123).catch(function (error) {
|
|
|
795
797
|
**Kind**: static namespace of [<code>application</code>](#balena.models.application)
|
|
796
798
|
|
|
797
799
|
* [.tags](#balena.models.application.tags) : <code>object</code>
|
|
798
|
-
* [.getAllByApplication(
|
|
800
|
+
* [.getAllByApplication(slugOrUuidOrId, [options])](#balena.models.application.tags.getAllByApplication) ⇒ <code>Promise</code>
|
|
799
801
|
* [.getAll([options])](#balena.models.application.tags.getAll) ⇒ <code>Promise</code>
|
|
800
|
-
* [.set(
|
|
801
|
-
* [.remove(
|
|
802
|
+
* [.set(slugOrUuidOrId, tagKey, value)](#balena.models.application.tags.set) ⇒ <code>Promise</code>
|
|
803
|
+
* [.remove(slugOrUuidOrId, tagKey)](#balena.models.application.tags.remove) ⇒ <code>Promise</code>
|
|
802
804
|
|
|
803
805
|
<a name="balena.models.application.tags.getAllByApplication"></a>
|
|
804
806
|
|
|
805
|
-
###### tags.getAllByApplication(
|
|
807
|
+
###### tags.getAllByApplication(slugOrUuidOrId, [options]) ⇒ <code>Promise</code>
|
|
806
808
|
**Kind**: static method of [<code>tags</code>](#balena.models.application.tags)
|
|
807
809
|
**Summary**: Get all application tags for an application
|
|
808
810
|
**Access**: public
|
|
@@ -810,7 +812,7 @@ balena.models.device.get(123).catch(function (error) {
|
|
|
810
812
|
|
|
811
813
|
| Param | Type | Default | Description |
|
|
812
814
|
| --- | --- | --- | --- |
|
|
813
|
-
|
|
|
815
|
+
| slugOrUuidOrId | <code>String</code> \| <code>Number</code> | | application slug (string), uuid (string) or id (number) |
|
|
814
816
|
| [options] | <code>Object</code> | <code>{}</code> | extra pine options to use |
|
|
815
817
|
|
|
816
818
|
**Example**
|
|
@@ -859,14 +861,14 @@ balena.models.application.tags.getAll(function(error, tags) {
|
|
|
859
861
|
```
|
|
860
862
|
<a name="balena.models.application.tags.set"></a>
|
|
861
863
|
|
|
862
|
-
###### tags.set(
|
|
864
|
+
###### tags.set(slugOrUuidOrId, tagKey, value) ⇒ <code>Promise</code>
|
|
863
865
|
**Kind**: static method of [<code>tags</code>](#balena.models.application.tags)
|
|
864
866
|
**Summary**: Set an application tag
|
|
865
867
|
**Access**: public
|
|
866
868
|
|
|
867
869
|
| Param | Type | Description |
|
|
868
870
|
| --- | --- | --- |
|
|
869
|
-
|
|
|
871
|
+
| slugOrUuidOrId | <code>String</code> \| <code>Number</code> | application slug (string), uuid (string) or id (number) |
|
|
870
872
|
| tagKey | <code>String</code> | tag key |
|
|
871
873
|
| value | <code>String</code> \| <code>undefined</code> | tag value |
|
|
872
874
|
|
|
@@ -886,14 +888,14 @@ balena.models.application.tags.set('myorganization/myapp', 'EDITOR', 'vim', func
|
|
|
886
888
|
```
|
|
887
889
|
<a name="balena.models.application.tags.remove"></a>
|
|
888
890
|
|
|
889
|
-
###### tags.remove(
|
|
891
|
+
###### tags.remove(slugOrUuidOrId, tagKey) ⇒ <code>Promise</code>
|
|
890
892
|
**Kind**: static method of [<code>tags</code>](#balena.models.application.tags)
|
|
891
893
|
**Summary**: Remove an application tag
|
|
892
894
|
**Access**: public
|
|
893
895
|
|
|
894
896
|
| Param | Type | Description |
|
|
895
897
|
| --- | --- | --- |
|
|
896
|
-
|
|
|
898
|
+
| slugOrUuidOrId | <code>String</code> \| <code>Number</code> | application slug (string), uuid (string) or id (number) |
|
|
897
899
|
| tagKey | <code>String</code> | tag key |
|
|
898
900
|
|
|
899
901
|
**Example**
|
|
@@ -912,14 +914,14 @@ balena.models.application.tags.remove('myorganization/myapp', 'EDITOR', function
|
|
|
912
914
|
**Kind**: static namespace of [<code>application</code>](#balena.models.application)
|
|
913
915
|
|
|
914
916
|
* [.configVar](#balena.models.application.configVar) : <code>object</code>
|
|
915
|
-
* [.getAllByApplication(
|
|
916
|
-
* [.get(
|
|
917
|
-
* [.set(
|
|
918
|
-
* [.remove(
|
|
917
|
+
* [.getAllByApplication(slugOrUuidOrId, [options])](#balena.models.application.configVar.getAllByApplication) ⇒ <code>Promise</code>
|
|
918
|
+
* [.get(slugOrUuidOrId, key)](#balena.models.application.configVar.get) ⇒ <code>Promise</code>
|
|
919
|
+
* [.set(slugOrUuidOrId, key, value)](#balena.models.application.configVar.set) ⇒ <code>Promise</code>
|
|
920
|
+
* [.remove(slugOrUuidOrId, key)](#balena.models.application.configVar.remove) ⇒ <code>Promise</code>
|
|
919
921
|
|
|
920
922
|
<a name="balena.models.application.configVar.getAllByApplication"></a>
|
|
921
923
|
|
|
922
|
-
###### configVar.getAllByApplication(
|
|
924
|
+
###### configVar.getAllByApplication(slugOrUuidOrId, [options]) ⇒ <code>Promise</code>
|
|
923
925
|
**Kind**: static method of [<code>configVar</code>](#balena.models.application.configVar)
|
|
924
926
|
**Summary**: Get all config variables for an application
|
|
925
927
|
**Access**: public
|
|
@@ -927,7 +929,7 @@ balena.models.application.tags.remove('myorganization/myapp', 'EDITOR', function
|
|
|
927
929
|
|
|
928
930
|
| Param | Type | Default | Description |
|
|
929
931
|
| --- | --- | --- | --- |
|
|
930
|
-
|
|
|
932
|
+
| slugOrUuidOrId | <code>String</code> \| <code>Number</code> | | application slug (string), uuid (string) or id (number) |
|
|
931
933
|
| [options] | <code>Object</code> | <code>{}</code> | extra pine options to use |
|
|
932
934
|
|
|
933
935
|
**Example**
|
|
@@ -951,7 +953,7 @@ balena.models.application.configVar.getAllByApplication('myorganization/myapp',
|
|
|
951
953
|
```
|
|
952
954
|
<a name="balena.models.application.configVar.get"></a>
|
|
953
955
|
|
|
954
|
-
###### configVar.get(
|
|
956
|
+
###### configVar.get(slugOrUuidOrId, key) ⇒ <code>Promise</code>
|
|
955
957
|
**Kind**: static method of [<code>configVar</code>](#balena.models.application.configVar)
|
|
956
958
|
**Summary**: Get the value of a specific config variable
|
|
957
959
|
**Access**: public
|
|
@@ -959,7 +961,7 @@ balena.models.application.configVar.getAllByApplication('myorganization/myapp',
|
|
|
959
961
|
|
|
960
962
|
| Param | Type | Description |
|
|
961
963
|
| --- | --- | --- |
|
|
962
|
-
|
|
|
964
|
+
| slugOrUuidOrId | <code>String</code> \| <code>Number</code> | application slug (string), uuid (string) or id (number) |
|
|
963
965
|
| key | <code>String</code> | config variable name |
|
|
964
966
|
|
|
965
967
|
**Example**
|
|
@@ -983,14 +985,14 @@ balena.models.application.configVar.get('myorganization/myapp', 'BALENA_VAR', fu
|
|
|
983
985
|
```
|
|
984
986
|
<a name="balena.models.application.configVar.set"></a>
|
|
985
987
|
|
|
986
|
-
###### configVar.set(
|
|
988
|
+
###### configVar.set(slugOrUuidOrId, key, value) ⇒ <code>Promise</code>
|
|
987
989
|
**Kind**: static method of [<code>configVar</code>](#balena.models.application.configVar)
|
|
988
990
|
**Summary**: Set the value of a specific config variable
|
|
989
991
|
**Access**: public
|
|
990
992
|
|
|
991
993
|
| Param | Type | Description |
|
|
992
994
|
| --- | --- | --- |
|
|
993
|
-
|
|
|
995
|
+
| slugOrUuidOrId | <code>String</code> \| <code>Number</code> | application slug (string), uuid (string) or id (number) |
|
|
994
996
|
| key | <code>String</code> | config variable name |
|
|
995
997
|
| value | <code>String</code> | config variable value |
|
|
996
998
|
|
|
@@ -1015,14 +1017,14 @@ balena.models.application.configVar.set('myorganization/myapp', 'BALENA_VAR', 'n
|
|
|
1015
1017
|
```
|
|
1016
1018
|
<a name="balena.models.application.configVar.remove"></a>
|
|
1017
1019
|
|
|
1018
|
-
###### configVar.remove(
|
|
1020
|
+
###### configVar.remove(slugOrUuidOrId, key) ⇒ <code>Promise</code>
|
|
1019
1021
|
**Kind**: static method of [<code>configVar</code>](#balena.models.application.configVar)
|
|
1020
1022
|
**Summary**: Clear the value of a specific config variable
|
|
1021
1023
|
**Access**: public
|
|
1022
1024
|
|
|
1023
1025
|
| Param | Type | Description |
|
|
1024
1026
|
| --- | --- | --- |
|
|
1025
|
-
|
|
|
1027
|
+
| slugOrUuidOrId | <code>String</code> \| <code>Number</code> | application slug (string), uuid (string) or id (number) |
|
|
1026
1028
|
| key | <code>String</code> | config variable name |
|
|
1027
1029
|
|
|
1028
1030
|
**Example**
|
|
@@ -1050,14 +1052,14 @@ balena.models.application.configVar.remove('myorganization/myapp', 'BALENA_VAR',
|
|
|
1050
1052
|
**Kind**: static namespace of [<code>application</code>](#balena.models.application)
|
|
1051
1053
|
|
|
1052
1054
|
* [.envVar](#balena.models.application.envVar) : <code>object</code>
|
|
1053
|
-
* [.getAllByApplication(
|
|
1054
|
-
* [.get(
|
|
1055
|
-
* [.set(
|
|
1056
|
-
* [.remove(
|
|
1055
|
+
* [.getAllByApplication(slugOrUuidOrId, [options])](#balena.models.application.envVar.getAllByApplication) ⇒ <code>Promise</code>
|
|
1056
|
+
* [.get(slugOrUuidOrId, key)](#balena.models.application.envVar.get) ⇒ <code>Promise</code>
|
|
1057
|
+
* [.set(slugOrUuidOrId, key, value)](#balena.models.application.envVar.set) ⇒ <code>Promise</code>
|
|
1058
|
+
* [.remove(slugOrUuidOrId, key)](#balena.models.application.envVar.remove) ⇒ <code>Promise</code>
|
|
1057
1059
|
|
|
1058
1060
|
<a name="balena.models.application.envVar.getAllByApplication"></a>
|
|
1059
1061
|
|
|
1060
|
-
###### envVar.getAllByApplication(
|
|
1062
|
+
###### envVar.getAllByApplication(slugOrUuidOrId, [options]) ⇒ <code>Promise</code>
|
|
1061
1063
|
**Kind**: static method of [<code>envVar</code>](#balena.models.application.envVar)
|
|
1062
1064
|
**Summary**: Get all environment variables for an application
|
|
1063
1065
|
**Access**: public
|
|
@@ -1065,7 +1067,7 @@ balena.models.application.configVar.remove('myorganization/myapp', 'BALENA_VAR',
|
|
|
1065
1067
|
|
|
1066
1068
|
| Param | Type | Default | Description |
|
|
1067
1069
|
| --- | --- | --- | --- |
|
|
1068
|
-
|
|
|
1070
|
+
| slugOrUuidOrId | <code>String</code> \| <code>Number</code> | | application slug (string), uuid (string) or id (number) |
|
|
1069
1071
|
| [options] | <code>Object</code> | <code>{}</code> | extra pine options to use |
|
|
1070
1072
|
|
|
1071
1073
|
**Example**
|
|
@@ -1089,7 +1091,7 @@ balena.models.application.envVar.getAllByApplication('myorganization/myapp', fun
|
|
|
1089
1091
|
```
|
|
1090
1092
|
<a name="balena.models.application.envVar.get"></a>
|
|
1091
1093
|
|
|
1092
|
-
###### envVar.get(
|
|
1094
|
+
###### envVar.get(slugOrUuidOrId, key) ⇒ <code>Promise</code>
|
|
1093
1095
|
**Kind**: static method of [<code>envVar</code>](#balena.models.application.envVar)
|
|
1094
1096
|
**Summary**: Get the value of a specific environment variable
|
|
1095
1097
|
**Access**: public
|
|
@@ -1097,7 +1099,7 @@ balena.models.application.envVar.getAllByApplication('myorganization/myapp', fun
|
|
|
1097
1099
|
|
|
1098
1100
|
| Param | Type | Description |
|
|
1099
1101
|
| --- | --- | --- |
|
|
1100
|
-
|
|
|
1102
|
+
| slugOrUuidOrId | <code>String</code> \| <code>Number</code> | application slug (string), uuid (string) or id (number) |
|
|
1101
1103
|
| key | <code>String</code> | environment variable name |
|
|
1102
1104
|
|
|
1103
1105
|
**Example**
|
|
@@ -1121,14 +1123,14 @@ balena.models.application.envVar.get('myorganization/myapp', 'VAR', function(err
|
|
|
1121
1123
|
```
|
|
1122
1124
|
<a name="balena.models.application.envVar.set"></a>
|
|
1123
1125
|
|
|
1124
|
-
###### envVar.set(
|
|
1126
|
+
###### envVar.set(slugOrUuidOrId, key, value) ⇒ <code>Promise</code>
|
|
1125
1127
|
**Kind**: static method of [<code>envVar</code>](#balena.models.application.envVar)
|
|
1126
1128
|
**Summary**: Set the value of a specific environment variable
|
|
1127
1129
|
**Access**: public
|
|
1128
1130
|
|
|
1129
1131
|
| Param | Type | Description |
|
|
1130
1132
|
| --- | --- | --- |
|
|
1131
|
-
|
|
|
1133
|
+
| slugOrUuidOrId | <code>String</code> \| <code>Number</code> | application slug (string), uuid (string) or id (number) |
|
|
1132
1134
|
| key | <code>String</code> | environment variable name |
|
|
1133
1135
|
| value | <code>String</code> | environment variable value |
|
|
1134
1136
|
|
|
@@ -1153,14 +1155,14 @@ balena.models.application.envVar.set('myorganization/myapp', 'VAR', 'newvalue',
|
|
|
1153
1155
|
```
|
|
1154
1156
|
<a name="balena.models.application.envVar.remove"></a>
|
|
1155
1157
|
|
|
1156
|
-
###### envVar.remove(
|
|
1158
|
+
###### envVar.remove(slugOrUuidOrId, key) ⇒ <code>Promise</code>
|
|
1157
1159
|
**Kind**: static method of [<code>envVar</code>](#balena.models.application.envVar)
|
|
1158
1160
|
**Summary**: Clear the value of a specific environment variable
|
|
1159
1161
|
**Access**: public
|
|
1160
1162
|
|
|
1161
1163
|
| Param | Type | Description |
|
|
1162
1164
|
| --- | --- | --- |
|
|
1163
|
-
|
|
|
1165
|
+
| slugOrUuidOrId | <code>String</code> \| <code>Number</code> | application slug (string), uuid (string) or id (number) |
|
|
1164
1166
|
| key | <code>String</code> | environment variable name |
|
|
1165
1167
|
|
|
1166
1168
|
**Example**
|
|
@@ -1188,14 +1190,14 @@ balena.models.application.envVar.remove('myorganization/myapp', 'VAR', function(
|
|
|
1188
1190
|
**Kind**: static namespace of [<code>application</code>](#balena.models.application)
|
|
1189
1191
|
|
|
1190
1192
|
* [.buildVar](#balena.models.application.buildVar) : <code>object</code>
|
|
1191
|
-
* [.getAllByApplication(
|
|
1192
|
-
* [.get(
|
|
1193
|
-
* [.set(
|
|
1194
|
-
* [.remove(
|
|
1193
|
+
* [.getAllByApplication(slugOrUuidOrId, [options])](#balena.models.application.buildVar.getAllByApplication) ⇒ <code>Promise</code>
|
|
1194
|
+
* [.get(slugOrUuidOrId, key)](#balena.models.application.buildVar.get) ⇒ <code>Promise</code>
|
|
1195
|
+
* [.set(slugOrUuidOrId, key, value)](#balena.models.application.buildVar.set) ⇒ <code>Promise</code>
|
|
1196
|
+
* [.remove(slugOrUuidOrId, key)](#balena.models.application.buildVar.remove) ⇒ <code>Promise</code>
|
|
1195
1197
|
|
|
1196
1198
|
<a name="balena.models.application.buildVar.getAllByApplication"></a>
|
|
1197
1199
|
|
|
1198
|
-
###### buildVar.getAllByApplication(
|
|
1200
|
+
###### buildVar.getAllByApplication(slugOrUuidOrId, [options]) ⇒ <code>Promise</code>
|
|
1199
1201
|
**Kind**: static method of [<code>buildVar</code>](#balena.models.application.buildVar)
|
|
1200
1202
|
**Summary**: Get all build environment variables for an application
|
|
1201
1203
|
**Access**: public
|
|
@@ -1203,7 +1205,7 @@ balena.models.application.envVar.remove('myorganization/myapp', 'VAR', function(
|
|
|
1203
1205
|
|
|
1204
1206
|
| Param | Type | Default | Description |
|
|
1205
1207
|
| --- | --- | --- | --- |
|
|
1206
|
-
|
|
|
1208
|
+
| slugOrUuidOrId | <code>String</code> \| <code>Number</code> | | application slug (string), uuid (string) or id (number) |
|
|
1207
1209
|
| [options] | <code>Object</code> | <code>{}</code> | extra pine options to use |
|
|
1208
1210
|
|
|
1209
1211
|
**Example**
|
|
@@ -1227,7 +1229,7 @@ balena.models.application.buildVar.getAllByApplication('myorganization/myapp', f
|
|
|
1227
1229
|
```
|
|
1228
1230
|
<a name="balena.models.application.buildVar.get"></a>
|
|
1229
1231
|
|
|
1230
|
-
###### buildVar.get(
|
|
1232
|
+
###### buildVar.get(slugOrUuidOrId, key) ⇒ <code>Promise</code>
|
|
1231
1233
|
**Kind**: static method of [<code>buildVar</code>](#balena.models.application.buildVar)
|
|
1232
1234
|
**Summary**: Get the value of a specific build environment variable
|
|
1233
1235
|
**Access**: public
|
|
@@ -1235,7 +1237,7 @@ balena.models.application.buildVar.getAllByApplication('myorganization/myapp', f
|
|
|
1235
1237
|
|
|
1236
1238
|
| Param | Type | Description |
|
|
1237
1239
|
| --- | --- | --- |
|
|
1238
|
-
|
|
|
1240
|
+
| slugOrUuidOrId | <code>String</code> \| <code>Number</code> | application slug (string), uuid (string) or id (number) |
|
|
1239
1241
|
| key | <code>String</code> | build environment variable name |
|
|
1240
1242
|
|
|
1241
1243
|
**Example**
|
|
@@ -1259,14 +1261,14 @@ balena.models.application.buildVar.get('myorganization/myapp', 'VAR', function(e
|
|
|
1259
1261
|
```
|
|
1260
1262
|
<a name="balena.models.application.buildVar.set"></a>
|
|
1261
1263
|
|
|
1262
|
-
###### buildVar.set(
|
|
1264
|
+
###### buildVar.set(slugOrUuidOrId, key, value) ⇒ <code>Promise</code>
|
|
1263
1265
|
**Kind**: static method of [<code>buildVar</code>](#balena.models.application.buildVar)
|
|
1264
1266
|
**Summary**: Set the value of a specific build environment variable
|
|
1265
1267
|
**Access**: public
|
|
1266
1268
|
|
|
1267
1269
|
| Param | Type | Description |
|
|
1268
1270
|
| --- | --- | --- |
|
|
1269
|
-
|
|
|
1271
|
+
| slugOrUuidOrId | <code>String</code> \| <code>Number</code> | application slug (string), uuid (string) or id (number) |
|
|
1270
1272
|
| key | <code>String</code> | build environment variable name |
|
|
1271
1273
|
| value | <code>String</code> | build environment variable value |
|
|
1272
1274
|
|
|
@@ -1291,14 +1293,14 @@ balena.models.application.buildVar.set('myorganization/myapp', 'VAR', 'newvalue'
|
|
|
1291
1293
|
```
|
|
1292
1294
|
<a name="balena.models.application.buildVar.remove"></a>
|
|
1293
1295
|
|
|
1294
|
-
###### buildVar.remove(
|
|
1296
|
+
###### buildVar.remove(slugOrUuidOrId, key) ⇒ <code>Promise</code>
|
|
1295
1297
|
**Kind**: static method of [<code>buildVar</code>](#balena.models.application.buildVar)
|
|
1296
1298
|
**Summary**: Clear the value of a specific build environment variable
|
|
1297
1299
|
**Access**: public
|
|
1298
1300
|
|
|
1299
1301
|
| Param | Type | Description |
|
|
1300
1302
|
| --- | --- | --- |
|
|
1301
|
-
|
|
|
1303
|
+
| slugOrUuidOrId | <code>String</code> \| <code>Number</code> | application slug (string), uuid (string) or id (number) |
|
|
1302
1304
|
| key | <code>String</code> | build environment variable name |
|
|
1303
1305
|
|
|
1304
1306
|
**Example**
|
|
@@ -1328,7 +1330,7 @@ balena.models.application.buildVar.remove('myorganization/myapp', 'VAR', functio
|
|
|
1328
1330
|
* [.membership](#balena.models.application.membership) : <code>object</code>
|
|
1329
1331
|
* [.get(membershipId, [options])](#balena.models.application.membership.get) ⇒ <code>Promise</code>
|
|
1330
1332
|
* [.getAll([options])](#balena.models.application.membership.getAll) ⇒ <code>Promise</code>
|
|
1331
|
-
* [.getAllByApplication(
|
|
1333
|
+
* [.getAllByApplication(slugOrUuidOrId, [options])](#balena.models.application.membership.getAllByApplication) ⇒ <code>Promise</code>
|
|
1332
1334
|
* [.create(options)](#balena.models.application.membership.create) ⇒ <code>Promise</code>
|
|
1333
1335
|
* [.changeRole(idOrUniqueKey, roleName)](#balena.models.application.membership.changeRole) ⇒ <code>Promise</code>
|
|
1334
1336
|
* [.remove(idOrUniqueKey)](#balena.models.application.membership.remove) ⇒ <code>Promise</code>
|
|
@@ -1388,7 +1390,7 @@ balena.models.application.membership.getAll(function(error, memberships) {
|
|
|
1388
1390
|
```
|
|
1389
1391
|
<a name="balena.models.application.membership.getAllByApplication"></a>
|
|
1390
1392
|
|
|
1391
|
-
###### membership.getAllByApplication(
|
|
1393
|
+
###### membership.getAllByApplication(slugOrUuidOrId, [options]) ⇒ <code>Promise</code>
|
|
1392
1394
|
This method returns all application memberships for a specific application.
|
|
1393
1395
|
|
|
1394
1396
|
**Kind**: static method of [<code>membership</code>](#balena.models.application.membership)
|
|
@@ -1398,7 +1400,7 @@ This method returns all application memberships for a specific application.
|
|
|
1398
1400
|
|
|
1399
1401
|
| Param | Type | Default | Description |
|
|
1400
1402
|
| --- | --- | --- | --- |
|
|
1401
|
-
|
|
|
1403
|
+
| slugOrUuidOrId | <code>String</code> \| <code>Number</code> | | application slug (string), uuid (string) or id (number) |
|
|
1402
1404
|
| [options] | <code>Object</code> | <code>{}</code> | extra pine options to use |
|
|
1403
1405
|
|
|
1404
1406
|
**Example**
|
|
@@ -1519,8 +1521,8 @@ balena.models.application.membership.remove(123,function(error) {
|
|
|
1519
1521
|
|
|
1520
1522
|
* [.invite](#balena.models.application.invite) : <code>object</code>
|
|
1521
1523
|
* [.getAll([options])](#balena.models.application.invite.getAll) ⇒ <code>Promise</code>
|
|
1522
|
-
* [.getAllByApplication(
|
|
1523
|
-
* [.create(
|
|
1524
|
+
* [.getAllByApplication(slugOrUuidOrId, [options])](#balena.models.application.invite.getAllByApplication) ⇒ <code>Promise</code>
|
|
1525
|
+
* [.create(slugOrUuidOrId, options, [message])](#balena.models.application.invite.create) ⇒ <code>Promise</code>
|
|
1524
1526
|
* [.revoke(id)](#balena.models.application.invite.revoke) ⇒ <code>Promise</code>
|
|
1525
1527
|
* [.accept(invitationToken)](#balena.models.application.invite.accept) ⇒ <code>Promise</code>
|
|
1526
1528
|
|
|
@@ -1552,7 +1554,7 @@ balena.models.application.invite.getAll(function(error, invites) {
|
|
|
1552
1554
|
```
|
|
1553
1555
|
<a name="balena.models.application.invite.getAllByApplication"></a>
|
|
1554
1556
|
|
|
1555
|
-
###### invite.getAllByApplication(
|
|
1557
|
+
###### invite.getAllByApplication(slugOrUuidOrId, [options]) ⇒ <code>Promise</code>
|
|
1556
1558
|
This method returns all invites for a specific application.
|
|
1557
1559
|
|
|
1558
1560
|
**Kind**: static method of [<code>invite</code>](#balena.models.application.invite)
|
|
@@ -1562,7 +1564,7 @@ This method returns all invites for a specific application.
|
|
|
1562
1564
|
|
|
1563
1565
|
| Param | Type | Default | Description |
|
|
1564
1566
|
| --- | --- | --- | --- |
|
|
1565
|
-
|
|
|
1567
|
+
| slugOrUuidOrId | <code>String</code> \| <code>Number</code> | | application slug (string), uuid (string) or id (number) |
|
|
1566
1568
|
| [options] | <code>Object</code> | <code>{}</code> | extra pine options to use |
|
|
1567
1569
|
|
|
1568
1570
|
**Example**
|
|
@@ -1585,7 +1587,7 @@ balena.models.application.invite.getAllByApplication(123, function(error, invite
|
|
|
1585
1587
|
```
|
|
1586
1588
|
<a name="balena.models.application.invite.create"></a>
|
|
1587
1589
|
|
|
1588
|
-
###### invite.create(
|
|
1590
|
+
###### invite.create(slugOrUuidOrId, options, [message]) ⇒ <code>Promise</code>
|
|
1589
1591
|
This method invites a user by their email to an application.
|
|
1590
1592
|
|
|
1591
1593
|
**Kind**: static method of [<code>invite</code>](#balena.models.application.invite)
|
|
@@ -1595,7 +1597,7 @@ This method invites a user by their email to an application.
|
|
|
1595
1597
|
|
|
1596
1598
|
| Param | Type | Default | Description |
|
|
1597
1599
|
| --- | --- | --- | --- |
|
|
1598
|
-
|
|
|
1600
|
+
| slugOrUuidOrId | <code>String</code> \| <code>Number</code> | | application slug (string), uuid (string) or id (number) |
|
|
1599
1601
|
| options | <code>Object</code> | | invite creation parameters |
|
|
1600
1602
|
| options.invitee | <code>String</code> | | the email/balena_username of the invitee |
|
|
1601
1603
|
| [options.roleName] | <code>String</code> | <code>"developer"</code> | the role name to be granted to the invitee |
|
|
@@ -1734,7 +1736,7 @@ balena.models.application.getAllDirectlyAccessible(function(error, applications)
|
|
|
1734
1736
|
```
|
|
1735
1737
|
<a name="balena.models.application.get"></a>
|
|
1736
1738
|
|
|
1737
|
-
##### application.get(
|
|
1739
|
+
##### application.get(slugOrUuidOrId, [options], [context]) ⇒ <code>Promise</code>
|
|
1738
1740
|
**Kind**: static method of [<code>application</code>](#balena.models.application)
|
|
1739
1741
|
**Summary**: Get a single application
|
|
1740
1742
|
**Access**: public
|
|
@@ -1742,7 +1744,7 @@ balena.models.application.getAllDirectlyAccessible(function(error, applications)
|
|
|
1742
1744
|
|
|
1743
1745
|
| Param | Type | Default | Description |
|
|
1744
1746
|
| --- | --- | --- | --- |
|
|
1745
|
-
|
|
|
1747
|
+
| slugOrUuidOrId | <code>String</code> \| <code>Number</code> | | application slug (string), uuid (string) or id (number) |
|
|
1746
1748
|
| [options] | <code>Object</code> | <code>{}</code> | extra pine options to use |
|
|
1747
1749
|
| [context] | <code>String</code> | | extra access filters, undefined or 'directly_accessible' |
|
|
1748
1750
|
|
|
@@ -1754,6 +1756,12 @@ balena.models.application.get('myorganization/myapp').then(function(application)
|
|
|
1754
1756
|
```
|
|
1755
1757
|
**Example**
|
|
1756
1758
|
```js
|
|
1759
|
+
balena.models.application.get('1bf99a68cf9e4266986e6dec7a6e8f46').then(function(application) {
|
|
1760
|
+
console.log(application);
|
|
1761
|
+
});
|
|
1762
|
+
```
|
|
1763
|
+
**Example**
|
|
1764
|
+
```js
|
|
1757
1765
|
balena.models.application.get(123).then(function(application) {
|
|
1758
1766
|
console.log(application);
|
|
1759
1767
|
});
|
|
@@ -1767,7 +1775,7 @@ balena.models.application.get('myorganization/myapp', function(error, applicatio
|
|
|
1767
1775
|
```
|
|
1768
1776
|
<a name="balena.models.application.getDirectlyAccessible"></a>
|
|
1769
1777
|
|
|
1770
|
-
##### application.getDirectlyAccessible(
|
|
1778
|
+
##### application.getDirectlyAccessible(slugOrUuidOrId, [options]) ⇒ <code>Promise</code>
|
|
1771
1779
|
**Kind**: static method of [<code>application</code>](#balena.models.application)
|
|
1772
1780
|
**Summary**: Get a single application directly accessible by the user
|
|
1773
1781
|
**Access**: public
|
|
@@ -1775,7 +1783,7 @@ balena.models.application.get('myorganization/myapp', function(error, applicatio
|
|
|
1775
1783
|
|
|
1776
1784
|
| Param | Type | Default | Description |
|
|
1777
1785
|
| --- | --- | --- | --- |
|
|
1778
|
-
|
|
|
1786
|
+
| slugOrUuidOrId | <code>String</code> \| <code>Number</code> | | application slug (string), uuid (string) or id (number) |
|
|
1779
1787
|
| [options] | <code>Object</code> | <code>{}</code> | extra pine options to use |
|
|
1780
1788
|
|
|
1781
1789
|
**Example**
|
|
@@ -1799,7 +1807,7 @@ balena.models.application.getDirectlyAccessible('myorganization/myapp', function
|
|
|
1799
1807
|
```
|
|
1800
1808
|
<a name="balena.models.application.getWithDeviceServiceDetails"></a>
|
|
1801
1809
|
|
|
1802
|
-
##### application.getWithDeviceServiceDetails(
|
|
1810
|
+
##### application.getWithDeviceServiceDetails(slugOrUuidOrId, [options]) ⇒ <code>Promise</code>
|
|
1803
1811
|
This method does not map exactly to the underlying model: it runs a
|
|
1804
1812
|
larger prebuilt query, and reformats it into an easy to use and
|
|
1805
1813
|
understand format. If you want more control, or to see the raw model
|
|
@@ -1813,7 +1821,7 @@ associated services' essential details
|
|
|
1813
1821
|
|
|
1814
1822
|
| Param | Type | Default | Description |
|
|
1815
1823
|
| --- | --- | --- | --- |
|
|
1816
|
-
|
|
|
1824
|
+
| slugOrUuidOrId | <code>String</code> \| <code>Number</code> | | application slug (string), uuid (string) or id (number) |
|
|
1817
1825
|
| [options] | <code>Object</code> | <code>{}</code> | extra pine options to use |
|
|
1818
1826
|
|
|
1819
1827
|
**Example**
|
|
@@ -1877,7 +1885,7 @@ balena.models.application.getAppByOwner('myorganization/myapp', 'MyOrg').then(fu
|
|
|
1877
1885
|
```
|
|
1878
1886
|
<a name="balena.models.application.has"></a>
|
|
1879
1887
|
|
|
1880
|
-
##### application.has(
|
|
1888
|
+
##### application.has(slugOrUuidOrId) ⇒ <code>Promise</code>
|
|
1881
1889
|
**Kind**: static method of [<code>application</code>](#balena.models.application)
|
|
1882
1890
|
**Summary**: Check if an application exists
|
|
1883
1891
|
**Access**: public
|
|
@@ -1885,7 +1893,7 @@ balena.models.application.getAppByOwner('myorganization/myapp', 'MyOrg').then(fu
|
|
|
1885
1893
|
|
|
1886
1894
|
| Param | Type | Description |
|
|
1887
1895
|
| --- | --- | --- |
|
|
1888
|
-
|
|
|
1896
|
+
| slugOrUuidOrId | <code>String</code> \| <code>Number</code> | application slug (string), uuid (string) or id (number) |
|
|
1889
1897
|
|
|
1890
1898
|
**Example**
|
|
1891
1899
|
```js
|
|
@@ -1964,14 +1972,14 @@ balena.models.application.create({ name: 'My App', applicationType: 'microservic
|
|
|
1964
1972
|
```
|
|
1965
1973
|
<a name="balena.models.application.remove"></a>
|
|
1966
1974
|
|
|
1967
|
-
##### application.remove(
|
|
1975
|
+
##### application.remove(slugOrUuidOrId) ⇒ <code>Promise</code>
|
|
1968
1976
|
**Kind**: static method of [<code>application</code>](#balena.models.application)
|
|
1969
1977
|
**Summary**: Remove application
|
|
1970
1978
|
**Access**: public
|
|
1971
1979
|
|
|
1972
1980
|
| Param | Type | Description |
|
|
1973
1981
|
| --- | --- | --- |
|
|
1974
|
-
|
|
|
1982
|
+
| slugOrUuidOrId | <code>String</code> \| <code>Number</code> | application slug (string), uuid (string) or id (number) |
|
|
1975
1983
|
|
|
1976
1984
|
**Example**
|
|
1977
1985
|
```js
|
|
@@ -1989,14 +1997,14 @@ balena.models.application.remove('myorganization/myapp', function(error) {
|
|
|
1989
1997
|
```
|
|
1990
1998
|
<a name="balena.models.application.rename"></a>
|
|
1991
1999
|
|
|
1992
|
-
##### application.rename(
|
|
2000
|
+
##### application.rename(slugOrUuidOrId, newName) ⇒ <code>Promise</code>
|
|
1993
2001
|
**Kind**: static method of [<code>application</code>](#balena.models.application)
|
|
1994
2002
|
**Summary**: Rename application
|
|
1995
2003
|
**Access**: public
|
|
1996
2004
|
|
|
1997
2005
|
| Param | Type | Description |
|
|
1998
2006
|
| --- | --- | --- |
|
|
1999
|
-
|
|
|
2007
|
+
| slugOrUuidOrId | <code>String</code> \| <code>Number</code> | application slug (string), uuid (string) or id (number) |
|
|
2000
2008
|
| newName | <code>String</code> | new application name (string) |
|
|
2001
2009
|
|
|
2002
2010
|
**Example**
|
|
@@ -2015,14 +2023,14 @@ balena.models.application.rename('myorganization/myapp', 'MyRenamedApp', functio
|
|
|
2015
2023
|
```
|
|
2016
2024
|
<a name="balena.models.application.restart"></a>
|
|
2017
2025
|
|
|
2018
|
-
##### application.restart(
|
|
2026
|
+
##### application.restart(slugOrUuidOrId) ⇒ <code>Promise</code>
|
|
2019
2027
|
**Kind**: static method of [<code>application</code>](#balena.models.application)
|
|
2020
2028
|
**Summary**: Restart application
|
|
2021
2029
|
**Access**: public
|
|
2022
2030
|
|
|
2023
2031
|
| Param | Type | Description |
|
|
2024
2032
|
| --- | --- | --- |
|
|
2025
|
-
|
|
|
2033
|
+
| slugOrUuidOrId | <code>String</code> \| <code>Number</code> | application slug (string), uuid (string) or id (number) |
|
|
2026
2034
|
|
|
2027
2035
|
**Example**
|
|
2028
2036
|
```js
|
|
@@ -2040,7 +2048,7 @@ balena.models.application.restart('myorganization/myapp', function(error) {
|
|
|
2040
2048
|
```
|
|
2041
2049
|
<a name="balena.models.application.generateApiKey"></a>
|
|
2042
2050
|
|
|
2043
|
-
##### ~~application.generateApiKey(
|
|
2051
|
+
##### ~~application.generateApiKey(slugOrUuidOrId) ⇒ <code>Promise</code>~~
|
|
2044
2052
|
***Deprecated***
|
|
2045
2053
|
|
|
2046
2054
|
Generally you shouldn't use this method: if you're provisioning a recent BalenaOS
|
|
@@ -2054,7 +2062,7 @@ be more secure.
|
|
|
2054
2062
|
|
|
2055
2063
|
| Param | Type | Description |
|
|
2056
2064
|
| --- | --- | --- |
|
|
2057
|
-
|
|
|
2065
|
+
| slugOrUuidOrId | <code>String</code> \| <code>Number</code> | application slug (string), uuid (string) or id (number) |
|
|
2058
2066
|
|
|
2059
2067
|
**Example**
|
|
2060
2068
|
```js
|
|
@@ -2077,7 +2085,7 @@ balena.models.application.generateApiKey('myorganization/myapp', function(error,
|
|
|
2077
2085
|
```
|
|
2078
2086
|
<a name="balena.models.application.generateProvisioningKey"></a>
|
|
2079
2087
|
|
|
2080
|
-
##### application.generateProvisioningKey(
|
|
2088
|
+
##### application.generateProvisioningKey(slugOrUuidOrId, [keyName], [keyDescription]) ⇒ <code>Promise</code>
|
|
2081
2089
|
**Kind**: static method of [<code>application</code>](#balena.models.application)
|
|
2082
2090
|
**Summary**: Generate a device provisioning key for a specific application
|
|
2083
2091
|
**Access**: public
|
|
@@ -2085,7 +2093,7 @@ balena.models.application.generateApiKey('myorganization/myapp', function(error,
|
|
|
2085
2093
|
|
|
2086
2094
|
| Param | Type | Description |
|
|
2087
2095
|
| --- | --- | --- |
|
|
2088
|
-
|
|
|
2096
|
+
| slugOrUuidOrId | <code>String</code> \| <code>Number</code> | application slug (string), uuid (string) or id (number) |
|
|
2089
2097
|
| [keyName] | <code>String</code> | Provisioning key name |
|
|
2090
2098
|
| [keyDescription] | <code>String</code> | Description for provisioning key |
|
|
2091
2099
|
|
|
@@ -2177,7 +2185,7 @@ balena.models.application.reboot(123, function(error) {
|
|
|
2177
2185
|
```
|
|
2178
2186
|
<a name="balena.models.application.willTrackNewReleases"></a>
|
|
2179
2187
|
|
|
2180
|
-
##### application.willTrackNewReleases(
|
|
2188
|
+
##### application.willTrackNewReleases(slugOrUuidOrId) ⇒ <code>Promise</code>
|
|
2181
2189
|
**Kind**: static method of [<code>application</code>](#balena.models.application)
|
|
2182
2190
|
**Summary**: Get whether the application is configured to receive updates whenever a new release is available
|
|
2183
2191
|
**Access**: public
|
|
@@ -2185,7 +2193,7 @@ balena.models.application.reboot(123, function(error) {
|
|
|
2185
2193
|
|
|
2186
2194
|
| Param | Type | Description |
|
|
2187
2195
|
| --- | --- | --- |
|
|
2188
|
-
|
|
|
2196
|
+
| slugOrUuidOrId | <code>String</code> \| <code>Number</code> | application slug (string), uuid (string) or id (number) |
|
|
2189
2197
|
|
|
2190
2198
|
**Example**
|
|
2191
2199
|
```js
|
|
@@ -2207,7 +2215,7 @@ balena.models.application.willTrackNewReleases('myorganization/myapp', function(
|
|
|
2207
2215
|
```
|
|
2208
2216
|
<a name="balena.models.application.isTrackingLatestRelease"></a>
|
|
2209
2217
|
|
|
2210
|
-
##### application.isTrackingLatestRelease(
|
|
2218
|
+
##### application.isTrackingLatestRelease(slugOrUuidOrId) ⇒ <code>Promise</code>
|
|
2211
2219
|
**Kind**: static method of [<code>application</code>](#balena.models.application)
|
|
2212
2220
|
**Summary**: Get whether the application is up to date and is tracking the latest finalized release for updates
|
|
2213
2221
|
**Access**: public
|
|
@@ -2215,7 +2223,7 @@ balena.models.application.willTrackNewReleases('myorganization/myapp', function(
|
|
|
2215
2223
|
|
|
2216
2224
|
| Param | Type | Description |
|
|
2217
2225
|
| --- | --- | --- |
|
|
2218
|
-
|
|
|
2226
|
+
| slugOrUuidOrId | <code>String</code> \| <code>Number</code> | application slug (string), uuid (string) or id (number) |
|
|
2219
2227
|
|
|
2220
2228
|
**Example**
|
|
2221
2229
|
```js
|
|
@@ -2237,7 +2245,7 @@ balena.models.application.isTrackingLatestRelease('myorganization/myapp', functi
|
|
|
2237
2245
|
```
|
|
2238
2246
|
<a name="balena.models.application.pinToRelease"></a>
|
|
2239
2247
|
|
|
2240
|
-
##### application.pinToRelease(
|
|
2248
|
+
##### application.pinToRelease(slugOrUuidOrId, fullReleaseHash) ⇒ <code>Promise</code>
|
|
2241
2249
|
Configures the application to run a particular release
|
|
2242
2250
|
and not get updated when the latest release changes.
|
|
2243
2251
|
|
|
@@ -2247,7 +2255,7 @@ and not get updated when the latest release changes.
|
|
|
2247
2255
|
|
|
2248
2256
|
| Param | Type | Description |
|
|
2249
2257
|
| --- | --- | --- |
|
|
2250
|
-
|
|
|
2258
|
+
| slugOrUuidOrId | <code>String</code> \| <code>Number</code> | application slug (string), uuid (string) or id (number) |
|
|
2251
2259
|
| fullReleaseHash | <code>String</code> | the hash of a successful release (string) |
|
|
2252
2260
|
|
|
2253
2261
|
**Example**
|
|
@@ -2271,7 +2279,7 @@ balena.models.application.pinToRelease('myorganization/myapp', 'f7caf4ff80114dee
|
|
|
2271
2279
|
```
|
|
2272
2280
|
<a name="balena.models.application.getTargetReleaseHash"></a>
|
|
2273
2281
|
|
|
2274
|
-
##### application.getTargetReleaseHash(
|
|
2282
|
+
##### application.getTargetReleaseHash(slugOrUuidOrId) ⇒ <code>Promise</code>
|
|
2275
2283
|
**Kind**: static method of [<code>application</code>](#balena.models.application)
|
|
2276
2284
|
**Summary**: Get the hash of the current release for a specific application
|
|
2277
2285
|
**Access**: public
|
|
@@ -2279,7 +2287,7 @@ balena.models.application.pinToRelease('myorganization/myapp', 'f7caf4ff80114dee
|
|
|
2279
2287
|
|
|
2280
2288
|
| Param | Type | Description |
|
|
2281
2289
|
| --- | --- | --- |
|
|
2282
|
-
|
|
|
2290
|
+
| slugOrUuidOrId | <code>String</code> \| <code>Number</code> | application slug (string), uuid (string) or id (number) |
|
|
2283
2291
|
|
|
2284
2292
|
**Example**
|
|
2285
2293
|
```js
|
|
@@ -2301,7 +2309,7 @@ balena.models.application.getTargetReleaseHash('myorganization/myapp', function(
|
|
|
2301
2309
|
```
|
|
2302
2310
|
<a name="balena.models.application.trackLatestRelease"></a>
|
|
2303
2311
|
|
|
2304
|
-
##### application.trackLatestRelease(
|
|
2312
|
+
##### application.trackLatestRelease(slugOrUuidOrId) ⇒ <code>Promise</code>
|
|
2305
2313
|
The application's current release will be updated with each new successfully built release.
|
|
2306
2314
|
|
|
2307
2315
|
**Kind**: static method of [<code>application</code>](#balena.models.application)
|
|
@@ -2310,7 +2318,7 @@ The application's current release will be updated with each new successfully bui
|
|
|
2310
2318
|
|
|
2311
2319
|
| Param | Type | Description |
|
|
2312
2320
|
| --- | --- | --- |
|
|
2313
|
-
|
|
|
2321
|
+
| slugOrUuidOrId | <code>String</code> \| <code>Number</code> | application slug (string), uuid (string) or id (number) |
|
|
2314
2322
|
|
|
2315
2323
|
**Example**
|
|
2316
2324
|
```js
|
|
@@ -2333,14 +2341,14 @@ balena.models.application.trackLatestRelease('myorganization/myapp', function(er
|
|
|
2333
2341
|
```
|
|
2334
2342
|
<a name="balena.models.application.enableDeviceUrls"></a>
|
|
2335
2343
|
|
|
2336
|
-
##### application.enableDeviceUrls(
|
|
2344
|
+
##### application.enableDeviceUrls(slugOrUuidOrId) ⇒ <code>Promise</code>
|
|
2337
2345
|
**Kind**: static method of [<code>application</code>](#balena.models.application)
|
|
2338
2346
|
**Summary**: Enable device urls for all devices that belong to an application
|
|
2339
2347
|
**Access**: public
|
|
2340
2348
|
|
|
2341
2349
|
| Param | Type | Description |
|
|
2342
2350
|
| --- | --- | --- |
|
|
2343
|
-
|
|
|
2351
|
+
| slugOrUuidOrId | <code>String</code> \| <code>Number</code> | application slug (string), uuid (string) or id (number) |
|
|
2344
2352
|
|
|
2345
2353
|
**Example**
|
|
2346
2354
|
```js
|
|
@@ -2358,14 +2366,14 @@ balena.models.device.enableDeviceUrls('myorganization/myapp', function(error) {
|
|
|
2358
2366
|
```
|
|
2359
2367
|
<a name="balena.models.application.disableDeviceUrls"></a>
|
|
2360
2368
|
|
|
2361
|
-
##### application.disableDeviceUrls(
|
|
2369
|
+
##### application.disableDeviceUrls(slugOrUuidOrId) ⇒ <code>Promise</code>
|
|
2362
2370
|
**Kind**: static method of [<code>application</code>](#balena.models.application)
|
|
2363
2371
|
**Summary**: Disable device urls for all devices that belong to an application
|
|
2364
2372
|
**Access**: public
|
|
2365
2373
|
|
|
2366
2374
|
| Param | Type | Description |
|
|
2367
2375
|
| --- | --- | --- |
|
|
2368
|
-
|
|
|
2376
|
+
| slugOrUuidOrId | <code>String</code> \| <code>Number</code> | application slug (string), uuid (string) or id (number) |
|
|
2369
2377
|
|
|
2370
2378
|
**Example**
|
|
2371
2379
|
```js
|
|
@@ -2383,14 +2391,14 @@ balena.models.device.disableDeviceUrls('myorganization/myapp', function(error) {
|
|
|
2383
2391
|
```
|
|
2384
2392
|
<a name="balena.models.application.grantSupportAccess"></a>
|
|
2385
2393
|
|
|
2386
|
-
##### application.grantSupportAccess(
|
|
2394
|
+
##### application.grantSupportAccess(slugOrUuidOrId, expiryTimestamp) ⇒ <code>Promise</code>
|
|
2387
2395
|
**Kind**: static method of [<code>application</code>](#balena.models.application)
|
|
2388
2396
|
**Summary**: Grant support access to an application until a specified time
|
|
2389
2397
|
**Access**: public
|
|
2390
2398
|
|
|
2391
2399
|
| Param | Type | Description |
|
|
2392
2400
|
| --- | --- | --- |
|
|
2393
|
-
|
|
|
2401
|
+
| slugOrUuidOrId | <code>String</code> \| <code>Number</code> | application slug (string), uuid (string) or id (number) |
|
|
2394
2402
|
| expiryTimestamp | <code>Number</code> | a timestamp in ms for when the support access will expire |
|
|
2395
2403
|
|
|
2396
2404
|
**Example**
|
|
@@ -2409,14 +2417,14 @@ balena.models.application.grantSupportAccess('myorganization/myapp', Date.now()
|
|
|
2409
2417
|
```
|
|
2410
2418
|
<a name="balena.models.application.revokeSupportAccess"></a>
|
|
2411
2419
|
|
|
2412
|
-
##### application.revokeSupportAccess(
|
|
2420
|
+
##### application.revokeSupportAccess(slugOrUuidOrId) ⇒ <code>Promise</code>
|
|
2413
2421
|
**Kind**: static method of [<code>application</code>](#balena.models.application)
|
|
2414
2422
|
**Summary**: Revoke support access to an application
|
|
2415
2423
|
**Access**: public
|
|
2416
2424
|
|
|
2417
2425
|
| Param | Type | Description |
|
|
2418
2426
|
| --- | --- | --- |
|
|
2419
|
-
|
|
|
2427
|
+
| slugOrUuidOrId | <code>String</code> \| <code>Number</code> | application slug (string), uuid (string) or id (number) |
|
|
2420
2428
|
|
|
2421
2429
|
**Example**
|
|
2422
2430
|
```js
|
|
@@ -2439,32 +2447,32 @@ balena.models.application.revokeSupportAccess('myorganization/myapp', function(e
|
|
|
2439
2447
|
|
|
2440
2448
|
* [.device](#balena.models.device) : <code>object</code>
|
|
2441
2449
|
* [.tags](#balena.models.device.tags) : <code>object</code>
|
|
2442
|
-
* [.getAllByApplication(
|
|
2450
|
+
* [.getAllByApplication(slugOrUuidOrId, [options])](#balena.models.device.tags.getAllByApplication) ⇒ <code>Promise</code>
|
|
2443
2451
|
* [.getAllByDevice(uuidOrId, [options])](#balena.models.device.tags.getAllByDevice) ⇒ <code>Promise</code>
|
|
2444
2452
|
* [.getAll([options])](#balena.models.device.tags.getAll) ⇒ <code>Promise</code>
|
|
2445
2453
|
* [.set(uuidOrId, tagKey, value)](#balena.models.device.tags.set) ⇒ <code>Promise</code>
|
|
2446
2454
|
* [.remove(uuidOrId, tagKey)](#balena.models.device.tags.remove) ⇒ <code>Promise</code>
|
|
2447
2455
|
* [.configVar](#balena.models.device.configVar) : <code>object</code>
|
|
2448
2456
|
* [.getAllByDevice(uuidOrId, [options])](#balena.models.device.configVar.getAllByDevice) ⇒ <code>Promise</code>
|
|
2449
|
-
* [.getAllByApplication(
|
|
2457
|
+
* [.getAllByApplication(slugOrUuidOrId, [options])](#balena.models.device.configVar.getAllByApplication) ⇒ <code>Promise</code>
|
|
2450
2458
|
* [.get(uuidOrId, key)](#balena.models.device.configVar.get) ⇒ <code>Promise</code>
|
|
2451
2459
|
* [.set(uuidOrId, key, value)](#balena.models.device.configVar.set) ⇒ <code>Promise</code>
|
|
2452
2460
|
* [.remove(uuidOrId, key)](#balena.models.device.configVar.remove) ⇒ <code>Promise</code>
|
|
2453
2461
|
* [.envVar](#balena.models.device.envVar) : <code>object</code>
|
|
2454
2462
|
* [.getAllByDevice(uuidOrId, [options])](#balena.models.device.envVar.getAllByDevice) ⇒ <code>Promise</code>
|
|
2455
|
-
* [.getAllByApplication(
|
|
2463
|
+
* [.getAllByApplication(slugOrUuidOrId, [options])](#balena.models.device.envVar.getAllByApplication) ⇒ <code>Promise</code>
|
|
2456
2464
|
* [.get(uuidOrId, key)](#balena.models.device.envVar.get) ⇒ <code>Promise</code>
|
|
2457
2465
|
* [.set(uuidOrId, key, value)](#balena.models.device.envVar.set) ⇒ <code>Promise</code>
|
|
2458
2466
|
* [.remove(uuidOrId, key)](#balena.models.device.envVar.remove) ⇒ <code>Promise</code>
|
|
2459
2467
|
* [.serviceVar](#balena.models.device.serviceVar) : <code>object</code>
|
|
2460
2468
|
* [.getAllByDevice(uuidOrId, [options])](#balena.models.device.serviceVar.getAllByDevice) ⇒ <code>Promise</code>
|
|
2461
|
-
* [.getAllByApplication(
|
|
2469
|
+
* [.getAllByApplication(slugOrUuidOrId, [options])](#balena.models.device.serviceVar.getAllByApplication) ⇒ <code>Promise</code>
|
|
2462
2470
|
* [.get(uuidOrId, id, key)](#balena.models.device.serviceVar.get) ⇒ <code>Promise</code>
|
|
2463
2471
|
* [.set(uuidOrId, id, key, value)](#balena.models.device.serviceVar.set) ⇒ <code>Promise</code>
|
|
2464
2472
|
* [.remove(uuidOrId, id, key)](#balena.models.device.serviceVar.remove) ⇒ <code>Promise</code>
|
|
2465
2473
|
* [.getDashboardUrl(uuid)](#balena.models.device.getDashboardUrl) ⇒ <code>String</code>
|
|
2466
2474
|
* [.getAll([options])](#balena.models.device.getAll) ⇒ <code>Promise</code>
|
|
2467
|
-
* [.getAllByApplication(
|
|
2475
|
+
* [.getAllByApplication(slugOrUuidOrId, [options])](#balena.models.device.getAllByApplication) ⇒ <code>Promise</code>
|
|
2468
2476
|
* [.getAllByParentDevice(parentUuidOrId, [options])](#balena.models.device.getAllByParentDevice) ⇒ <code>Promise</code>
|
|
2469
2477
|
* [.get(uuidOrId, [options])](#balena.models.device.get) ⇒ <code>Promise</code>
|
|
2470
2478
|
* [.getWithServiceDetails(uuidOrId, [options])](#balena.models.device.getWithServiceDetails) ⇒ <code>Promise</code>
|
|
@@ -2482,13 +2490,13 @@ balena.models.application.revokeSupportAccess('myorganization/myapp', function(e
|
|
|
2482
2490
|
* [.note(uuidOrId, note)](#balena.models.device.note) ⇒ <code>Promise</code>
|
|
2483
2491
|
* [.setCustomLocation(uuidOrId, location)](#balena.models.device.setCustomLocation) ⇒ <code>Promise</code>
|
|
2484
2492
|
* [.unsetCustomLocation(uuidOrId)](#balena.models.device.unsetCustomLocation) ⇒ <code>Promise</code>
|
|
2485
|
-
* [.move(uuidOrId,
|
|
2493
|
+
* [.move(uuidOrId, applicationSlugOrUuidOrId)](#balena.models.device.move) ⇒ <code>Promise</code>
|
|
2486
2494
|
* [.restartApplication(uuidOrId)](#balena.models.device.restartApplication) ⇒ <code>Promise</code>
|
|
2487
2495
|
* [.getSupervisorTargetState(uuidOrId)](#balena.models.device.getSupervisorTargetState) ⇒ <code>Promise</code>
|
|
2488
2496
|
* ~~[.getManifestBySlug(slugOrName)](#balena.models.device.getManifestBySlug) ⇒ <code>Promise</code>~~
|
|
2489
|
-
* [.getManifestByApplication(
|
|
2497
|
+
* ~~[.getManifestByApplication(slugOrUuidOrId)](#balena.models.device.getManifestByApplication) ⇒ <code>Promise</code>~~
|
|
2490
2498
|
* [.generateUniqueKey()](#balena.models.device.generateUniqueKey) ⇒ <code>String</code>
|
|
2491
|
-
* [.register(
|
|
2499
|
+
* [.register(applicationSlugOrUuidOrId, uuid)](#balena.models.device.register) ⇒ <code>Promise</code>
|
|
2492
2500
|
* [.generateDeviceKey(uuidOrId)](#balena.models.device.generateDeviceKey) ⇒ <code>Promise</code>
|
|
2493
2501
|
* [.hasDeviceUrl(uuidOrId)](#balena.models.device.hasDeviceUrl) ⇒ <code>Promise</code>
|
|
2494
2502
|
* [.getDeviceUrl(uuidOrId)](#balena.models.device.getDeviceUrl) ⇒ <code>Promise</code>
|
|
@@ -2534,7 +2542,7 @@ balena.models.application.revokeSupportAccess('myorganization/myapp', function(e
|
|
|
2534
2542
|
**Kind**: static namespace of [<code>device</code>](#balena.models.device)
|
|
2535
2543
|
|
|
2536
2544
|
* [.tags](#balena.models.device.tags) : <code>object</code>
|
|
2537
|
-
* [.getAllByApplication(
|
|
2545
|
+
* [.getAllByApplication(slugOrUuidOrId, [options])](#balena.models.device.tags.getAllByApplication) ⇒ <code>Promise</code>
|
|
2538
2546
|
* [.getAllByDevice(uuidOrId, [options])](#balena.models.device.tags.getAllByDevice) ⇒ <code>Promise</code>
|
|
2539
2547
|
* [.getAll([options])](#balena.models.device.tags.getAll) ⇒ <code>Promise</code>
|
|
2540
2548
|
* [.set(uuidOrId, tagKey, value)](#balena.models.device.tags.set) ⇒ <code>Promise</code>
|
|
@@ -2542,7 +2550,7 @@ balena.models.application.revokeSupportAccess('myorganization/myapp', function(e
|
|
|
2542
2550
|
|
|
2543
2551
|
<a name="balena.models.device.tags.getAllByApplication"></a>
|
|
2544
2552
|
|
|
2545
|
-
###### tags.getAllByApplication(
|
|
2553
|
+
###### tags.getAllByApplication(slugOrUuidOrId, [options]) ⇒ <code>Promise</code>
|
|
2546
2554
|
**Kind**: static method of [<code>tags</code>](#balena.models.device.tags)
|
|
2547
2555
|
**Summary**: Get all device tags for an application
|
|
2548
2556
|
**Access**: public
|
|
@@ -2550,7 +2558,7 @@ balena.models.application.revokeSupportAccess('myorganization/myapp', function(e
|
|
|
2550
2558
|
|
|
2551
2559
|
| Param | Type | Default | Description |
|
|
2552
2560
|
| --- | --- | --- | --- |
|
|
2553
|
-
|
|
|
2561
|
+
| slugOrUuidOrId | <code>String</code> \| <code>Number</code> | | application slug (string), uuid (string) or id (number) |
|
|
2554
2562
|
| [options] | <code>Object</code> | <code>{}</code> | extra pine options to use |
|
|
2555
2563
|
|
|
2556
2564
|
**Example**
|
|
@@ -2685,7 +2693,7 @@ balena.models.device.tags.remove('7cf02a6', 'EDITOR', function(error) {
|
|
|
2685
2693
|
|
|
2686
2694
|
* [.configVar](#balena.models.device.configVar) : <code>object</code>
|
|
2687
2695
|
* [.getAllByDevice(uuidOrId, [options])](#balena.models.device.configVar.getAllByDevice) ⇒ <code>Promise</code>
|
|
2688
|
-
* [.getAllByApplication(
|
|
2696
|
+
* [.getAllByApplication(slugOrUuidOrId, [options])](#balena.models.device.configVar.getAllByApplication) ⇒ <code>Promise</code>
|
|
2689
2697
|
* [.get(uuidOrId, key)](#balena.models.device.configVar.get) ⇒ <code>Promise</code>
|
|
2690
2698
|
* [.set(uuidOrId, key, value)](#balena.models.device.configVar.set) ⇒ <code>Promise</code>
|
|
2691
2699
|
* [.remove(uuidOrId, key)](#balena.models.device.configVar.remove) ⇒ <code>Promise</code>
|
|
@@ -2724,7 +2732,7 @@ balena.models.device.configVar.getAllByDevice('7cf02a6', function(error, vars) {
|
|
|
2724
2732
|
```
|
|
2725
2733
|
<a name="balena.models.device.configVar.getAllByApplication"></a>
|
|
2726
2734
|
|
|
2727
|
-
###### configVar.getAllByApplication(
|
|
2735
|
+
###### configVar.getAllByApplication(slugOrUuidOrId, [options]) ⇒ <code>Promise</code>
|
|
2728
2736
|
**Kind**: static method of [<code>configVar</code>](#balena.models.device.configVar)
|
|
2729
2737
|
**Summary**: Get all device config variables by application
|
|
2730
2738
|
**Access**: public
|
|
@@ -2732,7 +2740,7 @@ balena.models.device.configVar.getAllByDevice('7cf02a6', function(error, vars) {
|
|
|
2732
2740
|
|
|
2733
2741
|
| Param | Type | Default | Description |
|
|
2734
2742
|
| --- | --- | --- | --- |
|
|
2735
|
-
|
|
|
2743
|
+
| slugOrUuidOrId | <code>String</code> \| <code>Number</code> | | application slug (string), uuid (string) or id (number) |
|
|
2736
2744
|
| [options] | <code>Object</code> | <code>{}</code> | extra pine options to use |
|
|
2737
2745
|
|
|
2738
2746
|
**Example**
|
|
@@ -2856,7 +2864,7 @@ balena.models.device.configVar.remove('7cf02a6', 'BALENA_VAR', function(error) {
|
|
|
2856
2864
|
|
|
2857
2865
|
* [.envVar](#balena.models.device.envVar) : <code>object</code>
|
|
2858
2866
|
* [.getAllByDevice(uuidOrId, [options])](#balena.models.device.envVar.getAllByDevice) ⇒ <code>Promise</code>
|
|
2859
|
-
* [.getAllByApplication(
|
|
2867
|
+
* [.getAllByApplication(slugOrUuidOrId, [options])](#balena.models.device.envVar.getAllByApplication) ⇒ <code>Promise</code>
|
|
2860
2868
|
* [.get(uuidOrId, key)](#balena.models.device.envVar.get) ⇒ <code>Promise</code>
|
|
2861
2869
|
* [.set(uuidOrId, key, value)](#balena.models.device.envVar.set) ⇒ <code>Promise</code>
|
|
2862
2870
|
* [.remove(uuidOrId, key)](#balena.models.device.envVar.remove) ⇒ <code>Promise</code>
|
|
@@ -2895,7 +2903,7 @@ balena.models.device.envVar.getAllByDevice('7cf02a6', function(error, vars) {
|
|
|
2895
2903
|
```
|
|
2896
2904
|
<a name="balena.models.device.envVar.getAllByApplication"></a>
|
|
2897
2905
|
|
|
2898
|
-
###### envVar.getAllByApplication(
|
|
2906
|
+
###### envVar.getAllByApplication(slugOrUuidOrId, [options]) ⇒ <code>Promise</code>
|
|
2899
2907
|
**Kind**: static method of [<code>envVar</code>](#balena.models.device.envVar)
|
|
2900
2908
|
**Summary**: Get all device environment variables by application
|
|
2901
2909
|
**Access**: public
|
|
@@ -2903,7 +2911,7 @@ balena.models.device.envVar.getAllByDevice('7cf02a6', function(error, vars) {
|
|
|
2903
2911
|
|
|
2904
2912
|
| Param | Type | Default | Description |
|
|
2905
2913
|
| --- | --- | --- | --- |
|
|
2906
|
-
|
|
|
2914
|
+
| slugOrUuidOrId | <code>String</code> \| <code>Number</code> | | application slug (string), uuid (string) or id (number) |
|
|
2907
2915
|
| [options] | <code>Object</code> | <code>{}</code> | extra pine options to use |
|
|
2908
2916
|
|
|
2909
2917
|
**Example**
|
|
@@ -3027,7 +3035,7 @@ balena.models.device.envVar.remove('7cf02a6', 'VAR', function(error) {
|
|
|
3027
3035
|
|
|
3028
3036
|
* [.serviceVar](#balena.models.device.serviceVar) : <code>object</code>
|
|
3029
3037
|
* [.getAllByDevice(uuidOrId, [options])](#balena.models.device.serviceVar.getAllByDevice) ⇒ <code>Promise</code>
|
|
3030
|
-
* [.getAllByApplication(
|
|
3038
|
+
* [.getAllByApplication(slugOrUuidOrId, [options])](#balena.models.device.serviceVar.getAllByApplication) ⇒ <code>Promise</code>
|
|
3031
3039
|
* [.get(uuidOrId, id, key)](#balena.models.device.serviceVar.get) ⇒ <code>Promise</code>
|
|
3032
3040
|
* [.set(uuidOrId, id, key, value)](#balena.models.device.serviceVar.set) ⇒ <code>Promise</code>
|
|
3033
3041
|
* [.remove(uuidOrId, id, key)](#balena.models.device.serviceVar.remove) ⇒ <code>Promise</code>
|
|
@@ -3066,7 +3074,7 @@ balena.models.device.serviceVar.getAllByDevice('7cf02a6', function(error, vars)
|
|
|
3066
3074
|
```
|
|
3067
3075
|
<a name="balena.models.device.serviceVar.getAllByApplication"></a>
|
|
3068
3076
|
|
|
3069
|
-
###### serviceVar.getAllByApplication(
|
|
3077
|
+
###### serviceVar.getAllByApplication(slugOrUuidOrId, [options]) ⇒ <code>Promise</code>
|
|
3070
3078
|
**Kind**: static method of [<code>serviceVar</code>](#balena.models.device.serviceVar)
|
|
3071
3079
|
**Summary**: Get all device service variable overrides by application
|
|
3072
3080
|
**Access**: public
|
|
@@ -3074,7 +3082,7 @@ balena.models.device.serviceVar.getAllByDevice('7cf02a6', function(error, vars)
|
|
|
3074
3082
|
|
|
3075
3083
|
| Param | Type | Default | Description |
|
|
3076
3084
|
| --- | --- | --- | --- |
|
|
3077
|
-
|
|
|
3085
|
+
| slugOrUuidOrId | <code>String</code> \| <code>Number</code> | | application slug (string), uuid (string) or id (number) |
|
|
3078
3086
|
| [options] | <code>Object</code> | <code>{}</code> | extra pine options to use |
|
|
3079
3087
|
|
|
3080
3088
|
**Example**
|
|
@@ -3252,7 +3260,7 @@ balena.models.device.getAll(function(error, devices) {
|
|
|
3252
3260
|
```
|
|
3253
3261
|
<a name="balena.models.device.getAllByApplication"></a>
|
|
3254
3262
|
|
|
3255
|
-
##### device.getAllByApplication(
|
|
3263
|
+
##### device.getAllByApplication(slugOrUuidOrId, [options]) ⇒ <code>Promise</code>
|
|
3256
3264
|
This method returns all devices of a specific application.
|
|
3257
3265
|
In order to have the following computed properties in the result
|
|
3258
3266
|
you have to explicitly define them in a `$select` in the extra options:
|
|
@@ -3266,7 +3274,7 @@ you have to explicitly define them in a `$select` in the extra options:
|
|
|
3266
3274
|
|
|
3267
3275
|
| Param | Type | Default | Description |
|
|
3268
3276
|
| --- | --- | --- | --- |
|
|
3269
|
-
|
|
|
3277
|
+
| slugOrUuidOrId | <code>String</code> \| <code>Number</code> | | application slug (string), uuid (string) or id (number) |
|
|
3270
3278
|
| [options] | <code>Object</code> | <code>{}</code> | extra pine options to use |
|
|
3271
3279
|
|
|
3272
3280
|
**Example**
|
|
@@ -3821,7 +3829,7 @@ balena.models.device.unsetLocation('7cf02a6', function(error) {
|
|
|
3821
3829
|
```
|
|
3822
3830
|
<a name="balena.models.device.move"></a>
|
|
3823
3831
|
|
|
3824
|
-
##### device.move(uuidOrId,
|
|
3832
|
+
##### device.move(uuidOrId, applicationSlugOrUuidOrId) ⇒ <code>Promise</code>
|
|
3825
3833
|
**Kind**: static method of [<code>device</code>](#balena.models.device)
|
|
3826
3834
|
**Summary**: Move a device to another application
|
|
3827
3835
|
**Access**: public
|
|
@@ -3829,7 +3837,7 @@ balena.models.device.unsetLocation('7cf02a6', function(error) {
|
|
|
3829
3837
|
| Param | Type | Description |
|
|
3830
3838
|
| --- | --- | --- |
|
|
3831
3839
|
| uuidOrId | <code>String</code> \| <code>Number</code> | device uuid (string) or id (number) |
|
|
3832
|
-
|
|
|
3840
|
+
| applicationSlugOrUuidOrId | <code>String</code> \| <code>Number</code> | application slug (string), uuid (string) or id (number) |
|
|
3833
3841
|
|
|
3834
3842
|
**Example**
|
|
3835
3843
|
```js
|
|
@@ -3914,13 +3922,13 @@ balena.models.device.getSupervisorTargetState('7cf02a6', function(error, state)
|
|
|
3914
3922
|
***Deprecated***
|
|
3915
3923
|
|
|
3916
3924
|
**Kind**: static method of [<code>device</code>](#balena.models.device)
|
|
3917
|
-
**Summary**: Get a device manifest by slug
|
|
3925
|
+
**Summary**: Get a device type manifest by slug
|
|
3918
3926
|
**Access**: public
|
|
3919
|
-
**Fulfil**: <code>Object</code> - device manifest
|
|
3927
|
+
**Fulfil**: <code>Object</code> - device type manifest
|
|
3920
3928
|
|
|
3921
3929
|
| Param | Type | Description |
|
|
3922
3930
|
| --- | --- | --- |
|
|
3923
|
-
| slugOrName | <code>String</code> | device slug |
|
|
3931
|
+
| slugOrName | <code>String</code> | device type slug |
|
|
3924
3932
|
|
|
3925
3933
|
**Example**
|
|
3926
3934
|
```js
|
|
@@ -3937,7 +3945,9 @@ balena.models.device.getManifestBySlug('raspberry-pi', function(error, manifest)
|
|
|
3937
3945
|
```
|
|
3938
3946
|
<a name="balena.models.device.getManifestByApplication"></a>
|
|
3939
3947
|
|
|
3940
|
-
##### device.getManifestByApplication(
|
|
3948
|
+
##### ~~device.getManifestByApplication(slugOrUuidOrId) ⇒ <code>Promise</code>~~
|
|
3949
|
+
***Deprecated***
|
|
3950
|
+
|
|
3941
3951
|
**Kind**: static method of [<code>device</code>](#balena.models.device)
|
|
3942
3952
|
**Summary**: Get a device manifest by application name
|
|
3943
3953
|
**Access**: public
|
|
@@ -3945,7 +3955,7 @@ balena.models.device.getManifestBySlug('raspberry-pi', function(error, manifest)
|
|
|
3945
3955
|
|
|
3946
3956
|
| Param | Type | Description |
|
|
3947
3957
|
| --- | --- | --- |
|
|
3948
|
-
|
|
|
3958
|
+
| slugOrUuidOrId | <code>String</code> \| <code>Number</code> | application slug (string), uuid (string) or id (number) |
|
|
3949
3959
|
|
|
3950
3960
|
**Example**
|
|
3951
3961
|
```js
|
|
@@ -3981,7 +3991,7 @@ console.log(randomKey);
|
|
|
3981
3991
|
```
|
|
3982
3992
|
<a name="balena.models.device.register"></a>
|
|
3983
3993
|
|
|
3984
|
-
##### device.register(
|
|
3994
|
+
##### device.register(applicationSlugOrUuidOrId, uuid) ⇒ <code>Promise</code>
|
|
3985
3995
|
**Kind**: static method of [<code>device</code>](#balena.models.device)
|
|
3986
3996
|
**Summary**: Register a new device with a Balena application.
|
|
3987
3997
|
**Access**: public
|
|
@@ -3989,7 +3999,7 @@ console.log(randomKey);
|
|
|
3989
3999
|
|
|
3990
4000
|
| Param | Type | Description |
|
|
3991
4001
|
| --- | --- | --- |
|
|
3992
|
-
|
|
|
4002
|
+
| applicationSlugOrUuidOrId | <code>String</code> \| <code>Number</code> | application slug (string), uuid (string) or id (number) |
|
|
3993
4003
|
| uuid | <code>String</code> | device uuid |
|
|
3994
4004
|
|
|
3995
4005
|
**Example**
|
|
@@ -5286,7 +5296,7 @@ balena.models.deviceType.getSlugByName('Raspberry Pi', function(error, deviceTyp
|
|
|
5286
5296
|
* [.create(name, [description])](#balena.models.apiKey.create) ⇒ <code>Promise</code>
|
|
5287
5297
|
* [.getAll([options])](#balena.models.apiKey.getAll) ⇒ <code>Promise</code>
|
|
5288
5298
|
* [.getAllNamedUserApiKeys([options])](#balena.models.apiKey.getAllNamedUserApiKeys) ⇒ <code>Promise</code>
|
|
5289
|
-
* [.getProvisioningApiKeysByApplication(
|
|
5299
|
+
* [.getProvisioningApiKeysByApplication(slugOrUuidOrId, [options])](#balena.models.apiKey.getProvisioningApiKeysByApplication) ⇒ <code>Promise</code>
|
|
5290
5300
|
* [.getDeviceApiKeysByDevice(uuidOrId, [options])](#balena.models.apiKey.getDeviceApiKeysByDevice) ⇒ <code>Promise</code>
|
|
5291
5301
|
* [.update(id, apiKeyInfo)](#balena.models.apiKey.update) ⇒ <code>Promise</code>
|
|
5292
5302
|
* [.revoke(id)](#balena.models.apiKey.revoke) ⇒ <code>Promise</code>
|
|
@@ -5377,7 +5387,7 @@ balena.models.apiKey.getAllNamedUserApiKeys(function(error, apiKeys) {
|
|
|
5377
5387
|
```
|
|
5378
5388
|
<a name="balena.models.apiKey.getProvisioningApiKeysByApplication"></a>
|
|
5379
5389
|
|
|
5380
|
-
##### apiKey.getProvisioningApiKeysByApplication(
|
|
5390
|
+
##### apiKey.getProvisioningApiKeysByApplication(slugOrUuidOrId, [options]) ⇒ <code>Promise</code>
|
|
5381
5391
|
**Kind**: static method of [<code>apiKey</code>](#balena.models.apiKey)
|
|
5382
5392
|
**Summary**: Get all provisioning API keys for an application
|
|
5383
5393
|
**Access**: public
|
|
@@ -5385,7 +5395,7 @@ balena.models.apiKey.getAllNamedUserApiKeys(function(error, apiKeys) {
|
|
|
5385
5395
|
|
|
5386
5396
|
| Param | Type | Default | Description |
|
|
5387
5397
|
| --- | --- | --- | --- |
|
|
5388
|
-
|
|
|
5398
|
+
| slugOrUuidOrId | <code>String</code> \| <code>Number</code> | | application slug (string), uuid (string) or id (number) |
|
|
5389
5399
|
| [options] | <code>Object</code> | <code>{}</code> | extra pine options to use |
|
|
5390
5400
|
|
|
5391
5401
|
**Example**
|
|
@@ -6069,7 +6079,7 @@ balena.models.organization.remove(123, function(error) {
|
|
|
6069
6079
|
* [.getMaxSatisfyingVersion(deviceType, versionOrRange, [osType])](#balena.models.os.getMaxSatisfyingVersion) ⇒ <code>Promise</code>
|
|
6070
6080
|
* [.getLastModified(deviceType, [version])](#balena.models.os.getLastModified) ⇒ <code>Promise</code>
|
|
6071
6081
|
* [.download(deviceType, [version], options)](#balena.models.os.download) ⇒ <code>Promise</code>
|
|
6072
|
-
* [.getConfig(
|
|
6082
|
+
* [.getConfig(slugOrUuidOrId, options)](#balena.models.os.getConfig) ⇒ <code>Promise</code>
|
|
6073
6083
|
* [.isSupportedOsUpdate(deviceType, currentVersion, targetVersion)](#balena.models.os.isSupportedOsUpdate) ⇒ <code>Promise</code>
|
|
6074
6084
|
* [.getSupportedOsUpdateVersions(deviceType, currentVersion)](#balena.models.os.getSupportedOsUpdateVersions) ⇒ <code>Promise</code>
|
|
6075
6085
|
* [.isArchitectureCompatibleWith(osArchitecture, applicationArchitecture)](#balena.models.os.isArchitectureCompatibleWith) ⇒ <code>Boolean</code>
|
|
@@ -6222,7 +6232,7 @@ balena.models.os.download('raspberry-pi', function(error, stream) {
|
|
|
6222
6232
|
```
|
|
6223
6233
|
<a name="balena.models.os.getConfig"></a>
|
|
6224
6234
|
|
|
6225
|
-
##### os.getConfig(
|
|
6235
|
+
##### os.getConfig(slugOrUuidOrId, options) ⇒ <code>Promise</code>
|
|
6226
6236
|
Builds the config.json for a device in the given application, with the given
|
|
6227
6237
|
options.
|
|
6228
6238
|
|
|
@@ -6236,7 +6246,7 @@ generation is only supported when using a session token, not an API key.
|
|
|
6236
6246
|
|
|
6237
6247
|
| Param | Type | Default | Description |
|
|
6238
6248
|
| --- | --- | --- | --- |
|
|
6239
|
-
|
|
|
6249
|
+
| slugOrUuidOrId | <code>String</code> \| <code>Number</code> | | application slug (string), uuid (string) or id (number). |
|
|
6240
6250
|
| options | <code>Object</code> | | OS configuration options to use. |
|
|
6241
6251
|
| options.version | <code>String</code> | | Required: the OS version of the image. |
|
|
6242
6252
|
| [options.network] | <code>String</code> | <code>'ethernet'</code> | The network type that the device will use, one of 'ethernet' or 'wifi'. |
|
|
@@ -6348,6 +6358,7 @@ console.log(result2);
|
|
|
6348
6358
|
* [.config](#balena.models.config) : <code>object</code>
|
|
6349
6359
|
* [.getAll()](#balena.models.config.getAll) ⇒ <code>Promise</code>
|
|
6350
6360
|
* ~~[.getDeviceTypes()](#balena.models.config.getDeviceTypes) ⇒ <code>Promise</code>~~
|
|
6361
|
+
* ~~[.getDeviceTypeManifestBySlug(slugOrName)](#balena.models.config.getDeviceTypeManifestBySlug) ⇒ <code>Promise</code>~~
|
|
6351
6362
|
* [.getDeviceOptions(deviceType)](#balena.models.config.getDeviceOptions) ⇒ <code>Promise</code>
|
|
6352
6363
|
* [.getConfigVarSchema(deviceType)](#balena.models.config.getConfigVarSchema) ⇒ <code>Promise</code>
|
|
6353
6364
|
|
|
@@ -6393,6 +6404,33 @@ balena.models.config.getDeviceTypes(function(error, deviceTypes) {
|
|
|
6393
6404
|
console.log(deviceTypes);
|
|
6394
6405
|
})
|
|
6395
6406
|
```
|
|
6407
|
+
<a name="balena.models.config.getDeviceTypeManifestBySlug"></a>
|
|
6408
|
+
|
|
6409
|
+
##### ~~config.getDeviceTypeManifestBySlug(slugOrName) ⇒ <code>Promise</code>~~
|
|
6410
|
+
***Deprecated***
|
|
6411
|
+
|
|
6412
|
+
**Kind**: static method of [<code>config</code>](#balena.models.config)
|
|
6413
|
+
**Summary**: Get a device type manifest by slug
|
|
6414
|
+
**Access**: public
|
|
6415
|
+
**Fulfil**: <code>Object</code> - device type manifest
|
|
6416
|
+
|
|
6417
|
+
| Param | Type | Description |
|
|
6418
|
+
| --- | --- | --- |
|
|
6419
|
+
| slugOrName | <code>String</code> | device type slug |
|
|
6420
|
+
|
|
6421
|
+
**Example**
|
|
6422
|
+
```js
|
|
6423
|
+
balena.models.config.getDeviceTypeManifestBySlug('raspberry-pi').then(function(manifest) {
|
|
6424
|
+
console.log(manifest);
|
|
6425
|
+
});
|
|
6426
|
+
```
|
|
6427
|
+
**Example**
|
|
6428
|
+
```js
|
|
6429
|
+
balena.models.config.getDeviceTypeManifestBySlug('raspberry-pi', function(error, manifest) {
|
|
6430
|
+
if (error) throw error;
|
|
6431
|
+
console.log(manifest);
|
|
6432
|
+
});
|
|
6433
|
+
```
|
|
6396
6434
|
<a name="balena.models.config.getDeviceOptions"></a>
|
|
6397
6435
|
|
|
6398
6436
|
##### config.getDeviceOptions(deviceType) ⇒ <code>Promise</code>
|
|
@@ -6450,16 +6488,16 @@ balena.models.config.getConfigVarSchema('raspberry-pi', function(error, options)
|
|
|
6450
6488
|
|
|
6451
6489
|
* [.release](#balena.models.release) : <code>object</code>
|
|
6452
6490
|
* [.tags](#balena.models.release.tags) : <code>object</code>
|
|
6453
|
-
* [.getAllByApplication(
|
|
6491
|
+
* [.getAllByApplication(slugOrUuidOrId, [options])](#balena.models.release.tags.getAllByApplication) ⇒ <code>Promise</code>
|
|
6454
6492
|
* [.getAllByRelease(commitOrId, [options])](#balena.models.release.tags.getAllByRelease) ⇒ <code>Promise</code>
|
|
6455
6493
|
* [.getAll([options])](#balena.models.release.tags.getAll) ⇒ <code>Promise</code>
|
|
6456
6494
|
* [.set(commitOrId, tagKey, value)](#balena.models.release.tags.set) ⇒ <code>Promise</code>
|
|
6457
6495
|
* [.remove(commitOrId, tagKey)](#balena.models.release.tags.remove) ⇒ <code>Promise</code>
|
|
6458
6496
|
* [.get(commitOrId, [options])](#balena.models.release.get) ⇒ <code>Promise</code>
|
|
6459
6497
|
* [.getWithImageDetails(commitOrId, [options])](#balena.models.release.getWithImageDetails) ⇒ <code>Promise</code>
|
|
6460
|
-
* [.getAllByApplication(
|
|
6461
|
-
* [.getLatestByApplication(
|
|
6462
|
-
* [.createFromUrl(
|
|
6498
|
+
* [.getAllByApplication(slugOrUuidOrId, [options])](#balena.models.release.getAllByApplication) ⇒ <code>Promise</code>
|
|
6499
|
+
* [.getLatestByApplication(slugOrUuidOrId, [options])](#balena.models.release.getLatestByApplication) ⇒ <code>Promise</code>
|
|
6500
|
+
* [.createFromUrl(slugOrUuidOrId, urlDeployOptions)](#balena.models.release.createFromUrl) ⇒ <code>Promise</code>
|
|
6463
6501
|
* [.finalize(commitOrId)](#balena.models.release.finalize) ⇒ <code>Promise</code>
|
|
6464
6502
|
* [.setIsInvalidated(commitOrId, isInvalidated)](#balena.models.release.setIsInvalidated) ⇒ <code>Promise</code>
|
|
6465
6503
|
* [.note(commitOrId, note)](#balena.models.release.note) ⇒ <code>Promise</code>
|
|
@@ -6470,7 +6508,7 @@ balena.models.config.getConfigVarSchema('raspberry-pi', function(error, options)
|
|
|
6470
6508
|
**Kind**: static namespace of [<code>release</code>](#balena.models.release)
|
|
6471
6509
|
|
|
6472
6510
|
* [.tags](#balena.models.release.tags) : <code>object</code>
|
|
6473
|
-
* [.getAllByApplication(
|
|
6511
|
+
* [.getAllByApplication(slugOrUuidOrId, [options])](#balena.models.release.tags.getAllByApplication) ⇒ <code>Promise</code>
|
|
6474
6512
|
* [.getAllByRelease(commitOrId, [options])](#balena.models.release.tags.getAllByRelease) ⇒ <code>Promise</code>
|
|
6475
6513
|
* [.getAll([options])](#balena.models.release.tags.getAll) ⇒ <code>Promise</code>
|
|
6476
6514
|
* [.set(commitOrId, tagKey, value)](#balena.models.release.tags.set) ⇒ <code>Promise</code>
|
|
@@ -6478,7 +6516,7 @@ balena.models.config.getConfigVarSchema('raspberry-pi', function(error, options)
|
|
|
6478
6516
|
|
|
6479
6517
|
<a name="balena.models.release.tags.getAllByApplication"></a>
|
|
6480
6518
|
|
|
6481
|
-
###### tags.getAllByApplication(
|
|
6519
|
+
###### tags.getAllByApplication(slugOrUuidOrId, [options]) ⇒ <code>Promise</code>
|
|
6482
6520
|
**Kind**: static method of [<code>tags</code>](#balena.models.release.tags)
|
|
6483
6521
|
**Summary**: Get all release tags for an application
|
|
6484
6522
|
**Access**: public
|
|
@@ -6486,7 +6524,7 @@ balena.models.config.getConfigVarSchema('raspberry-pi', function(error, options)
|
|
|
6486
6524
|
|
|
6487
6525
|
| Param | Type | Default | Description |
|
|
6488
6526
|
| --- | --- | --- | --- |
|
|
6489
|
-
|
|
|
6527
|
+
| slugOrUuidOrId | <code>String</code> \| <code>Number</code> | | application slug (string), uuid (string) or id (number) |
|
|
6490
6528
|
| [options] | <code>Object</code> | <code>{}</code> | extra pine options to use |
|
|
6491
6529
|
|
|
6492
6530
|
**Example**
|
|
@@ -6698,7 +6736,7 @@ balena.models.release.getWithImageDetails(123, function(error, release) {
|
|
|
6698
6736
|
```
|
|
6699
6737
|
<a name="balena.models.release.getAllByApplication"></a>
|
|
6700
6738
|
|
|
6701
|
-
##### release.getAllByApplication(
|
|
6739
|
+
##### release.getAllByApplication(slugOrUuidOrId, [options]) ⇒ <code>Promise</code>
|
|
6702
6740
|
**Kind**: static method of [<code>release</code>](#balena.models.release)
|
|
6703
6741
|
**Summary**: Get all releases from an application
|
|
6704
6742
|
**Access**: public
|
|
@@ -6706,7 +6744,7 @@ balena.models.release.getWithImageDetails(123, function(error, release) {
|
|
|
6706
6744
|
|
|
6707
6745
|
| Param | Type | Default | Description |
|
|
6708
6746
|
| --- | --- | --- | --- |
|
|
6709
|
-
|
|
|
6747
|
+
| slugOrUuidOrId | <code>String</code> \| <code>Number</code> | | application slug (string), uuid (string) or id (number) |
|
|
6710
6748
|
| [options] | <code>Object</code> | <code>{}</code> | extra pine options to use |
|
|
6711
6749
|
|
|
6712
6750
|
**Example**
|
|
@@ -6730,7 +6768,7 @@ balena.models.release.getAllByApplication('myorganization/myapp', function(error
|
|
|
6730
6768
|
```
|
|
6731
6769
|
<a name="balena.models.release.getLatestByApplication"></a>
|
|
6732
6770
|
|
|
6733
|
-
##### release.getLatestByApplication(
|
|
6771
|
+
##### release.getLatestByApplication(slugOrUuidOrId, [options]) ⇒ <code>Promise</code>
|
|
6734
6772
|
**Kind**: static method of [<code>release</code>](#balena.models.release)
|
|
6735
6773
|
**Summary**: Get the latest successful release for an application
|
|
6736
6774
|
**Access**: public
|
|
@@ -6738,7 +6776,7 @@ balena.models.release.getAllByApplication('myorganization/myapp', function(error
|
|
|
6738
6776
|
|
|
6739
6777
|
| Param | Type | Default | Description |
|
|
6740
6778
|
| --- | --- | --- | --- |
|
|
6741
|
-
|
|
|
6779
|
+
| slugOrUuidOrId | <code>String</code> \| <code>Number</code> | | application slug (string), uuid (string) or id (number) |
|
|
6742
6780
|
| [options] | <code>Object</code> | <code>{}</code> | extra pine options to use |
|
|
6743
6781
|
|
|
6744
6782
|
**Example**
|
|
@@ -6762,7 +6800,7 @@ balena.models.release.getLatestByApplication('myorganization/myapp', function(er
|
|
|
6762
6800
|
```
|
|
6763
6801
|
<a name="balena.models.release.createFromUrl"></a>
|
|
6764
6802
|
|
|
6765
|
-
##### release.createFromUrl(
|
|
6803
|
+
##### release.createFromUrl(slugOrUuidOrId, urlDeployOptions) ⇒ <code>Promise</code>
|
|
6766
6804
|
**Kind**: static method of [<code>release</code>](#balena.models.release)
|
|
6767
6805
|
**Summary**: Create a new release built from the source in the provided url
|
|
6768
6806
|
**Access**: public
|
|
@@ -6770,7 +6808,7 @@ balena.models.release.getLatestByApplication('myorganization/myapp', function(er
|
|
|
6770
6808
|
|
|
6771
6809
|
| Param | Type | Default | Description |
|
|
6772
6810
|
| --- | --- | --- | --- |
|
|
6773
|
-
|
|
|
6811
|
+
| slugOrUuidOrId | <code>String</code> \| <code>Number</code> | | application slug (string), uuid (string) or id (number) |
|
|
6774
6812
|
| urlDeployOptions | <code>Object</code> | | builder options |
|
|
6775
6813
|
| urlDeployOptions.url | <code>String</code> | | a url with a tarball of the project to build |
|
|
6776
6814
|
| [urlDeployOptions.shouldFlatten] | <code>Boolean</code> | <code>true</code> | Should be true when the tarball includes an extra root folder with all the content |
|
|
@@ -6883,11 +6921,11 @@ balena.models.release.note(123, 'My useful note');
|
|
|
6883
6921
|
* [.service](#balena.models.service) : <code>object</code>
|
|
6884
6922
|
* [.var](#balena.models.service.var) : <code>object</code>
|
|
6885
6923
|
* [.getAllByService(id, [options])](#balena.models.service.var.getAllByService) ⇒ <code>Promise</code>
|
|
6886
|
-
* [.getAllByApplication(
|
|
6924
|
+
* [.getAllByApplication(slugOrUuidOrId, [options])](#balena.models.service.var.getAllByApplication) ⇒ <code>Promise</code>
|
|
6887
6925
|
* [.get(id, key)](#balena.models.service.var.get) ⇒ <code>Promise</code>
|
|
6888
6926
|
* [.set(id, key, value)](#balena.models.service.var.set) ⇒ <code>Promise</code>
|
|
6889
6927
|
* [.remove(id, key)](#balena.models.service.var.remove) ⇒ <code>Promise</code>
|
|
6890
|
-
* [.getAllByApplication(
|
|
6928
|
+
* [.getAllByApplication(slugOrUuidOrId, [options])](#balena.models.service.getAllByApplication) ⇒ <code>Promise</code>
|
|
6891
6929
|
|
|
6892
6930
|
<a name="balena.models.service.var"></a>
|
|
6893
6931
|
|
|
@@ -6896,7 +6934,7 @@ balena.models.release.note(123, 'My useful note');
|
|
|
6896
6934
|
|
|
6897
6935
|
* [.var](#balena.models.service.var) : <code>object</code>
|
|
6898
6936
|
* [.getAllByService(id, [options])](#balena.models.service.var.getAllByService) ⇒ <code>Promise</code>
|
|
6899
|
-
* [.getAllByApplication(
|
|
6937
|
+
* [.getAllByApplication(slugOrUuidOrId, [options])](#balena.models.service.var.getAllByApplication) ⇒ <code>Promise</code>
|
|
6900
6938
|
* [.get(id, key)](#balena.models.service.var.get) ⇒ <code>Promise</code>
|
|
6901
6939
|
* [.set(id, key, value)](#balena.models.service.var.set) ⇒ <code>Promise</code>
|
|
6902
6940
|
* [.remove(id, key)](#balena.models.service.var.remove) ⇒ <code>Promise</code>
|
|
@@ -6929,7 +6967,7 @@ balena.models.service.var.getAllByService(999999, function(error, vars) {
|
|
|
6929
6967
|
```
|
|
6930
6968
|
<a name="balena.models.service.var.getAllByApplication"></a>
|
|
6931
6969
|
|
|
6932
|
-
###### var.getAllByApplication(
|
|
6970
|
+
###### var.getAllByApplication(slugOrUuidOrId, [options]) ⇒ <code>Promise</code>
|
|
6933
6971
|
**Kind**: static method of [<code>var</code>](#balena.models.service.var)
|
|
6934
6972
|
**Summary**: Get all service variables by application
|
|
6935
6973
|
**Access**: public
|
|
@@ -6937,7 +6975,7 @@ balena.models.service.var.getAllByService(999999, function(error, vars) {
|
|
|
6937
6975
|
|
|
6938
6976
|
| Param | Type | Default | Description |
|
|
6939
6977
|
| --- | --- | --- | --- |
|
|
6940
|
-
|
|
|
6978
|
+
| slugOrUuidOrId | <code>String</code> \| <code>Number</code> | | application slug (string), uuid (string) or id (number) |
|
|
6941
6979
|
| [options] | <code>Object</code> | <code>{}</code> | extra pine options to use |
|
|
6942
6980
|
|
|
6943
6981
|
**Example**
|
|
@@ -7038,7 +7076,7 @@ balena.models.service.var.remove(999999, 'VAR', function(error) {
|
|
|
7038
7076
|
```
|
|
7039
7077
|
<a name="balena.models.service.getAllByApplication"></a>
|
|
7040
7078
|
|
|
7041
|
-
##### service.getAllByApplication(
|
|
7079
|
+
##### service.getAllByApplication(slugOrUuidOrId, [options]) ⇒ <code>Promise</code>
|
|
7042
7080
|
**Kind**: static method of [<code>service</code>](#balena.models.service)
|
|
7043
7081
|
**Summary**: Get all services from an application
|
|
7044
7082
|
**Access**: public
|
|
@@ -7046,7 +7084,7 @@ balena.models.service.var.remove(999999, 'VAR', function(error) {
|
|
|
7046
7084
|
|
|
7047
7085
|
| Param | Type | Default | Description |
|
|
7048
7086
|
| --- | --- | --- | --- |
|
|
7049
|
-
|
|
|
7087
|
+
| slugOrUuidOrId | <code>String</code> \| <code>Number</code> | | application slug (string), uuid (string) or id (number) |
|
|
7050
7088
|
| [options] | <code>Object</code> | <code>{}</code> | extra pine options to use |
|
|
7051
7089
|
|
|
7052
7090
|
**Example**
|