@itentialopensource/adapter-meraki 1.0.3 → 1.1.0
Sign up to get free protection for your applications and to get access to all the features.
- package/AUTH.md +14 -18
- package/CALLS.md +4264 -0
- package/CHANGELOG.md +16 -0
- package/CONTRIBUTING.md +1 -160
- package/ENHANCE.md +2 -2
- package/README.md +23 -18
- package/SYSTEMINFO.md +15 -2
- package/adapter.js +164 -335
- package/adapterBase.js +411 -920
- package/changelogs/changelog.md +198 -0
- package/metadata.json +61 -0
- package/package.json +24 -24
- package/pronghorn.json +470 -138
- package/propertiesSchema.json +358 -31
- package/refs?service=git-upload-pack +0 -0
- package/report/adapterInfo.json +8 -8
- package/report/updateReport1690417926405.json +119 -0
- package/sampleProperties.json +74 -27
- package/test/integration/adapterTestBasicGet.js +2 -4
- package/test/integration/adapterTestConnectivity.js +91 -42
- package/test/integration/adapterTestIntegration.js +130 -2
- package/test/unit/adapterBaseTestUnit.js +388 -313
- package/test/unit/adapterTestUnit.js +332 -112
- package/utils/adapterInfo.js +1 -1
- package/utils/addAuth.js +1 -1
- package/utils/artifactize.js +1 -1
- package/utils/checkMigrate.js +1 -1
- package/utils/entitiesToDB.js +2 -2
- package/utils/findPath.js +1 -1
- package/utils/methodDocumentor.js +225 -0
- package/utils/modify.js +13 -15
- package/utils/packModificationScript.js +1 -1
- package/utils/pre-commit.sh +2 -0
- package/utils/taskMover.js +309 -0
- package/utils/tbScript.js +89 -34
- package/utils/tbUtils.js +41 -21
- package/utils/testRunner.js +1 -1
- package/utils/troubleshootingAdapter.js +9 -6
- package/versions.json +0 -542
- package/workflows/README.md +0 -3
package/CALLS.md
CHANGED
@@ -165,5 +165,4269 @@ Specific adapter calls are built based on the API of the Meraki. The Adapter Bui
|
|
165
165
|
<th bgcolor="lightgrey" style="padding:15px"><span style="font-size:12.0pt">Path</span></th>
|
166
166
|
<th bgcolor="lightgrey" style="padding:15px"><span style="font-size:12.0pt">Workflow?</span></th>
|
167
167
|
</tr>
|
168
|
+
<tr>
|
169
|
+
<td style="padding:15px">createOrganizationActionBatch(organizationId, createOrganizationActionBatch, callback)</td>
|
170
|
+
<td style="padding:15px">Create an action batch</td>
|
171
|
+
<td style="padding:15px">{base_path}/{version}/organizations/{pathv1}/actionBatches?{query}</td>
|
172
|
+
<td style="padding:15px">Yes</td>
|
173
|
+
</tr>
|
174
|
+
<tr>
|
175
|
+
<td style="padding:15px">getOrganizationActionBatches(organizationId, callback)</td>
|
176
|
+
<td style="padding:15px">Return the list of action batches in the organization</td>
|
177
|
+
<td style="padding:15px">{base_path}/{version}/organizations/{pathv1}/actionBatches?{query}</td>
|
178
|
+
<td style="padding:15px">Yes</td>
|
179
|
+
</tr>
|
180
|
+
<tr>
|
181
|
+
<td style="padding:15px">getOrganizationActionBatch(organizationId, id, callback)</td>
|
182
|
+
<td style="padding:15px">Return an action batch</td>
|
183
|
+
<td style="padding:15px">{base_path}/{version}/organizations/{pathv1}/actionBatches/{pathv2}?{query}</td>
|
184
|
+
<td style="padding:15px">Yes</td>
|
185
|
+
</tr>
|
186
|
+
<tr>
|
187
|
+
<td style="padding:15px">deleteOrganizationActionBatch(organizationId, id, callback)</td>
|
188
|
+
<td style="padding:15px">Delete an action batch</td>
|
189
|
+
<td style="padding:15px">{base_path}/{version}/organizations/{pathv1}/actionBatches/{pathv2}?{query}</td>
|
190
|
+
<td style="padding:15px">Yes</td>
|
191
|
+
</tr>
|
192
|
+
<tr>
|
193
|
+
<td style="padding:15px">updateOrganizationActionBatch(organizationId, id, updateOrganizationActionBatch, callback)</td>
|
194
|
+
<td style="padding:15px">Update an action batch</td>
|
195
|
+
<td style="padding:15px">{base_path}/{version}/organizations/{pathv1}/actionBatches/{pathv2}?{query}</td>
|
196
|
+
<td style="padding:15px">Yes</td>
|
197
|
+
</tr>
|
198
|
+
<tr>
|
199
|
+
<td style="padding:15px">getOrganizationAdmins(organizationId, callback)</td>
|
200
|
+
<td style="padding:15px">List the dashboard administrators in this organization</td>
|
201
|
+
<td style="padding:15px">{base_path}/{version}/organizations/{pathv1}/admins?{query}</td>
|
202
|
+
<td style="padding:15px">Yes</td>
|
203
|
+
</tr>
|
204
|
+
<tr>
|
205
|
+
<td style="padding:15px">createOrganizationAdmin(organizationId, createOrganizationAdmin, callback)</td>
|
206
|
+
<td style="padding:15px">Create a new dashboard administrator</td>
|
207
|
+
<td style="padding:15px">{base_path}/{version}/organizations/{pathv1}/admins?{query}</td>
|
208
|
+
<td style="padding:15px">Yes</td>
|
209
|
+
</tr>
|
210
|
+
<tr>
|
211
|
+
<td style="padding:15px">updateOrganizationAdmin(organizationId, id, updateOrganizationAdmin, callback)</td>
|
212
|
+
<td style="padding:15px">Update an administrator</td>
|
213
|
+
<td style="padding:15px">{base_path}/{version}/organizations/{pathv1}/admins/{pathv2}?{query}</td>
|
214
|
+
<td style="padding:15px">Yes</td>
|
215
|
+
</tr>
|
216
|
+
<tr>
|
217
|
+
<td style="padding:15px">deleteOrganizationAdmin(organizationId, id, callback)</td>
|
218
|
+
<td style="padding:15px">Revoke all access for a dashboard administrator within this organization</td>
|
219
|
+
<td style="padding:15px">{base_path}/{version}/organizations/{pathv1}/admins/{pathv2}?{query}</td>
|
220
|
+
<td style="padding:15px">Yes</td>
|
221
|
+
</tr>
|
222
|
+
<tr>
|
223
|
+
<td style="padding:15px">getNetworkAlertSettings(networkId, callback)</td>
|
224
|
+
<td style="padding:15px">Return the alert configuration for this network</td>
|
225
|
+
<td style="padding:15px">[object Object]</td>
|
226
|
+
<td style="padding:15px">Yes</td>
|
227
|
+
</tr>
|
228
|
+
<tr>
|
229
|
+
<td style="padding:15px">updateNetworkAlertSettings(networkId, updateNetworkAlertSettings, callback)</td>
|
230
|
+
<td style="padding:15px">Update the alert configuration for this network</td>
|
231
|
+
<td style="padding:15px">[object Object]</td>
|
232
|
+
<td style="padding:15px">Yes</td>
|
233
|
+
</tr>
|
234
|
+
<tr>
|
235
|
+
<td style="padding:15px">getDeviceCameraAnalyticsOverview(serial, t0, t1, timespan, callback)</td>
|
236
|
+
<td style="padding:15px">Returns an overview of aggregate analytics data for a timespan</td>
|
237
|
+
<td style="padding:15px">{base_path}/{version}/devices/{pathv1}/camera/analytics/overview?{query}</td>
|
238
|
+
<td style="padding:15px">Yes</td>
|
239
|
+
</tr>
|
240
|
+
<tr>
|
241
|
+
<td style="padding:15px">getDeviceCameraAnalyticsZones(serial, callback)</td>
|
242
|
+
<td style="padding:15px">Returns all configured analytic zones for this camera</td>
|
243
|
+
<td style="padding:15px">{base_path}/{version}/devices/{pathv1}/camera/analytics/zones?{query}</td>
|
244
|
+
<td style="padding:15px">Yes</td>
|
245
|
+
</tr>
|
246
|
+
<tr>
|
247
|
+
<td style="padding:15px">getDeviceCameraAnalyticsZoneHistory(serial, zoneId, t0, t1, timespan, resolution, callback)</td>
|
248
|
+
<td style="padding:15px">Return historical records for analytic zones</td>
|
249
|
+
<td style="padding:15px">{base_path}/{version}/devices/{pathv1}/camera/analytics/zones/{pathv2}/history?{query}</td>
|
250
|
+
<td style="padding:15px">Yes</td>
|
251
|
+
</tr>
|
252
|
+
<tr>
|
253
|
+
<td style="padding:15px">getDeviceCameraAnalyticsRecent(serial, callback)</td>
|
254
|
+
<td style="padding:15px">Returns most recent record for analytics zones</td>
|
255
|
+
<td style="padding:15px">{base_path}/{version}/devices/{pathv1}/camera/analytics/recent?{query}</td>
|
256
|
+
<td style="padding:15px">Yes</td>
|
257
|
+
</tr>
|
258
|
+
<tr>
|
259
|
+
<td style="padding:15px">getDeviceCameraAnalyticsLive(serial, callback)</td>
|
260
|
+
<td style="padding:15px">Returns live state from camera of analytics zones</td>
|
261
|
+
<td style="padding:15px">{base_path}/{version}/devices/{pathv1}/camera/analytics/live?{query}</td>
|
262
|
+
<td style="padding:15px">Yes</td>
|
263
|
+
</tr>
|
264
|
+
<tr>
|
265
|
+
<td style="padding:15px">getOrganizationApiRequests(organizationId, t0, t1, timespan, perPage, startingAfter, endingBefore, adminId, pathParam, method, callback)</td>
|
266
|
+
<td style="padding:15px">List the API requests made by an organization</td>
|
267
|
+
<td style="padding:15px">{base_path}/{version}/organizations/{pathv1}/apiRequests?{query}</td>
|
268
|
+
<td style="padding:15px">Yes</td>
|
269
|
+
</tr>
|
270
|
+
<tr>
|
271
|
+
<td style="padding:15px">getNetworkBluetoothClient(networkId, bluetoothClientId, includeConnectivityHistory, connectivityHistoryTimespan, callback)</td>
|
272
|
+
<td style="padding:15px">Return a Bluetooth client. Bluetooth clients can be identified by their ID or their MAC.</td>
|
273
|
+
<td style="padding:15px">{base_path}/{version}/networks/{pathv1}/bluetoothClients/{pathv2}?{query}</td>
|
274
|
+
<td style="padding:15px">Yes</td>
|
275
|
+
</tr>
|
276
|
+
<tr>
|
277
|
+
<td style="padding:15px">getNetworkBluetoothClients(networkId, perPage, startingAfter, endingBefore, timespan, includeConnectivityHistory, callback)</td>
|
278
|
+
<td style="padding:15px">List the Bluetooth clients seen by APs in this network</td>
|
279
|
+
<td style="padding:15px">{base_path}/{version}/networks/{pathv1}/bluetoothClients?{query}</td>
|
280
|
+
<td style="padding:15px">Yes</td>
|
281
|
+
</tr>
|
282
|
+
<tr>
|
283
|
+
<td style="padding:15px">getNetworkBluetoothSettings(networkId, callback)</td>
|
284
|
+
<td style="padding:15px">Return the Bluetooth settings for a network. Bluetooth settings must be enabled on the network.</td>
|
285
|
+
<td style="padding:15px">{base_path}/{version}/networks/{pathv1}/bluetoothSettings?{query}</td>
|
286
|
+
<td style="padding:15px">Yes</td>
|
287
|
+
</tr>
|
288
|
+
<tr>
|
289
|
+
<td style="padding:15px">updateNetworkBluetoothSettings(networkId, updateNetworkBluetoothSettings, callback)</td>
|
290
|
+
<td style="padding:15px">Update the Bluetooth settings for a network. See the docs page for Bluetooth settings .</td>
|
291
|
+
<td style="padding:15px">{base_path}/{version}/networks/{pathv1}/bluetoothSettings?{query}</td>
|
292
|
+
<td style="padding:15px">Yes</td>
|
293
|
+
</tr>
|
294
|
+
<tr>
|
295
|
+
<td style="padding:15px">getOrganizationNetworks(organizationId, configTemplateId, callback)</td>
|
296
|
+
<td style="padding:15px">List the networks in an organization</td>
|
297
|
+
<td style="padding:15px">{base_path}/{version}/organizations/{pathv1}/networks?{query}</td>
|
298
|
+
<td style="padding:15px">Yes</td>
|
299
|
+
</tr>
|
300
|
+
<tr>
|
301
|
+
<td style="padding:15px">createOrganizationNetwork(organizationId, createOrganizationNetwork, callback)</td>
|
302
|
+
<td style="padding:15px">Create a network</td>
|
303
|
+
<td style="padding:15px">{base_path}/{version}/organizations/{pathv1}/networks?{query}</td>
|
304
|
+
<td style="padding:15px">Yes</td>
|
305
|
+
</tr>
|
306
|
+
<tr>
|
307
|
+
<td style="padding:15px">getNetwork(networkId, callback)</td>
|
308
|
+
<td style="padding:15px">Return a network</td>
|
309
|
+
<td style="padding:15px">{base_path}/{version}/networks/{pathv1}?{query}</td>
|
310
|
+
<td style="padding:15px">Yes</td>
|
311
|
+
</tr>
|
312
|
+
<tr>
|
313
|
+
<td style="padding:15px">updateNetwork(networkId, updateNetwork, callback)</td>
|
314
|
+
<td style="padding:15px">Update a network</td>
|
315
|
+
<td style="padding:15px">{base_path}/{version}/networks/{pathv1}?{query}</td>
|
316
|
+
<td style="padding:15px">Yes</td>
|
317
|
+
</tr>
|
318
|
+
<tr>
|
319
|
+
<td style="padding:15px">deleteNetwork(networkId, callback)</td>
|
320
|
+
<td style="padding:15px">Delete a network</td>
|
321
|
+
<td style="padding:15px">{base_path}/{version}/networks/{pathv1}?{query}</td>
|
322
|
+
<td style="padding:15px">Yes</td>
|
323
|
+
</tr>
|
324
|
+
<tr>
|
325
|
+
<td style="padding:15px">bindNetwork(networkId, bindNetwork, callback)</td>
|
326
|
+
<td style="padding:15px">Bind a network to a template.</td>
|
327
|
+
<td style="padding:15px">{base_path}/{version}/networks/{pathv1}/bind?{query}</td>
|
328
|
+
<td style="padding:15px">Yes</td>
|
329
|
+
</tr>
|
330
|
+
<tr>
|
331
|
+
<td style="padding:15px">unbindNetwork(networkId, callback)</td>
|
332
|
+
<td style="padding:15px">Unbind a network from a template.</td>
|
333
|
+
<td style="padding:15px">{base_path}/{version}/networks/{pathv1}/unbind?{query}</td>
|
334
|
+
<td style="padding:15px">Yes</td>
|
335
|
+
</tr>
|
336
|
+
<tr>
|
337
|
+
<td style="padding:15px">getNetworkTraffic(networkId, timespan, deviceType, callback)</td>
|
338
|
+
<td style="padding:15px">The traffic analysis data for this network.
|
339
|
+
Traffic Analysis with Hostname Visibility must be enabled on the network.</td>
|
340
|
+
<td style="padding:15px">{base_path}/{version}/networks/{pathv1}/traffic?{query}</td>
|
341
|
+
<td style="padding:15px">Yes</td>
|
342
|
+
</tr>
|
343
|
+
<tr>
|
344
|
+
<td style="padding:15px">getNetworkAccessPolicies(networkId, callback)</td>
|
345
|
+
<td style="padding:15px">List the access policies for this network. Only valid for MS networks.</td>
|
346
|
+
<td style="padding:15px">{base_path}/{version}/networks/{pathv1}/accessPolicies?{query}</td>
|
347
|
+
<td style="padding:15px">Yes</td>
|
348
|
+
</tr>
|
349
|
+
<tr>
|
350
|
+
<td style="padding:15px">returnTheSSIDStatusesOfAnAccessPoint(networkId, serial, callback)</td>
|
351
|
+
<td style="padding:15px">Return the SSID statuses of an access point</td>
|
352
|
+
<td style="padding:15px">{base_path}/{version}/networks/{pathv1}/devices/{pathv2}/wireless/status?{query}</td>
|
353
|
+
<td style="padding:15px">Yes</td>
|
354
|
+
</tr>
|
355
|
+
<tr>
|
356
|
+
<td style="padding:15px">returnTheSSIDStatusesOfAnAccessPointV1(serial, callback)</td>
|
357
|
+
<td style="padding:15px">Return the SSID statuses of an access point</td>
|
358
|
+
<td style="padding:15px">{base_path}/{version}/devices/{pathv1}/wireless/status?{query}</td>
|
359
|
+
<td style="padding:15px">Yes</td>
|
360
|
+
</tr>
|
361
|
+
<tr>
|
362
|
+
<td style="padding:15px">getNetworkAirMarshal(networkId, t0, timespan, callback)</td>
|
363
|
+
<td style="padding:15px">List Air Marshal scan results from a network</td>
|
364
|
+
<td style="padding:15px">[object Object]</td>
|
365
|
+
<td style="padding:15px">Yes</td>
|
366
|
+
</tr>
|
367
|
+
<tr>
|
368
|
+
<td style="padding:15px">combineOrganizationNetworks(organizationId, combineOrganizationNetworks, callback)</td>
|
369
|
+
<td style="padding:15px">Combine multiple networks into a single network</td>
|
370
|
+
<td style="padding:15px">{base_path}/{version}/organizations/{pathv1}/networks/combine?{query}</td>
|
371
|
+
<td style="padding:15px">Yes</td>
|
372
|
+
</tr>
|
373
|
+
<tr>
|
374
|
+
<td style="padding:15px">splitNetwork(networkId, callback)</td>
|
375
|
+
<td style="padding:15px">Split a combined network into individual networks for each type of device</td>
|
376
|
+
<td style="padding:15px">{base_path}/{version}/networks/{pathv1}/split?{query}</td>
|
377
|
+
<td style="padding:15px">Yes</td>
|
378
|
+
</tr>
|
379
|
+
<tr>
|
380
|
+
<td style="padding:15px">getNetworkSiteToSiteVpn(networkId, callback)</td>
|
381
|
+
<td style="padding:15px">Return the site-to-site VPN settings of a network. Only valid for MX networks.</td>
|
382
|
+
<td style="padding:15px">[object Object]</td>
|
383
|
+
<td style="padding:15px">Yes</td>
|
384
|
+
</tr>
|
385
|
+
<tr>
|
386
|
+
<td style="padding:15px">updateNetworkSiteToSiteVpn(networkId, updateNetworkSiteToSiteVpn, callback)</td>
|
387
|
+
<td style="padding:15px">Update the site-to-site VPN settings of a network. Only valid for MX networks in NAT mode.</td>
|
388
|
+
<td style="padding:15px">[object Object]</td>
|
389
|
+
<td style="padding:15px">Yes</td>
|
390
|
+
</tr>
|
391
|
+
<tr>
|
392
|
+
<td style="padding:15px">getNetworkCameraVideoLink(networkId, serial, timestamp, callback)</td>
|
393
|
+
<td style="padding:15px">Returns video link for the specified camera. If a timestamp supplied, it links to that time.</td>
|
394
|
+
<td style="padding:15px">{base_path}/{version}/networks/{pathv1}/cameras/{pathv2}/videoLink?{query}</td>
|
395
|
+
<td style="padding:15px">Yes</td>
|
396
|
+
</tr>
|
397
|
+
<tr>
|
398
|
+
<td style="padding:15px">generateNetworkCameraSnapshot(networkId, serial, generateNetworkCameraSnapshot, callback)</td>
|
399
|
+
<td style="padding:15px">Generate a snapshot of what the camera sees at the specified time and return a link to that image.</td>
|
400
|
+
<td style="padding:15px">{base_path}/{version}/networks/{pathv1}/cameras/{pathv2}/snapshot?{query}</td>
|
401
|
+
<td style="padding:15px">Yes</td>
|
402
|
+
</tr>
|
403
|
+
<tr>
|
404
|
+
<td style="padding:15px">getNetworkClient(networkId, clientId, callback)</td>
|
405
|
+
<td style="padding:15px">Return the client associated with the given identifier. Clients can be identified by a client key or either the MAC or IP depending on whether the network uses Track-by-IP.</td>
|
406
|
+
<td style="padding:15px">{base_path}/{version}/networks/{pathv1}/clients/{pathv2}?{query}</td>
|
407
|
+
<td style="padding:15px">Yes</td>
|
408
|
+
</tr>
|
409
|
+
<tr>
|
410
|
+
<td style="padding:15px">provisionNetworkClients(networkId, provisionNetworkClients, callback)</td>
|
411
|
+
<td style="padding:15px">Provisions a client with a name and policy. Clients can be provisioned before they associate to the network.</td>
|
412
|
+
<td style="padding:15px">{base_path}/{version}/networks/{pathv1}/clients/provision?{query}</td>
|
413
|
+
<td style="padding:15px">Yes</td>
|
414
|
+
</tr>
|
415
|
+
<tr>
|
416
|
+
<td style="padding:15px">getNetworkClientUsageHistory(networkId, clientId, callback)</td>
|
417
|
+
<td style="padding:15px">Return the client's daily usage history. Usage data is in kilobytes. Clients can be identified by a client key or either the MAC or IP depending on whether the network uses Track-by-IP.</td>
|
418
|
+
<td style="padding:15px">{base_path}/{version}/networks/{pathv1}/clients/{pathv2}/usageHistory?{query}</td>
|
419
|
+
<td style="padding:15px">Yes</td>
|
420
|
+
</tr>
|
421
|
+
<tr>
|
422
|
+
<td style="padding:15px">getNetworkClientPolicy(networkId, clientId, callback)</td>
|
423
|
+
<td style="padding:15px">Return the policy assigned to a client on the network. Clients can be identified by a client key or either the MAC or IP depending on whether the network uses Track-by-IP.</td>
|
424
|
+
<td style="padding:15px">{base_path}/{version}/networks/{pathv1}/clients/{pathv2}/policy?{query}</td>
|
425
|
+
<td style="padding:15px">Yes</td>
|
426
|
+
</tr>
|
427
|
+
<tr>
|
428
|
+
<td style="padding:15px">updateNetworkClientPolicy(networkId, clientId, updateNetworkClientPolicy, callback)</td>
|
429
|
+
<td style="padding:15px">Update the policy assigned to a client on the network. Clients can be identified by a client key or either the MAC or IP depending on whether the network uses Track-by-IP.</td>
|
430
|
+
<td style="padding:15px">{base_path}/{version}/networks/{pathv1}/clients/{pathv2}/policy?{query}</td>
|
431
|
+
<td style="padding:15px">Yes</td>
|
432
|
+
</tr>
|
433
|
+
<tr>
|
434
|
+
<td style="padding:15px">getNetworkClientSplashAuthorizationStatus(networkId, clientId, callback)</td>
|
435
|
+
<td style="padding:15px">Return the splash authorization for a client, for each SSID they've associated with through splash. Clients can be identified by a client key or either the MAC or IP depending on whether the network uses Track-by-IP.</td>
|
436
|
+
<td style="padding:15px">{base_path}/{version}/networks/{pathv1}/clients/{pathv2}/splashAuthorizationStatus?{query}</td>
|
437
|
+
<td style="padding:15px">Yes</td>
|
438
|
+
</tr>
|
439
|
+
<tr>
|
440
|
+
<td style="padding:15px">updateNetworkClientSplashAuthorizationStatus(networkId, clientId, updateNetworkClientSplashAuthorizationStatus, callback)</td>
|
441
|
+
<td style="padding:15px">Update a client's splash authorization. Clients can be identified by a client key or either the MAC or IP depending on whether the network uses Track-by-IP.</td>
|
442
|
+
<td style="padding:15px">{base_path}/{version}/networks/{pathv1}/clients/{pathv2}/splashAuthorizationStatus?{query}</td>
|
443
|
+
<td style="padding:15px">Yes</td>
|
444
|
+
</tr>
|
445
|
+
<tr>
|
446
|
+
<td style="padding:15px">getNetworkClients(networkId, t0, timespan, perPage, startingAfter, endingBefore, callback)</td>
|
447
|
+
<td style="padding:15px">List the clients that have used this network in the timespan</td>
|
448
|
+
<td style="padding:15px">{base_path}/{version}/networks/{pathv1}/clients?{query}</td>
|
449
|
+
<td style="padding:15px">Yes</td>
|
450
|
+
</tr>
|
451
|
+
<tr>
|
452
|
+
<td style="padding:15px">getDeviceClients(serial, t0, timespan, callback)</td>
|
453
|
+
<td style="padding:15px">List the clients of a device, up to a maximum of a month ago. The usage of each client is returned in kilobytes. If the device is a switch, the switchport is returned; otherwise the switchport field is null.</td>
|
454
|
+
<td style="padding:15px">{base_path}/{version}/devices/{pathv1}/clients?{query}</td>
|
455
|
+
<td style="padding:15px">Yes</td>
|
456
|
+
</tr>
|
457
|
+
<tr>
|
458
|
+
<td style="padding:15px">getNetworkClientTrafficHistory(networkId, clientId, perPage, startingAfter, endingBefore, callback)</td>
|
459
|
+
<td style="padding:15px">Return the client's network traffic data over time. Usage data is in kilobytes. This endpoint requires detailed traffic analysis to be enabled on the Network-wide > General page. Clients can be identified by a client key or either the MAC or IP depending on whether the network uses Track-by-IP.</td>
|
460
|
+
<td style="padding:15px">{base_path}/{version}/networks/{pathv1}/clients/{pathv2}/trafficHistory?{query}</td>
|
461
|
+
<td style="padding:15px">Yes</td>
|
462
|
+
</tr>
|
463
|
+
<tr>
|
464
|
+
<td style="padding:15px">getNetworkClientEvents(networkId, clientId, perPage, startingAfter, endingBefore, callback)</td>
|
465
|
+
<td style="padding:15px">Return the events associated with this client. Clients can be identified by a client key or either the MAC or IP depending on whether the network uses Track-by-IP.</td>
|
466
|
+
<td style="padding:15px">{base_path}/{version}/networks/{pathv1}/clients/{pathv2}/events?{query}</td>
|
467
|
+
<td style="padding:15px">Yes</td>
|
468
|
+
</tr>
|
469
|
+
<tr>
|
470
|
+
<td style="padding:15px">getNetworkClientLatencyHistory(networkId, clientId, t0, t1, timespan, resolution, callback)</td>
|
471
|
+
<td style="padding:15px">Return the latency history for a client. Clients can be identified by a client key or either the MAC or IP depending on whether the network uses Track-by-IP. The latency data is from a sample of 2% of packets and is grouped into 4 traffic categories: background, best effort, video, voice. Within these categories the sampled packet counters are bucketed by latency in milliseconds.</td>
|
472
|
+
<td style="padding:15px">{base_path}/{version}/networks/{pathv1}/clients/{pathv2}/latencyHistory?{query}</td>
|
473
|
+
<td style="padding:15px">Yes</td>
|
474
|
+
</tr>
|
475
|
+
<tr>
|
476
|
+
<td style="padding:15px">getOrganizationConfigTemplates(organizationId, callback)</td>
|
477
|
+
<td style="padding:15px">List the configuration templates for this organization</td>
|
478
|
+
<td style="padding:15px">{base_path}/{version}/organizations/{pathv1}/configTemplates?{query}</td>
|
479
|
+
<td style="padding:15px">Yes</td>
|
480
|
+
</tr>
|
481
|
+
<tr>
|
482
|
+
<td style="padding:15px">deleteOrganizationConfigTemplate(organizationId, id, callback)</td>
|
483
|
+
<td style="padding:15px">Remove a configuration template</td>
|
484
|
+
<td style="padding:15px">{base_path}/{version}/organizations/{pathv1}/configTemplates/{pathv2}?{query}</td>
|
485
|
+
<td style="padding:15px">Yes</td>
|
486
|
+
</tr>
|
487
|
+
<tr>
|
488
|
+
<td style="padding:15px">getNetworkDeviceLldpCdp(networkId, serial, timespan, callback)</td>
|
489
|
+
<td style="padding:15px">List LLDP and CDP information for a device</td>
|
490
|
+
<td style="padding:15px">{base_path}/{version}/networks/{pathv1}/devices/{pathv2}/lldp_cdp?{query}</td>
|
491
|
+
<td style="padding:15px">Yes</td>
|
492
|
+
</tr>
|
493
|
+
<tr>
|
494
|
+
<td style="padding:15px">getNetworkDeviceLldpCdpV1(serial, timespan, callback)</td>
|
495
|
+
<td style="padding:15px">List LLDP and CDP information for a device</td>
|
496
|
+
<td style="padding:15px">{base_path}/{version}/devices/{pathv1}/lldp_cdp?{query}</td>
|
497
|
+
<td style="padding:15px">Yes</td>
|
498
|
+
</tr>
|
499
|
+
<tr>
|
500
|
+
<td style="padding:15px">getOrganizationDevices(organizationId, perPage, startingAfter, endingBefore, callback)</td>
|
501
|
+
<td style="padding:15px">List the devices in an organization</td>
|
502
|
+
<td style="padding:15px">{base_path}/{version}/organizations/{pathv1}/devices?{query}</td>
|
503
|
+
<td style="padding:15px">Yes</td>
|
504
|
+
</tr>
|
505
|
+
<tr>
|
506
|
+
<td style="padding:15px">getNetworkDevices(networkId, callback)</td>
|
507
|
+
<td style="padding:15px">List the devices in a network</td>
|
508
|
+
<td style="padding:15px">{base_path}/{version}/networks/{pathv1}/devices?{query}</td>
|
509
|
+
<td style="padding:15px">Yes</td>
|
510
|
+
</tr>
|
511
|
+
<tr>
|
512
|
+
<td style="padding:15px">getNetworkDevice(networkId, serial, callback)</td>
|
513
|
+
<td style="padding:15px">Return a single device</td>
|
514
|
+
<td style="padding:15px">{base_path}/{version}/networks/{pathv1}/devices/{pathv2}?{query}</td>
|
515
|
+
<td style="padding:15px">Yes</td>
|
516
|
+
</tr>
|
517
|
+
<tr>
|
518
|
+
<td style="padding:15px">getNetworkDeviceV1(serial, callback)</td>
|
519
|
+
<td style="padding:15px">Return a single device</td>
|
520
|
+
<td style="padding:15px">{base_path}/{version}/devices/{pathv1}?{query}</td>
|
521
|
+
<td style="padding:15px">Yes</td>
|
522
|
+
</tr>
|
523
|
+
<tr>
|
524
|
+
<td style="padding:15px">updateNetworkDevice(networkId, serial, updateNetworkDevice, callback)</td>
|
525
|
+
<td style="padding:15px">Update the attributes of a device</td>
|
526
|
+
<td style="padding:15px">{base_path}/{version}/networks/{pathv1}/devices/{pathv2}?{query}</td>
|
527
|
+
<td style="padding:15px">Yes</td>
|
528
|
+
</tr>
|
529
|
+
<tr>
|
530
|
+
<td style="padding:15px">getNetworkDevicePerformance(networkId, serial, callback)</td>
|
531
|
+
<td style="padding:15px">Return the performance score for a single device. Only primary MX devices supported. If no data is available, a 204 error code is returned.</td>
|
532
|
+
<td style="padding:15px">{base_path}/{version}/networks/{pathv1}/devices/{pathv2}/performance?{query}</td>
|
533
|
+
<td style="padding:15px">Yes</td>
|
534
|
+
</tr>
|
535
|
+
<tr>
|
536
|
+
<td style="padding:15px">getNetworkDevicePerformanceV1(serial, callback)</td>
|
537
|
+
<td style="padding:15px">Return the performance score for a single device. Only primary MX devices supported. If no data is available, a 204 error code is returned.</td>
|
538
|
+
<td style="padding:15px">{base_path}/{version}/devices/{pathv1}/appliance/performance?{query}</td>
|
539
|
+
<td style="padding:15px">Yes</td>
|
540
|
+
</tr>
|
541
|
+
<tr>
|
542
|
+
<td style="padding:15px">getNetworkDeviceUplink(networkId, serial, callback)</td>
|
543
|
+
<td style="padding:15px">Return the uplink information for a device.</td>
|
544
|
+
<td style="padding:15px">{base_path}/{version}/networks/{pathv1}/devices/{pathv2}/uplink?{query}</td>
|
545
|
+
<td style="padding:15px">Yes</td>
|
546
|
+
</tr>
|
547
|
+
<tr>
|
548
|
+
<td style="padding:15px">claimNetworkDevices(networkId, claimNetworkDevices, callback)</td>
|
549
|
+
<td style="padding:15px">Claim a device into a network</td>
|
550
|
+
<td style="padding:15px">{base_path}/{version}/networks/{pathv1}/devices/claim?{query}</td>
|
551
|
+
<td style="padding:15px">Yes</td>
|
552
|
+
</tr>
|
553
|
+
<tr>
|
554
|
+
<td style="padding:15px">removeNetworkDevice(networkId, serial, callback)</td>
|
555
|
+
<td style="padding:15px">Remove a single device</td>
|
556
|
+
<td style="padding:15px">[object Object]</td>
|
557
|
+
<td style="padding:15px">Yes</td>
|
558
|
+
</tr>
|
559
|
+
<tr>
|
560
|
+
<td style="padding:15px">getNetworkDeviceLossAndLatencyHistory(networkId, serial, t0, t1, timespan, resolution, uplink, ip, callback)</td>
|
561
|
+
<td style="padding:15px">Get the uplink loss percentage and latency in milliseconds for a wired network device.</td>
|
562
|
+
<td style="padding:15px">{base_path}/{version}/networks/{pathv1}/devices/{pathv2}/lossAndLatencyHistory?{query}</td>
|
563
|
+
<td style="padding:15px">Yes</td>
|
564
|
+
</tr>
|
565
|
+
<tr>
|
566
|
+
<td style="padding:15px">getNetworkDeviceLossAndLatencyHistoryV1(serial, t0, t1, timespan, resolution, uplink, ip, callback)</td>
|
567
|
+
<td style="padding:15px">Get the uplink loss percentage and latency in milliseconds for a wired network device.</td>
|
568
|
+
<td style="padding:15px">{base_path}/{version}/devices/{pathv1}/lossAndLatencyHistory?{query}</td>
|
569
|
+
<td style="padding:15px">Yes</td>
|
570
|
+
</tr>
|
571
|
+
<tr>
|
572
|
+
<td style="padding:15px">rebootNetworkDevice(networkId, serial, callback)</td>
|
573
|
+
<td style="padding:15px">Reboot a device</td>
|
574
|
+
<td style="padding:15px">{base_path}/{version}/networks/{pathv1}/devices/{pathv2}/reboot?{query}</td>
|
575
|
+
<td style="padding:15px">Yes</td>
|
576
|
+
</tr>
|
577
|
+
<tr>
|
578
|
+
<td style="padding:15px">rebootNetworkDeviceV1(serial, callback)</td>
|
579
|
+
<td style="padding:15px">Reboot a device</td>
|
580
|
+
<td style="padding:15px">{base_path}/{version}/devices/{pathv1}/reboot?{query}</td>
|
581
|
+
<td style="padding:15px">Yes</td>
|
582
|
+
</tr>
|
583
|
+
<tr>
|
584
|
+
<td style="padding:15px">blinkNetworkDeviceLeds(networkId, serial, blinkNetworkDeviceLeds, callback)</td>
|
585
|
+
<td style="padding:15px">Blink the LEDs on a device</td>
|
586
|
+
<td style="padding:15px">{base_path}/{version}/networks/{pathv1}/devices/{pathv2}/blinkLeds?{query}</td>
|
587
|
+
<td style="padding:15px">Yes</td>
|
588
|
+
</tr>
|
589
|
+
<tr>
|
590
|
+
<td style="padding:15px">blinkNetworkDeviceLedsV1(serial, blinkNetworkDeviceLeds, callback)</td>
|
591
|
+
<td style="padding:15px">Blink the LEDs on a device</td>
|
592
|
+
<td style="padding:15px">{base_path}/{version}/devices/{pathv1}/blinkLeds?{query}</td>
|
593
|
+
<td style="padding:15px">Yes</td>
|
594
|
+
</tr>
|
595
|
+
<tr>
|
596
|
+
<td style="padding:15px">getNetworkCellularFirewallRules(networkId, callback)</td>
|
597
|
+
<td style="padding:15px">Return the cellular firewall rules for an MX network</td>
|
598
|
+
<td style="padding:15px">[object Object]</td>
|
599
|
+
<td style="padding:15px">Yes</td>
|
600
|
+
</tr>
|
601
|
+
<tr>
|
602
|
+
<td style="padding:15px">updateNetworkCellularFirewallRules(networkId, updateNetworkCellularFirewallRules, callback)</td>
|
603
|
+
<td style="padding:15px">Update the cellular firewall rules of an MX network</td>
|
604
|
+
<td style="padding:15px">[object Object]</td>
|
605
|
+
<td style="padding:15px">Yes</td>
|
606
|
+
</tr>
|
607
|
+
<tr>
|
608
|
+
<td style="padding:15px">getNetworkL3FirewallRules(networkId, callback)</td>
|
609
|
+
<td style="padding:15px">Return the L3 firewall rules for an MX network</td>
|
610
|
+
<td style="padding:15px">[object Object]</td>
|
611
|
+
<td style="padding:15px">Yes</td>
|
612
|
+
</tr>
|
613
|
+
<tr>
|
614
|
+
<td style="padding:15px">updateNetworkL3FirewallRules(networkId, updateNetworkL3FirewallRules, callback)</td>
|
615
|
+
<td style="padding:15px">Update the L3 firewall rules of an MX network</td>
|
616
|
+
<td style="padding:15px">[object Object]</td>
|
617
|
+
<td style="padding:15px">Yes</td>
|
618
|
+
</tr>
|
619
|
+
<tr>
|
620
|
+
<td style="padding:15px">getNetworkL7FirewallRulesApplicationCategories(networkId, callback)</td>
|
621
|
+
<td style="padding:15px">Return the L7 firewall application categories and their associated applications for an MX network</td>
|
622
|
+
<td style="padding:15px">[object Object]</td>
|
623
|
+
<td style="padding:15px">Yes</td>
|
624
|
+
</tr>
|
625
|
+
<tr>
|
626
|
+
<td style="padding:15px">getNetworkL7FirewallRules(networkId, callback)</td>
|
627
|
+
<td style="padding:15px">List the MX L7 firewall rules for an MX network</td>
|
628
|
+
<td style="padding:15px">[object Object]</td>
|
629
|
+
<td style="padding:15px">Yes</td>
|
630
|
+
</tr>
|
631
|
+
<tr>
|
632
|
+
<td style="padding:15px">updateNetworkL7FirewallRules(networkId, updateNetworkL7FirewallRules, callback)</td>
|
633
|
+
<td style="padding:15px">Update the MX L7 firewall rules for an MX network</td>
|
634
|
+
<td style="padding:15px">[object Object]</td>
|
635
|
+
<td style="padding:15px">Yes</td>
|
636
|
+
</tr>
|
637
|
+
<tr>
|
638
|
+
<td style="padding:15px">getOrganizationVpnFirewallRules(organizationId, callback)</td>
|
639
|
+
<td style="padding:15px">Return the firewall rules for an organization's site-to-site VPN</td>
|
640
|
+
<td style="padding:15px">[object Object]</td>
|
641
|
+
<td style="padding:15px">Yes</td>
|
642
|
+
</tr>
|
643
|
+
<tr>
|
644
|
+
<td style="padding:15px">updateOrganizationVpnFirewallRules(organizationId, updateOrganizationVpnFirewallRules, callback)</td>
|
645
|
+
<td style="padding:15px">Update the firewall rules of an organization's site-to-site VPN</td>
|
646
|
+
<td style="padding:15px">[object Object]</td>
|
647
|
+
<td style="padding:15px">Yes</td>
|
648
|
+
</tr>
|
649
|
+
<tr>
|
650
|
+
<td style="padding:15px">getNetworkSsidL3FirewallRules(networkId, number, callback)</td>
|
651
|
+
<td style="padding:15px">Return the L3 firewall rules for an SSID on an MR network</td>
|
652
|
+
<td style="padding:15px">[object Object]</td>
|
653
|
+
<td style="padding:15px">Yes</td>
|
654
|
+
</tr>
|
655
|
+
<tr>
|
656
|
+
<td style="padding:15px">updateNetworkSsidL3FirewallRules(networkId, number, updateNetworkSsidL3FirewallRules, callback)</td>
|
657
|
+
<td style="padding:15px">Update the L3 firewall rules of an SSID on an MR network</td>
|
658
|
+
<td style="padding:15px">[object Object]</td>
|
659
|
+
<td style="padding:15px">Yes</td>
|
660
|
+
</tr>
|
661
|
+
<tr>
|
662
|
+
<td style="padding:15px">getNetworkGroupPolicies(networkId, callback)</td>
|
663
|
+
<td style="padding:15px">List the group policies in a network</td>
|
664
|
+
<td style="padding:15px">{base_path}/{version}/networks/{pathv1}/groupPolicies?{query}</td>
|
665
|
+
<td style="padding:15px">Yes</td>
|
666
|
+
</tr>
|
667
|
+
<tr>
|
668
|
+
<td style="padding:15px">createNetworkGroupPolicy(networkId, createNetworkGroupPolicy, callback)</td>
|
669
|
+
<td style="padding:15px">Create a group policy</td>
|
670
|
+
<td style="padding:15px">{base_path}/{version}/networks/{pathv1}/groupPolicies?{query}</td>
|
671
|
+
<td style="padding:15px">Yes</td>
|
672
|
+
</tr>
|
673
|
+
<tr>
|
674
|
+
<td style="padding:15px">getNetworkGroupPolicy(networkId, groupPolicyId, callback)</td>
|
675
|
+
<td style="padding:15px">Display a group policy</td>
|
676
|
+
<td style="padding:15px">{base_path}/{version}/networks/{pathv1}/groupPolicies/{pathv2}?{query}</td>
|
677
|
+
<td style="padding:15px">Yes</td>
|
678
|
+
</tr>
|
679
|
+
<tr>
|
680
|
+
<td style="padding:15px">updateNetworkGroupPolicy(networkId, groupPolicyId, updateNetworkGroupPolicy, callback)</td>
|
681
|
+
<td style="padding:15px">Update a group policy</td>
|
682
|
+
<td style="padding:15px">{base_path}/{version}/networks/{pathv1}/groupPolicies/{pathv2}?{query}</td>
|
683
|
+
<td style="padding:15px">Yes</td>
|
684
|
+
</tr>
|
685
|
+
<tr>
|
686
|
+
<td style="padding:15px">deleteNetworkGroupPolicy(networkId, groupPolicyId, callback)</td>
|
687
|
+
<td style="padding:15px">Delete a group policy</td>
|
688
|
+
<td style="padding:15px">{base_path}/{version}/networks/{pathv1}/groupPolicies/{pathv2}?{query}</td>
|
689
|
+
<td style="padding:15px">Yes</td>
|
690
|
+
</tr>
|
691
|
+
<tr>
|
692
|
+
<td style="padding:15px">getNetworkSsidHotspot20(networkId, number, callback)</td>
|
693
|
+
<td style="padding:15px">Return the Hotspot 2.0 settings for an SSID</td>
|
694
|
+
<td style="padding:15px">[object Object]</td>
|
695
|
+
<td style="padding:15px">Yes</td>
|
696
|
+
</tr>
|
697
|
+
<tr>
|
698
|
+
<td style="padding:15px">updateNetworkSsidHotspot20(networkId, number, updateNetworkSsidHotspot20, callback)</td>
|
699
|
+
<td style="padding:15px">Update the Hotspot 2.0 settings of an SSID</td>
|
700
|
+
<td style="padding:15px">[object Object]</td>
|
701
|
+
<td style="padding:15px">Yes</td>
|
702
|
+
</tr>
|
703
|
+
<tr>
|
704
|
+
<td style="padding:15px">getNetworkHttpServers(networkId, callback)</td>
|
705
|
+
<td style="padding:15px">List the HTTP servers for a network</td>
|
706
|
+
<td style="padding:15px">{base_path}/{version}/networks/{pathv1}/httpServers?{query}</td>
|
707
|
+
<td style="padding:15px">Yes</td>
|
708
|
+
</tr>
|
709
|
+
<tr>
|
710
|
+
<td style="padding:15px">createNetworkHttpServer(networkId, createNetworkHttpServer, callback)</td>
|
711
|
+
<td style="padding:15px">Add an HTTP server</td>
|
712
|
+
<td style="padding:15px">{base_path}/{version}/networks/{pathv1}/httpServers?{query}</td>
|
713
|
+
<td style="padding:15px">Yes</td>
|
714
|
+
</tr>
|
715
|
+
<tr>
|
716
|
+
<td style="padding:15px">getNetworkHttpServer(networkId, id, callback)</td>
|
717
|
+
<td style="padding:15px">Return an HTTP server</td>
|
718
|
+
<td style="padding:15px">{base_path}/{version}/networks/{pathv1}/httpServers/{pathv2}?{query}</td>
|
719
|
+
<td style="padding:15px">Yes</td>
|
720
|
+
</tr>
|
721
|
+
<tr>
|
722
|
+
<td style="padding:15px">updateNetworkHttpServer(networkId, id, updateNetworkHttpServer, callback)</td>
|
723
|
+
<td style="padding:15px">Update an HTTP server</td>
|
724
|
+
<td style="padding:15px">{base_path}/{version}/networks/{pathv1}/httpServers/{pathv2}?{query}</td>
|
725
|
+
<td style="padding:15px">Yes</td>
|
726
|
+
</tr>
|
727
|
+
<tr>
|
728
|
+
<td style="padding:15px">deleteNetworkHttpServer(networkId, id, callback)</td>
|
729
|
+
<td style="padding:15px">Delete an HTTP server</td>
|
730
|
+
<td style="padding:15px">{base_path}/{version}/networks/{pathv1}/httpServers/{pathv2}?{query}</td>
|
731
|
+
<td style="padding:15px">Yes</td>
|
732
|
+
</tr>
|
733
|
+
<tr>
|
734
|
+
<td style="padding:15px">createNetworkHttpServersWebhookTest(networkId, createNetworkHttpServersWebhookTest, callback)</td>
|
735
|
+
<td style="padding:15px">Send a test webhook</td>
|
736
|
+
<td style="padding:15px">{base_path}/{version}/networks/{pathv1}/httpServers/webhookTests?{query}</td>
|
737
|
+
<td style="padding:15px">Yes</td>
|
738
|
+
</tr>
|
739
|
+
<tr>
|
740
|
+
<td style="padding:15px">getNetworkHttpServersWebhookTest(networkId, id, callback)</td>
|
741
|
+
<td style="padding:15px">Return the status of a webhook test</td>
|
742
|
+
<td style="padding:15px">{base_path}/{version}/networks/{pathv1}/httpServers/webhookTests/{pathv2}?{query}</td>
|
743
|
+
<td style="padding:15px">Yes</td>
|
744
|
+
</tr>
|
745
|
+
<tr>
|
746
|
+
<td style="padding:15px">getNetworkDeviceManagementInterfaceSettings(networkId, serial, callback)</td>
|
747
|
+
<td style="padding:15px">Return the management interface settings for a device</td>
|
748
|
+
<td style="padding:15px">{base_path}/{version}/networks/{pathv1}/devices/{pathv2}/managementInterfaceSettings?{query}</td>
|
749
|
+
<td style="padding:15px">Yes</td>
|
750
|
+
</tr>
|
751
|
+
<tr>
|
752
|
+
<td style="padding:15px">getNetworkDeviceManagementInterfaceSettingsV1(serial, callback)</td>
|
753
|
+
<td style="padding:15px">Return the management interface settings for a device</td>
|
754
|
+
<td style="padding:15px">{base_path}/{version}/devices/{pathv1}/managementInterfaceSettings?{query}</td>
|
755
|
+
<td style="padding:15px">Yes</td>
|
756
|
+
</tr>
|
757
|
+
<tr>
|
758
|
+
<td style="padding:15px">updateNetworkDeviceManagementInterfaceSettings(networkId, serial, updateNetworkDeviceManagementInterfaceSettings, callback)</td>
|
759
|
+
<td style="padding:15px">Update the management interface settings for a device</td>
|
760
|
+
<td style="padding:15px">{base_path}/{version}/networks/{pathv1}/devices/{pathv2}/managementInterfaceSettings?{query}</td>
|
761
|
+
<td style="padding:15px">Yes</td>
|
762
|
+
</tr>
|
763
|
+
<tr>
|
764
|
+
<td style="padding:15px">updateNetworkDeviceManagementInterfaceSettingsV1(serial, updateNetworkDeviceManagementInterfaceSettings, callback)</td>
|
765
|
+
<td style="padding:15px">Update the management interface settings for a device</td>
|
766
|
+
<td style="padding:15px">{base_path}/{version}/devices/{pathv1}/managementInterfaceSettings?{query}</td>
|
767
|
+
<td style="padding:15px">Yes</td>
|
768
|
+
</tr>
|
769
|
+
<tr>
|
770
|
+
<td style="padding:15px">getNetworkMerakiAuthUsers(networkId, callback)</td>
|
771
|
+
<td style="padding:15px">List the splash or RADIUS users configured under Meraki Authentication for a network</td>
|
772
|
+
<td style="padding:15px">{base_path}/{version}/networks/{pathv1}/merakiAuthUsers?{query}</td>
|
773
|
+
<td style="padding:15px">Yes</td>
|
774
|
+
</tr>
|
775
|
+
<tr>
|
776
|
+
<td style="padding:15px">getNetworkMerakiAuthUser(networkId, id, callback)</td>
|
777
|
+
<td style="padding:15px">Return the Meraki Auth splash or RADIUS user</td>
|
778
|
+
<td style="padding:15px">{base_path}/{version}/networks/{pathv1}/merakiAuthUsers/{pathv2}?{query}</td>
|
779
|
+
<td style="padding:15px">Yes</td>
|
780
|
+
</tr>
|
781
|
+
<tr>
|
782
|
+
<td style="padding:15px">getOrganizationOpenapiSpec(organizationId, callback)</td>
|
783
|
+
<td style="padding:15px">Return the OpenAPI 2.0 Specification of the organization's API documentation in JSON</td>
|
784
|
+
<td style="padding:15px">{base_path}/{version}/organizations/{pathv1}/openapiSpec?{query}</td>
|
785
|
+
<td style="padding:15px">Yes</td>
|
786
|
+
</tr>
|
787
|
+
<tr>
|
788
|
+
<td style="padding:15px">getOrganizations(callback)</td>
|
789
|
+
<td style="padding:15px">List the organizations that the user has privileges on</td>
|
790
|
+
<td style="padding:15px">{base_path}/{version}/organizations?{query}</td>
|
791
|
+
<td style="padding:15px">Yes</td>
|
792
|
+
</tr>
|
793
|
+
<tr>
|
794
|
+
<td style="padding:15px">createOrganization(createOrganization, callback)</td>
|
795
|
+
<td style="padding:15px">Create a new organization</td>
|
796
|
+
<td style="padding:15px">{base_path}/{version}/organizations?{query}</td>
|
797
|
+
<td style="padding:15px">Yes</td>
|
798
|
+
</tr>
|
799
|
+
<tr>
|
800
|
+
<td style="padding:15px">getOrganization(id, callback)</td>
|
801
|
+
<td style="padding:15px">Return an organization</td>
|
802
|
+
<td style="padding:15px">{base_path}/{version}/organizations/{pathv1}?{query}</td>
|
803
|
+
<td style="padding:15px">Yes</td>
|
804
|
+
</tr>
|
805
|
+
<tr>
|
806
|
+
<td style="padding:15px">updateOrganization(id, updateOrganization, callback)</td>
|
807
|
+
<td style="padding:15px">Update an organization</td>
|
808
|
+
<td style="padding:15px">{base_path}/{version}/organizations/{pathv1}?{query}</td>
|
809
|
+
<td style="padding:15px">Yes</td>
|
810
|
+
</tr>
|
811
|
+
<tr>
|
812
|
+
<td style="padding:15px">cloneOrganization(id, cloneOrganization, callback)</td>
|
813
|
+
<td style="padding:15px">Create a new organization by cloning the addressed organization</td>
|
814
|
+
<td style="padding:15px">{base_path}/{version}/organizations/{pathv1}/clone?{query}</td>
|
815
|
+
<td style="padding:15px">Yes</td>
|
816
|
+
</tr>
|
817
|
+
<tr>
|
818
|
+
<td style="padding:15px">getOrganizationLicenseState(id, callback)</td>
|
819
|
+
<td style="padding:15px">Return the license state for an organization</td>
|
820
|
+
<td style="padding:15px">{base_path}/{version}/organizations/{pathv1}/licenseState?{query}</td>
|
821
|
+
<td style="padding:15px">Yes</td>
|
822
|
+
</tr>
|
823
|
+
<tr>
|
824
|
+
<td style="padding:15px">getOrganizationInventory(id, callback)</td>
|
825
|
+
<td style="padding:15px">Return the inventory for an organization</td>
|
826
|
+
<td style="padding:15px">[object Object]</td>
|
827
|
+
<td style="padding:15px">Yes</td>
|
828
|
+
</tr>
|
829
|
+
<tr>
|
830
|
+
<td style="padding:15px">getOrganizationDeviceStatuses(id, callback)</td>
|
831
|
+
<td style="padding:15px">List the status of every Meraki device in the organization</td>
|
832
|
+
<td style="padding:15px">{base_path}/{version}/organizations/{pathv1}/deviceStatuses?{query}</td>
|
833
|
+
<td style="padding:15px">Yes</td>
|
834
|
+
</tr>
|
835
|
+
<tr>
|
836
|
+
<td style="padding:15px">getOrganizationSnmp(id, callback)</td>
|
837
|
+
<td style="padding:15px">Return the SNMP settings for an organization</td>
|
838
|
+
<td style="padding:15px">{base_path}/{version}/organizations/{pathv1}/snmp?{query}</td>
|
839
|
+
<td style="padding:15px">Yes</td>
|
840
|
+
</tr>
|
841
|
+
<tr>
|
842
|
+
<td style="padding:15px">updateOrganizationSnmp(id, updateOrganizationSnmp, callback)</td>
|
843
|
+
<td style="padding:15px">Update the SNMP settings for an organization</td>
|
844
|
+
<td style="padding:15px">{base_path}/{version}/organizations/{pathv1}/snmp?{query}</td>
|
845
|
+
<td style="padding:15px">Yes</td>
|
846
|
+
</tr>
|
847
|
+
<tr>
|
848
|
+
<td style="padding:15px">claimOrganization(organizationId, claimOrganization, callback)</td>
|
849
|
+
<td style="padding:15px">Claim a device, license key, or order into an organization. When claiming by order, all devices and licenses in the order will be claimed; licenses will be added to the organization and devices will be placed in the organization's inventory. These three types of claims are mutually exclusive and cannot be performed in one request.</td>
|
850
|
+
<td style="padding:15px">{base_path}/{version}/organizations/{pathv1}/claim?{query}</td>
|
851
|
+
<td style="padding:15px">Yes</td>
|
852
|
+
</tr>
|
853
|
+
<tr>
|
854
|
+
<td style="padding:15px">getOrganizationUplinksLossAndLatency(organizationId, uplink, ip, callback)</td>
|
855
|
+
<td style="padding:15px">Return the uplink loss and latency for every MX in the organization from 2 - 7 minutes ago</td>
|
856
|
+
<td style="padding:15px">[object Object]</td>
|
857
|
+
<td style="padding:15px">Yes</td>
|
858
|
+
</tr>
|
859
|
+
<tr>
|
860
|
+
<td style="padding:15px">getOrganizationThirdPartyVPNPeers(organizationId, callback)</td>
|
861
|
+
<td style="padding:15px">Return the third party VPN peers for an organization</td>
|
862
|
+
<td style="padding:15px">[object Object]</td>
|
863
|
+
<td style="padding:15px">Yes</td>
|
864
|
+
</tr>
|
865
|
+
<tr>
|
866
|
+
<td style="padding:15px">updateOrganizationThirdPartyVPNPeers(organizationId, updateOrganizationThirdPartyVPNPeers, callback)</td>
|
867
|
+
<td style="padding:15px">Update the third party VPN peers for an organization</td>
|
868
|
+
<td style="padding:15px">[object Object]</td>
|
869
|
+
<td style="padding:15px">Yes</td>
|
870
|
+
</tr>
|
871
|
+
<tr>
|
872
|
+
<td style="padding:15px">getNetworkPiiPiiKeys(networkId, username, email, mac, serial, imei, bluetoothMac, callback)</td>
|
873
|
+
<td style="padding:15px">List the keys required to access Personally Identifiable Information (PII) for a given identifier. Exactly one identifier will be accepted. If the organization contains org-wide Systems Manager users matching the key provided then there will be an entry with the key "0" containing the applicable keys.
|
874
|
+
|
875
|
+
## ALTERNATE PATH
|
876
|
+
|
877
|
+
```
|
878
|
+
/organizations/{organizationId}/pii/piiKeys
|
879
|
+
```</td>
|
880
|
+
<td style="padding:15px">{base_path}/{version}/networks/{pathv1}/pii/piiKeys?{query}</td>
|
881
|
+
<td style="padding:15px">Yes</td>
|
882
|
+
</tr>
|
883
|
+
<tr>
|
884
|
+
<td style="padding:15px">getNetworkPiiSmDevicesForKey(networkId, username, email, mac, serial, imei, bluetoothMac, callback)</td>
|
885
|
+
<td style="padding:15px">Given a piece of Personally Identifiable Information (PII), return the Systems Manager device ID(s) associated with that identifier. These device IDs can be used with the Systems Manager API endpoints to retrieve device details. Exactly one identifier will be accepted.
|
886
|
+
|
887
|
+
## ALTERNATE PATH
|
888
|
+
|
889
|
+
```
|
890
|
+
/organizations/{organizationId}/pii/smDevicesForKey
|
891
|
+
```</td>
|
892
|
+
<td style="padding:15px">{base_path}/{version}/networks/{pathv1}/pii/smDevicesForKey?{query}</td>
|
893
|
+
<td style="padding:15px">Yes</td>
|
894
|
+
</tr>
|
895
|
+
<tr>
|
896
|
+
<td style="padding:15px">getNetworkPiiSmOwnersForKey(networkId, username, email, mac, serial, imei, bluetoothMac, callback)</td>
|
897
|
+
<td style="padding:15px">Given a piece of Personally Identifiable Information (PII), return the Systems Manager owner ID(s) associated with that identifier. These owner IDs can be used with the Systems Manager API endpoints to retrieve owner details. Exactly one identifier will be accepted.
|
898
|
+
|
899
|
+
## ALTERNATE PATH
|
900
|
+
|
901
|
+
```
|
902
|
+
/organizations/{organizationId}/pii/smOwnersForKey
|
903
|
+
```</td>
|
904
|
+
<td style="padding:15px">{base_path}/{version}/networks/{pathv1}/pii/smOwnersForKey?{query}</td>
|
905
|
+
<td style="padding:15px">Yes</td>
|
906
|
+
</tr>
|
907
|
+
<tr>
|
908
|
+
<td style="padding:15px">getNetworkPiiRequests(networkId, callback)</td>
|
909
|
+
<td style="padding:15px">List the PII requests for this network or organization
|
910
|
+
|
911
|
+
## ALTERNATE PATH
|
912
|
+
|
913
|
+
```
|
914
|
+
/organizations/{organizationId}/pii/requests
|
915
|
+
```</td>
|
916
|
+
<td style="padding:15px">{base_path}/{version}/networks/{pathv1}/pii/requests?{query}</td>
|
917
|
+
<td style="padding:15px">Yes</td>
|
918
|
+
</tr>
|
919
|
+
<tr>
|
920
|
+
<td style="padding:15px">createNetworkPiiRequest(networkId, createNetworkPiiRequest, callback)</td>
|
921
|
+
<td style="padding:15px">Submit a new delete or restrict processing PII request
|
922
|
+
|
923
|
+
## ALTERNATE PATH
|
924
|
+
|
925
|
+
```
|
926
|
+
/organizations/{organizationId}/pii/requests
|
927
|
+
```</td>
|
928
|
+
<td style="padding:15px">{base_path}/{version}/networks/{pathv1}/pii/requests?{query}</td>
|
929
|
+
<td style="padding:15px">Yes</td>
|
930
|
+
</tr>
|
931
|
+
<tr>
|
932
|
+
<td style="padding:15px">getNetworkPiiRequest(networkId, requestId, callback)</td>
|
933
|
+
<td style="padding:15px">Return a PII request
|
934
|
+
|
935
|
+
## ALTERNATE PATH
|
936
|
+
|
937
|
+
```
|
938
|
+
/organizations/{organizationId}/pii/requests/{requestId}
|
939
|
+
```</td>
|
940
|
+
<td style="padding:15px">{base_path}/{version}/networks/{pathv1}/pii/requests/{pathv2}?{query}</td>
|
941
|
+
<td style="padding:15px">Yes</td>
|
942
|
+
</tr>
|
943
|
+
<tr>
|
944
|
+
<td style="padding:15px">deleteNetworkPiiRequest(networkId, requestId, callback)</td>
|
945
|
+
<td style="padding:15px">Delete a restrict processing PII request
|
946
|
+
|
947
|
+
## ALTERNATE PATH
|
948
|
+
|
949
|
+
```
|
950
|
+
/organizations/{organizationId}/pii/requests/{requestId}
|
951
|
+
```</td>
|
952
|
+
<td style="padding:15px">{base_path}/{version}/networks/{pathv1}/pii/requests/{pathv2}?{query}</td>
|
953
|
+
<td style="padding:15px">Yes</td>
|
954
|
+
</tr>
|
955
|
+
<tr>
|
956
|
+
<td style="padding:15px">returnTheSNMPSettingsForANetwork(networkId, callback)</td>
|
957
|
+
<td style="padding:15px">Return the SNMP settings for a network</td>
|
958
|
+
<td style="padding:15px">[object Object]</td>
|
959
|
+
<td style="padding:15px">Yes</td>
|
960
|
+
</tr>
|
961
|
+
<tr>
|
962
|
+
<td style="padding:15px">updateTheSNMPSettingsForANetwork(networkId, body, callback)</td>
|
963
|
+
<td style="padding:15px">Update the SNMP settings for a network
|
964
|
+
#### Body Parameters
|
965
|
+
**Parameter**|**Type**|**Description**
|
966
|
+
:-------------: |:-------------: |:-------------:
|
967
|
+
access| string| The type of SNMP access. Can be one of 'none' (disabled), 'community' (V1/V2c), or 'users' (V3).
|
968
|
+
communityString| string| The SNMP community string. Only relevant if 'access' is set to 'community'.
|
969
|
+
users| array| The list of SNMP users. Only relevant if 'access' is set to 'users'.</td>
|
970
|
+
<td style="padding:15px">[object Object]</td>
|
971
|
+
<td style="padding:15px">Yes</td>
|
972
|
+
</tr>
|
973
|
+
<tr>
|
974
|
+
<td style="padding:15px">returnTheSNMPSettingsForAnOrganization(organizationId, callback)</td>
|
975
|
+
<td style="padding:15px">Return the SNMP settings for an organization</td>
|
976
|
+
<td style="padding:15px">{base_path}/{version}/organizations/{pathv1}/snmp?{query}</td>
|
977
|
+
<td style="padding:15px">Yes</td>
|
978
|
+
</tr>
|
979
|
+
<tr>
|
980
|
+
<td style="padding:15px">updateTheSNMPSettingsForAnOrganization(organizationId, body, callback)</td>
|
981
|
+
<td style="padding:15px">Update the SNMP settings for an organization
|
982
|
+
#### Body Parameters
|
983
|
+
**Parameter**|**Type**|**Description**
|
984
|
+
:-------------: |:-------------: |:-------------:
|
985
|
+
v2cEnabled| boolean| Boolean indicating whether SNMP version 2c is enabled for the organization.
|
986
|
+
v3Enabled| boolean| Boolean indicating whether SNMP version 3 is enabled for the organization.
|
987
|
+
v3AuthMode| string| The SNMP version 3 authentication mode. Can be either 'MD5' or 'SHA'.
|
988
|
+
v3AuthPass| string| The SNMP version 3 authentication pass...(description truncated)</td>
|
989
|
+
<td style="padding:15px">{base_path}/{version}/organizations/{pathv1}/snmp?{query}</td>
|
990
|
+
<td style="padding:15px">Yes</td>
|
991
|
+
</tr>
|
992
|
+
<tr>
|
993
|
+
<td style="padding:15px">getNetworkDeviceWirelessRadioSettings(networkId, serial, callback)</td>
|
994
|
+
<td style="padding:15px">Return the radio settings of a device</td>
|
995
|
+
<td style="padding:15px">{base_path}/{version}/networks/{pathv1}/devices/{pathv2}/wireless/radioSettings?{query}</td>
|
996
|
+
<td style="padding:15px">Yes</td>
|
997
|
+
</tr>
|
998
|
+
<tr>
|
999
|
+
<td style="padding:15px">getNetworkDeviceWirelessRadioSettingsV1(serial, callback)</td>
|
1000
|
+
<td style="padding:15px">Return the radio settings of a device</td>
|
1001
|
+
<td style="padding:15px">{base_path}/{version}/devices/{pathv1}/wireless/radio/settings?{query}</td>
|
1002
|
+
<td style="padding:15px">Yes</td>
|
1003
|
+
</tr>
|
1004
|
+
<tr>
|
1005
|
+
<td style="padding:15px">updateNetworkDeviceWirelessRadioSettings(networkId, serial, updateNetworkDeviceWirelessRadioSettings, callback)</td>
|
1006
|
+
<td style="padding:15px">Update the radio settings of a device</td>
|
1007
|
+
<td style="padding:15px">{base_path}/{version}/networks/{pathv1}/devices/{pathv2}/wireless/radioSettings?{query}</td>
|
1008
|
+
<td style="padding:15px">Yes</td>
|
1009
|
+
</tr>
|
1010
|
+
<tr>
|
1011
|
+
<td style="padding:15px">updateNetworkDeviceWirelessRadioSettingsV1(serial, updateNetworkDeviceWirelessRadioSettings, callback)</td>
|
1012
|
+
<td style="padding:15px">Update the radio settings of a device</td>
|
1013
|
+
<td style="padding:15px">{base_path}/{version}/devices/{pathv1}/wireless/radio/settings?{query}</td>
|
1014
|
+
<td style="padding:15px">Yes</td>
|
1015
|
+
</tr>
|
1016
|
+
<tr>
|
1017
|
+
<td style="padding:15px">getNetworkWirelessRfProfiles(networkId, includeTemplateProfiles, callback)</td>
|
1018
|
+
<td style="padding:15px">List the non-basic RF profiles for this network</td>
|
1019
|
+
<td style="padding:15px">{base_path}/{version}/networks/{pathv1}/wireless/rfProfiles?{query}</td>
|
1020
|
+
<td style="padding:15px">Yes</td>
|
1021
|
+
</tr>
|
1022
|
+
<tr>
|
1023
|
+
<td style="padding:15px">getOrganizationSamlRoles(organizationId, callback)</td>
|
1024
|
+
<td style="padding:15px">List the SAML roles for this organization</td>
|
1025
|
+
<td style="padding:15px">{base_path}/{version}/organizations/{pathv1}/samlRoles?{query}</td>
|
1026
|
+
<td style="padding:15px">Yes</td>
|
1027
|
+
</tr>
|
1028
|
+
<tr>
|
1029
|
+
<td style="padding:15px">createOrganizationSamlRole(organizationId, createOrganizationSamlRole, callback)</td>
|
1030
|
+
<td style="padding:15px">Create a SAML role</td>
|
1031
|
+
<td style="padding:15px">{base_path}/{version}/organizations/{pathv1}/samlRoles?{query}</td>
|
1032
|
+
<td style="padding:15px">Yes</td>
|
1033
|
+
</tr>
|
1034
|
+
<tr>
|
1035
|
+
<td style="padding:15px">getOrganizationSamlRole(organizationId, id, callback)</td>
|
1036
|
+
<td style="padding:15px">Return a SAML role</td>
|
1037
|
+
<td style="padding:15px">{base_path}/{version}/organizations/{pathv1}/samlRoles/{pathv2}?{query}</td>
|
1038
|
+
<td style="padding:15px">Yes</td>
|
1039
|
+
</tr>
|
1040
|
+
<tr>
|
1041
|
+
<td style="padding:15px">updateOrganizationSamlRole(organizationId, id, updateOrganizationSamlRole, callback)</td>
|
1042
|
+
<td style="padding:15px">Update a SAML role</td>
|
1043
|
+
<td style="padding:15px">{base_path}/{version}/organizations/{pathv1}/samlRoles/{pathv2}?{query}</td>
|
1044
|
+
<td style="padding:15px">Yes</td>
|
1045
|
+
</tr>
|
1046
|
+
<tr>
|
1047
|
+
<td style="padding:15px">deleteOrganizationSamlRole(organizationId, id, callback)</td>
|
1048
|
+
<td style="padding:15px">Remove a SAML role</td>
|
1049
|
+
<td style="padding:15px">{base_path}/{version}/organizations/{pathv1}/samlRoles/{pathv2}?{query}</td>
|
1050
|
+
<td style="padding:15px">Yes</td>
|
1051
|
+
</tr>
|
1052
|
+
<tr>
|
1053
|
+
<td style="padding:15px">getNetworkClientSecurityEvents(networkId, clientId, t0, t1, timespan, perPage, startingAfter, endingBefore, callback)</td>
|
1054
|
+
<td style="padding:15px">List the security events for a client. Clients can be identified by a client key or either the MAC or IP depending on whether the network uses Track-by-IP.</td>
|
1055
|
+
<td style="padding:15px">[object Object]</td>
|
1056
|
+
<td style="padding:15px">Yes</td>
|
1057
|
+
</tr>
|
1058
|
+
<tr>
|
1059
|
+
<td style="padding:15px">getNetworkSecurityEvents(networkId, t0, t1, timespan, perPage, startingAfter, endingBefore, callback)</td>
|
1060
|
+
<td style="padding:15px">List the security events for a network</td>
|
1061
|
+
<td style="padding:15px">[object Object]</td>
|
1062
|
+
<td style="padding:15px">Yes</td>
|
1063
|
+
</tr>
|
1064
|
+
<tr>
|
1065
|
+
<td style="padding:15px">getOrganizationSecurityEvents(organizationId, t0, t1, timespan, perPage, startingAfter, endingBefore, callback)</td>
|
1066
|
+
<td style="padding:15px">List the security events for an organization</td>
|
1067
|
+
<td style="padding:15px">[object Object]</td>
|
1068
|
+
<td style="padding:15px">Yes</td>
|
1069
|
+
</tr>
|
1070
|
+
<tr>
|
1071
|
+
<td style="padding:15px">getNetworkSecurityIntrusionSettings(networkId, callback)</td>
|
1072
|
+
<td style="padding:15px">Returns all supported intrusion settings for an MX network</td>
|
1073
|
+
<td style="padding:15px">[object Object]</td>
|
1074
|
+
<td style="padding:15px">Yes</td>
|
1075
|
+
</tr>
|
1076
|
+
<tr>
|
1077
|
+
<td style="padding:15px">updateNetworkSecurityIntrusionSettings(networkId, updateNetworkSecurityIntrusionSettings, callback)</td>
|
1078
|
+
<td style="padding:15px">Set the supported instrusion settings for an MX network</td>
|
1079
|
+
<td style="padding:15px">[object Object]</td>
|
1080
|
+
<td style="padding:15px">Yes</td>
|
1081
|
+
</tr>
|
1082
|
+
<tr>
|
1083
|
+
<td style="padding:15px">getOrganizationSecurityIntrusionSettings(organizationId, callback)</td>
|
1084
|
+
<td style="padding:15px">Returns all supported intrusion settings for an organization</td>
|
1085
|
+
<td style="padding:15px">[object Object]</td>
|
1086
|
+
<td style="padding:15px">Yes</td>
|
1087
|
+
</tr>
|
1088
|
+
<tr>
|
1089
|
+
<td style="padding:15px">updateOrganizationSecurityIntrusionSettings(organizationId, updateOrganizationSecurityIntrusionSettings, callback)</td>
|
1090
|
+
<td style="padding:15px">Sets supported intrusion settings for an organization</td>
|
1091
|
+
<td style="padding:15px">[object Object]</td>
|
1092
|
+
<td style="padding:15px">Yes</td>
|
1093
|
+
</tr>
|
1094
|
+
<tr>
|
1095
|
+
<td style="padding:15px">getNetworkSecurityMalwareSettings(networkId, callback)</td>
|
1096
|
+
<td style="padding:15px">Returns all supported malware settings for an MX network</td>
|
1097
|
+
<td style="padding:15px">[object Object]</td>
|
1098
|
+
<td style="padding:15px">Yes</td>
|
1099
|
+
</tr>
|
1100
|
+
<tr>
|
1101
|
+
<td style="padding:15px">updateNetworkSecurityMalwareSettings(networkId, updateNetworkSecurityMalwareSettings, callback)</td>
|
1102
|
+
<td style="padding:15px">Set the supported malware settings for an MX network</td>
|
1103
|
+
<td style="padding:15px">[object Object]</td>
|
1104
|
+
<td style="padding:15px">Yes</td>
|
1105
|
+
</tr>
|
1106
|
+
<tr>
|
1107
|
+
<td style="padding:15px">getNetworkSmTargetGroups(networkId, withDetails, callback)</td>
|
1108
|
+
<td style="padding:15px">List the target groups in this network</td>
|
1109
|
+
<td style="padding:15px">{base_path}/{version}/networks/{pathv1}/sm/targetGroups?{query}</td>
|
1110
|
+
<td style="padding:15px">Yes</td>
|
1111
|
+
</tr>
|
1112
|
+
<tr>
|
1113
|
+
<td style="padding:15px">createNetworkSmTargetGroup(networkId, createNetworkSmTargetGroup, callback)</td>
|
1114
|
+
<td style="padding:15px">Add a target group</td>
|
1115
|
+
<td style="padding:15px">{base_path}/{version}/networks/{pathv1}/sm/targetGroups?{query}</td>
|
1116
|
+
<td style="padding:15px">Yes</td>
|
1117
|
+
</tr>
|
1118
|
+
<tr>
|
1119
|
+
<td style="padding:15px">getNetworkSmTargetGroup(networkId, targetGroupId, withDetails, callback)</td>
|
1120
|
+
<td style="padding:15px">Return a target group</td>
|
1121
|
+
<td style="padding:15px">{base_path}/{version}/networks/{pathv1}/sm/targetGroups/{pathv2}?{query}</td>
|
1122
|
+
<td style="padding:15px">Yes</td>
|
1123
|
+
</tr>
|
1124
|
+
<tr>
|
1125
|
+
<td style="padding:15px">updateNetworkSmTargetGroup(networkId, targetGroupId, updateNetworkSmTargetGroup, callback)</td>
|
1126
|
+
<td style="padding:15px">Update a target group</td>
|
1127
|
+
<td style="padding:15px">{base_path}/{version}/networks/{pathv1}/sm/targetGroups/{pathv2}?{query}</td>
|
1128
|
+
<td style="padding:15px">Yes</td>
|
1129
|
+
</tr>
|
1130
|
+
<tr>
|
1131
|
+
<td style="padding:15px">deleteNetworkSmTargetGroup(networkId, targetGroupId, callback)</td>
|
1132
|
+
<td style="padding:15px">Delete a target group from a network</td>
|
1133
|
+
<td style="padding:15px">{base_path}/{version}/networks/{pathv1}/sm/targetGroups/{pathv2}?{query}</td>
|
1134
|
+
<td style="padding:15px">Yes</td>
|
1135
|
+
</tr>
|
1136
|
+
<tr>
|
1137
|
+
<td style="padding:15px">createNetworkSmProfileClarity(networkId, createNetworkSmProfileClarity, callback)</td>
|
1138
|
+
<td style="padding:15px">Create a new profile containing a Cisco Clarity payload</td>
|
1139
|
+
<td style="padding:15px">{base_path}/{version}/networks/{pathv1}/sm/profile/clarity?{query}</td>
|
1140
|
+
<td style="padding:15px">Yes</td>
|
1141
|
+
</tr>
|
1142
|
+
<tr>
|
1143
|
+
<td style="padding:15px">updateNetworkSmProfileClarity(networkId, profileId, updateNetworkSmProfileClarity, callback)</td>
|
1144
|
+
<td style="padding:15px">Update an existing profile containing a Cisco Clarity payload</td>
|
1145
|
+
<td style="padding:15px">{base_path}/{version}/networks/{pathv1}/sm/profile/clarity/{pathv2}?{query}</td>
|
1146
|
+
<td style="padding:15px">Yes</td>
|
1147
|
+
</tr>
|
1148
|
+
<tr>
|
1149
|
+
<td style="padding:15px">addNetworkSmProfileClarity(networkId, profileId, addNetworkSmProfileClarity, callback)</td>
|
1150
|
+
<td style="padding:15px">Add a Cisco Clarity payload to an existing profile</td>
|
1151
|
+
<td style="padding:15px">{base_path}/{version}/networks/{pathv1}/sm/profile/clarity/{pathv2}?{query}</td>
|
1152
|
+
<td style="padding:15px">Yes</td>
|
1153
|
+
</tr>
|
1154
|
+
<tr>
|
1155
|
+
<td style="padding:15px">getNetworkSmProfileClarity(networkId, profileId, callback)</td>
|
1156
|
+
<td style="padding:15px">Get details for a Cisco Clarity payload</td>
|
1157
|
+
<td style="padding:15px">{base_path}/{version}/networks/{pathv1}/sm/profile/clarity/{pathv2}?{query}</td>
|
1158
|
+
<td style="padding:15px">Yes</td>
|
1159
|
+
</tr>
|
1160
|
+
<tr>
|
1161
|
+
<td style="padding:15px">deleteNetworkSmProfileClarity(networkId, profileId, callback)</td>
|
1162
|
+
<td style="padding:15px">Delete a Cisco Clarity payload. Deletes the entire profile if it's empty after removing the payload.</td>
|
1163
|
+
<td style="padding:15px">{base_path}/{version}/networks/{pathv1}/sm/profile/clarity/{pathv2}?{query}</td>
|
1164
|
+
<td style="padding:15px">Yes</td>
|
1165
|
+
</tr>
|
1166
|
+
<tr>
|
1167
|
+
<td style="padding:15px">createNetworkSmProfileUmbrella(networkId, createNetworkSmProfileUmbrella, callback)</td>
|
1168
|
+
<td style="padding:15px">Create a new profile containing a Cisco Umbrella payload</td>
|
1169
|
+
<td style="padding:15px">{base_path}/{version}/networks/{pathv1}/sm/profile/umbrella?{query}</td>
|
1170
|
+
<td style="padding:15px">Yes</td>
|
1171
|
+
</tr>
|
1172
|
+
<tr>
|
1173
|
+
<td style="padding:15px">updateNetworkSmProfileUmbrella(networkId, profileId, updateNetworkSmProfileUmbrella, callback)</td>
|
1174
|
+
<td style="padding:15px">Update an existing profile containing a Cisco Umbrella payload</td>
|
1175
|
+
<td style="padding:15px">{base_path}/{version}/networks/{pathv1}/sm/profile/umbrella/{pathv2}?{query}</td>
|
1176
|
+
<td style="padding:15px">Yes</td>
|
1177
|
+
</tr>
|
1178
|
+
<tr>
|
1179
|
+
<td style="padding:15px">addNetworkSmProfileUmbrella(networkId, profileId, addNetworkSmProfileUmbrella, callback)</td>
|
1180
|
+
<td style="padding:15px">Add a Cisco Umbrella payload to an existing profile</td>
|
1181
|
+
<td style="padding:15px">{base_path}/{version}/networks/{pathv1}/sm/profile/umbrella/{pathv2}?{query}</td>
|
1182
|
+
<td style="padding:15px">Yes</td>
|
1183
|
+
</tr>
|
1184
|
+
<tr>
|
1185
|
+
<td style="padding:15px">getNetworkSmProfileUmbrella(networkId, profileId, callback)</td>
|
1186
|
+
<td style="padding:15px">Get details for a Cisco Umbrella payload</td>
|
1187
|
+
<td style="padding:15px">{base_path}/{version}/networks/{pathv1}/sm/profile/umbrella/{pathv2}?{query}</td>
|
1188
|
+
<td style="padding:15px">Yes</td>
|
1189
|
+
</tr>
|
1190
|
+
<tr>
|
1191
|
+
<td style="padding:15px">deleteNetworkSmProfileUmbrella(networkId, profileId, callback)</td>
|
1192
|
+
<td style="padding:15px">Delete a Cisco Umbrella payload. Deletes the entire profile if it's empty after removing the payload</td>
|
1193
|
+
<td style="padding:15px">{base_path}/{version}/networks/{pathv1}/sm/profile/umbrella/{pathv2}?{query}</td>
|
1194
|
+
<td style="padding:15px">Yes</td>
|
1195
|
+
</tr>
|
1196
|
+
<tr>
|
1197
|
+
<td style="padding:15px">createNetworkSmAppPolaris(networkId, createNetworkSmAppPolaris, callback)</td>
|
1198
|
+
<td style="padding:15px">Create a new Polaris app</td>
|
1199
|
+
<td style="padding:15px">{base_path}/{version}/networks/{pathv1}/sm/app/polaris?{query}</td>
|
1200
|
+
<td style="padding:15px">Yes</td>
|
1201
|
+
</tr>
|
1202
|
+
<tr>
|
1203
|
+
<td style="padding:15px">getNetworkSmAppPolaris(networkId, bundleId, callback)</td>
|
1204
|
+
<td style="padding:15px">Get details for a Cisco Polaris app if it exists</td>
|
1205
|
+
<td style="padding:15px">{base_path}/{version}/networks/{pathv1}/sm/app/polaris?{query}</td>
|
1206
|
+
<td style="padding:15px">Yes</td>
|
1207
|
+
</tr>
|
1208
|
+
<tr>
|
1209
|
+
<td style="padding:15px">updateNetworkSmAppPolaris(networkId, appId, updateNetworkSmAppPolaris, callback)</td>
|
1210
|
+
<td style="padding:15px">Update an existing Polaris app</td>
|
1211
|
+
<td style="padding:15px">{base_path}/{version}/networks/{pathv1}/sm/app/polaris/{pathv2}?{query}</td>
|
1212
|
+
<td style="padding:15px">Yes</td>
|
1213
|
+
</tr>
|
1214
|
+
<tr>
|
1215
|
+
<td style="padding:15px">deleteNetworkSmAppPolaris(networkId, appId, callback)</td>
|
1216
|
+
<td style="padding:15px">Delete a Cisco Polaris app</td>
|
1217
|
+
<td style="padding:15px">{base_path}/{version}/networks/{pathv1}/sm/app/polaris/{pathv2}?{query}</td>
|
1218
|
+
<td style="padding:15px">Yes</td>
|
1219
|
+
</tr>
|
1220
|
+
<tr>
|
1221
|
+
<td style="padding:15px">getNetworkSmDevices(networkId, fields, wifiMacs, serials, ids, scope, batchToken, callback)</td>
|
1222
|
+
<td style="padding:15px">List the devices enrolled in an SM network with various specified fields and filters</td>
|
1223
|
+
<td style="padding:15px">{base_path}/{version}/networks/{pathv1}/sm/devices?{query}</td>
|
1224
|
+
<td style="padding:15px">Yes</td>
|
1225
|
+
</tr>
|
1226
|
+
<tr>
|
1227
|
+
<td style="padding:15px">getNetworkSmUsers(networkId, usernames, emails, ids, scope, callback)</td>
|
1228
|
+
<td style="padding:15px">List the owners in an SM network with various specified fields and filters</td>
|
1229
|
+
<td style="padding:15px">{base_path}/{version}/networks/{pathv1}/sm/users?{query}</td>
|
1230
|
+
<td style="padding:15px">Yes</td>
|
1231
|
+
</tr>
|
1232
|
+
<tr>
|
1233
|
+
<td style="padding:15px">getNetworkSmUserDeviceProfiles(networkId, id, callback)</td>
|
1234
|
+
<td style="padding:15px">Get the profiles associated with a user</td>
|
1235
|
+
<td style="padding:15px">[object Object]</td>
|
1236
|
+
<td style="padding:15px">Yes</td>
|
1237
|
+
</tr>
|
1238
|
+
<tr>
|
1239
|
+
<td style="padding:15px">getNetworkSmDeviceProfiles(networkId, id, callback)</td>
|
1240
|
+
<td style="padding:15px">Get the profiles associated with a device</td>
|
1241
|
+
<td style="padding:15px">{base_path}/{version}/networks/{pathv1}/sm/{pathv2}/deviceProfiles?{query}</td>
|
1242
|
+
<td style="padding:15px">Yes</td>
|
1243
|
+
</tr>
|
1244
|
+
<tr>
|
1245
|
+
<td style="padding:15px">getNetworkSmUserSoftwares(networkId, id, callback)</td>
|
1246
|
+
<td style="padding:15px">Get a list of softwares associated with a user</td>
|
1247
|
+
<td style="padding:15px">[object Object]</td>
|
1248
|
+
<td style="padding:15px">Yes</td>
|
1249
|
+
</tr>
|
1250
|
+
<tr>
|
1251
|
+
<td style="padding:15px">getNetworkSmSoftwares(networkId, id, callback)</td>
|
1252
|
+
<td style="padding:15px">Get a list of softwares associated with a device</td>
|
1253
|
+
<td style="padding:15px">[object Object]</td>
|
1254
|
+
<td style="padding:15px">Yes</td>
|
1255
|
+
</tr>
|
1256
|
+
<tr>
|
1257
|
+
<td style="padding:15px">getNetworkSmNetworkAdapters(networkId, id, callback)</td>
|
1258
|
+
<td style="padding:15px">List the network adapters of a device</td>
|
1259
|
+
<td style="padding:15px">[object Object]</td>
|
1260
|
+
<td style="padding:15px">Yes</td>
|
1261
|
+
</tr>
|
1262
|
+
<tr>
|
1263
|
+
<td style="padding:15px">getNetworkSmWlanLists(networkId, id, callback)</td>
|
1264
|
+
<td style="padding:15px">List the saved SSID names on a device</td>
|
1265
|
+
<td style="padding:15px">[object Object]</td>
|
1266
|
+
<td style="padding:15px">Yes</td>
|
1267
|
+
</tr>
|
1268
|
+
<tr>
|
1269
|
+
<td style="padding:15px">getNetworkSmSecurityCenters(networkId, id, callback)</td>
|
1270
|
+
<td style="padding:15px">List the security centers on a device</td>
|
1271
|
+
<td style="padding:15px">[object Object]</td>
|
1272
|
+
<td style="padding:15px">Yes</td>
|
1273
|
+
</tr>
|
1274
|
+
<tr>
|
1275
|
+
<td style="padding:15px">getNetworkSmRestrictions(networkId, id, callback)</td>
|
1276
|
+
<td style="padding:15px">List the restrictions on a device</td>
|
1277
|
+
<td style="padding:15px">[object Object]</td>
|
1278
|
+
<td style="padding:15px">Yes</td>
|
1279
|
+
</tr>
|
1280
|
+
<tr>
|
1281
|
+
<td style="padding:15px">getNetworkSmCerts(networkId, id, callback)</td>
|
1282
|
+
<td style="padding:15px">List the certs on a device</td>
|
1283
|
+
<td style="padding:15px">[object Object]</td>
|
1284
|
+
<td style="padding:15px">Yes</td>
|
1285
|
+
</tr>
|
1286
|
+
<tr>
|
1287
|
+
<td style="padding:15px">updateNetworkSmDevicesTags(networkId, updateNetworkSmDevicesTags, callback)</td>
|
1288
|
+
<td style="padding:15px">Add, delete, or update the tags of a set of devices</td>
|
1289
|
+
<td style="padding:15px">{base_path}/{version}/networks/{pathv1}/sm/devices/tags?{query}</td>
|
1290
|
+
<td style="padding:15px">Yes</td>
|
1291
|
+
</tr>
|
1292
|
+
<tr>
|
1293
|
+
<td style="padding:15px">updateNetworkSmDevicesTagsV1(networkId, updateNetworkSmDevicesTags, callback)</td>
|
1294
|
+
<td style="padding:15px">Add, delete, or update the tags of a set of devices</td>
|
1295
|
+
<td style="padding:15px">{base_path}/{version}/networks/{pathv1}/sm/devices/modifyTags?{query}</td>
|
1296
|
+
<td style="padding:15px">Yes</td>
|
1297
|
+
</tr>
|
1298
|
+
<tr>
|
1299
|
+
<td style="padding:15px">updateNetworkSmDeviceFields(networkId, updateNetworkSmDeviceFields, callback)</td>
|
1300
|
+
<td style="padding:15px">Modify the fields of a device</td>
|
1301
|
+
<td style="padding:15px">[object Object]</td>
|
1302
|
+
<td style="padding:15px">Yes</td>
|
1303
|
+
</tr>
|
1304
|
+
<tr>
|
1305
|
+
<td style="padding:15px">lockNetworkSmDevices(networkId, lockNetworkSmDevices, callback)</td>
|
1306
|
+
<td style="padding:15px">Lock a set of devices</td>
|
1307
|
+
<td style="padding:15px">{base_path}/{version}/networks/{pathv1}/sm/devices/lock?{query}</td>
|
1308
|
+
<td style="padding:15px">Yes</td>
|
1309
|
+
</tr>
|
1310
|
+
<tr>
|
1311
|
+
<td style="padding:15px">wipeNetworkSmDevice(networkId, wipeNetworkSmDevice, callback)</td>
|
1312
|
+
<td style="padding:15px">Wipe a device</td>
|
1313
|
+
<td style="padding:15px">{base_path}/{version}/networks/{pathv1}/sm/device/wipe?{query}</td>
|
1314
|
+
<td style="padding:15px">Yes</td>
|
1315
|
+
</tr>
|
1316
|
+
<tr>
|
1317
|
+
<td style="padding:15px">wipeNetworkSmDeviceV1(networkId, wipeNetworkSmDevice, callback)</td>
|
1318
|
+
<td style="padding:15px">Wipe a device</td>
|
1319
|
+
<td style="padding:15px">{base_path}/{version}/networks/{pathv1}/sm/devices/wipe?{query}</td>
|
1320
|
+
<td style="padding:15px">Yes</td>
|
1321
|
+
</tr>
|
1322
|
+
<tr>
|
1323
|
+
<td style="padding:15px">checkinNetworkSmDevices(networkId, checkinNetworkSmDevices, callback)</td>
|
1324
|
+
<td style="padding:15px">Force check-in a set of devices</td>
|
1325
|
+
<td style="padding:15px">{base_path}/{version}/networks/{pathv1}/sm/devices/checkin?{query}</td>
|
1326
|
+
<td style="padding:15px">Yes</td>
|
1327
|
+
</tr>
|
1328
|
+
<tr>
|
1329
|
+
<td style="padding:15px">checkinNetworkSmDevicesV1(networkId, checkinNetworkSmDevices, callback)</td>
|
1330
|
+
<td style="padding:15px">Force check-in a set of devices</td>
|
1331
|
+
<td style="padding:15px">{base_path}/{version}/networks/{pathv1}/sm/devices/checkin?{query}</td>
|
1332
|
+
<td style="padding:15px">Yes</td>
|
1333
|
+
</tr>
|
1334
|
+
<tr>
|
1335
|
+
<td style="padding:15px">moveNetworkSmDevices(networkId, moveNetworkSmDevices, callback)</td>
|
1336
|
+
<td style="padding:15px">Move a set of devices to a new network</td>
|
1337
|
+
<td style="padding:15px">{base_path}/{version}/networks/{pathv1}/sm/devices/move?{query}</td>
|
1338
|
+
<td style="padding:15px">Yes</td>
|
1339
|
+
</tr>
|
1340
|
+
<tr>
|
1341
|
+
<td style="padding:15px">moveNetworkSmDevicesV1(networkId, moveNetworkSmDevices, callback)</td>
|
1342
|
+
<td style="padding:15px">Move a set of devices to a new network</td>
|
1343
|
+
<td style="padding:15px">{base_path}/{version}/networks/{pathv1}/sm/devices/move?{query}</td>
|
1344
|
+
<td style="padding:15px">Yes</td>
|
1345
|
+
</tr>
|
1346
|
+
<tr>
|
1347
|
+
<td style="padding:15px">unenrollNetworkSmDevice(networkId, deviceId, callback)</td>
|
1348
|
+
<td style="padding:15px">Unenroll a device</td>
|
1349
|
+
<td style="padding:15px">{base_path}/{version}/networks/{pathv1}/sm/devices/{pathv2}/unenroll?{query}</td>
|
1350
|
+
<td style="padding:15px">Yes</td>
|
1351
|
+
</tr>
|
1352
|
+
<tr>
|
1353
|
+
<td style="padding:15px">updateNetworkSmProfileReinstall(networkId, updateNetworkSmProfileReinstall, callback)</td>
|
1354
|
+
<td style="padding:15px">Force reinstall a profile on a given device</td>
|
1355
|
+
<td style="padding:15px">{base_path}/{version}/networks/{pathv1}/sm/profile/reinstall?{query}</td>
|
1356
|
+
<td style="padding:15px">Yes</td>
|
1357
|
+
</tr>
|
1358
|
+
<tr>
|
1359
|
+
<td style="padding:15px">getNetworkSmProfiles(networkId, callback)</td>
|
1360
|
+
<td style="padding:15px">List all the profiles in the network</td>
|
1361
|
+
<td style="padding:15px">{base_path}/{version}/networks/{pathv1}/sm/profiles?{query}</td>
|
1362
|
+
<td style="padding:15px">Yes</td>
|
1363
|
+
</tr>
|
1364
|
+
<tr>
|
1365
|
+
<td style="padding:15px">deleteNetworkSmProfile(networkId, deleteNetworkSmProfile, callback)</td>
|
1366
|
+
<td style="padding:15px">Delete a specified profile in the network</td>
|
1367
|
+
<td style="padding:15px">{base_path}/{version}/networks/{pathv1}/sm/profile/delete?{query}</td>
|
1368
|
+
<td style="padding:15px">Yes</td>
|
1369
|
+
</tr>
|
1370
|
+
<tr>
|
1371
|
+
<td style="padding:15px">createNetworkSmProfileCreate(networkId, createNetworkSmProfileCreate, callback)</td>
|
1372
|
+
<td style="padding:15px">Create a profile in the given network</td>
|
1373
|
+
<td style="padding:15px">{base_path}/{version}/networks/{pathv1}/sm/profile/create?{query}</td>
|
1374
|
+
<td style="padding:15px">Yes</td>
|
1375
|
+
</tr>
|
1376
|
+
<tr>
|
1377
|
+
<td style="padding:15px">getNetworkSmCellularUsageHistory(networkId, id, callback)</td>
|
1378
|
+
<td style="padding:15px">Return the client's daily cellular data usage history. Usage data is in kilobytes.</td>
|
1379
|
+
<td style="padding:15px">[object Object]</td>
|
1380
|
+
<td style="padding:15px">Yes</td>
|
1381
|
+
</tr>
|
1382
|
+
<tr>
|
1383
|
+
<td style="padding:15px">getNetworkSmPerformanceHistory(networkId, id, perPage, startingAfter, endingBefore, callback)</td>
|
1384
|
+
<td style="padding:15px">Return historical records of various Systems Manager client metrics for desktop devices.</td>
|
1385
|
+
<td style="padding:15px">[object Object]</td>
|
1386
|
+
<td style="padding:15px">Yes</td>
|
1387
|
+
</tr>
|
1388
|
+
<tr>
|
1389
|
+
<td style="padding:15px">getNetworkSmDesktopLogs(networkId, id, perPage, startingAfter, endingBefore, callback)</td>
|
1390
|
+
<td style="padding:15px">Return historical records of various Systems Manager network connection details for desktop devices.</td>
|
1391
|
+
<td style="padding:15px">{base_path}/{version}/networks/{pathv1}/sm/{pathv2}/desktopLogs?{query}</td>
|
1392
|
+
<td style="padding:15px">Yes</td>
|
1393
|
+
</tr>
|
1394
|
+
<tr>
|
1395
|
+
<td style="padding:15px">getNetworkSmDeviceCommandLogs(networkId, id, perPage, startingAfter, endingBefore, callback)</td>
|
1396
|
+
<td style="padding:15px">Return historical records of commands sent to Systems Manager devices.
|
1397
|
+
Note that this will include the name of the Dashboard user who initiated the command if it was generated
|
1398
|
+
by a Dashboard admin rather than the automatic behavior of the system; you may wish to filter this out
|
1399
|
+
of any reports.</td>
|
1400
|
+
<td style="padding:15px">[object Object]</td>
|
1401
|
+
<td style="padding:15px">Yes</td>
|
1402
|
+
</tr>
|
1403
|
+
<tr>
|
1404
|
+
<td style="padding:15px">getNetworkSmConnectivity(networkId, id, perPage, startingAfter, endingBefore, callback)</td>
|
1405
|
+
<td style="padding:15px">Returns historical connectivity data (whether a device is regularly checking in to Dashboard).</td>
|
1406
|
+
<td style="padding:15px">[object Object]</td>
|
1407
|
+
<td style="padding:15px">Yes</td>
|
1408
|
+
</tr>
|
1409
|
+
<tr>
|
1410
|
+
<td style="padding:15px">getNetworkSplashLoginAttempts(id, ssidNumber, loginIdentifier, timespan, callback)</td>
|
1411
|
+
<td style="padding:15px">List the splash login attempts for a network</td>
|
1412
|
+
<td style="padding:15px">{base_path}/{version}/networks/{pathv1}/splashLoginAttempts?{query}</td>
|
1413
|
+
<td style="padding:15px">Yes</td>
|
1414
|
+
</tr>
|
1415
|
+
<tr>
|
1416
|
+
<td style="padding:15px">getNetworkSsidSplashSettings(networkId, number, callback)</td>
|
1417
|
+
<td style="padding:15px">Display the splash page settings for the given SSID</td>
|
1418
|
+
<td style="padding:15px">[object Object]</td>
|
1419
|
+
<td style="padding:15px">Yes</td>
|
1420
|
+
</tr>
|
1421
|
+
<tr>
|
1422
|
+
<td style="padding:15px">updateNetworkSsidSplashSettings(networkId, number, updateNetworkSsidSplashSettings, callback)</td>
|
1423
|
+
<td style="padding:15px">Modify the splash page settings for the given SSID</td>
|
1424
|
+
<td style="padding:15px">[object Object]</td>
|
1425
|
+
<td style="padding:15px">Yes</td>
|
1426
|
+
</tr>
|
1427
|
+
<tr>
|
1428
|
+
<td style="padding:15px">getNetworkSsids(networkId, callback)</td>
|
1429
|
+
<td style="padding:15px">List the SSIDs in a network. Supports networks with access points or wireless-enabled security appliances and teleworker gateways.</td>
|
1430
|
+
<td style="padding:15px">[object Object]</td>
|
1431
|
+
<td style="padding:15px">Yes</td>
|
1432
|
+
</tr>
|
1433
|
+
<tr>
|
1434
|
+
<td style="padding:15px">getNetworkSsid(networkId, number, callback)</td>
|
1435
|
+
<td style="padding:15px">Return a single SSID</td>
|
1436
|
+
<td style="padding:15px">[object Object]</td>
|
1437
|
+
<td style="padding:15px">Yes</td>
|
1438
|
+
</tr>
|
1439
|
+
<tr>
|
1440
|
+
<td style="padding:15px">updateNetworkSsid(networkId, number, updateNetworkSsid, callback)</td>
|
1441
|
+
<td style="padding:15px">Update the attributes of an SSID</td>
|
1442
|
+
<td style="padding:15px">[object Object]</td>
|
1443
|
+
<td style="padding:15px">Yes</td>
|
1444
|
+
</tr>
|
1445
|
+
<tr>
|
1446
|
+
<td style="padding:15px">getNetworkSwitchSettings(networkId, callback)</td>
|
1447
|
+
<td style="padding:15px">Returns the switch network settings</td>
|
1448
|
+
<td style="padding:15px">{base_path}/{version}/networks/{pathv1}/switch/settings?{query}</td>
|
1449
|
+
<td style="padding:15px">Yes</td>
|
1450
|
+
</tr>
|
1451
|
+
<tr>
|
1452
|
+
<td style="padding:15px">updateNetworkSwitchSettings(networkId, updateNetworkSwitchSettings, callback)</td>
|
1453
|
+
<td style="padding:15px">Update switch network settings</td>
|
1454
|
+
<td style="padding:15px">{base_path}/{version}/networks/{pathv1}/switch/settings?{query}</td>
|
1455
|
+
<td style="padding:15px">Yes</td>
|
1456
|
+
</tr>
|
1457
|
+
<tr>
|
1458
|
+
<td style="padding:15px">getDeviceSwitchPorts(serial, callback)</td>
|
1459
|
+
<td style="padding:15px">List the switch ports for a switch</td>
|
1460
|
+
<td style="padding:15px">[object Object]</td>
|
1461
|
+
<td style="padding:15px">Yes</td>
|
1462
|
+
</tr>
|
1463
|
+
<tr>
|
1464
|
+
<td style="padding:15px">getDeviceSwitchPort(serial, number, callback)</td>
|
1465
|
+
<td style="padding:15px">Return a switch port</td>
|
1466
|
+
<td style="padding:15px">[object Object]</td>
|
1467
|
+
<td style="padding:15px">Yes</td>
|
1468
|
+
</tr>
|
1469
|
+
<tr>
|
1470
|
+
<td style="padding:15px">updateDeviceSwitchPort(serial, number, updateDeviceSwitchPort, callback)</td>
|
1471
|
+
<td style="padding:15px">Update a switch port</td>
|
1472
|
+
<td style="padding:15px">[object Object]</td>
|
1473
|
+
<td style="padding:15px">Yes</td>
|
1474
|
+
</tr>
|
1475
|
+
<tr>
|
1476
|
+
<td style="padding:15px">getOrganizationConfigTemplateSwitchProfiles(organizationId, configTemplateId, callback)</td>
|
1477
|
+
<td style="padding:15px">List the switch profiles for your switch template configuration</td>
|
1478
|
+
<td style="padding:15px">{base_path}/{version}/organizations/{pathv1}/configTemplates/{pathv2}/switchProfiles?{query}</td>
|
1479
|
+
<td style="padding:15px">Yes</td>
|
1480
|
+
</tr>
|
1481
|
+
<tr>
|
1482
|
+
<td style="padding:15px">getNetworkSwitchStacks(networkId, callback)</td>
|
1483
|
+
<td style="padding:15px">List the switch stacks in a network</td>
|
1484
|
+
<td style="padding:15px">[object Object]</td>
|
1485
|
+
<td style="padding:15px">Yes</td>
|
1486
|
+
</tr>
|
1487
|
+
<tr>
|
1488
|
+
<td style="padding:15px">createNetworkSwitchStack(networkId, createNetworkSwitchStack, callback)</td>
|
1489
|
+
<td style="padding:15px">Create a stack</td>
|
1490
|
+
<td style="padding:15px">[object Object]</td>
|
1491
|
+
<td style="padding:15px">Yes</td>
|
1492
|
+
</tr>
|
1493
|
+
<tr>
|
1494
|
+
<td style="padding:15px">getNetworkSwitchStack(networkId, switchStackId, callback)</td>
|
1495
|
+
<td style="padding:15px">Show a switch stack</td>
|
1496
|
+
<td style="padding:15px">[object Object]</td>
|
1497
|
+
<td style="padding:15px">Yes</td>
|
1498
|
+
</tr>
|
1499
|
+
<tr>
|
1500
|
+
<td style="padding:15px">deleteNetworkSwitchStack(networkId, switchStackId, callback)</td>
|
1501
|
+
<td style="padding:15px">Delete a stack</td>
|
1502
|
+
<td style="padding:15px">[object Object]</td>
|
1503
|
+
<td style="padding:15px">Yes</td>
|
1504
|
+
</tr>
|
1505
|
+
<tr>
|
1506
|
+
<td style="padding:15px">addNetworkSwitchStack(networkId, switchStackId, addNetworkSwitchStack, callback)</td>
|
1507
|
+
<td style="padding:15px">Add a switch to a stack</td>
|
1508
|
+
<td style="padding:15px">[object Object]</td>
|
1509
|
+
<td style="padding:15px">Yes</td>
|
1510
|
+
</tr>
|
1511
|
+
<tr>
|
1512
|
+
<td style="padding:15px">removeNetworkSwitchStack(networkID, switchStackId, removeNetworkSwitchStack, callback)</td>
|
1513
|
+
<td style="padding:15px">Remove a switch from a stack</td>
|
1514
|
+
<td style="padding:15px">[object Object]</td>
|
1515
|
+
<td style="padding:15px">Yes</td>
|
1516
|
+
</tr>
|
1517
|
+
<tr>
|
1518
|
+
<td style="padding:15px">getNetworkSyslogServers(networkId, callback)</td>
|
1519
|
+
<td style="padding:15px">List the syslog servers for a network</td>
|
1520
|
+
<td style="padding:15px">{base_path}/{version}/networks/{pathv1}/syslogServers?{query}</td>
|
1521
|
+
<td style="padding:15px">Yes</td>
|
1522
|
+
</tr>
|
1523
|
+
<tr>
|
1524
|
+
<td style="padding:15px">updateNetworkSyslogServers(networkId, updateNetworkSyslogServers, callback)</td>
|
1525
|
+
<td style="padding:15px">Update the syslog servers for a network</td>
|
1526
|
+
<td style="padding:15px">{base_path}/{version}/networks/{pathv1}/syslogServers?{query}</td>
|
1527
|
+
<td style="padding:15px">Yes</td>
|
1528
|
+
</tr>
|
1529
|
+
<tr>
|
1530
|
+
<td style="padding:15px">updateNetworkTrafficShaping(networkId, updateNetworkTrafficShaping, callback)</td>
|
1531
|
+
<td style="padding:15px">Update the traffic shaping settings for an MX network</td>
|
1532
|
+
<td style="padding:15px">[object Object]</td>
|
1533
|
+
<td style="padding:15px">Yes</td>
|
1534
|
+
</tr>
|
1535
|
+
<tr>
|
1536
|
+
<td style="padding:15px">getNetworkTrafficShaping(networkId, callback)</td>
|
1537
|
+
<td style="padding:15px">Display the traffic shaping settings for an MX network</td>
|
1538
|
+
<td style="padding:15px">[object Object]</td>
|
1539
|
+
<td style="padding:15px">Yes</td>
|
1540
|
+
</tr>
|
1541
|
+
<tr>
|
1542
|
+
<td style="padding:15px">updateNetworkSsidTrafficShaping(networkId, number, updateNetworkSsidTrafficShaping, callback)</td>
|
1543
|
+
<td style="padding:15px">Update the traffic shaping settings for an SSID on an MR network</td>
|
1544
|
+
<td style="padding:15px">[object Object]</td>
|
1545
|
+
<td style="padding:15px">Yes</td>
|
1546
|
+
</tr>
|
1547
|
+
<tr>
|
1548
|
+
<td style="padding:15px">getNetworkSsidTrafficShaping(networkId, number, callback)</td>
|
1549
|
+
<td style="padding:15px">Display the traffic shaping settings for a SSID on an MR network</td>
|
1550
|
+
<td style="padding:15px">[object Object]</td>
|
1551
|
+
<td style="padding:15px">Yes</td>
|
1552
|
+
</tr>
|
1553
|
+
<tr>
|
1554
|
+
<td style="padding:15px">getNetworkTrafficShapingDscpTaggingOptions(networkId, callback)</td>
|
1555
|
+
<td style="padding:15px">Returns the available DSCP tagging options for your traffic shaping rules.</td>
|
1556
|
+
<td style="padding:15px">{base_path}/{version}/networks/{pathv1}/trafficShaping/dscpTaggingOptions?{query}</td>
|
1557
|
+
<td style="padding:15px">Yes</td>
|
1558
|
+
</tr>
|
1559
|
+
<tr>
|
1560
|
+
<td style="padding:15px">getNetworkTrafficShapingApplicationCategories(networkId, callback)</td>
|
1561
|
+
<td style="padding:15px">Returns the application categories for traffic shaping rules.</td>
|
1562
|
+
<td style="padding:15px">{base_path}/{version}/networks/{pathv1}/trafficShaping/applicationCategories?{query}</td>
|
1563
|
+
<td style="padding:15px">Yes</td>
|
1564
|
+
</tr>
|
1565
|
+
<tr>
|
1566
|
+
<td style="padding:15px">getNetworkContentFilteringCategories(networkId, callback)</td>
|
1567
|
+
<td style="padding:15px">List all available content filtering categories for an MX network</td>
|
1568
|
+
<td style="padding:15px">[object Object]</td>
|
1569
|
+
<td style="padding:15px">Yes</td>
|
1570
|
+
</tr>
|
1571
|
+
<tr>
|
1572
|
+
<td style="padding:15px">getNetworkContentFiltering(networkId, callback)</td>
|
1573
|
+
<td style="padding:15px">Return the content filtering settings for an MX network</td>
|
1574
|
+
<td style="padding:15px">[object Object]</td>
|
1575
|
+
<td style="padding:15px">Yes</td>
|
1576
|
+
</tr>
|
1577
|
+
<tr>
|
1578
|
+
<td style="padding:15px">updateNetworkContentFiltering(networkId, updateNetworkContentFiltering, callback)</td>
|
1579
|
+
<td style="padding:15px">Update the content filtering settings for an MX network</td>
|
1580
|
+
<td style="padding:15px">[object Object]</td>
|
1581
|
+
<td style="padding:15px">Yes</td>
|
1582
|
+
</tr>
|
1583
|
+
<tr>
|
1584
|
+
<td style="padding:15px">getNetworkFirewalledServices(networkId, callback)</td>
|
1585
|
+
<td style="padding:15px">List the appliance services and their accessibility rules</td>
|
1586
|
+
<td style="padding:15px">[object Object]</td>
|
1587
|
+
<td style="padding:15px">Yes</td>
|
1588
|
+
</tr>
|
1589
|
+
<tr>
|
1590
|
+
<td style="padding:15px">getNetworkFirewalledService(networkId, service, callback)</td>
|
1591
|
+
<td style="padding:15px">Return the accessibility settings of the given service ('ICMP', 'web', or 'SNMP')</td>
|
1592
|
+
<td style="padding:15px">[object Object]</td>
|
1593
|
+
<td style="padding:15px">Yes</td>
|
1594
|
+
</tr>
|
1595
|
+
<tr>
|
1596
|
+
<td style="padding:15px">updateNetworkFirewalledService(networkId, service, updateNetworkFirewalledService, callback)</td>
|
1597
|
+
<td style="padding:15px">Updates the accessibility settings for the given service ('ICMP', 'web', or 'SNMP')</td>
|
1598
|
+
<td style="padding:15px">[object Object]</td>
|
1599
|
+
<td style="padding:15px">Yes</td>
|
1600
|
+
</tr>
|
1601
|
+
<tr>
|
1602
|
+
<td style="padding:15px">getNetworkOneToManyNatRules(networkId, callback)</td>
|
1603
|
+
<td style="padding:15px">Return the 1:Many NAT mapping rules for an MX network</td>
|
1604
|
+
<td style="padding:15px">[object Object]</td>
|
1605
|
+
<td style="padding:15px">Yes</td>
|
1606
|
+
</tr>
|
1607
|
+
<tr>
|
1608
|
+
<td style="padding:15px">updateNetworkOneToManyNatRules(networkId, updateNetworkOneToManyNatRules, callback)</td>
|
1609
|
+
<td style="padding:15px">Set the 1:Many NAT mapping rules for an MX network</td>
|
1610
|
+
<td style="padding:15px">[object Object]</td>
|
1611
|
+
<td style="padding:15px">Yes</td>
|
1612
|
+
</tr>
|
1613
|
+
<tr>
|
1614
|
+
<td style="padding:15px">getNetworkOneToOneNatRules(networkId, callback)</td>
|
1615
|
+
<td style="padding:15px">Return the 1:1 NAT mapping rules for an MX network</td>
|
1616
|
+
<td style="padding:15px">[object Object]</td>
|
1617
|
+
<td style="padding:15px">Yes</td>
|
1618
|
+
</tr>
|
1619
|
+
<tr>
|
1620
|
+
<td style="padding:15px">updateNetworkOneToOneNatRules(networkId, updateNetworkOneToOneNatRules, callback)</td>
|
1621
|
+
<td style="padding:15px">Set the 1:1 NAT mapping rules for an MX network</td>
|
1622
|
+
<td style="padding:15px">[object Object]</td>
|
1623
|
+
<td style="padding:15px">Yes</td>
|
1624
|
+
</tr>
|
1625
|
+
<tr>
|
1626
|
+
<td style="padding:15px">getNetworkPortForwardingRules(networkId, callback)</td>
|
1627
|
+
<td style="padding:15px">Return the port forwarding rules for an MX network</td>
|
1628
|
+
<td style="padding:15px">[object Object]</td>
|
1629
|
+
<td style="padding:15px">Yes</td>
|
1630
|
+
</tr>
|
1631
|
+
<tr>
|
1632
|
+
<td style="padding:15px">updateNetworkPortForwardingRules(networkId, updateNetworkPortForwardingRules, callback)</td>
|
1633
|
+
<td style="padding:15px">Update the port forwarding rules for an MX network</td>
|
1634
|
+
<td style="padding:15px">[object Object]</td>
|
1635
|
+
<td style="padding:15px">Yes</td>
|
1636
|
+
</tr>
|
1637
|
+
<tr>
|
1638
|
+
<td style="padding:15px">getNetworkStaticRoutes(networkId, callback)</td>
|
1639
|
+
<td style="padding:15px">List the static routes for this network</td>
|
1640
|
+
<td style="padding:15px">[object Object]</td>
|
1641
|
+
<td style="padding:15px">Yes</td>
|
1642
|
+
</tr>
|
1643
|
+
<tr>
|
1644
|
+
<td style="padding:15px">createNetworkStaticRoute(networkId, createNetworkStaticRoute, callback)</td>
|
1645
|
+
<td style="padding:15px">Add a static route</td>
|
1646
|
+
<td style="padding:15px">[object Object]</td>
|
1647
|
+
<td style="padding:15px">Yes</td>
|
1648
|
+
</tr>
|
1649
|
+
<tr>
|
1650
|
+
<td style="padding:15px">getNetworkStaticRoute(networkId, srId, callback)</td>
|
1651
|
+
<td style="padding:15px">Return a static route</td>
|
1652
|
+
<td style="padding:15px">[object Object]</td>
|
1653
|
+
<td style="padding:15px">Yes</td>
|
1654
|
+
</tr>
|
1655
|
+
<tr>
|
1656
|
+
<td style="padding:15px">updateNetworkStaticRoute(networkId, srId, updateNetworkStaticRoute, callback)</td>
|
1657
|
+
<td style="padding:15px">Update a static route</td>
|
1658
|
+
<td style="padding:15px">[object Object]</td>
|
1659
|
+
<td style="padding:15px">Yes</td>
|
1660
|
+
</tr>
|
1661
|
+
<tr>
|
1662
|
+
<td style="padding:15px">deleteNetworkStaticRoute(networkId, srId, callback)</td>
|
1663
|
+
<td style="padding:15px">Delete a static route from a network</td>
|
1664
|
+
<td style="padding:15px">[object Object]</td>
|
1665
|
+
<td style="padding:15px">Yes</td>
|
1666
|
+
</tr>
|
1667
|
+
<tr>
|
1668
|
+
<td style="padding:15px">getNetworkUplinkSettings(networkId, callback)</td>
|
1669
|
+
<td style="padding:15px">Returns the uplink settings for your MX network.</td>
|
1670
|
+
<td style="padding:15px">{base_path}/{version}/networks/{pathv1}/uplinkSettings?{query}</td>
|
1671
|
+
<td style="padding:15px">Yes</td>
|
1672
|
+
</tr>
|
1673
|
+
<tr>
|
1674
|
+
<td style="padding:15px">updateNetworkUplinkSettings(networkId, updateNetworkUplinkSettings, callback)</td>
|
1675
|
+
<td style="padding:15px">Updates the uplink settings for your MX network.</td>
|
1676
|
+
<td style="padding:15px">{base_path}/{version}/networks/{pathv1}/uplinkSettings?{query}</td>
|
1677
|
+
<td style="padding:15px">Yes</td>
|
1678
|
+
</tr>
|
1679
|
+
<tr>
|
1680
|
+
<td style="padding:15px">getNetworkVlans(networkId, callback)</td>
|
1681
|
+
<td style="padding:15px">List the VLANs for an MX network</td>
|
1682
|
+
<td style="padding:15px">[object Object]</td>
|
1683
|
+
<td style="padding:15px">Yes</td>
|
1684
|
+
</tr>
|
1685
|
+
<tr>
|
1686
|
+
<td style="padding:15px">createNetworkVlan(networkId, createNetworkVlan, callback)</td>
|
1687
|
+
<td style="padding:15px">Add a VLAN</td>
|
1688
|
+
<td style="padding:15px">[object Object]</td>
|
1689
|
+
<td style="padding:15px">Yes</td>
|
1690
|
+
</tr>
|
1691
|
+
<tr>
|
1692
|
+
<td style="padding:15px">getNetworkVlan(networkId, vlanId, callback)</td>
|
1693
|
+
<td style="padding:15px">Return a VLAN</td>
|
1694
|
+
<td style="padding:15px">[object Object]</td>
|
1695
|
+
<td style="padding:15px">Yes</td>
|
1696
|
+
</tr>
|
1697
|
+
<tr>
|
1698
|
+
<td style="padding:15px">updateNetworkVlan(networkId, vlanId, updateNetworkVlan, callback)</td>
|
1699
|
+
<td style="padding:15px">Update a VLAN</td>
|
1700
|
+
<td style="padding:15px">[object Object]</td>
|
1701
|
+
<td style="padding:15px">Yes</td>
|
1702
|
+
</tr>
|
1703
|
+
<tr>
|
1704
|
+
<td style="padding:15px">deleteNetworkVlan(networkId, vlanId, callback)</td>
|
1705
|
+
<td style="padding:15px">Delete a VLAN from a network</td>
|
1706
|
+
<td style="padding:15px">[object Object]</td>
|
1707
|
+
<td style="padding:15px">Yes</td>
|
1708
|
+
</tr>
|
1709
|
+
<tr>
|
1710
|
+
<td style="padding:15px">getNetworkVlansEnabledState(networkId, callback)</td>
|
1711
|
+
<td style="padding:15px">Returns the enabled status of VLANs for the network</td>
|
1712
|
+
<td style="padding:15px">{base_path}/{version}/networks/{pathv1}/vlansEnabledState?{query}</td>
|
1713
|
+
<td style="padding:15px">Yes</td>
|
1714
|
+
</tr>
|
1715
|
+
<tr>
|
1716
|
+
<td style="padding:15px">updateNetworkVlansEnabledState(networkId, updateNetworkVlansEnabledState, callback)</td>
|
1717
|
+
<td style="padding:15px">Enable/Disable VLANs for the given network</td>
|
1718
|
+
<td style="padding:15px">{base_path}/{version}/networks/{pathv1}/vlansEnabledState?{query}</td>
|
1719
|
+
<td style="padding:15px">Yes</td>
|
1720
|
+
</tr>
|
1721
|
+
<tr>
|
1722
|
+
<td style="padding:15px">getNetworkConnectionStats(networkId, t0, t1, timespan, ssid, vlan, apTag, callback)</td>
|
1723
|
+
<td style="padding:15px">Aggregated connectivity info for this network</td>
|
1724
|
+
<td style="padding:15px">[object Object]</td>
|
1725
|
+
<td style="padding:15px">Yes</td>
|
1726
|
+
</tr>
|
1727
|
+
<tr>
|
1728
|
+
<td style="padding:15px">getNetworkDevicesConnectionStats(networkId, t0, t1, timespan, ssid, vlan, apTag, callback)</td>
|
1729
|
+
<td style="padding:15px">Aggregated connectivity info for this network, grouped by node</td>
|
1730
|
+
<td style="padding:15px">[object Object]</td>
|
1731
|
+
<td style="padding:15px">Yes</td>
|
1732
|
+
</tr>
|
1733
|
+
<tr>
|
1734
|
+
<td style="padding:15px">getNetworkDeviceConnectionStats(networkId, serial, t0, t1, timespan, ssid, vlan, apTag, callback)</td>
|
1735
|
+
<td style="padding:15px">Aggregated connectivity info for a given AP on this network</td>
|
1736
|
+
<td style="padding:15px">{base_path}/{version}/networks/{pathv1}/devices/{pathv2}/connectionStats?{query}</td>
|
1737
|
+
<td style="padding:15px">Yes</td>
|
1738
|
+
</tr>
|
1739
|
+
<tr>
|
1740
|
+
<td style="padding:15px">getNetworkDeviceConnectionStatsV1(serial, t0, t1, timespan, ssid, vlan, apTag, callback)</td>
|
1741
|
+
<td style="padding:15px">Aggregated connectivity info for a given AP on this network</td>
|
1742
|
+
<td style="padding:15px">{base_path}/{version}/devices/{pathv1}/wireless/connectionStats?{query}</td>
|
1743
|
+
<td style="padding:15px">Yes</td>
|
1744
|
+
</tr>
|
1745
|
+
<tr>
|
1746
|
+
<td style="padding:15px">getNetworkClientsConnectionStats(networkId, t0, t1, timespan, ssid, vlan, apTag, callback)</td>
|
1747
|
+
<td style="padding:15px">Aggregated connectivity info for this network, grouped by clients</td>
|
1748
|
+
<td style="padding:15px">[object Object]</td>
|
1749
|
+
<td style="padding:15px">Yes</td>
|
1750
|
+
</tr>
|
1751
|
+
<tr>
|
1752
|
+
<td style="padding:15px">getNetworkClientConnectionStats(networkId, clientId, t0, t1, timespan, ssid, vlan, apTag, callback)</td>
|
1753
|
+
<td style="padding:15px">Aggregated connectivity info for a given client on this network. Clients are identified by their MAC.</td>
|
1754
|
+
<td style="padding:15px">[object Object]</td>
|
1755
|
+
<td style="padding:15px">Yes</td>
|
1756
|
+
</tr>
|
1757
|
+
<tr>
|
1758
|
+
<td style="padding:15px">getNetworkLatencyStats(networkId, t0, t1, timespan, ssid, vlan, apTag, fields, callback)</td>
|
1759
|
+
<td style="padding:15px">Aggregated latency info for this network</td>
|
1760
|
+
<td style="padding:15px">[object Object]</td>
|
1761
|
+
<td style="padding:15px">Yes</td>
|
1762
|
+
</tr>
|
1763
|
+
<tr>
|
1764
|
+
<td style="padding:15px">getNetworkDevicesLatencyStats(networkId, t0, t1, timespan, ssid, vlan, apTag, fields, callback)</td>
|
1765
|
+
<td style="padding:15px">Aggregated latency info for this network, grouped by node</td>
|
1766
|
+
<td style="padding:15px">[object Object]</td>
|
1767
|
+
<td style="padding:15px">Yes</td>
|
1768
|
+
</tr>
|
1769
|
+
<tr>
|
1770
|
+
<td style="padding:15px">getNetworkDeviceLatencyStats(networkId, serial, t0, t1, timespan, ssid, vlan, apTag, fields, callback)</td>
|
1771
|
+
<td style="padding:15px">Aggregated latency info for a given AP on this network</td>
|
1772
|
+
<td style="padding:15px">{base_path}/{version}/networks/{pathv1}/devices/{pathv2}/latencyStats?{query}</td>
|
1773
|
+
<td style="padding:15px">Yes</td>
|
1774
|
+
</tr>
|
1775
|
+
<tr>
|
1776
|
+
<td style="padding:15px">getNetworkDeviceLatencyStatsV1(serial, t0, t1, timespan, ssid, vlan, apTag, fields, callback)</td>
|
1777
|
+
<td style="padding:15px">Aggregated latency info for a given AP on this network</td>
|
1778
|
+
<td style="padding:15px">{base_path}/{version}/devices/{pathv1}/wireless/latencyStats?{query}</td>
|
1779
|
+
<td style="padding:15px">Yes</td>
|
1780
|
+
</tr>
|
1781
|
+
<tr>
|
1782
|
+
<td style="padding:15px">getNetworkClientsLatencyStats(networkId, t0, t1, timespan, ssid, vlan, apTag, fields, callback)</td>
|
1783
|
+
<td style="padding:15px">Aggregated latency info for this network, grouped by clients</td>
|
1784
|
+
<td style="padding:15px">[object Object]</td>
|
1785
|
+
<td style="padding:15px">Yes</td>
|
1786
|
+
</tr>
|
1787
|
+
<tr>
|
1788
|
+
<td style="padding:15px">getNetworkClientLatencyStats(networkId, clientId, t0, t1, timespan, ssid, vlan, apTag, fields, callback)</td>
|
1789
|
+
<td style="padding:15px">Aggregated latency info for a given client on this network. Clients are identified by their MAC.</td>
|
1790
|
+
<td style="padding:15px">[object Object]</td>
|
1791
|
+
<td style="padding:15px">Yes</td>
|
1792
|
+
</tr>
|
1793
|
+
<tr>
|
1794
|
+
<td style="padding:15px">getNetworkFailedConnections(networkId, t0, t1, timespan, ssid, vlan, apTag, serial, clientId, callback)</td>
|
1795
|
+
<td style="padding:15px">List of all failed client connection events on this network in a given time range</td>
|
1796
|
+
<td style="padding:15px">[object Object]</td>
|
1797
|
+
<td style="padding:15px">Yes</td>
|
1798
|
+
</tr>
|
1799
|
+
<tr>
|
1800
|
+
<td style="padding:15px">getNetworkCameraQualityRetentionProfiles(networkId, callback)</td>
|
1801
|
+
<td style="padding:15px">List the quality retention profiles for this network</td>
|
1802
|
+
<td style="padding:15px">{base_path}/{version}/networks/{pathv1}/camera/qualityRetentionProfiles?{query}</td>
|
1803
|
+
<td style="padding:15px">Yes</td>
|
1804
|
+
</tr>
|
1805
|
+
<tr>
|
1806
|
+
<td style="padding:15px">createNetworkCameraQualityRetentionProfile(body, networkId, callback)</td>
|
1807
|
+
<td style="padding:15px">Creates new quality retention profile for this network.</td>
|
1808
|
+
<td style="padding:15px">{base_path}/{version}/networks/{pathv1}/camera/qualityRetentionProfiles?{query}</td>
|
1809
|
+
<td style="padding:15px">Yes</td>
|
1810
|
+
</tr>
|
1811
|
+
<tr>
|
1812
|
+
<td style="padding:15px">getNetworkCameraQualityRetentionProfile(networkId, qualityRetentionProfileId, callback)</td>
|
1813
|
+
<td style="padding:15px">Retrieve a single quality retention profile</td>
|
1814
|
+
<td style="padding:15px">{base_path}/{version}/networks/{pathv1}/camera/qualityRetentionProfiles/{pathv2}?{query}</td>
|
1815
|
+
<td style="padding:15px">Yes</td>
|
1816
|
+
</tr>
|
1817
|
+
<tr>
|
1818
|
+
<td style="padding:15px">updateNetworkCameraQualityRetentionProfile(body, networkId, qualityRetentionProfileId, callback)</td>
|
1819
|
+
<td style="padding:15px">Update an existing quality retention profile for this network.</td>
|
1820
|
+
<td style="padding:15px">{base_path}/{version}/networks/{pathv1}/camera/qualityRetentionProfiles/{pathv2}?{query}</td>
|
1821
|
+
<td style="padding:15px">Yes</td>
|
1822
|
+
</tr>
|
1823
|
+
<tr>
|
1824
|
+
<td style="padding:15px">deleteNetworkCameraQualityRetentionProfile(networkId, qualityRetentionProfileId, callback)</td>
|
1825
|
+
<td style="padding:15px">Delete an existing quality retention profile for this network.</td>
|
1826
|
+
<td style="padding:15px">{base_path}/{version}/networks/{pathv1}/camera/qualityRetentionProfiles/{pathv2}?{query}</td>
|
1827
|
+
<td style="padding:15px">Yes</td>
|
1828
|
+
</tr>
|
1829
|
+
<tr>
|
1830
|
+
<td style="padding:15px">getNetworkCellularGatewaySettingsConnectivityMonitoringDestinations(networkId, callback)</td>
|
1831
|
+
<td style="padding:15px">Return the connectivity testing destinations for an MG network</td>
|
1832
|
+
<td style="padding:15px">[object Object]</td>
|
1833
|
+
<td style="padding:15px">Yes</td>
|
1834
|
+
</tr>
|
1835
|
+
<tr>
|
1836
|
+
<td style="padding:15px">updateNetworkCellularGatewaySettingsConnectivityMonitoringDestinations(networkId, body, callback)</td>
|
1837
|
+
<td style="padding:15px">Update the connectivity testing destinations for an MG network</td>
|
1838
|
+
<td style="padding:15px">[object Object]</td>
|
1839
|
+
<td style="padding:15px">Yes</td>
|
1840
|
+
</tr>
|
1841
|
+
<tr>
|
1842
|
+
<td style="padding:15px">getNetworkCellularGatewaySettingsDhcp(networkId, callback)</td>
|
1843
|
+
<td style="padding:15px">List common DHCP settings of MGs</td>
|
1844
|
+
<td style="padding:15px">[object Object]</td>
|
1845
|
+
<td style="padding:15px">Yes</td>
|
1846
|
+
</tr>
|
1847
|
+
<tr>
|
1848
|
+
<td style="padding:15px">updateNetworkCellularGatewaySettingsDhcp(networkId, body, callback)</td>
|
1849
|
+
<td style="padding:15px">Update common DHCP settings of MGs</td>
|
1850
|
+
<td style="padding:15px">[object Object]</td>
|
1851
|
+
<td style="padding:15px">Yes</td>
|
1852
|
+
</tr>
|
1853
|
+
<tr>
|
1854
|
+
<td style="padding:15px">getDeviceCellularGatewaySettings(serial, callback)</td>
|
1855
|
+
<td style="padding:15px">Show the LAN Settings of a MG</td>
|
1856
|
+
<td style="padding:15px">[object Object]</td>
|
1857
|
+
<td style="padding:15px">Yes</td>
|
1858
|
+
</tr>
|
1859
|
+
<tr>
|
1860
|
+
<td style="padding:15px">returnTheEAPOverriddenParametersForAnSSID(networkId, number, callback)</td>
|
1861
|
+
<td style="padding:15px">Return the EAP overridden parameters for an SSID</td>
|
1862
|
+
<td style="padding:15px">[object Object]</td>
|
1863
|
+
<td style="padding:15px">Yes</td>
|
1864
|
+
</tr>
|
1865
|
+
<tr>
|
1866
|
+
<td style="padding:15px">updateTheEAPOverriddenParametersForAnSSID(networkId, number, body, callback)</td>
|
1867
|
+
<td style="padding:15px">Update the EAP overridden parameters for an SSID.
|
1868
|
+
#### Body Parameters
|
1869
|
+
**Parameter**|**Type**|**Description**
|
1870
|
+
:-------------: |:-------------: |:-------------:
|
1871
|
+
timeout| integer| General EAP timeout in seconds.
|
1872
|
+
identity| object| EAP settings for identity requests.
|
1873
|
+
maxRetries| integer| Maximum number of general EAP retries.
|
1874
|
+
eapolKey| object| EAPOL Key settings.
|
1875
|
+
|
1876
|
+
#### Supports Action Batches
|
1877
|
+
|
1878
|
+
**Resource**|**Operation**
|
1879
|
+
:-------------: |:-------------:
|
1880
|
+
`/networks/{networkId}/wireless/ssids/{num...(description truncated)</td>
|
1881
|
+
<td style="padding:15px">[object Object]</td>
|
1882
|
+
<td style="padding:15px">Yes</td>
|
1883
|
+
</tr>
|
1884
|
+
<tr>
|
1885
|
+
<td style="padding:15px">updateDeviceCellularGatewaySettings(serial, body, callback)</td>
|
1886
|
+
<td style="padding:15px">Update the LAN Settings for a single MG.</td>
|
1887
|
+
<td style="padding:15px">[object Object]</td>
|
1888
|
+
<td style="padding:15px">Yes</td>
|
1889
|
+
</tr>
|
1890
|
+
<tr>
|
1891
|
+
<td style="padding:15px">getDeviceCellularGatewaySettingsPortForwardingRules(serial, callback)</td>
|
1892
|
+
<td style="padding:15px">Returns the port forwarding rules for a single MG.</td>
|
1893
|
+
<td style="padding:15px">[object Object]</td>
|
1894
|
+
<td style="padding:15px">Yes</td>
|
1895
|
+
</tr>
|
1896
|
+
<tr>
|
1897
|
+
<td style="padding:15px">updateDeviceCellularGatewaySettingsPortForwardingRules(serial, body, callback)</td>
|
1898
|
+
<td style="padding:15px">Updates the port forwarding rules for a single MG.</td>
|
1899
|
+
<td style="padding:15px">[object Object]</td>
|
1900
|
+
<td style="padding:15px">Yes</td>
|
1901
|
+
</tr>
|
1902
|
+
<tr>
|
1903
|
+
<td style="padding:15px">getNetworkCellularGatewaySettingsSubnetPool(networkId, callback)</td>
|
1904
|
+
<td style="padding:15px">Return the subnet pool and mask configured for MGs in the network.</td>
|
1905
|
+
<td style="padding:15px">[object Object]</td>
|
1906
|
+
<td style="padding:15px">Yes</td>
|
1907
|
+
</tr>
|
1908
|
+
<tr>
|
1909
|
+
<td style="padding:15px">updateNetworkCellularGatewaySettingsSubnetPool(networkId, body, callback)</td>
|
1910
|
+
<td style="padding:15px">Update the subnet pool and mask configuration for MGs in the network.</td>
|
1911
|
+
<td style="padding:15px">[object Object]</td>
|
1912
|
+
<td style="padding:15px">Yes</td>
|
1913
|
+
</tr>
|
1914
|
+
<tr>
|
1915
|
+
<td style="padding:15px">getNetworkCellularGatewaySettingsUplink(networkId, callback)</td>
|
1916
|
+
<td style="padding:15px">Returns the uplink settings for your MG network.</td>
|
1917
|
+
<td style="padding:15px">[object Object]</td>
|
1918
|
+
<td style="padding:15px">Yes</td>
|
1919
|
+
</tr>
|
1920
|
+
<tr>
|
1921
|
+
<td style="padding:15px">updateNetworkCellularGatewaySettingsUplink(networkId, body, callback)</td>
|
1922
|
+
<td style="padding:15px">Updates the uplink settings for your MG network.</td>
|
1923
|
+
<td style="padding:15px">[object Object]</td>
|
1924
|
+
<td style="padding:15px">Yes</td>
|
1925
|
+
</tr>
|
1926
|
+
<tr>
|
1927
|
+
<td style="padding:15px">getNetworkSwitchAccessControlLists(networkId, callback)</td>
|
1928
|
+
<td style="padding:15px">Return the access control lists for a MS network</td>
|
1929
|
+
<td style="padding:15px">{base_path}/{version}/networks/{pathv1}/switch/accessControlLists?{query}</td>
|
1930
|
+
<td style="padding:15px">Yes</td>
|
1931
|
+
</tr>
|
1932
|
+
<tr>
|
1933
|
+
<td style="padding:15px">updateNetworkSwitchAccessControlLists(body, networkId, callback)</td>
|
1934
|
+
<td style="padding:15px">Update the access control lists for a MS network</td>
|
1935
|
+
<td style="padding:15px">{base_path}/{version}/networks/{pathv1}/switch/accessControlLists?{query}</td>
|
1936
|
+
<td style="padding:15px">Yes</td>
|
1937
|
+
</tr>
|
1938
|
+
<tr>
|
1939
|
+
<td style="padding:15px">listTheAccessPoliciesForASwitchNetwork(networkId, callback)</td>
|
1940
|
+
<td style="padding:15px">List the access policies for a switch network. Only returns access policies with 'my RADIUS server' as authentication method</td>
|
1941
|
+
<td style="padding:15px">[object Object]</td>
|
1942
|
+
<td style="padding:15px">Yes</td>
|
1943
|
+
</tr>
|
1944
|
+
<tr>
|
1945
|
+
<td style="padding:15px">createAnAccessPolicyForASwitchNetwork(networkId, body, callback)</td>
|
1946
|
+
<td style="padding:15px">Create an access policy for a switch network. If you would like to enable Meraki Authentication, set radiusServers to empty array.</td>
|
1947
|
+
<td style="padding:15px">{base_path}/{version}/networks/{pathv1}/switch/accessPolicies?{query}</td>
|
1948
|
+
<td style="padding:15px">Yes</td>
|
1949
|
+
</tr>
|
1950
|
+
<tr>
|
1951
|
+
<td style="padding:15px">returnASpecificAccessPolicyForASwitchNetwork(networkId, accessPolicyNumber, callback)</td>
|
1952
|
+
<td style="padding:15px">Return a specific access policy for a switch network</td>
|
1953
|
+
<td style="padding:15px">{base_path}/{version}/networks/{pathv1}/switch/accessPolicies/{pathv2}?{query}</td>
|
1954
|
+
<td style="padding:15px">Yes</td>
|
1955
|
+
</tr>
|
1956
|
+
<tr>
|
1957
|
+
<td style="padding:15px">updateAnAccessPolicyForASwitchNetwork(networkId, accessPolicyNumber, body, callback)</td>
|
1958
|
+
<td style="padding:15px">Update an access policy for a switch network. If you would like to enable Meraki Authentication, set radiusServers to empty array.</td>
|
1959
|
+
<td style="padding:15px">{base_path}/{version}/networks/{pathv1}/switch/accessPolicies/{pathv2}?{query}</td>
|
1960
|
+
<td style="padding:15px">Yes</td>
|
1961
|
+
</tr>
|
1962
|
+
<tr>
|
1963
|
+
<td style="padding:15px">deleteAnAccessPolicyForASwitchNetwork(networkId, accessPolicyNumber, callback)</td>
|
1964
|
+
<td style="padding:15px">Delete An Access Policy For A Switch Network</td>
|
1965
|
+
<td style="padding:15px">{base_path}/{version}/networks/{pathv1}/switch/accessPolicies/{pathv2}?{query}</td>
|
1966
|
+
<td style="padding:15px">Yes</td>
|
1967
|
+
</tr>
|
1968
|
+
<tr>
|
1969
|
+
<td style="padding:15px">returnTheStatusForAllThePortsOfASwitch(serial, callback)</td>
|
1970
|
+
<td style="padding:15px">Return the status for all the ports of a switch</td>
|
1971
|
+
<td style="padding:15px">[object Object]</td>
|
1972
|
+
<td style="padding:15px">Yes</td>
|
1973
|
+
</tr>
|
1974
|
+
<tr>
|
1975
|
+
<td style="padding:15px">returnThePacketCountersForAllThePortsOfASwitch(serial, callback)</td>
|
1976
|
+
<td style="padding:15px">Return the packet counters for all the ports of a switch</td>
|
1977
|
+
<td style="padding:15px">[object Object]</td>
|
1978
|
+
<td style="padding:15px">Yes</td>
|
1979
|
+
</tr>
|
1980
|
+
<tr>
|
1981
|
+
<td style="padding:15px">returnsTheUplinkBandwidthSettingsForYourMXNetwork(networkId, callback)</td>
|
1982
|
+
<td style="padding:15px">Returns the uplink bandwidth settings for your MX network.</td>
|
1983
|
+
<td style="padding:15px">{base_path}/{version}/networks/{pathv1}/appliance/trafficShaping/uplinkBandwidth?{query}</td>
|
1984
|
+
<td style="padding:15px">Yes</td>
|
1985
|
+
</tr>
|
1986
|
+
<tr>
|
1987
|
+
<td style="padding:15px">updatesTheUplinkBandwidthSettingsForYourMXNetwork(networkId, body, callback)</td>
|
1988
|
+
<td style="padding:15px">Updates the uplink bandwidth settings for your MX network.
|
1989
|
+
#### Body Parameters
|
1990
|
+
**Parameter**|**Type**|**Description**
|
1991
|
+
:-------------: |:-------------: |:-------------:
|
1992
|
+
bandwidthLimits| object| A mapping of uplinks to their bandwidth settings (be sure to check which uplinks are supported for your network)
|
1993
|
+
|
1994
|
+
#### Supports Action Batches
|
1995
|
+
|
1996
|
+
**Resource**|**Operation**
|
1997
|
+
:-------------: |:-------------:
|
1998
|
+
`/networks/{networkId}/appliance/trafficShaping/uplinkBandwidth` | update</td>
|
1999
|
+
<td style="padding:15px">{base_path}/{version}/networks/{pathv1}/appliance/trafficShaping/uplinkBandwidth?{query}</td>
|
2000
|
+
<td style="padding:15px">Yes</td>
|
2001
|
+
</tr>
|
2002
|
+
<tr>
|
2003
|
+
<td style="padding:15px">refreshTheDetailsOfADevice(networkId, deviceId, callback)</td>
|
2004
|
+
<td style="padding:15px">Refresh the details of a device</td>
|
2005
|
+
<td style="padding:15px">[object Object]</td>
|
2006
|
+
<td style="padding:15px">Yes</td>
|
2007
|
+
</tr>
|
2008
|
+
<tr>
|
2009
|
+
<td style="padding:15px">getNetworkSwitchPortSchedules(networkId, callback)</td>
|
2010
|
+
<td style="padding:15px">List switch port schedules</td>
|
2011
|
+
<td style="padding:15px">{base_path}/{version}/networks/{pathv1}/switch/portSchedules?{query}</td>
|
2012
|
+
<td style="padding:15px">Yes</td>
|
2013
|
+
</tr>
|
2014
|
+
<tr>
|
2015
|
+
<td style="padding:15px">createNetworkSwitchPortSchedule(networkId, body, callback)</td>
|
2016
|
+
<td style="padding:15px">Add a switch port schedule</td>
|
2017
|
+
<td style="padding:15px">{base_path}/{version}/networks/{pathv1}/switch/portSchedules?{query}</td>
|
2018
|
+
<td style="padding:15px">Yes</td>
|
2019
|
+
</tr>
|
2020
|
+
<tr>
|
2021
|
+
<td style="padding:15px">updateNetworkSwitchPortSchedule(networkId, portScheduleId, body, callback)</td>
|
2022
|
+
<td style="padding:15px">Update the access control lists for a MS network</td>
|
2023
|
+
<td style="padding:15px">{base_path}/{version}/networks/{pathv1}/switch/portSchedules/{pathv2}?{query}</td>
|
2024
|
+
<td style="padding:15px">Yes</td>
|
2025
|
+
</tr>
|
2026
|
+
<tr>
|
2027
|
+
<td style="padding:15px">deleteNetworkSwitchPortSchedule(networkId, portScheduleId, callback)</td>
|
2028
|
+
<td style="padding:15px">Delete a switch port schedule</td>
|
2029
|
+
<td style="padding:15px">{base_path}/{version}/networks/{pathv1}/switch/portSchedules/{pathv2}?{query}</td>
|
2030
|
+
<td style="padding:15px">Yes</td>
|
2031
|
+
</tr>
|
2032
|
+
<tr>
|
2033
|
+
<td style="padding:15px">getNetworkAppliancePorts(networkId, callback)</td>
|
2034
|
+
<td style="padding:15px">List per-port VLAN settings for all ports of a MX.</td>
|
2035
|
+
<td style="padding:15px">[object Object]</td>
|
2036
|
+
<td style="padding:15px">Yes</td>
|
2037
|
+
</tr>
|
2038
|
+
<tr>
|
2039
|
+
<td style="padding:15px">getNetworkAppliancePort(networkId, appliancePortId, callback)</td>
|
2040
|
+
<td style="padding:15px">Return per-port VLAN settings for a single MX port.</td>
|
2041
|
+
<td style="padding:15px">[object Object]</td>
|
2042
|
+
<td style="padding:15px">Yes</td>
|
2043
|
+
</tr>
|
2044
|
+
<tr>
|
2045
|
+
<td style="padding:15px">updateNetworkAppliancePort(body, networkId, appliancePortId, callback)</td>
|
2046
|
+
<td style="padding:15px">Update the per-port VLAN settings for a single MX port.</td>
|
2047
|
+
<td style="padding:15px">[object Object]</td>
|
2048
|
+
<td style="padding:15px">Yes</td>
|
2049
|
+
</tr>
|
2050
|
+
<tr>
|
2051
|
+
<td style="padding:15px">swapNetworkWarmspare(networkId, body, callback)</td>
|
2052
|
+
<td style="padding:15px">Swap MX primary and warm spare appliances</td>
|
2053
|
+
<td style="padding:15px">[object Object]</td>
|
2054
|
+
<td style="padding:15px">Yes</td>
|
2055
|
+
</tr>
|
2056
|
+
<tr>
|
2057
|
+
<td style="padding:15px">getNetworkWarmSpareSettings(networkId, callback)</td>
|
2058
|
+
<td style="padding:15px">Return MX warm spare settings</td>
|
2059
|
+
<td style="padding:15px">[object Object]</td>
|
2060
|
+
<td style="padding:15px">Yes</td>
|
2061
|
+
</tr>
|
2062
|
+
<tr>
|
2063
|
+
<td style="padding:15px">updateNetworkWarmSpareSettings(networkId, body, callback)</td>
|
2064
|
+
<td style="padding:15px">Update MX warm spare settings</td>
|
2065
|
+
<td style="padding:15px">[object Object]</td>
|
2066
|
+
<td style="padding:15px">Yes</td>
|
2067
|
+
</tr>
|
2068
|
+
<tr>
|
2069
|
+
<td style="padding:15px">getOrganizationLicenses(perPage, startingAfter, endingBefore, deviceSerial, networkId, state, organizationId, callback)</td>
|
2070
|
+
<td style="padding:15px">List the licenses for an organization</td>
|
2071
|
+
<td style="padding:15px">{base_path}/{version}/organizations/{pathv1}/licenses?{query}</td>
|
2072
|
+
<td style="padding:15px">Yes</td>
|
2073
|
+
</tr>
|
2074
|
+
<tr>
|
2075
|
+
<td style="padding:15px">getOrganizationLicense(organizationId, licenseId, callback)</td>
|
2076
|
+
<td style="padding:15px">Display a license</td>
|
2077
|
+
<td style="padding:15px">{base_path}/{version}/organizations/{pathv1}/licenses/{pathv2}?{query}</td>
|
2078
|
+
<td style="padding:15px">Yes</td>
|
2079
|
+
</tr>
|
2080
|
+
<tr>
|
2081
|
+
<td style="padding:15px">updateOrganizationLicense(body, organizationId, licenseId, callback)</td>
|
2082
|
+
<td style="padding:15px">Update a license</td>
|
2083
|
+
<td style="padding:15px">{base_path}/{version}/organizations/{pathv1}/licenses/{pathv2}?{query}</td>
|
2084
|
+
<td style="padding:15px">Yes</td>
|
2085
|
+
</tr>
|
2086
|
+
<tr>
|
2087
|
+
<td style="padding:15px">assignOrganizationLicensesSeats(organizationId, body, callback)</td>
|
2088
|
+
<td style="padding:15px">Assign SM seats to a network.</td>
|
2089
|
+
<td style="padding:15px">{base_path}/{version}/organizations/{pathv1}/licenses/assignSeats?{query}</td>
|
2090
|
+
<td style="padding:15px">Yes</td>
|
2091
|
+
</tr>
|
2092
|
+
<tr>
|
2093
|
+
<td style="padding:15px">moveOrganizationLicenses(organizationId, body, callback)</td>
|
2094
|
+
<td style="padding:15px">Move licenses to another organization.</td>
|
2095
|
+
<td style="padding:15px">{base_path}/{version}/organizations/{pathv1}/licenses/move?{query}</td>
|
2096
|
+
<td style="padding:15px">Yes</td>
|
2097
|
+
</tr>
|
2098
|
+
<tr>
|
2099
|
+
<td style="padding:15px">moveOrganizationLicensesSeats(body, organizationId, callback)</td>
|
2100
|
+
<td style="padding:15px">Move SM seats to another organization</td>
|
2101
|
+
<td style="padding:15px">{base_path}/{version}/organizations/{pathv1}/licenses/moveSeats?{query}</td>
|
2102
|
+
<td style="padding:15px">Yes</td>
|
2103
|
+
</tr>
|
2104
|
+
<tr>
|
2105
|
+
<td style="padding:15px">renewOrganizationLicensesSeats(body, organizationId, callback)</td>
|
2106
|
+
<td style="padding:15px">Renew SM seats of a license.</td>
|
2107
|
+
<td style="padding:15px">{base_path}/{version}/organizations/{pathv1}/licenses/renewSeats?{query}</td>
|
2108
|
+
<td style="padding:15px">Yes</td>
|
2109
|
+
</tr>
|
2110
|
+
<tr>
|
2111
|
+
<td style="padding:15px">getNetworkSwitchSettingsDhcpServerPolicy(networkId, callback)</td>
|
2112
|
+
<td style="padding:15px">Return the DHCP server policy</td>
|
2113
|
+
<td style="padding:15px">[object Object]</td>
|
2114
|
+
<td style="padding:15px">Yes</td>
|
2115
|
+
</tr>
|
2116
|
+
<tr>
|
2117
|
+
<td style="padding:15px">updateNetworkSwitchSettingsDhcpServerPolicy(body, networkId, callback)</td>
|
2118
|
+
<td style="padding:15px">Update the DHCP server policy</td>
|
2119
|
+
<td style="padding:15px">[object Object]</td>
|
2120
|
+
<td style="padding:15px">Yes</td>
|
2121
|
+
</tr>
|
2122
|
+
<tr>
|
2123
|
+
<td style="padding:15px">getNetworkSwitchSettingsDscpToCosMappings(networkId, callback)</td>
|
2124
|
+
<td style="padding:15px">Return the DSCP to CoS mappings</td>
|
2125
|
+
<td style="padding:15px">[object Object]</td>
|
2126
|
+
<td style="padding:15px">Yes</td>
|
2127
|
+
</tr>
|
2128
|
+
<tr>
|
2129
|
+
<td style="padding:15px">updateNetworkSwitchSettingsDscpToCosMappings(body, networkId, callback)</td>
|
2130
|
+
<td style="padding:15px">Update the DSCP to CoS mappings</td>
|
2131
|
+
<td style="padding:15px">[object Object]</td>
|
2132
|
+
<td style="padding:15px">Yes</td>
|
2133
|
+
</tr>
|
2134
|
+
<tr>
|
2135
|
+
<td style="padding:15px">getNetworkSwitchSettingsMtu(networkId, callback)</td>
|
2136
|
+
<td style="padding:15px">Return the MTU configuration</td>
|
2137
|
+
<td style="padding:15px">[object Object]</td>
|
2138
|
+
<td style="padding:15px">Yes</td>
|
2139
|
+
</tr>
|
2140
|
+
<tr>
|
2141
|
+
<td style="padding:15px">updateNetworkSwitchSettingsMtu(body, networkId, callback)</td>
|
2142
|
+
<td style="padding:15px">Update the MTU configuration</td>
|
2143
|
+
<td style="padding:15px">[object Object]</td>
|
2144
|
+
<td style="padding:15px">Yes</td>
|
2145
|
+
</tr>
|
2146
|
+
<tr>
|
2147
|
+
<td style="padding:15px">getNetworkSwitchSettingsQosRules(networkId, callback)</td>
|
2148
|
+
<td style="padding:15px">List quality of service rules</td>
|
2149
|
+
<td style="padding:15px">[object Object]</td>
|
2150
|
+
<td style="padding:15px">Yes</td>
|
2151
|
+
</tr>
|
2152
|
+
<tr>
|
2153
|
+
<td style="padding:15px">createNetworkSwitchSettingsQosRule(body, networkId, callback)</td>
|
2154
|
+
<td style="padding:15px">Add a quality of service rule</td>
|
2155
|
+
<td style="padding:15px">[object Object]</td>
|
2156
|
+
<td style="padding:15px">Yes</td>
|
2157
|
+
</tr>
|
2158
|
+
<tr>
|
2159
|
+
<td style="padding:15px">getNetworkSwitchSettingsQosRulesOrder(networkId, callback)</td>
|
2160
|
+
<td style="padding:15px">Return the quality of service rule IDs by order in which they will be processed by the switch</td>
|
2161
|
+
<td style="padding:15px">[object Object]</td>
|
2162
|
+
<td style="padding:15px">Yes</td>
|
2163
|
+
</tr>
|
2164
|
+
<tr>
|
2165
|
+
<td style="padding:15px">updateNetworkSwitchSettingsQosRulesOrder(body, networkId, callback)</td>
|
2166
|
+
<td style="padding:15px">Update the order in which the rules should be processed by the switch</td>
|
2167
|
+
<td style="padding:15px">[object Object]</td>
|
2168
|
+
<td style="padding:15px">Yes</td>
|
2169
|
+
</tr>
|
2170
|
+
<tr>
|
2171
|
+
<td style="padding:15px">getNetworkSwitchSettingsQosRule(networkId, qosRuleId, callback)</td>
|
2172
|
+
<td style="padding:15px">Return a quality of service rule</td>
|
2173
|
+
<td style="padding:15px">[object Object]</td>
|
2174
|
+
<td style="padding:15px">Yes</td>
|
2175
|
+
</tr>
|
2176
|
+
<tr>
|
2177
|
+
<td style="padding:15px">deleteNetworkSwitchSettingsQosRule(networkId, qosRuleId, callback)</td>
|
2178
|
+
<td style="padding:15px">Delete a quality of service rule</td>
|
2179
|
+
<td style="padding:15px">[object Object]</td>
|
2180
|
+
<td style="padding:15px">Yes</td>
|
2181
|
+
</tr>
|
2182
|
+
<tr>
|
2183
|
+
<td style="padding:15px">updateNetworkSwitchSettingsQosRule(networkId, qosRuleId, body, callback)</td>
|
2184
|
+
<td style="padding:15px">Update a quality of service rule</td>
|
2185
|
+
<td style="padding:15px">[object Object]</td>
|
2186
|
+
<td style="padding:15px">Yes</td>
|
2187
|
+
</tr>
|
2188
|
+
<tr>
|
2189
|
+
<td style="padding:15px">getNetworkSwitchSettingsStormControl(networkId, callback)</td>
|
2190
|
+
<td style="padding:15px">Return the storm control configuration for a switch network</td>
|
2191
|
+
<td style="padding:15px">[object Object]</td>
|
2192
|
+
<td style="padding:15px">Yes</td>
|
2193
|
+
</tr>
|
2194
|
+
<tr>
|
2195
|
+
<td style="padding:15px">updateNetworkSwitchSettingsStormControl(networkId, body, callback)</td>
|
2196
|
+
<td style="padding:15px">Update the storm control configuration for a switch network</td>
|
2197
|
+
<td style="padding:15px">[object Object]</td>
|
2198
|
+
<td style="padding:15px">Yes</td>
|
2199
|
+
</tr>
|
2200
|
+
<tr>
|
2201
|
+
<td style="padding:15px">getNetworkSwitchSettingsStp(networkId, callback)</td>
|
2202
|
+
<td style="padding:15px">Returns STP settings</td>
|
2203
|
+
<td style="padding:15px">[object Object]</td>
|
2204
|
+
<td style="padding:15px">Yes</td>
|
2205
|
+
</tr>
|
2206
|
+
<tr>
|
2207
|
+
<td style="padding:15px">updateNetworkSwitchSettingsStp(body, networkId, callback)</td>
|
2208
|
+
<td style="padding:15px">Updates STP settings</td>
|
2209
|
+
<td style="padding:15px">[object Object]</td>
|
2210
|
+
<td style="padding:15px">Yes</td>
|
2211
|
+
</tr>
|
2212
|
+
<tr>
|
2213
|
+
<td style="padding:15px">getNetworkConnectivityMonitoringDestinations(networkId, callback)</td>
|
2214
|
+
<td style="padding:15px">Return the connectivity testing destinations for an MX network</td>
|
2215
|
+
<td style="padding:15px">[object Object]</td>
|
2216
|
+
<td style="padding:15px">Yes</td>
|
2217
|
+
</tr>
|
2218
|
+
<tr>
|
2219
|
+
<td style="padding:15px">updateNetworkConnectivityMonitoringDestinations(networkId, body, callback)</td>
|
2220
|
+
<td style="padding:15px">Update the connectivity testing destinations for an MX network</td>
|
2221
|
+
<td style="padding:15px">[object Object]</td>
|
2222
|
+
<td style="padding:15px">Yes</td>
|
2223
|
+
</tr>
|
2224
|
+
<tr>
|
2225
|
+
<td style="padding:15px">getOrganizationBrandingPolicies(organizationId, callback)</td>
|
2226
|
+
<td style="padding:15px">List the branding policies of an organization</td>
|
2227
|
+
<td style="padding:15px">{base_path}/{version}/organizations/{pathv1}/brandingPolicies?{query}</td>
|
2228
|
+
<td style="padding:15px">Yes</td>
|
2229
|
+
</tr>
|
2230
|
+
<tr>
|
2231
|
+
<td style="padding:15px">createOrganizationBrandingPolicy(organizationId, body, callback)</td>
|
2232
|
+
<td style="padding:15px">Add a new branding policy to an organization</td>
|
2233
|
+
<td style="padding:15px">{base_path}/{version}/organizations/{pathv1}/brandingPolicies?{query}</td>
|
2234
|
+
<td style="padding:15px">Yes</td>
|
2235
|
+
</tr>
|
2236
|
+
<tr>
|
2237
|
+
<td style="padding:15px">getOrganizationBrandingPoliciesPriorities(organizationId, callback)</td>
|
2238
|
+
<td style="padding:15px">Return the branding policy IDs of an organization in priority order.</td>
|
2239
|
+
<td style="padding:15px">{base_path}/{version}/organizations/{pathv1}/brandingPolicies/priorities?{query}</td>
|
2240
|
+
<td style="padding:15px">Yes</td>
|
2241
|
+
</tr>
|
2242
|
+
<tr>
|
2243
|
+
<td style="padding:15px">updateOrganizationBrandingPoliciesPriorities(organizationId, body, callback)</td>
|
2244
|
+
<td style="padding:15px">Update the priority ordering of an organization's branding policies.</td>
|
2245
|
+
<td style="padding:15px">{base_path}/{version}/organizations/{pathv1}/brandingPolicies/priorities?{query}</td>
|
2246
|
+
<td style="padding:15px">Yes</td>
|
2247
|
+
</tr>
|
2248
|
+
<tr>
|
2249
|
+
<td style="padding:15px">getOrganizationBrandingPolicy(organizationId, callback)</td>
|
2250
|
+
<td style="padding:15px">Return a branding policy</td>
|
2251
|
+
<td style="padding:15px">{base_path}/{version}/organizations/{pathv1}/brandingPolicies/:brandingPolicyId?{query}</td>
|
2252
|
+
<td style="padding:15px">Yes</td>
|
2253
|
+
</tr>
|
2254
|
+
<tr>
|
2255
|
+
<td style="padding:15px">updateOrganizationBrandingPolicy(organizationId, brandingPolicyId, body, callback)</td>
|
2256
|
+
<td style="padding:15px">Update a branding policy</td>
|
2257
|
+
<td style="padding:15px">{base_path}/{version}/organizations/{pathv1}/brandingPolicies/{pathv2}?{query}</td>
|
2258
|
+
<td style="padding:15px">Yes</td>
|
2259
|
+
</tr>
|
2260
|
+
<tr>
|
2261
|
+
<td style="padding:15px">deleteOrganizationBrandingPolicy(organizationId, brandingPolicyId, callback)</td>
|
2262
|
+
<td style="padding:15px">Delete a branding policy</td>
|
2263
|
+
<td style="padding:15px">{base_path}/{version}/organizations/{pathv1}/brandingPolicies/{pathv2}?{query}</td>
|
2264
|
+
<td style="padding:15px">Yes</td>
|
2265
|
+
</tr>
|
2266
|
+
<tr>
|
2267
|
+
<td style="padding:15px">getNetworkEvents(productType, includedEventTypes, excludedEventTypes, deviceMac, deviceSerial, deviceName, clientIp, clientMac, clientName, smDeviceMac, smDeviceName, perPage, startingAfter, endingBefore, networkId, callback)</td>
|
2268
|
+
<td style="padding:15px">List the events for the network</td>
|
2269
|
+
<td style="padding:15px">{base_path}/{version}/networks/{pathv1}/events?{query}</td>
|
2270
|
+
<td style="padding:15px">Yes</td>
|
2271
|
+
</tr>
|
2272
|
+
<tr>
|
2273
|
+
<td style="padding:15px">getNetworkEventsEventTypes(networkId, callback)</td>
|
2274
|
+
<td style="padding:15px">List the event type to human-readable description</td>
|
2275
|
+
<td style="padding:15px">{base_path}/{version}/networks/{pathv1}/events/eventTypes?{query}</td>
|
2276
|
+
<td style="padding:15px">Yes</td>
|
2277
|
+
</tr>
|
2278
|
+
<tr>
|
2279
|
+
<td style="padding:15px">getNetworkFloorPlans(networkId, callback)</td>
|
2280
|
+
<td style="padding:15px">List the floor plans that belong to your network</td>
|
2281
|
+
<td style="padding:15px">{base_path}/{version}/networks/{pathv1}/floorPlans?{query}</td>
|
2282
|
+
<td style="padding:15px">Yes</td>
|
2283
|
+
</tr>
|
2284
|
+
<tr>
|
2285
|
+
<td style="padding:15px">createNetworkFloorPlan(networkId, body, callback)</td>
|
2286
|
+
<td style="padding:15px">Upload a floor plan</td>
|
2287
|
+
<td style="padding:15px">{base_path}/{version}/networks/{pathv1}/floorPlans?{query}</td>
|
2288
|
+
<td style="padding:15px">Yes</td>
|
2289
|
+
</tr>
|
2290
|
+
<tr>
|
2291
|
+
<td style="padding:15px">getNetworkFloorPlan(networkId, floorPlanId, callback)</td>
|
2292
|
+
<td style="padding:15px">Find a floor plan by ID</td>
|
2293
|
+
<td style="padding:15px">{base_path}/{version}/networks/{pathv1}/floorPlans/{pathv2}?{query}</td>
|
2294
|
+
<td style="padding:15px">Yes</td>
|
2295
|
+
</tr>
|
2296
|
+
<tr>
|
2297
|
+
<td style="padding:15px">updateNetworkFloorPlan(networkId, floorPlanId, body, callback)</td>
|
2298
|
+
<td style="padding:15px">Update a floor plan's geolocation and other meta data</td>
|
2299
|
+
<td style="padding:15px">{base_path}/{version}/networks/{pathv1}/floorPlans/{pathv2}?{query}</td>
|
2300
|
+
<td style="padding:15px">Yes</td>
|
2301
|
+
</tr>
|
2302
|
+
<tr>
|
2303
|
+
<td style="padding:15px">deleteNetworkFloorPlan(networkId, floorPlanId, callback)</td>
|
2304
|
+
<td style="padding:15px">Destroy a floor plan</td>
|
2305
|
+
<td style="padding:15px">{base_path}/{version}/networks/{pathv1}/floorPlans/{pathv2}?{query}</td>
|
2306
|
+
<td style="padding:15px">Yes</td>
|
2307
|
+
</tr>
|
2308
|
+
<tr>
|
2309
|
+
<td style="padding:15px">getNetworkSwitchLinkAggregations(networkId, callback)</td>
|
2310
|
+
<td style="padding:15px">List link aggregation groups</td>
|
2311
|
+
<td style="padding:15px">{base_path}/{version}/networks/{pathv1}/switch/linkAggregations?{query}</td>
|
2312
|
+
<td style="padding:15px">Yes</td>
|
2313
|
+
</tr>
|
2314
|
+
<tr>
|
2315
|
+
<td style="padding:15px">createNetworkSwitchLinkAggregation(networkId, body, callback)</td>
|
2316
|
+
<td style="padding:15px">Create a link aggregation group</td>
|
2317
|
+
<td style="padding:15px">{base_path}/{version}/networks/{pathv1}/switch/linkAggregations?{query}</td>
|
2318
|
+
<td style="padding:15px">Yes</td>
|
2319
|
+
</tr>
|
2320
|
+
<tr>
|
2321
|
+
<td style="padding:15px">updateNetworkSwitchLinkAggregation(networkId, linkAggregationId, body, callback)</td>
|
2322
|
+
<td style="padding:15px">Update a link aggregation group</td>
|
2323
|
+
<td style="padding:15px">{base_path}/{version}/networks/{pathv1}/switch/linkAggregations/{pathv2}?{query}</td>
|
2324
|
+
<td style="padding:15px">Yes</td>
|
2325
|
+
</tr>
|
2326
|
+
<tr>
|
2327
|
+
<td style="padding:15px">deleteNetworkSwitchLinkAggregation(networkId, linkAggregationId, callback)</td>
|
2328
|
+
<td style="padding:15px">Split a link aggregation group into separate ports</td>
|
2329
|
+
<td style="padding:15px">{base_path}/{version}/networks/{pathv1}/switch/linkAggregations/{pathv2}?{query}</td>
|
2330
|
+
<td style="padding:15px">Yes</td>
|
2331
|
+
</tr>
|
2332
|
+
<tr>
|
2333
|
+
<td style="padding:15px">getNetworkNetflowSettings(networkId, callback)</td>
|
2334
|
+
<td style="padding:15px">Return the NetFlow traffic reporting settings for a network</td>
|
2335
|
+
<td style="padding:15px">[object Object]</td>
|
2336
|
+
<td style="padding:15px">Yes</td>
|
2337
|
+
</tr>
|
2338
|
+
<tr>
|
2339
|
+
<td style="padding:15px">updateNetworkNetflowSettings(networkId, body, callback)</td>
|
2340
|
+
<td style="padding:15px">Update the NetFlow traffic reporting settings for a network</td>
|
2341
|
+
<td style="padding:15px">[object Object]</td>
|
2342
|
+
<td style="padding:15px">Yes</td>
|
2343
|
+
</tr>
|
2344
|
+
<tr>
|
2345
|
+
<td style="padding:15px">getNetworkTrafficAnalysisSettings(networkId, callback)</td>
|
2346
|
+
<td style="padding:15px">Return the traffic analysis settings for a network</td>
|
2347
|
+
<td style="padding:15px">[object Object]</td>
|
2348
|
+
<td style="padding:15px">Yes</td>
|
2349
|
+
</tr>
|
2350
|
+
<tr>
|
2351
|
+
<td style="padding:15px">updateNetworkTrafficAnalysisSettings(networkId, callback)</td>
|
2352
|
+
<td style="padding:15px">Update the traffic analysis settings for a network</td>
|
2353
|
+
<td style="padding:15px">[object Object]</td>
|
2354
|
+
<td style="padding:15px">Yes</td>
|
2355
|
+
</tr>
|
2356
|
+
<tr>
|
2357
|
+
<td style="padding:15px">getOrganizationWebhookLogs(t0, t1, timespan, perPage, startingAfter, endingBefore, url, organizationId, callback)</td>
|
2358
|
+
<td style="padding:15px">Return the log of webhook POSTs sent</td>
|
2359
|
+
<td style="padding:15px">[object Object]</td>
|
2360
|
+
<td style="padding:15px">Yes</td>
|
2361
|
+
</tr>
|
2362
|
+
<tr>
|
2363
|
+
<td style="padding:15px">getNetworkWirelessSettings(networkId, callback)</td>
|
2364
|
+
<td style="padding:15px">Return the wireless settings for a network</td>
|
2365
|
+
<td style="padding:15px">{base_path}/{version}/networks/{pathv1}/wireless/settings?{query}</td>
|
2366
|
+
<td style="padding:15px">Yes</td>
|
2367
|
+
</tr>
|
2368
|
+
<tr>
|
2369
|
+
<td style="padding:15px">updateNetworkWirelessSettings(networkId, body, callback)</td>
|
2370
|
+
<td style="padding:15px">Update the wireless settings for a network</td>
|
2371
|
+
<td style="padding:15px">{base_path}/{version}/networks/{pathv1}/wireless/settings?{query}</td>
|
2372
|
+
<td style="padding:15px">Yes</td>
|
2373
|
+
</tr>
|
2374
|
+
<tr>
|
2375
|
+
<td style="padding:15px">returnstheidentityofthecurrentuser(callback)</td>
|
2376
|
+
<td style="padding:15px">Returns the identity of the current user.</td>
|
2377
|
+
<td style="padding:15px">{base_path}/{version}/administered/identities/me?{query}</td>
|
2378
|
+
<td style="padding:15px">Yes</td>
|
2379
|
+
</tr>
|
2380
|
+
<tr>
|
2381
|
+
<td style="padding:15px">returntheDHCPsubnetinformationforanappliance(serial, callback)</td>
|
2382
|
+
<td style="padding:15px">Return the DHCP subnet information for an appliance</td>
|
2383
|
+
<td style="padding:15px">{base_path}/{version}/devices/{pathv1}/appliance/dhcp/subnets?{query}</td>
|
2384
|
+
<td style="padding:15px">Yes</td>
|
2385
|
+
</tr>
|
2386
|
+
<tr>
|
2387
|
+
<td style="padding:15px">getthesentandreceivedbytesforeachuplinkofanetwork(networkId, callback)</td>
|
2388
|
+
<td style="padding:15px">Get the sent and received bytes for each uplink of a network.</td>
|
2389
|
+
<td style="padding:15px">{base_path}/{version}/networks/{pathv1}/appliance/uplinks/usageHistory?{query}</td>
|
2390
|
+
<td style="padding:15px">Yes</td>
|
2391
|
+
</tr>
|
2392
|
+
<tr>
|
2393
|
+
<td style="padding:15px">returnAPusageovertimeforadeviceornetworkclient(networkId, callback)</td>
|
2394
|
+
<td style="padding:15px">Return AP usage over time for a device or network client</td>
|
2395
|
+
<td style="padding:15px">{base_path}/{version}/networks/{pathv1}/wireless/usageHistory?{query}</td>
|
2396
|
+
<td style="padding:15px">Yes</td>
|
2397
|
+
</tr>
|
2398
|
+
<tr>
|
2399
|
+
<td style="padding:15px">listtheuplinkstatusofeveryMerakiMXandZseriesappliancesintheorganization(organizationId, callback)</td>
|
2400
|
+
<td style="padding:15px">List the uplink status of every Meraki MX and Z series appliances in the organization</td>
|
2401
|
+
<td style="padding:15px">{base_path}/{version}/organizations/{pathv1}/appliance/uplink/statuses?{query}</td>
|
2402
|
+
<td style="padding:15px">Yes</td>
|
2403
|
+
</tr>
|
2404
|
+
<tr>
|
2405
|
+
<td style="padding:15px">fetchOnboardingStatusOfCameras(organizationId, callback)</td>
|
2406
|
+
<td style="padding:15px">Fetch onboarding status of cameras</td>
|
2407
|
+
<td style="padding:15px">{base_path}/{version}/organizations/{pathv1}/camera/onboarding/statuses?{query}</td>
|
2408
|
+
<td style="padding:15px">Yes</td>
|
2409
|
+
</tr>
|
2410
|
+
<tr>
|
2411
|
+
<td style="padding:15px">notifyThatCredentialHandoffToCameraHasCompleted(organizationId, body, callback)</td>
|
2412
|
+
<td style="padding:15px">Notify that credential handoff to camera has completed
|
2413
|
+
#### Body Parameters
|
2414
|
+
**Parameter**|**Type**|**Description**
|
2415
|
+
:-------------: |:-------------: |:-------------:
|
2416
|
+
serial| string| Serial of camera
|
2417
|
+
wirelessCredentialsSent| boolean| Note whether credentials were sent successfully
|
2418
|
+
</td>
|
2419
|
+
<td style="padding:15px">{base_path}/{version}/organizations/{pathv1}/camera/onboarding/statuses?{query}</td>
|
2420
|
+
<td style="padding:15px">Yes</td>
|
2421
|
+
</tr>
|
2422
|
+
<tr>
|
2423
|
+
<td style="padding:15px">listtheuplinkstatusofeveryMerakiMGcellulargatewayintheorganization(organizationId, callback)</td>
|
2424
|
+
<td style="padding:15px">List the uplink status of every Meraki MG cellular gateway in the organization</td>
|
2425
|
+
<td style="padding:15px">{base_path}/{version}/organizations/{pathv1}/cellularGateway/uplink/statuses?{query}</td>
|
2426
|
+
<td style="padding:15px">Yes</td>
|
2427
|
+
</tr>
|
2428
|
+
<tr>
|
2429
|
+
<td style="padding:15px">listtheuplinkstatusofeveryMerakiMXMGandZseriesdevicesintheorganization(organizationId, callback)</td>
|
2430
|
+
<td style="padding:15px">List the uplink status of every Meraki MX, MG and Z series devices in the organization</td>
|
2431
|
+
<td style="padding:15px">{base_path}/{version}/organizations/{pathv1}/uplinks/statuses?{query}</td>
|
2432
|
+
<td style="padding:15px">Yes</td>
|
2433
|
+
</tr>
|
2434
|
+
<tr>
|
2435
|
+
<td style="padding:15px">showVPNstatusfornetworksinanorganization(organizationId, callback)</td>
|
2436
|
+
<td style="padding:15px">Show VPN status for networks in an organization</td>
|
2437
|
+
<td style="padding:15px">{base_path}/{version}/organizations/{pathv1}/appliance/vpn/statuses?{query}</td>
|
2438
|
+
<td style="padding:15px">Yes</td>
|
2439
|
+
</tr>
|
2440
|
+
<tr>
|
2441
|
+
<td style="padding:15px">listTheStatusOfEveryMerakiDeviceInTheOrganization(organizationId, callback)</td>
|
2442
|
+
<td style="padding:15px">List the status of every Meraki device in the organization</td>
|
2443
|
+
<td style="padding:15px">{base_path}/{version}/organizations/{pathv1}/devices/statuses?{query}</td>
|
2444
|
+
<td style="padding:15px">Yes</td>
|
2445
|
+
</tr>
|
2446
|
+
<tr>
|
2447
|
+
<td style="padding:15px">showVPNhistorystatfornetworksinanorganization(organizationId, callback)</td>
|
2448
|
+
<td style="padding:15px">Show VPN history stat for networks in an organization</td>
|
2449
|
+
<td style="padding:15px">{base_path}/{version}/organizations/{pathv1}/appliance/vpn/stats?{query}</td>
|
2450
|
+
<td style="padding:15px">Yes</td>
|
2451
|
+
</tr>
|
2452
|
+
<tr>
|
2453
|
+
<td style="padding:15px">returnTheFirewallSettingsForThisNetwork(networkId, callback)</td>
|
2454
|
+
<td style="padding:15px">Return the firewall settings for this network</td>
|
2455
|
+
<td style="padding:15px">{base_path}/{version}/networks/{pathv1}/appliance/firewall/settings?{query}</td>
|
2456
|
+
<td style="padding:15px">Yes</td>
|
2457
|
+
</tr>
|
2458
|
+
<tr>
|
2459
|
+
<td style="padding:15px">updateTheFirewallSettingsForThisNetwork(networkId, body, callback)</td>
|
2460
|
+
<td style="padding:15px">Update the firewall settings for this network
|
2461
|
+
#### Body Parameters
|
2462
|
+
**Parameter**|**Type**|**Description**
|
2463
|
+
:-------------: |:-------------: |:-------------:
|
2464
|
+
spoofingProtection| object| Spoofing protection settings
|
2465
|
+
</td>
|
2466
|
+
<td style="padding:15px">{base_path}/{version}/networks/{pathv1}/appliance/firewall/settings?{query}</td>
|
2467
|
+
<td style="padding:15px">Yes</td>
|
2468
|
+
</tr>
|
2469
|
+
<tr>
|
2470
|
+
<td style="padding:15px">returnTheApplianceSettingsForANetwork(networkId, callback)</td>
|
2471
|
+
<td style="padding:15px">Return the appliance settings for a network</td>
|
2472
|
+
<td style="padding:15px">{base_path}/{version}/networks/{pathv1}/appliance/settings?{query}</td>
|
2473
|
+
<td style="padding:15px">Yes</td>
|
2474
|
+
</tr>
|
2475
|
+
<tr>
|
2476
|
+
<td style="padding:15px">updateTheApplianceSettingsForANetwork(networkId, body, callback)</td>
|
2477
|
+
<td style="padding:15px">Update the appliance settings for a network
|
2478
|
+
#### Body Parameters
|
2479
|
+
**Parameter**|**Type**|**Description**
|
2480
|
+
:-------------: |:-------------: |:-------------:
|
2481
|
+
clientTrackingMethod| string| Client tracking method of a network
|
2482
|
+
deploymentMode| string| Deployment mode of a network
|
2483
|
+
|
2484
|
+
#### Supports Action Batches
|
2485
|
+
|
2486
|
+
**Resource**|**Operation**
|
2487
|
+
:-------------: |:-------------:
|
2488
|
+
`/networks/{networkId}/appliance/settings` | update
|
2489
|
+
|
2490
|
+
</td>
|
2491
|
+
<td style="padding:15px">{base_path}/{version}/networks/{pathv1}/appliance/settings?{query}</td>
|
2492
|
+
<td style="padding:15px">Yes</td>
|
2493
|
+
</tr>
|
2494
|
+
<tr>
|
2495
|
+
<td style="padding:15px">returnsTheEnabledStatusOfVLANsForTheNetwork(networkId, callback)</td>
|
2496
|
+
<td style="padding:15px">Returns the enabled status of VLANs for the network</td>
|
2497
|
+
<td style="padding:15px">{base_path}/{version}/networks/{pathv1}/appliance/vlans/settings?{query}</td>
|
2498
|
+
<td style="padding:15px">Yes</td>
|
2499
|
+
</tr>
|
2500
|
+
<tr>
|
2501
|
+
<td style="padding:15px">enableDisableVLANsForTheGivenNetwork(networkId, body, callback)</td>
|
2502
|
+
<td style="padding:15px">Enable/Disable VLANs for the given network
|
2503
|
+
#### Body Parameters
|
2504
|
+
**Parameter**|**Type**|**Description**
|
2505
|
+
:-------------: |:-------------: |:-------------:
|
2506
|
+
vlansEnabled| boolean| Boolean indicating whether to enable (true) or disable (false) VLANs for the network
|
2507
|
+
|
2508
|
+
#### Supports Action Batches
|
2509
|
+
|
2510
|
+
**Resource**|**Operation**
|
2511
|
+
:-------------: |:-------------:
|
2512
|
+
`/networks/{networkId}/appliance/vlans/settings` | update
|
2513
|
+
|
2514
|
+
</td>
|
2515
|
+
<td style="padding:15px">{base_path}/{version}/networks/{pathv1}/appliance/vlans/settings?{query}</td>
|
2516
|
+
<td style="padding:15px">Yes</td>
|
2517
|
+
</tr>
|
2518
|
+
<tr>
|
2519
|
+
<td style="padding:15px">returnTheSettingsForANetwork(networkId, callback)</td>
|
2520
|
+
<td style="padding:15px">Return the settings for a network</td>
|
2521
|
+
<td style="padding:15px">{base_path}/{version}/networks/{pathv1}/settings?{query}</td>
|
2522
|
+
<td style="padding:15px">Yes</td>
|
2523
|
+
</tr>
|
2524
|
+
<tr>
|
2525
|
+
<td style="padding:15px">updateTheSettingsForANetwork(networkId, body, callback)</td>
|
2526
|
+
<td style="padding:15px">Update the settings for a network
|
2527
|
+
#### Body Parameters
|
2528
|
+
**Parameter**|**Type**|**Description**
|
2529
|
+
:-------------: |:-------------: |:-------------:
|
2530
|
+
localStatusPageEnabled| boolean| Enables / disables the local device status pages ( my.meraki.com, ap.meraki.com, switch.meraki.com, wired.meraki.com ). Optional (defaults to false)
|
2531
|
+
remoteStatusPageEnabled| boolean| Enables / disables access to the device status page ( http://[device's LAN IP]) . Optional. Can only be set if localStatusPageEna...(description truncated)</td>
|
2532
|
+
<td style="padding:15px">{base_path}/{version}/networks/{pathv1}/settings?{query}</td>
|
2533
|
+
<td style="padding:15px">Yes</td>
|
2534
|
+
</tr>
|
2535
|
+
<tr>
|
2536
|
+
<td style="padding:15px">returnsGlobalAdaptivePolicySettingsInAnOrganization(organizationId, callback)</td>
|
2537
|
+
<td style="padding:15px">Returns global adaptive policy settings in an organization</td>
|
2538
|
+
<td style="padding:15px">{base_path}/{version}/organizations/{pathv1}/adaptivePolicy/settings?{query}</td>
|
2539
|
+
<td style="padding:15px">Yes</td>
|
2540
|
+
</tr>
|
2541
|
+
<tr>
|
2542
|
+
<td style="padding:15px">updateGlobalAdaptivePolicySettings(organizationId, body, callback)</td>
|
2543
|
+
<td style="padding:15px">Update global adaptive policy settings
|
2544
|
+
#### Body Parameters
|
2545
|
+
**Parameter**|**Type**|**Description**
|
2546
|
+
:-------------: |:-------------: |:-------------:
|
2547
|
+
enabledNetworks| array| List of network IDs with adaptive policy enabled
|
2548
|
+
|
2549
|
+
#### Supports Action Batches
|
2550
|
+
|
2551
|
+
**Resource**|**Operation**
|
2552
|
+
:-------------: |:-------------:
|
2553
|
+
`/organizations/{organizationId}/adaptivePolicy/settings` | update
|
2554
|
+
|
2555
|
+
</td>
|
2556
|
+
<td style="padding:15px">{base_path}/{version}/organizations/{pathv1}/adaptivePolicy/settings?{query}</td>
|
2557
|
+
<td style="padding:15px">Yes</td>
|
2558
|
+
</tr>
|
2559
|
+
<tr>
|
2560
|
+
<td style="padding:15px">returnTheBluetoothSettingsForAWirelessDevice(serial, callback)</td>
|
2561
|
+
<td style="padding:15px">Return the bluetooth settings for a wireless device</td>
|
2562
|
+
<td style="padding:15px">{base_path}/{version}/devices/{pathv1}/wireless/bluetooth/settings?{query}</td>
|
2563
|
+
<td style="padding:15px">Yes</td>
|
2564
|
+
</tr>
|
2565
|
+
<tr>
|
2566
|
+
<td style="padding:15px">updateTheBluetoothSettingsForAWirelessDevice(serial, body, callback)</td>
|
2567
|
+
<td style="padding:15px">Update the bluetooth settings for a wireless device
|
2568
|
+
#### Body Parameters
|
2569
|
+
**Parameter**|**Type**|**Description**
|
2570
|
+
:-------------: |:-------------: |:-------------:
|
2571
|
+
uuid| string| Desired UUID of the beacon. If the value is set to null it will reset to Dashboard's automatically generated value.
|
2572
|
+
major| integer| Desired major value of the beacon. If the value is set to null it will reset to Dashboard's automatically generated value.
|
2573
|
+
minor| integer| Desired minor value of the beacon. If the value ...(description truncated)</td>
|
2574
|
+
<td style="padding:15px">{base_path}/{version}/devices/{pathv1}/wireless/bluetooth/settings?{query}</td>
|
2575
|
+
<td style="padding:15px">Yes</td>
|
2576
|
+
</tr>
|
2577
|
+
<tr>
|
2578
|
+
<td style="padding:15px">returnTheBluetoothSettingsForANetworkAHrefHttpsDocumentationMerakiComMRBluetoothBluetoothLowEnergyBLEBluetoothSettingsAMustBeEnabledOnTheNetwork(networkId, callback)</td>
|
2579
|
+
<td style="padding:15px">Return the Bluetooth settings for a network. Bluetooth settings must be enabled on the network.</td>
|
2580
|
+
<td style="padding:15px">{base_path}/{version}/networks/{pathv1}/wireless/bluetooth/settings?{query}</td>
|
2581
|
+
<td style="padding:15px">Yes</td>
|
2582
|
+
</tr>
|
2583
|
+
<tr>
|
2584
|
+
<td style="padding:15px">updateTheBluetoothSettingsForANetwork(networkId, body, callback)</td>
|
2585
|
+
<td style="padding:15px">Update the Bluetooth settings for a network. See the docs page for Bluetooth settings .</td>
|
2586
|
+
<td style="padding:15px">{base_path}/{version}/networks/{pathv1}/wireless/bluetooth/settings?{query}</td>
|
2587
|
+
<td style="padding:15px">Yes</td>
|
2588
|
+
</tr>
|
2589
|
+
<tr>
|
2590
|
+
<td style="padding:15px">returnAllThePortsOfASwitchProfile(organizationId, configTemplateId, profileId, callback)</td>
|
2591
|
+
<td style="padding:15px">Return all the ports of a switch profile</td>
|
2592
|
+
<td style="padding:15px">{base_path}/{version}/organizations/{pathv1}/configTemplates/{pathv2}/switch/profiles/{pathv3}/ports?{query}</td>
|
2593
|
+
<td style="padding:15px">Yes</td>
|
2594
|
+
</tr>
|
2595
|
+
<tr>
|
2596
|
+
<td style="padding:15px">returnASwitchProfilePort(organizationId, configTemplateId, profileId, portId, callback)</td>
|
2597
|
+
<td style="padding:15px">Return a switch profile port</td>
|
2598
|
+
<td style="padding:15px">{base_path}/{version}/organizations/{pathv1}/configTemplates/{pathv2}/switch/profiles/{pathv3}/ports/{pathv4}?{query}</td>
|
2599
|
+
<td style="padding:15px">Yes</td>
|
2600
|
+
</tr>
|
2601
|
+
<tr>
|
2602
|
+
<td style="padding:15px">updateASwitchProfilePort(organizationId, configTemplateId, profileId, portId, body, callback)</td>
|
2603
|
+
<td style="padding:15px">Update a switch profile port
|
2604
|
+
#### Body Parameters
|
2605
|
+
**Parameter**|**Type**|**Description**
|
2606
|
+
:-------------: |:-------------: |:-------------:
|
2607
|
+
name| string| The name of the switch profile port.
|
2608
|
+
tags| array| The list of tags of the switch profile port.
|
2609
|
+
enabled| boolean| The status of the switch profile port.
|
2610
|
+
poeEnabled| boolean| The PoE status of the switch profile port.
|
2611
|
+
type| string| The type of the switch profile port ('trunk' or 'access').
|
2612
|
+
vlan| integer| The VLAN of the switch profile port. A...(description truncated)</td>
|
2613
|
+
<td style="padding:15px">{base_path}/{version}/organizations/{pathv1}/configTemplates/{pathv2}/switch/profiles/{pathv3}/ports/{pathv4}?{query}</td>
|
2614
|
+
<td style="padding:15px">Yes</td>
|
2615
|
+
</tr>
|
2616
|
+
<tr>
|
2617
|
+
<td style="padding:15px">returnSingleLANConfiguration(networkId, callback)</td>
|
2618
|
+
<td style="padding:15px">Return single LAN configuration</td>
|
2619
|
+
<td style="padding:15px">{base_path}/{version}/networks/{pathv1}/appliance/singleLan?{query}</td>
|
2620
|
+
<td style="padding:15px">Yes</td>
|
2621
|
+
</tr>
|
2622
|
+
<tr>
|
2623
|
+
<td style="padding:15px">updateSingleLANConfiguration(networkId, body, callback)</td>
|
2624
|
+
<td style="padding:15px">Update single LAN configuration
|
2625
|
+
#### Body Parameters
|
2626
|
+
**Parameter**|**Type**|**Description**
|
2627
|
+
:-------------: |:-------------: |:-------------:
|
2628
|
+
subnet| string| The subnet of the single LAN configuration
|
2629
|
+
applianceIp| string| The appliance IP address of the single LAN
|
2630
|
+
|
2631
|
+
#### Supports Action Batches
|
2632
|
+
|
2633
|
+
**Resource**|**Operation**
|
2634
|
+
:-------------: |:-------------:
|
2635
|
+
`/networks/{networkId}/appliance/singleLan` | update
|
2636
|
+
|
2637
|
+
</td>
|
2638
|
+
<td style="padding:15px">{base_path}/{version}/networks/{pathv1}/appliance/singleLan?{query}</td>
|
2639
|
+
<td style="padding:15px">Yes</td>
|
2640
|
+
</tr>
|
2641
|
+
<tr>
|
2642
|
+
<td style="padding:15px">listLayer3StaticRoutesForASwitch(serial, callback)</td>
|
2643
|
+
<td style="padding:15px">List layer 3 static routes for a switch</td>
|
2644
|
+
<td style="padding:15px">{base_path}/{version}/devices/{pathv1}/switch/routing/staticRoutes?{query}</td>
|
2645
|
+
<td style="padding:15px">Yes</td>
|
2646
|
+
</tr>
|
2647
|
+
<tr>
|
2648
|
+
<td style="padding:15px">createALayer3StaticRouteForASwitch(serial, body, callback)</td>
|
2649
|
+
<td style="padding:15px">Create a layer 3 static route for a switch
|
2650
|
+
#### Body Parameters
|
2651
|
+
**Parameter**|**Type**|**Description**
|
2652
|
+
:-------------: |:-------------: |:-------------:
|
2653
|
+
name| string| Name or description for layer 3 static route
|
2654
|
+
subnet| string| The subnet which is routed via this static route and should be specified in CIDR notation (ex. 1.2.3.0/24)
|
2655
|
+
nextHopIp| string| IP address of the next hop device to which the device sends its traffic for the subnet
|
2656
|
+
advertiseViaOspfEnabled| boolean| Option to advertise ...(description truncated)</td>
|
2657
|
+
<td style="padding:15px">{base_path}/{version}/devices/{pathv1}/switch/routing/staticRoutes?{query}</td>
|
2658
|
+
<td style="padding:15px">Yes</td>
|
2659
|
+
</tr>
|
2660
|
+
<tr>
|
2661
|
+
<td style="padding:15px">returnALayer3StaticRouteForASwitch(serial, staticRouteId, callback)</td>
|
2662
|
+
<td style="padding:15px">Return a layer 3 static route for a switch</td>
|
2663
|
+
<td style="padding:15px">{base_path}/{version}/devices/{pathv1}/switch/routing/staticRoutes/{pathv2}?{query}</td>
|
2664
|
+
<td style="padding:15px">Yes</td>
|
2665
|
+
</tr>
|
2666
|
+
<tr>
|
2667
|
+
<td style="padding:15px">updateALayer3StaticRouteForASwitch(serial, staticRouteId, body, callback)</td>
|
2668
|
+
<td style="padding:15px">Update a layer 3 static route for a switch
|
2669
|
+
#### Body Parameters
|
2670
|
+
**Parameter**|**Type**|**Description**
|
2671
|
+
:-------------: |:-------------: |:-------------:
|
2672
|
+
name| string| Name or description for layer 3 static route
|
2673
|
+
subnet| string| The subnet which is routed via this static route and should be specified in CIDR notation (ex. 1.2.3.0/24)
|
2674
|
+
nextHopIp| string| IP address of the next hop device to which the device sends its traffic for the subnet
|
2675
|
+
advertiseViaOspfEnabled| boolean| Option to advertise ...(description truncated)</td>
|
2676
|
+
<td style="padding:15px">{base_path}/{version}/devices/{pathv1}/switch/routing/staticRoutes/{pathv2}?{query}</td>
|
2677
|
+
<td style="padding:15px">Yes</td>
|
2678
|
+
</tr>
|
2679
|
+
<tr>
|
2680
|
+
<td style="padding:15px">deleteALayer3StaticRouteForASwitch(serial, staticRouteId, callback)</td>
|
2681
|
+
<td style="padding:15px">Delete a layer 3 static route for a switch
|
2682
|
+
#### Supports Action Batches
|
2683
|
+
|
2684
|
+
**Resource**|**Operation**
|
2685
|
+
:-------------: |:-------------:
|
2686
|
+
`/devices/{serial}/switch/routing/staticRoutes/{staticRouteId}` | destroy
|
2687
|
+
|
2688
|
+
</td>
|
2689
|
+
<td style="padding:15px">{base_path}/{version}/devices/{pathv1}/switch/routing/staticRoutes/{pathv2}?{query}</td>
|
2690
|
+
<td style="padding:15px">Yes</td>
|
2691
|
+
</tr>
|
2692
|
+
<tr>
|
2693
|
+
<td style="padding:15px">listLayer3StaticRoutesForASwitchStack(networkId, switchStackId, callback)</td>
|
2694
|
+
<td style="padding:15px">List layer 3 static routes for a switch stack</td>
|
2695
|
+
<td style="padding:15px">{base_path}/{version}/networks/{pathv1}/switch/stacks/{pathv2}/routing/staticRoutes?{query}</td>
|
2696
|
+
<td style="padding:15px">Yes</td>
|
2697
|
+
</tr>
|
2698
|
+
<tr>
|
2699
|
+
<td style="padding:15px">createALayer3StaticRouteForASwitchStack(networkId, switchStackId, body, callback)</td>
|
2700
|
+
<td style="padding:15px">Create a layer 3 static route for a switch stack
|
2701
|
+
#### Body Parameters
|
2702
|
+
**Parameter**|**Type**|**Description**
|
2703
|
+
:-------------: |:-------------: |:-------------:
|
2704
|
+
name| string| Name or description for layer 3 static route
|
2705
|
+
subnet| string| The subnet which is routed via this static route and should be specified in CIDR notation (ex. 1.2.3.0/24)
|
2706
|
+
nextHopIp| string| IP address of the next hop device to which the device sends its traffic for the subnet
|
2707
|
+
advertiseViaOspfEnabled| boolean| Option to adve...(description truncated)</td>
|
2708
|
+
<td style="padding:15px">{base_path}/{version}/networks/{pathv1}/switch/stacks/{pathv2}/routing/staticRoutes?{query}</td>
|
2709
|
+
<td style="padding:15px">Yes</td>
|
2710
|
+
</tr>
|
2711
|
+
<tr>
|
2712
|
+
<td style="padding:15px">returnALayer3StaticRouteForASwitchStack(networkId, switchStackId, staticRouteId, callback)</td>
|
2713
|
+
<td style="padding:15px">Return a layer 3 static route for a switch stack</td>
|
2714
|
+
<td style="padding:15px">{base_path}/{version}/networks/{pathv1}/switch/stacks/{pathv2}/routing/staticRoutes/{pathv3}?{query}</td>
|
2715
|
+
<td style="padding:15px">Yes</td>
|
2716
|
+
</tr>
|
2717
|
+
<tr>
|
2718
|
+
<td style="padding:15px">updateALayer3StaticRouteForASwitchStack(networkId, switchStackId, staticRouteId, body, callback)</td>
|
2719
|
+
<td style="padding:15px">Update a layer 3 static route for a switch stack
|
2720
|
+
#### Body Parameters
|
2721
|
+
**Parameter**|**Type**|**Description**
|
2722
|
+
:-------------: |:-------------: |:-------------:
|
2723
|
+
name| string| Name or description for layer 3 static route
|
2724
|
+
subnet| string| The subnet which is routed via this static route and should be specified in CIDR notation (ex. 1.2.3.0/24)
|
2725
|
+
nextHopIp| string| IP address of the next hop device to which the device sends its traffic for the subnet
|
2726
|
+
advertiseViaOspfEnabled| boolean| Option to adve...(description truncated)</td>
|
2727
|
+
<td style="padding:15px">{base_path}/{version}/networks/{pathv1}/switch/stacks/{pathv2}/routing/staticRoutes/{pathv3}?{query}</td>
|
2728
|
+
<td style="padding:15px">Yes</td>
|
2729
|
+
</tr>
|
2730
|
+
<tr>
|
2731
|
+
<td style="padding:15px">deleteALayer3StaticRouteForASwitchStack(networkId, switchStackId, staticRouteId, callback)</td>
|
2732
|
+
<td style="padding:15px">Delete a layer 3 static route for a switch stack
|
2733
|
+
#### Supports Action Batches
|
2734
|
+
|
2735
|
+
**Resource**|**Operation**
|
2736
|
+
:-------------: |:-------------:
|
2737
|
+
`/networks/{networkId}/switch/stacks/{switchStackId}/routing/staticRoutes/{staticRouteId}` | destroy
|
2738
|
+
|
2739
|
+
</td>
|
2740
|
+
<td style="padding:15px">{base_path}/{version}/networks/{pathv1}/switch/stacks/{pathv2}/routing/staticRoutes/{pathv3}?{query}</td>
|
2741
|
+
<td style="padding:15px">Yes</td>
|
2742
|
+
</tr>
|
2743
|
+
<tr>
|
2744
|
+
<td style="padding:15px">listAllCustomPerformanceClassesForAnMXNetwork(networkId, callback)</td>
|
2745
|
+
<td style="padding:15px">List all custom performance classes for an MX network</td>
|
2746
|
+
<td style="padding:15px">{base_path}/{version}/networks/{pathv1}/appliance/trafficShaping/customPerformanceClasses?{query}</td>
|
2747
|
+
<td style="padding:15px">Yes</td>
|
2748
|
+
</tr>
|
2749
|
+
<tr>
|
2750
|
+
<td style="padding:15px">addACustomPerformanceClassForAnMXNetwork(networkId, body, callback)</td>
|
2751
|
+
<td style="padding:15px">Add a custom performance class for an MX network
|
2752
|
+
#### Body Parameters
|
2753
|
+
**Parameter**|**Type**|**Description**
|
2754
|
+
:-------------: |:-------------: |:-------------:
|
2755
|
+
name| string| Name of the custom performance class
|
2756
|
+
maxLatency| integer| Maximum latency in milliseconds
|
2757
|
+
maxJitter| integer| Maximum jitter in milliseconds
|
2758
|
+
maxLossPercentage| integer| Maximum percentage of packet loss
|
2759
|
+
|
2760
|
+
#### Supports Action Batches
|
2761
|
+
|
2762
|
+
**Resource**|**Operation**
|
2763
|
+
:-------------: |:-------------:
|
2764
|
+
`/networks/{networkId}/appli...(description truncated)</td>
|
2765
|
+
<td style="padding:15px">{base_path}/{version}/networks/{pathv1}/appliance/trafficShaping/customPerformanceClasses?{query}</td>
|
2766
|
+
<td style="padding:15px">Yes</td>
|
2767
|
+
</tr>
|
2768
|
+
<tr>
|
2769
|
+
<td style="padding:15px">returnACustomPerformanceClassForAnMXNetwork(networkId, customPerformanceClassId, callback)</td>
|
2770
|
+
<td style="padding:15px">Return a custom performance class for an MX network</td>
|
2771
|
+
<td style="padding:15px">{base_path}/{version}/networks/{pathv1}/appliance/trafficShaping/customPerformanceClasses/{pathv2}?{query}</td>
|
2772
|
+
<td style="padding:15px">Yes</td>
|
2773
|
+
</tr>
|
2774
|
+
<tr>
|
2775
|
+
<td style="padding:15px">updateACustomPerformanceClassForAnMXNetwork(networkId, customPerformanceClassId, body, callback)</td>
|
2776
|
+
<td style="padding:15px">Update a custom performance class for an MX network
|
2777
|
+
#### Body Parameters
|
2778
|
+
**Parameter**|**Type**|**Description**
|
2779
|
+
:-------------: |:-------------: |:-------------:
|
2780
|
+
name| string| Name of the custom performance class
|
2781
|
+
maxLatency| integer| Maximum latency in milliseconds
|
2782
|
+
maxJitter| integer| Maximum jitter in milliseconds
|
2783
|
+
maxLossPercentage| integer| Maximum percentage of packet loss
|
2784
|
+
|
2785
|
+
#### Supports Action Batches
|
2786
|
+
|
2787
|
+
**Resource**|**Operation**
|
2788
|
+
:-------------: |:-------------:
|
2789
|
+
`/networks/{networkId}/ap...(description truncated)</td>
|
2790
|
+
<td style="padding:15px">{base_path}/{version}/networks/{pathv1}/appliance/trafficShaping/customPerformanceClasses/{pathv2}?{query}</td>
|
2791
|
+
<td style="padding:15px">Yes</td>
|
2792
|
+
</tr>
|
2793
|
+
<tr>
|
2794
|
+
<td style="padding:15px">deleteACustomPerformanceClassFromAnMXNetwork(networkId, customPerformanceClassId, callback)</td>
|
2795
|
+
<td style="padding:15px">Delete a custom performance class from an MX network
|
2796
|
+
#### Supports Action Batches
|
2797
|
+
|
2798
|
+
**Resource**|**Operation**
|
2799
|
+
:-------------: |:-------------:
|
2800
|
+
`/networks/{networkId}/appliance/trafficShaping/customPerformanceClasses/{customPerformanceClassId}` | destroy
|
2801
|
+
|
2802
|
+
</td>
|
2803
|
+
<td style="padding:15px">{base_path}/{version}/networks/{pathv1}/appliance/trafficShaping/customPerformanceClasses/{pathv2}?{query}</td>
|
2804
|
+
<td style="padding:15px">Yes</td>
|
2805
|
+
</tr>
|
2806
|
+
<tr>
|
2807
|
+
<td style="padding:15px">updateTheTrafficShapingSettingsRulesForAnMXNetwork(networkId, body, callback)</td>
|
2808
|
+
<td style="padding:15px">Update the traffic shaping settings rules for an MX network
|
2809
|
+
#### Body Parameters
|
2810
|
+
**Parameter**|**Type**|**Description**
|
2811
|
+
:-------------: |:-------------: |:-------------:
|
2812
|
+
defaultRulesEnabled| boolean| Whether default traffic shaping rules are enabled (true) or disabled (false). There are 4 default rules, which can be seen on your network's traffic shaping page. Note that default rules count against the rule limit of 8.
|
2813
|
+
rules| array| An array of traffic shaping rules. Rules are applied in...(description truncated)</td>
|
2814
|
+
<td style="padding:15px">{base_path}/{version}/networks/{pathv1}/appliance/trafficShaping/rules?{query}</td>
|
2815
|
+
<td style="padding:15px">Yes</td>
|
2816
|
+
</tr>
|
2817
|
+
<tr>
|
2818
|
+
<td style="padding:15px">displayTheTrafficShapingSettingsRulesForAnMXNetwork(networkId, callback)</td>
|
2819
|
+
<td style="padding:15px">Display the traffic shaping settings rules for an MX network</td>
|
2820
|
+
<td style="padding:15px">{base_path}/{version}/networks/{pathv1}/appliance/trafficShaping/rules?{query}</td>
|
2821
|
+
<td style="padding:15px">Yes</td>
|
2822
|
+
</tr>
|
2823
|
+
<tr>
|
2824
|
+
<td style="padding:15px">showUplinkSelectionSettingsForAnMXNetwork(networkId, callback)</td>
|
2825
|
+
<td style="padding:15px">Show uplink selection settings for an MX network</td>
|
2826
|
+
<td style="padding:15px">{base_path}/{version}/networks/{pathv1}/appliance/trafficShaping/uplinkSelection?{query}</td>
|
2827
|
+
<td style="padding:15px">Yes</td>
|
2828
|
+
</tr>
|
2829
|
+
<tr>
|
2830
|
+
<td style="padding:15px">updateUplinkSelectionSettingsForAnMXNetwork(networkId, body, callback)</td>
|
2831
|
+
<td style="padding:15px">Update uplink selection settings for an MX network
|
2832
|
+
#### Body Parameters
|
2833
|
+
**Parameter**|**Type**|**Description**
|
2834
|
+
:-------------: |:-------------: |:-------------:
|
2835
|
+
activeActiveAutoVpnEnabled| boolean| Toggle for enabling or disabling active-active AutoVPN
|
2836
|
+
defaultUplink| string| The default uplink. Must be one of: 'wan1' or 'wan2'
|
2837
|
+
loadBalancingEnabled| boolean| Toggle for enabling or disabling load balancing
|
2838
|
+
wanTrafficUplinkPreferences| array| Array of uplink preference rules for WAN traffic
|
2839
|
+
vp...(description truncated)</td>
|
2840
|
+
<td style="padding:15px">{base_path}/{version}/networks/{pathv1}/appliance/trafficShaping/uplinkSelection?{query}</td>
|
2841
|
+
<td style="padding:15px">Yes</td>
|
2842
|
+
</tr>
|
2843
|
+
<tr>
|
2844
|
+
<td style="padding:15px">returnAHubBGPConfiguration(networkId, callback)</td>
|
2845
|
+
<td style="padding:15px">Return a Hub BGP Configuration</td>
|
2846
|
+
<td style="padding:15px">{base_path}/{version}/networks/{pathv1}/appliance/vpn/bgp?{query}</td>
|
2847
|
+
<td style="padding:15px">Yes</td>
|
2848
|
+
</tr>
|
2849
|
+
<tr>
|
2850
|
+
<td style="padding:15px">updateAHubBGPConfiguration(networkId, body, callback)</td>
|
2851
|
+
<td style="padding:15px">Update a Hub BGP Configuration
|
2852
|
+
#### Body Parameters
|
2853
|
+
**Parameter**|**Type**|**Description**
|
2854
|
+
:-------------: |:-------------: |:-------------:
|
2855
|
+
enabled| boolean| Boolean value to enable or disable the BGP configuration. When BGP is enabled, the asNumber (ASN) will be autopopulated with the preconfigured ASN at other Hubs or a default value if there is no ASN configured.
|
2856
|
+
asNumber| integer| An Autonomous System Number (ASN) is required if you are to run BGP and peer with another BGP Speaker outs...(description truncated)</td>
|
2857
|
+
<td style="padding:15px">{base_path}/{version}/networks/{pathv1}/appliance/vpn/bgp?{query}</td>
|
2858
|
+
<td style="padding:15px">Yes</td>
|
2859
|
+
</tr>
|
2860
|
+
<tr>
|
2861
|
+
<td style="padding:15px">returnWarmSpareConfigurationForASwitch(serial, callback)</td>
|
2862
|
+
<td style="padding:15px">Return warm spare configuration for a switch</td>
|
2863
|
+
<td style="padding:15px">{base_path}/{version}/devices/{pathv1}/switch/warmSpare?{query}</td>
|
2864
|
+
<td style="padding:15px">Yes</td>
|
2865
|
+
</tr>
|
2866
|
+
<tr>
|
2867
|
+
<td style="padding:15px">updateWarmSpareConfigurationForASwitch(serial, body, callback)</td>
|
2868
|
+
<td style="padding:15px">Update warm spare configuration for a switch. The spare will use the same L3 configuration as the primary. Note that this will irreversibly destroy any existing L3 configuration on the spare.</td>
|
2869
|
+
<td style="padding:15px">{base_path}/{version}/devices/{pathv1}/switch/warmSpare?{query}</td>
|
2870
|
+
<td style="padding:15px">Yes</td>
|
2871
|
+
</tr>
|
2872
|
+
<tr>
|
2873
|
+
<td style="padding:15px">returnoverviewstatisticsfornetworkclients(networkId, callback)</td>
|
2874
|
+
<td style="padding:15px">Return overview statistics for network clients</td>
|
2875
|
+
<td style="padding:15px">{base_path}/{version}/networks/{pathv1}/clients/overview?{query}</td>
|
2876
|
+
<td style="padding:15px">Yes</td>
|
2877
|
+
</tr>
|
2878
|
+
<tr>
|
2879
|
+
<td style="padding:15px">returnsummaryinformationaroundclientdatausageInmbAcrossthegivenorganization(organizationId, callback)</td>
|
2880
|
+
<td style="padding:15px">Return summary information around client data usage (in mb) across the given organization.</td>
|
2881
|
+
<td style="padding:15px">{base_path}/{version}/organizations/{pathv1}/clients/overview?{query}</td>
|
2882
|
+
<td style="padding:15px">Yes</td>
|
2883
|
+
</tr>
|
2884
|
+
<tr>
|
2885
|
+
<td style="padding:15px">returnanoverviewofcurrentdevicestatuses(organizationId, callback)</td>
|
2886
|
+
<td style="padding:15px">Return an overview of current device statuses</td>
|
2887
|
+
<td style="padding:15px">{base_path}/{version}/organizations/{pathv1}/devices/statuses/overview?{query}</td>
|
2888
|
+
<td style="padding:15px">Yes</td>
|
2889
|
+
</tr>
|
2890
|
+
<tr>
|
2891
|
+
<td style="padding:15px">returnsadaptivepolicyaggregatestatisticsforanorganization(organizationId, callback)</td>
|
2892
|
+
<td style="padding:15px">Returns adaptive policy aggregate statistics for an organization</td>
|
2893
|
+
<td style="padding:15px">{base_path}/{version}/organizations/{pathv1}/adaptivePolicy/overview?{query}</td>
|
2894
|
+
<td style="padding:15px">Yes</td>
|
2895
|
+
</tr>
|
2896
|
+
<tr>
|
2897
|
+
<td style="padding:15px">returnanoverviewofthelicensestateforanorganization(organizationId, callback)</td>
|
2898
|
+
<td style="padding:15px">Return an overview of the license state for an organization</td>
|
2899
|
+
<td style="padding:15px">{base_path}/{version}/organizations/{pathv1}/licenses/overview?{query}</td>
|
2900
|
+
<td style="padding:15px">Yes</td>
|
2901
|
+
</tr>
|
2902
|
+
<tr>
|
2903
|
+
<td style="padding:15px">returnallreportedreadingsfromsensorsinagiventimespanSortedbytimestamp(organizationId, callback)</td>
|
2904
|
+
<td style="padding:15px">Return all reported readings from sensors in a given timespan, sorted by timestamp</td>
|
2905
|
+
<td style="padding:15px">{base_path}/{version}/organizations/{pathv1}/sensor/readings/history?{query}</td>
|
2906
|
+
<td style="padding:15px">Yes</td>
|
2907
|
+
</tr>
|
2908
|
+
<tr>
|
2909
|
+
<td style="padding:15px">listCustomAnalyticsArtifacts(organizationId, callback)</td>
|
2910
|
+
<td style="padding:15px">List Custom Analytics Artifacts</td>
|
2911
|
+
<td style="padding:15px">{base_path}/{version}/organizations/{pathv1}/camera/customAnalytics/artifacts?{query}</td>
|
2912
|
+
<td style="padding:15px">Yes</td>
|
2913
|
+
</tr>
|
2914
|
+
<tr>
|
2915
|
+
<td style="padding:15px">createCustomAnalyticsArtifact(organizationId, body, callback)</td>
|
2916
|
+
<td style="padding:15px">Create custom analytics artifact. Returns an artifact upload URL with expiry time. Upload the artifact file with a put request to the returned upload URL before its expiry.</td>
|
2917
|
+
<td style="padding:15px">{base_path}/{version}/organizations/{pathv1}/camera/customAnalytics/artifacts?{query}</td>
|
2918
|
+
<td style="padding:15px">Yes</td>
|
2919
|
+
</tr>
|
2920
|
+
<tr>
|
2921
|
+
<td style="padding:15px">getCustomAnalyticsArtifact(organizationId, artifactId, callback)</td>
|
2922
|
+
<td style="padding:15px">Get Custom Analytics Artifact</td>
|
2923
|
+
<td style="padding:15px">{base_path}/{version}/organizations/{pathv1}/camera/customAnalytics/artifacts/{pathv2}?{query}</td>
|
2924
|
+
<td style="padding:15px">Yes</td>
|
2925
|
+
</tr>
|
2926
|
+
<tr>
|
2927
|
+
<td style="padding:15px">deleteCustomAnalyticsArtifact(organizationId, artifactId, callback)</td>
|
2928
|
+
<td style="padding:15px">Delete Custom Analytics Artifact</td>
|
2929
|
+
<td style="padding:15px">{base_path}/{version}/organizations/{pathv1}/camera/customAnalytics/artifacts/{pathv2}?{query}</td>
|
2930
|
+
<td style="padding:15px">Yes</td>
|
2931
|
+
</tr>
|
2932
|
+
<tr>
|
2933
|
+
<td style="padding:15px">returnCustomAnalyticsSettingsForACamera(serial, callback)</td>
|
2934
|
+
<td style="padding:15px">Return custom analytics settings for a camera</td>
|
2935
|
+
<td style="padding:15px">{base_path}/{version}/devices/{pathv1}/camera/customAnalytics?{query}</td>
|
2936
|
+
<td style="padding:15px">Yes</td>
|
2937
|
+
</tr>
|
2938
|
+
<tr>
|
2939
|
+
<td style="padding:15px">updateCustomAnalyticsSettingsForACamera(serial, body, callback)</td>
|
2940
|
+
<td style="padding:15px">Update custom analytics settings for a camera
|
2941
|
+
#### Body Parameters
|
2942
|
+
**Parameter**|**Type**|**Description**
|
2943
|
+
:-------------: |:-------------: |:-------------:
|
2944
|
+
enabled| boolean| Enable custom analytics
|
2945
|
+
artifactId| string| The ID of the custom analytics artifact
|
2946
|
+
parameters| array| Parameters for the custom analytics workload
|
2947
|
+
|
2948
|
+
#### Supports Action Batches
|
2949
|
+
|
2950
|
+
**Resource**|**Operation**
|
2951
|
+
:-------------: |:-------------:
|
2952
|
+
`/devices/{serial}/camera/customAnalytics` | update
|
2953
|
+
|
2954
|
+
</td>
|
2955
|
+
<td style="padding:15px">{base_path}/{version}/devices/{pathv1}/camera/customAnalytics?{query}</td>
|
2956
|
+
<td style="padding:15px">Yes</td>
|
2957
|
+
</tr>
|
2958
|
+
<tr>
|
2959
|
+
<td style="padding:15px">returnstheMVSenseobjectdetectionmodellistforthegivencamera(serial, callback)</td>
|
2960
|
+
<td style="padding:15px">Returns the MV Sense object detection model list for the given camera</td>
|
2961
|
+
<td style="padding:15px">{base_path}/{version}/devices/{pathv1}/camera/sense/objectDetectionModels?{query}</td>
|
2962
|
+
<td style="padding:15px">Yes</td>
|
2963
|
+
</tr>
|
2964
|
+
<tr>
|
2965
|
+
<td style="padding:15px">returnsSenseSettingsForAGivenCamera(serial, callback)</td>
|
2966
|
+
<td style="padding:15px">Returns sense settings for a given camera</td>
|
2967
|
+
<td style="padding:15px">{base_path}/{version}/devices/{pathv1}/camera/sense?{query}</td>
|
2968
|
+
<td style="padding:15px">Yes</td>
|
2969
|
+
</tr>
|
2970
|
+
<tr>
|
2971
|
+
<td style="padding:15px">updateSenseSettingsForTheGivenCamera(serial, body, callback)</td>
|
2972
|
+
<td style="padding:15px">Update sense settings for the given camera
|
2973
|
+
#### Body Parameters
|
2974
|
+
**Parameter**|**Type**|**Description**
|
2975
|
+
:-------------: |:-------------: |:-------------:
|
2976
|
+
senseEnabled| boolean| Boolean indicating if sense(license) is enabled(true) or disabled(false) on the camera
|
2977
|
+
mqttBrokerId| string| The ID of the MQTT broker to be enabled on the camera. A value of null will disable MQTT on the camera
|
2978
|
+
audioDetection| object| The details of the audio detection config.
|
2979
|
+
detectionModelId| string| The ID of the ...(description truncated)</td>
|
2980
|
+
<td style="padding:15px">{base_path}/{version}/devices/{pathv1}/camera/sense?{query}</td>
|
2981
|
+
<td style="padding:15px">Yes</td>
|
2982
|
+
</tr>
|
2983
|
+
<tr>
|
2984
|
+
<td style="padding:15px">returnsWirelessProfileAssignedToTheGivenCamera(serial, callback)</td>
|
2985
|
+
<td style="padding:15px">Returns wireless profile assigned to the given camera</td>
|
2986
|
+
<td style="padding:15px">{base_path}/{version}/devices/{pathv1}/camera/wirelessProfiles?{query}</td>
|
2987
|
+
<td style="padding:15px">Yes</td>
|
2988
|
+
</tr>
|
2989
|
+
<tr>
|
2990
|
+
<td style="padding:15px">assignWirelessProfilesToTheGivenCamera(serial, body, callback)</td>
|
2991
|
+
<td style="padding:15px">Assign wireless profiles to the given camera. Incremental updates are not supported, all profile assignment need to be supplied at once.</td>
|
2992
|
+
<td style="padding:15px">{base_path}/{version}/devices/{pathv1}/camera/wirelessProfiles?{query}</td>
|
2993
|
+
<td style="padding:15px">Yes</td>
|
2994
|
+
</tr>
|
2995
|
+
<tr>
|
2996
|
+
<td style="padding:15px">createsANewCameraWirelessProfileForThisNetwork(networkId, body, callback)</td>
|
2997
|
+
<td style="padding:15px">Creates a new camera wireless profile for this network.
|
2998
|
+
#### Body Parameters
|
2999
|
+
**Parameter**|**Type**|**Description**
|
3000
|
+
:-------------: |:-------------: |:-------------:
|
3001
|
+
name| string| The name of the camera wireless profile. This parameter is required.
|
3002
|
+
ssid| object| The details of the SSID config.
|
3003
|
+
identity| object| The identity of the wireless profile. Required for creating wireless profiles in 8021x-radius auth mode.
|
3004
|
+
</td>
|
3005
|
+
<td style="padding:15px">{base_path}/{version}/networks/{pathv1}/camera/wirelessProfiles?{query}</td>
|
3006
|
+
<td style="padding:15px">Yes</td>
|
3007
|
+
</tr>
|
3008
|
+
<tr>
|
3009
|
+
<td style="padding:15px">listTheCameraWirelessProfilesForThisNetwork(networkId, callback)</td>
|
3010
|
+
<td style="padding:15px">List the camera wireless profiles for this network.</td>
|
3011
|
+
<td style="padding:15px">{base_path}/{version}/networks/{pathv1}/camera/wirelessProfiles?{query}</td>
|
3012
|
+
<td style="padding:15px">Yes</td>
|
3013
|
+
</tr>
|
3014
|
+
<tr>
|
3015
|
+
<td style="padding:15px">retrieveASingleCameraWirelessProfile(networkId, wirelessProfileId, callback)</td>
|
3016
|
+
<td style="padding:15px">Retrieve a single camera wireless profile.</td>
|
3017
|
+
<td style="padding:15px">{base_path}/{version}/networks/{pathv1}/camera/wirelessProfiles/{pathv2}?{query}</td>
|
3018
|
+
<td style="padding:15px">Yes</td>
|
3019
|
+
</tr>
|
3020
|
+
<tr>
|
3021
|
+
<td style="padding:15px">updateAnExistingCameraWirelessProfileInThisNetwork(networkId, wirelessProfileId, body, callback)</td>
|
3022
|
+
<td style="padding:15px">Update an existing camera wireless profile in this network.
|
3023
|
+
#### Body Parameters
|
3024
|
+
**Parameter**|**Type**|**Description**
|
3025
|
+
:-------------: |:-------------: |:-------------:
|
3026
|
+
name| string| The name of the camera wireless profile.
|
3027
|
+
ssid| object| The details of the SSID config.
|
3028
|
+
identity| object| The identity of the wireless profile. Required for creating wireless profiles in 8021x-radius auth mode.
|
3029
|
+
</td>
|
3030
|
+
<td style="padding:15px">{base_path}/{version}/networks/{pathv1}/camera/wirelessProfiles/{pathv2}?{query}</td>
|
3031
|
+
<td style="padding:15px">Yes</td>
|
3032
|
+
</tr>
|
3033
|
+
<tr>
|
3034
|
+
<td style="padding:15px">deleteAnExistingCameraWirelessProfileForThisNetwork(networkId, wirelessProfileId, callback)</td>
|
3035
|
+
<td style="padding:15px">Delete an existing camera wireless profile for this network.</td>
|
3036
|
+
<td style="padding:15px">{base_path}/{version}/networks/{pathv1}/camera/wirelessProfiles/{pathv2}?{query}</td>
|
3037
|
+
<td style="padding:15px">Yes</td>
|
3038
|
+
</tr>
|
3039
|
+
<tr>
|
3040
|
+
<td style="padding:15px">listTheOutageScheduleForTheSSID(networkId, number, callback)</td>
|
3041
|
+
<td style="padding:15px">List the outage schedule for the SSID</td>
|
3042
|
+
<td style="padding:15px">{base_path}/{version}/networks/{pathv1}/wireless/ssids/{pathv2}/schedules?{query}</td>
|
3043
|
+
<td style="padding:15px">Yes</td>
|
3044
|
+
</tr>
|
3045
|
+
<tr>
|
3046
|
+
<td style="padding:15px">updateTheOutageScheduleForTheSSID(networkId, number, body, callback)</td>
|
3047
|
+
<td style="padding:15px">Update the outage schedule for the SSID
|
3048
|
+
#### Body Parameters
|
3049
|
+
**Parameter**|**Type**|**Description**
|
3050
|
+
:-------------: |:-------------: |:-------------:
|
3051
|
+
enabled| boolean| If true, the SSID outage schedule is enabled.
|
3052
|
+
ranges| array| List of outage ranges. Has a start date and time, and end date and time. If this parameter is passed in along with rangesInSeconds parameter, this will take precedence.
|
3053
|
+
rangesInSeconds| array| List of outage ranges in seconds since Sunday at Midnight. Has a start an...(description truncated)</td>
|
3054
|
+
<td style="padding:15px">{base_path}/{version}/networks/{pathv1}/wireless/ssids/{pathv2}/schedules?{query}</td>
|
3055
|
+
<td style="padding:15px">Yes</td>
|
3056
|
+
</tr>
|
3057
|
+
<tr>
|
3058
|
+
<td style="padding:15px">returnALayer3InterfaceDHCPConfigurationForASwitch(serial, interfaceId, callback)</td>
|
3059
|
+
<td style="padding:15px">Return a layer 3 interface DHCP configuration for a switch</td>
|
3060
|
+
<td style="padding:15px">{base_path}/{version}/devices/{pathv1}/switch/routing/interfaces/{pathv2}/dhcp?{query}</td>
|
3061
|
+
<td style="padding:15px">Yes</td>
|
3062
|
+
</tr>
|
3063
|
+
<tr>
|
3064
|
+
<td style="padding:15px">updateALayer3InterfaceDHCPConfigurationForASwitch(serial, interfaceId, body, callback)</td>
|
3065
|
+
<td style="padding:15px">Update a layer 3 interface DHCP configuration for a switch
|
3066
|
+
#### Body Parameters
|
3067
|
+
**Parameter**|**Type**|**Description**
|
3068
|
+
:-------------: |:-------------: |:-------------:
|
3069
|
+
dhcpMode| string| The DHCP mode options for the switch interface ('dhcpDisabled', 'dhcpRelay' or 'dhcpServer')
|
3070
|
+
dhcpRelayServerIps| array| The DHCP relay server IPs to which DHCP packets would get relayed for the switch interface
|
3071
|
+
dhcpLeaseTime| string| The DHCP lease time config for the dhcp server running on switch interface...(description truncated)</td>
|
3072
|
+
<td style="padding:15px">{base_path}/{version}/devices/{pathv1}/switch/routing/interfaces/{pathv2}/dhcp?{query}</td>
|
3073
|
+
<td style="padding:15px">Yes</td>
|
3074
|
+
</tr>
|
3075
|
+
<tr>
|
3076
|
+
<td style="padding:15px">returnALayer3InterfaceDHCPConfigurationForASwitchStack(networkId, switchStackId, interfaceId, callback)</td>
|
3077
|
+
<td style="padding:15px">Return a layer 3 interface DHCP configuration for a switch stack</td>
|
3078
|
+
<td style="padding:15px">{base_path}/{version}/networks/{pathv1}/switch/stacks/{pathv2}/routing/interfaces/{pathv3}/dhcp?{query}</td>
|
3079
|
+
<td style="padding:15px">Yes</td>
|
3080
|
+
</tr>
|
3081
|
+
<tr>
|
3082
|
+
<td style="padding:15px">updateALayer3InterfaceDHCPConfigurationForASwitchStack(networkId, switchStackId, interfaceId, body, callback)</td>
|
3083
|
+
<td style="padding:15px">Update a layer 3 interface DHCP configuration for a switch stack
|
3084
|
+
#### Body Parameters
|
3085
|
+
**Parameter**|**Type**|**Description**
|
3086
|
+
:-------------: |:-------------: |:-------------:
|
3087
|
+
dhcpMode| string| The DHCP mode options for the switch stack interface ('dhcpDisabled', 'dhcpRelay' or 'dhcpServer')
|
3088
|
+
dhcpRelayServerIps| array| The DHCP relay server IPs to which DHCP packets would get relayed for the switch stack interface
|
3089
|
+
dhcpLeaseTime| string| The DHCP lease time config for the dhcp server running o...(description truncated)</td>
|
3090
|
+
<td style="padding:15px">{base_path}/{version}/networks/{pathv1}/switch/stacks/{pathv2}/routing/interfaces/{pathv3}/dhcp?{query}</td>
|
3091
|
+
<td style="padding:15px">Yes</td>
|
3092
|
+
</tr>
|
3093
|
+
<tr>
|
3094
|
+
<td style="padding:15px">listtheSwitchPortProfilesinanetwork(networkId, callback)</td>
|
3095
|
+
<td style="padding:15px">List the Switch Port Profiles in a network</td>
|
3096
|
+
<td style="padding:15px">{base_path}/{version}/networks/{pathv1}/switch/ports/profiles?{query}</td>
|
3097
|
+
<td style="padding:15px">Yes</td>
|
3098
|
+
</tr>
|
3099
|
+
<tr>
|
3100
|
+
<td style="padding:15px">listallprofilesinanetwork(networkId, callback)</td>
|
3101
|
+
<td style="padding:15px">List all profiles in a network</td>
|
3102
|
+
<td style="padding:15px">{base_path}/{version}/networks/{pathv1}/sm/profiles?{query}</td>
|
3103
|
+
<td style="padding:15px">Yes</td>
|
3104
|
+
</tr>
|
3105
|
+
<tr>
|
3106
|
+
<td style="padding:15px">createAnOrganizationWideAlertConfiguration(organizationId, body, callback)</td>
|
3107
|
+
<td style="padding:15px">Create an organization-wide alert configuration
|
3108
|
+
#### Body Parameters
|
3109
|
+
**Parameter**|**Type**|**Description**
|
3110
|
+
:-------------: |:-------------: |:-------------:
|
3111
|
+
type| string| The alert type
|
3112
|
+
alertCondition| object| The conditions that determine if the alert triggers
|
3113
|
+
recipients| object| List of recipients that will recieve the alert.
|
3114
|
+
networkTags| array| Networks with these tags will be monitored for the alert
|
3115
|
+
description| string| User supplied description of the alert
|
3116
|
+
|
3117
|
+
#### Supports Action Batch...(description truncated)</td>
|
3118
|
+
<td style="padding:15px">{base_path}/{version}/organizations/{pathv1}/alerts/profiles?{query}</td>
|
3119
|
+
<td style="padding:15px">Yes</td>
|
3120
|
+
</tr>
|
3121
|
+
<tr>
|
3122
|
+
<td style="padding:15px">listAllOrganizationWideAlertConfigurations(organizationId, callback)</td>
|
3123
|
+
<td style="padding:15px">List all organization-wide alert configurations</td>
|
3124
|
+
<td style="padding:15px">{base_path}/{version}/organizations/{pathv1}/alerts/profiles?{query}</td>
|
3125
|
+
<td style="padding:15px">Yes</td>
|
3126
|
+
</tr>
|
3127
|
+
<tr>
|
3128
|
+
<td style="padding:15px">removesAnOrganizationWideAlertConfig(organizationId, alertConfigId, callback)</td>
|
3129
|
+
<td style="padding:15px">Removes an organization-wide alert config
|
3130
|
+
#### Supports Action Batches
|
3131
|
+
|
3132
|
+
**Resource**|**Operation**
|
3133
|
+
:-------------: |:-------------:
|
3134
|
+
`/organizations/{organizationId}/alerts/profiles/{alertConfigId}` | destroy
|
3135
|
+
|
3136
|
+
</td>
|
3137
|
+
<td style="padding:15px">{base_path}/{version}/organizations/{pathv1}/alerts/profiles/{pathv2}?{query}</td>
|
3138
|
+
<td style="padding:15px">Yes</td>
|
3139
|
+
</tr>
|
3140
|
+
<tr>
|
3141
|
+
<td style="padding:15px">updateAnOrganizationWideAlertConfig(organizationId, alertConfigId, body, callback)</td>
|
3142
|
+
<td style="padding:15px">Update an organization-wide alert config
|
3143
|
+
#### Body Parameters
|
3144
|
+
**Parameter**|**Type**|**Description**
|
3145
|
+
:-------------: |:-------------: |:-------------:
|
3146
|
+
enabled| boolean| Is the alert config enabled
|
3147
|
+
type| string| The alert type
|
3148
|
+
alertCondition| object| The conditions that determine if the alert triggers
|
3149
|
+
recipients| object| List of recipients that will recieve the alert.
|
3150
|
+
networkTags| array| Networks with these tags will be monitored for the alert
|
3151
|
+
description| string| User supplied description o...(description truncated)</td>
|
3152
|
+
<td style="padding:15px">{base_path}/{version}/organizations/{pathv1}/alerts/profiles/{pathv2}?{query}</td>
|
3153
|
+
<td style="padding:15px">Yes</td>
|
3154
|
+
</tr>
|
3155
|
+
<tr>
|
3156
|
+
<td style="padding:15px">listtheswitchportsinanorganizationbyswitch(organizationId, callback)</td>
|
3157
|
+
<td style="padding:15px">List the switchports in an organization by switch</td>
|
3158
|
+
<td style="padding:15px">{base_path}/{version}/organizations/{pathv1}/switch/ports/bySwitch?{query}</td>
|
3159
|
+
<td style="padding:15px">Yes</td>
|
3160
|
+
</tr>
|
3161
|
+
<tr>
|
3162
|
+
<td style="padding:15px">listLayer3InterfacesForASwitch(serial, callback)</td>
|
3163
|
+
<td style="padding:15px">List layer 3 interfaces for a switch. Those for a stack may be found under switch stack routing.</td>
|
3164
|
+
<td style="padding:15px">{base_path}/{version}/devices/{pathv1}/switch/routing/interfaces?{query}</td>
|
3165
|
+
<td style="padding:15px">Yes</td>
|
3166
|
+
</tr>
|
3167
|
+
<tr>
|
3168
|
+
<td style="padding:15px">createALayer3InterfaceForASwitch(serial, body, callback)</td>
|
3169
|
+
<td style="padding:15px">Create a layer 3 interface for a switch
|
3170
|
+
#### Body Parameters
|
3171
|
+
**Parameter**|**Type**|**Description**
|
3172
|
+
:-------------: |:-------------: |:-------------:
|
3173
|
+
name| string| A friendly name or description for the interface or VLAN.
|
3174
|
+
subnet| string| The network that this routed interface is on, in CIDR notation (ex. 10.1.1.0/24).
|
3175
|
+
interfaceIp| string| The IP address this switch will use for layer 3 routing on this VLAN or subnet. This cannot be the same as the switch's management IP.
|
3176
|
+
multicastRo...(description truncated)</td>
|
3177
|
+
<td style="padding:15px">{base_path}/{version}/devices/{pathv1}/switch/routing/interfaces?{query}</td>
|
3178
|
+
<td style="padding:15px">Yes</td>
|
3179
|
+
</tr>
|
3180
|
+
<tr>
|
3181
|
+
<td style="padding:15px">returnALayer3InterfaceForASwitch(serial, interfaceId, callback)</td>
|
3182
|
+
<td style="padding:15px">Return a layer 3 interface for a switch</td>
|
3183
|
+
<td style="padding:15px">{base_path}/{version}/devices/{pathv1}/switch/routing/interfaces/{pathv2}?{query}</td>
|
3184
|
+
<td style="padding:15px">Yes</td>
|
3185
|
+
</tr>
|
3186
|
+
<tr>
|
3187
|
+
<td style="padding:15px">updateALayer3InterfaceForASwitch(serial, interfaceId, body, callback)</td>
|
3188
|
+
<td style="padding:15px">Update a layer 3 interface for a switch
|
3189
|
+
#### Body Parameters
|
3190
|
+
**Parameter**|**Type**|**Description**
|
3191
|
+
:-------------: |:-------------: |:-------------:
|
3192
|
+
name| string| A friendly name or description for the interface or VLAN.
|
3193
|
+
subnet| string| The network that this routed interface is on, in CIDR notation (ex. 10.1.1.0/24).
|
3194
|
+
interfaceIp| string| The IP address this switch will use for layer 3 routing on this VLAN or subnet. This cannot be the same as the switch's management IP.
|
3195
|
+
multicastRo...(description truncated)</td>
|
3196
|
+
<td style="padding:15px">{base_path}/{version}/devices/{pathv1}/switch/routing/interfaces/{pathv2}?{query}</td>
|
3197
|
+
<td style="padding:15px">Yes</td>
|
3198
|
+
</tr>
|
3199
|
+
<tr>
|
3200
|
+
<td style="padding:15px">deleteALayer3InterfaceFromTheSwitch(serial, interfaceId, callback)</td>
|
3201
|
+
<td style="padding:15px">Delete a layer 3 interface from the switch
|
3202
|
+
#### Supports Action Batches
|
3203
|
+
|
3204
|
+
**Resource**|**Operation**
|
3205
|
+
:-------------: |:-------------:
|
3206
|
+
`/devices/{serial}/switch/routing/interfaces/{interfaceId}` | destroy
|
3207
|
+
|
3208
|
+
</td>
|
3209
|
+
<td style="padding:15px">{base_path}/{version}/devices/{pathv1}/switch/routing/interfaces/{pathv2}?{query}</td>
|
3210
|
+
<td style="padding:15px">Yes</td>
|
3211
|
+
</tr>
|
3212
|
+
<tr>
|
3213
|
+
<td style="padding:15px">listLayer3InterfacesForASwitchStack(networkId, switchStackId, callback)</td>
|
3214
|
+
<td style="padding:15px">List layer 3 interfaces for a switch stack</td>
|
3215
|
+
<td style="padding:15px">{base_path}/{version}/networks/{pathv1}/switch/stacks/{pathv2}/routing/interfaces?{query}</td>
|
3216
|
+
<td style="padding:15px">Yes</td>
|
3217
|
+
</tr>
|
3218
|
+
<tr>
|
3219
|
+
<td style="padding:15px">createALayer3InterfaceForASwitchStack(networkId, switchStackId, body, callback)</td>
|
3220
|
+
<td style="padding:15px">Create a layer 3 interface for a switch stack
|
3221
|
+
#### Body Parameters
|
3222
|
+
**Parameter**|**Type**|**Description**
|
3223
|
+
:-------------: |:-------------: |:-------------:
|
3224
|
+
name| string| A friendly name or description for the interface or VLAN.
|
3225
|
+
subnet| string| The network that this routed interface is on, in CIDR notation (ex. 10.1.1.0/24).
|
3226
|
+
interfaceIp| string| The IP address this switch stack will use for layer 3 routing on this VLAN or subnet. This cannot be the same as the switch's management IP.
|
3227
|
+
multica...(description truncated)</td>
|
3228
|
+
<td style="padding:15px">{base_path}/{version}/networks/{pathv1}/switch/stacks/{pathv2}/routing/interfaces?{query}</td>
|
3229
|
+
<td style="padding:15px">Yes</td>
|
3230
|
+
</tr>
|
3231
|
+
<tr>
|
3232
|
+
<td style="padding:15px">returnALayer3InterfaceFromASwitchStack(networkId, switchStackId, interfaceId, callback)</td>
|
3233
|
+
<td style="padding:15px">Return a layer 3 interface from a switch stack</td>
|
3234
|
+
<td style="padding:15px">{base_path}/{version}/networks/{pathv1}/switch/stacks/{pathv2}/routing/interfaces/{pathv3}?{query}</td>
|
3235
|
+
<td style="padding:15px">Yes</td>
|
3236
|
+
</tr>
|
3237
|
+
<tr>
|
3238
|
+
<td style="padding:15px">updateALayer3InterfaceForASwitchStack(networkId, switchStackId, interfaceId, body, callback)</td>
|
3239
|
+
<td style="padding:15px">Update a layer 3 interface for a switch stack
|
3240
|
+
#### Body Parameters
|
3241
|
+
**Parameter**|**Type**|**Description**
|
3242
|
+
:-------------: |:-------------: |:-------------:
|
3243
|
+
name| string| A friendly name or description for the interface or VLAN.
|
3244
|
+
subnet| string| The network that this routed interface is on, in CIDR notation (ex. 10.1.1.0/24).
|
3245
|
+
interfaceIp| string| The IP address this switch stack will use for layer 3 routing on this VLAN or subnet. This cannot be the same as the switch's management IP.
|
3246
|
+
multica...(description truncated)</td>
|
3247
|
+
<td style="padding:15px">{base_path}/{version}/networks/{pathv1}/switch/stacks/{pathv2}/routing/interfaces/{pathv3}?{query}</td>
|
3248
|
+
<td style="padding:15px">Yes</td>
|
3249
|
+
</tr>
|
3250
|
+
<tr>
|
3251
|
+
<td style="padding:15px">deleteALayer3InterfaceFromASwitchStack(networkId, switchStackId, interfaceId, callback)</td>
|
3252
|
+
<td style="padding:15px">Delete a layer 3 interface from a switch stack
|
3253
|
+
#### Supports Action Batches
|
3254
|
+
|
3255
|
+
**Resource**|**Operation**
|
3256
|
+
:-------------: |:-------------:
|
3257
|
+
`/networks/{networkId}/switch/stacks/{switchStackId}/routing/interfaces/{interfaceId}` | destroy
|
3258
|
+
|
3259
|
+
</td>
|
3260
|
+
<td style="padding:15px">{base_path}/{version}/networks/{pathv1}/switch/stacks/{pathv2}/routing/interfaces/{pathv3}?{query}</td>
|
3261
|
+
<td style="padding:15px">Yes</td>
|
3262
|
+
</tr>
|
3263
|
+
<tr>
|
3264
|
+
<td style="padding:15px">listMulticastRendezvousPoints(networkId, callback)</td>
|
3265
|
+
<td style="padding:15px">List multicast rendezvous points</td>
|
3266
|
+
<td style="padding:15px">{base_path}/{version}/networks/{pathv1}/switch/routing/multicast/rendezvousPoints?{query}</td>
|
3267
|
+
<td style="padding:15px">Yes</td>
|
3268
|
+
</tr>
|
3269
|
+
<tr>
|
3270
|
+
<td style="padding:15px">createAMulticastRendezvousPoint(networkId, body, callback)</td>
|
3271
|
+
<td style="padding:15px">Create a multicast rendezvous point
|
3272
|
+
#### Body Parameters
|
3273
|
+
**Parameter**|**Type**|**Description**
|
3274
|
+
:-------------: |:-------------: |:-------------:
|
3275
|
+
interfaceIp| string| The IP address of the interface where the RP needs to be created.
|
3276
|
+
multicastGroup| string| 'Any', or the IP address of a multicast group
|
3277
|
+
|
3278
|
+
#### Supports Action Batches
|
3279
|
+
|
3280
|
+
**Resource**|**Operation**
|
3281
|
+
:-------------: |:-------------:
|
3282
|
+
`/networks/{networkId}/switch/routing/multicast/rendezvousPoints` | create
|
3283
|
+
|
3284
|
+
</td>
|
3285
|
+
<td style="padding:15px">{base_path}/{version}/networks/{pathv1}/switch/routing/multicast/rendezvousPoints?{query}</td>
|
3286
|
+
<td style="padding:15px">Yes</td>
|
3287
|
+
</tr>
|
3288
|
+
<tr>
|
3289
|
+
<td style="padding:15px">returnAMulticastRendezvousPoint(networkId, rendezvousPointId, callback)</td>
|
3290
|
+
<td style="padding:15px">Return a multicast rendezvous point</td>
|
3291
|
+
<td style="padding:15px">{base_path}/{version}/networks/{pathv1}/switch/routing/multicast/rendezvousPoints/{pathv2}?{query}</td>
|
3292
|
+
<td style="padding:15px">Yes</td>
|
3293
|
+
</tr>
|
3294
|
+
<tr>
|
3295
|
+
<td style="padding:15px">deleteAMulticastRendezvousPoint(networkId, rendezvousPointId, callback)</td>
|
3296
|
+
<td style="padding:15px">Delete a multicast rendezvous point
|
3297
|
+
#### Supports Action Batches
|
3298
|
+
|
3299
|
+
**Resource**|**Operation**
|
3300
|
+
:-------------: |:-------------:
|
3301
|
+
`/networks/{networkId}/switch/routing/multicast/rendezvousPoints/{rendezvousPointId}` | destroy
|
3302
|
+
|
3303
|
+
</td>
|
3304
|
+
<td style="padding:15px">{base_path}/{version}/networks/{pathv1}/switch/routing/multicast/rendezvousPoints/{pathv2}?{query}</td>
|
3305
|
+
<td style="padding:15px">Yes</td>
|
3306
|
+
</tr>
|
3307
|
+
<tr>
|
3308
|
+
<td style="padding:15px">updateAMulticastRendezvousPoint(networkId, rendezvousPointId, body, callback)</td>
|
3309
|
+
<td style="padding:15px">Update a multicast rendezvous point
|
3310
|
+
#### Body Parameters
|
3311
|
+
**Parameter**|**Type**|**Description**
|
3312
|
+
:-------------: |:-------------: |:-------------:
|
3313
|
+
interfaceIp| string| The IP address of the interface to use
|
3314
|
+
multicastGroup| string| 'Any', or the IP address of a multicast group
|
3315
|
+
|
3316
|
+
#### Supports Action Batches
|
3317
|
+
|
3318
|
+
**Resource**|**Operation**
|
3319
|
+
:-------------: |:-------------:
|
3320
|
+
`/networks/{networkId}/switch/routing/multicast/rendezvousPoints/{rendezvousPointId}` | update
|
3321
|
+
|
3322
|
+
</td>
|
3323
|
+
<td style="padding:15px">{base_path}/{version}/networks/{pathv1}/switch/routing/multicast/rendezvousPoints/{pathv2}?{query}</td>
|
3324
|
+
<td style="padding:15px">Yes</td>
|
3325
|
+
</tr>
|
3326
|
+
<tr>
|
3327
|
+
<td style="padding:15px">returnMulticastSettingsForANetwork(networkId, callback)</td>
|
3328
|
+
<td style="padding:15px">Return multicast settings for a network</td>
|
3329
|
+
<td style="padding:15px">{base_path}/{version}/networks/{pathv1}/switch/routing/multicast?{query}</td>
|
3330
|
+
<td style="padding:15px">Yes</td>
|
3331
|
+
</tr>
|
3332
|
+
<tr>
|
3333
|
+
<td style="padding:15px">updateMulticastSettingsForANetwork(networkId, body, callback)</td>
|
3334
|
+
<td style="padding:15px">Update multicast settings for a network
|
3335
|
+
#### Body Parameters
|
3336
|
+
**Parameter**|**Type**|**Description**
|
3337
|
+
:-------------: |:-------------: |:-------------:
|
3338
|
+
defaultSettings| object| Default multicast setting for entire network. IGMP snooping and Flood unknown multicast traffic settings are enabled by default.
|
3339
|
+
overrides| array| Array of paired switches/stacks/profiles and corresponding multicast settings. An empty array will clear the multicast settings.
|
3340
|
+
|
3341
|
+
#### Supports Action Batches
|
3342
|
+
|
3343
|
+
**Resource**|...(description truncated)</td>
|
3344
|
+
<td style="padding:15px">{base_path}/{version}/networks/{pathv1}/switch/routing/multicast?{query}</td>
|
3345
|
+
<td style="padding:15px">Yes</td>
|
3346
|
+
</tr>
|
3347
|
+
<tr>
|
3348
|
+
<td style="padding:15px">returnLayer3OSPFRoutingConfiguration(networkId, callback)</td>
|
3349
|
+
<td style="padding:15px">Return layer 3 OSPF routing configuration</td>
|
3350
|
+
<td style="padding:15px">{base_path}/{version}/networks/{pathv1}/switch/routing/ospf?{query}</td>
|
3351
|
+
<td style="padding:15px">Yes</td>
|
3352
|
+
</tr>
|
3353
|
+
<tr>
|
3354
|
+
<td style="padding:15px">updateLayer3OSPFRoutingConfiguration(networkId, body, callback)</td>
|
3355
|
+
<td style="padding:15px">Update layer 3 OSPF routing configuration
|
3356
|
+
#### Body Parameters
|
3357
|
+
**Parameter**|**Type**|**Description**
|
3358
|
+
:-------------: |:-------------: |:-------------:
|
3359
|
+
enabled| boolean| Boolean value to enable or disable OSPF routing. OSPF routing is disabled by default.
|
3360
|
+
helloTimerInSeconds| integer| Time interval in seconds at which hello packet will be sent to OSPF neighbors to maintain connectivity. Value must be between 1 and 255. Default is 10 seconds.
|
3361
|
+
deadTimerInSeconds| integer| Time interval to det...(description truncated)</td>
|
3362
|
+
<td style="padding:15px">{base_path}/{version}/networks/{pathv1}/switch/routing/ospf?{query}</td>
|
3363
|
+
<td style="padding:15px">Yes</td>
|
3364
|
+
</tr>
|
3365
|
+
<tr>
|
3366
|
+
<td style="padding:15px">returnTheSwitchAlternateManagementInterfaceForTheNetwork(networkId, callback)</td>
|
3367
|
+
<td style="padding:15px">Return the switch alternate management interface for the network</td>
|
3368
|
+
<td style="padding:15px">{base_path}/{version}/networks/{pathv1}/switch/alternateManagementInterface?{query}</td>
|
3369
|
+
<td style="padding:15px">Yes</td>
|
3370
|
+
</tr>
|
3371
|
+
<tr>
|
3372
|
+
<td style="padding:15px">updateTheSwitchAlternateManagementInterfaceForTheNetwork(networkId, body, callback)</td>
|
3373
|
+
<td style="padding:15px">Update the switch alternate management interface for the network
|
3374
|
+
#### Body Parameters
|
3375
|
+
**Parameter**|**Type**|**Description**
|
3376
|
+
:-------------: |:-------------: |:-------------:
|
3377
|
+
enabled| boolean| Boolean value to enable or disable AMI configuration. If enabled, VLAN and protocols must be set
|
3378
|
+
vlanId| integer| Alternate management VLAN, must be between 1 and 4094
|
3379
|
+
protocols| array| Can be one or more of the following values: 'radius', 'snmp' or 'syslog'
|
3380
|
+
switches| array| Array of switch serial num...(description truncated)</td>
|
3381
|
+
<td style="padding:15px">{base_path}/{version}/networks/{pathv1}/switch/alternateManagementInterface?{query}</td>
|
3382
|
+
<td style="padding:15px">Yes</td>
|
3383
|
+
</tr>
|
3384
|
+
<tr>
|
3385
|
+
<td style="padding:15px">returnAlternateManagementInterfaceAndDevicesWithIPAssigned(networkId, callback)</td>
|
3386
|
+
<td style="padding:15px">Return alternate management interface and devices with IP assigned</td>
|
3387
|
+
<td style="padding:15px">{base_path}/{version}/networks/{pathv1}/wireless/alternateManagementInterface?{query}</td>
|
3388
|
+
<td style="padding:15px">Yes</td>
|
3389
|
+
</tr>
|
3390
|
+
<tr>
|
3391
|
+
<td style="padding:15px">updateAlternateManagementInterfaceAndDeviceStaticIP(networkId, body, callback)</td>
|
3392
|
+
<td style="padding:15px">Update alternate management interface and device static IP
|
3393
|
+
#### Body Parameters
|
3394
|
+
**Parameter**|**Type**|**Description**
|
3395
|
+
:-------------: |:-------------: |:-------------:
|
3396
|
+
enabled| boolean| Boolean value to enable or disable alternate management interface
|
3397
|
+
vlanId| integer| Alternate management interface VLAN, must be between 1 and 4094
|
3398
|
+
protocols| array| Can be one or more of the following values: 'radius', 'snmp', 'syslog' or 'ldap'
|
3399
|
+
accessPoints| array| Array of access point serial number and I...(description truncated)</td>
|
3400
|
+
<td style="padding:15px">{base_path}/{version}/networks/{pathv1}/wireless/alternateManagementInterface?{query}</td>
|
3401
|
+
<td style="padding:15px">Yes</td>
|
3402
|
+
</tr>
|
3403
|
+
<tr>
|
3404
|
+
<td style="padding:15px">returnthenetworkSDHCPv4serversseenwithintheselectedtimeframeDefault1day(networkId, callback)</td>
|
3405
|
+
<td style="padding:15px">Return the network's DHCPv4 servers seen within the selected timeframe (default 1 day)</td>
|
3406
|
+
<td style="padding:15px">{base_path}/{version}/networks/{pathv1}/switch/dhcp/v4/servers/seen?{query}</td>
|
3407
|
+
<td style="padding:15px">Yes</td>
|
3408
|
+
</tr>
|
3409
|
+
<tr>
|
3410
|
+
<td style="padding:15px">returnTheListOfServersTrustedByDynamicARPInspectionOnThisNetwork(networkId, callback)</td>
|
3411
|
+
<td style="padding:15px">Return the list of servers trusted by Dynamic ARP Inspection on this network. These are also known as whitelisted snoop entries</td>
|
3412
|
+
<td style="padding:15px">{base_path}/{version}/networks/{pathv1}/switch/dhcpServerPolicy/arpInspection/trustedServers?{query}</td>
|
3413
|
+
<td style="padding:15px">Yes</td>
|
3414
|
+
</tr>
|
3415
|
+
<tr>
|
3416
|
+
<td style="padding:15px">addAServerToBeTrustedByDynamicARPInspectionOnThisNetwork(networkId, body, callback)</td>
|
3417
|
+
<td style="padding:15px">Add a server to be trusted by Dynamic ARP Inspection on this network
|
3418
|
+
#### Body Parameters
|
3419
|
+
**Parameter**|**Type**|**Description**
|
3420
|
+
:-------------: |:-------------: |:-------------:
|
3421
|
+
mac| string| The mac address of the trusted server being added
|
3422
|
+
vlan| integer| The VLAN of the trusted server being added. It must be between 1 and 4094
|
3423
|
+
ipv4| object| The IPv4 attributes of the trusted server being added
|
3424
|
+
|
3425
|
+
#### Supports Action Batches
|
3426
|
+
|
3427
|
+
**Resource**|**Operation**
|
3428
|
+
:-------------: |:-------------:
|
3429
|
+
`/net...(description truncated)</td>
|
3430
|
+
<td style="padding:15px">{base_path}/{version}/networks/{pathv1}/switch/dhcpServerPolicy/arpInspection/trustedServers?{query}</td>
|
3431
|
+
<td style="padding:15px">Yes</td>
|
3432
|
+
</tr>
|
3433
|
+
<tr>
|
3434
|
+
<td style="padding:15px">updateAServerThatIsTrustedByDynamicARPInspectionOnThisNetwork(networkId, trustedServerId, body, callback)</td>
|
3435
|
+
<td style="padding:15px">Update a server that is trusted by Dynamic ARP Inspection on this network
|
3436
|
+
#### Body Parameters
|
3437
|
+
**Parameter**|**Type**|**Description**
|
3438
|
+
:-------------: |:-------------: |:-------------:
|
3439
|
+
mac| string| The updated mac address of the trusted server
|
3440
|
+
vlan| integer| The updated VLAN of the trusted server. It must be between 1 and 4094
|
3441
|
+
ipv4| object| The updated IPv4 attributes of the trusted server
|
3442
|
+
|
3443
|
+
#### Supports Action Batches
|
3444
|
+
|
3445
|
+
**Resource**|**Operation**
|
3446
|
+
:-------------: |:-------------:
|
3447
|
+
`/networks/{...(description truncated)</td>
|
3448
|
+
<td style="padding:15px">{base_path}/{version}/networks/{pathv1}/switch/dhcpServerPolicy/arpInspection/trustedServers/{pathv2}?{query}</td>
|
3449
|
+
<td style="padding:15px">Yes</td>
|
3450
|
+
</tr>
|
3451
|
+
<tr>
|
3452
|
+
<td style="padding:15px">removeAServerFromBeingTrustedByDynamicARPInspectionOnThisNetwork(networkId, trustedServerId, callback)</td>
|
3453
|
+
<td style="padding:15px">Remove a server from being trusted by Dynamic ARP Inspection on this network
|
3454
|
+
#### Supports Action Batches
|
3455
|
+
|
3456
|
+
**Resource**|**Operation**
|
3457
|
+
:-------------: |:-------------:
|
3458
|
+
`/networks/{networkId}/switch/dhcpServerPolicy/arpInspection/trustedServers/{trustedServerId}` | destroy
|
3459
|
+
|
3460
|
+
</td>
|
3461
|
+
<td style="padding:15px">{base_path}/{version}/networks/{pathv1}/switch/dhcpServerPolicy/arpInspection/trustedServers/{pathv2}?{query}</td>
|
3462
|
+
<td style="padding:15px">Yes</td>
|
3463
|
+
</tr>
|
3464
|
+
<tr>
|
3465
|
+
<td style="padding:15px">returnthedevicesthathaveaDynamicARPInspectionwarningandtheirwarnings(networkId, callback)</td>
|
3466
|
+
<td style="padding:15px">Return the devices that have a Dynamic ARP Inspection warning and their warnings</td>
|
3467
|
+
<td style="padding:15px">{base_path}/{version}/networks/{pathv1}/switch/dhcpServerPolicy/arpInspection/warnings/byDevice?{query}</td>
|
3468
|
+
<td style="padding:15px">Yes</td>
|
3469
|
+
</tr>
|
3470
|
+
<tr>
|
3471
|
+
<td style="padding:15px">listthepowerstatusinformationfordevicesinanorganization(organizationId, callback)</td>
|
3472
|
+
<td style="padding:15px">List the power status information for devices in an organization. The data returned by this endpoint is updated every 5 minutes.</td>
|
3473
|
+
<td style="padding:15px">{base_path}/{version}/organizations/{pathv1}/devices/powerModules/statuses/byDevice?{query}</td>
|
3474
|
+
<td style="padding:15px">Yes</td>
|
3475
|
+
</tr>
|
3476
|
+
<tr>
|
3477
|
+
<td style="padding:15px">listthecurrentuplinkaddressesfordevicesinanorganization(organizationId, callback)</td>
|
3478
|
+
<td style="padding:15px">List the current uplink addresses for devices in an organization.</td>
|
3479
|
+
<td style="padding:15px">{base_path}/{version}/organizations/{pathv1}/devices/uplinks/addresses/byDevice?{query}</td>
|
3480
|
+
<td style="padding:15px">Yes</td>
|
3481
|
+
</tr>
|
3482
|
+
<tr>
|
3483
|
+
<td style="padding:15px">cloneportLevelandsomeswitchLevelconfigurationsettingsfromasourceswitchtooneormoretargetswitches(organizationId, body, callback)</td>
|
3484
|
+
<td style="padding:15px">Clone port-level and some switch-level configuration settings from a source switch to one or more target switches. Cloned settings include: Aggregation Groups, Power Settings, Multicast Settings, MTU Configuration, STP Bridge priority, Port Mirroring</td>
|
3485
|
+
<td style="padding:15px">{base_path}/{version}/organizations/{pathv1}/switch/devices/clone?{query}</td>
|
3486
|
+
<td style="padding:15px">Yes</td>
|
3487
|
+
</tr>
|
3488
|
+
<tr>
|
3489
|
+
<td style="padding:15px">returnASingleDeviceFromTheInventoryOfAnOrganization(organizationId, serial, callback)</td>
|
3490
|
+
<td style="padding:15px">Return a single device from the inventory of an organization</td>
|
3491
|
+
<td style="padding:15px">{base_path}/{version}/organizations/{pathv1}/inventory/devices/{pathv2}?{query}</td>
|
3492
|
+
<td style="padding:15px">Yes</td>
|
3493
|
+
</tr>
|
3494
|
+
<tr>
|
3495
|
+
<td style="padding:15px">returnTheBillingSettingsOfThisNetwork(networkId, callback)</td>
|
3496
|
+
<td style="padding:15px">Return the billing settings of this network</td>
|
3497
|
+
<td style="padding:15px">{base_path}/{version}/networks/{pathv1}/wireless/billing?{query}</td>
|
3498
|
+
<td style="padding:15px">Yes</td>
|
3499
|
+
</tr>
|
3500
|
+
<tr>
|
3501
|
+
<td style="padding:15px">updateTheBillingSettings(networkId, body, callback)</td>
|
3502
|
+
<td style="padding:15px">Update the billing settings
|
3503
|
+
#### Body Parameters
|
3504
|
+
**Parameter**|**Type**|**Description**
|
3505
|
+
:-------------: |:-------------: |:-------------:
|
3506
|
+
currency| string| The currency code of this node group's billing plans
|
3507
|
+
plans| array| Array of billing plans in the node group. (Can configure a maximum of 5)
|
3508
|
+
|
3509
|
+
#### Supports Action Batches
|
3510
|
+
|
3511
|
+
**Resource**|**Operation**
|
3512
|
+
:-------------: |:-------------:
|
3513
|
+
`/networks/{networkId}/wireless/billing` | update
|
3514
|
+
|
3515
|
+
</td>
|
3516
|
+
<td style="padding:15px">{base_path}/{version}/networks/{pathv1}/wireless/billing?{query}</td>
|
3517
|
+
<td style="padding:15px">Yes</td>
|
3518
|
+
</tr>
|
3519
|
+
<tr>
|
3520
|
+
<td style="padding:15px">listTheBonjourForwardingSettingAndRulesForTheSSID(networkId, number, callback)</td>
|
3521
|
+
<td style="padding:15px">List the Bonjour forwarding setting and rules for the SSID</td>
|
3522
|
+
<td style="padding:15px">{base_path}/{version}/networks/{pathv1}/wireless/ssids/{pathv2}/bonjourForwarding?{query}</td>
|
3523
|
+
<td style="padding:15px">Yes</td>
|
3524
|
+
</tr>
|
3525
|
+
<tr>
|
3526
|
+
<td style="padding:15px">updateTheBonjourForwardingSettingAndRulesForTheSSID(networkId, number, body, callback)</td>
|
3527
|
+
<td style="padding:15px">Update the bonjour forwarding setting and rules for the SSID
|
3528
|
+
#### Body Parameters
|
3529
|
+
**Parameter**|**Type**|**Description**
|
3530
|
+
:-------------: |:-------------: |:-------------:
|
3531
|
+
enabled| boolean| If true, Bonjour forwarding is enabled on this SSID.
|
3532
|
+
rules| array| List of bonjour forwarding rules.
|
3533
|
+
|
3534
|
+
#### Supports Action Batches
|
3535
|
+
|
3536
|
+
**Resource**|**Operation**
|
3537
|
+
:-------------: |:-------------:
|
3538
|
+
`/networks/{networkId}/wireless/ssids/{number}/bonjourForwarding` | update
|
3539
|
+
|
3540
|
+
</td>
|
3541
|
+
<td style="padding:15px">{base_path}/{version}/networks/{pathv1}/wireless/ssids/{pathv2}/bonjourForwarding?{query}</td>
|
3542
|
+
<td style="padding:15px">Yes</td>
|
3543
|
+
</tr>
|
3544
|
+
<tr>
|
3545
|
+
<td style="padding:15px">listAllIdentityPSKsInAWirelessNetwork(networkId, number, callback)</td>
|
3546
|
+
<td style="padding:15px">List all Identity PSKs in a wireless network</td>
|
3547
|
+
<td style="padding:15px">{base_path}/{version}/networks/{pathv1}/wireless/ssids/{pathv2}/identityPsks?{query}</td>
|
3548
|
+
<td style="padding:15px">Yes</td>
|
3549
|
+
</tr>
|
3550
|
+
<tr>
|
3551
|
+
<td style="padding:15px">createAnIdentityPSK(networkId, number, body, callback)</td>
|
3552
|
+
<td style="padding:15px">Create an Identity PSK
|
3553
|
+
#### Body Parameters
|
3554
|
+
**Parameter**|**Type**|**Description**
|
3555
|
+
:-------------: |:-------------: |:-------------:
|
3556
|
+
name| string| The name of the Identity PSK
|
3557
|
+
passphrase| string| The passphrase for client authentication. If left blank, one will be auto-generated.
|
3558
|
+
groupPolicyId| string| The group policy to be applied to clients
|
3559
|
+
|
3560
|
+
#### Supports Action Batches
|
3561
|
+
|
3562
|
+
**Resource**|**Operation**
|
3563
|
+
:-------------: |:-------------:
|
3564
|
+
`/networks/{networkId}/wireless/ssids/{number}/identityPsk...(description truncated)</td>
|
3565
|
+
<td style="padding:15px">{base_path}/{version}/networks/{pathv1}/wireless/ssids/{pathv2}/identityPsks?{query}</td>
|
3566
|
+
<td style="padding:15px">Yes</td>
|
3567
|
+
</tr>
|
3568
|
+
<tr>
|
3569
|
+
<td style="padding:15px">returnAnIdentityPSK(networkId, number, identityPskId, callback)</td>
|
3570
|
+
<td style="padding:15px">Return an Identity PSK</td>
|
3571
|
+
<td style="padding:15px">{base_path}/{version}/networks/{pathv1}/wireless/ssids/{pathv2}/identityPsks/{pathv3}?{query}</td>
|
3572
|
+
<td style="padding:15px">Yes</td>
|
3573
|
+
</tr>
|
3574
|
+
<tr>
|
3575
|
+
<td style="padding:15px">updateAnIdentityPSK(networkId, number, identityPskId, body, callback)</td>
|
3576
|
+
<td style="padding:15px">Update an Identity PSK
|
3577
|
+
#### Body Parameters
|
3578
|
+
**Parameter**|**Type**|**Description**
|
3579
|
+
:-------------: |:-------------: |:-------------:
|
3580
|
+
name| string| The name of the Identity PSK
|
3581
|
+
passphrase| string| The passphrase for client authentication
|
3582
|
+
groupPolicyId| string| The group policy to be applied to clients
|
3583
|
+
|
3584
|
+
#### Supports Action Batches
|
3585
|
+
|
3586
|
+
**Resource**|**Operation**
|
3587
|
+
:-------------: |:-------------:
|
3588
|
+
`/networks/{networkId}/wireless/ssids/{number}/identityPsks/{identityPskId}` | update
|
3589
|
+
|
3590
|
+
</td>
|
3591
|
+
<td style="padding:15px">{base_path}/{version}/networks/{pathv1}/wireless/ssids/{pathv2}/identityPsks/{pathv3}?{query}</td>
|
3592
|
+
<td style="padding:15px">Yes</td>
|
3593
|
+
</tr>
|
3594
|
+
<tr>
|
3595
|
+
<td style="padding:15px">deleteAnIdentityPSK(networkId, number, identityPskId, callback)</td>
|
3596
|
+
<td style="padding:15px">Delete an Identity PSK
|
3597
|
+
#### Supports Action Batches
|
3598
|
+
|
3599
|
+
**Resource**|**Operation**
|
3600
|
+
:-------------: |:-------------:
|
3601
|
+
`/networks/{networkId}/wireless/ssids/{number}/identityPsks/{identityPskId}` | destroy
|
3602
|
+
|
3603
|
+
</td>
|
3604
|
+
<td style="padding:15px">{base_path}/{version}/networks/{pathv1}/wireless/ssids/{pathv2}/identityPsks/{pathv3}?{query}</td>
|
3605
|
+
<td style="padding:15px">Yes</td>
|
3606
|
+
</tr>
|
3607
|
+
<tr>
|
3608
|
+
<td style="padding:15px">listTheVPNSettingsForTheSSID(networkId, number, callback)</td>
|
3609
|
+
<td style="padding:15px">List the VPN settings for the SSID.</td>
|
3610
|
+
<td style="padding:15px">{base_path}/{version}/networks/{pathv1}/wireless/ssids/{pathv2}/vpn?{query}</td>
|
3611
|
+
<td style="padding:15px">Yes</td>
|
3612
|
+
</tr>
|
3613
|
+
<tr>
|
3614
|
+
<td style="padding:15px">updateTheVPNSettingsForTheSSID(networkId, number, body, callback)</td>
|
3615
|
+
<td style="padding:15px">Update the VPN settings for the SSID
|
3616
|
+
#### Body Parameters
|
3617
|
+
**Parameter**|**Type**|**Description**
|
3618
|
+
:-------------: |:-------------: |:-------------:
|
3619
|
+
concentrator| object| The VPN concentrator settings for this SSID.
|
3620
|
+
splitTunnel| object| The VPN split tunnel settings for this SSID.
|
3621
|
+
failover| object| Secondary VPN concentrator settings. This is only used when two VPN concentrators are configured on the SSID.
|
3622
|
+
|
3623
|
+
#### Supports Action Batches
|
3624
|
+
|
3625
|
+
**Resource**|**Operation**
|
3626
|
+
:-------------: |:-----------...(description truncated)</td>
|
3627
|
+
<td style="padding:15px">{base_path}/{version}/networks/{pathv1}/wireless/ssids/{pathv2}/vpn?{query}</td>
|
3628
|
+
<td style="padding:15px">Yes</td>
|
3629
|
+
</tr>
|
3630
|
+
<tr>
|
3631
|
+
<td style="padding:15px">returnAPchannelutilizationovertimeforadeviceornetworkclient(networkId, callback)</td>
|
3632
|
+
<td style="padding:15px">Return AP channel utilization over time for a device or network client</td>
|
3633
|
+
<td style="padding:15px">{base_path}/{version}/networks/{pathv1}/wireless/channelUtilizationHistory?{query}</td>
|
3634
|
+
<td style="padding:15px">Yes</td>
|
3635
|
+
</tr>
|
3636
|
+
<tr>
|
3637
|
+
<td style="padding:15px">returnwirelessclientcountsovertimeforanetworkDeviceOrnetworkclient(networkId, callback)</td>
|
3638
|
+
<td style="padding:15px">Return wireless client counts over time for a network, device, or network client</td>
|
3639
|
+
<td style="padding:15px">{base_path}/{version}/networks/{pathv1}/wireless/clientCountHistory?{query}</td>
|
3640
|
+
<td style="padding:15px">Yes</td>
|
3641
|
+
</tr>
|
3642
|
+
<tr>
|
3643
|
+
<td style="padding:15px">listthewirelessconnectivityeventsforaclientwithinanetworkinthetimespan(networkId, clientId, callback)</td>
|
3644
|
+
<td style="padding:15px">List the wireless connectivity events for a client within a network in the timespan.</td>
|
3645
|
+
<td style="padding:15px">{base_path}/{version}/networks/{pathv1}/wireless/clients/{pathv2}/connectivityEvents?{query}</td>
|
3646
|
+
<td style="padding:15px">Yes</td>
|
3647
|
+
</tr>
|
3648
|
+
<tr>
|
3649
|
+
<td style="padding:15px">returnaveragewirelesslatencyovertimeforanetworkDeviceOrnetworkclient(networkId, callback)</td>
|
3650
|
+
<td style="padding:15px">Return average wireless latency over time for a network, device, or network client</td>
|
3651
|
+
<td style="padding:15px">{base_path}/{version}/networks/{pathv1}/wireless/latencyHistory?{query}</td>
|
3652
|
+
<td style="padding:15px">Yes</td>
|
3653
|
+
</tr>
|
3654
|
+
<tr>
|
3655
|
+
<td style="padding:15px">returnPHYdataratesovertimeforanetworkDeviceOrnetworkclient(networkId, callback)</td>
|
3656
|
+
<td style="padding:15px">Return PHY data rates over time for a network, device, or network client</td>
|
3657
|
+
<td style="padding:15px">{base_path}/{version}/networks/{pathv1}/wireless/dataRateHistory?{query}</td>
|
3658
|
+
<td style="padding:15px">Yes</td>
|
3659
|
+
</tr>
|
3660
|
+
<tr>
|
3661
|
+
<td style="padding:15px">listwirelessmeshstatusesforrepeaters(networkId, callback)</td>
|
3662
|
+
<td style="padding:15px">List wireless mesh statuses for repeaters</td>
|
3663
|
+
<td style="padding:15px">{base_path}/{version}/networks/{pathv1}/wireless/meshStatuses?{query}</td>
|
3664
|
+
<td style="padding:15px">Yes</td>
|
3665
|
+
</tr>
|
3666
|
+
<tr>
|
3667
|
+
<td style="padding:15px">returnsignalqualitySNRRSSIOvertimeforadeviceornetworkclient(networkId, callback)</td>
|
3668
|
+
<td style="padding:15px">Return signal quality (SNR/RSSI) over time for a device or network client</td>
|
3669
|
+
<td style="padding:15px">{base_path}/{version}/networks/{pathv1}/wireless/signalQualityHistory?{query}</td>
|
3670
|
+
<td style="padding:15px">Yes</td>
|
3671
|
+
</tr>
|
3672
|
+
<tr>
|
3673
|
+
<td style="padding:15px">getapplicationhealthbytime(networkId, applicationId, callback)</td>
|
3674
|
+
<td style="padding:15px">Get application health by time</td>
|
3675
|
+
<td style="padding:15px">{base_path}/{version}/networks/{pathv1}/insight/applications/{pathv2}/healthByTime?{query}</td>
|
3676
|
+
<td style="padding:15px">Yes</td>
|
3677
|
+
</tr>
|
3678
|
+
<tr>
|
3679
|
+
<td style="padding:15px">listallInsighttrackedapplications(organizationId, callback)</td>
|
3680
|
+
<td style="padding:15px">List all Insight tracked applications</td>
|
3681
|
+
<td style="padding:15px">{base_path}/{version}/organizations/{pathv1}/insight/applications?{query}</td>
|
3682
|
+
<td style="padding:15px">Yes</td>
|
3683
|
+
</tr>
|
3684
|
+
<tr>
|
3685
|
+
<td style="padding:15px">returnthelatestavailablereadingforeachmetricfromeachsensorSortedbysensorserial(organizationId, callback)</td>
|
3686
|
+
<td style="padding:15px">Return the latest available reading for each metric from each sensor, sorted by sensor serial</td>
|
3687
|
+
<td style="padding:15px">{base_path}/{version}/organizations/{pathv1}/sensor/readings/latest?{query}</td>
|
3688
|
+
<td style="padding:15px">Yes</td>
|
3689
|
+
</tr>
|
3690
|
+
<tr>
|
3691
|
+
<td style="padding:15px">listTrustedAccessConfigs(networkId, callback)</td>
|
3692
|
+
<td style="padding:15px">List Trusted Access Configs</td>
|
3693
|
+
<td style="padding:15px">{base_path}/{version}/networks/{pathv1}/sm/trustedAccessConfigs?{query}</td>
|
3694
|
+
<td style="padding:15px">Yes</td>
|
3695
|
+
</tr>
|
3696
|
+
<tr>
|
3697
|
+
<td style="padding:15px">listUserAccessDevicesAndItsTrustedAccessConnections(networkId, callback)</td>
|
3698
|
+
<td style="padding:15px">List User Access Devices and its Trusted Access Connections</td>
|
3699
|
+
<td style="padding:15px">{base_path}/{version}/networks/{pathv1}/sm/userAccessDevices?{query}</td>
|
3700
|
+
<td style="padding:15px">Yes</td>
|
3701
|
+
</tr>
|
3702
|
+
<tr>
|
3703
|
+
<td style="padding:15px">deleteAUserAccessDevice(networkId, userAccessDeviceId, callback)</td>
|
3704
|
+
<td style="padding:15px">Delete a User Access Device
|
3705
|
+
#### Supports Action Batches
|
3706
|
+
|
3707
|
+
**Resource**|**Operation**
|
3708
|
+
:-------------: |:-------------:
|
3709
|
+
`/networks/{networkId}/sm/userAccessDevices/{userAccessDeviceId}` | destroy
|
3710
|
+
|
3711
|
+
</td>
|
3712
|
+
<td style="padding:15px">{base_path}/{version}/networks/{pathv1}/sm/userAccessDevices/{pathv2}?{query}</td>
|
3713
|
+
<td style="padding:15px">Yes</td>
|
3714
|
+
</tr>
|
3715
|
+
<tr>
|
3716
|
+
<td style="padding:15px">gettheorganizationSAPNScertificate(organizationId, callback)</td>
|
3717
|
+
<td style="padding:15px">Get the organization's APNS certificate</td>
|
3718
|
+
<td style="padding:15px">{base_path}/{version}/organizations/{pathv1}/sm/apnsCert?{query}</td>
|
3719
|
+
<td style="padding:15px">Yes</td>
|
3720
|
+
</tr>
|
3721
|
+
<tr>
|
3722
|
+
<td style="padding:15px">listTheVPPAccountsInTheOrganization(organizationId, callback)</td>
|
3723
|
+
<td style="padding:15px">List the VPP accounts in the organization</td>
|
3724
|
+
<td style="padding:15px">{base_path}/{version}/organizations/{pathv1}/sm/vppAccounts?{query}</td>
|
3725
|
+
<td style="padding:15px">Yes</td>
|
3726
|
+
</tr>
|
3727
|
+
<tr>
|
3728
|
+
<td style="padding:15px">getAHashContainingTheUnparsedTokenOfTheVPPAccountWithTheGivenID(organizationId, vppAccountId, callback)</td>
|
3729
|
+
<td style="padding:15px">Get a hash containing the unparsed token of the VPP account with the given ID</td>
|
3730
|
+
<td style="padding:15px">{base_path}/{version}/organizations/{pathv1}/sm/vppAccounts/{pathv2}?{query}</td>
|
3731
|
+
<td style="padding:15px">Yes</td>
|
3732
|
+
</tr>
|
3733
|
+
<tr>
|
3734
|
+
<td style="padding:15px">enqueueAJobToPingATargetHostFromTheDevice(serial, body, callback)</td>
|
3735
|
+
<td style="padding:15px">Enqueue a job to ping a target host from the device
|
3736
|
+
#### Body Parameters
|
3737
|
+
**Parameter**|**Type**|**Description**
|
3738
|
+
:-------------: |:-------------: |:-------------:
|
3739
|
+
target| string| FQDN, IPv4 or IPv6 address
|
3740
|
+
count| integer| Count parameter to pass to ping. [1..5], default 5
|
3741
|
+
</td>
|
3742
|
+
<td style="padding:15px">{base_path}/{version}/devices/{pathv1}/liveTools/ping?{query}</td>
|
3743
|
+
<td style="padding:15px">Yes</td>
|
3744
|
+
</tr>
|
3745
|
+
<tr>
|
3746
|
+
<td style="padding:15px">returnAPingJob(serial, id, callback)</td>
|
3747
|
+
<td style="padding:15px">Return a ping job. Latency unit in response is in milliseconds. Size is in bytes.</td>
|
3748
|
+
<td style="padding:15px">{base_path}/{version}/devices/{pathv1}/liveTools/ping/{pathv2}?{query}</td>
|
3749
|
+
<td style="padding:15px">Yes</td>
|
3750
|
+
</tr>
|
3751
|
+
<tr>
|
3752
|
+
<td style="padding:15px">enqueueAJobToCheckConnectivityStatusToTheDevice(serial, body, callback)</td>
|
3753
|
+
<td style="padding:15px">Enqueue a job to check connectivity status to the device
|
3754
|
+
#### Body Parameters
|
3755
|
+
**Parameter**|**Type**|**Description**
|
3756
|
+
:-------------: |:-------------: |:-------------:
|
3757
|
+
count| integer| Count parameter to pass to ping. [1..5], default 5
|
3758
|
+
</td>
|
3759
|
+
<td style="padding:15px">{base_path}/{version}/devices/{pathv1}/liveTools/pingDevice?{query}</td>
|
3760
|
+
<td style="padding:15px">Yes</td>
|
3761
|
+
</tr>
|
3762
|
+
<tr>
|
3763
|
+
<td style="padding:15px">returnAPingDeviceJob(serial, id, callback)</td>
|
3764
|
+
<td style="padding:15px">Return a ping device job. Latency unit in response is in milliseconds. Size is in bytes.</td>
|
3765
|
+
<td style="padding:15px">{base_path}/{version}/devices/{pathv1}/liveTools/pingDevice/{pathv2}?{query}</td>
|
3766
|
+
<td style="padding:15px">Yes</td>
|
3767
|
+
</tr>
|
3768
|
+
<tr>
|
3769
|
+
<td style="padding:15px">claimavMXintoanetwork(networkId, body, callback)</td>
|
3770
|
+
<td style="padding:15px">Claim a vMX into a network
|
3771
|
+
#### Body Parameters
|
3772
|
+
**Parameter**|**Type**|**Description**
|
3773
|
+
:-------------: |:-------------: |:-------------:
|
3774
|
+
size| string| The size of the vMX you claim. It can be one of: small, medium, large, 100
|
3775
|
+
|
3776
|
+
#### Supports Action Batches
|
3777
|
+
|
3778
|
+
**Resource**|**Operation**
|
3779
|
+
:-------------: |:-------------:
|
3780
|
+
`/networks/{networkId}/devices/claim` | claim
|
3781
|
+
|
3782
|
+
</td>
|
3783
|
+
<td style="padding:15px">{base_path}/{version}/networks/{pathv1}/devices/claim/vmx?{query}</td>
|
3784
|
+
<td style="padding:15px">Yes</td>
|
3785
|
+
</tr>
|
3786
|
+
<tr>
|
3787
|
+
<td style="padding:15px">rollbackaFirmwareUpgradeForANetwork(networkId, body, callback)</td>
|
3788
|
+
<td style="padding:15px">Rollback a Firmware Upgrade For A Network
|
3789
|
+
#### Body Parameters
|
3790
|
+
**Parameter**|**Type**|**Description**
|
3791
|
+
:-------------: |:-------------: |:-------------:
|
3792
|
+
product| string| Product type to rollback (if the network is a combined network)
|
3793
|
+
time| string| Scheduled time for the rollback
|
3794
|
+
reasons| array| Reasons for the rollback
|
3795
|
+
toVersion| object| Version to downgrade to (if the network has firmware flexibility)
|
3796
|
+
|
3797
|
+
#### Supports Action Batches
|
3798
|
+
|
3799
|
+
**Resource**|**Operation**
|
3800
|
+
:-------------: |:-------------:...(description truncated)</td>
|
3801
|
+
<td style="padding:15px">{base_path}/{version}/networks/{pathv1}/firmwareUpgrades/rollbacks?{query}</td>
|
3802
|
+
<td style="padding:15px">Yes</td>
|
3803
|
+
</tr>
|
3804
|
+
<tr>
|
3805
|
+
<td style="padding:15px">getFirmwareUpgradeInformationForANetwork(networkId, callback)</td>
|
3806
|
+
<td style="padding:15px">Get firmware upgrade information for a network</td>
|
3807
|
+
<td style="padding:15px">{base_path}/{version}/networks/{pathv1}/firmwareUpgrades?{query}</td>
|
3808
|
+
<td style="padding:15px">Yes</td>
|
3809
|
+
</tr>
|
3810
|
+
<tr>
|
3811
|
+
<td style="padding:15px">updateFirmwareUpgradeInformationForANetwork(networkId, body, callback)</td>
|
3812
|
+
<td style="padding:15px">Update firmware upgrade information for a network
|
3813
|
+
#### Body Parameters
|
3814
|
+
**Parameter**|**Type**|**Description**
|
3815
|
+
:-------------: |:-------------: |:-------------:
|
3816
|
+
upgradeWindow| object| Upgrade window for devices in network
|
3817
|
+
timezone| string| The timezone for the network
|
3818
|
+
products| object| Contains information about the network to update
|
3819
|
+
|
3820
|
+
#### Supports Action Batches
|
3821
|
+
|
3822
|
+
**Resource**|**Operation**
|
3823
|
+
:-------------: |:-------------:
|
3824
|
+
`/networks/{networkId}/firmwareUpgrades` | update
|
3825
|
+
|
3826
|
+
</td>
|
3827
|
+
<td style="padding:15px">{base_path}/{version}/networks/{pathv1}/firmwareUpgrades?{query}</td>
|
3828
|
+
<td style="padding:15px">Yes</td>
|
3829
|
+
</tr>
|
3830
|
+
<tr>
|
3831
|
+
<td style="padding:15px">returnallglobalalertsonthisnetwork(networkId, callback)</td>
|
3832
|
+
<td style="padding:15px">Return all global alerts on this network</td>
|
3833
|
+
<td style="padding:15px">{base_path}/{version}/networks/{pathv1}/health/alerts?{query}</td>
|
3834
|
+
<td style="padding:15px">Yes</td>
|
3835
|
+
</tr>
|
3836
|
+
<tr>
|
3837
|
+
<td style="padding:15px">authorizeAUserConfiguredWithMerakiAuthenticationForANetworkCurrentlySupports8021XSplashGuestAndClientVPNUsersAndCurrentlyOrganizationsHaveA50000UserCap(networkId, body, callback)</td>
|
3838
|
+
<td style="padding:15px">Authorize a user configured with Meraki Authentication for a network (currently supports 802.1X, splash guest, and client VPN users, and currently, organizations have a 50,000 user cap)
|
3839
|
+
#### Body Parameters
|
3840
|
+
**Parameter**|**Type**|**Description**
|
3841
|
+
:-------------: |:-------------: |:-------------:
|
3842
|
+
email| string| Email address of the user
|
3843
|
+
name| string| Name of the user. Only required If the user is not a Dashboard administrator.
|
3844
|
+
password| string| The password for this user account. Only require...(description truncated)</td>
|
3845
|
+
<td style="padding:15px">{base_path}/{version}/networks/{pathv1}/merakiAuthUsers?{query}</td>
|
3846
|
+
<td style="padding:15px">Yes</td>
|
3847
|
+
</tr>
|
3848
|
+
<tr>
|
3849
|
+
<td style="padding:15px">deauthorizeAUser(networkId, merakiAuthUserId, callback)</td>
|
3850
|
+
<td style="padding:15px">Deauthorize a user. To reauthorize a user after deauthorizing them, POST to this endpoint. (Currently, 802.1X RADIUS, splash guest, and client VPN users can be deauthorized.)</td>
|
3851
|
+
<td style="padding:15px">{base_path}/{version}/networks/{pathv1}/merakiAuthUsers/{pathv2}?{query}</td>
|
3852
|
+
<td style="padding:15px">Yes</td>
|
3853
|
+
</tr>
|
3854
|
+
<tr>
|
3855
|
+
<td style="padding:15px">updateAUserConfiguredWithMerakiAuthenticationCurrently8021XRADIUSSplashGuestAndClientVPNUsersCanBeUpdated(networkId, merakiAuthUserId, body, callback)</td>
|
3856
|
+
<td style="padding:15px">Update a user configured with Meraki Authentication (currently, 802.1X RADIUS, splash guest, and client VPN users can be updated)
|
3857
|
+
#### Body Parameters
|
3858
|
+
**Parameter**|**Type**|**Description**
|
3859
|
+
:-------------: |:-------------: |:-------------:
|
3860
|
+
name| string| Name of the user. Only allowed If the user is not Dashboard administrator.
|
3861
|
+
password| string| The password for this user account. Only allowed If the user is not Dashboard administrator.
|
3862
|
+
emailPasswordToUser| boolean| Whether or not Meraki sho...(description truncated)</td>
|
3863
|
+
<td style="padding:15px">{base_path}/{version}/networks/{pathv1}/merakiAuthUsers/{pathv2}?{query}</td>
|
3864
|
+
<td style="padding:15px">Yes</td>
|
3865
|
+
</tr>
|
3866
|
+
<tr>
|
3867
|
+
<td style="padding:15px">addAnMQTTBroker(networkId, body, callback)</td>
|
3868
|
+
<td style="padding:15px">Add an MQTT broker
|
3869
|
+
#### Body Parameters
|
3870
|
+
**Parameter**|**Type**|**Description**
|
3871
|
+
:-------------: |:-------------: |:-------------:
|
3872
|
+
name| string| Name of the MQTT broker.
|
3873
|
+
host| string| Host name/IP address where the MQTT broker runs.
|
3874
|
+
port| integer| Host port though which the MQTT broker can be reached.
|
3875
|
+
security| object| Security settings of the MQTT broker.
|
3876
|
+
authentication| object| Authentication settings of the MQTT broker
|
3877
|
+
|
3878
|
+
#### Supports Action Batches
|
3879
|
+
|
3880
|
+
**Resource**|**Operation**
|
3881
|
+
:------------...(description truncated)</td>
|
3882
|
+
<td style="padding:15px">{base_path}/{version}/networks/{pathv1}/mqttBrokers?{query}</td>
|
3883
|
+
<td style="padding:15px">Yes</td>
|
3884
|
+
</tr>
|
3885
|
+
<tr>
|
3886
|
+
<td style="padding:15px">listTheMQTTBrokersForThisNetwork(networkId, callback)</td>
|
3887
|
+
<td style="padding:15px">List the MQTT brokers for this network</td>
|
3888
|
+
<td style="padding:15px">{base_path}/{version}/networks/{pathv1}/mqttBrokers?{query}</td>
|
3889
|
+
<td style="padding:15px">Yes</td>
|
3890
|
+
</tr>
|
3891
|
+
<tr>
|
3892
|
+
<td style="padding:15px">deleteAnMQTTBroker(networkId, mqttBrokerId, callback)</td>
|
3893
|
+
<td style="padding:15px">Delete an MQTT broker
|
3894
|
+
#### Supports Action Batches
|
3895
|
+
|
3896
|
+
**Resource**|**Operation**
|
3897
|
+
:-------------: |:-------------:
|
3898
|
+
`/networks/{networkId}/mqttBrokers/{mqttBrokerId}` | destroy
|
3899
|
+
|
3900
|
+
</td>
|
3901
|
+
<td style="padding:15px">{base_path}/{version}/networks/{pathv1}/mqttBrokers/{pathv2}?{query}</td>
|
3902
|
+
<td style="padding:15px">Yes</td>
|
3903
|
+
</tr>
|
3904
|
+
<tr>
|
3905
|
+
<td style="padding:15px">returnAnMQTTBroker(networkId, mqttBrokerId, callback)</td>
|
3906
|
+
<td style="padding:15px">Return an MQTT broker</td>
|
3907
|
+
<td style="padding:15px">{base_path}/{version}/networks/{pathv1}/mqttBrokers/{pathv2}?{query}</td>
|
3908
|
+
<td style="padding:15px">Yes</td>
|
3909
|
+
</tr>
|
3910
|
+
<tr>
|
3911
|
+
<td style="padding:15px">updateAnMQTTBroker(networkId, mqttBrokerId, body, callback)</td>
|
3912
|
+
<td style="padding:15px">Update an MQTT broker
|
3913
|
+
#### Body Parameters
|
3914
|
+
**Parameter**|**Type**|**Description**
|
3915
|
+
:-------------: |:-------------: |:-------------:
|
3916
|
+
name| string| Name of the MQTT broker.
|
3917
|
+
host| string| Host name/IP address where the MQTT broker runs.
|
3918
|
+
port| integer| Host port though which the MQTT broker can be reached.
|
3919
|
+
security| object| Security settings of the MQTT broker.
|
3920
|
+
authentication| object| Authentication settings of the MQTT broker
|
3921
|
+
|
3922
|
+
#### Supports Action Batches
|
3923
|
+
|
3924
|
+
**Resource**|**Operation**
|
3925
|
+
:---------...(description truncated)</td>
|
3926
|
+
<td style="padding:15px">{base_path}/{version}/networks/{pathv1}/mqttBrokers/{pathv2}?{query}</td>
|
3927
|
+
<td style="padding:15px">Yes</td>
|
3928
|
+
</tr>
|
3929
|
+
<tr>
|
3930
|
+
<td style="padding:15px">getpoliciesforallclientswithpolicies(networkId, callback)</td>
|
3931
|
+
<td style="padding:15px">Get policies for all clients with policies</td>
|
3932
|
+
<td style="padding:15px">{base_path}/{version}/networks/{pathv1}/policies/byClient?{query}</td>
|
3933
|
+
<td style="padding:15px">Yes</td>
|
3934
|
+
</tr>
|
3935
|
+
<tr>
|
3936
|
+
<td style="padding:15px">listofdevicesandconnectionsamongthemwithinthenetwork(networkId, callback)</td>
|
3937
|
+
<td style="padding:15px">List of devices and connections among them within the network.</td>
|
3938
|
+
<td style="padding:15px">{base_path}/{version}/networks/{pathv1}/topology/linkLayer?{query}</td>
|
3939
|
+
<td style="padding:15px">Yes</td>
|
3940
|
+
</tr>
|
3941
|
+
<tr>
|
3942
|
+
<td style="padding:15px">createAWebhookPayloadTemplateForANetwork(networkId, body, callback)</td>
|
3943
|
+
<td style="padding:15px">Create a webhook payload template for a network
|
3944
|
+
#### Body Parameters
|
3945
|
+
**Parameter**|**Type**|**Description**
|
3946
|
+
:-------------: |:-------------: |:-------------:
|
3947
|
+
name| string| The name of the new template
|
3948
|
+
body| string| The liquid template used for the body of the webhook message. Either `body` or `bodyFile` must be specified.
|
3949
|
+
headers| string| The liquid template used with the webhook headers.
|
3950
|
+
bodyFile| string| A file containing liquid template used for the body of the webhook message. Either `b...(description truncated)</td>
|
3951
|
+
<td style="padding:15px">{base_path}/{version}/networks/{pathv1}/webhooks/payloadTemplates?{query}</td>
|
3952
|
+
<td style="padding:15px">Yes</td>
|
3953
|
+
</tr>
|
3954
|
+
<tr>
|
3955
|
+
<td style="padding:15px">listTheWebhookPayloadTemplatesForANetwork(networkId, callback)</td>
|
3956
|
+
<td style="padding:15px">List the webhook payload templates for a network</td>
|
3957
|
+
<td style="padding:15px">{base_path}/{version}/networks/{pathv1}/webhooks/payloadTemplates?{query}</td>
|
3958
|
+
<td style="padding:15px">Yes</td>
|
3959
|
+
</tr>
|
3960
|
+
<tr>
|
3961
|
+
<td style="padding:15px">destroyAWebhookPayloadTemplateForANetwork(networkId, payloadTemplateId, callback)</td>
|
3962
|
+
<td style="padding:15px">Destroy a webhook payload template for a network. Does not work for included templates ('wpt_00001', 'wpt_00002', 'wpt_00003' or 'wpt_00004')</td>
|
3963
|
+
<td style="padding:15px">{base_path}/{version}/networks/{pathv1}/webhooks/payloadTemplates/{pathv2}?{query}</td>
|
3964
|
+
<td style="padding:15px">Yes</td>
|
3965
|
+
</tr>
|
3966
|
+
<tr>
|
3967
|
+
<td style="padding:15px">getTheWebhookPayloadTemplateForANetwork(networkId, payloadTemplateId, callback)</td>
|
3968
|
+
<td style="padding:15px">Get the webhook payload template for a network</td>
|
3969
|
+
<td style="padding:15px">{base_path}/{version}/networks/{pathv1}/webhooks/payloadTemplates/{pathv2}?{query}</td>
|
3970
|
+
<td style="padding:15px">Yes</td>
|
3971
|
+
</tr>
|
3972
|
+
<tr>
|
3973
|
+
<td style="padding:15px">updateAWebhookPayloadTemplateForANetwork(networkId, payloadTemplateId, body, callback)</td>
|
3974
|
+
<td style="padding:15px">Update a webhook payload template for a network
|
3975
|
+
#### Body Parameters
|
3976
|
+
**Parameter**|**Type**|**Description**
|
3977
|
+
:-------------: |:-------------: |:-------------:
|
3978
|
+
name| string| The name of the template
|
3979
|
+
body| string| The liquid template used for the body of the webhook message.
|
3980
|
+
headers| string| The liquid template used with the webhook headers.
|
3981
|
+
bodyFile| string| A file containing liquid template used for the body of the webhook message.
|
3982
|
+
headersFile| string| A file containing the liquid template u...(description truncated)</td>
|
3983
|
+
<td style="padding:15px">{base_path}/{version}/networks/{pathv1}/webhooks/payloadTemplates/{pathv2}?{query}</td>
|
3984
|
+
<td style="padding:15px">Yes</td>
|
3985
|
+
</tr>
|
3986
|
+
<tr>
|
3987
|
+
<td style="padding:15px">returntheapplicationusagedataforclients(networkId, callback)</td>
|
3988
|
+
<td style="padding:15px">Return the application usage data for clients. Usage data is in kilobytes. Clients can be identified by client keys or either the MACs or IPs depending on whether the network uses Track-by-IP.</td>
|
3989
|
+
<td style="padding:15px">{base_path}/{version}/networks/{pathv1}/clients/applicationUsage?{query}</td>
|
3990
|
+
<td style="padding:15px">Yes</td>
|
3991
|
+
</tr>
|
3992
|
+
<tr>
|
3993
|
+
<td style="padding:15px">returnsatimeseriesoftotaltrafficconsumptionratesforallclientsonanetworkwithinagiventimespanInmegabitspersecond(networkId, callback)</td>
|
3994
|
+
<td style="padding:15px">Returns a timeseries of total traffic consumption rates for all clients on a network within a given timespan, in megabits per second.</td>
|
3995
|
+
<td style="padding:15px">{base_path}/{version}/networks/{pathv1}/clients/bandwidthUsageHistory?{query}</td>
|
3996
|
+
<td style="padding:15px">Yes</td>
|
3997
|
+
</tr>
|
3998
|
+
<tr>
|
3999
|
+
<td style="padding:15px">returndatausageInmegabitspersecondOvertimeforallclientsinthegivenorganizationwithinagiventimerange(organizationId, callback)</td>
|
4000
|
+
<td style="padding:15px">Return data usage (in megabits per second) over time for all clients in the given organization within a given time range.</td>
|
4001
|
+
<td style="padding:15px">{base_path}/{version}/organizations/{pathv1}/clients/bandwidthUsageHistory?{query}</td>
|
4002
|
+
<td style="padding:15px">Yes</td>
|
4003
|
+
</tr>
|
4004
|
+
<tr>
|
4005
|
+
<td style="padding:15px">returntheusagehistoriesforclients(networkId, callback)</td>
|
4006
|
+
<td style="padding:15px">Return the usage histories for clients. Usage data is in kilobytes. Clients can be identified by client keys or either the MACs or IPs depending on whether the network uses Track-by-IP.</td>
|
4007
|
+
<td style="padding:15px">{base_path}/{version}/networks/{pathv1}/clients/usageHistories?{query}</td>
|
4008
|
+
<td style="padding:15px">Yes</td>
|
4009
|
+
</tr>
|
4010
|
+
<tr>
|
4011
|
+
<td style="padding:15px">getthechannelutilizationovereachradioforallAPsinanetwork(networkId, callback)</td>
|
4012
|
+
<td style="padding:15px">Get the channel utilization over each radio for all APs in a network.</td>
|
4013
|
+
<td style="padding:15px">{base_path}/{version}/networks/{pathv1}/networkHealth/channelUtilization?{query}</td>
|
4014
|
+
<td style="padding:15px">Yes</td>
|
4015
|
+
</tr>
|
4016
|
+
<tr>
|
4017
|
+
<td style="padding:15px">createsNewAdaptivePolicyACL(organizationId, body, callback)</td>
|
4018
|
+
<td style="padding:15px">Creates new adaptive policy ACL
|
4019
|
+
#### Body Parameters
|
4020
|
+
**Parameter**|**Type**|**Description**
|
4021
|
+
:-------------: |:-------------: |:-------------:
|
4022
|
+
name| string| Name of the adaptive policy ACL
|
4023
|
+
description| string| Description of the adaptive policy ACL
|
4024
|
+
rules| array| An ordered array of the adaptive policy ACL rules.
|
4025
|
+
ipVersion| string| IP version of adpative policy ACL. One of: 'any', 'ipv4' or 'ipv6'
|
4026
|
+
|
4027
|
+
#### Supports Action Batches
|
4028
|
+
|
4029
|
+
**Resource**|**Operation**
|
4030
|
+
:-------------: |:-------------:
|
4031
|
+
`/org...(description truncated)</td>
|
4032
|
+
<td style="padding:15px">{base_path}/{version}/organizations/{pathv1}/adaptivePolicy/acls?{query}</td>
|
4033
|
+
<td style="padding:15px">Yes</td>
|
4034
|
+
</tr>
|
4035
|
+
<tr>
|
4036
|
+
<td style="padding:15px">listAdaptivePolicyACLsInAOrganization(organizationId, callback)</td>
|
4037
|
+
<td style="padding:15px">List adaptive policy ACLs in a organization</td>
|
4038
|
+
<td style="padding:15px">{base_path}/{version}/organizations/{pathv1}/adaptivePolicy/acls?{query}</td>
|
4039
|
+
<td style="padding:15px">Yes</td>
|
4040
|
+
</tr>
|
4041
|
+
<tr>
|
4042
|
+
<td style="padding:15px">deletesTheSpecifiedAdaptivePolicyACL(organizationId, aclId, callback)</td>
|
4043
|
+
<td style="padding:15px">Deletes the specified adaptive policy ACL. Note this adaptive policy ACL will also be removed from policies using it.</td>
|
4044
|
+
<td style="padding:15px">{base_path}/{version}/organizations/{pathv1}/adaptivePolicy/acls/{pathv2}?{query}</td>
|
4045
|
+
<td style="padding:15px">Yes</td>
|
4046
|
+
</tr>
|
4047
|
+
<tr>
|
4048
|
+
<td style="padding:15px">returnsTheAdaptivePolicyACLInformation(organizationId, aclId, callback)</td>
|
4049
|
+
<td style="padding:15px">Returns the adaptive policy ACL information</td>
|
4050
|
+
<td style="padding:15px">{base_path}/{version}/organizations/{pathv1}/adaptivePolicy/acls/{pathv2}?{query}</td>
|
4051
|
+
<td style="padding:15px">Yes</td>
|
4052
|
+
</tr>
|
4053
|
+
<tr>
|
4054
|
+
<td style="padding:15px">updatesAnAdaptivePolicyACL(organizationId, aclId, body, callback)</td>
|
4055
|
+
<td style="padding:15px">Updates an adaptive policy ACL
|
4056
|
+
#### Body Parameters
|
4057
|
+
**Parameter**|**Type**|**Description**
|
4058
|
+
:-------------: |:-------------: |:-------------:
|
4059
|
+
name| string| Name of the adaptive policy ACL
|
4060
|
+
description| string| Description of the adaptive policy ACL
|
4061
|
+
rules| array| An ordered array of the adaptive policy ACL rules. An empty array will clear the rules.
|
4062
|
+
ipVersion| string| IP version of adpative policy ACL. One of: 'any', 'ipv4' or 'ipv6'
|
4063
|
+
|
4064
|
+
#### Supports Action Batches
|
4065
|
+
|
4066
|
+
**Resource**|**Operation**
|
4067
|
+
:-...(description truncated)</td>
|
4068
|
+
<td style="padding:15px">{base_path}/{version}/organizations/{pathv1}/adaptivePolicy/acls/{pathv2}?{query}</td>
|
4069
|
+
<td style="padding:15px">Yes</td>
|
4070
|
+
</tr>
|
4071
|
+
<tr>
|
4072
|
+
<td style="padding:15px">createsANewAdaptivePolicyGroup(organizationId, body, callback)</td>
|
4073
|
+
<td style="padding:15px">Creates a new adaptive policy group
|
4074
|
+
#### Body Parameters
|
4075
|
+
**Parameter**|**Type**|**Description**
|
4076
|
+
:-------------: |:-------------: |:-------------:
|
4077
|
+
name| string| Name of the group
|
4078
|
+
sgt| integer| SGT value of the group
|
4079
|
+
description| string| Description of the group (default: "")
|
4080
|
+
policyObjects| array| The policy objects that belong to this group; traffic from addresses specified by these policy objects will be tagged with this group's SGT value if no other tagging scheme is being used (each requi...(description truncated)</td>
|
4081
|
+
<td style="padding:15px">{base_path}/{version}/organizations/{pathv1}/adaptivePolicy/groups?{query}</td>
|
4082
|
+
<td style="padding:15px">Yes</td>
|
4083
|
+
</tr>
|
4084
|
+
<tr>
|
4085
|
+
<td style="padding:15px">listAdaptivePolicyGroupsInAOrganization(organizationId, callback)</td>
|
4086
|
+
<td style="padding:15px">List adaptive policy groups in a organization</td>
|
4087
|
+
<td style="padding:15px">{base_path}/{version}/organizations/{pathv1}/adaptivePolicy/groups?{query}</td>
|
4088
|
+
<td style="padding:15px">Yes</td>
|
4089
|
+
</tr>
|
4090
|
+
<tr>
|
4091
|
+
<td style="padding:15px">deletesTheSpecifiedAdaptivePolicyGroupAndAnyAssociatedPoliciesAndReferences(organizationId, id, callback)</td>
|
4092
|
+
<td style="padding:15px">Deletes the specified adaptive policy group and any associated policies and references
|
4093
|
+
#### Supports Action Batches
|
4094
|
+
|
4095
|
+
**Resource**|**Operation**
|
4096
|
+
:-------------: |:-------------:
|
4097
|
+
`/organizations/{organizationId}/adaptivePolicy/groups/{id}` | destroy
|
4098
|
+
|
4099
|
+
</td>
|
4100
|
+
<td style="padding:15px">{base_path}/{version}/organizations/{pathv1}/adaptivePolicy/groups/{pathv2}?{query}</td>
|
4101
|
+
<td style="padding:15px">Yes</td>
|
4102
|
+
</tr>
|
4103
|
+
<tr>
|
4104
|
+
<td style="padding:15px">returnsAnAdaptivePolicyGroup(organizationId, id, callback)</td>
|
4105
|
+
<td style="padding:15px">Returns an adaptive policy group</td>
|
4106
|
+
<td style="padding:15px">{base_path}/{version}/organizations/{pathv1}/adaptivePolicy/groups/{pathv2}?{query}</td>
|
4107
|
+
<td style="padding:15px">Yes</td>
|
4108
|
+
</tr>
|
4109
|
+
<tr>
|
4110
|
+
<td style="padding:15px">updatesAnAdaptivePolicyGroup(organizationId, id, body, callback)</td>
|
4111
|
+
<td style="padding:15px">Updates an adaptive policy group. If updating "Infrastructure", only the SGT is allowed. Cannot update "Unknown".</td>
|
4112
|
+
<td style="padding:15px">{base_path}/{version}/organizations/{pathv1}/adaptivePolicy/groups/{pathv2}?{query}</td>
|
4113
|
+
<td style="padding:15px">Yes</td>
|
4114
|
+
</tr>
|
4115
|
+
<tr>
|
4116
|
+
<td style="padding:15px">addAnAdaptivePolicy(organizationId, body, callback)</td>
|
4117
|
+
<td style="padding:15px">Add an Adaptive Policy
|
4118
|
+
#### Body Parameters
|
4119
|
+
**Parameter**|**Type**|**Description**
|
4120
|
+
:-------------: |:-------------: |:-------------:
|
4121
|
+
sourceGroup| object| The source adaptive policy group (requires one unique attribute)
|
4122
|
+
|
4123
|
+
destinationGroup| object| The destination adaptive policy group (requires one unique attribute)
|
4124
|
+
|
4125
|
+
acls| array| An ordered array of adaptive policy ACLs (each requires one unique attribute) that apply to this policy (default: [])
|
4126
|
+
|
4127
|
+
lastEntryRule| string| The rule to apply if th...(description truncated)</td>
|
4128
|
+
<td style="padding:15px">{base_path}/{version}/organizations/{pathv1}/adaptivePolicy/policies?{query}</td>
|
4129
|
+
<td style="padding:15px">Yes</td>
|
4130
|
+
</tr>
|
4131
|
+
<tr>
|
4132
|
+
<td style="padding:15px">listAdaptivePoliciesInAnOrganization(organizationId, callback)</td>
|
4133
|
+
<td style="padding:15px">List adaptive policies in an organization</td>
|
4134
|
+
<td style="padding:15px">{base_path}/{version}/organizations/{pathv1}/adaptivePolicy/policies?{query}</td>
|
4135
|
+
<td style="padding:15px">Yes</td>
|
4136
|
+
</tr>
|
4137
|
+
<tr>
|
4138
|
+
<td style="padding:15px">deleteAnAdaptivePolicy(organizationId, id, callback)</td>
|
4139
|
+
<td style="padding:15px">Delete an Adaptive Policy
|
4140
|
+
#### Supports Action Batches
|
4141
|
+
|
4142
|
+
**Resource**|**Operation**
|
4143
|
+
:-------------: |:-------------:
|
4144
|
+
`/organizations/{organizationId}/adaptivePolicy/policies/{id}` | destroy
|
4145
|
+
|
4146
|
+
</td>
|
4147
|
+
<td style="padding:15px">{base_path}/{version}/organizations/{pathv1}/adaptivePolicy/policies/{pathv2}?{query}</td>
|
4148
|
+
<td style="padding:15px">Yes</td>
|
4149
|
+
</tr>
|
4150
|
+
<tr>
|
4151
|
+
<td style="padding:15px">returnAnAdaptivePolicy(organizationId, id, callback)</td>
|
4152
|
+
<td style="padding:15px">Return an adaptive policy</td>
|
4153
|
+
<td style="padding:15px">{base_path}/{version}/organizations/{pathv1}/adaptivePolicy/policies/{pathv2}?{query}</td>
|
4154
|
+
<td style="padding:15px">Yes</td>
|
4155
|
+
</tr>
|
4156
|
+
<tr>
|
4157
|
+
<td style="padding:15px">updateAnAdaptivePolicy(organizationId, id, body, callback)</td>
|
4158
|
+
<td style="padding:15px">Update an Adaptive Policy
|
4159
|
+
#### Body Parameters
|
4160
|
+
**Parameter**|**Type**|**Description**
|
4161
|
+
:-------------: |:-------------: |:-------------:
|
4162
|
+
sourceGroup| object| The source adaptive policy group (requires one unique attribute)
|
4163
|
+
|
4164
|
+
destinationGroup| object| The destination adaptive policy group (requires one unique attribute)
|
4165
|
+
|
4166
|
+
acls| array| An ordered array of adaptive policy ACLs (each requires one unique attribute) that apply to this policy
|
4167
|
+
|
4168
|
+
lastEntryRule| string| The rule to apply if there is no m...(description truncated)</td>
|
4169
|
+
<td style="padding:15px">{base_path}/{version}/organizations/{pathv1}/adaptivePolicy/policies/{pathv2}?{query}</td>
|
4170
|
+
<td style="padding:15px">Yes</td>
|
4171
|
+
</tr>
|
4172
|
+
<tr>
|
4173
|
+
<td style="padding:15px">returntheclientdetailsinanorganization(organizationId, callback)</td>
|
4174
|
+
<td style="padding:15px">Return the client details in an organization</td>
|
4175
|
+
<td style="padding:15px">{base_path}/{version}/organizations/{pathv1}/clients/search?{query}</td>
|
4176
|
+
<td style="padding:15px">Yes</td>
|
4177
|
+
</tr>
|
4178
|
+
<tr>
|
4179
|
+
<td style="padding:15px">createANewConfigurationTemplate(organizationId, body, callback)</td>
|
4180
|
+
<td style="padding:15px">Create a new configuration template
|
4181
|
+
#### Body Parameters
|
4182
|
+
**Parameter**|**Type**|**Description**
|
4183
|
+
:-------------: |:-------------: |:-------------:
|
4184
|
+
name| string| The name of the configuration template
|
4185
|
+
timeZone| string| The timezone of the configuration template. For a list of allowed timezones, please see the 'TZ' column in the table in this article . Not applicable if copying from existing network or template
|
4186
|
+
copyFromNetworkId| string| The ID of the network or config template to copy config...(description truncated)</td>
|
4187
|
+
<td style="padding:15px">{base_path}/{version}/organizations/{pathv1}/configTemplates?{query}</td>
|
4188
|
+
<td style="padding:15px">Yes</td>
|
4189
|
+
</tr>
|
4190
|
+
<tr>
|
4191
|
+
<td style="padding:15px">returnASingleConfigurationTemplate(organizationId, configTemplateId, callback)</td>
|
4192
|
+
<td style="padding:15px">Return a single configuration template</td>
|
4193
|
+
<td style="padding:15px">{base_path}/{version}/organizations/{pathv1}/configTemplates/{pathv2}?{query}</td>
|
4194
|
+
<td style="padding:15px">Yes</td>
|
4195
|
+
</tr>
|
4196
|
+
<tr>
|
4197
|
+
<td style="padding:15px">updateAConfigurationTemplate(organizationId, configTemplateId, body, callback)</td>
|
4198
|
+
<td style="padding:15px">Update a configuration template
|
4199
|
+
#### Body Parameters
|
4200
|
+
**Parameter**|**Type**|**Description**
|
4201
|
+
:-------------: |:-------------: |:-------------:
|
4202
|
+
name| string| The name of the configuration template
|
4203
|
+
timeZone| string| The timezone of the configuration template. For a list of allowed timezones, please see the 'TZ' column in the table in this article.
|
4204
|
+
|
4205
|
+
#### Supports Action Batches
|
4206
|
+
|
4207
|
+
**Resource**|**Operation**
|
4208
|
+
:-------------: |:-------------:
|
4209
|
+
`/organizations/{organizationId}/configTemplates/{confi...(description truncated)</td>
|
4210
|
+
<td style="padding:15px">{base_path}/{version}/organizations/{pathv1}/configTemplates/{pathv2}?{query}</td>
|
4211
|
+
<td style="padding:15px">Yes</td>
|
4212
|
+
</tr>
|
4213
|
+
<tr>
|
4214
|
+
<td style="padding:15px">createANewEarlyAccessFeatureOptInForAnOrganization(organizationId, body, callback)</td>
|
4215
|
+
<td style="padding:15px">Create a new early access feature opt-in for an organization
|
4216
|
+
#### Body Parameters
|
4217
|
+
**Parameter**|**Type**|**Description**
|
4218
|
+
:-------------: |:-------------: |:-------------:
|
4219
|
+
shortName| string| Short name of the early access feature
|
4220
|
+
limitScopeToNetworks| array| A list of network IDs to apply the opt-in to
|
4221
|
+
</td>
|
4222
|
+
<td style="padding:15px">{base_path}/{version}/organizations/{pathv1}/earlyAccess/features/optIns?{query}</td>
|
4223
|
+
<td style="padding:15px">Yes</td>
|
4224
|
+
</tr>
|
4225
|
+
<tr>
|
4226
|
+
<td style="padding:15px">listTheEarlyAccessFeatureOptInsForAnOrganization(organizationId, callback)</td>
|
4227
|
+
<td style="padding:15px">List the early access feature opt-ins for an organization</td>
|
4228
|
+
<td style="padding:15px">{base_path}/{version}/organizations/{pathv1}/earlyAccess/features/optIns?{query}</td>
|
4229
|
+
<td style="padding:15px">Yes</td>
|
4230
|
+
</tr>
|
4231
|
+
<tr>
|
4232
|
+
<td style="padding:15px">deleteAnEarlyAccessFeatureOptIn(organizationId, optInId, callback)</td>
|
4233
|
+
<td style="padding:15px">Delete an early access feature opt-in</td>
|
4234
|
+
<td style="padding:15px">{base_path}/{version}/organizations/{pathv1}/earlyAccess/features/optIns/{pathv2}?{query}</td>
|
4235
|
+
<td style="padding:15px">Yes</td>
|
4236
|
+
</tr>
|
4237
|
+
<tr>
|
4238
|
+
<td style="padding:15px">showAnEarlyAccessFeatureOptInForAnOrganization(organizationId, optInId, callback)</td>
|
4239
|
+
<td style="padding:15px">Show an early access feature opt-in for an organization</td>
|
4240
|
+
<td style="padding:15px">{base_path}/{version}/organizations/{pathv1}/earlyAccess/features/optIns/{pathv2}?{query}</td>
|
4241
|
+
<td style="padding:15px">Yes</td>
|
4242
|
+
</tr>
|
4243
|
+
<tr>
|
4244
|
+
<td style="padding:15px">updateAnEarlyAccessFeatureOptInForAnOrganization(organizationId, optInId, body, callback)</td>
|
4245
|
+
<td style="padding:15px">Update an early access feature opt-in for an organization
|
4246
|
+
#### Body Parameters
|
4247
|
+
**Parameter**|**Type**|**Description**
|
4248
|
+
:-------------: |:-------------: |:-------------:
|
4249
|
+
limitScopeToNetworks| array| A list of network IDs to apply the opt-in to
|
4250
|
+
|
4251
|
+
#### Supports Action Batches
|
4252
|
+
|
4253
|
+
**Resource**|**Operation**
|
4254
|
+
:-------------: |:-------------:
|
4255
|
+
`/organizations/{organizationId}/earlyAccess/features/optIns/{optInId}` | update
|
4256
|
+
|
4257
|
+
</td>
|
4258
|
+
<td style="padding:15px">{base_path}/{version}/organizations/{pathv1}/earlyAccess/features/optIns/{pathv2}?{query}</td>
|
4259
|
+
<td style="padding:15px">Yes</td>
|
4260
|
+
</tr>
|
4261
|
+
<tr>
|
4262
|
+
<td style="padding:15px">listTheAvailableEarlyAccessFeaturesForOrganization(organizationId, callback)</td>
|
4263
|
+
<td style="padding:15px">List the available early access features for organization</td>
|
4264
|
+
<td style="padding:15px">{base_path}/{version}/organizations/{pathv1}/earlyAccess/features?{query}</td>
|
4265
|
+
<td style="padding:15px">Yes</td>
|
4266
|
+
</tr>
|
4267
|
+
<tr>
|
4268
|
+
<td style="padding:15px">claimAListOfDevicesLicensesAndOrOrdersIntoAnOrganizationInventory(organizationId, body, callback)</td>
|
4269
|
+
<td style="padding:15px">Claim a list of devices, licenses, and/or orders into an organization inventory. When claiming by order, all devices and licenses in the order will be claimed; licenses will be added to the organization and devices will be placed in the organization's inventory. Use /organizations/{organizationId}/inventory/release to release devices from an organization.</td>
|
4270
|
+
<td style="padding:15px">{base_path}/{version}/organizations/{pathv1}/inventory/claim?{query}</td>
|
4271
|
+
<td style="padding:15px">Yes</td>
|
4272
|
+
</tr>
|
4273
|
+
<tr>
|
4274
|
+
<td style="padding:15px">releaseAListOfClaimedDevicesFromAnOrganization(organizationId, body, callback)</td>
|
4275
|
+
<td style="padding:15px">Release a list of claimed devices from an organization.
|
4276
|
+
#### Body Parameters
|
4277
|
+
**Parameter**|**Type**|**Description**
|
4278
|
+
:-------------: |:-------------: |:-------------:
|
4279
|
+
serials| array| Serials of the devices that should be released
|
4280
|
+
</td>
|
4281
|
+
<td style="padding:15px">{base_path}/{version}/organizations/{pathv1}/inventory/release?{query}</td>
|
4282
|
+
<td style="padding:15px">Yes</td>
|
4283
|
+
</tr>
|
4284
|
+
<tr>
|
4285
|
+
<td style="padding:15px">returnsTheLoginSecuritySettingsForAnOrganization(organizationId, callback)</td>
|
4286
|
+
<td style="padding:15px">Returns the login security settings for an organization.</td>
|
4287
|
+
<td style="padding:15px">{base_path}/{version}/organizations/{pathv1}/loginSecurity?{query}</td>
|
4288
|
+
<td style="padding:15px">Yes</td>
|
4289
|
+
</tr>
|
4290
|
+
<tr>
|
4291
|
+
<td style="padding:15px">updateTheLoginSecuritySettingsForAnOrganization(organizationId, body, callback)</td>
|
4292
|
+
<td style="padding:15px">Update the login security settings for an organization
|
4293
|
+
#### Body Parameters
|
4294
|
+
**Parameter**|**Type**|**Description**
|
4295
|
+
:-------------: |:-------------: |:-------------:
|
4296
|
+
enforcePasswordExpiration| boolean| Boolean indicating whether users are forced to change their password every X number of days.
|
4297
|
+
passwordExpirationDays| integer| Number of days after which users will be forced to change their password.
|
4298
|
+
enforceDifferentPasswords| boolean| Boolean indicating whether users, when setting a new passw...(description truncated)</td>
|
4299
|
+
<td style="padding:15px">{base_path}/{version}/organizations/{pathv1}/loginSecurity?{query}</td>
|
4300
|
+
<td style="padding:15px">Yes</td>
|
4301
|
+
</tr>
|
4302
|
+
<tr>
|
4303
|
+
<td style="padding:15px">createASAMLIdPForYourOrganization(organizationId, body, callback)</td>
|
4304
|
+
<td style="padding:15px">Create a SAML IdP for your organization.
|
4305
|
+
#### Body Parameters
|
4306
|
+
**Parameter**|**Type**|**Description**
|
4307
|
+
:-------------: |:-------------: |:-------------:
|
4308
|
+
x509certSha1Fingerprint| string| Fingerprint (SHA1) of the SAML certificate provided by your Identity Provider (IdP). This will be used for encryption / validation.
|
4309
|
+
sloLogoutUrl| string| Dashboard will redirect users to this URL when they sign out.
|
4310
|
+
|
4311
|
+
#### Supports Action Batches
|
4312
|
+
|
4313
|
+
**Resource**|**Operation**
|
4314
|
+
:-------------: |:-------------:
|
4315
|
+
`/or...(description truncated)</td>
|
4316
|
+
<td style="padding:15px">{base_path}/{version}/organizations/{pathv1}/saml/idps?{query}</td>
|
4317
|
+
<td style="padding:15px">Yes</td>
|
4318
|
+
</tr>
|
4319
|
+
<tr>
|
4320
|
+
<td style="padding:15px">listTheSAMLIdPsInYourOrganization(organizationId, callback)</td>
|
4321
|
+
<td style="padding:15px">List the SAML IdPs in your organization.</td>
|
4322
|
+
<td style="padding:15px">{base_path}/{version}/organizations/{pathv1}/saml/idps?{query}</td>
|
4323
|
+
<td style="padding:15px">Yes</td>
|
4324
|
+
</tr>
|
4325
|
+
<tr>
|
4326
|
+
<td style="padding:15px">getASAMLIdPFromYourOrganization(organizationId, idpId, callback)</td>
|
4327
|
+
<td style="padding:15px">Get a SAML IdP from your organization.</td>
|
4328
|
+
<td style="padding:15px">{base_path}/{version}/organizations/{pathv1}/saml/idps/{pathv2}?{query}</td>
|
4329
|
+
<td style="padding:15px">Yes</td>
|
4330
|
+
</tr>
|
4331
|
+
<tr>
|
4332
|
+
<td style="padding:15px">removeASAMLIdPInYourOrganization(organizationId, idpId, callback)</td>
|
4333
|
+
<td style="padding:15px">Remove a SAML IdP in your organization.
|
4334
|
+
#### Supports Action Batches
|
4335
|
+
|
4336
|
+
**Resource**|**Operation**
|
4337
|
+
:-------------: |:-------------:
|
4338
|
+
`/organizations/{organizationId}/saml/idps/{idpId}` | destroy
|
4339
|
+
|
4340
|
+
</td>
|
4341
|
+
<td style="padding:15px">{base_path}/{version}/organizations/{pathv1}/saml/idps/{pathv2}?{query}</td>
|
4342
|
+
<td style="padding:15px">Yes</td>
|
4343
|
+
</tr>
|
4344
|
+
<tr>
|
4345
|
+
<td style="padding:15px">updateASAMLIdPInYourOrganization(organizationId, idpId, body, callback)</td>
|
4346
|
+
<td style="padding:15px">Update a SAML IdP in your organization
|
4347
|
+
#### Body Parameters
|
4348
|
+
**Parameter**|**Type**|**Description**
|
4349
|
+
:-------------: |:-------------: |:-------------:
|
4350
|
+
x509certSha1Fingerprint| string| Fingerprint (SHA1) of the SAML certificate provided by your Identity Provider (IdP). This will be used for encryption / validation.
|
4351
|
+
sloLogoutUrl| string| Dashboard will redirect users to this URL when they sign out.
|
4352
|
+
|
4353
|
+
#### Supports Action Batches
|
4354
|
+
|
4355
|
+
**Resource**|**Operation**
|
4356
|
+
:-------------: |:-------------:
|
4357
|
+
`/orga...(description truncated)</td>
|
4358
|
+
<td style="padding:15px">{base_path}/{version}/organizations/{pathv1}/saml/idps/{pathv2}?{query}</td>
|
4359
|
+
<td style="padding:15px">Yes</td>
|
4360
|
+
</tr>
|
4361
|
+
<tr>
|
4362
|
+
<td style="padding:15px">returnsTheSAMLSSOEnabledSettingsForAnOrganization(organizationId, callback)</td>
|
4363
|
+
<td style="padding:15px">Returns the SAML SSO enabled settings for an organization.</td>
|
4364
|
+
<td style="padding:15px">{base_path}/{version}/organizations/{pathv1}/saml?{query}</td>
|
4365
|
+
<td style="padding:15px">Yes</td>
|
4366
|
+
</tr>
|
4367
|
+
<tr>
|
4368
|
+
<td style="padding:15px">updatesTheSAMLSSOEnabledSettingsForAnOrganization(organizationId, body, callback)</td>
|
4369
|
+
<td style="padding:15px">Updates the SAML SSO enabled settings for an organization.
|
4370
|
+
#### Body Parameters
|
4371
|
+
**Parameter**|**Type**|**Description**
|
4372
|
+
:-------------: |:-------------: |:-------------:
|
4373
|
+
enabled| boolean| Boolean for updating SAML SSO enabled settings.
|
4374
|
+
</td>
|
4375
|
+
<td style="padding:15px">{base_path}/{version}/organizations/{pathv1}/saml?{query}</td>
|
4376
|
+
<td style="padding:15px">Yes</td>
|
4377
|
+
</tr>
|
4378
|
+
<tr>
|
4379
|
+
<td style="padding:15px">listtheavailabilityinformationfordevicesinanorganization(organizationId, callback)</td>
|
4380
|
+
<td style="padding:15px">List the availability information for devices in an organization. The data returned by this endpoint is updated every 5 minutes.</td>
|
4381
|
+
<td style="padding:15px">{base_path}/{version}/organizations/{pathv1}/devices/availabilities?{query}</td>
|
4382
|
+
<td style="padding:15px">Yes</td>
|
4383
|
+
</tr>
|
4384
|
+
<tr>
|
4385
|
+
<td style="padding:15px">returnthetop10appliancessortedbyutilizationovergiventimerange(organizationId, callback)</td>
|
4386
|
+
<td style="padding:15px">Return the top 10 appliances sorted by utilization over given time range.</td>
|
4387
|
+
<td style="padding:15px">{base_path}/{version}/organizations/{pathv1}/summary/top/appliances/byUtilization?{query}</td>
|
4388
|
+
<td style="padding:15px">Yes</td>
|
4389
|
+
</tr>
|
4390
|
+
<tr>
|
4391
|
+
<td style="padding:15px">returnmetricsfororganizationStop10clientsbydatausageInmbOvergiventimerange(organizationId, callback)</td>
|
4392
|
+
<td style="padding:15px">Return metrics for organization's top 10 clients by data usage (in mb) over given time range.</td>
|
4393
|
+
<td style="padding:15px">{base_path}/{version}/organizations/{pathv1}/summary/top/clients/byUsage?{query}</td>
|
4394
|
+
<td style="padding:15px">Yes</td>
|
4395
|
+
</tr>
|
4396
|
+
<tr>
|
4397
|
+
<td style="padding:15px">returnmetricsfororganizationStop10devicessortedbydatausageovergiventimerange(organizationId, callback)</td>
|
4398
|
+
<td style="padding:15px">Return metrics for organization's top 10 devices sorted by data usage over given time range. Default unit is megabytes.</td>
|
4399
|
+
<td style="padding:15px">{base_path}/{version}/organizations/{pathv1}/summary/top/devices/byUsage?{query}</td>
|
4400
|
+
<td style="padding:15px">Yes</td>
|
4401
|
+
</tr>
|
4402
|
+
<tr>
|
4403
|
+
<td style="padding:15px">returnmetricsfororganizationStopclientsbydatausageInmbOvergiventimerangeGroupedbymanufacturer(organizationId, callback)</td>
|
4404
|
+
<td style="padding:15px">Return metrics for organization's top clients by data usage (in mb) over given time range, grouped by manufacturer.</td>
|
4405
|
+
<td style="padding:15px">{base_path}/{version}/organizations/{pathv1}/summary/top/clients/manufacturers/byUsage?{query}</td>
|
4406
|
+
<td style="padding:15px">Yes</td>
|
4407
|
+
</tr>
|
4408
|
+
<tr>
|
4409
|
+
<td style="padding:15px">returnmetricsfororganizationStop10devicemodelssortedbydatausageovergiventimerange(organizationId, callback)</td>
|
4410
|
+
<td style="padding:15px">Return metrics for organization's top 10 device models sorted by data usage over given time range. Default unit is megabytes.</td>
|
4411
|
+
<td style="padding:15px">{base_path}/{version}/organizations/{pathv1}/summary/top/devices/models/byUsage?{query}</td>
|
4412
|
+
<td style="padding:15px">Yes</td>
|
4413
|
+
</tr>
|
4414
|
+
<tr>
|
4415
|
+
<td style="padding:15px">returnmetricsfororganizationStop10ssidsbydatausageovergiventimerange(organizationId, callback)</td>
|
4416
|
+
<td style="padding:15px">Return metrics for organization's top 10 ssids by data usage over given time range. Default unit is megabytes.</td>
|
4417
|
+
<td style="padding:15px">{base_path}/{version}/organizations/{pathv1}/summary/top/ssids/byUsage?{query}</td>
|
4418
|
+
<td style="padding:15px">Yes</td>
|
4419
|
+
</tr>
|
4420
|
+
<tr>
|
4421
|
+
<td style="padding:15px">returnmetricsfororganizationStop10switchesbyenergyusageovergiventimerange(organizationId, callback)</td>
|
4422
|
+
<td style="padding:15px">Return metrics for organization's top 10 switches by energy usage over given time range. Default unit is joules.</td>
|
4423
|
+
<td style="padding:15px">{base_path}/{version}/organizations/{pathv1}/summary/top/switches/byEnergyUsage?{query}</td>
|
4424
|
+
<td style="padding:15px">Yes</td>
|
4425
|
+
</tr>
|
4426
|
+
<tr>
|
4427
|
+
<td style="padding:15px">returnalistofalerttypestobeusedwithmanagingwebhookalerts(organizationId, callback)</td>
|
4428
|
+
<td style="padding:15px">Return a list of alert types to be used with managing webhook alerts</td>
|
4429
|
+
<td style="padding:15px">{base_path}/{version}/organizations/{pathv1}/webhooks/alertTypes?{query}</td>
|
4430
|
+
<td style="padding:15px">Yes</td>
|
4431
|
+
</tr>
|
168
4432
|
</table>
|
169
4433
|
<br>
|