balena-sdk 16.9.3 → 16.10.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 -1
- package/DOCUMENTATION.md +290 -284
- package/es2015/balena-browser.js +176 -177
- package/es2015/balena-browser.min.js +1 -1
- package/es2015/index.d.ts +39 -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 +104 -103
- package/es2015/models/device.d.ts +16 -16
- package/es2015/models/device.js +26 -26
- package/es2015/models/index.d.ts +38 -38
- package/es2015/models/os.d.ts +1 -1
- package/es2015/models/os.js +13 -15
- 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 +176 -177
- package/es2018/balena-browser.min.js +1 -1
- package/es2018/index.d.ts +39 -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 +104 -103
- package/es2018/models/device.d.ts +16 -16
- package/es2018/models/device.js +26 -26
- package/es2018/models/index.d.ts +38 -38
- package/es2018/models/os.d.ts +1 -1
- package/es2018/models/os.js +13 -15
- 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,7 +302,7 @@ 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>
|
|
@@ -313,27 +313,27 @@ const sdk = fromSharedOptions();
|
|
|
313
313
|
* [.getConfigVarSchema(deviceType)](#balena.models.config.getConfigVarSchema) ⇒ <code>Promise</code>
|
|
314
314
|
* [.release](#balena.models.release) : <code>object</code>
|
|
315
315
|
* [.tags](#balena.models.release.tags) : <code>object</code>
|
|
316
|
-
* [.getAllByApplication(
|
|
316
|
+
* [.getAllByApplication(slugOrUuidOrId, [options])](#balena.models.release.tags.getAllByApplication) ⇒ <code>Promise</code>
|
|
317
317
|
* [.getAllByRelease(commitOrId, [options])](#balena.models.release.tags.getAllByRelease) ⇒ <code>Promise</code>
|
|
318
318
|
* [.getAll([options])](#balena.models.release.tags.getAll) ⇒ <code>Promise</code>
|
|
319
319
|
* [.set(commitOrId, tagKey, value)](#balena.models.release.tags.set) ⇒ <code>Promise</code>
|
|
320
320
|
* [.remove(commitOrId, tagKey)](#balena.models.release.tags.remove) ⇒ <code>Promise</code>
|
|
321
321
|
* [.get(commitOrId, [options])](#balena.models.release.get) ⇒ <code>Promise</code>
|
|
322
322
|
* [.getWithImageDetails(commitOrId, [options])](#balena.models.release.getWithImageDetails) ⇒ <code>Promise</code>
|
|
323
|
-
* [.getAllByApplication(
|
|
324
|
-
* [.getLatestByApplication(
|
|
325
|
-
* [.createFromUrl(
|
|
323
|
+
* [.getAllByApplication(slugOrUuidOrId, [options])](#balena.models.release.getAllByApplication) ⇒ <code>Promise</code>
|
|
324
|
+
* [.getLatestByApplication(slugOrUuidOrId, [options])](#balena.models.release.getLatestByApplication) ⇒ <code>Promise</code>
|
|
325
|
+
* [.createFromUrl(slugOrUuidOrId, urlDeployOptions)](#balena.models.release.createFromUrl) ⇒ <code>Promise</code>
|
|
326
326
|
* [.finalize(commitOrId)](#balena.models.release.finalize) ⇒ <code>Promise</code>
|
|
327
327
|
* [.setIsInvalidated(commitOrId, isInvalidated)](#balena.models.release.setIsInvalidated) ⇒ <code>Promise</code>
|
|
328
328
|
* [.note(commitOrId, note)](#balena.models.release.note) ⇒ <code>Promise</code>
|
|
329
329
|
* [.service](#balena.models.service) : <code>object</code>
|
|
330
330
|
* [.var](#balena.models.service.var) : <code>object</code>
|
|
331
331
|
* [.getAllByService(id, [options])](#balena.models.service.var.getAllByService) ⇒ <code>Promise</code>
|
|
332
|
-
* [.getAllByApplication(
|
|
332
|
+
* [.getAllByApplication(slugOrUuidOrId, [options])](#balena.models.service.var.getAllByApplication) ⇒ <code>Promise</code>
|
|
333
333
|
* [.get(id, key)](#balena.models.service.var.get) ⇒ <code>Promise</code>
|
|
334
334
|
* [.set(id, key, value)](#balena.models.service.var.set) ⇒ <code>Promise</code>
|
|
335
335
|
* [.remove(id, key)](#balena.models.service.var.remove) ⇒ <code>Promise</code>
|
|
336
|
-
* [.getAllByApplication(
|
|
336
|
+
* [.getAllByApplication(slugOrUuidOrId, [options])](#balena.models.service.getAllByApplication) ⇒ <code>Promise</code>
|
|
337
337
|
* [.image](#balena.models.image) : <code>object</code>
|
|
338
338
|
* [.get(id, [options])](#balena.models.image.get) ⇒ <code>Promise</code>
|
|
339
339
|
* [.getLogs(id)](#balena.models.image.getLogs) ⇒ <code>Promise</code>
|
|
@@ -482,94 +482,94 @@ balena.models.device.get(123).catch(function (error) {
|
|
|
482
482
|
* [.models](#balena.models) : <code>object</code>
|
|
483
483
|
* [.application](#balena.models.application) : <code>object</code>
|
|
484
484
|
* [.tags](#balena.models.application.tags) : <code>object</code>
|
|
485
|
-
* [.getAllByApplication(
|
|
485
|
+
* [.getAllByApplication(slugOrUuidOrId, [options])](#balena.models.application.tags.getAllByApplication) ⇒ <code>Promise</code>
|
|
486
486
|
* [.getAll([options])](#balena.models.application.tags.getAll) ⇒ <code>Promise</code>
|
|
487
|
-
* [.set(
|
|
488
|
-
* [.remove(
|
|
487
|
+
* [.set(slugOrUuidOrId, tagKey, value)](#balena.models.application.tags.set) ⇒ <code>Promise</code>
|
|
488
|
+
* [.remove(slugOrUuidOrId, tagKey)](#balena.models.application.tags.remove) ⇒ <code>Promise</code>
|
|
489
489
|
* [.configVar](#balena.models.application.configVar) : <code>object</code>
|
|
490
|
-
* [.getAllByApplication(
|
|
491
|
-
* [.get(
|
|
492
|
-
* [.set(
|
|
493
|
-
* [.remove(
|
|
490
|
+
* [.getAllByApplication(slugOrUuidOrId, [options])](#balena.models.application.configVar.getAllByApplication) ⇒ <code>Promise</code>
|
|
491
|
+
* [.get(slugOrUuidOrId, key)](#balena.models.application.configVar.get) ⇒ <code>Promise</code>
|
|
492
|
+
* [.set(slugOrUuidOrId, key, value)](#balena.models.application.configVar.set) ⇒ <code>Promise</code>
|
|
493
|
+
* [.remove(slugOrUuidOrId, key)](#balena.models.application.configVar.remove) ⇒ <code>Promise</code>
|
|
494
494
|
* [.envVar](#balena.models.application.envVar) : <code>object</code>
|
|
495
|
-
* [.getAllByApplication(
|
|
496
|
-
* [.get(
|
|
497
|
-
* [.set(
|
|
498
|
-
* [.remove(
|
|
495
|
+
* [.getAllByApplication(slugOrUuidOrId, [options])](#balena.models.application.envVar.getAllByApplication) ⇒ <code>Promise</code>
|
|
496
|
+
* [.get(slugOrUuidOrId, key)](#balena.models.application.envVar.get) ⇒ <code>Promise</code>
|
|
497
|
+
* [.set(slugOrUuidOrId, key, value)](#balena.models.application.envVar.set) ⇒ <code>Promise</code>
|
|
498
|
+
* [.remove(slugOrUuidOrId, key)](#balena.models.application.envVar.remove) ⇒ <code>Promise</code>
|
|
499
499
|
* [.buildVar](#balena.models.application.buildVar) : <code>object</code>
|
|
500
|
-
* [.getAllByApplication(
|
|
501
|
-
* [.get(
|
|
502
|
-
* [.set(
|
|
503
|
-
* [.remove(
|
|
500
|
+
* [.getAllByApplication(slugOrUuidOrId, [options])](#balena.models.application.buildVar.getAllByApplication) ⇒ <code>Promise</code>
|
|
501
|
+
* [.get(slugOrUuidOrId, key)](#balena.models.application.buildVar.get) ⇒ <code>Promise</code>
|
|
502
|
+
* [.set(slugOrUuidOrId, key, value)](#balena.models.application.buildVar.set) ⇒ <code>Promise</code>
|
|
503
|
+
* [.remove(slugOrUuidOrId, key)](#balena.models.application.buildVar.remove) ⇒ <code>Promise</code>
|
|
504
504
|
* [.membership](#balena.models.application.membership) : <code>object</code>
|
|
505
505
|
* [.get(membershipId, [options])](#balena.models.application.membership.get) ⇒ <code>Promise</code>
|
|
506
506
|
* [.getAll([options])](#balena.models.application.membership.getAll) ⇒ <code>Promise</code>
|
|
507
|
-
* [.getAllByApplication(
|
|
507
|
+
* [.getAllByApplication(slugOrUuidOrId, [options])](#balena.models.application.membership.getAllByApplication) ⇒ <code>Promise</code>
|
|
508
508
|
* [.create(options)](#balena.models.application.membership.create) ⇒ <code>Promise</code>
|
|
509
509
|
* [.changeRole(idOrUniqueKey, roleName)](#balena.models.application.membership.changeRole) ⇒ <code>Promise</code>
|
|
510
510
|
* [.remove(idOrUniqueKey)](#balena.models.application.membership.remove) ⇒ <code>Promise</code>
|
|
511
511
|
* [.invite](#balena.models.application.invite) : <code>object</code>
|
|
512
512
|
* [.getAll([options])](#balena.models.application.invite.getAll) ⇒ <code>Promise</code>
|
|
513
|
-
* [.getAllByApplication(
|
|
514
|
-
* [.create(
|
|
513
|
+
* [.getAllByApplication(slugOrUuidOrId, [options])](#balena.models.application.invite.getAllByApplication) ⇒ <code>Promise</code>
|
|
514
|
+
* [.create(slugOrUuidOrId, options, [message])](#balena.models.application.invite.create) ⇒ <code>Promise</code>
|
|
515
515
|
* [.revoke(id)](#balena.models.application.invite.revoke) ⇒ <code>Promise</code>
|
|
516
516
|
* [.accept(invitationToken)](#balena.models.application.invite.accept) ⇒ <code>Promise</code>
|
|
517
517
|
* [.getDashboardUrl(id)](#balena.models.application.getDashboardUrl) ⇒ <code>String</code>
|
|
518
518
|
* [.getAll([options], [context])](#balena.models.application.getAll) ⇒ <code>Promise</code>
|
|
519
519
|
* [.getAllDirectlyAccessible([options])](#balena.models.application.getAllDirectlyAccessible) ⇒ <code>Promise</code>
|
|
520
|
-
* [.get(
|
|
521
|
-
* [.getDirectlyAccessible(
|
|
522
|
-
* [.getWithDeviceServiceDetails(
|
|
520
|
+
* [.get(slugOrUuidOrId, [options], [context])](#balena.models.application.get) ⇒ <code>Promise</code>
|
|
521
|
+
* [.getDirectlyAccessible(slugOrUuidOrId, [options])](#balena.models.application.getDirectlyAccessible) ⇒ <code>Promise</code>
|
|
522
|
+
* [.getWithDeviceServiceDetails(slugOrUuidOrId, [options])](#balena.models.application.getWithDeviceServiceDetails) ⇒ <code>Promise</code>
|
|
523
523
|
* [.getAppByName(appName, [options], [context])](#balena.models.application.getAppByName) ⇒ <code>Promise</code>
|
|
524
524
|
* [.getAppByOwner(appName, owner, [options])](#balena.models.application.getAppByOwner) ⇒ <code>Promise</code>
|
|
525
|
-
* [.has(
|
|
525
|
+
* [.has(slugOrUuidOrId)](#balena.models.application.has) ⇒ <code>Promise</code>
|
|
526
526
|
* [.hasAny()](#balena.models.application.hasAny) ⇒ <code>Promise</code>
|
|
527
527
|
* [.create(options)](#balena.models.application.create) ⇒ <code>Promise</code>
|
|
528
|
-
* [.remove(
|
|
529
|
-
* [.rename(
|
|
530
|
-
* [.restart(
|
|
531
|
-
* ~~[.generateApiKey(
|
|
532
|
-
* [.generateProvisioningKey(
|
|
528
|
+
* [.remove(slugOrUuidOrId)](#balena.models.application.remove) ⇒ <code>Promise</code>
|
|
529
|
+
* [.rename(slugOrUuidOrId, newName)](#balena.models.application.rename) ⇒ <code>Promise</code>
|
|
530
|
+
* [.restart(slugOrUuidOrId)](#balena.models.application.restart) ⇒ <code>Promise</code>
|
|
531
|
+
* ~~[.generateApiKey(slugOrUuidOrId)](#balena.models.application.generateApiKey) ⇒ <code>Promise</code>~~
|
|
532
|
+
* [.generateProvisioningKey(slugOrUuidOrId, [keyName], [keyDescription])](#balena.models.application.generateProvisioningKey) ⇒ <code>Promise</code>
|
|
533
533
|
* [.purge(appId)](#balena.models.application.purge) ⇒ <code>Promise</code>
|
|
534
534
|
* [.shutdown(appId, [options])](#balena.models.application.shutdown) ⇒ <code>Promise</code>
|
|
535
535
|
* [.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(
|
|
536
|
+
* [.willTrackNewReleases(slugOrUuidOrId)](#balena.models.application.willTrackNewReleases) ⇒ <code>Promise</code>
|
|
537
|
+
* [.isTrackingLatestRelease(slugOrUuidOrId)](#balena.models.application.isTrackingLatestRelease) ⇒ <code>Promise</code>
|
|
538
|
+
* [.pinToRelease(slugOrUuidOrId, fullReleaseHash)](#balena.models.application.pinToRelease) ⇒ <code>Promise</code>
|
|
539
|
+
* [.getTargetReleaseHash(slugOrUuidOrId)](#balena.models.application.getTargetReleaseHash) ⇒ <code>Promise</code>
|
|
540
|
+
* [.trackLatestRelease(slugOrUuidOrId)](#balena.models.application.trackLatestRelease) ⇒ <code>Promise</code>
|
|
541
|
+
* [.enableDeviceUrls(slugOrUuidOrId)](#balena.models.application.enableDeviceUrls) ⇒ <code>Promise</code>
|
|
542
|
+
* [.disableDeviceUrls(slugOrUuidOrId)](#balena.models.application.disableDeviceUrls) ⇒ <code>Promise</code>
|
|
543
|
+
* [.grantSupportAccess(slugOrUuidOrId, expiryTimestamp)](#balena.models.application.grantSupportAccess) ⇒ <code>Promise</code>
|
|
544
|
+
* [.revokeSupportAccess(slugOrUuidOrId)](#balena.models.application.revokeSupportAccess) ⇒ <code>Promise</code>
|
|
545
545
|
* [.device](#balena.models.device) : <code>object</code>
|
|
546
546
|
* [.tags](#balena.models.device.tags) : <code>object</code>
|
|
547
|
-
* [.getAllByApplication(
|
|
547
|
+
* [.getAllByApplication(slugOrUuidOrId, [options])](#balena.models.device.tags.getAllByApplication) ⇒ <code>Promise</code>
|
|
548
548
|
* [.getAllByDevice(uuidOrId, [options])](#balena.models.device.tags.getAllByDevice) ⇒ <code>Promise</code>
|
|
549
549
|
* [.getAll([options])](#balena.models.device.tags.getAll) ⇒ <code>Promise</code>
|
|
550
550
|
* [.set(uuidOrId, tagKey, value)](#balena.models.device.tags.set) ⇒ <code>Promise</code>
|
|
551
551
|
* [.remove(uuidOrId, tagKey)](#balena.models.device.tags.remove) ⇒ <code>Promise</code>
|
|
552
552
|
* [.configVar](#balena.models.device.configVar) : <code>object</code>
|
|
553
553
|
* [.getAllByDevice(uuidOrId, [options])](#balena.models.device.configVar.getAllByDevice) ⇒ <code>Promise</code>
|
|
554
|
-
* [.getAllByApplication(
|
|
554
|
+
* [.getAllByApplication(slugOrUuidOrId, [options])](#balena.models.device.configVar.getAllByApplication) ⇒ <code>Promise</code>
|
|
555
555
|
* [.get(uuidOrId, key)](#balena.models.device.configVar.get) ⇒ <code>Promise</code>
|
|
556
556
|
* [.set(uuidOrId, key, value)](#balena.models.device.configVar.set) ⇒ <code>Promise</code>
|
|
557
557
|
* [.remove(uuidOrId, key)](#balena.models.device.configVar.remove) ⇒ <code>Promise</code>
|
|
558
558
|
* [.envVar](#balena.models.device.envVar) : <code>object</code>
|
|
559
559
|
* [.getAllByDevice(uuidOrId, [options])](#balena.models.device.envVar.getAllByDevice) ⇒ <code>Promise</code>
|
|
560
|
-
* [.getAllByApplication(
|
|
560
|
+
* [.getAllByApplication(slugOrUuidOrId, [options])](#balena.models.device.envVar.getAllByApplication) ⇒ <code>Promise</code>
|
|
561
561
|
* [.get(uuidOrId, key)](#balena.models.device.envVar.get) ⇒ <code>Promise</code>
|
|
562
562
|
* [.set(uuidOrId, key, value)](#balena.models.device.envVar.set) ⇒ <code>Promise</code>
|
|
563
563
|
* [.remove(uuidOrId, key)](#balena.models.device.envVar.remove) ⇒ <code>Promise</code>
|
|
564
564
|
* [.serviceVar](#balena.models.device.serviceVar) : <code>object</code>
|
|
565
565
|
* [.getAllByDevice(uuidOrId, [options])](#balena.models.device.serviceVar.getAllByDevice) ⇒ <code>Promise</code>
|
|
566
|
-
* [.getAllByApplication(
|
|
566
|
+
* [.getAllByApplication(slugOrUuidOrId, [options])](#balena.models.device.serviceVar.getAllByApplication) ⇒ <code>Promise</code>
|
|
567
567
|
* [.get(uuidOrId, id, key)](#balena.models.device.serviceVar.get) ⇒ <code>Promise</code>
|
|
568
568
|
* [.set(uuidOrId, id, key, value)](#balena.models.device.serviceVar.set) ⇒ <code>Promise</code>
|
|
569
569
|
* [.remove(uuidOrId, id, key)](#balena.models.device.serviceVar.remove) ⇒ <code>Promise</code>
|
|
570
570
|
* [.getDashboardUrl(uuid)](#balena.models.device.getDashboardUrl) ⇒ <code>String</code>
|
|
571
571
|
* [.getAll([options])](#balena.models.device.getAll) ⇒ <code>Promise</code>
|
|
572
|
-
* [.getAllByApplication(
|
|
572
|
+
* [.getAllByApplication(slugOrUuidOrId, [options])](#balena.models.device.getAllByApplication) ⇒ <code>Promise</code>
|
|
573
573
|
* [.getAllByParentDevice(parentUuidOrId, [options])](#balena.models.device.getAllByParentDevice) ⇒ <code>Promise</code>
|
|
574
574
|
* [.get(uuidOrId, [options])](#balena.models.device.get) ⇒ <code>Promise</code>
|
|
575
575
|
* [.getWithServiceDetails(uuidOrId, [options])](#balena.models.device.getWithServiceDetails) ⇒ <code>Promise</code>
|
|
@@ -587,13 +587,13 @@ balena.models.device.get(123).catch(function (error) {
|
|
|
587
587
|
* [.note(uuidOrId, note)](#balena.models.device.note) ⇒ <code>Promise</code>
|
|
588
588
|
* [.setCustomLocation(uuidOrId, location)](#balena.models.device.setCustomLocation) ⇒ <code>Promise</code>
|
|
589
589
|
* [.unsetCustomLocation(uuidOrId)](#balena.models.device.unsetCustomLocation) ⇒ <code>Promise</code>
|
|
590
|
-
* [.move(uuidOrId,
|
|
590
|
+
* [.move(uuidOrId, applicationSlugOrUuidOrId)](#balena.models.device.move) ⇒ <code>Promise</code>
|
|
591
591
|
* [.restartApplication(uuidOrId)](#balena.models.device.restartApplication) ⇒ <code>Promise</code>
|
|
592
592
|
* [.getSupervisorTargetState(uuidOrId)](#balena.models.device.getSupervisorTargetState) ⇒ <code>Promise</code>
|
|
593
593
|
* ~~[.getManifestBySlug(slugOrName)](#balena.models.device.getManifestBySlug) ⇒ <code>Promise</code>~~
|
|
594
|
-
* [.getManifestByApplication(
|
|
594
|
+
* [.getManifestByApplication(slugOrUuidOrId)](#balena.models.device.getManifestByApplication) ⇒ <code>Promise</code>
|
|
595
595
|
* [.generateUniqueKey()](#balena.models.device.generateUniqueKey) ⇒ <code>String</code>
|
|
596
|
-
* [.register(
|
|
596
|
+
* [.register(applicationSlugOrUuidOrId, uuid)](#balena.models.device.register) ⇒ <code>Promise</code>
|
|
597
597
|
* [.generateDeviceKey(uuidOrId)](#balena.models.device.generateDeviceKey) ⇒ <code>Promise</code>
|
|
598
598
|
* [.hasDeviceUrl(uuidOrId)](#balena.models.device.hasDeviceUrl) ⇒ <code>Promise</code>
|
|
599
599
|
* [.getDeviceUrl(uuidOrId)](#balena.models.device.getDeviceUrl) ⇒ <code>Promise</code>
|
|
@@ -643,7 +643,7 @@ balena.models.device.get(123).catch(function (error) {
|
|
|
643
643
|
* [.create(name, [description])](#balena.models.apiKey.create) ⇒ <code>Promise</code>
|
|
644
644
|
* [.getAll([options])](#balena.models.apiKey.getAll) ⇒ <code>Promise</code>
|
|
645
645
|
* [.getAllNamedUserApiKeys([options])](#balena.models.apiKey.getAllNamedUserApiKeys) ⇒ <code>Promise</code>
|
|
646
|
-
* [.getProvisioningApiKeysByApplication(
|
|
646
|
+
* [.getProvisioningApiKeysByApplication(slugOrUuidOrId, [options])](#balena.models.apiKey.getProvisioningApiKeysByApplication) ⇒ <code>Promise</code>
|
|
647
647
|
* [.getDeviceApiKeysByDevice(uuidOrId, [options])](#balena.models.apiKey.getDeviceApiKeysByDevice) ⇒ <code>Promise</code>
|
|
648
648
|
* [.update(id, apiKeyInfo)](#balena.models.apiKey.update) ⇒ <code>Promise</code>
|
|
649
649
|
* [.revoke(id)](#balena.models.apiKey.revoke) ⇒ <code>Promise</code>
|
|
@@ -677,7 +677,7 @@ balena.models.device.get(123).catch(function (error) {
|
|
|
677
677
|
* [.getMaxSatisfyingVersion(deviceType, versionOrRange, [osType])](#balena.models.os.getMaxSatisfyingVersion) ⇒ <code>Promise</code>
|
|
678
678
|
* [.getLastModified(deviceType, [version])](#balena.models.os.getLastModified) ⇒ <code>Promise</code>
|
|
679
679
|
* [.download(deviceType, [version], options)](#balena.models.os.download) ⇒ <code>Promise</code>
|
|
680
|
-
* [.getConfig(
|
|
680
|
+
* [.getConfig(slugOrUuidOrId, options)](#balena.models.os.getConfig) ⇒ <code>Promise</code>
|
|
681
681
|
* [.isSupportedOsUpdate(deviceType, currentVersion, targetVersion)](#balena.models.os.isSupportedOsUpdate) ⇒ <code>Promise</code>
|
|
682
682
|
* [.getSupportedOsUpdateVersions(deviceType, currentVersion)](#balena.models.os.getSupportedOsUpdateVersions) ⇒ <code>Promise</code>
|
|
683
683
|
* [.isArchitectureCompatibleWith(osArchitecture, applicationArchitecture)](#balena.models.os.isArchitectureCompatibleWith) ⇒ <code>Boolean</code>
|
|
@@ -688,27 +688,27 @@ balena.models.device.get(123).catch(function (error) {
|
|
|
688
688
|
* [.getConfigVarSchema(deviceType)](#balena.models.config.getConfigVarSchema) ⇒ <code>Promise</code>
|
|
689
689
|
* [.release](#balena.models.release) : <code>object</code>
|
|
690
690
|
* [.tags](#balena.models.release.tags) : <code>object</code>
|
|
691
|
-
* [.getAllByApplication(
|
|
691
|
+
* [.getAllByApplication(slugOrUuidOrId, [options])](#balena.models.release.tags.getAllByApplication) ⇒ <code>Promise</code>
|
|
692
692
|
* [.getAllByRelease(commitOrId, [options])](#balena.models.release.tags.getAllByRelease) ⇒ <code>Promise</code>
|
|
693
693
|
* [.getAll([options])](#balena.models.release.tags.getAll) ⇒ <code>Promise</code>
|
|
694
694
|
* [.set(commitOrId, tagKey, value)](#balena.models.release.tags.set) ⇒ <code>Promise</code>
|
|
695
695
|
* [.remove(commitOrId, tagKey)](#balena.models.release.tags.remove) ⇒ <code>Promise</code>
|
|
696
696
|
* [.get(commitOrId, [options])](#balena.models.release.get) ⇒ <code>Promise</code>
|
|
697
697
|
* [.getWithImageDetails(commitOrId, [options])](#balena.models.release.getWithImageDetails) ⇒ <code>Promise</code>
|
|
698
|
-
* [.getAllByApplication(
|
|
699
|
-
* [.getLatestByApplication(
|
|
700
|
-
* [.createFromUrl(
|
|
698
|
+
* [.getAllByApplication(slugOrUuidOrId, [options])](#balena.models.release.getAllByApplication) ⇒ <code>Promise</code>
|
|
699
|
+
* [.getLatestByApplication(slugOrUuidOrId, [options])](#balena.models.release.getLatestByApplication) ⇒ <code>Promise</code>
|
|
700
|
+
* [.createFromUrl(slugOrUuidOrId, urlDeployOptions)](#balena.models.release.createFromUrl) ⇒ <code>Promise</code>
|
|
701
701
|
* [.finalize(commitOrId)](#balena.models.release.finalize) ⇒ <code>Promise</code>
|
|
702
702
|
* [.setIsInvalidated(commitOrId, isInvalidated)](#balena.models.release.setIsInvalidated) ⇒ <code>Promise</code>
|
|
703
703
|
* [.note(commitOrId, note)](#balena.models.release.note) ⇒ <code>Promise</code>
|
|
704
704
|
* [.service](#balena.models.service) : <code>object</code>
|
|
705
705
|
* [.var](#balena.models.service.var) : <code>object</code>
|
|
706
706
|
* [.getAllByService(id, [options])](#balena.models.service.var.getAllByService) ⇒ <code>Promise</code>
|
|
707
|
-
* [.getAllByApplication(
|
|
707
|
+
* [.getAllByApplication(slugOrUuidOrId, [options])](#balena.models.service.var.getAllByApplication) ⇒ <code>Promise</code>
|
|
708
708
|
* [.get(id, key)](#balena.models.service.var.get) ⇒ <code>Promise</code>
|
|
709
709
|
* [.set(id, key, value)](#balena.models.service.var.set) ⇒ <code>Promise</code>
|
|
710
710
|
* [.remove(id, key)](#balena.models.service.var.remove) ⇒ <code>Promise</code>
|
|
711
|
-
* [.getAllByApplication(
|
|
711
|
+
* [.getAllByApplication(slugOrUuidOrId, [options])](#balena.models.service.getAllByApplication) ⇒ <code>Promise</code>
|
|
712
712
|
* [.image](#balena.models.image) : <code>object</code>
|
|
713
713
|
* [.get(id, [options])](#balena.models.image.get) ⇒ <code>Promise</code>
|
|
714
714
|
* [.getLogs(id)](#balena.models.image.getLogs) ⇒ <code>Promise</code>
|
|
@@ -728,66 +728,66 @@ balena.models.device.get(123).catch(function (error) {
|
|
|
728
728
|
|
|
729
729
|
* [.application](#balena.models.application) : <code>object</code>
|
|
730
730
|
* [.tags](#balena.models.application.tags) : <code>object</code>
|
|
731
|
-
* [.getAllByApplication(
|
|
731
|
+
* [.getAllByApplication(slugOrUuidOrId, [options])](#balena.models.application.tags.getAllByApplication) ⇒ <code>Promise</code>
|
|
732
732
|
* [.getAll([options])](#balena.models.application.tags.getAll) ⇒ <code>Promise</code>
|
|
733
|
-
* [.set(
|
|
734
|
-
* [.remove(
|
|
733
|
+
* [.set(slugOrUuidOrId, tagKey, value)](#balena.models.application.tags.set) ⇒ <code>Promise</code>
|
|
734
|
+
* [.remove(slugOrUuidOrId, tagKey)](#balena.models.application.tags.remove) ⇒ <code>Promise</code>
|
|
735
735
|
* [.configVar](#balena.models.application.configVar) : <code>object</code>
|
|
736
|
-
* [.getAllByApplication(
|
|
737
|
-
* [.get(
|
|
738
|
-
* [.set(
|
|
739
|
-
* [.remove(
|
|
736
|
+
* [.getAllByApplication(slugOrUuidOrId, [options])](#balena.models.application.configVar.getAllByApplication) ⇒ <code>Promise</code>
|
|
737
|
+
* [.get(slugOrUuidOrId, key)](#balena.models.application.configVar.get) ⇒ <code>Promise</code>
|
|
738
|
+
* [.set(slugOrUuidOrId, key, value)](#balena.models.application.configVar.set) ⇒ <code>Promise</code>
|
|
739
|
+
* [.remove(slugOrUuidOrId, key)](#balena.models.application.configVar.remove) ⇒ <code>Promise</code>
|
|
740
740
|
* [.envVar](#balena.models.application.envVar) : <code>object</code>
|
|
741
|
-
* [.getAllByApplication(
|
|
742
|
-
* [.get(
|
|
743
|
-
* [.set(
|
|
744
|
-
* [.remove(
|
|
741
|
+
* [.getAllByApplication(slugOrUuidOrId, [options])](#balena.models.application.envVar.getAllByApplication) ⇒ <code>Promise</code>
|
|
742
|
+
* [.get(slugOrUuidOrId, key)](#balena.models.application.envVar.get) ⇒ <code>Promise</code>
|
|
743
|
+
* [.set(slugOrUuidOrId, key, value)](#balena.models.application.envVar.set) ⇒ <code>Promise</code>
|
|
744
|
+
* [.remove(slugOrUuidOrId, key)](#balena.models.application.envVar.remove) ⇒ <code>Promise</code>
|
|
745
745
|
* [.buildVar](#balena.models.application.buildVar) : <code>object</code>
|
|
746
|
-
* [.getAllByApplication(
|
|
747
|
-
* [.get(
|
|
748
|
-
* [.set(
|
|
749
|
-
* [.remove(
|
|
746
|
+
* [.getAllByApplication(slugOrUuidOrId, [options])](#balena.models.application.buildVar.getAllByApplication) ⇒ <code>Promise</code>
|
|
747
|
+
* [.get(slugOrUuidOrId, key)](#balena.models.application.buildVar.get) ⇒ <code>Promise</code>
|
|
748
|
+
* [.set(slugOrUuidOrId, key, value)](#balena.models.application.buildVar.set) ⇒ <code>Promise</code>
|
|
749
|
+
* [.remove(slugOrUuidOrId, key)](#balena.models.application.buildVar.remove) ⇒ <code>Promise</code>
|
|
750
750
|
* [.membership](#balena.models.application.membership) : <code>object</code>
|
|
751
751
|
* [.get(membershipId, [options])](#balena.models.application.membership.get) ⇒ <code>Promise</code>
|
|
752
752
|
* [.getAll([options])](#balena.models.application.membership.getAll) ⇒ <code>Promise</code>
|
|
753
|
-
* [.getAllByApplication(
|
|
753
|
+
* [.getAllByApplication(slugOrUuidOrId, [options])](#balena.models.application.membership.getAllByApplication) ⇒ <code>Promise</code>
|
|
754
754
|
* [.create(options)](#balena.models.application.membership.create) ⇒ <code>Promise</code>
|
|
755
755
|
* [.changeRole(idOrUniqueKey, roleName)](#balena.models.application.membership.changeRole) ⇒ <code>Promise</code>
|
|
756
756
|
* [.remove(idOrUniqueKey)](#balena.models.application.membership.remove) ⇒ <code>Promise</code>
|
|
757
757
|
* [.invite](#balena.models.application.invite) : <code>object</code>
|
|
758
758
|
* [.getAll([options])](#balena.models.application.invite.getAll) ⇒ <code>Promise</code>
|
|
759
|
-
* [.getAllByApplication(
|
|
760
|
-
* [.create(
|
|
759
|
+
* [.getAllByApplication(slugOrUuidOrId, [options])](#balena.models.application.invite.getAllByApplication) ⇒ <code>Promise</code>
|
|
760
|
+
* [.create(slugOrUuidOrId, options, [message])](#balena.models.application.invite.create) ⇒ <code>Promise</code>
|
|
761
761
|
* [.revoke(id)](#balena.models.application.invite.revoke) ⇒ <code>Promise</code>
|
|
762
762
|
* [.accept(invitationToken)](#balena.models.application.invite.accept) ⇒ <code>Promise</code>
|
|
763
763
|
* [.getDashboardUrl(id)](#balena.models.application.getDashboardUrl) ⇒ <code>String</code>
|
|
764
764
|
* [.getAll([options], [context])](#balena.models.application.getAll) ⇒ <code>Promise</code>
|
|
765
765
|
* [.getAllDirectlyAccessible([options])](#balena.models.application.getAllDirectlyAccessible) ⇒ <code>Promise</code>
|
|
766
|
-
* [.get(
|
|
767
|
-
* [.getDirectlyAccessible(
|
|
768
|
-
* [.getWithDeviceServiceDetails(
|
|
766
|
+
* [.get(slugOrUuidOrId, [options], [context])](#balena.models.application.get) ⇒ <code>Promise</code>
|
|
767
|
+
* [.getDirectlyAccessible(slugOrUuidOrId, [options])](#balena.models.application.getDirectlyAccessible) ⇒ <code>Promise</code>
|
|
768
|
+
* [.getWithDeviceServiceDetails(slugOrUuidOrId, [options])](#balena.models.application.getWithDeviceServiceDetails) ⇒ <code>Promise</code>
|
|
769
769
|
* [.getAppByName(appName, [options], [context])](#balena.models.application.getAppByName) ⇒ <code>Promise</code>
|
|
770
770
|
* [.getAppByOwner(appName, owner, [options])](#balena.models.application.getAppByOwner) ⇒ <code>Promise</code>
|
|
771
|
-
* [.has(
|
|
771
|
+
* [.has(slugOrUuidOrId)](#balena.models.application.has) ⇒ <code>Promise</code>
|
|
772
772
|
* [.hasAny()](#balena.models.application.hasAny) ⇒ <code>Promise</code>
|
|
773
773
|
* [.create(options)](#balena.models.application.create) ⇒ <code>Promise</code>
|
|
774
|
-
* [.remove(
|
|
775
|
-
* [.rename(
|
|
776
|
-
* [.restart(
|
|
777
|
-
* ~~[.generateApiKey(
|
|
778
|
-
* [.generateProvisioningKey(
|
|
774
|
+
* [.remove(slugOrUuidOrId)](#balena.models.application.remove) ⇒ <code>Promise</code>
|
|
775
|
+
* [.rename(slugOrUuidOrId, newName)](#balena.models.application.rename) ⇒ <code>Promise</code>
|
|
776
|
+
* [.restart(slugOrUuidOrId)](#balena.models.application.restart) ⇒ <code>Promise</code>
|
|
777
|
+
* ~~[.generateApiKey(slugOrUuidOrId)](#balena.models.application.generateApiKey) ⇒ <code>Promise</code>~~
|
|
778
|
+
* [.generateProvisioningKey(slugOrUuidOrId, [keyName], [keyDescription])](#balena.models.application.generateProvisioningKey) ⇒ <code>Promise</code>
|
|
779
779
|
* [.purge(appId)](#balena.models.application.purge) ⇒ <code>Promise</code>
|
|
780
780
|
* [.shutdown(appId, [options])](#balena.models.application.shutdown) ⇒ <code>Promise</code>
|
|
781
781
|
* [.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(
|
|
782
|
+
* [.willTrackNewReleases(slugOrUuidOrId)](#balena.models.application.willTrackNewReleases) ⇒ <code>Promise</code>
|
|
783
|
+
* [.isTrackingLatestRelease(slugOrUuidOrId)](#balena.models.application.isTrackingLatestRelease) ⇒ <code>Promise</code>
|
|
784
|
+
* [.pinToRelease(slugOrUuidOrId, fullReleaseHash)](#balena.models.application.pinToRelease) ⇒ <code>Promise</code>
|
|
785
|
+
* [.getTargetReleaseHash(slugOrUuidOrId)](#balena.models.application.getTargetReleaseHash) ⇒ <code>Promise</code>
|
|
786
|
+
* [.trackLatestRelease(slugOrUuidOrId)](#balena.models.application.trackLatestRelease) ⇒ <code>Promise</code>
|
|
787
|
+
* [.enableDeviceUrls(slugOrUuidOrId)](#balena.models.application.enableDeviceUrls) ⇒ <code>Promise</code>
|
|
788
|
+
* [.disableDeviceUrls(slugOrUuidOrId)](#balena.models.application.disableDeviceUrls) ⇒ <code>Promise</code>
|
|
789
|
+
* [.grantSupportAccess(slugOrUuidOrId, expiryTimestamp)](#balena.models.application.grantSupportAccess) ⇒ <code>Promise</code>
|
|
790
|
+
* [.revokeSupportAccess(slugOrUuidOrId)](#balena.models.application.revokeSupportAccess) ⇒ <code>Promise</code>
|
|
791
791
|
|
|
792
792
|
<a name="balena.models.application.tags"></a>
|
|
793
793
|
|
|
@@ -795,14 +795,14 @@ balena.models.device.get(123).catch(function (error) {
|
|
|
795
795
|
**Kind**: static namespace of [<code>application</code>](#balena.models.application)
|
|
796
796
|
|
|
797
797
|
* [.tags](#balena.models.application.tags) : <code>object</code>
|
|
798
|
-
* [.getAllByApplication(
|
|
798
|
+
* [.getAllByApplication(slugOrUuidOrId, [options])](#balena.models.application.tags.getAllByApplication) ⇒ <code>Promise</code>
|
|
799
799
|
* [.getAll([options])](#balena.models.application.tags.getAll) ⇒ <code>Promise</code>
|
|
800
|
-
* [.set(
|
|
801
|
-
* [.remove(
|
|
800
|
+
* [.set(slugOrUuidOrId, tagKey, value)](#balena.models.application.tags.set) ⇒ <code>Promise</code>
|
|
801
|
+
* [.remove(slugOrUuidOrId, tagKey)](#balena.models.application.tags.remove) ⇒ <code>Promise</code>
|
|
802
802
|
|
|
803
803
|
<a name="balena.models.application.tags.getAllByApplication"></a>
|
|
804
804
|
|
|
805
|
-
###### tags.getAllByApplication(
|
|
805
|
+
###### tags.getAllByApplication(slugOrUuidOrId, [options]) ⇒ <code>Promise</code>
|
|
806
806
|
**Kind**: static method of [<code>tags</code>](#balena.models.application.tags)
|
|
807
807
|
**Summary**: Get all application tags for an application
|
|
808
808
|
**Access**: public
|
|
@@ -810,7 +810,7 @@ balena.models.device.get(123).catch(function (error) {
|
|
|
810
810
|
|
|
811
811
|
| Param | Type | Default | Description |
|
|
812
812
|
| --- | --- | --- | --- |
|
|
813
|
-
|
|
|
813
|
+
| slugOrUuidOrId | <code>String</code> \| <code>Number</code> | | application slug (string), uuid (string) or id (number) |
|
|
814
814
|
| [options] | <code>Object</code> | <code>{}</code> | extra pine options to use |
|
|
815
815
|
|
|
816
816
|
**Example**
|
|
@@ -859,14 +859,14 @@ balena.models.application.tags.getAll(function(error, tags) {
|
|
|
859
859
|
```
|
|
860
860
|
<a name="balena.models.application.tags.set"></a>
|
|
861
861
|
|
|
862
|
-
###### tags.set(
|
|
862
|
+
###### tags.set(slugOrUuidOrId, tagKey, value) ⇒ <code>Promise</code>
|
|
863
863
|
**Kind**: static method of [<code>tags</code>](#balena.models.application.tags)
|
|
864
864
|
**Summary**: Set an application tag
|
|
865
865
|
**Access**: public
|
|
866
866
|
|
|
867
867
|
| Param | Type | Description |
|
|
868
868
|
| --- | --- | --- |
|
|
869
|
-
|
|
|
869
|
+
| slugOrUuidOrId | <code>String</code> \| <code>Number</code> | application slug (string), uuid (string) or id (number) |
|
|
870
870
|
| tagKey | <code>String</code> | tag key |
|
|
871
871
|
| value | <code>String</code> \| <code>undefined</code> | tag value |
|
|
872
872
|
|
|
@@ -886,14 +886,14 @@ balena.models.application.tags.set('myorganization/myapp', 'EDITOR', 'vim', func
|
|
|
886
886
|
```
|
|
887
887
|
<a name="balena.models.application.tags.remove"></a>
|
|
888
888
|
|
|
889
|
-
###### tags.remove(
|
|
889
|
+
###### tags.remove(slugOrUuidOrId, tagKey) ⇒ <code>Promise</code>
|
|
890
890
|
**Kind**: static method of [<code>tags</code>](#balena.models.application.tags)
|
|
891
891
|
**Summary**: Remove an application tag
|
|
892
892
|
**Access**: public
|
|
893
893
|
|
|
894
894
|
| Param | Type | Description |
|
|
895
895
|
| --- | --- | --- |
|
|
896
|
-
|
|
|
896
|
+
| slugOrUuidOrId | <code>String</code> \| <code>Number</code> | application slug (string), uuid (string) or id (number) |
|
|
897
897
|
| tagKey | <code>String</code> | tag key |
|
|
898
898
|
|
|
899
899
|
**Example**
|
|
@@ -912,14 +912,14 @@ balena.models.application.tags.remove('myorganization/myapp', 'EDITOR', function
|
|
|
912
912
|
**Kind**: static namespace of [<code>application</code>](#balena.models.application)
|
|
913
913
|
|
|
914
914
|
* [.configVar](#balena.models.application.configVar) : <code>object</code>
|
|
915
|
-
* [.getAllByApplication(
|
|
916
|
-
* [.get(
|
|
917
|
-
* [.set(
|
|
918
|
-
* [.remove(
|
|
915
|
+
* [.getAllByApplication(slugOrUuidOrId, [options])](#balena.models.application.configVar.getAllByApplication) ⇒ <code>Promise</code>
|
|
916
|
+
* [.get(slugOrUuidOrId, key)](#balena.models.application.configVar.get) ⇒ <code>Promise</code>
|
|
917
|
+
* [.set(slugOrUuidOrId, key, value)](#balena.models.application.configVar.set) ⇒ <code>Promise</code>
|
|
918
|
+
* [.remove(slugOrUuidOrId, key)](#balena.models.application.configVar.remove) ⇒ <code>Promise</code>
|
|
919
919
|
|
|
920
920
|
<a name="balena.models.application.configVar.getAllByApplication"></a>
|
|
921
921
|
|
|
922
|
-
###### configVar.getAllByApplication(
|
|
922
|
+
###### configVar.getAllByApplication(slugOrUuidOrId, [options]) ⇒ <code>Promise</code>
|
|
923
923
|
**Kind**: static method of [<code>configVar</code>](#balena.models.application.configVar)
|
|
924
924
|
**Summary**: Get all config variables for an application
|
|
925
925
|
**Access**: public
|
|
@@ -927,7 +927,7 @@ balena.models.application.tags.remove('myorganization/myapp', 'EDITOR', function
|
|
|
927
927
|
|
|
928
928
|
| Param | Type | Default | Description |
|
|
929
929
|
| --- | --- | --- | --- |
|
|
930
|
-
|
|
|
930
|
+
| slugOrUuidOrId | <code>String</code> \| <code>Number</code> | | application slug (string), uuid (string) or id (number) |
|
|
931
931
|
| [options] | <code>Object</code> | <code>{}</code> | extra pine options to use |
|
|
932
932
|
|
|
933
933
|
**Example**
|
|
@@ -951,7 +951,7 @@ balena.models.application.configVar.getAllByApplication('myorganization/myapp',
|
|
|
951
951
|
```
|
|
952
952
|
<a name="balena.models.application.configVar.get"></a>
|
|
953
953
|
|
|
954
|
-
###### configVar.get(
|
|
954
|
+
###### configVar.get(slugOrUuidOrId, key) ⇒ <code>Promise</code>
|
|
955
955
|
**Kind**: static method of [<code>configVar</code>](#balena.models.application.configVar)
|
|
956
956
|
**Summary**: Get the value of a specific config variable
|
|
957
957
|
**Access**: public
|
|
@@ -959,7 +959,7 @@ balena.models.application.configVar.getAllByApplication('myorganization/myapp',
|
|
|
959
959
|
|
|
960
960
|
| Param | Type | Description |
|
|
961
961
|
| --- | --- | --- |
|
|
962
|
-
|
|
|
962
|
+
| slugOrUuidOrId | <code>String</code> \| <code>Number</code> | application slug (string), uuid (string) or id (number) |
|
|
963
963
|
| key | <code>String</code> | config variable name |
|
|
964
964
|
|
|
965
965
|
**Example**
|
|
@@ -983,14 +983,14 @@ balena.models.application.configVar.get('myorganization/myapp', 'BALENA_VAR', fu
|
|
|
983
983
|
```
|
|
984
984
|
<a name="balena.models.application.configVar.set"></a>
|
|
985
985
|
|
|
986
|
-
###### configVar.set(
|
|
986
|
+
###### configVar.set(slugOrUuidOrId, key, value) ⇒ <code>Promise</code>
|
|
987
987
|
**Kind**: static method of [<code>configVar</code>](#balena.models.application.configVar)
|
|
988
988
|
**Summary**: Set the value of a specific config variable
|
|
989
989
|
**Access**: public
|
|
990
990
|
|
|
991
991
|
| Param | Type | Description |
|
|
992
992
|
| --- | --- | --- |
|
|
993
|
-
|
|
|
993
|
+
| slugOrUuidOrId | <code>String</code> \| <code>Number</code> | application slug (string), uuid (string) or id (number) |
|
|
994
994
|
| key | <code>String</code> | config variable name |
|
|
995
995
|
| value | <code>String</code> | config variable value |
|
|
996
996
|
|
|
@@ -1015,14 +1015,14 @@ balena.models.application.configVar.set('myorganization/myapp', 'BALENA_VAR', 'n
|
|
|
1015
1015
|
```
|
|
1016
1016
|
<a name="balena.models.application.configVar.remove"></a>
|
|
1017
1017
|
|
|
1018
|
-
###### configVar.remove(
|
|
1018
|
+
###### configVar.remove(slugOrUuidOrId, key) ⇒ <code>Promise</code>
|
|
1019
1019
|
**Kind**: static method of [<code>configVar</code>](#balena.models.application.configVar)
|
|
1020
1020
|
**Summary**: Clear the value of a specific config variable
|
|
1021
1021
|
**Access**: public
|
|
1022
1022
|
|
|
1023
1023
|
| Param | Type | Description |
|
|
1024
1024
|
| --- | --- | --- |
|
|
1025
|
-
|
|
|
1025
|
+
| slugOrUuidOrId | <code>String</code> \| <code>Number</code> | application slug (string), uuid (string) or id (number) |
|
|
1026
1026
|
| key | <code>String</code> | config variable name |
|
|
1027
1027
|
|
|
1028
1028
|
**Example**
|
|
@@ -1050,14 +1050,14 @@ balena.models.application.configVar.remove('myorganization/myapp', 'BALENA_VAR',
|
|
|
1050
1050
|
**Kind**: static namespace of [<code>application</code>](#balena.models.application)
|
|
1051
1051
|
|
|
1052
1052
|
* [.envVar](#balena.models.application.envVar) : <code>object</code>
|
|
1053
|
-
* [.getAllByApplication(
|
|
1054
|
-
* [.get(
|
|
1055
|
-
* [.set(
|
|
1056
|
-
* [.remove(
|
|
1053
|
+
* [.getAllByApplication(slugOrUuidOrId, [options])](#balena.models.application.envVar.getAllByApplication) ⇒ <code>Promise</code>
|
|
1054
|
+
* [.get(slugOrUuidOrId, key)](#balena.models.application.envVar.get) ⇒ <code>Promise</code>
|
|
1055
|
+
* [.set(slugOrUuidOrId, key, value)](#balena.models.application.envVar.set) ⇒ <code>Promise</code>
|
|
1056
|
+
* [.remove(slugOrUuidOrId, key)](#balena.models.application.envVar.remove) ⇒ <code>Promise</code>
|
|
1057
1057
|
|
|
1058
1058
|
<a name="balena.models.application.envVar.getAllByApplication"></a>
|
|
1059
1059
|
|
|
1060
|
-
###### envVar.getAllByApplication(
|
|
1060
|
+
###### envVar.getAllByApplication(slugOrUuidOrId, [options]) ⇒ <code>Promise</code>
|
|
1061
1061
|
**Kind**: static method of [<code>envVar</code>](#balena.models.application.envVar)
|
|
1062
1062
|
**Summary**: Get all environment variables for an application
|
|
1063
1063
|
**Access**: public
|
|
@@ -1065,7 +1065,7 @@ balena.models.application.configVar.remove('myorganization/myapp', 'BALENA_VAR',
|
|
|
1065
1065
|
|
|
1066
1066
|
| Param | Type | Default | Description |
|
|
1067
1067
|
| --- | --- | --- | --- |
|
|
1068
|
-
|
|
|
1068
|
+
| slugOrUuidOrId | <code>String</code> \| <code>Number</code> | | application slug (string), uuid (string) or id (number) |
|
|
1069
1069
|
| [options] | <code>Object</code> | <code>{}</code> | extra pine options to use |
|
|
1070
1070
|
|
|
1071
1071
|
**Example**
|
|
@@ -1089,7 +1089,7 @@ balena.models.application.envVar.getAllByApplication('myorganization/myapp', fun
|
|
|
1089
1089
|
```
|
|
1090
1090
|
<a name="balena.models.application.envVar.get"></a>
|
|
1091
1091
|
|
|
1092
|
-
###### envVar.get(
|
|
1092
|
+
###### envVar.get(slugOrUuidOrId, key) ⇒ <code>Promise</code>
|
|
1093
1093
|
**Kind**: static method of [<code>envVar</code>](#balena.models.application.envVar)
|
|
1094
1094
|
**Summary**: Get the value of a specific environment variable
|
|
1095
1095
|
**Access**: public
|
|
@@ -1097,7 +1097,7 @@ balena.models.application.envVar.getAllByApplication('myorganization/myapp', fun
|
|
|
1097
1097
|
|
|
1098
1098
|
| Param | Type | Description |
|
|
1099
1099
|
| --- | --- | --- |
|
|
1100
|
-
|
|
|
1100
|
+
| slugOrUuidOrId | <code>String</code> \| <code>Number</code> | application slug (string), uuid (string) or id (number) |
|
|
1101
1101
|
| key | <code>String</code> | environment variable name |
|
|
1102
1102
|
|
|
1103
1103
|
**Example**
|
|
@@ -1121,14 +1121,14 @@ balena.models.application.envVar.get('myorganization/myapp', 'VAR', function(err
|
|
|
1121
1121
|
```
|
|
1122
1122
|
<a name="balena.models.application.envVar.set"></a>
|
|
1123
1123
|
|
|
1124
|
-
###### envVar.set(
|
|
1124
|
+
###### envVar.set(slugOrUuidOrId, key, value) ⇒ <code>Promise</code>
|
|
1125
1125
|
**Kind**: static method of [<code>envVar</code>](#balena.models.application.envVar)
|
|
1126
1126
|
**Summary**: Set the value of a specific environment variable
|
|
1127
1127
|
**Access**: public
|
|
1128
1128
|
|
|
1129
1129
|
| Param | Type | Description |
|
|
1130
1130
|
| --- | --- | --- |
|
|
1131
|
-
|
|
|
1131
|
+
| slugOrUuidOrId | <code>String</code> \| <code>Number</code> | application slug (string), uuid (string) or id (number) |
|
|
1132
1132
|
| key | <code>String</code> | environment variable name |
|
|
1133
1133
|
| value | <code>String</code> | environment variable value |
|
|
1134
1134
|
|
|
@@ -1153,14 +1153,14 @@ balena.models.application.envVar.set('myorganization/myapp', 'VAR', 'newvalue',
|
|
|
1153
1153
|
```
|
|
1154
1154
|
<a name="balena.models.application.envVar.remove"></a>
|
|
1155
1155
|
|
|
1156
|
-
###### envVar.remove(
|
|
1156
|
+
###### envVar.remove(slugOrUuidOrId, key) ⇒ <code>Promise</code>
|
|
1157
1157
|
**Kind**: static method of [<code>envVar</code>](#balena.models.application.envVar)
|
|
1158
1158
|
**Summary**: Clear the value of a specific environment variable
|
|
1159
1159
|
**Access**: public
|
|
1160
1160
|
|
|
1161
1161
|
| Param | Type | Description |
|
|
1162
1162
|
| --- | --- | --- |
|
|
1163
|
-
|
|
|
1163
|
+
| slugOrUuidOrId | <code>String</code> \| <code>Number</code> | application slug (string), uuid (string) or id (number) |
|
|
1164
1164
|
| key | <code>String</code> | environment variable name |
|
|
1165
1165
|
|
|
1166
1166
|
**Example**
|
|
@@ -1188,14 +1188,14 @@ balena.models.application.envVar.remove('myorganization/myapp', 'VAR', function(
|
|
|
1188
1188
|
**Kind**: static namespace of [<code>application</code>](#balena.models.application)
|
|
1189
1189
|
|
|
1190
1190
|
* [.buildVar](#balena.models.application.buildVar) : <code>object</code>
|
|
1191
|
-
* [.getAllByApplication(
|
|
1192
|
-
* [.get(
|
|
1193
|
-
* [.set(
|
|
1194
|
-
* [.remove(
|
|
1191
|
+
* [.getAllByApplication(slugOrUuidOrId, [options])](#balena.models.application.buildVar.getAllByApplication) ⇒ <code>Promise</code>
|
|
1192
|
+
* [.get(slugOrUuidOrId, key)](#balena.models.application.buildVar.get) ⇒ <code>Promise</code>
|
|
1193
|
+
* [.set(slugOrUuidOrId, key, value)](#balena.models.application.buildVar.set) ⇒ <code>Promise</code>
|
|
1194
|
+
* [.remove(slugOrUuidOrId, key)](#balena.models.application.buildVar.remove) ⇒ <code>Promise</code>
|
|
1195
1195
|
|
|
1196
1196
|
<a name="balena.models.application.buildVar.getAllByApplication"></a>
|
|
1197
1197
|
|
|
1198
|
-
###### buildVar.getAllByApplication(
|
|
1198
|
+
###### buildVar.getAllByApplication(slugOrUuidOrId, [options]) ⇒ <code>Promise</code>
|
|
1199
1199
|
**Kind**: static method of [<code>buildVar</code>](#balena.models.application.buildVar)
|
|
1200
1200
|
**Summary**: Get all build environment variables for an application
|
|
1201
1201
|
**Access**: public
|
|
@@ -1203,7 +1203,7 @@ balena.models.application.envVar.remove('myorganization/myapp', 'VAR', function(
|
|
|
1203
1203
|
|
|
1204
1204
|
| Param | Type | Default | Description |
|
|
1205
1205
|
| --- | --- | --- | --- |
|
|
1206
|
-
|
|
|
1206
|
+
| slugOrUuidOrId | <code>String</code> \| <code>Number</code> | | application slug (string), uuid (string) or id (number) |
|
|
1207
1207
|
| [options] | <code>Object</code> | <code>{}</code> | extra pine options to use |
|
|
1208
1208
|
|
|
1209
1209
|
**Example**
|
|
@@ -1227,7 +1227,7 @@ balena.models.application.buildVar.getAllByApplication('myorganization/myapp', f
|
|
|
1227
1227
|
```
|
|
1228
1228
|
<a name="balena.models.application.buildVar.get"></a>
|
|
1229
1229
|
|
|
1230
|
-
###### buildVar.get(
|
|
1230
|
+
###### buildVar.get(slugOrUuidOrId, key) ⇒ <code>Promise</code>
|
|
1231
1231
|
**Kind**: static method of [<code>buildVar</code>](#balena.models.application.buildVar)
|
|
1232
1232
|
**Summary**: Get the value of a specific build environment variable
|
|
1233
1233
|
**Access**: public
|
|
@@ -1235,7 +1235,7 @@ balena.models.application.buildVar.getAllByApplication('myorganization/myapp', f
|
|
|
1235
1235
|
|
|
1236
1236
|
| Param | Type | Description |
|
|
1237
1237
|
| --- | --- | --- |
|
|
1238
|
-
|
|
|
1238
|
+
| slugOrUuidOrId | <code>String</code> \| <code>Number</code> | application slug (string), uuid (string) or id (number) |
|
|
1239
1239
|
| key | <code>String</code> | build environment variable name |
|
|
1240
1240
|
|
|
1241
1241
|
**Example**
|
|
@@ -1259,14 +1259,14 @@ balena.models.application.buildVar.get('myorganization/myapp', 'VAR', function(e
|
|
|
1259
1259
|
```
|
|
1260
1260
|
<a name="balena.models.application.buildVar.set"></a>
|
|
1261
1261
|
|
|
1262
|
-
###### buildVar.set(
|
|
1262
|
+
###### buildVar.set(slugOrUuidOrId, key, value) ⇒ <code>Promise</code>
|
|
1263
1263
|
**Kind**: static method of [<code>buildVar</code>](#balena.models.application.buildVar)
|
|
1264
1264
|
**Summary**: Set the value of a specific build environment variable
|
|
1265
1265
|
**Access**: public
|
|
1266
1266
|
|
|
1267
1267
|
| Param | Type | Description |
|
|
1268
1268
|
| --- | --- | --- |
|
|
1269
|
-
|
|
|
1269
|
+
| slugOrUuidOrId | <code>String</code> \| <code>Number</code> | application slug (string), uuid (string) or id (number) |
|
|
1270
1270
|
| key | <code>String</code> | build environment variable name |
|
|
1271
1271
|
| value | <code>String</code> | build environment variable value |
|
|
1272
1272
|
|
|
@@ -1291,14 +1291,14 @@ balena.models.application.buildVar.set('myorganization/myapp', 'VAR', 'newvalue'
|
|
|
1291
1291
|
```
|
|
1292
1292
|
<a name="balena.models.application.buildVar.remove"></a>
|
|
1293
1293
|
|
|
1294
|
-
###### buildVar.remove(
|
|
1294
|
+
###### buildVar.remove(slugOrUuidOrId, key) ⇒ <code>Promise</code>
|
|
1295
1295
|
**Kind**: static method of [<code>buildVar</code>](#balena.models.application.buildVar)
|
|
1296
1296
|
**Summary**: Clear the value of a specific build environment variable
|
|
1297
1297
|
**Access**: public
|
|
1298
1298
|
|
|
1299
1299
|
| Param | Type | Description |
|
|
1300
1300
|
| --- | --- | --- |
|
|
1301
|
-
|
|
|
1301
|
+
| slugOrUuidOrId | <code>String</code> \| <code>Number</code> | application slug (string), uuid (string) or id (number) |
|
|
1302
1302
|
| key | <code>String</code> | build environment variable name |
|
|
1303
1303
|
|
|
1304
1304
|
**Example**
|
|
@@ -1328,7 +1328,7 @@ balena.models.application.buildVar.remove('myorganization/myapp', 'VAR', functio
|
|
|
1328
1328
|
* [.membership](#balena.models.application.membership) : <code>object</code>
|
|
1329
1329
|
* [.get(membershipId, [options])](#balena.models.application.membership.get) ⇒ <code>Promise</code>
|
|
1330
1330
|
* [.getAll([options])](#balena.models.application.membership.getAll) ⇒ <code>Promise</code>
|
|
1331
|
-
* [.getAllByApplication(
|
|
1331
|
+
* [.getAllByApplication(slugOrUuidOrId, [options])](#balena.models.application.membership.getAllByApplication) ⇒ <code>Promise</code>
|
|
1332
1332
|
* [.create(options)](#balena.models.application.membership.create) ⇒ <code>Promise</code>
|
|
1333
1333
|
* [.changeRole(idOrUniqueKey, roleName)](#balena.models.application.membership.changeRole) ⇒ <code>Promise</code>
|
|
1334
1334
|
* [.remove(idOrUniqueKey)](#balena.models.application.membership.remove) ⇒ <code>Promise</code>
|
|
@@ -1388,7 +1388,7 @@ balena.models.application.membership.getAll(function(error, memberships) {
|
|
|
1388
1388
|
```
|
|
1389
1389
|
<a name="balena.models.application.membership.getAllByApplication"></a>
|
|
1390
1390
|
|
|
1391
|
-
###### membership.getAllByApplication(
|
|
1391
|
+
###### membership.getAllByApplication(slugOrUuidOrId, [options]) ⇒ <code>Promise</code>
|
|
1392
1392
|
This method returns all application memberships for a specific application.
|
|
1393
1393
|
|
|
1394
1394
|
**Kind**: static method of [<code>membership</code>](#balena.models.application.membership)
|
|
@@ -1398,7 +1398,7 @@ This method returns all application memberships for a specific application.
|
|
|
1398
1398
|
|
|
1399
1399
|
| Param | Type | Default | Description |
|
|
1400
1400
|
| --- | --- | --- | --- |
|
|
1401
|
-
|
|
|
1401
|
+
| slugOrUuidOrId | <code>String</code> \| <code>Number</code> | | application slug (string), uuid (string) or id (number) |
|
|
1402
1402
|
| [options] | <code>Object</code> | <code>{}</code> | extra pine options to use |
|
|
1403
1403
|
|
|
1404
1404
|
**Example**
|
|
@@ -1519,8 +1519,8 @@ balena.models.application.membership.remove(123,function(error) {
|
|
|
1519
1519
|
|
|
1520
1520
|
* [.invite](#balena.models.application.invite) : <code>object</code>
|
|
1521
1521
|
* [.getAll([options])](#balena.models.application.invite.getAll) ⇒ <code>Promise</code>
|
|
1522
|
-
* [.getAllByApplication(
|
|
1523
|
-
* [.create(
|
|
1522
|
+
* [.getAllByApplication(slugOrUuidOrId, [options])](#balena.models.application.invite.getAllByApplication) ⇒ <code>Promise</code>
|
|
1523
|
+
* [.create(slugOrUuidOrId, options, [message])](#balena.models.application.invite.create) ⇒ <code>Promise</code>
|
|
1524
1524
|
* [.revoke(id)](#balena.models.application.invite.revoke) ⇒ <code>Promise</code>
|
|
1525
1525
|
* [.accept(invitationToken)](#balena.models.application.invite.accept) ⇒ <code>Promise</code>
|
|
1526
1526
|
|
|
@@ -1552,7 +1552,7 @@ balena.models.application.invite.getAll(function(error, invites) {
|
|
|
1552
1552
|
```
|
|
1553
1553
|
<a name="balena.models.application.invite.getAllByApplication"></a>
|
|
1554
1554
|
|
|
1555
|
-
###### invite.getAllByApplication(
|
|
1555
|
+
###### invite.getAllByApplication(slugOrUuidOrId, [options]) ⇒ <code>Promise</code>
|
|
1556
1556
|
This method returns all invites for a specific application.
|
|
1557
1557
|
|
|
1558
1558
|
**Kind**: static method of [<code>invite</code>](#balena.models.application.invite)
|
|
@@ -1562,7 +1562,7 @@ This method returns all invites for a specific application.
|
|
|
1562
1562
|
|
|
1563
1563
|
| Param | Type | Default | Description |
|
|
1564
1564
|
| --- | --- | --- | --- |
|
|
1565
|
-
|
|
|
1565
|
+
| slugOrUuidOrId | <code>String</code> \| <code>Number</code> | | application slug (string), uuid (string) or id (number) |
|
|
1566
1566
|
| [options] | <code>Object</code> | <code>{}</code> | extra pine options to use |
|
|
1567
1567
|
|
|
1568
1568
|
**Example**
|
|
@@ -1585,7 +1585,7 @@ balena.models.application.invite.getAllByApplication(123, function(error, invite
|
|
|
1585
1585
|
```
|
|
1586
1586
|
<a name="balena.models.application.invite.create"></a>
|
|
1587
1587
|
|
|
1588
|
-
###### invite.create(
|
|
1588
|
+
###### invite.create(slugOrUuidOrId, options, [message]) ⇒ <code>Promise</code>
|
|
1589
1589
|
This method invites a user by their email to an application.
|
|
1590
1590
|
|
|
1591
1591
|
**Kind**: static method of [<code>invite</code>](#balena.models.application.invite)
|
|
@@ -1595,7 +1595,7 @@ This method invites a user by their email to an application.
|
|
|
1595
1595
|
|
|
1596
1596
|
| Param | Type | Default | Description |
|
|
1597
1597
|
| --- | --- | --- | --- |
|
|
1598
|
-
|
|
|
1598
|
+
| slugOrUuidOrId | <code>String</code> \| <code>Number</code> | | application slug (string), uuid (string) or id (number) |
|
|
1599
1599
|
| options | <code>Object</code> | | invite creation parameters |
|
|
1600
1600
|
| options.invitee | <code>String</code> | | the email/balena_username of the invitee |
|
|
1601
1601
|
| [options.roleName] | <code>String</code> | <code>"developer"</code> | the role name to be granted to the invitee |
|
|
@@ -1734,7 +1734,7 @@ balena.models.application.getAllDirectlyAccessible(function(error, applications)
|
|
|
1734
1734
|
```
|
|
1735
1735
|
<a name="balena.models.application.get"></a>
|
|
1736
1736
|
|
|
1737
|
-
##### application.get(
|
|
1737
|
+
##### application.get(slugOrUuidOrId, [options], [context]) ⇒ <code>Promise</code>
|
|
1738
1738
|
**Kind**: static method of [<code>application</code>](#balena.models.application)
|
|
1739
1739
|
**Summary**: Get a single application
|
|
1740
1740
|
**Access**: public
|
|
@@ -1742,7 +1742,7 @@ balena.models.application.getAllDirectlyAccessible(function(error, applications)
|
|
|
1742
1742
|
|
|
1743
1743
|
| Param | Type | Default | Description |
|
|
1744
1744
|
| --- | --- | --- | --- |
|
|
1745
|
-
|
|
|
1745
|
+
| slugOrUuidOrId | <code>String</code> \| <code>Number</code> | | application slug (string), uuid (string) or id (number) |
|
|
1746
1746
|
| [options] | <code>Object</code> | <code>{}</code> | extra pine options to use |
|
|
1747
1747
|
| [context] | <code>String</code> | | extra access filters, undefined or 'directly_accessible' |
|
|
1748
1748
|
|
|
@@ -1754,6 +1754,12 @@ balena.models.application.get('myorganization/myapp').then(function(application)
|
|
|
1754
1754
|
```
|
|
1755
1755
|
**Example**
|
|
1756
1756
|
```js
|
|
1757
|
+
balena.models.application.get('1bf99a68cf9e4266986e6dec7a6e8f46').then(function(application) {
|
|
1758
|
+
console.log(application);
|
|
1759
|
+
});
|
|
1760
|
+
```
|
|
1761
|
+
**Example**
|
|
1762
|
+
```js
|
|
1757
1763
|
balena.models.application.get(123).then(function(application) {
|
|
1758
1764
|
console.log(application);
|
|
1759
1765
|
});
|
|
@@ -1767,7 +1773,7 @@ balena.models.application.get('myorganization/myapp', function(error, applicatio
|
|
|
1767
1773
|
```
|
|
1768
1774
|
<a name="balena.models.application.getDirectlyAccessible"></a>
|
|
1769
1775
|
|
|
1770
|
-
##### application.getDirectlyAccessible(
|
|
1776
|
+
##### application.getDirectlyAccessible(slugOrUuidOrId, [options]) ⇒ <code>Promise</code>
|
|
1771
1777
|
**Kind**: static method of [<code>application</code>](#balena.models.application)
|
|
1772
1778
|
**Summary**: Get a single application directly accessible by the user
|
|
1773
1779
|
**Access**: public
|
|
@@ -1775,7 +1781,7 @@ balena.models.application.get('myorganization/myapp', function(error, applicatio
|
|
|
1775
1781
|
|
|
1776
1782
|
| Param | Type | Default | Description |
|
|
1777
1783
|
| --- | --- | --- | --- |
|
|
1778
|
-
|
|
|
1784
|
+
| slugOrUuidOrId | <code>String</code> \| <code>Number</code> | | application slug (string), uuid (string) or id (number) |
|
|
1779
1785
|
| [options] | <code>Object</code> | <code>{}</code> | extra pine options to use |
|
|
1780
1786
|
|
|
1781
1787
|
**Example**
|
|
@@ -1799,7 +1805,7 @@ balena.models.application.getDirectlyAccessible('myorganization/myapp', function
|
|
|
1799
1805
|
```
|
|
1800
1806
|
<a name="balena.models.application.getWithDeviceServiceDetails"></a>
|
|
1801
1807
|
|
|
1802
|
-
##### application.getWithDeviceServiceDetails(
|
|
1808
|
+
##### application.getWithDeviceServiceDetails(slugOrUuidOrId, [options]) ⇒ <code>Promise</code>
|
|
1803
1809
|
This method does not map exactly to the underlying model: it runs a
|
|
1804
1810
|
larger prebuilt query, and reformats it into an easy to use and
|
|
1805
1811
|
understand format. If you want more control, or to see the raw model
|
|
@@ -1813,7 +1819,7 @@ associated services' essential details
|
|
|
1813
1819
|
|
|
1814
1820
|
| Param | Type | Default | Description |
|
|
1815
1821
|
| --- | --- | --- | --- |
|
|
1816
|
-
|
|
|
1822
|
+
| slugOrUuidOrId | <code>String</code> \| <code>Number</code> | | application slug (string), uuid (string) or id (number) |
|
|
1817
1823
|
| [options] | <code>Object</code> | <code>{}</code> | extra pine options to use |
|
|
1818
1824
|
|
|
1819
1825
|
**Example**
|
|
@@ -1877,7 +1883,7 @@ balena.models.application.getAppByOwner('myorganization/myapp', 'MyOrg').then(fu
|
|
|
1877
1883
|
```
|
|
1878
1884
|
<a name="balena.models.application.has"></a>
|
|
1879
1885
|
|
|
1880
|
-
##### application.has(
|
|
1886
|
+
##### application.has(slugOrUuidOrId) ⇒ <code>Promise</code>
|
|
1881
1887
|
**Kind**: static method of [<code>application</code>](#balena.models.application)
|
|
1882
1888
|
**Summary**: Check if an application exists
|
|
1883
1889
|
**Access**: public
|
|
@@ -1885,7 +1891,7 @@ balena.models.application.getAppByOwner('myorganization/myapp', 'MyOrg').then(fu
|
|
|
1885
1891
|
|
|
1886
1892
|
| Param | Type | Description |
|
|
1887
1893
|
| --- | --- | --- |
|
|
1888
|
-
|
|
|
1894
|
+
| slugOrUuidOrId | <code>String</code> \| <code>Number</code> | application slug (string), uuid (string) or id (number) |
|
|
1889
1895
|
|
|
1890
1896
|
**Example**
|
|
1891
1897
|
```js
|
|
@@ -1964,14 +1970,14 @@ balena.models.application.create({ name: 'My App', applicationType: 'microservic
|
|
|
1964
1970
|
```
|
|
1965
1971
|
<a name="balena.models.application.remove"></a>
|
|
1966
1972
|
|
|
1967
|
-
##### application.remove(
|
|
1973
|
+
##### application.remove(slugOrUuidOrId) ⇒ <code>Promise</code>
|
|
1968
1974
|
**Kind**: static method of [<code>application</code>](#balena.models.application)
|
|
1969
1975
|
**Summary**: Remove application
|
|
1970
1976
|
**Access**: public
|
|
1971
1977
|
|
|
1972
1978
|
| Param | Type | Description |
|
|
1973
1979
|
| --- | --- | --- |
|
|
1974
|
-
|
|
|
1980
|
+
| slugOrUuidOrId | <code>String</code> \| <code>Number</code> | application slug (string), uuid (string) or id (number) |
|
|
1975
1981
|
|
|
1976
1982
|
**Example**
|
|
1977
1983
|
```js
|
|
@@ -1989,14 +1995,14 @@ balena.models.application.remove('myorganization/myapp', function(error) {
|
|
|
1989
1995
|
```
|
|
1990
1996
|
<a name="balena.models.application.rename"></a>
|
|
1991
1997
|
|
|
1992
|
-
##### application.rename(
|
|
1998
|
+
##### application.rename(slugOrUuidOrId, newName) ⇒ <code>Promise</code>
|
|
1993
1999
|
**Kind**: static method of [<code>application</code>](#balena.models.application)
|
|
1994
2000
|
**Summary**: Rename application
|
|
1995
2001
|
**Access**: public
|
|
1996
2002
|
|
|
1997
2003
|
| Param | Type | Description |
|
|
1998
2004
|
| --- | --- | --- |
|
|
1999
|
-
|
|
|
2005
|
+
| slugOrUuidOrId | <code>String</code> \| <code>Number</code> | application slug (string), uuid (string) or id (number) |
|
|
2000
2006
|
| newName | <code>String</code> | new application name (string) |
|
|
2001
2007
|
|
|
2002
2008
|
**Example**
|
|
@@ -2015,14 +2021,14 @@ balena.models.application.rename('myorganization/myapp', 'MyRenamedApp', functio
|
|
|
2015
2021
|
```
|
|
2016
2022
|
<a name="balena.models.application.restart"></a>
|
|
2017
2023
|
|
|
2018
|
-
##### application.restart(
|
|
2024
|
+
##### application.restart(slugOrUuidOrId) ⇒ <code>Promise</code>
|
|
2019
2025
|
**Kind**: static method of [<code>application</code>](#balena.models.application)
|
|
2020
2026
|
**Summary**: Restart application
|
|
2021
2027
|
**Access**: public
|
|
2022
2028
|
|
|
2023
2029
|
| Param | Type | Description |
|
|
2024
2030
|
| --- | --- | --- |
|
|
2025
|
-
|
|
|
2031
|
+
| slugOrUuidOrId | <code>String</code> \| <code>Number</code> | application slug (string), uuid (string) or id (number) |
|
|
2026
2032
|
|
|
2027
2033
|
**Example**
|
|
2028
2034
|
```js
|
|
@@ -2040,7 +2046,7 @@ balena.models.application.restart('myorganization/myapp', function(error) {
|
|
|
2040
2046
|
```
|
|
2041
2047
|
<a name="balena.models.application.generateApiKey"></a>
|
|
2042
2048
|
|
|
2043
|
-
##### ~~application.generateApiKey(
|
|
2049
|
+
##### ~~application.generateApiKey(slugOrUuidOrId) ⇒ <code>Promise</code>~~
|
|
2044
2050
|
***Deprecated***
|
|
2045
2051
|
|
|
2046
2052
|
Generally you shouldn't use this method: if you're provisioning a recent BalenaOS
|
|
@@ -2054,7 +2060,7 @@ be more secure.
|
|
|
2054
2060
|
|
|
2055
2061
|
| Param | Type | Description |
|
|
2056
2062
|
| --- | --- | --- |
|
|
2057
|
-
|
|
|
2063
|
+
| slugOrUuidOrId | <code>String</code> \| <code>Number</code> | application slug (string), uuid (string) or id (number) |
|
|
2058
2064
|
|
|
2059
2065
|
**Example**
|
|
2060
2066
|
```js
|
|
@@ -2077,7 +2083,7 @@ balena.models.application.generateApiKey('myorganization/myapp', function(error,
|
|
|
2077
2083
|
```
|
|
2078
2084
|
<a name="balena.models.application.generateProvisioningKey"></a>
|
|
2079
2085
|
|
|
2080
|
-
##### application.generateProvisioningKey(
|
|
2086
|
+
##### application.generateProvisioningKey(slugOrUuidOrId, [keyName], [keyDescription]) ⇒ <code>Promise</code>
|
|
2081
2087
|
**Kind**: static method of [<code>application</code>](#balena.models.application)
|
|
2082
2088
|
**Summary**: Generate a device provisioning key for a specific application
|
|
2083
2089
|
**Access**: public
|
|
@@ -2085,7 +2091,7 @@ balena.models.application.generateApiKey('myorganization/myapp', function(error,
|
|
|
2085
2091
|
|
|
2086
2092
|
| Param | Type | Description |
|
|
2087
2093
|
| --- | --- | --- |
|
|
2088
|
-
|
|
|
2094
|
+
| slugOrUuidOrId | <code>String</code> \| <code>Number</code> | application slug (string), uuid (string) or id (number) |
|
|
2089
2095
|
| [keyName] | <code>String</code> | Provisioning key name |
|
|
2090
2096
|
| [keyDescription] | <code>String</code> | Description for provisioning key |
|
|
2091
2097
|
|
|
@@ -2177,7 +2183,7 @@ balena.models.application.reboot(123, function(error) {
|
|
|
2177
2183
|
```
|
|
2178
2184
|
<a name="balena.models.application.willTrackNewReleases"></a>
|
|
2179
2185
|
|
|
2180
|
-
##### application.willTrackNewReleases(
|
|
2186
|
+
##### application.willTrackNewReleases(slugOrUuidOrId) ⇒ <code>Promise</code>
|
|
2181
2187
|
**Kind**: static method of [<code>application</code>](#balena.models.application)
|
|
2182
2188
|
**Summary**: Get whether the application is configured to receive updates whenever a new release is available
|
|
2183
2189
|
**Access**: public
|
|
@@ -2185,7 +2191,7 @@ balena.models.application.reboot(123, function(error) {
|
|
|
2185
2191
|
|
|
2186
2192
|
| Param | Type | Description |
|
|
2187
2193
|
| --- | --- | --- |
|
|
2188
|
-
|
|
|
2194
|
+
| slugOrUuidOrId | <code>String</code> \| <code>Number</code> | application slug (string), uuid (string) or id (number) |
|
|
2189
2195
|
|
|
2190
2196
|
**Example**
|
|
2191
2197
|
```js
|
|
@@ -2207,7 +2213,7 @@ balena.models.application.willTrackNewReleases('myorganization/myapp', function(
|
|
|
2207
2213
|
```
|
|
2208
2214
|
<a name="balena.models.application.isTrackingLatestRelease"></a>
|
|
2209
2215
|
|
|
2210
|
-
##### application.isTrackingLatestRelease(
|
|
2216
|
+
##### application.isTrackingLatestRelease(slugOrUuidOrId) ⇒ <code>Promise</code>
|
|
2211
2217
|
**Kind**: static method of [<code>application</code>](#balena.models.application)
|
|
2212
2218
|
**Summary**: Get whether the application is up to date and is tracking the latest finalized release for updates
|
|
2213
2219
|
**Access**: public
|
|
@@ -2215,7 +2221,7 @@ balena.models.application.willTrackNewReleases('myorganization/myapp', function(
|
|
|
2215
2221
|
|
|
2216
2222
|
| Param | Type | Description |
|
|
2217
2223
|
| --- | --- | --- |
|
|
2218
|
-
|
|
|
2224
|
+
| slugOrUuidOrId | <code>String</code> \| <code>Number</code> | application slug (string), uuid (string) or id (number) |
|
|
2219
2225
|
|
|
2220
2226
|
**Example**
|
|
2221
2227
|
```js
|
|
@@ -2237,7 +2243,7 @@ balena.models.application.isTrackingLatestRelease('myorganization/myapp', functi
|
|
|
2237
2243
|
```
|
|
2238
2244
|
<a name="balena.models.application.pinToRelease"></a>
|
|
2239
2245
|
|
|
2240
|
-
##### application.pinToRelease(
|
|
2246
|
+
##### application.pinToRelease(slugOrUuidOrId, fullReleaseHash) ⇒ <code>Promise</code>
|
|
2241
2247
|
Configures the application to run a particular release
|
|
2242
2248
|
and not get updated when the latest release changes.
|
|
2243
2249
|
|
|
@@ -2247,7 +2253,7 @@ and not get updated when the latest release changes.
|
|
|
2247
2253
|
|
|
2248
2254
|
| Param | Type | Description |
|
|
2249
2255
|
| --- | --- | --- |
|
|
2250
|
-
|
|
|
2256
|
+
| slugOrUuidOrId | <code>String</code> \| <code>Number</code> | application slug (string), uuid (string) or id (number) |
|
|
2251
2257
|
| fullReleaseHash | <code>String</code> | the hash of a successful release (string) |
|
|
2252
2258
|
|
|
2253
2259
|
**Example**
|
|
@@ -2271,7 +2277,7 @@ balena.models.application.pinToRelease('myorganization/myapp', 'f7caf4ff80114dee
|
|
|
2271
2277
|
```
|
|
2272
2278
|
<a name="balena.models.application.getTargetReleaseHash"></a>
|
|
2273
2279
|
|
|
2274
|
-
##### application.getTargetReleaseHash(
|
|
2280
|
+
##### application.getTargetReleaseHash(slugOrUuidOrId) ⇒ <code>Promise</code>
|
|
2275
2281
|
**Kind**: static method of [<code>application</code>](#balena.models.application)
|
|
2276
2282
|
**Summary**: Get the hash of the current release for a specific application
|
|
2277
2283
|
**Access**: public
|
|
@@ -2279,7 +2285,7 @@ balena.models.application.pinToRelease('myorganization/myapp', 'f7caf4ff80114dee
|
|
|
2279
2285
|
|
|
2280
2286
|
| Param | Type | Description |
|
|
2281
2287
|
| --- | --- | --- |
|
|
2282
|
-
|
|
|
2288
|
+
| slugOrUuidOrId | <code>String</code> \| <code>Number</code> | application slug (string), uuid (string) or id (number) |
|
|
2283
2289
|
|
|
2284
2290
|
**Example**
|
|
2285
2291
|
```js
|
|
@@ -2301,7 +2307,7 @@ balena.models.application.getTargetReleaseHash('myorganization/myapp', function(
|
|
|
2301
2307
|
```
|
|
2302
2308
|
<a name="balena.models.application.trackLatestRelease"></a>
|
|
2303
2309
|
|
|
2304
|
-
##### application.trackLatestRelease(
|
|
2310
|
+
##### application.trackLatestRelease(slugOrUuidOrId) ⇒ <code>Promise</code>
|
|
2305
2311
|
The application's current release will be updated with each new successfully built release.
|
|
2306
2312
|
|
|
2307
2313
|
**Kind**: static method of [<code>application</code>](#balena.models.application)
|
|
@@ -2310,7 +2316,7 @@ The application's current release will be updated with each new successfully bui
|
|
|
2310
2316
|
|
|
2311
2317
|
| Param | Type | Description |
|
|
2312
2318
|
| --- | --- | --- |
|
|
2313
|
-
|
|
|
2319
|
+
| slugOrUuidOrId | <code>String</code> \| <code>Number</code> | application slug (string), uuid (string) or id (number) |
|
|
2314
2320
|
|
|
2315
2321
|
**Example**
|
|
2316
2322
|
```js
|
|
@@ -2333,14 +2339,14 @@ balena.models.application.trackLatestRelease('myorganization/myapp', function(er
|
|
|
2333
2339
|
```
|
|
2334
2340
|
<a name="balena.models.application.enableDeviceUrls"></a>
|
|
2335
2341
|
|
|
2336
|
-
##### application.enableDeviceUrls(
|
|
2342
|
+
##### application.enableDeviceUrls(slugOrUuidOrId) ⇒ <code>Promise</code>
|
|
2337
2343
|
**Kind**: static method of [<code>application</code>](#balena.models.application)
|
|
2338
2344
|
**Summary**: Enable device urls for all devices that belong to an application
|
|
2339
2345
|
**Access**: public
|
|
2340
2346
|
|
|
2341
2347
|
| Param | Type | Description |
|
|
2342
2348
|
| --- | --- | --- |
|
|
2343
|
-
|
|
|
2349
|
+
| slugOrUuidOrId | <code>String</code> \| <code>Number</code> | application slug (string), uuid (string) or id (number) |
|
|
2344
2350
|
|
|
2345
2351
|
**Example**
|
|
2346
2352
|
```js
|
|
@@ -2358,14 +2364,14 @@ balena.models.device.enableDeviceUrls('myorganization/myapp', function(error) {
|
|
|
2358
2364
|
```
|
|
2359
2365
|
<a name="balena.models.application.disableDeviceUrls"></a>
|
|
2360
2366
|
|
|
2361
|
-
##### application.disableDeviceUrls(
|
|
2367
|
+
##### application.disableDeviceUrls(slugOrUuidOrId) ⇒ <code>Promise</code>
|
|
2362
2368
|
**Kind**: static method of [<code>application</code>](#balena.models.application)
|
|
2363
2369
|
**Summary**: Disable device urls for all devices that belong to an application
|
|
2364
2370
|
**Access**: public
|
|
2365
2371
|
|
|
2366
2372
|
| Param | Type | Description |
|
|
2367
2373
|
| --- | --- | --- |
|
|
2368
|
-
|
|
|
2374
|
+
| slugOrUuidOrId | <code>String</code> \| <code>Number</code> | application slug (string), uuid (string) or id (number) |
|
|
2369
2375
|
|
|
2370
2376
|
**Example**
|
|
2371
2377
|
```js
|
|
@@ -2383,14 +2389,14 @@ balena.models.device.disableDeviceUrls('myorganization/myapp', function(error) {
|
|
|
2383
2389
|
```
|
|
2384
2390
|
<a name="balena.models.application.grantSupportAccess"></a>
|
|
2385
2391
|
|
|
2386
|
-
##### application.grantSupportAccess(
|
|
2392
|
+
##### application.grantSupportAccess(slugOrUuidOrId, expiryTimestamp) ⇒ <code>Promise</code>
|
|
2387
2393
|
**Kind**: static method of [<code>application</code>](#balena.models.application)
|
|
2388
2394
|
**Summary**: Grant support access to an application until a specified time
|
|
2389
2395
|
**Access**: public
|
|
2390
2396
|
|
|
2391
2397
|
| Param | Type | Description |
|
|
2392
2398
|
| --- | --- | --- |
|
|
2393
|
-
|
|
|
2399
|
+
| slugOrUuidOrId | <code>String</code> \| <code>Number</code> | application slug (string), uuid (string) or id (number) |
|
|
2394
2400
|
| expiryTimestamp | <code>Number</code> | a timestamp in ms for when the support access will expire |
|
|
2395
2401
|
|
|
2396
2402
|
**Example**
|
|
@@ -2409,14 +2415,14 @@ balena.models.application.grantSupportAccess('myorganization/myapp', Date.now()
|
|
|
2409
2415
|
```
|
|
2410
2416
|
<a name="balena.models.application.revokeSupportAccess"></a>
|
|
2411
2417
|
|
|
2412
|
-
##### application.revokeSupportAccess(
|
|
2418
|
+
##### application.revokeSupportAccess(slugOrUuidOrId) ⇒ <code>Promise</code>
|
|
2413
2419
|
**Kind**: static method of [<code>application</code>](#balena.models.application)
|
|
2414
2420
|
**Summary**: Revoke support access to an application
|
|
2415
2421
|
**Access**: public
|
|
2416
2422
|
|
|
2417
2423
|
| Param | Type | Description |
|
|
2418
2424
|
| --- | --- | --- |
|
|
2419
|
-
|
|
|
2425
|
+
| slugOrUuidOrId | <code>String</code> \| <code>Number</code> | application slug (string), uuid (string) or id (number) |
|
|
2420
2426
|
|
|
2421
2427
|
**Example**
|
|
2422
2428
|
```js
|
|
@@ -2439,32 +2445,32 @@ balena.models.application.revokeSupportAccess('myorganization/myapp', function(e
|
|
|
2439
2445
|
|
|
2440
2446
|
* [.device](#balena.models.device) : <code>object</code>
|
|
2441
2447
|
* [.tags](#balena.models.device.tags) : <code>object</code>
|
|
2442
|
-
* [.getAllByApplication(
|
|
2448
|
+
* [.getAllByApplication(slugOrUuidOrId, [options])](#balena.models.device.tags.getAllByApplication) ⇒ <code>Promise</code>
|
|
2443
2449
|
* [.getAllByDevice(uuidOrId, [options])](#balena.models.device.tags.getAllByDevice) ⇒ <code>Promise</code>
|
|
2444
2450
|
* [.getAll([options])](#balena.models.device.tags.getAll) ⇒ <code>Promise</code>
|
|
2445
2451
|
* [.set(uuidOrId, tagKey, value)](#balena.models.device.tags.set) ⇒ <code>Promise</code>
|
|
2446
2452
|
* [.remove(uuidOrId, tagKey)](#balena.models.device.tags.remove) ⇒ <code>Promise</code>
|
|
2447
2453
|
* [.configVar](#balena.models.device.configVar) : <code>object</code>
|
|
2448
2454
|
* [.getAllByDevice(uuidOrId, [options])](#balena.models.device.configVar.getAllByDevice) ⇒ <code>Promise</code>
|
|
2449
|
-
* [.getAllByApplication(
|
|
2455
|
+
* [.getAllByApplication(slugOrUuidOrId, [options])](#balena.models.device.configVar.getAllByApplication) ⇒ <code>Promise</code>
|
|
2450
2456
|
* [.get(uuidOrId, key)](#balena.models.device.configVar.get) ⇒ <code>Promise</code>
|
|
2451
2457
|
* [.set(uuidOrId, key, value)](#balena.models.device.configVar.set) ⇒ <code>Promise</code>
|
|
2452
2458
|
* [.remove(uuidOrId, key)](#balena.models.device.configVar.remove) ⇒ <code>Promise</code>
|
|
2453
2459
|
* [.envVar](#balena.models.device.envVar) : <code>object</code>
|
|
2454
2460
|
* [.getAllByDevice(uuidOrId, [options])](#balena.models.device.envVar.getAllByDevice) ⇒ <code>Promise</code>
|
|
2455
|
-
* [.getAllByApplication(
|
|
2461
|
+
* [.getAllByApplication(slugOrUuidOrId, [options])](#balena.models.device.envVar.getAllByApplication) ⇒ <code>Promise</code>
|
|
2456
2462
|
* [.get(uuidOrId, key)](#balena.models.device.envVar.get) ⇒ <code>Promise</code>
|
|
2457
2463
|
* [.set(uuidOrId, key, value)](#balena.models.device.envVar.set) ⇒ <code>Promise</code>
|
|
2458
2464
|
* [.remove(uuidOrId, key)](#balena.models.device.envVar.remove) ⇒ <code>Promise</code>
|
|
2459
2465
|
* [.serviceVar](#balena.models.device.serviceVar) : <code>object</code>
|
|
2460
2466
|
* [.getAllByDevice(uuidOrId, [options])](#balena.models.device.serviceVar.getAllByDevice) ⇒ <code>Promise</code>
|
|
2461
|
-
* [.getAllByApplication(
|
|
2467
|
+
* [.getAllByApplication(slugOrUuidOrId, [options])](#balena.models.device.serviceVar.getAllByApplication) ⇒ <code>Promise</code>
|
|
2462
2468
|
* [.get(uuidOrId, id, key)](#balena.models.device.serviceVar.get) ⇒ <code>Promise</code>
|
|
2463
2469
|
* [.set(uuidOrId, id, key, value)](#balena.models.device.serviceVar.set) ⇒ <code>Promise</code>
|
|
2464
2470
|
* [.remove(uuidOrId, id, key)](#balena.models.device.serviceVar.remove) ⇒ <code>Promise</code>
|
|
2465
2471
|
* [.getDashboardUrl(uuid)](#balena.models.device.getDashboardUrl) ⇒ <code>String</code>
|
|
2466
2472
|
* [.getAll([options])](#balena.models.device.getAll) ⇒ <code>Promise</code>
|
|
2467
|
-
* [.getAllByApplication(
|
|
2473
|
+
* [.getAllByApplication(slugOrUuidOrId, [options])](#balena.models.device.getAllByApplication) ⇒ <code>Promise</code>
|
|
2468
2474
|
* [.getAllByParentDevice(parentUuidOrId, [options])](#balena.models.device.getAllByParentDevice) ⇒ <code>Promise</code>
|
|
2469
2475
|
* [.get(uuidOrId, [options])](#balena.models.device.get) ⇒ <code>Promise</code>
|
|
2470
2476
|
* [.getWithServiceDetails(uuidOrId, [options])](#balena.models.device.getWithServiceDetails) ⇒ <code>Promise</code>
|
|
@@ -2482,13 +2488,13 @@ balena.models.application.revokeSupportAccess('myorganization/myapp', function(e
|
|
|
2482
2488
|
* [.note(uuidOrId, note)](#balena.models.device.note) ⇒ <code>Promise</code>
|
|
2483
2489
|
* [.setCustomLocation(uuidOrId, location)](#balena.models.device.setCustomLocation) ⇒ <code>Promise</code>
|
|
2484
2490
|
* [.unsetCustomLocation(uuidOrId)](#balena.models.device.unsetCustomLocation) ⇒ <code>Promise</code>
|
|
2485
|
-
* [.move(uuidOrId,
|
|
2491
|
+
* [.move(uuidOrId, applicationSlugOrUuidOrId)](#balena.models.device.move) ⇒ <code>Promise</code>
|
|
2486
2492
|
* [.restartApplication(uuidOrId)](#balena.models.device.restartApplication) ⇒ <code>Promise</code>
|
|
2487
2493
|
* [.getSupervisorTargetState(uuidOrId)](#balena.models.device.getSupervisorTargetState) ⇒ <code>Promise</code>
|
|
2488
2494
|
* ~~[.getManifestBySlug(slugOrName)](#balena.models.device.getManifestBySlug) ⇒ <code>Promise</code>~~
|
|
2489
|
-
* [.getManifestByApplication(
|
|
2495
|
+
* [.getManifestByApplication(slugOrUuidOrId)](#balena.models.device.getManifestByApplication) ⇒ <code>Promise</code>
|
|
2490
2496
|
* [.generateUniqueKey()](#balena.models.device.generateUniqueKey) ⇒ <code>String</code>
|
|
2491
|
-
* [.register(
|
|
2497
|
+
* [.register(applicationSlugOrUuidOrId, uuid)](#balena.models.device.register) ⇒ <code>Promise</code>
|
|
2492
2498
|
* [.generateDeviceKey(uuidOrId)](#balena.models.device.generateDeviceKey) ⇒ <code>Promise</code>
|
|
2493
2499
|
* [.hasDeviceUrl(uuidOrId)](#balena.models.device.hasDeviceUrl) ⇒ <code>Promise</code>
|
|
2494
2500
|
* [.getDeviceUrl(uuidOrId)](#balena.models.device.getDeviceUrl) ⇒ <code>Promise</code>
|
|
@@ -2534,7 +2540,7 @@ balena.models.application.revokeSupportAccess('myorganization/myapp', function(e
|
|
|
2534
2540
|
**Kind**: static namespace of [<code>device</code>](#balena.models.device)
|
|
2535
2541
|
|
|
2536
2542
|
* [.tags](#balena.models.device.tags) : <code>object</code>
|
|
2537
|
-
* [.getAllByApplication(
|
|
2543
|
+
* [.getAllByApplication(slugOrUuidOrId, [options])](#balena.models.device.tags.getAllByApplication) ⇒ <code>Promise</code>
|
|
2538
2544
|
* [.getAllByDevice(uuidOrId, [options])](#balena.models.device.tags.getAllByDevice) ⇒ <code>Promise</code>
|
|
2539
2545
|
* [.getAll([options])](#balena.models.device.tags.getAll) ⇒ <code>Promise</code>
|
|
2540
2546
|
* [.set(uuidOrId, tagKey, value)](#balena.models.device.tags.set) ⇒ <code>Promise</code>
|
|
@@ -2542,7 +2548,7 @@ balena.models.application.revokeSupportAccess('myorganization/myapp', function(e
|
|
|
2542
2548
|
|
|
2543
2549
|
<a name="balena.models.device.tags.getAllByApplication"></a>
|
|
2544
2550
|
|
|
2545
|
-
###### tags.getAllByApplication(
|
|
2551
|
+
###### tags.getAllByApplication(slugOrUuidOrId, [options]) ⇒ <code>Promise</code>
|
|
2546
2552
|
**Kind**: static method of [<code>tags</code>](#balena.models.device.tags)
|
|
2547
2553
|
**Summary**: Get all device tags for an application
|
|
2548
2554
|
**Access**: public
|
|
@@ -2550,7 +2556,7 @@ balena.models.application.revokeSupportAccess('myorganization/myapp', function(e
|
|
|
2550
2556
|
|
|
2551
2557
|
| Param | Type | Default | Description |
|
|
2552
2558
|
| --- | --- | --- | --- |
|
|
2553
|
-
|
|
|
2559
|
+
| slugOrUuidOrId | <code>String</code> \| <code>Number</code> | | application slug (string), uuid (string) or id (number) |
|
|
2554
2560
|
| [options] | <code>Object</code> | <code>{}</code> | extra pine options to use |
|
|
2555
2561
|
|
|
2556
2562
|
**Example**
|
|
@@ -2685,7 +2691,7 @@ balena.models.device.tags.remove('7cf02a6', 'EDITOR', function(error) {
|
|
|
2685
2691
|
|
|
2686
2692
|
* [.configVar](#balena.models.device.configVar) : <code>object</code>
|
|
2687
2693
|
* [.getAllByDevice(uuidOrId, [options])](#balena.models.device.configVar.getAllByDevice) ⇒ <code>Promise</code>
|
|
2688
|
-
* [.getAllByApplication(
|
|
2694
|
+
* [.getAllByApplication(slugOrUuidOrId, [options])](#balena.models.device.configVar.getAllByApplication) ⇒ <code>Promise</code>
|
|
2689
2695
|
* [.get(uuidOrId, key)](#balena.models.device.configVar.get) ⇒ <code>Promise</code>
|
|
2690
2696
|
* [.set(uuidOrId, key, value)](#balena.models.device.configVar.set) ⇒ <code>Promise</code>
|
|
2691
2697
|
* [.remove(uuidOrId, key)](#balena.models.device.configVar.remove) ⇒ <code>Promise</code>
|
|
@@ -2724,7 +2730,7 @@ balena.models.device.configVar.getAllByDevice('7cf02a6', function(error, vars) {
|
|
|
2724
2730
|
```
|
|
2725
2731
|
<a name="balena.models.device.configVar.getAllByApplication"></a>
|
|
2726
2732
|
|
|
2727
|
-
###### configVar.getAllByApplication(
|
|
2733
|
+
###### configVar.getAllByApplication(slugOrUuidOrId, [options]) ⇒ <code>Promise</code>
|
|
2728
2734
|
**Kind**: static method of [<code>configVar</code>](#balena.models.device.configVar)
|
|
2729
2735
|
**Summary**: Get all device config variables by application
|
|
2730
2736
|
**Access**: public
|
|
@@ -2732,7 +2738,7 @@ balena.models.device.configVar.getAllByDevice('7cf02a6', function(error, vars) {
|
|
|
2732
2738
|
|
|
2733
2739
|
| Param | Type | Default | Description |
|
|
2734
2740
|
| --- | --- | --- | --- |
|
|
2735
|
-
|
|
|
2741
|
+
| slugOrUuidOrId | <code>String</code> \| <code>Number</code> | | application slug (string), uuid (string) or id (number) |
|
|
2736
2742
|
| [options] | <code>Object</code> | <code>{}</code> | extra pine options to use |
|
|
2737
2743
|
|
|
2738
2744
|
**Example**
|
|
@@ -2856,7 +2862,7 @@ balena.models.device.configVar.remove('7cf02a6', 'BALENA_VAR', function(error) {
|
|
|
2856
2862
|
|
|
2857
2863
|
* [.envVar](#balena.models.device.envVar) : <code>object</code>
|
|
2858
2864
|
* [.getAllByDevice(uuidOrId, [options])](#balena.models.device.envVar.getAllByDevice) ⇒ <code>Promise</code>
|
|
2859
|
-
* [.getAllByApplication(
|
|
2865
|
+
* [.getAllByApplication(slugOrUuidOrId, [options])](#balena.models.device.envVar.getAllByApplication) ⇒ <code>Promise</code>
|
|
2860
2866
|
* [.get(uuidOrId, key)](#balena.models.device.envVar.get) ⇒ <code>Promise</code>
|
|
2861
2867
|
* [.set(uuidOrId, key, value)](#balena.models.device.envVar.set) ⇒ <code>Promise</code>
|
|
2862
2868
|
* [.remove(uuidOrId, key)](#balena.models.device.envVar.remove) ⇒ <code>Promise</code>
|
|
@@ -2895,7 +2901,7 @@ balena.models.device.envVar.getAllByDevice('7cf02a6', function(error, vars) {
|
|
|
2895
2901
|
```
|
|
2896
2902
|
<a name="balena.models.device.envVar.getAllByApplication"></a>
|
|
2897
2903
|
|
|
2898
|
-
###### envVar.getAllByApplication(
|
|
2904
|
+
###### envVar.getAllByApplication(slugOrUuidOrId, [options]) ⇒ <code>Promise</code>
|
|
2899
2905
|
**Kind**: static method of [<code>envVar</code>](#balena.models.device.envVar)
|
|
2900
2906
|
**Summary**: Get all device environment variables by application
|
|
2901
2907
|
**Access**: public
|
|
@@ -2903,7 +2909,7 @@ balena.models.device.envVar.getAllByDevice('7cf02a6', function(error, vars) {
|
|
|
2903
2909
|
|
|
2904
2910
|
| Param | Type | Default | Description |
|
|
2905
2911
|
| --- | --- | --- | --- |
|
|
2906
|
-
|
|
|
2912
|
+
| slugOrUuidOrId | <code>String</code> \| <code>Number</code> | | application slug (string), uuid (string) or id (number) |
|
|
2907
2913
|
| [options] | <code>Object</code> | <code>{}</code> | extra pine options to use |
|
|
2908
2914
|
|
|
2909
2915
|
**Example**
|
|
@@ -3027,7 +3033,7 @@ balena.models.device.envVar.remove('7cf02a6', 'VAR', function(error) {
|
|
|
3027
3033
|
|
|
3028
3034
|
* [.serviceVar](#balena.models.device.serviceVar) : <code>object</code>
|
|
3029
3035
|
* [.getAllByDevice(uuidOrId, [options])](#balena.models.device.serviceVar.getAllByDevice) ⇒ <code>Promise</code>
|
|
3030
|
-
* [.getAllByApplication(
|
|
3036
|
+
* [.getAllByApplication(slugOrUuidOrId, [options])](#balena.models.device.serviceVar.getAllByApplication) ⇒ <code>Promise</code>
|
|
3031
3037
|
* [.get(uuidOrId, id, key)](#balena.models.device.serviceVar.get) ⇒ <code>Promise</code>
|
|
3032
3038
|
* [.set(uuidOrId, id, key, value)](#balena.models.device.serviceVar.set) ⇒ <code>Promise</code>
|
|
3033
3039
|
* [.remove(uuidOrId, id, key)](#balena.models.device.serviceVar.remove) ⇒ <code>Promise</code>
|
|
@@ -3066,7 +3072,7 @@ balena.models.device.serviceVar.getAllByDevice('7cf02a6', function(error, vars)
|
|
|
3066
3072
|
```
|
|
3067
3073
|
<a name="balena.models.device.serviceVar.getAllByApplication"></a>
|
|
3068
3074
|
|
|
3069
|
-
###### serviceVar.getAllByApplication(
|
|
3075
|
+
###### serviceVar.getAllByApplication(slugOrUuidOrId, [options]) ⇒ <code>Promise</code>
|
|
3070
3076
|
**Kind**: static method of [<code>serviceVar</code>](#balena.models.device.serviceVar)
|
|
3071
3077
|
**Summary**: Get all device service variable overrides by application
|
|
3072
3078
|
**Access**: public
|
|
@@ -3074,7 +3080,7 @@ balena.models.device.serviceVar.getAllByDevice('7cf02a6', function(error, vars)
|
|
|
3074
3080
|
|
|
3075
3081
|
| Param | Type | Default | Description |
|
|
3076
3082
|
| --- | --- | --- | --- |
|
|
3077
|
-
|
|
|
3083
|
+
| slugOrUuidOrId | <code>String</code> \| <code>Number</code> | | application slug (string), uuid (string) or id (number) |
|
|
3078
3084
|
| [options] | <code>Object</code> | <code>{}</code> | extra pine options to use |
|
|
3079
3085
|
|
|
3080
3086
|
**Example**
|
|
@@ -3252,7 +3258,7 @@ balena.models.device.getAll(function(error, devices) {
|
|
|
3252
3258
|
```
|
|
3253
3259
|
<a name="balena.models.device.getAllByApplication"></a>
|
|
3254
3260
|
|
|
3255
|
-
##### device.getAllByApplication(
|
|
3261
|
+
##### device.getAllByApplication(slugOrUuidOrId, [options]) ⇒ <code>Promise</code>
|
|
3256
3262
|
This method returns all devices of a specific application.
|
|
3257
3263
|
In order to have the following computed properties in the result
|
|
3258
3264
|
you have to explicitly define them in a `$select` in the extra options:
|
|
@@ -3266,7 +3272,7 @@ you have to explicitly define them in a `$select` in the extra options:
|
|
|
3266
3272
|
|
|
3267
3273
|
| Param | Type | Default | Description |
|
|
3268
3274
|
| --- | --- | --- | --- |
|
|
3269
|
-
|
|
|
3275
|
+
| slugOrUuidOrId | <code>String</code> \| <code>Number</code> | | application slug (string), uuid (string) or id (number) |
|
|
3270
3276
|
| [options] | <code>Object</code> | <code>{}</code> | extra pine options to use |
|
|
3271
3277
|
|
|
3272
3278
|
**Example**
|
|
@@ -3821,7 +3827,7 @@ balena.models.device.unsetLocation('7cf02a6', function(error) {
|
|
|
3821
3827
|
```
|
|
3822
3828
|
<a name="balena.models.device.move"></a>
|
|
3823
3829
|
|
|
3824
|
-
##### device.move(uuidOrId,
|
|
3830
|
+
##### device.move(uuidOrId, applicationSlugOrUuidOrId) ⇒ <code>Promise</code>
|
|
3825
3831
|
**Kind**: static method of [<code>device</code>](#balena.models.device)
|
|
3826
3832
|
**Summary**: Move a device to another application
|
|
3827
3833
|
**Access**: public
|
|
@@ -3829,7 +3835,7 @@ balena.models.device.unsetLocation('7cf02a6', function(error) {
|
|
|
3829
3835
|
| Param | Type | Description |
|
|
3830
3836
|
| --- | --- | --- |
|
|
3831
3837
|
| uuidOrId | <code>String</code> \| <code>Number</code> | device uuid (string) or id (number) |
|
|
3832
|
-
|
|
|
3838
|
+
| applicationSlugOrUuidOrId | <code>String</code> \| <code>Number</code> | application slug (string), uuid (string) or id (number) |
|
|
3833
3839
|
|
|
3834
3840
|
**Example**
|
|
3835
3841
|
```js
|
|
@@ -3937,7 +3943,7 @@ balena.models.device.getManifestBySlug('raspberry-pi', function(error, manifest)
|
|
|
3937
3943
|
```
|
|
3938
3944
|
<a name="balena.models.device.getManifestByApplication"></a>
|
|
3939
3945
|
|
|
3940
|
-
##### device.getManifestByApplication(
|
|
3946
|
+
##### device.getManifestByApplication(slugOrUuidOrId) ⇒ <code>Promise</code>
|
|
3941
3947
|
**Kind**: static method of [<code>device</code>](#balena.models.device)
|
|
3942
3948
|
**Summary**: Get a device manifest by application name
|
|
3943
3949
|
**Access**: public
|
|
@@ -3945,7 +3951,7 @@ balena.models.device.getManifestBySlug('raspberry-pi', function(error, manifest)
|
|
|
3945
3951
|
|
|
3946
3952
|
| Param | Type | Description |
|
|
3947
3953
|
| --- | --- | --- |
|
|
3948
|
-
|
|
|
3954
|
+
| slugOrUuidOrId | <code>String</code> \| <code>Number</code> | application slug (string), uuid (string) or id (number) |
|
|
3949
3955
|
|
|
3950
3956
|
**Example**
|
|
3951
3957
|
```js
|
|
@@ -3981,7 +3987,7 @@ console.log(randomKey);
|
|
|
3981
3987
|
```
|
|
3982
3988
|
<a name="balena.models.device.register"></a>
|
|
3983
3989
|
|
|
3984
|
-
##### device.register(
|
|
3990
|
+
##### device.register(applicationSlugOrUuidOrId, uuid) ⇒ <code>Promise</code>
|
|
3985
3991
|
**Kind**: static method of [<code>device</code>](#balena.models.device)
|
|
3986
3992
|
**Summary**: Register a new device with a Balena application.
|
|
3987
3993
|
**Access**: public
|
|
@@ -3989,7 +3995,7 @@ console.log(randomKey);
|
|
|
3989
3995
|
|
|
3990
3996
|
| Param | Type | Description |
|
|
3991
3997
|
| --- | --- | --- |
|
|
3992
|
-
|
|
|
3998
|
+
| applicationSlugOrUuidOrId | <code>String</code> \| <code>Number</code> | application slug (string), uuid (string) or id (number) |
|
|
3993
3999
|
| uuid | <code>String</code> | device uuid |
|
|
3994
4000
|
|
|
3995
4001
|
**Example**
|
|
@@ -5286,7 +5292,7 @@ balena.models.deviceType.getSlugByName('Raspberry Pi', function(error, deviceTyp
|
|
|
5286
5292
|
* [.create(name, [description])](#balena.models.apiKey.create) ⇒ <code>Promise</code>
|
|
5287
5293
|
* [.getAll([options])](#balena.models.apiKey.getAll) ⇒ <code>Promise</code>
|
|
5288
5294
|
* [.getAllNamedUserApiKeys([options])](#balena.models.apiKey.getAllNamedUserApiKeys) ⇒ <code>Promise</code>
|
|
5289
|
-
* [.getProvisioningApiKeysByApplication(
|
|
5295
|
+
* [.getProvisioningApiKeysByApplication(slugOrUuidOrId, [options])](#balena.models.apiKey.getProvisioningApiKeysByApplication) ⇒ <code>Promise</code>
|
|
5290
5296
|
* [.getDeviceApiKeysByDevice(uuidOrId, [options])](#balena.models.apiKey.getDeviceApiKeysByDevice) ⇒ <code>Promise</code>
|
|
5291
5297
|
* [.update(id, apiKeyInfo)](#balena.models.apiKey.update) ⇒ <code>Promise</code>
|
|
5292
5298
|
* [.revoke(id)](#balena.models.apiKey.revoke) ⇒ <code>Promise</code>
|
|
@@ -5377,7 +5383,7 @@ balena.models.apiKey.getAllNamedUserApiKeys(function(error, apiKeys) {
|
|
|
5377
5383
|
```
|
|
5378
5384
|
<a name="balena.models.apiKey.getProvisioningApiKeysByApplication"></a>
|
|
5379
5385
|
|
|
5380
|
-
##### apiKey.getProvisioningApiKeysByApplication(
|
|
5386
|
+
##### apiKey.getProvisioningApiKeysByApplication(slugOrUuidOrId, [options]) ⇒ <code>Promise</code>
|
|
5381
5387
|
**Kind**: static method of [<code>apiKey</code>](#balena.models.apiKey)
|
|
5382
5388
|
**Summary**: Get all provisioning API keys for an application
|
|
5383
5389
|
**Access**: public
|
|
@@ -5385,7 +5391,7 @@ balena.models.apiKey.getAllNamedUserApiKeys(function(error, apiKeys) {
|
|
|
5385
5391
|
|
|
5386
5392
|
| Param | Type | Default | Description |
|
|
5387
5393
|
| --- | --- | --- | --- |
|
|
5388
|
-
|
|
|
5394
|
+
| slugOrUuidOrId | <code>String</code> \| <code>Number</code> | | application slug (string), uuid (string) or id (number) |
|
|
5389
5395
|
| [options] | <code>Object</code> | <code>{}</code> | extra pine options to use |
|
|
5390
5396
|
|
|
5391
5397
|
**Example**
|
|
@@ -6069,7 +6075,7 @@ balena.models.organization.remove(123, function(error) {
|
|
|
6069
6075
|
* [.getMaxSatisfyingVersion(deviceType, versionOrRange, [osType])](#balena.models.os.getMaxSatisfyingVersion) ⇒ <code>Promise</code>
|
|
6070
6076
|
* [.getLastModified(deviceType, [version])](#balena.models.os.getLastModified) ⇒ <code>Promise</code>
|
|
6071
6077
|
* [.download(deviceType, [version], options)](#balena.models.os.download) ⇒ <code>Promise</code>
|
|
6072
|
-
* [.getConfig(
|
|
6078
|
+
* [.getConfig(slugOrUuidOrId, options)](#balena.models.os.getConfig) ⇒ <code>Promise</code>
|
|
6073
6079
|
* [.isSupportedOsUpdate(deviceType, currentVersion, targetVersion)](#balena.models.os.isSupportedOsUpdate) ⇒ <code>Promise</code>
|
|
6074
6080
|
* [.getSupportedOsUpdateVersions(deviceType, currentVersion)](#balena.models.os.getSupportedOsUpdateVersions) ⇒ <code>Promise</code>
|
|
6075
6081
|
* [.isArchitectureCompatibleWith(osArchitecture, applicationArchitecture)](#balena.models.os.isArchitectureCompatibleWith) ⇒ <code>Boolean</code>
|
|
@@ -6222,7 +6228,7 @@ balena.models.os.download('raspberry-pi', function(error, stream) {
|
|
|
6222
6228
|
```
|
|
6223
6229
|
<a name="balena.models.os.getConfig"></a>
|
|
6224
6230
|
|
|
6225
|
-
##### os.getConfig(
|
|
6231
|
+
##### os.getConfig(slugOrUuidOrId, options) ⇒ <code>Promise</code>
|
|
6226
6232
|
Builds the config.json for a device in the given application, with the given
|
|
6227
6233
|
options.
|
|
6228
6234
|
|
|
@@ -6236,7 +6242,7 @@ generation is only supported when using a session token, not an API key.
|
|
|
6236
6242
|
|
|
6237
6243
|
| Param | Type | Default | Description |
|
|
6238
6244
|
| --- | --- | --- | --- |
|
|
6239
|
-
|
|
|
6245
|
+
| slugOrUuidOrId | <code>String</code> \| <code>Number</code> | | application slug (string), uuid (string) or id (number). |
|
|
6240
6246
|
| options | <code>Object</code> | | OS configuration options to use. |
|
|
6241
6247
|
| options.version | <code>String</code> | | Required: the OS version of the image. |
|
|
6242
6248
|
| [options.network] | <code>String</code> | <code>'ethernet'</code> | The network type that the device will use, one of 'ethernet' or 'wifi'. |
|
|
@@ -6450,16 +6456,16 @@ balena.models.config.getConfigVarSchema('raspberry-pi', function(error, options)
|
|
|
6450
6456
|
|
|
6451
6457
|
* [.release](#balena.models.release) : <code>object</code>
|
|
6452
6458
|
* [.tags](#balena.models.release.tags) : <code>object</code>
|
|
6453
|
-
* [.getAllByApplication(
|
|
6459
|
+
* [.getAllByApplication(slugOrUuidOrId, [options])](#balena.models.release.tags.getAllByApplication) ⇒ <code>Promise</code>
|
|
6454
6460
|
* [.getAllByRelease(commitOrId, [options])](#balena.models.release.tags.getAllByRelease) ⇒ <code>Promise</code>
|
|
6455
6461
|
* [.getAll([options])](#balena.models.release.tags.getAll) ⇒ <code>Promise</code>
|
|
6456
6462
|
* [.set(commitOrId, tagKey, value)](#balena.models.release.tags.set) ⇒ <code>Promise</code>
|
|
6457
6463
|
* [.remove(commitOrId, tagKey)](#balena.models.release.tags.remove) ⇒ <code>Promise</code>
|
|
6458
6464
|
* [.get(commitOrId, [options])](#balena.models.release.get) ⇒ <code>Promise</code>
|
|
6459
6465
|
* [.getWithImageDetails(commitOrId, [options])](#balena.models.release.getWithImageDetails) ⇒ <code>Promise</code>
|
|
6460
|
-
* [.getAllByApplication(
|
|
6461
|
-
* [.getLatestByApplication(
|
|
6462
|
-
* [.createFromUrl(
|
|
6466
|
+
* [.getAllByApplication(slugOrUuidOrId, [options])](#balena.models.release.getAllByApplication) ⇒ <code>Promise</code>
|
|
6467
|
+
* [.getLatestByApplication(slugOrUuidOrId, [options])](#balena.models.release.getLatestByApplication) ⇒ <code>Promise</code>
|
|
6468
|
+
* [.createFromUrl(slugOrUuidOrId, urlDeployOptions)](#balena.models.release.createFromUrl) ⇒ <code>Promise</code>
|
|
6463
6469
|
* [.finalize(commitOrId)](#balena.models.release.finalize) ⇒ <code>Promise</code>
|
|
6464
6470
|
* [.setIsInvalidated(commitOrId, isInvalidated)](#balena.models.release.setIsInvalidated) ⇒ <code>Promise</code>
|
|
6465
6471
|
* [.note(commitOrId, note)](#balena.models.release.note) ⇒ <code>Promise</code>
|
|
@@ -6470,7 +6476,7 @@ balena.models.config.getConfigVarSchema('raspberry-pi', function(error, options)
|
|
|
6470
6476
|
**Kind**: static namespace of [<code>release</code>](#balena.models.release)
|
|
6471
6477
|
|
|
6472
6478
|
* [.tags](#balena.models.release.tags) : <code>object</code>
|
|
6473
|
-
* [.getAllByApplication(
|
|
6479
|
+
* [.getAllByApplication(slugOrUuidOrId, [options])](#balena.models.release.tags.getAllByApplication) ⇒ <code>Promise</code>
|
|
6474
6480
|
* [.getAllByRelease(commitOrId, [options])](#balena.models.release.tags.getAllByRelease) ⇒ <code>Promise</code>
|
|
6475
6481
|
* [.getAll([options])](#balena.models.release.tags.getAll) ⇒ <code>Promise</code>
|
|
6476
6482
|
* [.set(commitOrId, tagKey, value)](#balena.models.release.tags.set) ⇒ <code>Promise</code>
|
|
@@ -6478,7 +6484,7 @@ balena.models.config.getConfigVarSchema('raspberry-pi', function(error, options)
|
|
|
6478
6484
|
|
|
6479
6485
|
<a name="balena.models.release.tags.getAllByApplication"></a>
|
|
6480
6486
|
|
|
6481
|
-
###### tags.getAllByApplication(
|
|
6487
|
+
###### tags.getAllByApplication(slugOrUuidOrId, [options]) ⇒ <code>Promise</code>
|
|
6482
6488
|
**Kind**: static method of [<code>tags</code>](#balena.models.release.tags)
|
|
6483
6489
|
**Summary**: Get all release tags for an application
|
|
6484
6490
|
**Access**: public
|
|
@@ -6486,7 +6492,7 @@ balena.models.config.getConfigVarSchema('raspberry-pi', function(error, options)
|
|
|
6486
6492
|
|
|
6487
6493
|
| Param | Type | Default | Description |
|
|
6488
6494
|
| --- | --- | --- | --- |
|
|
6489
|
-
|
|
|
6495
|
+
| slugOrUuidOrId | <code>String</code> \| <code>Number</code> | | application slug (string), uuid (string) or id (number) |
|
|
6490
6496
|
| [options] | <code>Object</code> | <code>{}</code> | extra pine options to use |
|
|
6491
6497
|
|
|
6492
6498
|
**Example**
|
|
@@ -6698,7 +6704,7 @@ balena.models.release.getWithImageDetails(123, function(error, release) {
|
|
|
6698
6704
|
```
|
|
6699
6705
|
<a name="balena.models.release.getAllByApplication"></a>
|
|
6700
6706
|
|
|
6701
|
-
##### release.getAllByApplication(
|
|
6707
|
+
##### release.getAllByApplication(slugOrUuidOrId, [options]) ⇒ <code>Promise</code>
|
|
6702
6708
|
**Kind**: static method of [<code>release</code>](#balena.models.release)
|
|
6703
6709
|
**Summary**: Get all releases from an application
|
|
6704
6710
|
**Access**: public
|
|
@@ -6706,7 +6712,7 @@ balena.models.release.getWithImageDetails(123, function(error, release) {
|
|
|
6706
6712
|
|
|
6707
6713
|
| Param | Type | Default | Description |
|
|
6708
6714
|
| --- | --- | --- | --- |
|
|
6709
|
-
|
|
|
6715
|
+
| slugOrUuidOrId | <code>String</code> \| <code>Number</code> | | application slug (string), uuid (string) or id (number) |
|
|
6710
6716
|
| [options] | <code>Object</code> | <code>{}</code> | extra pine options to use |
|
|
6711
6717
|
|
|
6712
6718
|
**Example**
|
|
@@ -6730,7 +6736,7 @@ balena.models.release.getAllByApplication('myorganization/myapp', function(error
|
|
|
6730
6736
|
```
|
|
6731
6737
|
<a name="balena.models.release.getLatestByApplication"></a>
|
|
6732
6738
|
|
|
6733
|
-
##### release.getLatestByApplication(
|
|
6739
|
+
##### release.getLatestByApplication(slugOrUuidOrId, [options]) ⇒ <code>Promise</code>
|
|
6734
6740
|
**Kind**: static method of [<code>release</code>](#balena.models.release)
|
|
6735
6741
|
**Summary**: Get the latest successful release for an application
|
|
6736
6742
|
**Access**: public
|
|
@@ -6738,7 +6744,7 @@ balena.models.release.getAllByApplication('myorganization/myapp', function(error
|
|
|
6738
6744
|
|
|
6739
6745
|
| Param | Type | Default | Description |
|
|
6740
6746
|
| --- | --- | --- | --- |
|
|
6741
|
-
|
|
|
6747
|
+
| slugOrUuidOrId | <code>String</code> \| <code>Number</code> | | application slug (string), uuid (string) or id (number) |
|
|
6742
6748
|
| [options] | <code>Object</code> | <code>{}</code> | extra pine options to use |
|
|
6743
6749
|
|
|
6744
6750
|
**Example**
|
|
@@ -6762,7 +6768,7 @@ balena.models.release.getLatestByApplication('myorganization/myapp', function(er
|
|
|
6762
6768
|
```
|
|
6763
6769
|
<a name="balena.models.release.createFromUrl"></a>
|
|
6764
6770
|
|
|
6765
|
-
##### release.createFromUrl(
|
|
6771
|
+
##### release.createFromUrl(slugOrUuidOrId, urlDeployOptions) ⇒ <code>Promise</code>
|
|
6766
6772
|
**Kind**: static method of [<code>release</code>](#balena.models.release)
|
|
6767
6773
|
**Summary**: Create a new release built from the source in the provided url
|
|
6768
6774
|
**Access**: public
|
|
@@ -6770,7 +6776,7 @@ balena.models.release.getLatestByApplication('myorganization/myapp', function(er
|
|
|
6770
6776
|
|
|
6771
6777
|
| Param | Type | Default | Description |
|
|
6772
6778
|
| --- | --- | --- | --- |
|
|
6773
|
-
|
|
|
6779
|
+
| slugOrUuidOrId | <code>String</code> \| <code>Number</code> | | application slug (string), uuid (string) or id (number) |
|
|
6774
6780
|
| urlDeployOptions | <code>Object</code> | | builder options |
|
|
6775
6781
|
| urlDeployOptions.url | <code>String</code> | | a url with a tarball of the project to build |
|
|
6776
6782
|
| [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 +6889,11 @@ balena.models.release.note(123, 'My useful note');
|
|
|
6883
6889
|
* [.service](#balena.models.service) : <code>object</code>
|
|
6884
6890
|
* [.var](#balena.models.service.var) : <code>object</code>
|
|
6885
6891
|
* [.getAllByService(id, [options])](#balena.models.service.var.getAllByService) ⇒ <code>Promise</code>
|
|
6886
|
-
* [.getAllByApplication(
|
|
6892
|
+
* [.getAllByApplication(slugOrUuidOrId, [options])](#balena.models.service.var.getAllByApplication) ⇒ <code>Promise</code>
|
|
6887
6893
|
* [.get(id, key)](#balena.models.service.var.get) ⇒ <code>Promise</code>
|
|
6888
6894
|
* [.set(id, key, value)](#balena.models.service.var.set) ⇒ <code>Promise</code>
|
|
6889
6895
|
* [.remove(id, key)](#balena.models.service.var.remove) ⇒ <code>Promise</code>
|
|
6890
|
-
* [.getAllByApplication(
|
|
6896
|
+
* [.getAllByApplication(slugOrUuidOrId, [options])](#balena.models.service.getAllByApplication) ⇒ <code>Promise</code>
|
|
6891
6897
|
|
|
6892
6898
|
<a name="balena.models.service.var"></a>
|
|
6893
6899
|
|
|
@@ -6896,7 +6902,7 @@ balena.models.release.note(123, 'My useful note');
|
|
|
6896
6902
|
|
|
6897
6903
|
* [.var](#balena.models.service.var) : <code>object</code>
|
|
6898
6904
|
* [.getAllByService(id, [options])](#balena.models.service.var.getAllByService) ⇒ <code>Promise</code>
|
|
6899
|
-
* [.getAllByApplication(
|
|
6905
|
+
* [.getAllByApplication(slugOrUuidOrId, [options])](#balena.models.service.var.getAllByApplication) ⇒ <code>Promise</code>
|
|
6900
6906
|
* [.get(id, key)](#balena.models.service.var.get) ⇒ <code>Promise</code>
|
|
6901
6907
|
* [.set(id, key, value)](#balena.models.service.var.set) ⇒ <code>Promise</code>
|
|
6902
6908
|
* [.remove(id, key)](#balena.models.service.var.remove) ⇒ <code>Promise</code>
|
|
@@ -6929,7 +6935,7 @@ balena.models.service.var.getAllByService(999999, function(error, vars) {
|
|
|
6929
6935
|
```
|
|
6930
6936
|
<a name="balena.models.service.var.getAllByApplication"></a>
|
|
6931
6937
|
|
|
6932
|
-
###### var.getAllByApplication(
|
|
6938
|
+
###### var.getAllByApplication(slugOrUuidOrId, [options]) ⇒ <code>Promise</code>
|
|
6933
6939
|
**Kind**: static method of [<code>var</code>](#balena.models.service.var)
|
|
6934
6940
|
**Summary**: Get all service variables by application
|
|
6935
6941
|
**Access**: public
|
|
@@ -6937,7 +6943,7 @@ balena.models.service.var.getAllByService(999999, function(error, vars) {
|
|
|
6937
6943
|
|
|
6938
6944
|
| Param | Type | Default | Description |
|
|
6939
6945
|
| --- | --- | --- | --- |
|
|
6940
|
-
|
|
|
6946
|
+
| slugOrUuidOrId | <code>String</code> \| <code>Number</code> | | application slug (string), uuid (string) or id (number) |
|
|
6941
6947
|
| [options] | <code>Object</code> | <code>{}</code> | extra pine options to use |
|
|
6942
6948
|
|
|
6943
6949
|
**Example**
|
|
@@ -7038,7 +7044,7 @@ balena.models.service.var.remove(999999, 'VAR', function(error) {
|
|
|
7038
7044
|
```
|
|
7039
7045
|
<a name="balena.models.service.getAllByApplication"></a>
|
|
7040
7046
|
|
|
7041
|
-
##### service.getAllByApplication(
|
|
7047
|
+
##### service.getAllByApplication(slugOrUuidOrId, [options]) ⇒ <code>Promise</code>
|
|
7042
7048
|
**Kind**: static method of [<code>service</code>](#balena.models.service)
|
|
7043
7049
|
**Summary**: Get all services from an application
|
|
7044
7050
|
**Access**: public
|
|
@@ -7046,7 +7052,7 @@ balena.models.service.var.remove(999999, 'VAR', function(error) {
|
|
|
7046
7052
|
|
|
7047
7053
|
| Param | Type | Default | Description |
|
|
7048
7054
|
| --- | --- | --- | --- |
|
|
7049
|
-
|
|
|
7055
|
+
| slugOrUuidOrId | <code>String</code> \| <code>Number</code> | | application slug (string), uuid (string) or id (number) |
|
|
7050
7056
|
| [options] | <code>Object</code> | <code>{}</code> | extra pine options to use |
|
|
7051
7057
|
|
|
7052
7058
|
**Example**
|