@itentialopensource/adapter-meraki 1.1.0 → 1.2.1
Sign up to get free protection for your applications and to get access to all the features.
- package/CALLS.md +457 -1163
- package/CHANGELOG.md +16 -0
- package/README.md +11 -7
- package/adapterBase.js +103 -0
- package/metadata.json +20 -6
- package/package.json +4 -4
- package/propertiesSchema.json +64 -0
- package/refs?service=git-upload-pack +0 -0
- package/report/adapter-openapi.json +5460 -0
- package/report/adapter-openapi.yaml +3774 -0
- package/report/adapterInfo.json +5 -5
- package/report/updateReport1692203092612.json +120 -0
- package/report/updateReport1694439659179.json +120 -0
- package/sampleProperties.json +12 -0
- package/test/unit/adapterBaseTestUnit.js +6 -6
- package/test/unit/adapterTestUnit.js +9 -3
- package/utils/methodDocumentor.js +57 -22
package/CALLS.md
CHANGED
|
@@ -19,7 +19,7 @@ These are adapter methods that IAP or you might use. There are some other method
|
|
|
19
19
|
</tr>
|
|
20
20
|
<tr>
|
|
21
21
|
<td style="padding:15px">healthCheck(callback)</td>
|
|
22
|
-
<td style="padding:15px">This call ensures that the adapter can communicate with Meraki. The actual call that is used is defined in the adapter properties and .system entities action.json file.</td>
|
|
22
|
+
<td style="padding:15px">This call ensures that the adapter can communicate with Adapter for Meraki. The actual call that is used is defined in the adapter properties and .system entities action.json file.</td>
|
|
23
23
|
<td style="padding:15px">No</td>
|
|
24
24
|
</tr>
|
|
25
25
|
<tr>
|
|
@@ -29,7 +29,7 @@ These are adapter methods that IAP or you might use. There are some other method
|
|
|
29
29
|
</tr>
|
|
30
30
|
<tr>
|
|
31
31
|
<td style="padding:15px">encryptProperty(property, technique, callback)</td>
|
|
32
|
-
<td style="padding:15px">This call will take the provided property and technique, and return the property encrypted with the technique. This allows the property to be used in the adapterProps section for the credential password so that the password does not have to be in clear text. The adapter will decrypt the property as needed for communications with Meraki.</td>
|
|
32
|
+
<td style="padding:15px">This call will take the provided property and technique, and return the property encrypted with the technique. This allows the property to be used in the adapterProps section for the credential password so that the password does not have to be in clear text. The adapter will decrypt the property as needed for communications with Adapter for Meraki.</td>
|
|
33
33
|
<td style="padding:15px">No</td>
|
|
34
34
|
</tr>
|
|
35
35
|
<tr>
|
|
@@ -37,11 +37,6 @@ These are adapter methods that IAP or you might use. There are some other method
|
|
|
37
37
|
<td style="padding:15px">This call provides the ability to update the adapter configuration from IAP - includes actions, schema, mockdata and other configurations.</td>
|
|
38
38
|
<td style="padding:15px">Yes</td>
|
|
39
39
|
</tr>
|
|
40
|
-
<tr>
|
|
41
|
-
<td style="padding:15px">iapFindAdapterPath(apiPath, callback)</td>
|
|
42
|
-
<td style="padding:15px">This call provides the ability to see if a particular API path is supported by the adapter.</td>
|
|
43
|
-
<td style="padding:15px">Yes</td>
|
|
44
|
-
</tr>
|
|
45
40
|
<tr>
|
|
46
41
|
<td style="padding:15px">iapSuspendAdapter(mode, callback)</td>
|
|
47
42
|
<td style="padding:15px">This call provides the ability to suspend the adapter and either have requests rejected or put into a queue to be processed after the adapter is resumed.</td>
|
|
@@ -57,12 +52,16 @@ These are adapter methods that IAP or you might use. There are some other method
|
|
|
57
52
|
<td style="padding:15px">This call will return the requests that are waiting in the queue if throttling is enabled.</td>
|
|
58
53
|
<td style="padding:15px">Yes</td>
|
|
59
54
|
</tr>
|
|
55
|
+
<tr>
|
|
56
|
+
<td style="padding:15px">iapFindAdapterPath(apiPath, callback)</td>
|
|
57
|
+
<td style="padding:15px">This call provides the ability to see if a particular API path is supported by the adapter.</td>
|
|
58
|
+
<td style="padding:15px">Yes</td>
|
|
59
|
+
</tr>
|
|
60
60
|
<tr>
|
|
61
61
|
<td style="padding:15px">iapTroubleshootAdapter(props, persistFlag, adapter, callback)</td>
|
|
62
62
|
<td style="padding:15px">This call can be used to check on the performance of the adapter - it checks connectivity, healthcheck and basic get calls.</td>
|
|
63
63
|
<td style="padding:15px">Yes</td>
|
|
64
64
|
</tr>
|
|
65
|
-
|
|
66
65
|
<tr>
|
|
67
66
|
<td style="padding:15px">iapRunAdapterHealthcheck(adapter, callback)</td>
|
|
68
67
|
<td style="padding:15px">This call will return the results of a healthcheck.</td>
|
|
@@ -83,6 +82,21 @@ These are adapter methods that IAP or you might use. There are some other method
|
|
|
83
82
|
<td style="padding:15px">This call will push the adapter configuration from the entities directory into the Adapter or IAP Database.</td>
|
|
84
83
|
<td style="padding:15px">Yes</td>
|
|
85
84
|
</tr>
|
|
85
|
+
<tr>
|
|
86
|
+
<td style="padding:15px">iapDeactivateTasks(tasks, callback)</td>
|
|
87
|
+
<td style="padding:15px">This call provides the ability to remove tasks from the adapter.</td>
|
|
88
|
+
<td style="padding:15px">Yes</td>
|
|
89
|
+
</tr>
|
|
90
|
+
<tr>
|
|
91
|
+
<td style="padding:15px">iapActivateTasks(tasks, callback)</td>
|
|
92
|
+
<td style="padding:15px">This call provides the ability to add deactivated tasks back into the adapter.</td>
|
|
93
|
+
<td style="padding:15px">Yes</td>
|
|
94
|
+
</tr>
|
|
95
|
+
<tr>
|
|
96
|
+
<td style="padding:15px">iapExpandedGenericAdapterRequest(metadata, uriPath, restMethod, pathVars, queryData, requestBody, addlHeaders, callback)</td>
|
|
97
|
+
<td style="padding:15px">This is an expanded Generic Call. The metadata object allows us to provide many new capabilities within the generic request.</td>
|
|
98
|
+
<td style="padding:15px">Yes</td>
|
|
99
|
+
</tr>
|
|
86
100
|
<tr>
|
|
87
101
|
<td style="padding:15px">genericAdapterRequest(uriPath, restMethod, queryData, requestBody, addlHeaders, callback)</td>
|
|
88
102
|
<td style="padding:15px">This call allows you to provide the path to have the adapter call. It is an easy way to incorporate paths that have not been built into the adapter yet.</td>
|
|
@@ -94,19 +108,42 @@ These are adapter methods that IAP or you might use. There are some other method
|
|
|
94
108
|
<td style="padding:15px">Yes</td>
|
|
95
109
|
</tr>
|
|
96
110
|
<tr>
|
|
97
|
-
<td style="padding:15px">
|
|
98
|
-
<td style="padding:15px">
|
|
99
|
-
<td style="padding:15px">
|
|
111
|
+
<td style="padding:15px">iapRunAdapterLint(callback)</td>
|
|
112
|
+
<td style="padding:15px">Runs lint on the addapter and provides the information back.</td>
|
|
113
|
+
<td style="padding:15px">Yes</td>
|
|
100
114
|
</tr>
|
|
101
115
|
<tr>
|
|
102
|
-
<td style="padding:15px">
|
|
103
|
-
<td style="padding:15px">
|
|
104
|
-
<td style="padding:15px">
|
|
116
|
+
<td style="padding:15px">iapRunAdapterTests(callback)</td>
|
|
117
|
+
<td style="padding:15px">Runs baseunit and unit tests on the adapter and provides the information back.</td>
|
|
118
|
+
<td style="padding:15px">Yes</td>
|
|
105
119
|
</tr>
|
|
106
120
|
<tr>
|
|
107
|
-
<td style="padding:15px">
|
|
108
|
-
<td style="padding:15px">This call
|
|
109
|
-
<td style="padding:15px">
|
|
121
|
+
<td style="padding:15px">iapGetAdapterInventory(callback)</td>
|
|
122
|
+
<td style="padding:15px">This call provides some inventory related information about the adapter.</td>
|
|
123
|
+
<td style="padding:15px">Yes</td>
|
|
124
|
+
</tr>
|
|
125
|
+
</table>
|
|
126
|
+
<br>
|
|
127
|
+
|
|
128
|
+
### Adapter Cache Calls
|
|
129
|
+
|
|
130
|
+
These are adapter methods that are used for adapter caching. If configured, the adapter will cache based on the interval provided. However, you can force a population of the cache manually as well.
|
|
131
|
+
|
|
132
|
+
<table border="1" class="bordered-table">
|
|
133
|
+
<tr>
|
|
134
|
+
<th bgcolor="lightgrey" style="padding:15px"><span style="font-size:12.0pt">Method Signature</span></th>
|
|
135
|
+
<th bgcolor="lightgrey" style="padding:15px"><span style="font-size:12.0pt">Description</span></th>
|
|
136
|
+
<th bgcolor="lightgrey" style="padding:15px"><span style="font-size:12.0pt">Workflow?</span></th>
|
|
137
|
+
</tr>
|
|
138
|
+
<tr>
|
|
139
|
+
<td style="padding:15px">iapPopulateEntityCache(entityTypes, callback)</td>
|
|
140
|
+
<td style="padding:15px">This call populates the adapter cache.</td>
|
|
141
|
+
<td style="padding:15px">Yes</td>
|
|
142
|
+
</tr>
|
|
143
|
+
<tr>
|
|
144
|
+
<td style="padding:15px">iapRetrieveEntitiesCache(entityType, options, callback)</td>
|
|
145
|
+
<td style="padding:15px">This call retrieves the specific items from the adapter cache.</td>
|
|
146
|
+
<td style="padding:15px">Yes</td>
|
|
110
147
|
</tr>
|
|
111
148
|
</table>
|
|
112
149
|
<br>
|
|
@@ -129,27 +166,27 @@ These are adapter methods that are used to integrate to IAP Brokers. This adapte
|
|
|
129
166
|
<tr>
|
|
130
167
|
<td style="padding:15px">getDevice(deviceName, callback)</td>
|
|
131
168
|
<td style="padding:15px">This call returns the details of the requested device.</td>
|
|
132
|
-
<td style="padding:15px">
|
|
169
|
+
<td style="padding:15px">No</td>
|
|
133
170
|
</tr>
|
|
134
171
|
<tr>
|
|
135
172
|
<td style="padding:15px">getDevicesFiltered(options, callback)</td>
|
|
136
173
|
<td style="padding:15px">This call returns the list of devices that match the criteria provided in the options filter.</td>
|
|
137
|
-
<td style="padding:15px">
|
|
174
|
+
<td style="padding:15px">No</td>
|
|
138
175
|
</tr>
|
|
139
176
|
<tr>
|
|
140
177
|
<td style="padding:15px">isAlive(deviceName, callback)</td>
|
|
141
178
|
<td style="padding:15px">This call returns whether the device status is active</td>
|
|
142
|
-
<td style="padding:15px">
|
|
179
|
+
<td style="padding:15px">No</td>
|
|
143
180
|
</tr>
|
|
144
181
|
<tr>
|
|
145
182
|
<td style="padding:15px">getConfig(deviceName, format, callback)</td>
|
|
146
183
|
<td style="padding:15px">This call returns the configuration for the selected device.</td>
|
|
147
|
-
<td style="padding:15px">
|
|
184
|
+
<td style="padding:15px">No</td>
|
|
148
185
|
</tr>
|
|
149
186
|
<tr>
|
|
150
187
|
<td style="padding:15px">iapGetDeviceCount(callback)</td>
|
|
151
188
|
<td style="padding:15px">This call returns the count of devices.</td>
|
|
152
|
-
<td style="padding:15px">
|
|
189
|
+
<td style="padding:15px">No</td>
|
|
153
190
|
</tr>
|
|
154
191
|
</table>
|
|
155
192
|
<br>
|
|
@@ -222,13 +259,13 @@ Specific adapter calls are built based on the API of the Meraki. The Adapter Bui
|
|
|
222
259
|
<tr>
|
|
223
260
|
<td style="padding:15px">getNetworkAlertSettings(networkId, callback)</td>
|
|
224
261
|
<td style="padding:15px">Return the alert configuration for this network</td>
|
|
225
|
-
<td style="padding:15px">
|
|
262
|
+
<td style="padding:15px">v0:{base_path}/{version}/networks/{pathv1}/alertSettings?{query} <br /> v1:{base_path}/{version}/networks/{pathv1}/alerts/Settings?{query}</td>
|
|
226
263
|
<td style="padding:15px">Yes</td>
|
|
227
264
|
</tr>
|
|
228
265
|
<tr>
|
|
229
266
|
<td style="padding:15px">updateNetworkAlertSettings(networkId, updateNetworkAlertSettings, callback)</td>
|
|
230
267
|
<td style="padding:15px">Update the alert configuration for this network</td>
|
|
231
|
-
<td style="padding:15px">
|
|
268
|
+
<td style="padding:15px">v0:{base_path}/{version}/networks/{pathv1}/alertSettings?{query} <br /> v1:{base_path}/{version}/networks/{pathv1}/alerts/Settings?{query}</td>
|
|
232
269
|
<td style="padding:15px">Yes</td>
|
|
233
270
|
</tr>
|
|
234
271
|
<tr>
|
|
@@ -237,6 +274,12 @@ Specific adapter calls are built based on the API of the Meraki. The Adapter Bui
|
|
|
237
274
|
<td style="padding:15px">{base_path}/{version}/devices/{pathv1}/camera/analytics/overview?{query}</td>
|
|
238
275
|
<td style="padding:15px">Yes</td>
|
|
239
276
|
</tr>
|
|
277
|
+
<tr>
|
|
278
|
+
<td style="padding:15px">getDeviceCameraAnalyticsOverviewV2(serial, queryVars, callback)</td>
|
|
279
|
+
<td style="padding:15px">Returns an overview of aggregate analytics data for a timespan</td>
|
|
280
|
+
<td style="padding:15px">{base_path}/{version}/devices/{pathv1}/camera/analytics/overview?{query}</td>
|
|
281
|
+
<td style="padding:15px">Yes</td>
|
|
282
|
+
</tr>
|
|
240
283
|
<tr>
|
|
241
284
|
<td style="padding:15px">getDeviceCameraAnalyticsZones(serial, callback)</td>
|
|
242
285
|
<td style="padding:15px">Returns all configured analytic zones for this camera</td>
|
|
@@ -249,12 +292,24 @@ Specific adapter calls are built based on the API of the Meraki. The Adapter Bui
|
|
|
249
292
|
<td style="padding:15px">{base_path}/{version}/devices/{pathv1}/camera/analytics/zones/{pathv2}/history?{query}</td>
|
|
250
293
|
<td style="padding:15px">Yes</td>
|
|
251
294
|
</tr>
|
|
295
|
+
<tr>
|
|
296
|
+
<td style="padding:15px">getDeviceCameraAnalyticsZoneHistoryV2(serial, zoneId, queryVars, callback)</td>
|
|
297
|
+
<td style="padding:15px">Return historical records for analytic zones</td>
|
|
298
|
+
<td style="padding:15px">{base_path}/{version}/devices/{pathv1}/camera/analytics/zones/{pathv2}/history?{query}</td>
|
|
299
|
+
<td style="padding:15px">Yes</td>
|
|
300
|
+
</tr>
|
|
252
301
|
<tr>
|
|
253
302
|
<td style="padding:15px">getDeviceCameraAnalyticsRecent(serial, callback)</td>
|
|
254
303
|
<td style="padding:15px">Returns most recent record for analytics zones</td>
|
|
255
304
|
<td style="padding:15px">{base_path}/{version}/devices/{pathv1}/camera/analytics/recent?{query}</td>
|
|
256
305
|
<td style="padding:15px">Yes</td>
|
|
257
306
|
</tr>
|
|
307
|
+
<tr>
|
|
308
|
+
<td style="padding:15px">getDeviceCameraAnalyticsRecentV2(serial, queryVars, callback)</td>
|
|
309
|
+
<td style="padding:15px">Returns most recent record for analytics zones</td>
|
|
310
|
+
<td style="padding:15px">{base_path}/{version}/devices/{pathv1}/camera/analytics/recent?{query}</td>
|
|
311
|
+
<td style="padding:15px">Yes</td>
|
|
312
|
+
</tr>
|
|
258
313
|
<tr>
|
|
259
314
|
<td style="padding:15px">getDeviceCameraAnalyticsLive(serial, callback)</td>
|
|
260
315
|
<td style="padding:15px">Returns live state from camera of analytics zones</td>
|
|
@@ -267,6 +322,12 @@ Specific adapter calls are built based on the API of the Meraki. The Adapter Bui
|
|
|
267
322
|
<td style="padding:15px">{base_path}/{version}/organizations/{pathv1}/apiRequests?{query}</td>
|
|
268
323
|
<td style="padding:15px">Yes</td>
|
|
269
324
|
</tr>
|
|
325
|
+
<tr>
|
|
326
|
+
<td style="padding:15px">getOrganizationApiRequestsV2(organizationId, queryVars, callback)</td>
|
|
327
|
+
<td style="padding:15px">List the API requests made by an organization</td>
|
|
328
|
+
<td style="padding:15px">{base_path}/{version}/organizations/{pathv1}/apiRequests?{query}</td>
|
|
329
|
+
<td style="padding:15px">Yes</td>
|
|
330
|
+
</tr>
|
|
270
331
|
<tr>
|
|
271
332
|
<td style="padding:15px">getNetworkBluetoothClient(networkId, bluetoothClientId, includeConnectivityHistory, connectivityHistoryTimespan, callback)</td>
|
|
272
333
|
<td style="padding:15px">Return a Bluetooth client. Bluetooth clients can be identified by their ID or their MAC.</td>
|
|
@@ -279,6 +340,12 @@ Specific adapter calls are built based on the API of the Meraki. The Adapter Bui
|
|
|
279
340
|
<td style="padding:15px">{base_path}/{version}/networks/{pathv1}/bluetoothClients?{query}</td>
|
|
280
341
|
<td style="padding:15px">Yes</td>
|
|
281
342
|
</tr>
|
|
343
|
+
<tr>
|
|
344
|
+
<td style="padding:15px">getNetworkBluetoothClientsV2(networkId, queryVars, callback)</td>
|
|
345
|
+
<td style="padding:15px">List the Bluetooth clients seen by APs in this network</td>
|
|
346
|
+
<td style="padding:15px">{base_path}/{version}/networks/{pathv1}/bluetoothClients?{query}</td>
|
|
347
|
+
<td style="padding:15px">Yes</td>
|
|
348
|
+
</tr>
|
|
282
349
|
<tr>
|
|
283
350
|
<td style="padding:15px">getNetworkBluetoothSettings(networkId, callback)</td>
|
|
284
351
|
<td style="padding:15px">Return the Bluetooth settings for a network. Bluetooth settings must be enabled on the network.</td>
|
|
@@ -336,6 +403,13 @@ Specific adapter calls are built based on the API of the Meraki. The Adapter Bui
|
|
|
336
403
|
<tr>
|
|
337
404
|
<td style="padding:15px">getNetworkTraffic(networkId, timespan, deviceType, callback)</td>
|
|
338
405
|
<td style="padding:15px">The traffic analysis data for this network.
|
|
406
|
+
Traffic Analysis with Hostname Visibility must be enabled on the network.</td>
|
|
407
|
+
<td style="padding:15px">{base_path}/{version}/networks/{pathv1}/traffic?{query}</td>
|
|
408
|
+
<td style="padding:15px">Yes</td>
|
|
409
|
+
</tr>
|
|
410
|
+
<tr>
|
|
411
|
+
<td style="padding:15px">getNetworkTrafficV2(networkId, queryVars, callback)</td>
|
|
412
|
+
<td style="padding:15px">The traffic analysis data for this network.
|
|
339
413
|
Traffic Analysis with Hostname Visibility must be enabled on the network.</td>
|
|
340
414
|
<td style="padding:15px">{base_path}/{version}/networks/{pathv1}/traffic?{query}</td>
|
|
341
415
|
<td style="padding:15px">Yes</td>
|
|
@@ -361,7 +435,7 @@ Specific adapter calls are built based on the API of the Meraki. The Adapter Bui
|
|
|
361
435
|
<tr>
|
|
362
436
|
<td style="padding:15px">getNetworkAirMarshal(networkId, t0, timespan, callback)</td>
|
|
363
437
|
<td style="padding:15px">List Air Marshal scan results from a network</td>
|
|
364
|
-
<td style="padding:15px">
|
|
438
|
+
<td style="padding:15px">v0:{base_path}/{version}/networks/{pathv1}/airMarshal?{query} <br /> v1:{base_path}/{version}/networks/{pathv1}/wireless/airMarshal?{query}</td>
|
|
365
439
|
<td style="padding:15px">Yes</td>
|
|
366
440
|
</tr>
|
|
367
441
|
<tr>
|
|
@@ -379,13 +453,13 @@ Specific adapter calls are built based on the API of the Meraki. The Adapter Bui
|
|
|
379
453
|
<tr>
|
|
380
454
|
<td style="padding:15px">getNetworkSiteToSiteVpn(networkId, callback)</td>
|
|
381
455
|
<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">
|
|
456
|
+
<td style="padding:15px">v0:{base_path}/{version}/networks/{pathv1}/siteToSiteVpn?{query} <br /> v1:{base_path}/{version}/networks/{pathv1}/aplpiance/vpn/siteToSiteVpn?{query}</td>
|
|
383
457
|
<td style="padding:15px">Yes</td>
|
|
384
458
|
</tr>
|
|
385
459
|
<tr>
|
|
386
460
|
<td style="padding:15px">updateNetworkSiteToSiteVpn(networkId, updateNetworkSiteToSiteVpn, callback)</td>
|
|
387
461
|
<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">
|
|
462
|
+
<td style="padding:15px">v0:{base_path}/{version}/networks/{pathv1}/siteToSiteVpn?{query} <br /> v1:{base_path}/{version}/networks/{pathv1}/aplpiance/vpn/siteToSiteVpn?{query}</td>
|
|
389
463
|
<td style="padding:15px">Yes</td>
|
|
390
464
|
</tr>
|
|
391
465
|
<tr>
|
|
@@ -553,7 +627,7 @@ Specific adapter calls are built based on the API of the Meraki. The Adapter Bui
|
|
|
553
627
|
<tr>
|
|
554
628
|
<td style="padding:15px">removeNetworkDevice(networkId, serial, callback)</td>
|
|
555
629
|
<td style="padding:15px">Remove a single device</td>
|
|
556
|
-
<td style="padding:15px">
|
|
630
|
+
<td style="padding:15px">v0:{base_path}/{version}/networks/{pathv1}/devices/{pathv2}/remove?{query} <br /> v1:{base_path}/{version}/networks/{pathv1}/devices/remove?{query}</td>
|
|
557
631
|
<td style="padding:15px">Yes</td>
|
|
558
632
|
</tr>
|
|
559
633
|
<tr>
|
|
@@ -595,67 +669,67 @@ Specific adapter calls are built based on the API of the Meraki. The Adapter Bui
|
|
|
595
669
|
<tr>
|
|
596
670
|
<td style="padding:15px">getNetworkCellularFirewallRules(networkId, callback)</td>
|
|
597
671
|
<td style="padding:15px">Return the cellular firewall rules for an MX network</td>
|
|
598
|
-
<td style="padding:15px">
|
|
672
|
+
<td style="padding:15px">v0:{base_path}/{version}/networks/{pathv1}/cellularFirewallRules?{query} <br /> v1:{base_path}/{version}/networks/{pathv1}/appliance/firewall/cellularFirewallRules?{query}</td>
|
|
599
673
|
<td style="padding:15px">Yes</td>
|
|
600
674
|
</tr>
|
|
601
675
|
<tr>
|
|
602
676
|
<td style="padding:15px">updateNetworkCellularFirewallRules(networkId, updateNetworkCellularFirewallRules, callback)</td>
|
|
603
677
|
<td style="padding:15px">Update the cellular firewall rules of an MX network</td>
|
|
604
|
-
<td style="padding:15px">
|
|
678
|
+
<td style="padding:15px">v0:{base_path}/{version}/networks/{pathv1}/cellularFirewallRules?{query} <br /> v1:{base_path}/{version}/networks/{pathv1}/appliance/firewall/cellularFirewallRules?{query}</td>
|
|
605
679
|
<td style="padding:15px">Yes</td>
|
|
606
680
|
</tr>
|
|
607
681
|
<tr>
|
|
608
682
|
<td style="padding:15px">getNetworkL3FirewallRules(networkId, callback)</td>
|
|
609
683
|
<td style="padding:15px">Return the L3 firewall rules for an MX network</td>
|
|
610
|
-
<td style="padding:15px">
|
|
684
|
+
<td style="padding:15px">v0:{base_path}/{version}/networks/{pathv1}/l3FirewallRules?{query} <br /> v1:{base_path}/{version}/networks/{pathv1}/appliance/firewall/l3FirewallRules?{query}</td>
|
|
611
685
|
<td style="padding:15px">Yes</td>
|
|
612
686
|
</tr>
|
|
613
687
|
<tr>
|
|
614
688
|
<td style="padding:15px">updateNetworkL3FirewallRules(networkId, updateNetworkL3FirewallRules, callback)</td>
|
|
615
689
|
<td style="padding:15px">Update the L3 firewall rules of an MX network</td>
|
|
616
|
-
<td style="padding:15px">
|
|
690
|
+
<td style="padding:15px">v0:{base_path}/{version}/networks/{pathv1}/l3FirewallRules?{query} <br /> v1:{base_path}/{version}/networks/{pathv1}/appliance/firewall/l3FirewallRules?{query}</td>
|
|
617
691
|
<td style="padding:15px">Yes</td>
|
|
618
692
|
</tr>
|
|
619
693
|
<tr>
|
|
620
694
|
<td style="padding:15px">getNetworkL7FirewallRulesApplicationCategories(networkId, callback)</td>
|
|
621
695
|
<td style="padding:15px">Return the L7 firewall application categories and their associated applications for an MX network</td>
|
|
622
|
-
<td style="padding:15px">
|
|
696
|
+
<td style="padding:15px">v0:{base_path}/{version}/networks/{pathv1}/l7FirewallRules/applicationCategories?{query} <br /> v1:{base_path}/{version}/networks/{pathv1}/appliance/firewall/l7FirewallRules/applicationCategories?{query}</td>
|
|
623
697
|
<td style="padding:15px">Yes</td>
|
|
624
698
|
</tr>
|
|
625
699
|
<tr>
|
|
626
700
|
<td style="padding:15px">getNetworkL7FirewallRules(networkId, callback)</td>
|
|
627
701
|
<td style="padding:15px">List the MX L7 firewall rules for an MX network</td>
|
|
628
|
-
<td style="padding:15px">
|
|
702
|
+
<td style="padding:15px">v0:{base_path}/{version}/networks/{pathv1}/l7FirewallRules?{query} <br /> v1:{base_path}/{version}/networks/{pathv1}/appliance/firewall/l7FirewallRules?{query}</td>
|
|
629
703
|
<td style="padding:15px">Yes</td>
|
|
630
704
|
</tr>
|
|
631
705
|
<tr>
|
|
632
706
|
<td style="padding:15px">updateNetworkL7FirewallRules(networkId, updateNetworkL7FirewallRules, callback)</td>
|
|
633
707
|
<td style="padding:15px">Update the MX L7 firewall rules for an MX network</td>
|
|
634
|
-
<td style="padding:15px">
|
|
708
|
+
<td style="padding:15px">v0:{base_path}/{version}/networks/{pathv1}/l7FirewallRules?{query} <br /> v1:{base_path}/{version}/networks/{pathv1}/appliance/firewall/l7FirewallRules?{query}</td>
|
|
635
709
|
<td style="padding:15px">Yes</td>
|
|
636
710
|
</tr>
|
|
637
711
|
<tr>
|
|
638
712
|
<td style="padding:15px">getOrganizationVpnFirewallRules(organizationId, callback)</td>
|
|
639
713
|
<td style="padding:15px">Return the firewall rules for an organization's site-to-site VPN</td>
|
|
640
|
-
<td style="padding:15px">
|
|
714
|
+
<td style="padding:15px">v0:{base_path}/{version}/organizations/{pathv1}/vpnFirewallRules?{query} <br /> v1:{base_path}/{version}/organizations/{pathv1}/appliance/vpn/vpnFirewallRules?{query}</td>
|
|
641
715
|
<td style="padding:15px">Yes</td>
|
|
642
716
|
</tr>
|
|
643
717
|
<tr>
|
|
644
718
|
<td style="padding:15px">updateOrganizationVpnFirewallRules(organizationId, updateOrganizationVpnFirewallRules, callback)</td>
|
|
645
719
|
<td style="padding:15px">Update the firewall rules of an organization's site-to-site VPN</td>
|
|
646
|
-
<td style="padding:15px">
|
|
720
|
+
<td style="padding:15px">v0:{base_path}/{version}/organizations/{pathv1}/vpnFirewallRules?{query} <br /> v1:{base_path}/{version}/organizations/{pathv1}/appliance/vpn/vpnFirewallRules?{query}</td>
|
|
647
721
|
<td style="padding:15px">Yes</td>
|
|
648
722
|
</tr>
|
|
649
723
|
<tr>
|
|
650
724
|
<td style="padding:15px">getNetworkSsidL3FirewallRules(networkId, number, callback)</td>
|
|
651
725
|
<td style="padding:15px">Return the L3 firewall rules for an SSID on an MR network</td>
|
|
652
|
-
<td style="padding:15px">
|
|
726
|
+
<td style="padding:15px">v0:{base_path}/{version}/networks/{pathv1}/ssids/{pathv2}/l3FirewallRules?{query} <br /> v1:{base_path}/{version}/networks/{pathv1}/wireless/ssids/{pathv2}/firewall/l3FirewallRules?{query}</td>
|
|
653
727
|
<td style="padding:15px">Yes</td>
|
|
654
728
|
</tr>
|
|
655
729
|
<tr>
|
|
656
730
|
<td style="padding:15px">updateNetworkSsidL3FirewallRules(networkId, number, updateNetworkSsidL3FirewallRules, callback)</td>
|
|
657
731
|
<td style="padding:15px">Update the L3 firewall rules of an SSID on an MR network</td>
|
|
658
|
-
<td style="padding:15px">
|
|
732
|
+
<td style="padding:15px">v0:{base_path}/{version}/networks/{pathv1}/ssids/{pathv2}/l3FirewallRules?{query} <br /> v1:{base_path}/{version}/networks/{pathv1}/wireless/ssids/{pathv2}/firewall/l3FirewallRules?{query}</td>
|
|
659
733
|
<td style="padding:15px">Yes</td>
|
|
660
734
|
</tr>
|
|
661
735
|
<tr>
|
|
@@ -691,13 +765,13 @@ Specific adapter calls are built based on the API of the Meraki. The Adapter Bui
|
|
|
691
765
|
<tr>
|
|
692
766
|
<td style="padding:15px">getNetworkSsidHotspot20(networkId, number, callback)</td>
|
|
693
767
|
<td style="padding:15px">Return the Hotspot 2.0 settings for an SSID</td>
|
|
694
|
-
<td style="padding:15px">
|
|
768
|
+
<td style="padding:15px">v0:{base_path}/{version}/networks/{pathv1}/ssids/{pathv2}/hotspot20?{query} <br /> v1:{base_path}/{version}/networks/{pathv1}/wireless/ssids/{pathv2}/hotspot20?{query}</td>
|
|
695
769
|
<td style="padding:15px">Yes</td>
|
|
696
770
|
</tr>
|
|
697
771
|
<tr>
|
|
698
772
|
<td style="padding:15px">updateNetworkSsidHotspot20(networkId, number, updateNetworkSsidHotspot20, callback)</td>
|
|
699
773
|
<td style="padding:15px">Update the Hotspot 2.0 settings of an SSID</td>
|
|
700
|
-
<td style="padding:15px">
|
|
774
|
+
<td style="padding:15px">v0:{base_path}/{version}/networks/{pathv1}/ssids/{pathv2}/hotspot20?{query} <br /> v1:{base_path}/{version}/networks/{pathv1}/wireless/ssids/{pathv2}/hotspot20?{query}</td>
|
|
701
775
|
<td style="padding:15px">Yes</td>
|
|
702
776
|
</tr>
|
|
703
777
|
<tr>
|
|
@@ -823,7 +897,13 @@ Specific adapter calls are built based on the API of the Meraki. The Adapter Bui
|
|
|
823
897
|
<tr>
|
|
824
898
|
<td style="padding:15px">getOrganizationInventory(id, callback)</td>
|
|
825
899
|
<td style="padding:15px">Return the inventory for an organization</td>
|
|
826
|
-
<td style="padding:15px">
|
|
900
|
+
<td style="padding:15px">v0:{base_path}/{version}/organizations/{pathv1}/inventory?{query} <br /> v1:{base_path}/{version}/organizations/{pathv1}/inventory/devices?{query}</td>
|
|
901
|
+
<td style="padding:15px">Yes</td>
|
|
902
|
+
</tr>
|
|
903
|
+
<tr>
|
|
904
|
+
<td style="padding:15px">getOrganizationInventoryV2(id, queryVars, callback)</td>
|
|
905
|
+
<td style="padding:15px">Return the inventory for an organization</td>
|
|
906
|
+
<td style="padding:15px">v0:{base_path}/{version}/organizations/{pathv1}/inventory?{query} <br /> v1:{base_path}/{version}/organizations/{pathv1}/inventory/devices?{query}</td>
|
|
827
907
|
<td style="padding:15px">Yes</td>
|
|
828
908
|
</tr>
|
|
829
909
|
<tr>
|
|
@@ -853,139 +933,90 @@ Specific adapter calls are built based on the API of the Meraki. The Adapter Bui
|
|
|
853
933
|
<tr>
|
|
854
934
|
<td style="padding:15px">getOrganizationUplinksLossAndLatency(organizationId, uplink, ip, callback)</td>
|
|
855
935
|
<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">
|
|
936
|
+
<td style="padding:15px">v0:{base_path}/{version}/organizations/{pathv1}/uplinksLossAndLatency?{query} <br /> v1:{base_path}/{version}/organizations/{pathv1}/devices/uplinksLossAndLatency?{query}</td>
|
|
937
|
+
<td style="padding:15px">Yes</td>
|
|
938
|
+
</tr>
|
|
939
|
+
<tr>
|
|
940
|
+
<td style="padding:15px">getOrganizationUplinksLossAndLatencyV2(organizationId, queryVars, callback)</td>
|
|
941
|
+
<td style="padding:15px">Return the uplink loss and latency for every MX in the organization from 2 - 7 minutes ago</td>
|
|
942
|
+
<td style="padding:15px">v0:{base_path}/{version}/organizations/{pathv1}/uplinksLossAndLatency?{query} <br /> v1:{base_path}/{version}/organizations/{pathv1}/devices/uplinksLossAndLatency?{query}</td>
|
|
857
943
|
<td style="padding:15px">Yes</td>
|
|
858
944
|
</tr>
|
|
859
945
|
<tr>
|
|
860
946
|
<td style="padding:15px">getOrganizationThirdPartyVPNPeers(organizationId, callback)</td>
|
|
861
947
|
<td style="padding:15px">Return the third party VPN peers for an organization</td>
|
|
862
|
-
<td style="padding:15px">
|
|
948
|
+
<td style="padding:15px">v0:{base_path}/{version}/organizations/{pathv1}/thirdPartyVPNPeers?{query} <br /> v1:{base_path}/{version}/organizations/{pathv1}/appliance/vpn/thirdPartyVPNPeers?{query}</td>
|
|
863
949
|
<td style="padding:15px">Yes</td>
|
|
864
950
|
</tr>
|
|
865
951
|
<tr>
|
|
866
952
|
<td style="padding:15px">updateOrganizationThirdPartyVPNPeers(organizationId, updateOrganizationThirdPartyVPNPeers, callback)</td>
|
|
867
953
|
<td style="padding:15px">Update the third party VPN peers for an organization</td>
|
|
868
|
-
<td style="padding:15px">
|
|
954
|
+
<td style="padding:15px">v0:{base_path}/{version}/organizations/{pathv1}/thirdPartyVPNPeers?{query} <br /> v1:{base_path}/{version}/organizations/{pathv1}/appliance/vpn/thirdPartyVPNPeers?{query}</td>
|
|
869
955
|
<td style="padding:15px">Yes</td>
|
|
870
956
|
</tr>
|
|
871
957
|
<tr>
|
|
872
958
|
<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>
|
|
959
|
+
<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.</td>
|
|
880
960
|
<td style="padding:15px">{base_path}/{version}/networks/{pathv1}/pii/piiKeys?{query}</td>
|
|
881
961
|
<td style="padding:15px">Yes</td>
|
|
882
962
|
</tr>
|
|
883
963
|
<tr>
|
|
884
964
|
<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>
|
|
965
|
+
<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.</td>
|
|
892
966
|
<td style="padding:15px">{base_path}/{version}/networks/{pathv1}/pii/smDevicesForKey?{query}</td>
|
|
893
967
|
<td style="padding:15px">Yes</td>
|
|
894
968
|
</tr>
|
|
895
969
|
<tr>
|
|
896
970
|
<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>
|
|
971
|
+
<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.</td>
|
|
904
972
|
<td style="padding:15px">{base_path}/{version}/networks/{pathv1}/pii/smOwnersForKey?{query}</td>
|
|
905
973
|
<td style="padding:15px">Yes</td>
|
|
906
974
|
</tr>
|
|
907
975
|
<tr>
|
|
908
976
|
<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>
|
|
977
|
+
<td style="padding:15px">List the PII requests for this network or organization</td>
|
|
916
978
|
<td style="padding:15px">{base_path}/{version}/networks/{pathv1}/pii/requests?{query}</td>
|
|
917
979
|
<td style="padding:15px">Yes</td>
|
|
918
980
|
</tr>
|
|
919
981
|
<tr>
|
|
920
982
|
<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>
|
|
983
|
+
<td style="padding:15px">Submit a new delete or restrict processing PII request</td>
|
|
928
984
|
<td style="padding:15px">{base_path}/{version}/networks/{pathv1}/pii/requests?{query}</td>
|
|
929
985
|
<td style="padding:15px">Yes</td>
|
|
930
986
|
</tr>
|
|
931
987
|
<tr>
|
|
932
988
|
<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>
|
|
989
|
+
<td style="padding:15px">Return a PII request</td>
|
|
940
990
|
<td style="padding:15px">{base_path}/{version}/networks/{pathv1}/pii/requests/{pathv2}?{query}</td>
|
|
941
991
|
<td style="padding:15px">Yes</td>
|
|
942
992
|
</tr>
|
|
943
993
|
<tr>
|
|
944
994
|
<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>
|
|
995
|
+
<td style="padding:15px">Delete a restrict processing PII request</td>
|
|
952
996
|
<td style="padding:15px">{base_path}/{version}/networks/{pathv1}/pii/requests/{pathv2}?{query}</td>
|
|
953
997
|
<td style="padding:15px">Yes</td>
|
|
954
998
|
</tr>
|
|
955
999
|
<tr>
|
|
956
1000
|
<td style="padding:15px">returnTheSNMPSettingsForANetwork(networkId, callback)</td>
|
|
957
|
-
<td style="padding:15px">Return
|
|
958
|
-
<td style="padding:15px">
|
|
1001
|
+
<td style="padding:15px">Return The SNMP Settings For A Network</td>
|
|
1002
|
+
<td style="padding:15px">v0:{base_path}/{version}/networks/{pathv1}/snmpSettings?{query} <br /> v1:{base_path}/{version}/networks/{pathv1}/snmp?{query}</td>
|
|
959
1003
|
<td style="padding:15px">Yes</td>
|
|
960
1004
|
</tr>
|
|
961
1005
|
<tr>
|
|
962
1006
|
<td style="padding:15px">updateTheSNMPSettingsForANetwork(networkId, body, callback)</td>
|
|
963
|
-
<td style="padding:15px">Update
|
|
964
|
-
|
|
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>
|
|
1007
|
+
<td style="padding:15px">Update The SNMP Settings For A Network</td>
|
|
1008
|
+
<td style="padding:15px">v0:{base_path}/{version}/networks/{pathv1}/snmpSettings?{query} <br /> v1:{base_path}/{version}/networks/{pathv1}/snmp?{query}</td>
|
|
971
1009
|
<td style="padding:15px">Yes</td>
|
|
972
1010
|
</tr>
|
|
973
1011
|
<tr>
|
|
974
1012
|
<td style="padding:15px">returnTheSNMPSettingsForAnOrganization(organizationId, callback)</td>
|
|
975
|
-
<td style="padding:15px">Return
|
|
1013
|
+
<td style="padding:15px">Return The SNMP Settings For An Organization</td>
|
|
976
1014
|
<td style="padding:15px">{base_path}/{version}/organizations/{pathv1}/snmp?{query}</td>
|
|
977
1015
|
<td style="padding:15px">Yes</td>
|
|
978
1016
|
</tr>
|
|
979
1017
|
<tr>
|
|
980
1018
|
<td style="padding:15px">updateTheSNMPSettingsForAnOrganization(organizationId, body, callback)</td>
|
|
981
|
-
<td style="padding:15px">Update
|
|
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>
|
|
1019
|
+
<td style="padding:15px">Update The SNMP Settings For An Organization</td>
|
|
989
1020
|
<td style="padding:15px">{base_path}/{version}/organizations/{pathv1}/snmp?{query}</td>
|
|
990
1021
|
<td style="padding:15px">Yes</td>
|
|
991
1022
|
</tr>
|
|
@@ -1052,55 +1083,55 @@ v3AuthPass| string| The SNMP version 3 authentication pass...(description trunca
|
|
|
1052
1083
|
<tr>
|
|
1053
1084
|
<td style="padding:15px">getNetworkClientSecurityEvents(networkId, clientId, t0, t1, timespan, perPage, startingAfter, endingBefore, callback)</td>
|
|
1054
1085
|
<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">
|
|
1086
|
+
<td style="padding:15px">v0:{base_path}/{version}/networks/{pathv1}/clients/{pathv2}/securityEvents?{query} <br /> v1:{base_path}/{version}/networks/{pathv1}/appliance/clients/{pathv2}/security/events?{query}</td>
|
|
1056
1087
|
<td style="padding:15px">Yes</td>
|
|
1057
1088
|
</tr>
|
|
1058
1089
|
<tr>
|
|
1059
1090
|
<td style="padding:15px">getNetworkSecurityEvents(networkId, t0, t1, timespan, perPage, startingAfter, endingBefore, callback)</td>
|
|
1060
1091
|
<td style="padding:15px">List the security events for a network</td>
|
|
1061
|
-
<td style="padding:15px">
|
|
1092
|
+
<td style="padding:15px">v0:{base_path}/{version}/networks/{pathv1}/securityEvents?{query} <br /> v1:{base_path}/{version}/networks/{pathv1}/appliance/security/events?{query}</td>
|
|
1062
1093
|
<td style="padding:15px">Yes</td>
|
|
1063
1094
|
</tr>
|
|
1064
1095
|
<tr>
|
|
1065
1096
|
<td style="padding:15px">getOrganizationSecurityEvents(organizationId, t0, t1, timespan, perPage, startingAfter, endingBefore, callback)</td>
|
|
1066
1097
|
<td style="padding:15px">List the security events for an organization</td>
|
|
1067
|
-
<td style="padding:15px">
|
|
1098
|
+
<td style="padding:15px">v0:{base_path}/{version}/organizations/{pathv1}/securityEvents?{query} <br /> v1:{base_path}/{version}/organizations/{pathv1}/appliance/security/events?{query}</td>
|
|
1068
1099
|
<td style="padding:15px">Yes</td>
|
|
1069
1100
|
</tr>
|
|
1070
1101
|
<tr>
|
|
1071
1102
|
<td style="padding:15px">getNetworkSecurityIntrusionSettings(networkId, callback)</td>
|
|
1072
1103
|
<td style="padding:15px">Returns all supported intrusion settings for an MX network</td>
|
|
1073
|
-
<td style="padding:15px">
|
|
1104
|
+
<td style="padding:15px">v0:{base_path}/{version}/networks/{pathv1}/security/intrusionSettings?{query} <br /> v1:{base_path}/{version}/networks/{pathv1}/appliance/security/intrusionSettings?{query}</td>
|
|
1074
1105
|
<td style="padding:15px">Yes</td>
|
|
1075
1106
|
</tr>
|
|
1076
1107
|
<tr>
|
|
1077
1108
|
<td style="padding:15px">updateNetworkSecurityIntrusionSettings(networkId, updateNetworkSecurityIntrusionSettings, callback)</td>
|
|
1078
1109
|
<td style="padding:15px">Set the supported instrusion settings for an MX network</td>
|
|
1079
|
-
<td style="padding:15px">
|
|
1110
|
+
<td style="padding:15px">v0:{base_path}/{version}/networks/{pathv1}/security/intrusionSettings?{query} <br /> v1:{base_path}/{version}/networks/{pathv1}/appliance/security/intrusionSettings?{query}</td>
|
|
1080
1111
|
<td style="padding:15px">Yes</td>
|
|
1081
1112
|
</tr>
|
|
1082
1113
|
<tr>
|
|
1083
1114
|
<td style="padding:15px">getOrganizationSecurityIntrusionSettings(organizationId, callback)</td>
|
|
1084
1115
|
<td style="padding:15px">Returns all supported intrusion settings for an organization</td>
|
|
1085
|
-
<td style="padding:15px">
|
|
1116
|
+
<td style="padding:15px">v0:{base_path}/{version}/organizations/{pathv1}/security/intrusionSettings?{query} <br /> v1:{base_path}/{version}/organizations/{pathv1}/appliance/security/intrusionSettings?{query}</td>
|
|
1086
1117
|
<td style="padding:15px">Yes</td>
|
|
1087
1118
|
</tr>
|
|
1088
1119
|
<tr>
|
|
1089
1120
|
<td style="padding:15px">updateOrganizationSecurityIntrusionSettings(organizationId, updateOrganizationSecurityIntrusionSettings, callback)</td>
|
|
1090
1121
|
<td style="padding:15px">Sets supported intrusion settings for an organization</td>
|
|
1091
|
-
<td style="padding:15px">
|
|
1122
|
+
<td style="padding:15px">v0:{base_path}/{version}/organizations/{pathv1}/security/intrusionSettings?{query} <br /> v1:{base_path}/{version}/organizations/{pathv1}/appliance/security/intrusion?{query}</td>
|
|
1092
1123
|
<td style="padding:15px">Yes</td>
|
|
1093
1124
|
</tr>
|
|
1094
1125
|
<tr>
|
|
1095
1126
|
<td style="padding:15px">getNetworkSecurityMalwareSettings(networkId, callback)</td>
|
|
1096
1127
|
<td style="padding:15px">Returns all supported malware settings for an MX network</td>
|
|
1097
|
-
<td style="padding:15px">
|
|
1128
|
+
<td style="padding:15px">v0:{base_path}/{version}/networks/{pathv1}/security/malwareSettings?{query} <br /> v1:{base_path}/{version}/networks/{pathv1}/appliance/security/malware?{query}</td>
|
|
1098
1129
|
<td style="padding:15px">Yes</td>
|
|
1099
1130
|
</tr>
|
|
1100
1131
|
<tr>
|
|
1101
1132
|
<td style="padding:15px">updateNetworkSecurityMalwareSettings(networkId, updateNetworkSecurityMalwareSettings, callback)</td>
|
|
1102
1133
|
<td style="padding:15px">Set the supported malware settings for an MX network</td>
|
|
1103
|
-
<td style="padding:15px">
|
|
1134
|
+
<td style="padding:15px">v0:{base_path}/{version}/networks/{pathv1}/security/malwareSettings?{query} <br /> v1:{base_path}/{version}/networks/{pathv1}/appliance/security/malware?{query}</td>
|
|
1104
1135
|
<td style="padding:15px">Yes</td>
|
|
1105
1136
|
</tr>
|
|
1106
1137
|
<tr>
|
|
@@ -1223,6 +1254,12 @@ v3AuthPass| string| The SNMP version 3 authentication pass...(description trunca
|
|
|
1223
1254
|
<td style="padding:15px">{base_path}/{version}/networks/{pathv1}/sm/devices?{query}</td>
|
|
1224
1255
|
<td style="padding:15px">Yes</td>
|
|
1225
1256
|
</tr>
|
|
1257
|
+
<tr>
|
|
1258
|
+
<td style="padding:15px">getNetworkSmDevicesV2(networkId, queryVars, callback)</td>
|
|
1259
|
+
<td style="padding:15px">List the devices enrolled in an SM network with various specified fields and filters</td>
|
|
1260
|
+
<td style="padding:15px">{base_path}/{version}/networks/{pathv1}/sm/devices?{query}</td>
|
|
1261
|
+
<td style="padding:15px">Yes</td>
|
|
1262
|
+
</tr>
|
|
1226
1263
|
<tr>
|
|
1227
1264
|
<td style="padding:15px">getNetworkSmUsers(networkId, usernames, emails, ids, scope, callback)</td>
|
|
1228
1265
|
<td style="padding:15px">List the owners in an SM network with various specified fields and filters</td>
|
|
@@ -1232,7 +1269,7 @@ v3AuthPass| string| The SNMP version 3 authentication pass...(description trunca
|
|
|
1232
1269
|
<tr>
|
|
1233
1270
|
<td style="padding:15px">getNetworkSmUserDeviceProfiles(networkId, id, callback)</td>
|
|
1234
1271
|
<td style="padding:15px">Get the profiles associated with a user</td>
|
|
1235
|
-
<td style="padding:15px">
|
|
1272
|
+
<td style="padding:15px">v0:{base_path}/{version}/networks/{pathv1}/sm/user/{pathv2}/deviceProfiles?{query} <br /> v1:{base_path}/{version}/networks/{pathv1}/sm/users/{pathv2}/deviceProfiles?{query}</td>
|
|
1236
1273
|
<td style="padding:15px">Yes</td>
|
|
1237
1274
|
</tr>
|
|
1238
1275
|
<tr>
|
|
@@ -1244,43 +1281,43 @@ v3AuthPass| string| The SNMP version 3 authentication pass...(description trunca
|
|
|
1244
1281
|
<tr>
|
|
1245
1282
|
<td style="padding:15px">getNetworkSmUserSoftwares(networkId, id, callback)</td>
|
|
1246
1283
|
<td style="padding:15px">Get a list of softwares associated with a user</td>
|
|
1247
|
-
<td style="padding:15px">
|
|
1284
|
+
<td style="padding:15px">v0:{base_path}/{version}/networks/{pathv1}/sm/user/{pathv2}/softwares?{query} <br /> v1:{base_path}/{version}/networks/{pathv1}/sm/users/{pathv2}/softwares?{query}</td>
|
|
1248
1285
|
<td style="padding:15px">Yes</td>
|
|
1249
1286
|
</tr>
|
|
1250
1287
|
<tr>
|
|
1251
1288
|
<td style="padding:15px">getNetworkSmSoftwares(networkId, id, callback)</td>
|
|
1252
1289
|
<td style="padding:15px">Get a list of softwares associated with a device</td>
|
|
1253
|
-
<td style="padding:15px">
|
|
1290
|
+
<td style="padding:15px">v0:{base_path}/{version}/networks/{pathv1}/sm/{pathv2}/softwares?{query} <br /> v1:{base_path}/{version}/networks/{pathv1}/sm/devices/{pathv2}/softwares?{query}</td>
|
|
1254
1291
|
<td style="padding:15px">Yes</td>
|
|
1255
1292
|
</tr>
|
|
1256
1293
|
<tr>
|
|
1257
1294
|
<td style="padding:15px">getNetworkSmNetworkAdapters(networkId, id, callback)</td>
|
|
1258
1295
|
<td style="padding:15px">List the network adapters of a device</td>
|
|
1259
|
-
<td style="padding:15px">
|
|
1296
|
+
<td style="padding:15px">v0:{base_path}/{version}/networks/{pathv1}/sm/{pathv2}/networkAdapters?{query} <br /> v1:{base_path}/{version}/networks/{pathv1}/sm/devices/{pathv2}/networkAdapters?{query}</td>
|
|
1260
1297
|
<td style="padding:15px">Yes</td>
|
|
1261
1298
|
</tr>
|
|
1262
1299
|
<tr>
|
|
1263
1300
|
<td style="padding:15px">getNetworkSmWlanLists(networkId, id, callback)</td>
|
|
1264
1301
|
<td style="padding:15px">List the saved SSID names on a device</td>
|
|
1265
|
-
<td style="padding:15px">
|
|
1302
|
+
<td style="padding:15px">v0:{base_path}/{version}/networks/{pathv1}/sm/{pathv2}/wlanLists?{query} <br /> v1:{base_path}/{version}/networks/{pathv1}/sm/devices/{pathv2}/wlanLists?{query}</td>
|
|
1266
1303
|
<td style="padding:15px">Yes</td>
|
|
1267
1304
|
</tr>
|
|
1268
1305
|
<tr>
|
|
1269
1306
|
<td style="padding:15px">getNetworkSmSecurityCenters(networkId, id, callback)</td>
|
|
1270
1307
|
<td style="padding:15px">List the security centers on a device</td>
|
|
1271
|
-
<td style="padding:15px">
|
|
1308
|
+
<td style="padding:15px">v0:{base_path}/{version}/networks/{pathv1}/sm/{pathv2}/securityCenters?{query} <br /> v1:{base_path}/{version}/networks/{pathv1}/sm/devices/{pathv2}/securityCenters?{query}</td>
|
|
1272
1309
|
<td style="padding:15px">Yes</td>
|
|
1273
1310
|
</tr>
|
|
1274
1311
|
<tr>
|
|
1275
1312
|
<td style="padding:15px">getNetworkSmRestrictions(networkId, id, callback)</td>
|
|
1276
1313
|
<td style="padding:15px">List the restrictions on a device</td>
|
|
1277
|
-
<td style="padding:15px">
|
|
1314
|
+
<td style="padding:15px">v0:{base_path}/{version}/networks/{pathv1}/sm/{pathv2}/restrictions?{query} <br /> v1:{base_path}/{version}/networks/{pathv1}/sm/devices/{pathv2}/restrictions?{query}</td>
|
|
1278
1315
|
<td style="padding:15px">Yes</td>
|
|
1279
1316
|
</tr>
|
|
1280
1317
|
<tr>
|
|
1281
1318
|
<td style="padding:15px">getNetworkSmCerts(networkId, id, callback)</td>
|
|
1282
1319
|
<td style="padding:15px">List the certs on a device</td>
|
|
1283
|
-
<td style="padding:15px">
|
|
1320
|
+
<td style="padding:15px">v0:{base_path}/{version}/networks/{pathv1}/sm/{pathv2}/certs?{query} <br /> v1:{base_path}/{version}/networks/{pathv1}/sm/devices/{pathv2}/certs?{query}</td>
|
|
1284
1321
|
<td style="padding:15px">Yes</td>
|
|
1285
1322
|
</tr>
|
|
1286
1323
|
<tr>
|
|
@@ -1298,7 +1335,7 @@ v3AuthPass| string| The SNMP version 3 authentication pass...(description trunca
|
|
|
1298
1335
|
<tr>
|
|
1299
1336
|
<td style="padding:15px">updateNetworkSmDeviceFields(networkId, updateNetworkSmDeviceFields, callback)</td>
|
|
1300
1337
|
<td style="padding:15px">Modify the fields of a device</td>
|
|
1301
|
-
<td style="padding:15px">
|
|
1338
|
+
<td style="padding:15px">v0:{base_path}/{version}/networks/{pathv1}/sm/device/fields?{query} <br /> v1:{base_path}/{version}/networks/{pathv1}/sm/devices/fields?{query}</td>
|
|
1302
1339
|
<td style="padding:15px">Yes</td>
|
|
1303
1340
|
</tr>
|
|
1304
1341
|
<tr>
|
|
@@ -1376,13 +1413,13 @@ v3AuthPass| string| The SNMP version 3 authentication pass...(description trunca
|
|
|
1376
1413
|
<tr>
|
|
1377
1414
|
<td style="padding:15px">getNetworkSmCellularUsageHistory(networkId, id, callback)</td>
|
|
1378
1415
|
<td style="padding:15px">Return the client's daily cellular data usage history. Usage data is in kilobytes.</td>
|
|
1379
|
-
<td style="padding:15px">
|
|
1416
|
+
<td style="padding:15px">v0:{base_path}/{version}/networks/{pathv1}/sm/{pathv2}/cellularUsageHistory?{query} <br /> v1:{base_path}/{version}/networks/{pathv1}/sm/devices/{pathv2}/cellularUsageHistory?{query}</td>
|
|
1380
1417
|
<td style="padding:15px">Yes</td>
|
|
1381
1418
|
</tr>
|
|
1382
1419
|
<tr>
|
|
1383
1420
|
<td style="padding:15px">getNetworkSmPerformanceHistory(networkId, id, perPage, startingAfter, endingBefore, callback)</td>
|
|
1384
1421
|
<td style="padding:15px">Return historical records of various Systems Manager client metrics for desktop devices.</td>
|
|
1385
|
-
<td style="padding:15px">
|
|
1422
|
+
<td style="padding:15px">v0:{base_path}/{version}/networks/{pathv1}/sm/{pathv2}/performanceHistory?{query} <br /> v1:{base_path}/{version}/networks/{pathv1}/sm/devices/{pathv2}/performanceHistory?{query}</td>
|
|
1386
1423
|
<td style="padding:15px">Yes</td>
|
|
1387
1424
|
</tr>
|
|
1388
1425
|
<tr>
|
|
@@ -1397,13 +1434,13 @@ v3AuthPass| string| The SNMP version 3 authentication pass...(description trunca
|
|
|
1397
1434
|
Note that this will include the name of the Dashboard user who initiated the command if it was generated
|
|
1398
1435
|
by a Dashboard admin rather than the automatic behavior of the system; you may wish to filter this out
|
|
1399
1436
|
of any reports.</td>
|
|
1400
|
-
<td style="padding:15px">
|
|
1437
|
+
<td style="padding:15px">v0:{base_path}/{version}/networks/{pathv1}/sm/{pathv2}/deviceCommandLogs?{query} <br /> v1:{base_path}/{version}/networks/{pathv1}/sm/devices/{pathv2}/deviceCommandLogs?{query}</td>
|
|
1401
1438
|
<td style="padding:15px">Yes</td>
|
|
1402
1439
|
</tr>
|
|
1403
1440
|
<tr>
|
|
1404
1441
|
<td style="padding:15px">getNetworkSmConnectivity(networkId, id, perPage, startingAfter, endingBefore, callback)</td>
|
|
1405
1442
|
<td style="padding:15px">Returns historical connectivity data (whether a device is regularly checking in to Dashboard).</td>
|
|
1406
|
-
<td style="padding:15px">
|
|
1443
|
+
<td style="padding:15px">v0:{base_path}/{version}/networks/{pathv1}/sm/{pathv2}/connectivity?{query} <br /> v1:{base_path}/{version}/networks/{pathv1}/sm/devices/{pathv2}/connectivity?{query}</td>
|
|
1407
1444
|
<td style="padding:15px">Yes</td>
|
|
1408
1445
|
</tr>
|
|
1409
1446
|
<tr>
|
|
@@ -1415,31 +1452,31 @@ v3AuthPass| string| The SNMP version 3 authentication pass...(description trunca
|
|
|
1415
1452
|
<tr>
|
|
1416
1453
|
<td style="padding:15px">getNetworkSsidSplashSettings(networkId, number, callback)</td>
|
|
1417
1454
|
<td style="padding:15px">Display the splash page settings for the given SSID</td>
|
|
1418
|
-
<td style="padding:15px">
|
|
1455
|
+
<td style="padding:15px">v0:{base_path}/{version}/networks/{pathv1}/ssids/{pathv2}/splashSettings?{query} <br /> v1:{base_path}/{version}/networks/{pathv1}/wireless/ssids/{pathv2}/splash/settings?{query}</td>
|
|
1419
1456
|
<td style="padding:15px">Yes</td>
|
|
1420
1457
|
</tr>
|
|
1421
1458
|
<tr>
|
|
1422
1459
|
<td style="padding:15px">updateNetworkSsidSplashSettings(networkId, number, updateNetworkSsidSplashSettings, callback)</td>
|
|
1423
1460
|
<td style="padding:15px">Modify the splash page settings for the given SSID</td>
|
|
1424
|
-
<td style="padding:15px">
|
|
1461
|
+
<td style="padding:15px">v0:{base_path}/{version}/networks/{pathv1}/ssids/{pathv2}/splashSettings?{query} <br /> v1:{base_path}/{version}/networks/{pathv1}/wireless/ssids/{pathv2}/splash/settings?{query}</td>
|
|
1425
1462
|
<td style="padding:15px">Yes</td>
|
|
1426
1463
|
</tr>
|
|
1427
1464
|
<tr>
|
|
1428
1465
|
<td style="padding:15px">getNetworkSsids(networkId, callback)</td>
|
|
1429
1466
|
<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">
|
|
1467
|
+
<td style="padding:15px">v0:{base_path}/{version}/networks/{pathv1}/ssids?{query} <br /> v1:{base_path}/{version}/networks/{pathv1}/wireless/ssids?{query}</td>
|
|
1431
1468
|
<td style="padding:15px">Yes</td>
|
|
1432
1469
|
</tr>
|
|
1433
1470
|
<tr>
|
|
1434
1471
|
<td style="padding:15px">getNetworkSsid(networkId, number, callback)</td>
|
|
1435
1472
|
<td style="padding:15px">Return a single SSID</td>
|
|
1436
|
-
<td style="padding:15px">
|
|
1473
|
+
<td style="padding:15px">v0:{base_path}/{version}/networks/{pathv1}/ssids/{pathv2}?{query} <br /> v1:{base_path}/{version}/networks/{pathv1}/wireless/ssids/{pathv2}?{query}</td>
|
|
1437
1474
|
<td style="padding:15px">Yes</td>
|
|
1438
1475
|
</tr>
|
|
1439
1476
|
<tr>
|
|
1440
1477
|
<td style="padding:15px">updateNetworkSsid(networkId, number, updateNetworkSsid, callback)</td>
|
|
1441
1478
|
<td style="padding:15px">Update the attributes of an SSID</td>
|
|
1442
|
-
<td style="padding:15px">
|
|
1479
|
+
<td style="padding:15px">v0:{base_path}/{version}/networks/{pathv1}/ssids/{pathv2}?{query} <br /> v1:{base_path}/{version}/networks/{pathv1}/wireless/ssids/{pathv2}?{query}</td>
|
|
1443
1480
|
<td style="padding:15px">Yes</td>
|
|
1444
1481
|
</tr>
|
|
1445
1482
|
<tr>
|
|
@@ -1457,19 +1494,19 @@ v3AuthPass| string| The SNMP version 3 authentication pass...(description trunca
|
|
|
1457
1494
|
<tr>
|
|
1458
1495
|
<td style="padding:15px">getDeviceSwitchPorts(serial, callback)</td>
|
|
1459
1496
|
<td style="padding:15px">List the switch ports for a switch</td>
|
|
1460
|
-
<td style="padding:15px">
|
|
1497
|
+
<td style="padding:15px">v0:{base_path}/{version}/devices/{pathv1}/switchPorts?{query} <br /> v1:{base_path}/{version}/devices/{pathv1}/switch/ports?{query}</td>
|
|
1461
1498
|
<td style="padding:15px">Yes</td>
|
|
1462
1499
|
</tr>
|
|
1463
1500
|
<tr>
|
|
1464
1501
|
<td style="padding:15px">getDeviceSwitchPort(serial, number, callback)</td>
|
|
1465
1502
|
<td style="padding:15px">Return a switch port</td>
|
|
1466
|
-
<td style="padding:15px">
|
|
1503
|
+
<td style="padding:15px">v0:{base_path}/{version}/devices/{pathv1}/switchPorts/{pathv2}?{query} <br /> v1:{base_path}/{version}/devices/{pathv1}/switch/ports/{pathv2}?{query}</td>
|
|
1467
1504
|
<td style="padding:15px">Yes</td>
|
|
1468
1505
|
</tr>
|
|
1469
1506
|
<tr>
|
|
1470
1507
|
<td style="padding:15px">updateDeviceSwitchPort(serial, number, updateDeviceSwitchPort, callback)</td>
|
|
1471
1508
|
<td style="padding:15px">Update a switch port</td>
|
|
1472
|
-
<td style="padding:15px">
|
|
1509
|
+
<td style="padding:15px">v0:{base_path}/{version}/devices/{pathv1}/switchPorts/{pathv2}?{query} <br /> v1:{base_path}/{version}/devices/{pathv1}/switch/ports/{pathv2}?{query}</td>
|
|
1473
1510
|
<td style="padding:15px">Yes</td>
|
|
1474
1511
|
</tr>
|
|
1475
1512
|
<tr>
|
|
@@ -1481,37 +1518,37 @@ v3AuthPass| string| The SNMP version 3 authentication pass...(description trunca
|
|
|
1481
1518
|
<tr>
|
|
1482
1519
|
<td style="padding:15px">getNetworkSwitchStacks(networkId, callback)</td>
|
|
1483
1520
|
<td style="padding:15px">List the switch stacks in a network</td>
|
|
1484
|
-
<td style="padding:15px">
|
|
1521
|
+
<td style="padding:15px">v0:{base_path}/{version}/networks/{pathv1}/switchStacks?{query} <br /> v1:{base_path}/{version}/networks/{pathv1}/switch/stacks?{query}</td>
|
|
1485
1522
|
<td style="padding:15px">Yes</td>
|
|
1486
1523
|
</tr>
|
|
1487
1524
|
<tr>
|
|
1488
1525
|
<td style="padding:15px">createNetworkSwitchStack(networkId, createNetworkSwitchStack, callback)</td>
|
|
1489
1526
|
<td style="padding:15px">Create a stack</td>
|
|
1490
|
-
<td style="padding:15px">
|
|
1527
|
+
<td style="padding:15px">v0:{base_path}/{version}/networks/{pathv1}/switchStacks?{query} <br /> v1:{base_path}/{version}/networks/{pathv1}/switch/stacks?{query}</td>
|
|
1491
1528
|
<td style="padding:15px">Yes</td>
|
|
1492
1529
|
</tr>
|
|
1493
1530
|
<tr>
|
|
1494
1531
|
<td style="padding:15px">getNetworkSwitchStack(networkId, switchStackId, callback)</td>
|
|
1495
1532
|
<td style="padding:15px">Show a switch stack</td>
|
|
1496
|
-
<td style="padding:15px">
|
|
1533
|
+
<td style="padding:15px">v0:{base_path}/{version}/networks/{pathv1}/switchStacks/{pathv2}?{query} <br /> v1:{base_path}/{version}/networks/{pathv1}/switch/stacks/{pathv2}?{query}</td>
|
|
1497
1534
|
<td style="padding:15px">Yes</td>
|
|
1498
1535
|
</tr>
|
|
1499
1536
|
<tr>
|
|
1500
1537
|
<td style="padding:15px">deleteNetworkSwitchStack(networkId, switchStackId, callback)</td>
|
|
1501
1538
|
<td style="padding:15px">Delete a stack</td>
|
|
1502
|
-
<td style="padding:15px">
|
|
1539
|
+
<td style="padding:15px">v0:{base_path}/{version}/networks/{pathv1}/switchStacks/{pathv2}?{query} <br /> v1:{base_path}/{version}/networks/{pathv1}/switch/stacks/{pathv2}?{query}</td>
|
|
1503
1540
|
<td style="padding:15px">Yes</td>
|
|
1504
1541
|
</tr>
|
|
1505
1542
|
<tr>
|
|
1506
1543
|
<td style="padding:15px">addNetworkSwitchStack(networkId, switchStackId, addNetworkSwitchStack, callback)</td>
|
|
1507
1544
|
<td style="padding:15px">Add a switch to a stack</td>
|
|
1508
|
-
<td style="padding:15px">
|
|
1545
|
+
<td style="padding:15px">v0:{base_path}/{version}/networks/{pathv1}/switchStacks/{pathv2}/add?{query} <br /> v1:{base_path}/{version}/networks/{pathv1}/switch/stacks/{pathv2}/add?{query}</td>
|
|
1509
1546
|
<td style="padding:15px">Yes</td>
|
|
1510
1547
|
</tr>
|
|
1511
1548
|
<tr>
|
|
1512
1549
|
<td style="padding:15px">removeNetworkSwitchStack(networkID, switchStackId, removeNetworkSwitchStack, callback)</td>
|
|
1513
1550
|
<td style="padding:15px">Remove a switch from a stack</td>
|
|
1514
|
-
<td style="padding:15px">
|
|
1551
|
+
<td style="padding:15px">v0:{base_path}/{version}/networks/{pathv1}/switchStacks/{pathv2}/remove?{query} <br /> v1:{base_path}/{version}/networks/{pathv1}/switch/stacks/{pathv2}/remove?{query}</td>
|
|
1515
1552
|
<td style="padding:15px">Yes</td>
|
|
1516
1553
|
</tr>
|
|
1517
1554
|
<tr>
|
|
@@ -1529,25 +1566,25 @@ v3AuthPass| string| The SNMP version 3 authentication pass...(description trunca
|
|
|
1529
1566
|
<tr>
|
|
1530
1567
|
<td style="padding:15px">updateNetworkTrafficShaping(networkId, updateNetworkTrafficShaping, callback)</td>
|
|
1531
1568
|
<td style="padding:15px">Update the traffic shaping settings for an MX network</td>
|
|
1532
|
-
<td style="padding:15px">
|
|
1569
|
+
<td style="padding:15px">v0:{base_path}/{version}/networks/{pathv1}/trafficShaping?{query} <br /> v1:{base_path}/{version}/networks/{pathv1}/appliance/trafficShaping?{query}</td>
|
|
1533
1570
|
<td style="padding:15px">Yes</td>
|
|
1534
1571
|
</tr>
|
|
1535
1572
|
<tr>
|
|
1536
1573
|
<td style="padding:15px">getNetworkTrafficShaping(networkId, callback)</td>
|
|
1537
1574
|
<td style="padding:15px">Display the traffic shaping settings for an MX network</td>
|
|
1538
|
-
<td style="padding:15px">
|
|
1575
|
+
<td style="padding:15px">v0:{base_path}/{version}/networks/{pathv1}/trafficShaping?{query} <br /> v1:{base_path}/{version}/networks/{pathv1}/appliance/trafficShaping?{query}</td>
|
|
1539
1576
|
<td style="padding:15px">Yes</td>
|
|
1540
1577
|
</tr>
|
|
1541
1578
|
<tr>
|
|
1542
1579
|
<td style="padding:15px">updateNetworkSsidTrafficShaping(networkId, number, updateNetworkSsidTrafficShaping, callback)</td>
|
|
1543
1580
|
<td style="padding:15px">Update the traffic shaping settings for an SSID on an MR network</td>
|
|
1544
|
-
<td style="padding:15px">
|
|
1581
|
+
<td style="padding:15px">v0:{base_path}/{version}/networks/{pathv1}/ssids/{pathv2}/trafficShaping?{query} <br /> v1:{base_path}/{version}/networks/{pathv1}/wireless/ssids/{pathv2}/trafficShaping/rules?{query}</td>
|
|
1545
1582
|
<td style="padding:15px">Yes</td>
|
|
1546
1583
|
</tr>
|
|
1547
1584
|
<tr>
|
|
1548
1585
|
<td style="padding:15px">getNetworkSsidTrafficShaping(networkId, number, callback)</td>
|
|
1549
1586
|
<td style="padding:15px">Display the traffic shaping settings for a SSID on an MR network</td>
|
|
1550
|
-
<td style="padding:15px">
|
|
1587
|
+
<td style="padding:15px">v0:{base_path}/{version}/networks/{pathv1}/ssids/{pathv2}/trafficShaping?{query} <br /> v1:{base_path}/{version}/networks/{pathv1}/wireless/ssids/{pathv2}/trafficShaping/rules?{query}</td>
|
|
1551
1588
|
<td style="padding:15px">Yes</td>
|
|
1552
1589
|
</tr>
|
|
1553
1590
|
<tr>
|
|
@@ -1565,103 +1602,103 @@ v3AuthPass| string| The SNMP version 3 authentication pass...(description trunca
|
|
|
1565
1602
|
<tr>
|
|
1566
1603
|
<td style="padding:15px">getNetworkContentFilteringCategories(networkId, callback)</td>
|
|
1567
1604
|
<td style="padding:15px">List all available content filtering categories for an MX network</td>
|
|
1568
|
-
<td style="padding:15px">
|
|
1605
|
+
<td style="padding:15px">v0:{base_path}/{version}/networks/{pathv1}/contentFiltering/categories?{query} <br /> v1:{base_path}/{version}/networks/{pathv1}/appliance/contentFiltering/categories?{query}</td>
|
|
1569
1606
|
<td style="padding:15px">Yes</td>
|
|
1570
1607
|
</tr>
|
|
1571
1608
|
<tr>
|
|
1572
1609
|
<td style="padding:15px">getNetworkContentFiltering(networkId, callback)</td>
|
|
1573
1610
|
<td style="padding:15px">Return the content filtering settings for an MX network</td>
|
|
1574
|
-
<td style="padding:15px">
|
|
1611
|
+
<td style="padding:15px">v0:{base_path}/{version}/networks/{pathv1}/contentFiltering?{query} <br /> v1:{base_path}/{version}/networks/{pathv1}/appliance/contentFiltering?{query}</td>
|
|
1575
1612
|
<td style="padding:15px">Yes</td>
|
|
1576
1613
|
</tr>
|
|
1577
1614
|
<tr>
|
|
1578
1615
|
<td style="padding:15px">updateNetworkContentFiltering(networkId, updateNetworkContentFiltering, callback)</td>
|
|
1579
1616
|
<td style="padding:15px">Update the content filtering settings for an MX network</td>
|
|
1580
|
-
<td style="padding:15px">
|
|
1617
|
+
<td style="padding:15px">v0:{base_path}/{version}/networks/{pathv1}/contentFiltering?{query} <br /> v1:{base_path}/{version}/networks/{pathv1}/appliance/contentFiltering?{query}</td>
|
|
1581
1618
|
<td style="padding:15px">Yes</td>
|
|
1582
1619
|
</tr>
|
|
1583
1620
|
<tr>
|
|
1584
1621
|
<td style="padding:15px">getNetworkFirewalledServices(networkId, callback)</td>
|
|
1585
1622
|
<td style="padding:15px">List the appliance services and their accessibility rules</td>
|
|
1586
|
-
<td style="padding:15px">
|
|
1623
|
+
<td style="padding:15px">v0:{base_path}/{version}/networks/{pathv1}/firewalledServices?{query} <br /> v1:{base_path}/{version}/networks/{pathv1}/appliance/firewall/firewalledServices?{query}</td>
|
|
1587
1624
|
<td style="padding:15px">Yes</td>
|
|
1588
1625
|
</tr>
|
|
1589
1626
|
<tr>
|
|
1590
1627
|
<td style="padding:15px">getNetworkFirewalledService(networkId, service, callback)</td>
|
|
1591
1628
|
<td style="padding:15px">Return the accessibility settings of the given service ('ICMP', 'web', or 'SNMP')</td>
|
|
1592
|
-
<td style="padding:15px">
|
|
1629
|
+
<td style="padding:15px">v0:{base_path}/{version}/networks/{pathv1}/firewalledServices/{pathv2}?{query} <br /> v1:{base_path}/{version}/networks/{pathv1}/appliance/firewall/firewalledServices/{pathv2}?{query}</td>
|
|
1593
1630
|
<td style="padding:15px">Yes</td>
|
|
1594
1631
|
</tr>
|
|
1595
1632
|
<tr>
|
|
1596
1633
|
<td style="padding:15px">updateNetworkFirewalledService(networkId, service, updateNetworkFirewalledService, callback)</td>
|
|
1597
1634
|
<td style="padding:15px">Updates the accessibility settings for the given service ('ICMP', 'web', or 'SNMP')</td>
|
|
1598
|
-
<td style="padding:15px">
|
|
1635
|
+
<td style="padding:15px">v0:{base_path}/{version}/networks/{pathv1}/firewalledServices/{pathv2}?{query} <br /> v1:{base_path}/{version}/networks/{pathv1}/appliance/firewall/firewalledServices/{pathv2}?{query}</td>
|
|
1599
1636
|
<td style="padding:15px">Yes</td>
|
|
1600
1637
|
</tr>
|
|
1601
1638
|
<tr>
|
|
1602
1639
|
<td style="padding:15px">getNetworkOneToManyNatRules(networkId, callback)</td>
|
|
1603
1640
|
<td style="padding:15px">Return the 1:Many NAT mapping rules for an MX network</td>
|
|
1604
|
-
<td style="padding:15px">
|
|
1641
|
+
<td style="padding:15px">v0:{base_path}/{version}/networks/{pathv1}/oneToManyNatRules?{query} <br /> v1:{base_path}/{version}/networks/{pathv1}/appliance/firewall/oneToManyNatRules?{query}</td>
|
|
1605
1642
|
<td style="padding:15px">Yes</td>
|
|
1606
1643
|
</tr>
|
|
1607
1644
|
<tr>
|
|
1608
1645
|
<td style="padding:15px">updateNetworkOneToManyNatRules(networkId, updateNetworkOneToManyNatRules, callback)</td>
|
|
1609
1646
|
<td style="padding:15px">Set the 1:Many NAT mapping rules for an MX network</td>
|
|
1610
|
-
<td style="padding:15px">
|
|
1647
|
+
<td style="padding:15px">v0:{base_path}/{version}/networks/{pathv1}/oneToManyNatRules?{query} <br /> v1:{base_path}/{version}/networks/{pathv1}/appliance/firewall/oneToManyNatRules?{query}</td>
|
|
1611
1648
|
<td style="padding:15px">Yes</td>
|
|
1612
1649
|
</tr>
|
|
1613
1650
|
<tr>
|
|
1614
1651
|
<td style="padding:15px">getNetworkOneToOneNatRules(networkId, callback)</td>
|
|
1615
1652
|
<td style="padding:15px">Return the 1:1 NAT mapping rules for an MX network</td>
|
|
1616
|
-
<td style="padding:15px">
|
|
1653
|
+
<td style="padding:15px">v0:{base_path}/{version}/networks/{pathv1}/oneToOneNatRules?{query} <br /> v1:{base_path}/{version}/networks/{pathv1}/appliance/firewall/oneToOneNatRules?{query}</td>
|
|
1617
1654
|
<td style="padding:15px">Yes</td>
|
|
1618
1655
|
</tr>
|
|
1619
1656
|
<tr>
|
|
1620
1657
|
<td style="padding:15px">updateNetworkOneToOneNatRules(networkId, updateNetworkOneToOneNatRules, callback)</td>
|
|
1621
1658
|
<td style="padding:15px">Set the 1:1 NAT mapping rules for an MX network</td>
|
|
1622
|
-
<td style="padding:15px">
|
|
1659
|
+
<td style="padding:15px">v0:{base_path}/{version}/networks/{pathv1}/oneToOneNatRules?{query} <br /> v1:{base_path}/{version}/networks/{pathv1}/appliance/firewall/oneToOneNatRules?{query}</td>
|
|
1623
1660
|
<td style="padding:15px">Yes</td>
|
|
1624
1661
|
</tr>
|
|
1625
1662
|
<tr>
|
|
1626
1663
|
<td style="padding:15px">getNetworkPortForwardingRules(networkId, callback)</td>
|
|
1627
1664
|
<td style="padding:15px">Return the port forwarding rules for an MX network</td>
|
|
1628
|
-
<td style="padding:15px">
|
|
1665
|
+
<td style="padding:15px">v0:{base_path}/{version}/networks/{pathv1}/portForwardingRules?{query} <br /> v1:{base_path}/{version}/networks/{pathv1}/appliance/firewall/portForwardingRules?{query}</td>
|
|
1629
1666
|
<td style="padding:15px">Yes</td>
|
|
1630
1667
|
</tr>
|
|
1631
1668
|
<tr>
|
|
1632
1669
|
<td style="padding:15px">updateNetworkPortForwardingRules(networkId, updateNetworkPortForwardingRules, callback)</td>
|
|
1633
1670
|
<td style="padding:15px">Update the port forwarding rules for an MX network</td>
|
|
1634
|
-
<td style="padding:15px">
|
|
1671
|
+
<td style="padding:15px">v0:{base_path}/{version}/networks/{pathv1}/portForwardingRules?{query} <br /> v1:{base_path}/{version}/networks/{pathv1}/appliance/firewall/portForwardingRules?{query}</td>
|
|
1635
1672
|
<td style="padding:15px">Yes</td>
|
|
1636
1673
|
</tr>
|
|
1637
1674
|
<tr>
|
|
1638
1675
|
<td style="padding:15px">getNetworkStaticRoutes(networkId, callback)</td>
|
|
1639
1676
|
<td style="padding:15px">List the static routes for this network</td>
|
|
1640
|
-
<td style="padding:15px">
|
|
1677
|
+
<td style="padding:15px">v0:{base_path}/{version}/networks/{pathv1}/staticRoutes?{query} <br /> v1:{base_path}/{version}/networks/{pathv1}/appliance/staticRoutes?{query}</td>
|
|
1641
1678
|
<td style="padding:15px">Yes</td>
|
|
1642
1679
|
</tr>
|
|
1643
1680
|
<tr>
|
|
1644
1681
|
<td style="padding:15px">createNetworkStaticRoute(networkId, createNetworkStaticRoute, callback)</td>
|
|
1645
1682
|
<td style="padding:15px">Add a static route</td>
|
|
1646
|
-
<td style="padding:15px">
|
|
1683
|
+
<td style="padding:15px">v0:{base_path}/{version}/networks/{pathv1}/staticRoutes?{query} <br /> v1:{base_path}/{version}/networks/{pathv1}/appliance/staticRoutes?{query}</td>
|
|
1647
1684
|
<td style="padding:15px">Yes</td>
|
|
1648
1685
|
</tr>
|
|
1649
1686
|
<tr>
|
|
1650
1687
|
<td style="padding:15px">getNetworkStaticRoute(networkId, srId, callback)</td>
|
|
1651
1688
|
<td style="padding:15px">Return a static route</td>
|
|
1652
|
-
<td style="padding:15px">
|
|
1689
|
+
<td style="padding:15px">v0:{base_path}/{version}/networks/{pathv1}/staticRoutes/{pathv2}?{query} <br /> v1:{base_path}/{version}/networks/{pathv1}/appliance/staticRoutes/{pathv2}?{query}</td>
|
|
1653
1690
|
<td style="padding:15px">Yes</td>
|
|
1654
1691
|
</tr>
|
|
1655
1692
|
<tr>
|
|
1656
1693
|
<td style="padding:15px">updateNetworkStaticRoute(networkId, srId, updateNetworkStaticRoute, callback)</td>
|
|
1657
1694
|
<td style="padding:15px">Update a static route</td>
|
|
1658
|
-
<td style="padding:15px">
|
|
1695
|
+
<td style="padding:15px">v0:{base_path}/{version}/networks/{pathv1}/staticRoutes/{pathv2}?{query} <br /> v1:{base_path}/{version}/networks/{pathv1}/appliance/staticRoutes/{pathv2}?{query}</td>
|
|
1659
1696
|
<td style="padding:15px">Yes</td>
|
|
1660
1697
|
</tr>
|
|
1661
1698
|
<tr>
|
|
1662
1699
|
<td style="padding:15px">deleteNetworkStaticRoute(networkId, srId, callback)</td>
|
|
1663
1700
|
<td style="padding:15px">Delete a static route from a network</td>
|
|
1664
|
-
<td style="padding:15px">
|
|
1701
|
+
<td style="padding:15px">v0:{base_path}/{version}/networks/{pathv1}/staticRoutes/{pathv2}?{query} <br /> v1:{base_path}/{version}/networks/{pathv1}/appliance/staticRoutes/{pathv2}?{query}</td>
|
|
1665
1702
|
<td style="padding:15px">Yes</td>
|
|
1666
1703
|
</tr>
|
|
1667
1704
|
<tr>
|
|
@@ -1679,31 +1716,31 @@ v3AuthPass| string| The SNMP version 3 authentication pass...(description trunca
|
|
|
1679
1716
|
<tr>
|
|
1680
1717
|
<td style="padding:15px">getNetworkVlans(networkId, callback)</td>
|
|
1681
1718
|
<td style="padding:15px">List the VLANs for an MX network</td>
|
|
1682
|
-
<td style="padding:15px">
|
|
1719
|
+
<td style="padding:15px">v0:{base_path}/{version}/networks/{pathv1}/vlans?{query} <br /> v1:{base_path}/{version}/networks/{pathv1}/appliance/vlans?{query}</td>
|
|
1683
1720
|
<td style="padding:15px">Yes</td>
|
|
1684
1721
|
</tr>
|
|
1685
1722
|
<tr>
|
|
1686
1723
|
<td style="padding:15px">createNetworkVlan(networkId, createNetworkVlan, callback)</td>
|
|
1687
1724
|
<td style="padding:15px">Add a VLAN</td>
|
|
1688
|
-
<td style="padding:15px">
|
|
1725
|
+
<td style="padding:15px">v0:{base_path}/{version}/networks/{pathv1}/vlans?{query} <br /> v1:{base_path}/{version}/networks/{pathv1}/appliance/vlans?{query}</td>
|
|
1689
1726
|
<td style="padding:15px">Yes</td>
|
|
1690
1727
|
</tr>
|
|
1691
1728
|
<tr>
|
|
1692
1729
|
<td style="padding:15px">getNetworkVlan(networkId, vlanId, callback)</td>
|
|
1693
1730
|
<td style="padding:15px">Return a VLAN</td>
|
|
1694
|
-
<td style="padding:15px">
|
|
1731
|
+
<td style="padding:15px">v0:{base_path}/{version}/networks/{pathv1}/vlans/{pathv2}?{query} <br /> v1:{base_path}/{version}/networks/{pathv1}/appliance/vlans/{pathv2}?{query}</td>
|
|
1695
1732
|
<td style="padding:15px">Yes</td>
|
|
1696
1733
|
</tr>
|
|
1697
1734
|
<tr>
|
|
1698
1735
|
<td style="padding:15px">updateNetworkVlan(networkId, vlanId, updateNetworkVlan, callback)</td>
|
|
1699
1736
|
<td style="padding:15px">Update a VLAN</td>
|
|
1700
|
-
<td style="padding:15px">
|
|
1737
|
+
<td style="padding:15px">v0:{base_path}/{version}/networks/{pathv1}/vlans/{pathv2}?{query} <br /> v1:{base_path}/{version}/networks/{pathv1}/appliance/vlans/{pathv2}?{query}</td>
|
|
1701
1738
|
<td style="padding:15px">Yes</td>
|
|
1702
1739
|
</tr>
|
|
1703
1740
|
<tr>
|
|
1704
1741
|
<td style="padding:15px">deleteNetworkVlan(networkId, vlanId, callback)</td>
|
|
1705
1742
|
<td style="padding:15px">Delete a VLAN from a network</td>
|
|
1706
|
-
<td style="padding:15px">
|
|
1743
|
+
<td style="padding:15px">v0:{base_path}/{version}/networks/{pathv1}/vlans/{pathv2}?{query} <br /> v1:{base_path}/{version}/networks/{pathv1}/appliance/vlans/{pathv2}?{query}</td>
|
|
1707
1744
|
<td style="padding:15px">Yes</td>
|
|
1708
1745
|
</tr>
|
|
1709
1746
|
<tr>
|
|
@@ -1721,13 +1758,13 @@ v3AuthPass| string| The SNMP version 3 authentication pass...(description trunca
|
|
|
1721
1758
|
<tr>
|
|
1722
1759
|
<td style="padding:15px">getNetworkConnectionStats(networkId, t0, t1, timespan, ssid, vlan, apTag, callback)</td>
|
|
1723
1760
|
<td style="padding:15px">Aggregated connectivity info for this network</td>
|
|
1724
|
-
<td style="padding:15px">
|
|
1761
|
+
<td style="padding:15px">v0:{base_path}/{version}/networks/{pathv1}/connectionStats?{query} <br /> v1:{base_path}/{version}/networks/{pathv1}/wireless/connectionStats?{query}</td>
|
|
1725
1762
|
<td style="padding:15px">Yes</td>
|
|
1726
1763
|
</tr>
|
|
1727
1764
|
<tr>
|
|
1728
1765
|
<td style="padding:15px">getNetworkDevicesConnectionStats(networkId, t0, t1, timespan, ssid, vlan, apTag, callback)</td>
|
|
1729
1766
|
<td style="padding:15px">Aggregated connectivity info for this network, grouped by node</td>
|
|
1730
|
-
<td style="padding:15px">
|
|
1767
|
+
<td style="padding:15px">v0:{base_path}/{version}/networks/{pathv1}/devices/connectionStats?{query} <br /> v1:{base_path}/{version}/networks/{pathv1}/wireless/devices/connectionStats?{query}</td>
|
|
1731
1768
|
<td style="padding:15px">Yes</td>
|
|
1732
1769
|
</tr>
|
|
1733
1770
|
<tr>
|
|
@@ -1745,25 +1782,25 @@ v3AuthPass| string| The SNMP version 3 authentication pass...(description trunca
|
|
|
1745
1782
|
<tr>
|
|
1746
1783
|
<td style="padding:15px">getNetworkClientsConnectionStats(networkId, t0, t1, timespan, ssid, vlan, apTag, callback)</td>
|
|
1747
1784
|
<td style="padding:15px">Aggregated connectivity info for this network, grouped by clients</td>
|
|
1748
|
-
<td style="padding:15px">
|
|
1785
|
+
<td style="padding:15px">v0:{base_path}/{version}/networks/{pathv1}/clients/connectionStats?{query} <br /> v1:{base_path}/{version}/networks/{pathv1}/wireless/clients/connectionStats?{query}</td>
|
|
1749
1786
|
<td style="padding:15px">Yes</td>
|
|
1750
1787
|
</tr>
|
|
1751
1788
|
<tr>
|
|
1752
1789
|
<td style="padding:15px">getNetworkClientConnectionStats(networkId, clientId, t0, t1, timespan, ssid, vlan, apTag, callback)</td>
|
|
1753
1790
|
<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">
|
|
1791
|
+
<td style="padding:15px">v0:{base_path}/{version}/networks/{pathv1}/clients/{pathv2}/connectionStats?{query} <br /> v1:{base_path}/{version}/networks/{pathv1}/wireless/clients/{pathv2}/connectionStats?{query}</td>
|
|
1755
1792
|
<td style="padding:15px">Yes</td>
|
|
1756
1793
|
</tr>
|
|
1757
1794
|
<tr>
|
|
1758
1795
|
<td style="padding:15px">getNetworkLatencyStats(networkId, t0, t1, timespan, ssid, vlan, apTag, fields, callback)</td>
|
|
1759
1796
|
<td style="padding:15px">Aggregated latency info for this network</td>
|
|
1760
|
-
<td style="padding:15px">
|
|
1797
|
+
<td style="padding:15px">v0:{base_path}/{version}/networks/{pathv1}/latencyStats?{query} <br /> v1:{base_path}/{version}/networks/{pathv1}/wireless/latencyStats?{query}</td>
|
|
1761
1798
|
<td style="padding:15px">Yes</td>
|
|
1762
1799
|
</tr>
|
|
1763
1800
|
<tr>
|
|
1764
1801
|
<td style="padding:15px">getNetworkDevicesLatencyStats(networkId, t0, t1, timespan, ssid, vlan, apTag, fields, callback)</td>
|
|
1765
1802
|
<td style="padding:15px">Aggregated latency info for this network, grouped by node</td>
|
|
1766
|
-
<td style="padding:15px">
|
|
1803
|
+
<td style="padding:15px">v0:{base_path}/{version}/networks/{pathv1}/devices/latencyStats?{query} <br /> v1:{base_path}/{version}/networks/{pathv1}/wireless/devices/latencyStats?{query}</td>
|
|
1767
1804
|
<td style="padding:15px">Yes</td>
|
|
1768
1805
|
</tr>
|
|
1769
1806
|
<tr>
|
|
@@ -1781,19 +1818,19 @@ v3AuthPass| string| The SNMP version 3 authentication pass...(description trunca
|
|
|
1781
1818
|
<tr>
|
|
1782
1819
|
<td style="padding:15px">getNetworkClientsLatencyStats(networkId, t0, t1, timespan, ssid, vlan, apTag, fields, callback)</td>
|
|
1783
1820
|
<td style="padding:15px">Aggregated latency info for this network, grouped by clients</td>
|
|
1784
|
-
<td style="padding:15px">
|
|
1821
|
+
<td style="padding:15px">v0:{base_path}/{version}/networks/{pathv1}/clients/latencyStats?{query} <br /> v1:{base_path}/{version}/networks/{pathv1}/wireless/clients/latencyStats?{query}</td>
|
|
1785
1822
|
<td style="padding:15px">Yes</td>
|
|
1786
1823
|
</tr>
|
|
1787
1824
|
<tr>
|
|
1788
1825
|
<td style="padding:15px">getNetworkClientLatencyStats(networkId, clientId, t0, t1, timespan, ssid, vlan, apTag, fields, callback)</td>
|
|
1789
1826
|
<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">
|
|
1827
|
+
<td style="padding:15px">v0:{base_path}/{version}/networks/{pathv1}/clients/{pathv2}/latencyStats?{query} <br /> v1:{base_path}/{version}/networks/{pathv1}/wireless/clients/{pathv2}/latencyStats?{query}</td>
|
|
1791
1828
|
<td style="padding:15px">Yes</td>
|
|
1792
1829
|
</tr>
|
|
1793
1830
|
<tr>
|
|
1794
1831
|
<td style="padding:15px">getNetworkFailedConnections(networkId, t0, t1, timespan, ssid, vlan, apTag, serial, clientId, callback)</td>
|
|
1795
1832
|
<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">
|
|
1833
|
+
<td style="padding:15px">v0:{base_path}/{version}/networks/{pathv1}/failedConnections?{query} <br /> v1:{base_path}/{version}/networks/{pathv1}/wireless/failedConnections?{query}</td>
|
|
1797
1834
|
<td style="padding:15px">Yes</td>
|
|
1798
1835
|
</tr>
|
|
1799
1836
|
<tr>
|
|
@@ -1829,98 +1866,85 @@ v3AuthPass| string| The SNMP version 3 authentication pass...(description trunca
|
|
|
1829
1866
|
<tr>
|
|
1830
1867
|
<td style="padding:15px">getNetworkCellularGatewaySettingsConnectivityMonitoringDestinations(networkId, callback)</td>
|
|
1831
1868
|
<td style="padding:15px">Return the connectivity testing destinations for an MG network</td>
|
|
1832
|
-
<td style="padding:15px">
|
|
1869
|
+
<td style="padding:15px">v0:{base_path}/{version}/networks/{pathv1}/cellularGateway/settings/connectivityMonitoringDestinations?{query} <br /> v1:{base_path}/{version}/networks/{pathv1}/cellularGateway/connectivityMonitoringDestinations?{query}</td>
|
|
1833
1870
|
<td style="padding:15px">Yes</td>
|
|
1834
1871
|
</tr>
|
|
1835
1872
|
<tr>
|
|
1836
1873
|
<td style="padding:15px">updateNetworkCellularGatewaySettingsConnectivityMonitoringDestinations(networkId, body, callback)</td>
|
|
1837
1874
|
<td style="padding:15px">Update the connectivity testing destinations for an MG network</td>
|
|
1838
|
-
<td style="padding:15px">
|
|
1875
|
+
<td style="padding:15px">v0:{base_path}/{version}/networks/{pathv1}/cellularGateway/settings/connectivityMonitoringDestinations?{query} <br /> v1:{base_path}/{version}/networks/{pathv1}/cellularGateway/connectivityMonitoringDestinations?{query}</td>
|
|
1839
1876
|
<td style="padding:15px">Yes</td>
|
|
1840
1877
|
</tr>
|
|
1841
1878
|
<tr>
|
|
1842
1879
|
<td style="padding:15px">getNetworkCellularGatewaySettingsDhcp(networkId, callback)</td>
|
|
1843
1880
|
<td style="padding:15px">List common DHCP settings of MGs</td>
|
|
1844
|
-
<td style="padding:15px">
|
|
1881
|
+
<td style="padding:15px">v0:{base_path}/{version}/networks/{pathv1}/cellularGateway/settings/dhcp?{query} <br /> v1:{base_path}/{version}/networks/{pathv1}/cellularGateway/dhcp?{query}</td>
|
|
1845
1882
|
<td style="padding:15px">Yes</td>
|
|
1846
1883
|
</tr>
|
|
1847
1884
|
<tr>
|
|
1848
1885
|
<td style="padding:15px">updateNetworkCellularGatewaySettingsDhcp(networkId, body, callback)</td>
|
|
1849
1886
|
<td style="padding:15px">Update common DHCP settings of MGs</td>
|
|
1850
|
-
<td style="padding:15px">
|
|
1887
|
+
<td style="padding:15px">v0:{base_path}/{version}/networks/{pathv1}/cellularGateway/settings/dhcp?{query} <br /> v1:{base_path}/{version}/networks/{pathv1}/cellularGateway/dhcp?{query}</td>
|
|
1851
1888
|
<td style="padding:15px">Yes</td>
|
|
1852
1889
|
</tr>
|
|
1853
1890
|
<tr>
|
|
1854
1891
|
<td style="padding:15px">getDeviceCellularGatewaySettings(serial, callback)</td>
|
|
1855
1892
|
<td style="padding:15px">Show the LAN Settings of a MG</td>
|
|
1856
|
-
<td style="padding:15px">
|
|
1893
|
+
<td style="padding:15px">v0:{base_path}/{version}/devices/{pathv1}/cellularGateway/settings?{query} <br /> v1:{base_path}/{version}/devices/{pathv1}/cellularGateway/lan?{query}</td>
|
|
1857
1894
|
<td style="padding:15px">Yes</td>
|
|
1858
1895
|
</tr>
|
|
1859
1896
|
<tr>
|
|
1860
1897
|
<td style="padding:15px">returnTheEAPOverriddenParametersForAnSSID(networkId, number, callback)</td>
|
|
1861
|
-
<td style="padding:15px">Return
|
|
1862
|
-
<td style="padding:15px">
|
|
1898
|
+
<td style="padding:15px">Return The EAP Overridden Parameters For An SSID</td>
|
|
1899
|
+
<td style="padding:15px">v0:{base_path}/{version}/networks/{pathv1}/ssids/{pathv2}/eap_override?{query} <br /> v1:{base_path}/{version}/networks/{pathv1}/wireless/ssids/{pathv2}/eapOverride?{query}</td>
|
|
1863
1900
|
<td style="padding:15px">Yes</td>
|
|
1864
1901
|
</tr>
|
|
1865
1902
|
<tr>
|
|
1866
1903
|
<td style="padding:15px">updateTheEAPOverriddenParametersForAnSSID(networkId, number, body, callback)</td>
|
|
1867
|
-
<td style="padding:15px">Update
|
|
1868
|
-
|
|
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>
|
|
1904
|
+
<td style="padding:15px">Update The EAP Overridden Parameters For An SSID</td>
|
|
1905
|
+
<td style="padding:15px">v0:{base_path}/{version}/networks/{pathv1}/ssids/{pathv2}/eap_override?{query} <br /> v1:{base_path}/{version}/networks/{pathv1}/wireless/ssids/{pathv2}/eapOverride?{query}</td>
|
|
1882
1906
|
<td style="padding:15px">Yes</td>
|
|
1883
1907
|
</tr>
|
|
1884
1908
|
<tr>
|
|
1885
1909
|
<td style="padding:15px">updateDeviceCellularGatewaySettings(serial, body, callback)</td>
|
|
1886
1910
|
<td style="padding:15px">Update the LAN Settings for a single MG.</td>
|
|
1887
|
-
<td style="padding:15px">
|
|
1911
|
+
<td style="padding:15px">v0:{base_path}/{version}/devices/{pathv1}/cellularGateway/settings?{query} <br /> v1:{base_path}/{version}/devices/{pathv1}/cellularGateway/lan?{query}</td>
|
|
1888
1912
|
<td style="padding:15px">Yes</td>
|
|
1889
1913
|
</tr>
|
|
1890
1914
|
<tr>
|
|
1891
1915
|
<td style="padding:15px">getDeviceCellularGatewaySettingsPortForwardingRules(serial, callback)</td>
|
|
1892
1916
|
<td style="padding:15px">Returns the port forwarding rules for a single MG.</td>
|
|
1893
|
-
<td style="padding:15px">
|
|
1917
|
+
<td style="padding:15px">v0:{base_path}/{version}/devices/{pathv1}/cellularGateway/settings/portForwardingRules?{query} <br /> v1:{base_path}/{version}/devices/{pathv1}/cellularGateway/portForwardingRules?{query}</td>
|
|
1894
1918
|
<td style="padding:15px">Yes</td>
|
|
1895
1919
|
</tr>
|
|
1896
1920
|
<tr>
|
|
1897
1921
|
<td style="padding:15px">updateDeviceCellularGatewaySettingsPortForwardingRules(serial, body, callback)</td>
|
|
1898
1922
|
<td style="padding:15px">Updates the port forwarding rules for a single MG.</td>
|
|
1899
|
-
<td style="padding:15px">
|
|
1923
|
+
<td style="padding:15px">v0:{base_path}/{version}/devices/{pathv1}/cellularGateway/settings/portForwardingRules?{query} <br /> v1:{base_path}/{version}/devices/{pathv1}/cellularGateway/portForwardingRules?{query}</td>
|
|
1900
1924
|
<td style="padding:15px">Yes</td>
|
|
1901
1925
|
</tr>
|
|
1902
1926
|
<tr>
|
|
1903
1927
|
<td style="padding:15px">getNetworkCellularGatewaySettingsSubnetPool(networkId, callback)</td>
|
|
1904
1928
|
<td style="padding:15px">Return the subnet pool and mask configured for MGs in the network.</td>
|
|
1905
|
-
<td style="padding:15px">
|
|
1929
|
+
<td style="padding:15px">v0:{base_path}/{version}/networks/{pathv1}/cellularGateway/settings/subnetPool?{query} <br /> v1:{base_path}/{version}/networks/{pathv1}/cellularGateway/subnetPool?{query}</td>
|
|
1906
1930
|
<td style="padding:15px">Yes</td>
|
|
1907
1931
|
</tr>
|
|
1908
1932
|
<tr>
|
|
1909
1933
|
<td style="padding:15px">updateNetworkCellularGatewaySettingsSubnetPool(networkId, body, callback)</td>
|
|
1910
1934
|
<td style="padding:15px">Update the subnet pool and mask configuration for MGs in the network.</td>
|
|
1911
|
-
<td style="padding:15px">
|
|
1935
|
+
<td style="padding:15px">v0:{base_path}/{version}/networks/{pathv1}/cellularGateway/settings/subnetPool?{query} <br /> v1:{base_path}/{version}/networks/{pathv1}/cellularGateway/subnetPool?{query}</td>
|
|
1912
1936
|
<td style="padding:15px">Yes</td>
|
|
1913
1937
|
</tr>
|
|
1914
1938
|
<tr>
|
|
1915
1939
|
<td style="padding:15px">getNetworkCellularGatewaySettingsUplink(networkId, callback)</td>
|
|
1916
1940
|
<td style="padding:15px">Returns the uplink settings for your MG network.</td>
|
|
1917
|
-
<td style="padding:15px">
|
|
1941
|
+
<td style="padding:15px">v0:{base_path}/{version}/networks/{pathv1}/cellularGateway/settings/uplink?{query} <br /> v1:{base_path}/{version}/networks/{pathv1}/cellularGateway/uplink?{query}</td>
|
|
1918
1942
|
<td style="padding:15px">Yes</td>
|
|
1919
1943
|
</tr>
|
|
1920
1944
|
<tr>
|
|
1921
1945
|
<td style="padding:15px">updateNetworkCellularGatewaySettingsUplink(networkId, body, callback)</td>
|
|
1922
1946
|
<td style="padding:15px">Updates the uplink settings for your MG network.</td>
|
|
1923
|
-
<td style="padding:15px">
|
|
1947
|
+
<td style="padding:15px">v0:{base_path}/{version}/networks/{pathv1}/cellularGateway/settings/uplink?{query} <br /> v1:{base_path}/{version}/networks/{pathv1}/cellularGateway/uplink?{query}</td>
|
|
1924
1948
|
<td style="padding:15px">Yes</td>
|
|
1925
1949
|
</tr>
|
|
1926
1950
|
<tr>
|
|
@@ -1937,25 +1961,25 @@ eapolKey| object| EAPOL Key settings.
|
|
|
1937
1961
|
</tr>
|
|
1938
1962
|
<tr>
|
|
1939
1963
|
<td style="padding:15px">listTheAccessPoliciesForASwitchNetwork(networkId, callback)</td>
|
|
1940
|
-
<td style="padding:15px">List
|
|
1941
|
-
<td style="padding:15px">
|
|
1964
|
+
<td style="padding:15px">List The Access Policies For A Switch Network</td>
|
|
1965
|
+
<td style="padding:15px">v0:{base_path}/{version}/networks/{pathv1}/accessPolicies?{query} <br /> v1:{base_path}/{version}/networks/{pathv1}/switch/accessPolicies?{query}</td>
|
|
1942
1966
|
<td style="padding:15px">Yes</td>
|
|
1943
1967
|
</tr>
|
|
1944
1968
|
<tr>
|
|
1945
1969
|
<td style="padding:15px">createAnAccessPolicyForASwitchNetwork(networkId, body, callback)</td>
|
|
1946
|
-
<td style="padding:15px">Create
|
|
1970
|
+
<td style="padding:15px">Create An Access Policy For A Switch Network</td>
|
|
1947
1971
|
<td style="padding:15px">{base_path}/{version}/networks/{pathv1}/switch/accessPolicies?{query}</td>
|
|
1948
1972
|
<td style="padding:15px">Yes</td>
|
|
1949
1973
|
</tr>
|
|
1950
1974
|
<tr>
|
|
1951
1975
|
<td style="padding:15px">returnASpecificAccessPolicyForASwitchNetwork(networkId, accessPolicyNumber, callback)</td>
|
|
1952
|
-
<td style="padding:15px">Return
|
|
1976
|
+
<td style="padding:15px">Return A Specific Access Policy For A Switch Network</td>
|
|
1953
1977
|
<td style="padding:15px">{base_path}/{version}/networks/{pathv1}/switch/accessPolicies/{pathv2}?{query}</td>
|
|
1954
1978
|
<td style="padding:15px">Yes</td>
|
|
1955
1979
|
</tr>
|
|
1956
1980
|
<tr>
|
|
1957
1981
|
<td style="padding:15px">updateAnAccessPolicyForASwitchNetwork(networkId, accessPolicyNumber, body, callback)</td>
|
|
1958
|
-
<td style="padding:15px">Update
|
|
1982
|
+
<td style="padding:15px">Update An Access Policy For A Switch Network</td>
|
|
1959
1983
|
<td style="padding:15px">{base_path}/{version}/networks/{pathv1}/switch/accessPolicies/{pathv2}?{query}</td>
|
|
1960
1984
|
<td style="padding:15px">Yes</td>
|
|
1961
1985
|
</tr>
|
|
@@ -1967,42 +1991,32 @@ eapolKey| object| EAPOL Key settings.
|
|
|
1967
1991
|
</tr>
|
|
1968
1992
|
<tr>
|
|
1969
1993
|
<td style="padding:15px">returnTheStatusForAllThePortsOfASwitch(serial, callback)</td>
|
|
1970
|
-
<td style="padding:15px">Return
|
|
1971
|
-
<td style="padding:15px">
|
|
1994
|
+
<td style="padding:15px">Return The Status For All The Ports Of A Switch</td>
|
|
1995
|
+
<td style="padding:15px">v0:{base_path}/{version}/devices/{pathv1}/switchPortStatuses?{query} <br /> v1:{base_path}/{version}/devices/{pathv1}/switch/ports/statuses?{query}</td>
|
|
1972
1996
|
<td style="padding:15px">Yes</td>
|
|
1973
1997
|
</tr>
|
|
1974
1998
|
<tr>
|
|
1975
1999
|
<td style="padding:15px">returnThePacketCountersForAllThePortsOfASwitch(serial, callback)</td>
|
|
1976
2000
|
<td style="padding:15px">Return the packet counters for all the ports of a switch</td>
|
|
1977
|
-
<td style="padding:15px">
|
|
2001
|
+
<td style="padding:15px">v0:{base_path}/{version}/devices/{pathv1}/switchPortStatuses/packets?{query} <br /> v1:{base_path}/{version}/devices/{pathv1}/switch/ports/statuses/packets?{query}</td>
|
|
1978
2002
|
<td style="padding:15px">Yes</td>
|
|
1979
2003
|
</tr>
|
|
1980
2004
|
<tr>
|
|
1981
2005
|
<td style="padding:15px">returnsTheUplinkBandwidthSettingsForYourMXNetwork(networkId, callback)</td>
|
|
1982
|
-
<td style="padding:15px">Returns
|
|
2006
|
+
<td style="padding:15px">Returns The Uplink Bandwidth Settings For Your MX Network</td>
|
|
1983
2007
|
<td style="padding:15px">{base_path}/{version}/networks/{pathv1}/appliance/trafficShaping/uplinkBandwidth?{query}</td>
|
|
1984
2008
|
<td style="padding:15px">Yes</td>
|
|
1985
2009
|
</tr>
|
|
1986
2010
|
<tr>
|
|
1987
2011
|
<td style="padding:15px">updatesTheUplinkBandwidthSettingsForYourMXNetwork(networkId, body, callback)</td>
|
|
1988
|
-
<td style="padding:15px">Updates
|
|
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>
|
|
2012
|
+
<td style="padding:15px">Updates The Uplink Bandwidth Settings For Your MX Network</td>
|
|
1999
2013
|
<td style="padding:15px">{base_path}/{version}/networks/{pathv1}/appliance/trafficShaping/uplinkBandwidth?{query}</td>
|
|
2000
2014
|
<td style="padding:15px">Yes</td>
|
|
2001
2015
|
</tr>
|
|
2002
2016
|
<tr>
|
|
2003
2017
|
<td style="padding:15px">refreshTheDetailsOfADevice(networkId, deviceId, callback)</td>
|
|
2004
|
-
<td style="padding:15px">Refresh
|
|
2005
|
-
<td style="padding:15px">
|
|
2018
|
+
<td style="padding:15px">Refresh The Details Of A Device</td>
|
|
2019
|
+
<td style="padding:15px">v0:{base_path}/{version}/networks/{pathv1}/sm/device/{pathv2}/refreshDetails?{query} <br /> v1:{base_path}/{version}/networks/{pathv1}/sm/devices/{pathv2}/refreshDetails?{query}</td>
|
|
2006
2020
|
<td style="padding:15px">Yes</td>
|
|
2007
2021
|
</tr>
|
|
2008
2022
|
<tr>
|
|
@@ -2032,37 +2046,37 @@ bandwidthLimits| object| A mapping of uplinks to their bandwidth settings (be su
|
|
|
2032
2046
|
<tr>
|
|
2033
2047
|
<td style="padding:15px">getNetworkAppliancePorts(networkId, callback)</td>
|
|
2034
2048
|
<td style="padding:15px">List per-port VLAN settings for all ports of a MX.</td>
|
|
2035
|
-
<td style="padding:15px">
|
|
2049
|
+
<td style="padding:15px">v0:{base_path}/{version}/networks/{pathv1}/appliancePorts?{query} <br /> v1:{base_path}/{version}/networks/{pathv1}/appliance/ports?{query}</td>
|
|
2036
2050
|
<td style="padding:15px">Yes</td>
|
|
2037
2051
|
</tr>
|
|
2038
2052
|
<tr>
|
|
2039
2053
|
<td style="padding:15px">getNetworkAppliancePort(networkId, appliancePortId, callback)</td>
|
|
2040
2054
|
<td style="padding:15px">Return per-port VLAN settings for a single MX port.</td>
|
|
2041
|
-
<td style="padding:15px">
|
|
2055
|
+
<td style="padding:15px">v0:{base_path}/{version}/networks/{pathv1}/appliancePorts/{pathv2}?{query} <br /> v1:{base_path}/{version}/networks/{pathv1}/appliance/ports/{pathv2}?{query}</td>
|
|
2042
2056
|
<td style="padding:15px">Yes</td>
|
|
2043
2057
|
</tr>
|
|
2044
2058
|
<tr>
|
|
2045
2059
|
<td style="padding:15px">updateNetworkAppliancePort(body, networkId, appliancePortId, callback)</td>
|
|
2046
2060
|
<td style="padding:15px">Update the per-port VLAN settings for a single MX port.</td>
|
|
2047
|
-
<td style="padding:15px">
|
|
2061
|
+
<td style="padding:15px">v0:{base_path}/{version}/networks/{pathv1}/appliancePorts/{pathv2}?{query} <br /> v1:{base_path}/{version}/networks/{pathv1}/appliance/ports/{pathv2}?{query}</td>
|
|
2048
2062
|
<td style="padding:15px">Yes</td>
|
|
2049
2063
|
</tr>
|
|
2050
2064
|
<tr>
|
|
2051
2065
|
<td style="padding:15px">swapNetworkWarmspare(networkId, body, callback)</td>
|
|
2052
2066
|
<td style="padding:15px">Swap MX primary and warm spare appliances</td>
|
|
2053
|
-
<td style="padding:15px">
|
|
2067
|
+
<td style="padding:15px">v0:{base_path}/{version}/networks/{pathv1}/swapWarmSpare?{query} <br /> v1:{base_path}/{version}/networks/{pathv1}/appliance/WarmSpare/swap?{query}</td>
|
|
2054
2068
|
<td style="padding:15px">Yes</td>
|
|
2055
2069
|
</tr>
|
|
2056
2070
|
<tr>
|
|
2057
2071
|
<td style="padding:15px">getNetworkWarmSpareSettings(networkId, callback)</td>
|
|
2058
2072
|
<td style="padding:15px">Return MX warm spare settings</td>
|
|
2059
|
-
<td style="padding:15px">
|
|
2073
|
+
<td style="padding:15px">v0:{base_path}/{version}/networks/{pathv1}/warmSpareSettings?{query} <br /> v1:{base_path}/{version}/networks/{pathv1}/appliance/warmSpare?{query}</td>
|
|
2060
2074
|
<td style="padding:15px">Yes</td>
|
|
2061
2075
|
</tr>
|
|
2062
2076
|
<tr>
|
|
2063
2077
|
<td style="padding:15px">updateNetworkWarmSpareSettings(networkId, body, callback)</td>
|
|
2064
2078
|
<td style="padding:15px">Update MX warm spare settings</td>
|
|
2065
|
-
<td style="padding:15px">
|
|
2079
|
+
<td style="padding:15px">v0:{base_path}/{version}/networks/{pathv1}/warmSpareSettings?{query} <br /> v1:{base_path}/{version}/networks/{pathv1}/appliance/warmSpare?{query}</td>
|
|
2066
2080
|
<td style="padding:15px">Yes</td>
|
|
2067
2081
|
</tr>
|
|
2068
2082
|
<tr>
|
|
@@ -2110,115 +2124,115 @@ bandwidthLimits| object| A mapping of uplinks to their bandwidth settings (be su
|
|
|
2110
2124
|
<tr>
|
|
2111
2125
|
<td style="padding:15px">getNetworkSwitchSettingsDhcpServerPolicy(networkId, callback)</td>
|
|
2112
2126
|
<td style="padding:15px">Return the DHCP server policy</td>
|
|
2113
|
-
<td style="padding:15px">
|
|
2127
|
+
<td style="padding:15px">v0:{base_path}/{version}/networks/{pathv1}/switch/settings/dhcpServerPolicy?{query} <br /> v1:{base_path}/{version}/networks/{pathv1}/switch/dhcpServerPolicy?{query}</td>
|
|
2114
2128
|
<td style="padding:15px">Yes</td>
|
|
2115
2129
|
</tr>
|
|
2116
2130
|
<tr>
|
|
2117
2131
|
<td style="padding:15px">updateNetworkSwitchSettingsDhcpServerPolicy(body, networkId, callback)</td>
|
|
2118
2132
|
<td style="padding:15px">Update the DHCP server policy</td>
|
|
2119
|
-
<td style="padding:15px">
|
|
2133
|
+
<td style="padding:15px">v0:{base_path}/{version}/networks/{pathv1}/switch/settings/dhcpServerPolicy?{query} <br /> v1:{base_path}/{version}/networks/{pathv1}/switch/dhcpServerPolicy?{query}</td>
|
|
2120
2134
|
<td style="padding:15px">Yes</td>
|
|
2121
2135
|
</tr>
|
|
2122
2136
|
<tr>
|
|
2123
2137
|
<td style="padding:15px">getNetworkSwitchSettingsDscpToCosMappings(networkId, callback)</td>
|
|
2124
2138
|
<td style="padding:15px">Return the DSCP to CoS mappings</td>
|
|
2125
|
-
<td style="padding:15px">
|
|
2139
|
+
<td style="padding:15px">v0:{base_path}/{version}/networks/{pathv1}/switch/settings/dscpToCosMappings?{query} <br /> v1:{base_path}/{version}/networks/{pathv1}/switch/dscpToCosMappings?{query}</td>
|
|
2126
2140
|
<td style="padding:15px">Yes</td>
|
|
2127
2141
|
</tr>
|
|
2128
2142
|
<tr>
|
|
2129
2143
|
<td style="padding:15px">updateNetworkSwitchSettingsDscpToCosMappings(body, networkId, callback)</td>
|
|
2130
2144
|
<td style="padding:15px">Update the DSCP to CoS mappings</td>
|
|
2131
|
-
<td style="padding:15px">
|
|
2145
|
+
<td style="padding:15px">v0:{base_path}/{version}/networks/{pathv1}/switch/settings/dscpToCosMappings?{query} <br /> v1:{base_path}/{version}/networks/{pathv1}/switch/dscpToCosMappings?{query}</td>
|
|
2132
2146
|
<td style="padding:15px">Yes</td>
|
|
2133
2147
|
</tr>
|
|
2134
2148
|
<tr>
|
|
2135
2149
|
<td style="padding:15px">getNetworkSwitchSettingsMtu(networkId, callback)</td>
|
|
2136
2150
|
<td style="padding:15px">Return the MTU configuration</td>
|
|
2137
|
-
<td style="padding:15px">
|
|
2151
|
+
<td style="padding:15px">v0:{base_path}/{version}/networks/{pathv1}/switch/settings/mtu?{query} <br /> v1:{base_path}/{version}/networks/{pathv1}/switch/mtu?{query}</td>
|
|
2138
2152
|
<td style="padding:15px">Yes</td>
|
|
2139
2153
|
</tr>
|
|
2140
2154
|
<tr>
|
|
2141
2155
|
<td style="padding:15px">updateNetworkSwitchSettingsMtu(body, networkId, callback)</td>
|
|
2142
2156
|
<td style="padding:15px">Update the MTU configuration</td>
|
|
2143
|
-
<td style="padding:15px">
|
|
2157
|
+
<td style="padding:15px">v0:{base_path}/{version}/networks/{pathv1}/switch/settings/mtu?{query} <br /> v1:{base_path}/{version}/networks/{pathv1}/switch/mtu?{query}</td>
|
|
2144
2158
|
<td style="padding:15px">Yes</td>
|
|
2145
2159
|
</tr>
|
|
2146
2160
|
<tr>
|
|
2147
2161
|
<td style="padding:15px">getNetworkSwitchSettingsQosRules(networkId, callback)</td>
|
|
2148
2162
|
<td style="padding:15px">List quality of service rules</td>
|
|
2149
|
-
<td style="padding:15px">
|
|
2163
|
+
<td style="padding:15px">v0:{base_path}/{version}/networks/{pathv1}/switch/settings/qosRules?{query} <br /> v1:{base_path}/{version}/networks/{pathv1}/switch/qosRules?{query}</td>
|
|
2150
2164
|
<td style="padding:15px">Yes</td>
|
|
2151
2165
|
</tr>
|
|
2152
2166
|
<tr>
|
|
2153
2167
|
<td style="padding:15px">createNetworkSwitchSettingsQosRule(body, networkId, callback)</td>
|
|
2154
2168
|
<td style="padding:15px">Add a quality of service rule</td>
|
|
2155
|
-
<td style="padding:15px">
|
|
2169
|
+
<td style="padding:15px">v0:{base_path}/{version}/networks/{pathv1}/switch/settings/qosRules?{query} <br /> v1:{base_path}/{version}/networks/{pathv1}/switch/qosRules?{query}</td>
|
|
2156
2170
|
<td style="padding:15px">Yes</td>
|
|
2157
2171
|
</tr>
|
|
2158
2172
|
<tr>
|
|
2159
2173
|
<td style="padding:15px">getNetworkSwitchSettingsQosRulesOrder(networkId, callback)</td>
|
|
2160
2174
|
<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">
|
|
2175
|
+
<td style="padding:15px">v0:{base_path}/{version}/networks/{pathv1}/switch/settings/qosRules/order?{query} <br /> v1:{base_path}/{version}/networks/{pathv1}/switch/qosRules/order?{query}</td>
|
|
2162
2176
|
<td style="padding:15px">Yes</td>
|
|
2163
2177
|
</tr>
|
|
2164
2178
|
<tr>
|
|
2165
2179
|
<td style="padding:15px">updateNetworkSwitchSettingsQosRulesOrder(body, networkId, callback)</td>
|
|
2166
2180
|
<td style="padding:15px">Update the order in which the rules should be processed by the switch</td>
|
|
2167
|
-
<td style="padding:15px">
|
|
2181
|
+
<td style="padding:15px">v0:{base_path}/{version}/networks/{pathv1}/switch/settings/qosRules/order?{query} <br /> v1:{base_path}/{version}/networks/{pathv1}/switch/qosRules/order?{query}</td>
|
|
2168
2182
|
<td style="padding:15px">Yes</td>
|
|
2169
2183
|
</tr>
|
|
2170
2184
|
<tr>
|
|
2171
2185
|
<td style="padding:15px">getNetworkSwitchSettingsQosRule(networkId, qosRuleId, callback)</td>
|
|
2172
2186
|
<td style="padding:15px">Return a quality of service rule</td>
|
|
2173
|
-
<td style="padding:15px">
|
|
2187
|
+
<td style="padding:15px">v0:{base_path}/{version}/networks/{pathv1}/switch/settings/qosRules/{pathv2}?{query} <br /> v1:{base_path}/{version}/networks/{pathv1}/switch/qosRules/{pathv2}?{query}</td>
|
|
2174
2188
|
<td style="padding:15px">Yes</td>
|
|
2175
2189
|
</tr>
|
|
2176
2190
|
<tr>
|
|
2177
2191
|
<td style="padding:15px">deleteNetworkSwitchSettingsQosRule(networkId, qosRuleId, callback)</td>
|
|
2178
2192
|
<td style="padding:15px">Delete a quality of service rule</td>
|
|
2179
|
-
<td style="padding:15px">
|
|
2193
|
+
<td style="padding:15px">v0:{base_path}/{version}/networks/{pathv1}/switch/settings/qosRules/{pathv2}?{query} <br /> v1:{base_path}/{version}/networks/{pathv1}/switch/qosRules/{pathv2}?{query}</td>
|
|
2180
2194
|
<td style="padding:15px">Yes</td>
|
|
2181
2195
|
</tr>
|
|
2182
2196
|
<tr>
|
|
2183
2197
|
<td style="padding:15px">updateNetworkSwitchSettingsQosRule(networkId, qosRuleId, body, callback)</td>
|
|
2184
2198
|
<td style="padding:15px">Update a quality of service rule</td>
|
|
2185
|
-
<td style="padding:15px">
|
|
2199
|
+
<td style="padding:15px">v0:{base_path}/{version}/networks/{pathv1}/switch/settings/qosRules/{pathv2}?{query} <br /> v1:{base_path}/{version}/networks/{pathv1}/switch/qosRules/{pathv2}?{query}</td>
|
|
2186
2200
|
<td style="padding:15px">Yes</td>
|
|
2187
2201
|
</tr>
|
|
2188
2202
|
<tr>
|
|
2189
2203
|
<td style="padding:15px">getNetworkSwitchSettingsStormControl(networkId, callback)</td>
|
|
2190
2204
|
<td style="padding:15px">Return the storm control configuration for a switch network</td>
|
|
2191
|
-
<td style="padding:15px">
|
|
2205
|
+
<td style="padding:15px">v0:{base_path}/{version}/networks/{pathv1}/switch/settings/stormControl?{query} <br /> v1:{base_path}/{version}/networks/{pathv1}/switch/stormControl?{query}</td>
|
|
2192
2206
|
<td style="padding:15px">Yes</td>
|
|
2193
2207
|
</tr>
|
|
2194
2208
|
<tr>
|
|
2195
2209
|
<td style="padding:15px">updateNetworkSwitchSettingsStormControl(networkId, body, callback)</td>
|
|
2196
2210
|
<td style="padding:15px">Update the storm control configuration for a switch network</td>
|
|
2197
|
-
<td style="padding:15px">
|
|
2211
|
+
<td style="padding:15px">v0:{base_path}/{version}/networks/{pathv1}/switch/settings/stormControl?{query} <br /> v1:{base_path}/{version}/networks/{pathv1}/switch/stormControl?{query}</td>
|
|
2198
2212
|
<td style="padding:15px">Yes</td>
|
|
2199
2213
|
</tr>
|
|
2200
2214
|
<tr>
|
|
2201
2215
|
<td style="padding:15px">getNetworkSwitchSettingsStp(networkId, callback)</td>
|
|
2202
2216
|
<td style="padding:15px">Returns STP settings</td>
|
|
2203
|
-
<td style="padding:15px">
|
|
2217
|
+
<td style="padding:15px">v0:{base_path}/{version}/networks/{pathv1}/switch/settings/stp?{query} <br /> v1:{base_path}/{version}/networks/{pathv1}/switch/stp?{query}</td>
|
|
2204
2218
|
<td style="padding:15px">Yes</td>
|
|
2205
2219
|
</tr>
|
|
2206
2220
|
<tr>
|
|
2207
2221
|
<td style="padding:15px">updateNetworkSwitchSettingsStp(body, networkId, callback)</td>
|
|
2208
2222
|
<td style="padding:15px">Updates STP settings</td>
|
|
2209
|
-
<td style="padding:15px">
|
|
2223
|
+
<td style="padding:15px">v0:{base_path}/{version}/networks/{pathv1}/switch/settings/stp?{query} <br /> v1:{base_path}/{version}/networks/{pathv1}/switch/stp?{query}</td>
|
|
2210
2224
|
<td style="padding:15px">Yes</td>
|
|
2211
2225
|
</tr>
|
|
2212
2226
|
<tr>
|
|
2213
2227
|
<td style="padding:15px">getNetworkConnectivityMonitoringDestinations(networkId, callback)</td>
|
|
2214
2228
|
<td style="padding:15px">Return the connectivity testing destinations for an MX network</td>
|
|
2215
|
-
<td style="padding:15px">
|
|
2229
|
+
<td style="padding:15px">v0:{base_path}/{version}/networks/{pathv1}/connectivityMonitoringDestinations?{query} <br /> v1:{base_path}/{version}/networks/{pathv1}/appliance/connectivityMonitoringDestinations?{query}</td>
|
|
2216
2230
|
<td style="padding:15px">Yes</td>
|
|
2217
2231
|
</tr>
|
|
2218
2232
|
<tr>
|
|
2219
2233
|
<td style="padding:15px">updateNetworkConnectivityMonitoringDestinations(networkId, body, callback)</td>
|
|
2220
2234
|
<td style="padding:15px">Update the connectivity testing destinations for an MX network</td>
|
|
2221
|
-
<td style="padding:15px">
|
|
2235
|
+
<td style="padding:15px">v0:{base_path}/{version}/networks/{pathv1}/connectivityMonitoringDestinations?{query} <br /> v1:{base_path}/{version}/networks/{pathv1}/appliance/connectivityMonitoringDestinations?{query}</td>
|
|
2222
2236
|
<td style="padding:15px">Yes</td>
|
|
2223
2237
|
</tr>
|
|
2224
2238
|
<tr>
|
|
@@ -2332,31 +2346,31 @@ bandwidthLimits| object| A mapping of uplinks to their bandwidth settings (be su
|
|
|
2332
2346
|
<tr>
|
|
2333
2347
|
<td style="padding:15px">getNetworkNetflowSettings(networkId, callback)</td>
|
|
2334
2348
|
<td style="padding:15px">Return the NetFlow traffic reporting settings for a network</td>
|
|
2335
|
-
<td style="padding:15px">
|
|
2349
|
+
<td style="padding:15px">v0:{base_path}/{version}/networks/{pathv1}/netflowSettings?{query} <br /> v1:{base_path}/{version}/networks/{pathv1}/netflow?{query}</td>
|
|
2336
2350
|
<td style="padding:15px">Yes</td>
|
|
2337
2351
|
</tr>
|
|
2338
2352
|
<tr>
|
|
2339
2353
|
<td style="padding:15px">updateNetworkNetflowSettings(networkId, body, callback)</td>
|
|
2340
2354
|
<td style="padding:15px">Update the NetFlow traffic reporting settings for a network</td>
|
|
2341
|
-
<td style="padding:15px">
|
|
2355
|
+
<td style="padding:15px">v0:{base_path}/{version}/networks/{pathv1}/netflowSettings?{query} <br /> v1:{base_path}/{version}/networks/{pathv1}/netflow?{query}</td>
|
|
2342
2356
|
<td style="padding:15px">Yes</td>
|
|
2343
2357
|
</tr>
|
|
2344
2358
|
<tr>
|
|
2345
2359
|
<td style="padding:15px">getNetworkTrafficAnalysisSettings(networkId, callback)</td>
|
|
2346
2360
|
<td style="padding:15px">Return the traffic analysis settings for a network</td>
|
|
2347
|
-
<td style="padding:15px">
|
|
2361
|
+
<td style="padding:15px">v0:{base_path}/{version}/networks/{pathv1}/trafficAnalysisSettings?{query} <br /> v1:{base_path}/{version}/networks/{pathv1}/trafficAnalysis?{query}</td>
|
|
2348
2362
|
<td style="padding:15px">Yes</td>
|
|
2349
2363
|
</tr>
|
|
2350
2364
|
<tr>
|
|
2351
2365
|
<td style="padding:15px">updateNetworkTrafficAnalysisSettings(networkId, callback)</td>
|
|
2352
2366
|
<td style="padding:15px">Update the traffic analysis settings for a network</td>
|
|
2353
|
-
<td style="padding:15px">
|
|
2367
|
+
<td style="padding:15px">v0:{base_path}/{version}/networks/{pathv1}/trafficAnalysisSettings?{query} <br /> v1:{base_path}/{version}/networks/{pathv1}/trafficAnalysis?{query}</td>
|
|
2354
2368
|
<td style="padding:15px">Yes</td>
|
|
2355
2369
|
</tr>
|
|
2356
2370
|
<tr>
|
|
2357
2371
|
<td style="padding:15px">getOrganizationWebhookLogs(t0, t1, timespan, perPage, startingAfter, endingBefore, url, organizationId, callback)</td>
|
|
2358
2372
|
<td style="padding:15px">Return the log of webhook POSTs sent</td>
|
|
2359
|
-
<td style="padding:15px">
|
|
2373
|
+
<td style="padding:15px">v0:{base_path}/{version}/organizations/{pathv1}/webhookLogs?{query} <br /> v1:{base_path}/{version}/organizations/{pathv1}/webhooks/logs?{query}</td>
|
|
2360
2374
|
<td style="padding:15px">Yes</td>
|
|
2361
2375
|
</tr>
|
|
2362
2376
|
<tr>
|
|
@@ -2403,19 +2417,13 @@ bandwidthLimits| object| A mapping of uplinks to their bandwidth settings (be su
|
|
|
2403
2417
|
</tr>
|
|
2404
2418
|
<tr>
|
|
2405
2419
|
<td style="padding:15px">fetchOnboardingStatusOfCameras(organizationId, callback)</td>
|
|
2406
|
-
<td style="padding:15px">Fetch
|
|
2420
|
+
<td style="padding:15px">Fetch Onboarding Status Of Cameras</td>
|
|
2407
2421
|
<td style="padding:15px">{base_path}/{version}/organizations/{pathv1}/camera/onboarding/statuses?{query}</td>
|
|
2408
2422
|
<td style="padding:15px">Yes</td>
|
|
2409
2423
|
</tr>
|
|
2410
2424
|
<tr>
|
|
2411
2425
|
<td style="padding:15px">notifyThatCredentialHandoffToCameraHasCompleted(organizationId, body, callback)</td>
|
|
2412
|
-
<td style="padding:15px">Notify
|
|
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>
|
|
2426
|
+
<td style="padding:15px">Notify That Credential Handoff To Camera Has Completed</td>
|
|
2419
2427
|
<td style="padding:15px">{base_path}/{version}/organizations/{pathv1}/camera/onboarding/statuses?{query}</td>
|
|
2420
2428
|
<td style="padding:15px">Yes</td>
|
|
2421
2429
|
</tr>
|
|
@@ -2439,7 +2447,7 @@ wirelessCredentialsSent| boolean| Note whether credentials were sent successfull
|
|
|
2439
2447
|
</tr>
|
|
2440
2448
|
<tr>
|
|
2441
2449
|
<td style="padding:15px">listTheStatusOfEveryMerakiDeviceInTheOrganization(organizationId, callback)</td>
|
|
2442
|
-
<td style="padding:15px">List
|
|
2450
|
+
<td style="padding:15px">List The Status Of Every Meraki Device In The Organization</td>
|
|
2443
2451
|
<td style="padding:15px">{base_path}/{version}/organizations/{pathv1}/devices/statuses?{query}</td>
|
|
2444
2452
|
<td style="padding:15px">Yes</td>
|
|
2445
2453
|
</tr>
|
|
@@ -2451,421 +2459,253 @@ wirelessCredentialsSent| boolean| Note whether credentials were sent successfull
|
|
|
2451
2459
|
</tr>
|
|
2452
2460
|
<tr>
|
|
2453
2461
|
<td style="padding:15px">returnTheFirewallSettingsForThisNetwork(networkId, callback)</td>
|
|
2454
|
-
<td style="padding:15px">Return
|
|
2462
|
+
<td style="padding:15px">Return The Firewall Settings For This Network</td>
|
|
2455
2463
|
<td style="padding:15px">{base_path}/{version}/networks/{pathv1}/appliance/firewall/settings?{query}</td>
|
|
2456
2464
|
<td style="padding:15px">Yes</td>
|
|
2457
2465
|
</tr>
|
|
2458
2466
|
<tr>
|
|
2459
2467
|
<td style="padding:15px">updateTheFirewallSettingsForThisNetwork(networkId, body, callback)</td>
|
|
2460
|
-
<td style="padding:15px">Update
|
|
2461
|
-
#### Body Parameters
|
|
2462
|
-
**Parameter**|**Type**|**Description**
|
|
2463
|
-
:-------------: |:-------------: |:-------------:
|
|
2464
|
-
spoofingProtection| object| Spoofing protection settings
|
|
2465
|
-
</td>
|
|
2468
|
+
<td style="padding:15px">Update The Firewall Settings For This Network</td>
|
|
2466
2469
|
<td style="padding:15px">{base_path}/{version}/networks/{pathv1}/appliance/firewall/settings?{query}</td>
|
|
2467
2470
|
<td style="padding:15px">Yes</td>
|
|
2468
2471
|
</tr>
|
|
2469
2472
|
<tr>
|
|
2470
2473
|
<td style="padding:15px">returnTheApplianceSettingsForANetwork(networkId, callback)</td>
|
|
2471
|
-
<td style="padding:15px">Return
|
|
2474
|
+
<td style="padding:15px">Return The Appliance Settings For A Network</td>
|
|
2472
2475
|
<td style="padding:15px">{base_path}/{version}/networks/{pathv1}/appliance/settings?{query}</td>
|
|
2473
2476
|
<td style="padding:15px">Yes</td>
|
|
2474
2477
|
</tr>
|
|
2475
2478
|
<tr>
|
|
2476
2479
|
<td style="padding:15px">updateTheApplianceSettingsForANetwork(networkId, body, callback)</td>
|
|
2477
|
-
<td style="padding:15px">Update
|
|
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>
|
|
2480
|
+
<td style="padding:15px">Update The Appliance Settings For A Network</td>
|
|
2491
2481
|
<td style="padding:15px">{base_path}/{version}/networks/{pathv1}/appliance/settings?{query}</td>
|
|
2492
2482
|
<td style="padding:15px">Yes</td>
|
|
2493
2483
|
</tr>
|
|
2494
2484
|
<tr>
|
|
2495
2485
|
<td style="padding:15px">returnsTheEnabledStatusOfVLANsForTheNetwork(networkId, callback)</td>
|
|
2496
|
-
<td style="padding:15px">Returns
|
|
2486
|
+
<td style="padding:15px">Returns The Enabled Status Of VLA Ns For The Network</td>
|
|
2497
2487
|
<td style="padding:15px">{base_path}/{version}/networks/{pathv1}/appliance/vlans/settings?{query}</td>
|
|
2498
2488
|
<td style="padding:15px">Yes</td>
|
|
2499
2489
|
</tr>
|
|
2500
2490
|
<tr>
|
|
2501
2491
|
<td style="padding:15px">enableDisableVLANsForTheGivenNetwork(networkId, body, callback)</td>
|
|
2502
|
-
<td style="padding:15px">Enable
|
|
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>
|
|
2492
|
+
<td style="padding:15px">Enable Disable VLA Ns For The Given Network</td>
|
|
2515
2493
|
<td style="padding:15px">{base_path}/{version}/networks/{pathv1}/appliance/vlans/settings?{query}</td>
|
|
2516
2494
|
<td style="padding:15px">Yes</td>
|
|
2517
2495
|
</tr>
|
|
2518
2496
|
<tr>
|
|
2519
2497
|
<td style="padding:15px">returnTheSettingsForANetwork(networkId, callback)</td>
|
|
2520
|
-
<td style="padding:15px">Return
|
|
2498
|
+
<td style="padding:15px">Return The Settings For A Network</td>
|
|
2521
2499
|
<td style="padding:15px">{base_path}/{version}/networks/{pathv1}/settings?{query}</td>
|
|
2522
2500
|
<td style="padding:15px">Yes</td>
|
|
2523
2501
|
</tr>
|
|
2524
2502
|
<tr>
|
|
2525
2503
|
<td style="padding:15px">updateTheSettingsForANetwork(networkId, body, callback)</td>
|
|
2526
|
-
<td style="padding:15px">Update
|
|
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>
|
|
2504
|
+
<td style="padding:15px">Update The Settings For A Network</td>
|
|
2532
2505
|
<td style="padding:15px">{base_path}/{version}/networks/{pathv1}/settings?{query}</td>
|
|
2533
2506
|
<td style="padding:15px">Yes</td>
|
|
2534
2507
|
</tr>
|
|
2535
2508
|
<tr>
|
|
2536
2509
|
<td style="padding:15px">returnsGlobalAdaptivePolicySettingsInAnOrganization(organizationId, callback)</td>
|
|
2537
|
-
<td style="padding:15px">Returns
|
|
2510
|
+
<td style="padding:15px">Returns Global Adaptive Policy Settings In An Organization</td>
|
|
2538
2511
|
<td style="padding:15px">{base_path}/{version}/organizations/{pathv1}/adaptivePolicy/settings?{query}</td>
|
|
2539
2512
|
<td style="padding:15px">Yes</td>
|
|
2540
2513
|
</tr>
|
|
2541
2514
|
<tr>
|
|
2542
2515
|
<td style="padding:15px">updateGlobalAdaptivePolicySettings(organizationId, body, callback)</td>
|
|
2543
|
-
<td style="padding:15px">Update
|
|
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>
|
|
2516
|
+
<td style="padding:15px">Update Global Adaptive Policy Settings</td>
|
|
2556
2517
|
<td style="padding:15px">{base_path}/{version}/organizations/{pathv1}/adaptivePolicy/settings?{query}</td>
|
|
2557
2518
|
<td style="padding:15px">Yes</td>
|
|
2558
2519
|
</tr>
|
|
2559
2520
|
<tr>
|
|
2560
2521
|
<td style="padding:15px">returnTheBluetoothSettingsForAWirelessDevice(serial, callback)</td>
|
|
2561
|
-
<td style="padding:15px">Return
|
|
2522
|
+
<td style="padding:15px">Return The Bluetooth Settings For A Wireless Device</td>
|
|
2562
2523
|
<td style="padding:15px">{base_path}/{version}/devices/{pathv1}/wireless/bluetooth/settings?{query}</td>
|
|
2563
2524
|
<td style="padding:15px">Yes</td>
|
|
2564
2525
|
</tr>
|
|
2565
2526
|
<tr>
|
|
2566
2527
|
<td style="padding:15px">updateTheBluetoothSettingsForAWirelessDevice(serial, body, callback)</td>
|
|
2567
|
-
<td style="padding:15px">Update
|
|
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>
|
|
2528
|
+
<td style="padding:15px">Update The Bluetooth Settings For A Wireless Device</td>
|
|
2574
2529
|
<td style="padding:15px">{base_path}/{version}/devices/{pathv1}/wireless/bluetooth/settings?{query}</td>
|
|
2575
2530
|
<td style="padding:15px">Yes</td>
|
|
2576
2531
|
</tr>
|
|
2577
2532
|
<tr>
|
|
2578
2533
|
<td style="padding:15px">returnTheBluetoothSettingsForANetworkAHrefHttpsDocumentationMerakiComMRBluetoothBluetoothLowEnergyBLEBluetoothSettingsAMustBeEnabledOnTheNetwork(networkId, callback)</td>
|
|
2579
|
-
<td style="padding:15px">Return
|
|
2534
|
+
<td style="padding:15px">Return The Bluetooth Settings For A Network A Href Https Documentation Meraki Com MR Bluetooth Blue</td>
|
|
2580
2535
|
<td style="padding:15px">{base_path}/{version}/networks/{pathv1}/wireless/bluetooth/settings?{query}</td>
|
|
2581
2536
|
<td style="padding:15px">Yes</td>
|
|
2582
2537
|
</tr>
|
|
2583
2538
|
<tr>
|
|
2584
2539
|
<td style="padding:15px">updateTheBluetoothSettingsForANetwork(networkId, body, callback)</td>
|
|
2585
|
-
<td style="padding:15px">Update
|
|
2540
|
+
<td style="padding:15px">Update The Bluetooth Settings For A Network</td>
|
|
2586
2541
|
<td style="padding:15px">{base_path}/{version}/networks/{pathv1}/wireless/bluetooth/settings?{query}</td>
|
|
2587
2542
|
<td style="padding:15px">Yes</td>
|
|
2588
2543
|
</tr>
|
|
2589
2544
|
<tr>
|
|
2590
2545
|
<td style="padding:15px">returnAllThePortsOfASwitchProfile(organizationId, configTemplateId, profileId, callback)</td>
|
|
2591
|
-
<td style="padding:15px">Return
|
|
2546
|
+
<td style="padding:15px">Return All The Ports Of A Switch Profile</td>
|
|
2592
2547
|
<td style="padding:15px">{base_path}/{version}/organizations/{pathv1}/configTemplates/{pathv2}/switch/profiles/{pathv3}/ports?{query}</td>
|
|
2593
2548
|
<td style="padding:15px">Yes</td>
|
|
2594
2549
|
</tr>
|
|
2595
2550
|
<tr>
|
|
2596
2551
|
<td style="padding:15px">returnASwitchProfilePort(organizationId, configTemplateId, profileId, portId, callback)</td>
|
|
2597
|
-
<td style="padding:15px">Return
|
|
2552
|
+
<td style="padding:15px">Return A Switch Profile Port</td>
|
|
2598
2553
|
<td style="padding:15px">{base_path}/{version}/organizations/{pathv1}/configTemplates/{pathv2}/switch/profiles/{pathv3}/ports/{pathv4}?{query}</td>
|
|
2599
2554
|
<td style="padding:15px">Yes</td>
|
|
2600
2555
|
</tr>
|
|
2601
2556
|
<tr>
|
|
2602
2557
|
<td style="padding:15px">updateASwitchProfilePort(organizationId, configTemplateId, profileId, portId, body, callback)</td>
|
|
2603
|
-
<td style="padding:15px">Update
|
|
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>
|
|
2558
|
+
<td style="padding:15px">Update A Switch Profile Port</td>
|
|
2613
2559
|
<td style="padding:15px">{base_path}/{version}/organizations/{pathv1}/configTemplates/{pathv2}/switch/profiles/{pathv3}/ports/{pathv4}?{query}</td>
|
|
2614
2560
|
<td style="padding:15px">Yes</td>
|
|
2615
2561
|
</tr>
|
|
2616
2562
|
<tr>
|
|
2617
2563
|
<td style="padding:15px">returnSingleLANConfiguration(networkId, callback)</td>
|
|
2618
|
-
<td style="padding:15px">Return
|
|
2564
|
+
<td style="padding:15px">Return Single LAN Configuration</td>
|
|
2619
2565
|
<td style="padding:15px">{base_path}/{version}/networks/{pathv1}/appliance/singleLan?{query}</td>
|
|
2620
2566
|
<td style="padding:15px">Yes</td>
|
|
2621
2567
|
</tr>
|
|
2622
2568
|
<tr>
|
|
2623
2569
|
<td style="padding:15px">updateSingleLANConfiguration(networkId, body, callback)</td>
|
|
2624
|
-
<td style="padding:15px">Update
|
|
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>
|
|
2570
|
+
<td style="padding:15px">Update Single LAN Configuration</td>
|
|
2638
2571
|
<td style="padding:15px">{base_path}/{version}/networks/{pathv1}/appliance/singleLan?{query}</td>
|
|
2639
2572
|
<td style="padding:15px">Yes</td>
|
|
2640
2573
|
</tr>
|
|
2641
2574
|
<tr>
|
|
2642
2575
|
<td style="padding:15px">listLayer3StaticRoutesForASwitch(serial, callback)</td>
|
|
2643
|
-
<td style="padding:15px">List
|
|
2576
|
+
<td style="padding:15px">List Layer 3 Static Routes For A Switch</td>
|
|
2644
2577
|
<td style="padding:15px">{base_path}/{version}/devices/{pathv1}/switch/routing/staticRoutes?{query}</td>
|
|
2645
2578
|
<td style="padding:15px">Yes</td>
|
|
2646
2579
|
</tr>
|
|
2647
2580
|
<tr>
|
|
2648
2581
|
<td style="padding:15px">createALayer3StaticRouteForASwitch(serial, body, callback)</td>
|
|
2649
|
-
<td style="padding:15px">Create
|
|
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>
|
|
2582
|
+
<td style="padding:15px">Create A Layer 3 Static Route For A Switch</td>
|
|
2657
2583
|
<td style="padding:15px">{base_path}/{version}/devices/{pathv1}/switch/routing/staticRoutes?{query}</td>
|
|
2658
2584
|
<td style="padding:15px">Yes</td>
|
|
2659
2585
|
</tr>
|
|
2660
2586
|
<tr>
|
|
2661
2587
|
<td style="padding:15px">returnALayer3StaticRouteForASwitch(serial, staticRouteId, callback)</td>
|
|
2662
|
-
<td style="padding:15px">Return
|
|
2588
|
+
<td style="padding:15px">Return A Layer 3 Static Route For A Switch</td>
|
|
2663
2589
|
<td style="padding:15px">{base_path}/{version}/devices/{pathv1}/switch/routing/staticRoutes/{pathv2}?{query}</td>
|
|
2664
2590
|
<td style="padding:15px">Yes</td>
|
|
2665
2591
|
</tr>
|
|
2666
2592
|
<tr>
|
|
2667
2593
|
<td style="padding:15px">updateALayer3StaticRouteForASwitch(serial, staticRouteId, body, callback)</td>
|
|
2668
|
-
<td style="padding:15px">Update
|
|
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>
|
|
2594
|
+
<td style="padding:15px">Update A Layer 3 Static Route For A Switch</td>
|
|
2676
2595
|
<td style="padding:15px">{base_path}/{version}/devices/{pathv1}/switch/routing/staticRoutes/{pathv2}?{query}</td>
|
|
2677
2596
|
<td style="padding:15px">Yes</td>
|
|
2678
2597
|
</tr>
|
|
2679
2598
|
<tr>
|
|
2680
2599
|
<td style="padding:15px">deleteALayer3StaticRouteForASwitch(serial, staticRouteId, callback)</td>
|
|
2681
|
-
<td style="padding:15px">Delete
|
|
2682
|
-
#### Supports Action Batches
|
|
2683
|
-
|
|
2684
|
-
**Resource**|**Operation**
|
|
2685
|
-
:-------------: |:-------------:
|
|
2686
|
-
`/devices/{serial}/switch/routing/staticRoutes/{staticRouteId}` | destroy
|
|
2687
|
-
|
|
2688
|
-
</td>
|
|
2600
|
+
<td style="padding:15px">Delete A Layer 3 Static Route For A Switch</td>
|
|
2689
2601
|
<td style="padding:15px">{base_path}/{version}/devices/{pathv1}/switch/routing/staticRoutes/{pathv2}?{query}</td>
|
|
2690
2602
|
<td style="padding:15px">Yes</td>
|
|
2691
2603
|
</tr>
|
|
2692
2604
|
<tr>
|
|
2693
2605
|
<td style="padding:15px">listLayer3StaticRoutesForASwitchStack(networkId, switchStackId, callback)</td>
|
|
2694
|
-
<td style="padding:15px">List
|
|
2606
|
+
<td style="padding:15px">List Layer 3 Static Routes For A Switch Stack</td>
|
|
2695
2607
|
<td style="padding:15px">{base_path}/{version}/networks/{pathv1}/switch/stacks/{pathv2}/routing/staticRoutes?{query}</td>
|
|
2696
2608
|
<td style="padding:15px">Yes</td>
|
|
2697
2609
|
</tr>
|
|
2698
2610
|
<tr>
|
|
2699
2611
|
<td style="padding:15px">createALayer3StaticRouteForASwitchStack(networkId, switchStackId, body, callback)</td>
|
|
2700
|
-
<td style="padding:15px">Create
|
|
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>
|
|
2612
|
+
<td style="padding:15px">Create A Layer 3 Static Route For A Switch Stack</td>
|
|
2708
2613
|
<td style="padding:15px">{base_path}/{version}/networks/{pathv1}/switch/stacks/{pathv2}/routing/staticRoutes?{query}</td>
|
|
2709
2614
|
<td style="padding:15px">Yes</td>
|
|
2710
2615
|
</tr>
|
|
2711
2616
|
<tr>
|
|
2712
2617
|
<td style="padding:15px">returnALayer3StaticRouteForASwitchStack(networkId, switchStackId, staticRouteId, callback)</td>
|
|
2713
|
-
<td style="padding:15px">Return
|
|
2618
|
+
<td style="padding:15px">Return A Layer 3 Static Route For A Switch Stack</td>
|
|
2714
2619
|
<td style="padding:15px">{base_path}/{version}/networks/{pathv1}/switch/stacks/{pathv2}/routing/staticRoutes/{pathv3}?{query}</td>
|
|
2715
2620
|
<td style="padding:15px">Yes</td>
|
|
2716
2621
|
</tr>
|
|
2717
2622
|
<tr>
|
|
2718
2623
|
<td style="padding:15px">updateALayer3StaticRouteForASwitchStack(networkId, switchStackId, staticRouteId, body, callback)</td>
|
|
2719
|
-
<td style="padding:15px">Update
|
|
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>
|
|
2624
|
+
<td style="padding:15px">Update A Layer 3 Static Route For A Switch Stack</td>
|
|
2727
2625
|
<td style="padding:15px">{base_path}/{version}/networks/{pathv1}/switch/stacks/{pathv2}/routing/staticRoutes/{pathv3}?{query}</td>
|
|
2728
2626
|
<td style="padding:15px">Yes</td>
|
|
2729
2627
|
</tr>
|
|
2730
2628
|
<tr>
|
|
2731
2629
|
<td style="padding:15px">deleteALayer3StaticRouteForASwitchStack(networkId, switchStackId, staticRouteId, callback)</td>
|
|
2732
|
-
<td style="padding:15px">Delete
|
|
2733
|
-
#### Supports Action Batches
|
|
2734
|
-
|
|
2735
|
-
**Resource**|**Operation**
|
|
2736
|
-
:-------------: |:-------------:
|
|
2737
|
-
`/networks/{networkId}/switch/stacks/{switchStackId}/routing/staticRoutes/{staticRouteId}` | destroy
|
|
2738
|
-
|
|
2739
|
-
</td>
|
|
2630
|
+
<td style="padding:15px">Delete A Layer 3 Static Route For A Switch Stack</td>
|
|
2740
2631
|
<td style="padding:15px">{base_path}/{version}/networks/{pathv1}/switch/stacks/{pathv2}/routing/staticRoutes/{pathv3}?{query}</td>
|
|
2741
2632
|
<td style="padding:15px">Yes</td>
|
|
2742
2633
|
</tr>
|
|
2743
2634
|
<tr>
|
|
2744
2635
|
<td style="padding:15px">listAllCustomPerformanceClassesForAnMXNetwork(networkId, callback)</td>
|
|
2745
|
-
<td style="padding:15px">List
|
|
2636
|
+
<td style="padding:15px">List All Custom Performance Classes For An MX Network</td>
|
|
2746
2637
|
<td style="padding:15px">{base_path}/{version}/networks/{pathv1}/appliance/trafficShaping/customPerformanceClasses?{query}</td>
|
|
2747
2638
|
<td style="padding:15px">Yes</td>
|
|
2748
2639
|
</tr>
|
|
2749
2640
|
<tr>
|
|
2750
2641
|
<td style="padding:15px">addACustomPerformanceClassForAnMXNetwork(networkId, body, callback)</td>
|
|
2751
|
-
<td style="padding:15px">Add
|
|
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>
|
|
2642
|
+
<td style="padding:15px">Add A Custom Performance Class For An MX Network</td>
|
|
2765
2643
|
<td style="padding:15px">{base_path}/{version}/networks/{pathv1}/appliance/trafficShaping/customPerformanceClasses?{query}</td>
|
|
2766
2644
|
<td style="padding:15px">Yes</td>
|
|
2767
2645
|
</tr>
|
|
2768
2646
|
<tr>
|
|
2769
2647
|
<td style="padding:15px">returnACustomPerformanceClassForAnMXNetwork(networkId, customPerformanceClassId, callback)</td>
|
|
2770
|
-
<td style="padding:15px">Return
|
|
2648
|
+
<td style="padding:15px">Return A Custom Performance Class For An MX Network</td>
|
|
2771
2649
|
<td style="padding:15px">{base_path}/{version}/networks/{pathv1}/appliance/trafficShaping/customPerformanceClasses/{pathv2}?{query}</td>
|
|
2772
2650
|
<td style="padding:15px">Yes</td>
|
|
2773
2651
|
</tr>
|
|
2774
2652
|
<tr>
|
|
2775
2653
|
<td style="padding:15px">updateACustomPerformanceClassForAnMXNetwork(networkId, customPerformanceClassId, body, callback)</td>
|
|
2776
|
-
<td style="padding:15px">Update
|
|
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>
|
|
2654
|
+
<td style="padding:15px">Update A Custom Performance Class For An MX Network</td>
|
|
2790
2655
|
<td style="padding:15px">{base_path}/{version}/networks/{pathv1}/appliance/trafficShaping/customPerformanceClasses/{pathv2}?{query}</td>
|
|
2791
2656
|
<td style="padding:15px">Yes</td>
|
|
2792
2657
|
</tr>
|
|
2793
2658
|
<tr>
|
|
2794
2659
|
<td style="padding:15px">deleteACustomPerformanceClassFromAnMXNetwork(networkId, customPerformanceClassId, callback)</td>
|
|
2795
|
-
<td style="padding:15px">Delete
|
|
2796
|
-
#### Supports Action Batches
|
|
2797
|
-
|
|
2798
|
-
**Resource**|**Operation**
|
|
2799
|
-
:-------------: |:-------------:
|
|
2800
|
-
`/networks/{networkId}/appliance/trafficShaping/customPerformanceClasses/{customPerformanceClassId}` | destroy
|
|
2801
|
-
|
|
2802
|
-
</td>
|
|
2660
|
+
<td style="padding:15px">Delete A Custom Performance Class From An MX Network</td>
|
|
2803
2661
|
<td style="padding:15px">{base_path}/{version}/networks/{pathv1}/appliance/trafficShaping/customPerformanceClasses/{pathv2}?{query}</td>
|
|
2804
2662
|
<td style="padding:15px">Yes</td>
|
|
2805
2663
|
</tr>
|
|
2806
2664
|
<tr>
|
|
2807
2665
|
<td style="padding:15px">updateTheTrafficShapingSettingsRulesForAnMXNetwork(networkId, body, callback)</td>
|
|
2808
|
-
<td style="padding:15px">Update
|
|
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>
|
|
2666
|
+
<td style="padding:15px">Update The Traffic Shaping Settings Rules For An MX Network</td>
|
|
2814
2667
|
<td style="padding:15px">{base_path}/{version}/networks/{pathv1}/appliance/trafficShaping/rules?{query}</td>
|
|
2815
2668
|
<td style="padding:15px">Yes</td>
|
|
2816
2669
|
</tr>
|
|
2817
2670
|
<tr>
|
|
2818
2671
|
<td style="padding:15px">displayTheTrafficShapingSettingsRulesForAnMXNetwork(networkId, callback)</td>
|
|
2819
|
-
<td style="padding:15px">Display
|
|
2672
|
+
<td style="padding:15px">Display The Traffic Shaping Settings Rules For An MX Network</td>
|
|
2820
2673
|
<td style="padding:15px">{base_path}/{version}/networks/{pathv1}/appliance/trafficShaping/rules?{query}</td>
|
|
2821
2674
|
<td style="padding:15px">Yes</td>
|
|
2822
2675
|
</tr>
|
|
2823
2676
|
<tr>
|
|
2824
2677
|
<td style="padding:15px">showUplinkSelectionSettingsForAnMXNetwork(networkId, callback)</td>
|
|
2825
|
-
<td style="padding:15px">Show
|
|
2678
|
+
<td style="padding:15px">Show Uplink Selection Settings For An MX Network</td>
|
|
2826
2679
|
<td style="padding:15px">{base_path}/{version}/networks/{pathv1}/appliance/trafficShaping/uplinkSelection?{query}</td>
|
|
2827
2680
|
<td style="padding:15px">Yes</td>
|
|
2828
2681
|
</tr>
|
|
2829
2682
|
<tr>
|
|
2830
2683
|
<td style="padding:15px">updateUplinkSelectionSettingsForAnMXNetwork(networkId, body, callback)</td>
|
|
2831
|
-
<td style="padding:15px">Update
|
|
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>
|
|
2684
|
+
<td style="padding:15px">Update Uplink Selection Settings For An MX Network</td>
|
|
2840
2685
|
<td style="padding:15px">{base_path}/{version}/networks/{pathv1}/appliance/trafficShaping/uplinkSelection?{query}</td>
|
|
2841
2686
|
<td style="padding:15px">Yes</td>
|
|
2842
2687
|
</tr>
|
|
2843
2688
|
<tr>
|
|
2844
2689
|
<td style="padding:15px">returnAHubBGPConfiguration(networkId, callback)</td>
|
|
2845
|
-
<td style="padding:15px">Return
|
|
2690
|
+
<td style="padding:15px">Return A Hub BGP Configuration</td>
|
|
2846
2691
|
<td style="padding:15px">{base_path}/{version}/networks/{pathv1}/appliance/vpn/bgp?{query}</td>
|
|
2847
2692
|
<td style="padding:15px">Yes</td>
|
|
2848
2693
|
</tr>
|
|
2849
2694
|
<tr>
|
|
2850
2695
|
<td style="padding:15px">updateAHubBGPConfiguration(networkId, body, callback)</td>
|
|
2851
|
-
<td style="padding:15px">Update
|
|
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>
|
|
2696
|
+
<td style="padding:15px">Update A Hub BGP Configuration</td>
|
|
2857
2697
|
<td style="padding:15px">{base_path}/{version}/networks/{pathv1}/appliance/vpn/bgp?{query}</td>
|
|
2858
2698
|
<td style="padding:15px">Yes</td>
|
|
2859
2699
|
</tr>
|
|
2860
2700
|
<tr>
|
|
2861
2701
|
<td style="padding:15px">returnWarmSpareConfigurationForASwitch(serial, callback)</td>
|
|
2862
|
-
<td style="padding:15px">Return
|
|
2702
|
+
<td style="padding:15px">Return Warm Spare Configuration For A Switch</td>
|
|
2863
2703
|
<td style="padding:15px">{base_path}/{version}/devices/{pathv1}/switch/warmSpare?{query}</td>
|
|
2864
2704
|
<td style="padding:15px">Yes</td>
|
|
2865
2705
|
</tr>
|
|
2866
2706
|
<tr>
|
|
2867
2707
|
<td style="padding:15px">updateWarmSpareConfigurationForASwitch(serial, body, callback)</td>
|
|
2868
|
-
<td style="padding:15px">Update
|
|
2708
|
+
<td style="padding:15px">Update Warm Spare Configuration For A Switch</td>
|
|
2869
2709
|
<td style="padding:15px">{base_path}/{version}/devices/{pathv1}/switch/warmSpare?{query}</td>
|
|
2870
2710
|
<td style="padding:15px">Yes</td>
|
|
2871
2711
|
</tr>
|
|
@@ -2913,7 +2753,7 @@ asNumber| integer| An Autonomous System Number (ASN) is required if you are to r
|
|
|
2913
2753
|
</tr>
|
|
2914
2754
|
<tr>
|
|
2915
2755
|
<td style="padding:15px">createCustomAnalyticsArtifact(organizationId, body, callback)</td>
|
|
2916
|
-
<td style="padding:15px">Create
|
|
2756
|
+
<td style="padding:15px">Create Custom Analytics Artifact</td>
|
|
2917
2757
|
<td style="padding:15px">{base_path}/{version}/organizations/{pathv1}/camera/customAnalytics/artifacts?{query}</td>
|
|
2918
2758
|
<td style="padding:15px">Yes</td>
|
|
2919
2759
|
</tr>
|
|
@@ -2931,27 +2771,13 @@ asNumber| integer| An Autonomous System Number (ASN) is required if you are to r
|
|
|
2931
2771
|
</tr>
|
|
2932
2772
|
<tr>
|
|
2933
2773
|
<td style="padding:15px">returnCustomAnalyticsSettingsForACamera(serial, callback)</td>
|
|
2934
|
-
<td style="padding:15px">Return
|
|
2774
|
+
<td style="padding:15px">Return Custom Analytics Settings For A Camera</td>
|
|
2935
2775
|
<td style="padding:15px">{base_path}/{version}/devices/{pathv1}/camera/customAnalytics?{query}</td>
|
|
2936
2776
|
<td style="padding:15px">Yes</td>
|
|
2937
2777
|
</tr>
|
|
2938
2778
|
<tr>
|
|
2939
2779
|
<td style="padding:15px">updateCustomAnalyticsSettingsForACamera(serial, body, callback)</td>
|
|
2940
|
-
<td style="padding:15px">Update
|
|
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>
|
|
2780
|
+
<td style="padding:15px">Update Custom Analytics Settings For A Camera</td>
|
|
2955
2781
|
<td style="padding:15px">{base_path}/{version}/devices/{pathv1}/camera/customAnalytics?{query}</td>
|
|
2956
2782
|
<td style="padding:15px">Yes</td>
|
|
2957
2783
|
</tr>
|
|
@@ -2963,130 +2789,91 @@ parameters| array| Parameters for the custom analytics workload
|
|
|
2963
2789
|
</tr>
|
|
2964
2790
|
<tr>
|
|
2965
2791
|
<td style="padding:15px">returnsSenseSettingsForAGivenCamera(serial, callback)</td>
|
|
2966
|
-
<td style="padding:15px">Returns
|
|
2792
|
+
<td style="padding:15px">Returns Sense Settings For A Given Camera</td>
|
|
2967
2793
|
<td style="padding:15px">{base_path}/{version}/devices/{pathv1}/camera/sense?{query}</td>
|
|
2968
2794
|
<td style="padding:15px">Yes</td>
|
|
2969
2795
|
</tr>
|
|
2970
2796
|
<tr>
|
|
2971
2797
|
<td style="padding:15px">updateSenseSettingsForTheGivenCamera(serial, body, callback)</td>
|
|
2972
|
-
<td style="padding:15px">Update
|
|
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>
|
|
2798
|
+
<td style="padding:15px">Update Sense Settings For The Given Camera</td>
|
|
2980
2799
|
<td style="padding:15px">{base_path}/{version}/devices/{pathv1}/camera/sense?{query}</td>
|
|
2981
2800
|
<td style="padding:15px">Yes</td>
|
|
2982
2801
|
</tr>
|
|
2983
2802
|
<tr>
|
|
2984
2803
|
<td style="padding:15px">returnsWirelessProfileAssignedToTheGivenCamera(serial, callback)</td>
|
|
2985
|
-
<td style="padding:15px">Returns
|
|
2804
|
+
<td style="padding:15px">Returns Wireless Profile Assigned To The Given Camera</td>
|
|
2986
2805
|
<td style="padding:15px">{base_path}/{version}/devices/{pathv1}/camera/wirelessProfiles?{query}</td>
|
|
2987
2806
|
<td style="padding:15px">Yes</td>
|
|
2988
2807
|
</tr>
|
|
2989
2808
|
<tr>
|
|
2990
2809
|
<td style="padding:15px">assignWirelessProfilesToTheGivenCamera(serial, body, callback)</td>
|
|
2991
|
-
<td style="padding:15px">Assign
|
|
2810
|
+
<td style="padding:15px">Assign Wireless Profiles To The Given Camera</td>
|
|
2992
2811
|
<td style="padding:15px">{base_path}/{version}/devices/{pathv1}/camera/wirelessProfiles?{query}</td>
|
|
2993
2812
|
<td style="padding:15px">Yes</td>
|
|
2994
2813
|
</tr>
|
|
2995
2814
|
<tr>
|
|
2996
2815
|
<td style="padding:15px">createsANewCameraWirelessProfileForThisNetwork(networkId, body, callback)</td>
|
|
2997
|
-
<td style="padding:15px">Creates
|
|
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>
|
|
2816
|
+
<td style="padding:15px">Creates A New Camera Wireless Profile For This Network</td>
|
|
3005
2817
|
<td style="padding:15px">{base_path}/{version}/networks/{pathv1}/camera/wirelessProfiles?{query}</td>
|
|
3006
2818
|
<td style="padding:15px">Yes</td>
|
|
3007
2819
|
</tr>
|
|
3008
2820
|
<tr>
|
|
3009
2821
|
<td style="padding:15px">listTheCameraWirelessProfilesForThisNetwork(networkId, callback)</td>
|
|
3010
|
-
<td style="padding:15px">List
|
|
2822
|
+
<td style="padding:15px">List The Camera Wireless Profiles For This Network</td>
|
|
3011
2823
|
<td style="padding:15px">{base_path}/{version}/networks/{pathv1}/camera/wirelessProfiles?{query}</td>
|
|
3012
2824
|
<td style="padding:15px">Yes</td>
|
|
3013
2825
|
</tr>
|
|
3014
2826
|
<tr>
|
|
3015
2827
|
<td style="padding:15px">retrieveASingleCameraWirelessProfile(networkId, wirelessProfileId, callback)</td>
|
|
3016
|
-
<td style="padding:15px">Retrieve
|
|
2828
|
+
<td style="padding:15px">Retrieve A Single Camera Wireless Profile</td>
|
|
3017
2829
|
<td style="padding:15px">{base_path}/{version}/networks/{pathv1}/camera/wirelessProfiles/{pathv2}?{query}</td>
|
|
3018
2830
|
<td style="padding:15px">Yes</td>
|
|
3019
2831
|
</tr>
|
|
3020
2832
|
<tr>
|
|
3021
2833
|
<td style="padding:15px">updateAnExistingCameraWirelessProfileInThisNetwork(networkId, wirelessProfileId, body, callback)</td>
|
|
3022
|
-
<td style="padding:15px">Update
|
|
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>
|
|
2834
|
+
<td style="padding:15px">Update An Existing Camera Wireless Profile In This Network</td>
|
|
3030
2835
|
<td style="padding:15px">{base_path}/{version}/networks/{pathv1}/camera/wirelessProfiles/{pathv2}?{query}</td>
|
|
3031
2836
|
<td style="padding:15px">Yes</td>
|
|
3032
2837
|
</tr>
|
|
3033
2838
|
<tr>
|
|
3034
2839
|
<td style="padding:15px">deleteAnExistingCameraWirelessProfileForThisNetwork(networkId, wirelessProfileId, callback)</td>
|
|
3035
|
-
<td style="padding:15px">Delete
|
|
2840
|
+
<td style="padding:15px">Delete An Existing Camera Wireless Profile For This Network</td>
|
|
3036
2841
|
<td style="padding:15px">{base_path}/{version}/networks/{pathv1}/camera/wirelessProfiles/{pathv2}?{query}</td>
|
|
3037
2842
|
<td style="padding:15px">Yes</td>
|
|
3038
2843
|
</tr>
|
|
3039
2844
|
<tr>
|
|
3040
2845
|
<td style="padding:15px">listTheOutageScheduleForTheSSID(networkId, number, callback)</td>
|
|
3041
|
-
<td style="padding:15px">List
|
|
2846
|
+
<td style="padding:15px">List The Outage Schedule For The SSID</td>
|
|
3042
2847
|
<td style="padding:15px">{base_path}/{version}/networks/{pathv1}/wireless/ssids/{pathv2}/schedules?{query}</td>
|
|
3043
2848
|
<td style="padding:15px">Yes</td>
|
|
3044
2849
|
</tr>
|
|
3045
2850
|
<tr>
|
|
3046
2851
|
<td style="padding:15px">updateTheOutageScheduleForTheSSID(networkId, number, body, callback)</td>
|
|
3047
|
-
<td style="padding:15px">Update
|
|
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>
|
|
2852
|
+
<td style="padding:15px">Update The Outage Schedule For The SSID</td>
|
|
3054
2853
|
<td style="padding:15px">{base_path}/{version}/networks/{pathv1}/wireless/ssids/{pathv2}/schedules?{query}</td>
|
|
3055
2854
|
<td style="padding:15px">Yes</td>
|
|
3056
2855
|
</tr>
|
|
3057
2856
|
<tr>
|
|
3058
2857
|
<td style="padding:15px">returnALayer3InterfaceDHCPConfigurationForASwitch(serial, interfaceId, callback)</td>
|
|
3059
|
-
<td style="padding:15px">Return
|
|
2858
|
+
<td style="padding:15px">Return A Layer 3 Interface DHCP Configuration For A Switch</td>
|
|
3060
2859
|
<td style="padding:15px">{base_path}/{version}/devices/{pathv1}/switch/routing/interfaces/{pathv2}/dhcp?{query}</td>
|
|
3061
2860
|
<td style="padding:15px">Yes</td>
|
|
3062
2861
|
</tr>
|
|
3063
2862
|
<tr>
|
|
3064
2863
|
<td style="padding:15px">updateALayer3InterfaceDHCPConfigurationForASwitch(serial, interfaceId, body, callback)</td>
|
|
3065
|
-
<td style="padding:15px">Update
|
|
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>
|
|
2864
|
+
<td style="padding:15px">Update A Layer 3 Interface DHCP Configuration For A Switch</td>
|
|
3072
2865
|
<td style="padding:15px">{base_path}/{version}/devices/{pathv1}/switch/routing/interfaces/{pathv2}/dhcp?{query}</td>
|
|
3073
2866
|
<td style="padding:15px">Yes</td>
|
|
3074
2867
|
</tr>
|
|
3075
2868
|
<tr>
|
|
3076
2869
|
<td style="padding:15px">returnALayer3InterfaceDHCPConfigurationForASwitchStack(networkId, switchStackId, interfaceId, callback)</td>
|
|
3077
|
-
<td style="padding:15px">Return
|
|
2870
|
+
<td style="padding:15px">Return A Layer 3 Interface DHCP Configuration For A Switch Stack</td>
|
|
3078
2871
|
<td style="padding:15px">{base_path}/{version}/networks/{pathv1}/switch/stacks/{pathv2}/routing/interfaces/{pathv3}/dhcp?{query}</td>
|
|
3079
2872
|
<td style="padding:15px">Yes</td>
|
|
3080
2873
|
</tr>
|
|
3081
2874
|
<tr>
|
|
3082
2875
|
<td style="padding:15px">updateALayer3InterfaceDHCPConfigurationForASwitchStack(networkId, switchStackId, interfaceId, body, callback)</td>
|
|
3083
|
-
<td style="padding:15px">Update
|
|
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>
|
|
2876
|
+
<td style="padding:15px">Update A Layer 3 Interface DHCP Configuration For A Switch Stack</td>
|
|
3090
2877
|
<td style="padding:15px">{base_path}/{version}/networks/{pathv1}/switch/stacks/{pathv2}/routing/interfaces/{pathv3}/dhcp?{query}</td>
|
|
3091
2878
|
<td style="padding:15px">Yes</td>
|
|
3092
2879
|
</tr>
|
|
@@ -3104,51 +2891,25 @@ dhcpLeaseTime| string| The DHCP lease time config for the dhcp server running o.
|
|
|
3104
2891
|
</tr>
|
|
3105
2892
|
<tr>
|
|
3106
2893
|
<td style="padding:15px">createAnOrganizationWideAlertConfiguration(organizationId, body, callback)</td>
|
|
3107
|
-
<td style="padding:15px">Create
|
|
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>
|
|
2894
|
+
<td style="padding:15px">Create An Organization Wide Alert Configuration</td>
|
|
3118
2895
|
<td style="padding:15px">{base_path}/{version}/organizations/{pathv1}/alerts/profiles?{query}</td>
|
|
3119
2896
|
<td style="padding:15px">Yes</td>
|
|
3120
2897
|
</tr>
|
|
3121
2898
|
<tr>
|
|
3122
2899
|
<td style="padding:15px">listAllOrganizationWideAlertConfigurations(organizationId, callback)</td>
|
|
3123
|
-
<td style="padding:15px">List
|
|
2900
|
+
<td style="padding:15px">List All Organization Wide Alert Configurations</td>
|
|
3124
2901
|
<td style="padding:15px">{base_path}/{version}/organizations/{pathv1}/alerts/profiles?{query}</td>
|
|
3125
2902
|
<td style="padding:15px">Yes</td>
|
|
3126
2903
|
</tr>
|
|
3127
2904
|
<tr>
|
|
3128
2905
|
<td style="padding:15px">removesAnOrganizationWideAlertConfig(organizationId, alertConfigId, callback)</td>
|
|
3129
|
-
<td style="padding:15px">Removes
|
|
3130
|
-
#### Supports Action Batches
|
|
3131
|
-
|
|
3132
|
-
**Resource**|**Operation**
|
|
3133
|
-
:-------------: |:-------------:
|
|
3134
|
-
`/organizations/{organizationId}/alerts/profiles/{alertConfigId}` | destroy
|
|
3135
|
-
|
|
3136
|
-
</td>
|
|
2906
|
+
<td style="padding:15px">Removes An Organization Wide Alert Config</td>
|
|
3137
2907
|
<td style="padding:15px">{base_path}/{version}/organizations/{pathv1}/alerts/profiles/{pathv2}?{query}</td>
|
|
3138
2908
|
<td style="padding:15px">Yes</td>
|
|
3139
2909
|
</tr>
|
|
3140
2910
|
<tr>
|
|
3141
2911
|
<td style="padding:15px">updateAnOrganizationWideAlertConfig(organizationId, alertConfigId, body, callback)</td>
|
|
3142
|
-
<td style="padding:15px">Update
|
|
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>
|
|
2912
|
+
<td style="padding:15px">Update An Organization Wide Alert Config</td>
|
|
3152
2913
|
<td style="padding:15px">{base_path}/{version}/organizations/{pathv1}/alerts/profiles/{pathv2}?{query}</td>
|
|
3153
2914
|
<td style="padding:15px">Yes</td>
|
|
3154
2915
|
</tr>
|
|
@@ -3160,243 +2921,139 @@ description| string| User supplied description o...(description truncated)</td>
|
|
|
3160
2921
|
</tr>
|
|
3161
2922
|
<tr>
|
|
3162
2923
|
<td style="padding:15px">listLayer3InterfacesForASwitch(serial, callback)</td>
|
|
3163
|
-
<td style="padding:15px">List
|
|
2924
|
+
<td style="padding:15px">List Layer 3 Interfaces For A Switch</td>
|
|
3164
2925
|
<td style="padding:15px">{base_path}/{version}/devices/{pathv1}/switch/routing/interfaces?{query}</td>
|
|
3165
2926
|
<td style="padding:15px">Yes</td>
|
|
3166
2927
|
</tr>
|
|
3167
2928
|
<tr>
|
|
3168
2929
|
<td style="padding:15px">createALayer3InterfaceForASwitch(serial, body, callback)</td>
|
|
3169
|
-
<td style="padding:15px">Create
|
|
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>
|
|
2930
|
+
<td style="padding:15px">Create A Layer 3 Interface For A Switch</td>
|
|
3177
2931
|
<td style="padding:15px">{base_path}/{version}/devices/{pathv1}/switch/routing/interfaces?{query}</td>
|
|
3178
2932
|
<td style="padding:15px">Yes</td>
|
|
3179
2933
|
</tr>
|
|
3180
2934
|
<tr>
|
|
3181
2935
|
<td style="padding:15px">returnALayer3InterfaceForASwitch(serial, interfaceId, callback)</td>
|
|
3182
|
-
<td style="padding:15px">Return
|
|
2936
|
+
<td style="padding:15px">Return A Layer 3 Interface For A Switch</td>
|
|
3183
2937
|
<td style="padding:15px">{base_path}/{version}/devices/{pathv1}/switch/routing/interfaces/{pathv2}?{query}</td>
|
|
3184
2938
|
<td style="padding:15px">Yes</td>
|
|
3185
2939
|
</tr>
|
|
3186
2940
|
<tr>
|
|
3187
2941
|
<td style="padding:15px">updateALayer3InterfaceForASwitch(serial, interfaceId, body, callback)</td>
|
|
3188
|
-
<td style="padding:15px">Update
|
|
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>
|
|
2942
|
+
<td style="padding:15px">Update A Layer 3 Interface For A Switch</td>
|
|
3196
2943
|
<td style="padding:15px">{base_path}/{version}/devices/{pathv1}/switch/routing/interfaces/{pathv2}?{query}</td>
|
|
3197
2944
|
<td style="padding:15px">Yes</td>
|
|
3198
2945
|
</tr>
|
|
3199
2946
|
<tr>
|
|
3200
2947
|
<td style="padding:15px">deleteALayer3InterfaceFromTheSwitch(serial, interfaceId, callback)</td>
|
|
3201
|
-
<td style="padding:15px">Delete
|
|
3202
|
-
#### Supports Action Batches
|
|
3203
|
-
|
|
3204
|
-
**Resource**|**Operation**
|
|
3205
|
-
:-------------: |:-------------:
|
|
3206
|
-
`/devices/{serial}/switch/routing/interfaces/{interfaceId}` | destroy
|
|
3207
|
-
|
|
3208
|
-
</td>
|
|
2948
|
+
<td style="padding:15px">Delete A Layer 3 Interface From The Switch</td>
|
|
3209
2949
|
<td style="padding:15px">{base_path}/{version}/devices/{pathv1}/switch/routing/interfaces/{pathv2}?{query}</td>
|
|
3210
2950
|
<td style="padding:15px">Yes</td>
|
|
3211
2951
|
</tr>
|
|
3212
2952
|
<tr>
|
|
3213
2953
|
<td style="padding:15px">listLayer3InterfacesForASwitchStack(networkId, switchStackId, callback)</td>
|
|
3214
|
-
<td style="padding:15px">List
|
|
2954
|
+
<td style="padding:15px">List Layer 3 Interfaces For A Switch Stack</td>
|
|
3215
2955
|
<td style="padding:15px">{base_path}/{version}/networks/{pathv1}/switch/stacks/{pathv2}/routing/interfaces?{query}</td>
|
|
3216
2956
|
<td style="padding:15px">Yes</td>
|
|
3217
2957
|
</tr>
|
|
3218
2958
|
<tr>
|
|
3219
2959
|
<td style="padding:15px">createALayer3InterfaceForASwitchStack(networkId, switchStackId, body, callback)</td>
|
|
3220
|
-
<td style="padding:15px">Create
|
|
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>
|
|
2960
|
+
<td style="padding:15px">Create A Layer 3 Interface For A Switch Stack</td>
|
|
3228
2961
|
<td style="padding:15px">{base_path}/{version}/networks/{pathv1}/switch/stacks/{pathv2}/routing/interfaces?{query}</td>
|
|
3229
2962
|
<td style="padding:15px">Yes</td>
|
|
3230
2963
|
</tr>
|
|
3231
2964
|
<tr>
|
|
3232
2965
|
<td style="padding:15px">returnALayer3InterfaceFromASwitchStack(networkId, switchStackId, interfaceId, callback)</td>
|
|
3233
|
-
<td style="padding:15px">Return
|
|
2966
|
+
<td style="padding:15px">Return A Layer 3 Interface From A Switch Stack</td>
|
|
3234
2967
|
<td style="padding:15px">{base_path}/{version}/networks/{pathv1}/switch/stacks/{pathv2}/routing/interfaces/{pathv3}?{query}</td>
|
|
3235
2968
|
<td style="padding:15px">Yes</td>
|
|
3236
2969
|
</tr>
|
|
3237
2970
|
<tr>
|
|
3238
2971
|
<td style="padding:15px">updateALayer3InterfaceForASwitchStack(networkId, switchStackId, interfaceId, body, callback)</td>
|
|
3239
|
-
<td style="padding:15px">Update
|
|
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>
|
|
2972
|
+
<td style="padding:15px">Update A Layer 3 Interface For A Switch Stack</td>
|
|
3247
2973
|
<td style="padding:15px">{base_path}/{version}/networks/{pathv1}/switch/stacks/{pathv2}/routing/interfaces/{pathv3}?{query}</td>
|
|
3248
2974
|
<td style="padding:15px">Yes</td>
|
|
3249
2975
|
</tr>
|
|
3250
2976
|
<tr>
|
|
3251
2977
|
<td style="padding:15px">deleteALayer3InterfaceFromASwitchStack(networkId, switchStackId, interfaceId, callback)</td>
|
|
3252
|
-
<td style="padding:15px">Delete
|
|
3253
|
-
#### Supports Action Batches
|
|
3254
|
-
|
|
3255
|
-
**Resource**|**Operation**
|
|
3256
|
-
:-------------: |:-------------:
|
|
3257
|
-
`/networks/{networkId}/switch/stacks/{switchStackId}/routing/interfaces/{interfaceId}` | destroy
|
|
3258
|
-
|
|
3259
|
-
</td>
|
|
2978
|
+
<td style="padding:15px">Delete A Layer 3 Interface From A Switch Stack</td>
|
|
3260
2979
|
<td style="padding:15px">{base_path}/{version}/networks/{pathv1}/switch/stacks/{pathv2}/routing/interfaces/{pathv3}?{query}</td>
|
|
3261
2980
|
<td style="padding:15px">Yes</td>
|
|
3262
2981
|
</tr>
|
|
3263
2982
|
<tr>
|
|
3264
2983
|
<td style="padding:15px">listMulticastRendezvousPoints(networkId, callback)</td>
|
|
3265
|
-
<td style="padding:15px">List
|
|
2984
|
+
<td style="padding:15px">List Multicast Rendezvous Points</td>
|
|
3266
2985
|
<td style="padding:15px">{base_path}/{version}/networks/{pathv1}/switch/routing/multicast/rendezvousPoints?{query}</td>
|
|
3267
2986
|
<td style="padding:15px">Yes</td>
|
|
3268
2987
|
</tr>
|
|
3269
2988
|
<tr>
|
|
3270
2989
|
<td style="padding:15px">createAMulticastRendezvousPoint(networkId, body, callback)</td>
|
|
3271
|
-
<td style="padding:15px">Create
|
|
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>
|
|
2990
|
+
<td style="padding:15px">Create A Multicast Rendezvous Point</td>
|
|
3285
2991
|
<td style="padding:15px">{base_path}/{version}/networks/{pathv1}/switch/routing/multicast/rendezvousPoints?{query}</td>
|
|
3286
2992
|
<td style="padding:15px">Yes</td>
|
|
3287
2993
|
</tr>
|
|
3288
2994
|
<tr>
|
|
3289
2995
|
<td style="padding:15px">returnAMulticastRendezvousPoint(networkId, rendezvousPointId, callback)</td>
|
|
3290
|
-
<td style="padding:15px">Return
|
|
2996
|
+
<td style="padding:15px">Return A Multicast Rendezvous Point</td>
|
|
3291
2997
|
<td style="padding:15px">{base_path}/{version}/networks/{pathv1}/switch/routing/multicast/rendezvousPoints/{pathv2}?{query}</td>
|
|
3292
2998
|
<td style="padding:15px">Yes</td>
|
|
3293
2999
|
</tr>
|
|
3294
3000
|
<tr>
|
|
3295
3001
|
<td style="padding:15px">deleteAMulticastRendezvousPoint(networkId, rendezvousPointId, callback)</td>
|
|
3296
|
-
<td style="padding:15px">Delete
|
|
3297
|
-
#### Supports Action Batches
|
|
3298
|
-
|
|
3299
|
-
**Resource**|**Operation**
|
|
3300
|
-
:-------------: |:-------------:
|
|
3301
|
-
`/networks/{networkId}/switch/routing/multicast/rendezvousPoints/{rendezvousPointId}` | destroy
|
|
3302
|
-
|
|
3303
|
-
</td>
|
|
3002
|
+
<td style="padding:15px">Delete A Multicast Rendezvous Point</td>
|
|
3304
3003
|
<td style="padding:15px">{base_path}/{version}/networks/{pathv1}/switch/routing/multicast/rendezvousPoints/{pathv2}?{query}</td>
|
|
3305
3004
|
<td style="padding:15px">Yes</td>
|
|
3306
3005
|
</tr>
|
|
3307
3006
|
<tr>
|
|
3308
3007
|
<td style="padding:15px">updateAMulticastRendezvousPoint(networkId, rendezvousPointId, body, callback)</td>
|
|
3309
|
-
<td style="padding:15px">Update
|
|
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>
|
|
3008
|
+
<td style="padding:15px">Update A Multicast Rendezvous Point</td>
|
|
3323
3009
|
<td style="padding:15px">{base_path}/{version}/networks/{pathv1}/switch/routing/multicast/rendezvousPoints/{pathv2}?{query}</td>
|
|
3324
3010
|
<td style="padding:15px">Yes</td>
|
|
3325
3011
|
</tr>
|
|
3326
3012
|
<tr>
|
|
3327
3013
|
<td style="padding:15px">returnMulticastSettingsForANetwork(networkId, callback)</td>
|
|
3328
|
-
<td style="padding:15px">Return
|
|
3014
|
+
<td style="padding:15px">Return Multicast Settings For A Network</td>
|
|
3329
3015
|
<td style="padding:15px">{base_path}/{version}/networks/{pathv1}/switch/routing/multicast?{query}</td>
|
|
3330
3016
|
<td style="padding:15px">Yes</td>
|
|
3331
3017
|
</tr>
|
|
3332
3018
|
<tr>
|
|
3333
3019
|
<td style="padding:15px">updateMulticastSettingsForANetwork(networkId, body, callback)</td>
|
|
3334
|
-
<td style="padding:15px">Update
|
|
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>
|
|
3020
|
+
<td style="padding:15px">Update Multicast Settings For A Network</td>
|
|
3344
3021
|
<td style="padding:15px">{base_path}/{version}/networks/{pathv1}/switch/routing/multicast?{query}</td>
|
|
3345
3022
|
<td style="padding:15px">Yes</td>
|
|
3346
3023
|
</tr>
|
|
3347
3024
|
<tr>
|
|
3348
3025
|
<td style="padding:15px">returnLayer3OSPFRoutingConfiguration(networkId, callback)</td>
|
|
3349
|
-
<td style="padding:15px">Return
|
|
3026
|
+
<td style="padding:15px">Return Layer 3 OSPF Routing Configuration</td>
|
|
3350
3027
|
<td style="padding:15px">{base_path}/{version}/networks/{pathv1}/switch/routing/ospf?{query}</td>
|
|
3351
3028
|
<td style="padding:15px">Yes</td>
|
|
3352
3029
|
</tr>
|
|
3353
3030
|
<tr>
|
|
3354
3031
|
<td style="padding:15px">updateLayer3OSPFRoutingConfiguration(networkId, body, callback)</td>
|
|
3355
|
-
<td style="padding:15px">Update
|
|
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>
|
|
3032
|
+
<td style="padding:15px">Update Layer 3 OSPF Routing Configuration</td>
|
|
3362
3033
|
<td style="padding:15px">{base_path}/{version}/networks/{pathv1}/switch/routing/ospf?{query}</td>
|
|
3363
3034
|
<td style="padding:15px">Yes</td>
|
|
3364
3035
|
</tr>
|
|
3365
3036
|
<tr>
|
|
3366
3037
|
<td style="padding:15px">returnTheSwitchAlternateManagementInterfaceForTheNetwork(networkId, callback)</td>
|
|
3367
|
-
<td style="padding:15px">Return
|
|
3038
|
+
<td style="padding:15px">Return The Switch Alternate Management Interface For The Network</td>
|
|
3368
3039
|
<td style="padding:15px">{base_path}/{version}/networks/{pathv1}/switch/alternateManagementInterface?{query}</td>
|
|
3369
3040
|
<td style="padding:15px">Yes</td>
|
|
3370
3041
|
</tr>
|
|
3371
3042
|
<tr>
|
|
3372
3043
|
<td style="padding:15px">updateTheSwitchAlternateManagementInterfaceForTheNetwork(networkId, body, callback)</td>
|
|
3373
|
-
<td style="padding:15px">Update
|
|
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>
|
|
3044
|
+
<td style="padding:15px">Update The Switch Alternate Management Interface For The Network</td>
|
|
3381
3045
|
<td style="padding:15px">{base_path}/{version}/networks/{pathv1}/switch/alternateManagementInterface?{query}</td>
|
|
3382
3046
|
<td style="padding:15px">Yes</td>
|
|
3383
3047
|
</tr>
|
|
3384
3048
|
<tr>
|
|
3385
3049
|
<td style="padding:15px">returnAlternateManagementInterfaceAndDevicesWithIPAssigned(networkId, callback)</td>
|
|
3386
|
-
<td style="padding:15px">Return
|
|
3050
|
+
<td style="padding:15px">Return Alternate Management Interface And Devices With IP Assigned</td>
|
|
3387
3051
|
<td style="padding:15px">{base_path}/{version}/networks/{pathv1}/wireless/alternateManagementInterface?{query}</td>
|
|
3388
3052
|
<td style="padding:15px">Yes</td>
|
|
3389
3053
|
</tr>
|
|
3390
3054
|
<tr>
|
|
3391
3055
|
<td style="padding:15px">updateAlternateManagementInterfaceAndDeviceStaticIP(networkId, body, callback)</td>
|
|
3392
|
-
<td style="padding:15px">Update
|
|
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>
|
|
3056
|
+
<td style="padding:15px">Update Alternate Management Interface And Device Static IP</td>
|
|
3400
3057
|
<td style="padding:15px">{base_path}/{version}/networks/{pathv1}/wireless/alternateManagementInterface?{query}</td>
|
|
3401
3058
|
<td style="padding:15px">Yes</td>
|
|
3402
3059
|
</tr>
|
|
@@ -3408,56 +3065,25 @@ accessPoints| array| Array of access point serial number and I...(description tr
|
|
|
3408
3065
|
</tr>
|
|
3409
3066
|
<tr>
|
|
3410
3067
|
<td style="padding:15px">returnTheListOfServersTrustedByDynamicARPInspectionOnThisNetwork(networkId, callback)</td>
|
|
3411
|
-
<td style="padding:15px">Return
|
|
3068
|
+
<td style="padding:15px">Return The List Of Servers Trusted By Dynamic ARP Inspection On This Network</td>
|
|
3412
3069
|
<td style="padding:15px">{base_path}/{version}/networks/{pathv1}/switch/dhcpServerPolicy/arpInspection/trustedServers?{query}</td>
|
|
3413
3070
|
<td style="padding:15px">Yes</td>
|
|
3414
3071
|
</tr>
|
|
3415
3072
|
<tr>
|
|
3416
3073
|
<td style="padding:15px">addAServerToBeTrustedByDynamicARPInspectionOnThisNetwork(networkId, body, callback)</td>
|
|
3417
|
-
<td style="padding:15px">Add
|
|
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>
|
|
3074
|
+
<td style="padding:15px">Add A Server To Be Trusted By Dynamic ARP Inspection On This Network</td>
|
|
3430
3075
|
<td style="padding:15px">{base_path}/{version}/networks/{pathv1}/switch/dhcpServerPolicy/arpInspection/trustedServers?{query}</td>
|
|
3431
3076
|
<td style="padding:15px">Yes</td>
|
|
3432
3077
|
</tr>
|
|
3433
3078
|
<tr>
|
|
3434
3079
|
<td style="padding:15px">updateAServerThatIsTrustedByDynamicARPInspectionOnThisNetwork(networkId, trustedServerId, body, callback)</td>
|
|
3435
|
-
<td style="padding:15px">Update
|
|
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>
|
|
3080
|
+
<td style="padding:15px">Update A Server That Is Trusted By Dynamic ARP Inspection On This Network</td>
|
|
3448
3081
|
<td style="padding:15px">{base_path}/{version}/networks/{pathv1}/switch/dhcpServerPolicy/arpInspection/trustedServers/{pathv2}?{query}</td>
|
|
3449
3082
|
<td style="padding:15px">Yes</td>
|
|
3450
3083
|
</tr>
|
|
3451
3084
|
<tr>
|
|
3452
3085
|
<td style="padding:15px">removeAServerFromBeingTrustedByDynamicARPInspectionOnThisNetwork(networkId, trustedServerId, callback)</td>
|
|
3453
|
-
<td style="padding:15px">Remove
|
|
3454
|
-
#### Supports Action Batches
|
|
3455
|
-
|
|
3456
|
-
**Resource**|**Operation**
|
|
3457
|
-
:-------------: |:-------------:
|
|
3458
|
-
`/networks/{networkId}/switch/dhcpServerPolicy/arpInspection/trustedServers/{trustedServerId}` | destroy
|
|
3459
|
-
|
|
3460
|
-
</td>
|
|
3086
|
+
<td style="padding:15px">Remove A Server From Being Trusted By Dynamic ARP Inspection On This Network</td>
|
|
3461
3087
|
<td style="padding:15px">{base_path}/{version}/networks/{pathv1}/switch/dhcpServerPolicy/arpInspection/trustedServers/{pathv2}?{query}</td>
|
|
3462
3088
|
<td style="padding:15px">Yes</td>
|
|
3463
3089
|
</tr>
|
|
@@ -3469,7 +3095,7 @@ ipv4| object| The updated IPv4 attributes of the trusted server
|
|
|
3469
3095
|
</tr>
|
|
3470
3096
|
<tr>
|
|
3471
3097
|
<td style="padding:15px">listthepowerstatusinformationfordevicesinanorganization(organizationId, callback)</td>
|
|
3472
|
-
<td style="padding:15px">List the power status information for devices in an organization
|
|
3098
|
+
<td style="padding:15px">List the power status information for devices in an organization</td>
|
|
3473
3099
|
<td style="padding:15px">{base_path}/{version}/organizations/{pathv1}/devices/powerModules/statuses/byDevice?{query}</td>
|
|
3474
3100
|
<td style="padding:15px">Yes</td>
|
|
3475
3101
|
</tr>
|
|
@@ -3481,149 +3107,79 @@ ipv4| object| The updated IPv4 attributes of the trusted server
|
|
|
3481
3107
|
</tr>
|
|
3482
3108
|
<tr>
|
|
3483
3109
|
<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
|
|
3110
|
+
<td style="padding:15px">Clone port-level and some switch-level configuration settings from a source switch to one or more t</td>
|
|
3485
3111
|
<td style="padding:15px">{base_path}/{version}/organizations/{pathv1}/switch/devices/clone?{query}</td>
|
|
3486
3112
|
<td style="padding:15px">Yes</td>
|
|
3487
3113
|
</tr>
|
|
3488
3114
|
<tr>
|
|
3489
3115
|
<td style="padding:15px">returnASingleDeviceFromTheInventoryOfAnOrganization(organizationId, serial, callback)</td>
|
|
3490
|
-
<td style="padding:15px">Return
|
|
3116
|
+
<td style="padding:15px">Return A Single Device From The Inventory Of An Organization</td>
|
|
3491
3117
|
<td style="padding:15px">{base_path}/{version}/organizations/{pathv1}/inventory/devices/{pathv2}?{query}</td>
|
|
3492
3118
|
<td style="padding:15px">Yes</td>
|
|
3493
3119
|
</tr>
|
|
3494
3120
|
<tr>
|
|
3495
3121
|
<td style="padding:15px">returnTheBillingSettingsOfThisNetwork(networkId, callback)</td>
|
|
3496
|
-
<td style="padding:15px">Return
|
|
3122
|
+
<td style="padding:15px">Return The Billing Settings Of This Network</td>
|
|
3497
3123
|
<td style="padding:15px">{base_path}/{version}/networks/{pathv1}/wireless/billing?{query}</td>
|
|
3498
3124
|
<td style="padding:15px">Yes</td>
|
|
3499
3125
|
</tr>
|
|
3500
3126
|
<tr>
|
|
3501
3127
|
<td style="padding:15px">updateTheBillingSettings(networkId, body, callback)</td>
|
|
3502
|
-
<td style="padding:15px">Update
|
|
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>
|
|
3128
|
+
<td style="padding:15px">Update The Billing Settings</td>
|
|
3516
3129
|
<td style="padding:15px">{base_path}/{version}/networks/{pathv1}/wireless/billing?{query}</td>
|
|
3517
3130
|
<td style="padding:15px">Yes</td>
|
|
3518
3131
|
</tr>
|
|
3519
3132
|
<tr>
|
|
3520
3133
|
<td style="padding:15px">listTheBonjourForwardingSettingAndRulesForTheSSID(networkId, number, callback)</td>
|
|
3521
|
-
<td style="padding:15px">List
|
|
3134
|
+
<td style="padding:15px">List The Bonjour Forwarding Setting And Rules For The SSID</td>
|
|
3522
3135
|
<td style="padding:15px">{base_path}/{version}/networks/{pathv1}/wireless/ssids/{pathv2}/bonjourForwarding?{query}</td>
|
|
3523
3136
|
<td style="padding:15px">Yes</td>
|
|
3524
3137
|
</tr>
|
|
3525
3138
|
<tr>
|
|
3526
3139
|
<td style="padding:15px">updateTheBonjourForwardingSettingAndRulesForTheSSID(networkId, number, body, callback)</td>
|
|
3527
|
-
<td style="padding:15px">Update
|
|
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>
|
|
3140
|
+
<td style="padding:15px">Update The Bonjour Forwarding Setting And Rules For The SSID</td>
|
|
3541
3141
|
<td style="padding:15px">{base_path}/{version}/networks/{pathv1}/wireless/ssids/{pathv2}/bonjourForwarding?{query}</td>
|
|
3542
3142
|
<td style="padding:15px">Yes</td>
|
|
3543
3143
|
</tr>
|
|
3544
3144
|
<tr>
|
|
3545
3145
|
<td style="padding:15px">listAllIdentityPSKsInAWirelessNetwork(networkId, number, callback)</td>
|
|
3546
|
-
<td style="padding:15px">List
|
|
3146
|
+
<td style="padding:15px">List All Identity PS Ks In A Wireless Network</td>
|
|
3547
3147
|
<td style="padding:15px">{base_path}/{version}/networks/{pathv1}/wireless/ssids/{pathv2}/identityPsks?{query}</td>
|
|
3548
3148
|
<td style="padding:15px">Yes</td>
|
|
3549
3149
|
</tr>
|
|
3550
3150
|
<tr>
|
|
3551
3151
|
<td style="padding:15px">createAnIdentityPSK(networkId, number, body, callback)</td>
|
|
3552
|
-
<td style="padding:15px">Create
|
|
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>
|
|
3152
|
+
<td style="padding:15px">Create An Identity PSK</td>
|
|
3565
3153
|
<td style="padding:15px">{base_path}/{version}/networks/{pathv1}/wireless/ssids/{pathv2}/identityPsks?{query}</td>
|
|
3566
3154
|
<td style="padding:15px">Yes</td>
|
|
3567
3155
|
</tr>
|
|
3568
3156
|
<tr>
|
|
3569
3157
|
<td style="padding:15px">returnAnIdentityPSK(networkId, number, identityPskId, callback)</td>
|
|
3570
|
-
<td style="padding:15px">Return
|
|
3158
|
+
<td style="padding:15px">Return An Identity PSK</td>
|
|
3571
3159
|
<td style="padding:15px">{base_path}/{version}/networks/{pathv1}/wireless/ssids/{pathv2}/identityPsks/{pathv3}?{query}</td>
|
|
3572
3160
|
<td style="padding:15px">Yes</td>
|
|
3573
3161
|
</tr>
|
|
3574
3162
|
<tr>
|
|
3575
3163
|
<td style="padding:15px">updateAnIdentityPSK(networkId, number, identityPskId, body, callback)</td>
|
|
3576
|
-
<td style="padding:15px">Update
|
|
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>
|
|
3164
|
+
<td style="padding:15px">Update An Identity PSK</td>
|
|
3591
3165
|
<td style="padding:15px">{base_path}/{version}/networks/{pathv1}/wireless/ssids/{pathv2}/identityPsks/{pathv3}?{query}</td>
|
|
3592
3166
|
<td style="padding:15px">Yes</td>
|
|
3593
3167
|
</tr>
|
|
3594
3168
|
<tr>
|
|
3595
3169
|
<td style="padding:15px">deleteAnIdentityPSK(networkId, number, identityPskId, callback)</td>
|
|
3596
|
-
<td style="padding:15px">Delete
|
|
3597
|
-
#### Supports Action Batches
|
|
3598
|
-
|
|
3599
|
-
**Resource**|**Operation**
|
|
3600
|
-
:-------------: |:-------------:
|
|
3601
|
-
`/networks/{networkId}/wireless/ssids/{number}/identityPsks/{identityPskId}` | destroy
|
|
3602
|
-
|
|
3603
|
-
</td>
|
|
3170
|
+
<td style="padding:15px">Delete An Identity PSK</td>
|
|
3604
3171
|
<td style="padding:15px">{base_path}/{version}/networks/{pathv1}/wireless/ssids/{pathv2}/identityPsks/{pathv3}?{query}</td>
|
|
3605
3172
|
<td style="padding:15px">Yes</td>
|
|
3606
3173
|
</tr>
|
|
3607
3174
|
<tr>
|
|
3608
3175
|
<td style="padding:15px">listTheVPNSettingsForTheSSID(networkId, number, callback)</td>
|
|
3609
|
-
<td style="padding:15px">List
|
|
3176
|
+
<td style="padding:15px">List The VPN Settings For The SSID</td>
|
|
3610
3177
|
<td style="padding:15px">{base_path}/{version}/networks/{pathv1}/wireless/ssids/{pathv2}/vpn?{query}</td>
|
|
3611
3178
|
<td style="padding:15px">Yes</td>
|
|
3612
3179
|
</tr>
|
|
3613
3180
|
<tr>
|
|
3614
3181
|
<td style="padding:15px">updateTheVPNSettingsForTheSSID(networkId, number, body, callback)</td>
|
|
3615
|
-
<td style="padding:15px">Update
|
|
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>
|
|
3182
|
+
<td style="padding:15px">Update The VPN Settings For The SSID</td>
|
|
3627
3183
|
<td style="padding:15px">{base_path}/{version}/networks/{pathv1}/wireless/ssids/{pathv2}/vpn?{query}</td>
|
|
3628
3184
|
<td style="padding:15px">Yes</td>
|
|
3629
3185
|
</tr>
|
|
@@ -3695,20 +3251,13 @@ failover| object| Secondary VPN concentrator settings. This is only used when tw
|
|
|
3695
3251
|
</tr>
|
|
3696
3252
|
<tr>
|
|
3697
3253
|
<td style="padding:15px">listUserAccessDevicesAndItsTrustedAccessConnections(networkId, callback)</td>
|
|
3698
|
-
<td style="padding:15px">List User Access Devices
|
|
3254
|
+
<td style="padding:15px">List User Access Devices And Its Trusted Access Connections</td>
|
|
3699
3255
|
<td style="padding:15px">{base_path}/{version}/networks/{pathv1}/sm/userAccessDevices?{query}</td>
|
|
3700
3256
|
<td style="padding:15px">Yes</td>
|
|
3701
3257
|
</tr>
|
|
3702
3258
|
<tr>
|
|
3703
3259
|
<td style="padding:15px">deleteAUserAccessDevice(networkId, userAccessDeviceId, callback)</td>
|
|
3704
|
-
<td style="padding:15px">Delete
|
|
3705
|
-
#### Supports Action Batches
|
|
3706
|
-
|
|
3707
|
-
**Resource**|**Operation**
|
|
3708
|
-
:-------------: |:-------------:
|
|
3709
|
-
`/networks/{networkId}/sm/userAccessDevices/{userAccessDeviceId}` | destroy
|
|
3710
|
-
|
|
3711
|
-
</td>
|
|
3260
|
+
<td style="padding:15px">Delete A User Access Device</td>
|
|
3712
3261
|
<td style="padding:15px">{base_path}/{version}/networks/{pathv1}/sm/userAccessDevices/{pathv2}?{query}</td>
|
|
3713
3262
|
<td style="padding:15px">Yes</td>
|
|
3714
3263
|
</tr>
|
|
@@ -3720,110 +3269,61 @@ failover| object| Secondary VPN concentrator settings. This is only used when tw
|
|
|
3720
3269
|
</tr>
|
|
3721
3270
|
<tr>
|
|
3722
3271
|
<td style="padding:15px">listTheVPPAccountsInTheOrganization(organizationId, callback)</td>
|
|
3723
|
-
<td style="padding:15px">List
|
|
3272
|
+
<td style="padding:15px">List The VPP Accounts In The Organization</td>
|
|
3724
3273
|
<td style="padding:15px">{base_path}/{version}/organizations/{pathv1}/sm/vppAccounts?{query}</td>
|
|
3725
3274
|
<td style="padding:15px">Yes</td>
|
|
3726
3275
|
</tr>
|
|
3727
3276
|
<tr>
|
|
3728
3277
|
<td style="padding:15px">getAHashContainingTheUnparsedTokenOfTheVPPAccountWithTheGivenID(organizationId, vppAccountId, callback)</td>
|
|
3729
|
-
<td style="padding:15px">Get
|
|
3278
|
+
<td style="padding:15px">Get A Hash Containing The Unparsed Token Of The VPP Account With The Given ID</td>
|
|
3730
3279
|
<td style="padding:15px">{base_path}/{version}/organizations/{pathv1}/sm/vppAccounts/{pathv2}?{query}</td>
|
|
3731
3280
|
<td style="padding:15px">Yes</td>
|
|
3732
3281
|
</tr>
|
|
3733
3282
|
<tr>
|
|
3734
3283
|
<td style="padding:15px">enqueueAJobToPingATargetHostFromTheDevice(serial, body, callback)</td>
|
|
3735
|
-
<td style="padding:15px">Enqueue
|
|
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>
|
|
3284
|
+
<td style="padding:15px">Enqueue A Job To Ping A Target Host From The Device</td>
|
|
3742
3285
|
<td style="padding:15px">{base_path}/{version}/devices/{pathv1}/liveTools/ping?{query}</td>
|
|
3743
3286
|
<td style="padding:15px">Yes</td>
|
|
3744
3287
|
</tr>
|
|
3745
3288
|
<tr>
|
|
3746
3289
|
<td style="padding:15px">returnAPingJob(serial, id, callback)</td>
|
|
3747
|
-
<td style="padding:15px">Return
|
|
3290
|
+
<td style="padding:15px">Return A Ping Job</td>
|
|
3748
3291
|
<td style="padding:15px">{base_path}/{version}/devices/{pathv1}/liveTools/ping/{pathv2}?{query}</td>
|
|
3749
3292
|
<td style="padding:15px">Yes</td>
|
|
3750
3293
|
</tr>
|
|
3751
3294
|
<tr>
|
|
3752
3295
|
<td style="padding:15px">enqueueAJobToCheckConnectivityStatusToTheDevice(serial, body, callback)</td>
|
|
3753
|
-
<td style="padding:15px">Enqueue
|
|
3754
|
-
#### Body Parameters
|
|
3755
|
-
**Parameter**|**Type**|**Description**
|
|
3756
|
-
:-------------: |:-------------: |:-------------:
|
|
3757
|
-
count| integer| Count parameter to pass to ping. [1..5], default 5
|
|
3758
|
-
</td>
|
|
3296
|
+
<td style="padding:15px">Enqueue A Job To Check Connectivity Status To The Device</td>
|
|
3759
3297
|
<td style="padding:15px">{base_path}/{version}/devices/{pathv1}/liveTools/pingDevice?{query}</td>
|
|
3760
3298
|
<td style="padding:15px">Yes</td>
|
|
3761
3299
|
</tr>
|
|
3762
3300
|
<tr>
|
|
3763
3301
|
<td style="padding:15px">returnAPingDeviceJob(serial, id, callback)</td>
|
|
3764
|
-
<td style="padding:15px">Return
|
|
3302
|
+
<td style="padding:15px">Return A Ping Device Job</td>
|
|
3765
3303
|
<td style="padding:15px">{base_path}/{version}/devices/{pathv1}/liveTools/pingDevice/{pathv2}?{query}</td>
|
|
3766
3304
|
<td style="padding:15px">Yes</td>
|
|
3767
3305
|
</tr>
|
|
3768
3306
|
<tr>
|
|
3769
3307
|
<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>
|
|
3308
|
+
<td style="padding:15px">Claim a vMX into a network</td>
|
|
3783
3309
|
<td style="padding:15px">{base_path}/{version}/networks/{pathv1}/devices/claim/vmx?{query}</td>
|
|
3784
3310
|
<td style="padding:15px">Yes</td>
|
|
3785
3311
|
</tr>
|
|
3786
3312
|
<tr>
|
|
3787
3313
|
<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>
|
|
3314
|
+
<td style="padding:15px">Rollback a Firmware Upgrade For A Network</td>
|
|
3801
3315
|
<td style="padding:15px">{base_path}/{version}/networks/{pathv1}/firmwareUpgrades/rollbacks?{query}</td>
|
|
3802
3316
|
<td style="padding:15px">Yes</td>
|
|
3803
3317
|
</tr>
|
|
3804
3318
|
<tr>
|
|
3805
3319
|
<td style="padding:15px">getFirmwareUpgradeInformationForANetwork(networkId, callback)</td>
|
|
3806
|
-
<td style="padding:15px">Get
|
|
3320
|
+
<td style="padding:15px">Get Firmware Upgrade Information For A Network</td>
|
|
3807
3321
|
<td style="padding:15px">{base_path}/{version}/networks/{pathv1}/firmwareUpgrades?{query}</td>
|
|
3808
3322
|
<td style="padding:15px">Yes</td>
|
|
3809
3323
|
</tr>
|
|
3810
3324
|
<tr>
|
|
3811
3325
|
<td style="padding:15px">updateFirmwareUpgradeInformationForANetwork(networkId, body, callback)</td>
|
|
3812
|
-
<td style="padding:15px">Update
|
|
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>
|
|
3326
|
+
<td style="padding:15px">Update Firmware Upgrade Information For A Network</td>
|
|
3827
3327
|
<td style="padding:15px">{base_path}/{version}/networks/{pathv1}/firmwareUpgrades?{query}</td>
|
|
3828
3328
|
<td style="padding:15px">Yes</td>
|
|
3829
3329
|
</tr>
|
|
@@ -3835,94 +3335,49 @@ products| object| Contains information about the network to update
|
|
|
3835
3335
|
</tr>
|
|
3836
3336
|
<tr>
|
|
3837
3337
|
<td style="padding:15px">authorizeAUserConfiguredWithMerakiAuthenticationForANetworkCurrentlySupports8021XSplashGuestAndClientVPNUsersAndCurrentlyOrganizationsHaveA50000UserCap(networkId, body, callback)</td>
|
|
3838
|
-
<td style="padding:15px">Authorize
|
|
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>
|
|
3338
|
+
<td style="padding:15px">Authorize A User Configured With Meraki Authentication For A Network Currently Supports 802 1 X Spl</td>
|
|
3845
3339
|
<td style="padding:15px">{base_path}/{version}/networks/{pathv1}/merakiAuthUsers?{query}</td>
|
|
3846
3340
|
<td style="padding:15px">Yes</td>
|
|
3847
3341
|
</tr>
|
|
3848
3342
|
<tr>
|
|
3849
3343
|
<td style="padding:15px">deauthorizeAUser(networkId, merakiAuthUserId, callback)</td>
|
|
3850
|
-
<td style="padding:15px">Deauthorize
|
|
3344
|
+
<td style="padding:15px">Deauthorize A User</td>
|
|
3851
3345
|
<td style="padding:15px">{base_path}/{version}/networks/{pathv1}/merakiAuthUsers/{pathv2}?{query}</td>
|
|
3852
3346
|
<td style="padding:15px">Yes</td>
|
|
3853
3347
|
</tr>
|
|
3854
3348
|
<tr>
|
|
3855
3349
|
<td style="padding:15px">updateAUserConfiguredWithMerakiAuthenticationCurrently8021XRADIUSSplashGuestAndClientVPNUsersCanBeUpdated(networkId, merakiAuthUserId, body, callback)</td>
|
|
3856
|
-
<td style="padding:15px">Update
|
|
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>
|
|
3350
|
+
<td style="padding:15px">Update A User Configured With Meraki Authentication Currently 802 1 X RADIUS Splash Guest And Clien</td>
|
|
3863
3351
|
<td style="padding:15px">{base_path}/{version}/networks/{pathv1}/merakiAuthUsers/{pathv2}?{query}</td>
|
|
3864
3352
|
<td style="padding:15px">Yes</td>
|
|
3865
3353
|
</tr>
|
|
3866
3354
|
<tr>
|
|
3867
3355
|
<td style="padding:15px">addAnMQTTBroker(networkId, body, callback)</td>
|
|
3868
|
-
<td style="padding:15px">Add
|
|
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>
|
|
3356
|
+
<td style="padding:15px">Add An MQTT Broker</td>
|
|
3882
3357
|
<td style="padding:15px">{base_path}/{version}/networks/{pathv1}/mqttBrokers?{query}</td>
|
|
3883
3358
|
<td style="padding:15px">Yes</td>
|
|
3884
3359
|
</tr>
|
|
3885
3360
|
<tr>
|
|
3886
3361
|
<td style="padding:15px">listTheMQTTBrokersForThisNetwork(networkId, callback)</td>
|
|
3887
|
-
<td style="padding:15px">List
|
|
3362
|
+
<td style="padding:15px">List The MQTT Brokers For This Network</td>
|
|
3888
3363
|
<td style="padding:15px">{base_path}/{version}/networks/{pathv1}/mqttBrokers?{query}</td>
|
|
3889
3364
|
<td style="padding:15px">Yes</td>
|
|
3890
3365
|
</tr>
|
|
3891
3366
|
<tr>
|
|
3892
3367
|
<td style="padding:15px">deleteAnMQTTBroker(networkId, mqttBrokerId, callback)</td>
|
|
3893
|
-
<td style="padding:15px">Delete
|
|
3894
|
-
#### Supports Action Batches
|
|
3895
|
-
|
|
3896
|
-
**Resource**|**Operation**
|
|
3897
|
-
:-------------: |:-------------:
|
|
3898
|
-
`/networks/{networkId}/mqttBrokers/{mqttBrokerId}` | destroy
|
|
3899
|
-
|
|
3900
|
-
</td>
|
|
3368
|
+
<td style="padding:15px">Delete An MQTT Broker</td>
|
|
3901
3369
|
<td style="padding:15px">{base_path}/{version}/networks/{pathv1}/mqttBrokers/{pathv2}?{query}</td>
|
|
3902
3370
|
<td style="padding:15px">Yes</td>
|
|
3903
3371
|
</tr>
|
|
3904
3372
|
<tr>
|
|
3905
3373
|
<td style="padding:15px">returnAnMQTTBroker(networkId, mqttBrokerId, callback)</td>
|
|
3906
|
-
<td style="padding:15px">Return
|
|
3374
|
+
<td style="padding:15px">Return An MQTT Broker</td>
|
|
3907
3375
|
<td style="padding:15px">{base_path}/{version}/networks/{pathv1}/mqttBrokers/{pathv2}?{query}</td>
|
|
3908
3376
|
<td style="padding:15px">Yes</td>
|
|
3909
3377
|
</tr>
|
|
3910
3378
|
<tr>
|
|
3911
3379
|
<td style="padding:15px">updateAnMQTTBroker(networkId, mqttBrokerId, body, callback)</td>
|
|
3912
|
-
<td style="padding:15px">Update
|
|
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>
|
|
3380
|
+
<td style="padding:15px">Update An MQTT Broker</td>
|
|
3926
3381
|
<td style="padding:15px">{base_path}/{version}/networks/{pathv1}/mqttBrokers/{pathv2}?{query}</td>
|
|
3927
3382
|
<td style="padding:15px">Yes</td>
|
|
3928
3383
|
</tr>
|
|
@@ -3940,70 +3395,55 @@ authentication| object| Authentication settings of the MQTT broker
|
|
|
3940
3395
|
</tr>
|
|
3941
3396
|
<tr>
|
|
3942
3397
|
<td style="padding:15px">createAWebhookPayloadTemplateForANetwork(networkId, body, callback)</td>
|
|
3943
|
-
<td style="padding:15px">Create
|
|
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>
|
|
3398
|
+
<td style="padding:15px">Create A Webhook Payload Template For A Network</td>
|
|
3951
3399
|
<td style="padding:15px">{base_path}/{version}/networks/{pathv1}/webhooks/payloadTemplates?{query}</td>
|
|
3952
3400
|
<td style="padding:15px">Yes</td>
|
|
3953
3401
|
</tr>
|
|
3954
3402
|
<tr>
|
|
3955
3403
|
<td style="padding:15px">listTheWebhookPayloadTemplatesForANetwork(networkId, callback)</td>
|
|
3956
|
-
<td style="padding:15px">List
|
|
3404
|
+
<td style="padding:15px">List The Webhook Payload Templates For A Network</td>
|
|
3957
3405
|
<td style="padding:15px">{base_path}/{version}/networks/{pathv1}/webhooks/payloadTemplates?{query}</td>
|
|
3958
3406
|
<td style="padding:15px">Yes</td>
|
|
3959
3407
|
</tr>
|
|
3960
3408
|
<tr>
|
|
3961
3409
|
<td style="padding:15px">destroyAWebhookPayloadTemplateForANetwork(networkId, payloadTemplateId, callback)</td>
|
|
3962
|
-
<td style="padding:15px">Destroy
|
|
3410
|
+
<td style="padding:15px">Destroy A Webhook Payload Template For A Network</td>
|
|
3963
3411
|
<td style="padding:15px">{base_path}/{version}/networks/{pathv1}/webhooks/payloadTemplates/{pathv2}?{query}</td>
|
|
3964
3412
|
<td style="padding:15px">Yes</td>
|
|
3965
3413
|
</tr>
|
|
3966
3414
|
<tr>
|
|
3967
3415
|
<td style="padding:15px">getTheWebhookPayloadTemplateForANetwork(networkId, payloadTemplateId, callback)</td>
|
|
3968
|
-
<td style="padding:15px">Get
|
|
3416
|
+
<td style="padding:15px">Get The Webhook Payload Template For A Network</td>
|
|
3969
3417
|
<td style="padding:15px">{base_path}/{version}/networks/{pathv1}/webhooks/payloadTemplates/{pathv2}?{query}</td>
|
|
3970
3418
|
<td style="padding:15px">Yes</td>
|
|
3971
3419
|
</tr>
|
|
3972
3420
|
<tr>
|
|
3973
3421
|
<td style="padding:15px">updateAWebhookPayloadTemplateForANetwork(networkId, payloadTemplateId, body, callback)</td>
|
|
3974
|
-
<td style="padding:15px">Update
|
|
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>
|
|
3422
|
+
<td style="padding:15px">Update A Webhook Payload Template For A Network</td>
|
|
3983
3423
|
<td style="padding:15px">{base_path}/{version}/networks/{pathv1}/webhooks/payloadTemplates/{pathv2}?{query}</td>
|
|
3984
3424
|
<td style="padding:15px">Yes</td>
|
|
3985
3425
|
</tr>
|
|
3986
3426
|
<tr>
|
|
3987
3427
|
<td style="padding:15px">returntheapplicationusagedataforclients(networkId, callback)</td>
|
|
3988
|
-
<td style="padding:15px">Return the application usage data for clients
|
|
3428
|
+
<td style="padding:15px">Return the application usage data for clients</td>
|
|
3989
3429
|
<td style="padding:15px">{base_path}/{version}/networks/{pathv1}/clients/applicationUsage?{query}</td>
|
|
3990
3430
|
<td style="padding:15px">Yes</td>
|
|
3991
3431
|
</tr>
|
|
3992
3432
|
<tr>
|
|
3993
3433
|
<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
|
|
3434
|
+
<td style="padding:15px">Returns a timeseries of total traffic consumption rates for all clients on a network within a given</td>
|
|
3995
3435
|
<td style="padding:15px">{base_path}/{version}/networks/{pathv1}/clients/bandwidthUsageHistory?{query}</td>
|
|
3996
3436
|
<td style="padding:15px">Yes</td>
|
|
3997
3437
|
</tr>
|
|
3998
3438
|
<tr>
|
|
3999
3439
|
<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
|
|
3440
|
+
<td style="padding:15px">Return data usage (in megabits per second) over time for all clients in the given organization with</td>
|
|
4001
3441
|
<td style="padding:15px">{base_path}/{version}/organizations/{pathv1}/clients/bandwidthUsageHistory?{query}</td>
|
|
4002
3442
|
<td style="padding:15px">Yes</td>
|
|
4003
3443
|
</tr>
|
|
4004
3444
|
<tr>
|
|
4005
3445
|
<td style="padding:15px">returntheusagehistoriesforclients(networkId, callback)</td>
|
|
4006
|
-
<td style="padding:15px">Return the usage histories for clients
|
|
3446
|
+
<td style="padding:15px">Return the usage histories for clients</td>
|
|
4007
3447
|
<td style="padding:15px">{base_path}/{version}/networks/{pathv1}/clients/usageHistories?{query}</td>
|
|
4008
3448
|
<td style="padding:15px">Yes</td>
|
|
4009
3449
|
</tr>
|
|
@@ -4015,157 +3455,91 @@ headersFile| string| A file containing the liquid template u...(description trun
|
|
|
4015
3455
|
</tr>
|
|
4016
3456
|
<tr>
|
|
4017
3457
|
<td style="padding:15px">createsNewAdaptivePolicyACL(organizationId, body, callback)</td>
|
|
4018
|
-
<td style="padding:15px">Creates
|
|
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>
|
|
3458
|
+
<td style="padding:15px">Creates New Adaptive Policy ACL</td>
|
|
4032
3459
|
<td style="padding:15px">{base_path}/{version}/organizations/{pathv1}/adaptivePolicy/acls?{query}</td>
|
|
4033
3460
|
<td style="padding:15px">Yes</td>
|
|
4034
3461
|
</tr>
|
|
4035
3462
|
<tr>
|
|
4036
3463
|
<td style="padding:15px">listAdaptivePolicyACLsInAOrganization(organizationId, callback)</td>
|
|
4037
|
-
<td style="padding:15px">List
|
|
3464
|
+
<td style="padding:15px">List Adaptive Policy AC Ls In A Organization</td>
|
|
4038
3465
|
<td style="padding:15px">{base_path}/{version}/organizations/{pathv1}/adaptivePolicy/acls?{query}</td>
|
|
4039
3466
|
<td style="padding:15px">Yes</td>
|
|
4040
3467
|
</tr>
|
|
4041
3468
|
<tr>
|
|
4042
3469
|
<td style="padding:15px">deletesTheSpecifiedAdaptivePolicyACL(organizationId, aclId, callback)</td>
|
|
4043
|
-
<td style="padding:15px">Deletes
|
|
3470
|
+
<td style="padding:15px">Deletes The Specified Adaptive Policy ACL</td>
|
|
4044
3471
|
<td style="padding:15px">{base_path}/{version}/organizations/{pathv1}/adaptivePolicy/acls/{pathv2}?{query}</td>
|
|
4045
3472
|
<td style="padding:15px">Yes</td>
|
|
4046
3473
|
</tr>
|
|
4047
3474
|
<tr>
|
|
4048
3475
|
<td style="padding:15px">returnsTheAdaptivePolicyACLInformation(organizationId, aclId, callback)</td>
|
|
4049
|
-
<td style="padding:15px">Returns
|
|
3476
|
+
<td style="padding:15px">Returns The Adaptive Policy ACL Information</td>
|
|
4050
3477
|
<td style="padding:15px">{base_path}/{version}/organizations/{pathv1}/adaptivePolicy/acls/{pathv2}?{query}</td>
|
|
4051
3478
|
<td style="padding:15px">Yes</td>
|
|
4052
3479
|
</tr>
|
|
4053
3480
|
<tr>
|
|
4054
3481
|
<td style="padding:15px">updatesAnAdaptivePolicyACL(organizationId, aclId, body, callback)</td>
|
|
4055
|
-
<td style="padding:15px">Updates
|
|
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>
|
|
3482
|
+
<td style="padding:15px">Updates An Adaptive Policy ACL</td>
|
|
4068
3483
|
<td style="padding:15px">{base_path}/{version}/organizations/{pathv1}/adaptivePolicy/acls/{pathv2}?{query}</td>
|
|
4069
3484
|
<td style="padding:15px">Yes</td>
|
|
4070
3485
|
</tr>
|
|
4071
3486
|
<tr>
|
|
4072
3487
|
<td style="padding:15px">createsANewAdaptivePolicyGroup(organizationId, body, callback)</td>
|
|
4073
|
-
<td style="padding:15px">Creates
|
|
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>
|
|
3488
|
+
<td style="padding:15px">Creates A New Adaptive Policy Group</td>
|
|
4081
3489
|
<td style="padding:15px">{base_path}/{version}/organizations/{pathv1}/adaptivePolicy/groups?{query}</td>
|
|
4082
3490
|
<td style="padding:15px">Yes</td>
|
|
4083
3491
|
</tr>
|
|
4084
3492
|
<tr>
|
|
4085
3493
|
<td style="padding:15px">listAdaptivePolicyGroupsInAOrganization(organizationId, callback)</td>
|
|
4086
|
-
<td style="padding:15px">List
|
|
3494
|
+
<td style="padding:15px">List Adaptive Policy Groups In A Organization</td>
|
|
4087
3495
|
<td style="padding:15px">{base_path}/{version}/organizations/{pathv1}/adaptivePolicy/groups?{query}</td>
|
|
4088
3496
|
<td style="padding:15px">Yes</td>
|
|
4089
3497
|
</tr>
|
|
4090
3498
|
<tr>
|
|
4091
3499
|
<td style="padding:15px">deletesTheSpecifiedAdaptivePolicyGroupAndAnyAssociatedPoliciesAndReferences(organizationId, id, callback)</td>
|
|
4092
|
-
<td style="padding:15px">Deletes
|
|
4093
|
-
#### Supports Action Batches
|
|
4094
|
-
|
|
4095
|
-
**Resource**|**Operation**
|
|
4096
|
-
:-------------: |:-------------:
|
|
4097
|
-
`/organizations/{organizationId}/adaptivePolicy/groups/{id}` | destroy
|
|
4098
|
-
|
|
4099
|
-
</td>
|
|
3500
|
+
<td style="padding:15px">Deletes The Specified Adaptive Policy Group And Any Associated Policies And References</td>
|
|
4100
3501
|
<td style="padding:15px">{base_path}/{version}/organizations/{pathv1}/adaptivePolicy/groups/{pathv2}?{query}</td>
|
|
4101
3502
|
<td style="padding:15px">Yes</td>
|
|
4102
3503
|
</tr>
|
|
4103
3504
|
<tr>
|
|
4104
3505
|
<td style="padding:15px">returnsAnAdaptivePolicyGroup(organizationId, id, callback)</td>
|
|
4105
|
-
<td style="padding:15px">Returns
|
|
3506
|
+
<td style="padding:15px">Returns An Adaptive Policy Group</td>
|
|
4106
3507
|
<td style="padding:15px">{base_path}/{version}/organizations/{pathv1}/adaptivePolicy/groups/{pathv2}?{query}</td>
|
|
4107
3508
|
<td style="padding:15px">Yes</td>
|
|
4108
3509
|
</tr>
|
|
4109
3510
|
<tr>
|
|
4110
3511
|
<td style="padding:15px">updatesAnAdaptivePolicyGroup(organizationId, id, body, callback)</td>
|
|
4111
|
-
<td style="padding:15px">Updates
|
|
3512
|
+
<td style="padding:15px">Updates An Adaptive Policy Group</td>
|
|
4112
3513
|
<td style="padding:15px">{base_path}/{version}/organizations/{pathv1}/adaptivePolicy/groups/{pathv2}?{query}</td>
|
|
4113
3514
|
<td style="padding:15px">Yes</td>
|
|
4114
3515
|
</tr>
|
|
4115
3516
|
<tr>
|
|
4116
3517
|
<td style="padding:15px">addAnAdaptivePolicy(organizationId, body, callback)</td>
|
|
4117
|
-
<td style="padding:15px">Add
|
|
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>
|
|
3518
|
+
<td style="padding:15px">Add An Adaptive Policy</td>
|
|
4128
3519
|
<td style="padding:15px">{base_path}/{version}/organizations/{pathv1}/adaptivePolicy/policies?{query}</td>
|
|
4129
3520
|
<td style="padding:15px">Yes</td>
|
|
4130
3521
|
</tr>
|
|
4131
3522
|
<tr>
|
|
4132
3523
|
<td style="padding:15px">listAdaptivePoliciesInAnOrganization(organizationId, callback)</td>
|
|
4133
|
-
<td style="padding:15px">List
|
|
3524
|
+
<td style="padding:15px">List Adaptive Policies In An Organization</td>
|
|
4134
3525
|
<td style="padding:15px">{base_path}/{version}/organizations/{pathv1}/adaptivePolicy/policies?{query}</td>
|
|
4135
3526
|
<td style="padding:15px">Yes</td>
|
|
4136
3527
|
</tr>
|
|
4137
3528
|
<tr>
|
|
4138
3529
|
<td style="padding:15px">deleteAnAdaptivePolicy(organizationId, id, callback)</td>
|
|
4139
|
-
<td style="padding:15px">Delete
|
|
4140
|
-
#### Supports Action Batches
|
|
4141
|
-
|
|
4142
|
-
**Resource**|**Operation**
|
|
4143
|
-
:-------------: |:-------------:
|
|
4144
|
-
`/organizations/{organizationId}/adaptivePolicy/policies/{id}` | destroy
|
|
4145
|
-
|
|
4146
|
-
</td>
|
|
3530
|
+
<td style="padding:15px">Delete An Adaptive Policy</td>
|
|
4147
3531
|
<td style="padding:15px">{base_path}/{version}/organizations/{pathv1}/adaptivePolicy/policies/{pathv2}?{query}</td>
|
|
4148
3532
|
<td style="padding:15px">Yes</td>
|
|
4149
3533
|
</tr>
|
|
4150
3534
|
<tr>
|
|
4151
3535
|
<td style="padding:15px">returnAnAdaptivePolicy(organizationId, id, callback)</td>
|
|
4152
|
-
<td style="padding:15px">Return
|
|
3536
|
+
<td style="padding:15px">Return An Adaptive Policy</td>
|
|
4153
3537
|
<td style="padding:15px">{base_path}/{version}/organizations/{pathv1}/adaptivePolicy/policies/{pathv2}?{query}</td>
|
|
4154
3538
|
<td style="padding:15px">Yes</td>
|
|
4155
3539
|
</tr>
|
|
4156
3540
|
<tr>
|
|
4157
3541
|
<td style="padding:15px">updateAnAdaptivePolicy(organizationId, id, body, callback)</td>
|
|
4158
|
-
<td style="padding:15px">Update
|
|
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>
|
|
3542
|
+
<td style="padding:15px">Update An Adaptive Policy</td>
|
|
4169
3543
|
<td style="padding:15px">{base_path}/{version}/organizations/{pathv1}/adaptivePolicy/policies/{pathv2}?{query}</td>
|
|
4170
3544
|
<td style="padding:15px">Yes</td>
|
|
4171
3545
|
</tr>
|
|
@@ -4177,207 +3551,127 @@ lastEntryRule| string| The rule to apply if there is no m...(description truncat
|
|
|
4177
3551
|
</tr>
|
|
4178
3552
|
<tr>
|
|
4179
3553
|
<td style="padding:15px">createANewConfigurationTemplate(organizationId, body, callback)</td>
|
|
4180
|
-
<td style="padding:15px">Create
|
|
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>
|
|
3554
|
+
<td style="padding:15px">Create A New Configuration Template</td>
|
|
4187
3555
|
<td style="padding:15px">{base_path}/{version}/organizations/{pathv1}/configTemplates?{query}</td>
|
|
4188
3556
|
<td style="padding:15px">Yes</td>
|
|
4189
3557
|
</tr>
|
|
4190
3558
|
<tr>
|
|
4191
3559
|
<td style="padding:15px">returnASingleConfigurationTemplate(organizationId, configTemplateId, callback)</td>
|
|
4192
|
-
<td style="padding:15px">Return
|
|
3560
|
+
<td style="padding:15px">Return A Single Configuration Template</td>
|
|
4193
3561
|
<td style="padding:15px">{base_path}/{version}/organizations/{pathv1}/configTemplates/{pathv2}?{query}</td>
|
|
4194
3562
|
<td style="padding:15px">Yes</td>
|
|
4195
3563
|
</tr>
|
|
4196
3564
|
<tr>
|
|
4197
3565
|
<td style="padding:15px">updateAConfigurationTemplate(organizationId, configTemplateId, body, callback)</td>
|
|
4198
|
-
<td style="padding:15px">Update
|
|
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>
|
|
3566
|
+
<td style="padding:15px">Update A Configuration Template</td>
|
|
4210
3567
|
<td style="padding:15px">{base_path}/{version}/organizations/{pathv1}/configTemplates/{pathv2}?{query}</td>
|
|
4211
3568
|
<td style="padding:15px">Yes</td>
|
|
4212
3569
|
</tr>
|
|
4213
3570
|
<tr>
|
|
4214
3571
|
<td style="padding:15px">createANewEarlyAccessFeatureOptInForAnOrganization(organizationId, body, callback)</td>
|
|
4215
|
-
<td style="padding:15px">Create
|
|
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>
|
|
3572
|
+
<td style="padding:15px">Create A New Early Access Feature Opt In For An Organization</td>
|
|
4222
3573
|
<td style="padding:15px">{base_path}/{version}/organizations/{pathv1}/earlyAccess/features/optIns?{query}</td>
|
|
4223
3574
|
<td style="padding:15px">Yes</td>
|
|
4224
3575
|
</tr>
|
|
4225
3576
|
<tr>
|
|
4226
3577
|
<td style="padding:15px">listTheEarlyAccessFeatureOptInsForAnOrganization(organizationId, callback)</td>
|
|
4227
|
-
<td style="padding:15px">List
|
|
3578
|
+
<td style="padding:15px">List The Early Access Feature Opt Ins For An Organization</td>
|
|
4228
3579
|
<td style="padding:15px">{base_path}/{version}/organizations/{pathv1}/earlyAccess/features/optIns?{query}</td>
|
|
4229
3580
|
<td style="padding:15px">Yes</td>
|
|
4230
3581
|
</tr>
|
|
4231
3582
|
<tr>
|
|
4232
3583
|
<td style="padding:15px">deleteAnEarlyAccessFeatureOptIn(organizationId, optInId, callback)</td>
|
|
4233
|
-
<td style="padding:15px">Delete
|
|
3584
|
+
<td style="padding:15px">Delete An Early Access Feature Opt In</td>
|
|
4234
3585
|
<td style="padding:15px">{base_path}/{version}/organizations/{pathv1}/earlyAccess/features/optIns/{pathv2}?{query}</td>
|
|
4235
3586
|
<td style="padding:15px">Yes</td>
|
|
4236
3587
|
</tr>
|
|
4237
3588
|
<tr>
|
|
4238
3589
|
<td style="padding:15px">showAnEarlyAccessFeatureOptInForAnOrganization(organizationId, optInId, callback)</td>
|
|
4239
|
-
<td style="padding:15px">Show
|
|
3590
|
+
<td style="padding:15px">Show An Early Access Feature Opt In For An Organization</td>
|
|
4240
3591
|
<td style="padding:15px">{base_path}/{version}/organizations/{pathv1}/earlyAccess/features/optIns/{pathv2}?{query}</td>
|
|
4241
3592
|
<td style="padding:15px">Yes</td>
|
|
4242
3593
|
</tr>
|
|
4243
3594
|
<tr>
|
|
4244
3595
|
<td style="padding:15px">updateAnEarlyAccessFeatureOptInForAnOrganization(organizationId, optInId, body, callback)</td>
|
|
4245
|
-
<td style="padding:15px">Update
|
|
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>
|
|
3596
|
+
<td style="padding:15px">Update An Early Access Feature Opt In For An Organization</td>
|
|
4258
3597
|
<td style="padding:15px">{base_path}/{version}/organizations/{pathv1}/earlyAccess/features/optIns/{pathv2}?{query}</td>
|
|
4259
3598
|
<td style="padding:15px">Yes</td>
|
|
4260
3599
|
</tr>
|
|
4261
3600
|
<tr>
|
|
4262
3601
|
<td style="padding:15px">listTheAvailableEarlyAccessFeaturesForOrganization(organizationId, callback)</td>
|
|
4263
|
-
<td style="padding:15px">List
|
|
3602
|
+
<td style="padding:15px">List The Available Early Access Features For Organization</td>
|
|
4264
3603
|
<td style="padding:15px">{base_path}/{version}/organizations/{pathv1}/earlyAccess/features?{query}</td>
|
|
4265
3604
|
<td style="padding:15px">Yes</td>
|
|
4266
3605
|
</tr>
|
|
4267
3606
|
<tr>
|
|
4268
3607
|
<td style="padding:15px">claimAListOfDevicesLicensesAndOrOrdersIntoAnOrganizationInventory(organizationId, body, callback)</td>
|
|
4269
|
-
<td style="padding:15px">Claim
|
|
3608
|
+
<td style="padding:15px">Claim A List Of Devices Licenses And Or Orders Into An Organization Inventory</td>
|
|
4270
3609
|
<td style="padding:15px">{base_path}/{version}/organizations/{pathv1}/inventory/claim?{query}</td>
|
|
4271
3610
|
<td style="padding:15px">Yes</td>
|
|
4272
3611
|
</tr>
|
|
4273
3612
|
<tr>
|
|
4274
3613
|
<td style="padding:15px">releaseAListOfClaimedDevicesFromAnOrganization(organizationId, body, callback)</td>
|
|
4275
|
-
<td style="padding:15px">Release
|
|
4276
|
-
#### Body Parameters
|
|
4277
|
-
**Parameter**|**Type**|**Description**
|
|
4278
|
-
:-------------: |:-------------: |:-------------:
|
|
4279
|
-
serials| array| Serials of the devices that should be released
|
|
4280
|
-
</td>
|
|
3614
|
+
<td style="padding:15px">Release A List Of Claimed Devices From An Organization</td>
|
|
4281
3615
|
<td style="padding:15px">{base_path}/{version}/organizations/{pathv1}/inventory/release?{query}</td>
|
|
4282
3616
|
<td style="padding:15px">Yes</td>
|
|
4283
3617
|
</tr>
|
|
4284
3618
|
<tr>
|
|
4285
3619
|
<td style="padding:15px">returnsTheLoginSecuritySettingsForAnOrganization(organizationId, callback)</td>
|
|
4286
|
-
<td style="padding:15px">Returns
|
|
3620
|
+
<td style="padding:15px">Returns The Login Security Settings For An Organization</td>
|
|
4287
3621
|
<td style="padding:15px">{base_path}/{version}/organizations/{pathv1}/loginSecurity?{query}</td>
|
|
4288
3622
|
<td style="padding:15px">Yes</td>
|
|
4289
3623
|
</tr>
|
|
4290
3624
|
<tr>
|
|
4291
3625
|
<td style="padding:15px">updateTheLoginSecuritySettingsForAnOrganization(organizationId, body, callback)</td>
|
|
4292
|
-
<td style="padding:15px">Update
|
|
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>
|
|
3626
|
+
<td style="padding:15px">Update The Login Security Settings For An Organization</td>
|
|
4299
3627
|
<td style="padding:15px">{base_path}/{version}/organizations/{pathv1}/loginSecurity?{query}</td>
|
|
4300
3628
|
<td style="padding:15px">Yes</td>
|
|
4301
3629
|
</tr>
|
|
4302
3630
|
<tr>
|
|
4303
3631
|
<td style="padding:15px">createASAMLIdPForYourOrganization(organizationId, body, callback)</td>
|
|
4304
|
-
<td style="padding:15px">Create
|
|
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>
|
|
3632
|
+
<td style="padding:15px">Create A SAML Id P For Your Organization</td>
|
|
4316
3633
|
<td style="padding:15px">{base_path}/{version}/organizations/{pathv1}/saml/idps?{query}</td>
|
|
4317
3634
|
<td style="padding:15px">Yes</td>
|
|
4318
3635
|
</tr>
|
|
4319
3636
|
<tr>
|
|
4320
3637
|
<td style="padding:15px">listTheSAMLIdPsInYourOrganization(organizationId, callback)</td>
|
|
4321
|
-
<td style="padding:15px">List
|
|
3638
|
+
<td style="padding:15px">List The SAML Id Ps In Your Organization</td>
|
|
4322
3639
|
<td style="padding:15px">{base_path}/{version}/organizations/{pathv1}/saml/idps?{query}</td>
|
|
4323
3640
|
<td style="padding:15px">Yes</td>
|
|
4324
3641
|
</tr>
|
|
4325
3642
|
<tr>
|
|
4326
3643
|
<td style="padding:15px">getASAMLIdPFromYourOrganization(organizationId, idpId, callback)</td>
|
|
4327
|
-
<td style="padding:15px">Get
|
|
3644
|
+
<td style="padding:15px">Get A SAML Id P From Your Organization</td>
|
|
4328
3645
|
<td style="padding:15px">{base_path}/{version}/organizations/{pathv1}/saml/idps/{pathv2}?{query}</td>
|
|
4329
3646
|
<td style="padding:15px">Yes</td>
|
|
4330
3647
|
</tr>
|
|
4331
3648
|
<tr>
|
|
4332
3649
|
<td style="padding:15px">removeASAMLIdPInYourOrganization(organizationId, idpId, callback)</td>
|
|
4333
|
-
<td style="padding:15px">Remove
|
|
4334
|
-
#### Supports Action Batches
|
|
4335
|
-
|
|
4336
|
-
**Resource**|**Operation**
|
|
4337
|
-
:-------------: |:-------------:
|
|
4338
|
-
`/organizations/{organizationId}/saml/idps/{idpId}` | destroy
|
|
4339
|
-
|
|
4340
|
-
</td>
|
|
3650
|
+
<td style="padding:15px">Remove A SAML Id P In Your Organization</td>
|
|
4341
3651
|
<td style="padding:15px">{base_path}/{version}/organizations/{pathv1}/saml/idps/{pathv2}?{query}</td>
|
|
4342
3652
|
<td style="padding:15px">Yes</td>
|
|
4343
3653
|
</tr>
|
|
4344
3654
|
<tr>
|
|
4345
3655
|
<td style="padding:15px">updateASAMLIdPInYourOrganization(organizationId, idpId, body, callback)</td>
|
|
4346
|
-
<td style="padding:15px">Update
|
|
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>
|
|
3656
|
+
<td style="padding:15px">Update A SAML Id P In Your Organization</td>
|
|
4358
3657
|
<td style="padding:15px">{base_path}/{version}/organizations/{pathv1}/saml/idps/{pathv2}?{query}</td>
|
|
4359
3658
|
<td style="padding:15px">Yes</td>
|
|
4360
3659
|
</tr>
|
|
4361
3660
|
<tr>
|
|
4362
3661
|
<td style="padding:15px">returnsTheSAMLSSOEnabledSettingsForAnOrganization(organizationId, callback)</td>
|
|
4363
|
-
<td style="padding:15px">Returns
|
|
3662
|
+
<td style="padding:15px">Returns The SAML SSO Enabled Settings For An Organization</td>
|
|
4364
3663
|
<td style="padding:15px">{base_path}/{version}/organizations/{pathv1}/saml?{query}</td>
|
|
4365
3664
|
<td style="padding:15px">Yes</td>
|
|
4366
3665
|
</tr>
|
|
4367
3666
|
<tr>
|
|
4368
3667
|
<td style="padding:15px">updatesTheSAMLSSOEnabledSettingsForAnOrganization(organizationId, body, callback)</td>
|
|
4369
|
-
<td style="padding:15px">Updates
|
|
4370
|
-
#### Body Parameters
|
|
4371
|
-
**Parameter**|**Type**|**Description**
|
|
4372
|
-
:-------------: |:-------------: |:-------------:
|
|
4373
|
-
enabled| boolean| Boolean for updating SAML SSO enabled settings.
|
|
4374
|
-
</td>
|
|
3668
|
+
<td style="padding:15px">Updates The SAML SSO Enabled Settings For An Organization</td>
|
|
4375
3669
|
<td style="padding:15px">{base_path}/{version}/organizations/{pathv1}/saml?{query}</td>
|
|
4376
3670
|
<td style="padding:15px">Yes</td>
|
|
4377
3671
|
</tr>
|
|
4378
3672
|
<tr>
|
|
4379
3673
|
<td style="padding:15px">listtheavailabilityinformationfordevicesinanorganization(organizationId, callback)</td>
|
|
4380
|
-
<td style="padding:15px">List the availability information for devices in an organization
|
|
3674
|
+
<td style="padding:15px">List the availability information for devices in an organization</td>
|
|
4381
3675
|
<td style="padding:15px">{base_path}/{version}/organizations/{pathv1}/devices/availabilities?{query}</td>
|
|
4382
3676
|
<td style="padding:15px">Yes</td>
|
|
4383
3677
|
</tr>
|
|
@@ -4395,31 +3689,31 @@ enabled| boolean| Boolean for updating SAML SSO enabled settings.
|
|
|
4395
3689
|
</tr>
|
|
4396
3690
|
<tr>
|
|
4397
3691
|
<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
|
|
3692
|
+
<td style="padding:15px">Return metrics for organization's top 10 devices sorted by data usage over given time range</td>
|
|
4399
3693
|
<td style="padding:15px">{base_path}/{version}/organizations/{pathv1}/summary/top/devices/byUsage?{query}</td>
|
|
4400
3694
|
<td style="padding:15px">Yes</td>
|
|
4401
3695
|
</tr>
|
|
4402
3696
|
<tr>
|
|
4403
3697
|
<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
|
|
3698
|
+
<td style="padding:15px">Return metrics for organization's top clients by data usage (in mb) over given time range, grouped</td>
|
|
4405
3699
|
<td style="padding:15px">{base_path}/{version}/organizations/{pathv1}/summary/top/clients/manufacturers/byUsage?{query}</td>
|
|
4406
3700
|
<td style="padding:15px">Yes</td>
|
|
4407
3701
|
</tr>
|
|
4408
3702
|
<tr>
|
|
4409
3703
|
<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
|
|
3704
|
+
<td style="padding:15px">Return metrics for organization's top 10 device models sorted by data usage over given time range</td>
|
|
4411
3705
|
<td style="padding:15px">{base_path}/{version}/organizations/{pathv1}/summary/top/devices/models/byUsage?{query}</td>
|
|
4412
3706
|
<td style="padding:15px">Yes</td>
|
|
4413
3707
|
</tr>
|
|
4414
3708
|
<tr>
|
|
4415
3709
|
<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
|
|
3710
|
+
<td style="padding:15px">Return metrics for organization's top 10 ssids by data usage over given time range</td>
|
|
4417
3711
|
<td style="padding:15px">{base_path}/{version}/organizations/{pathv1}/summary/top/ssids/byUsage?{query}</td>
|
|
4418
3712
|
<td style="padding:15px">Yes</td>
|
|
4419
3713
|
</tr>
|
|
4420
3714
|
<tr>
|
|
4421
3715
|
<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
|
|
3716
|
+
<td style="padding:15px">Return metrics for organization's top 10 switches by energy usage over given time range</td>
|
|
4423
3717
|
<td style="padding:15px">{base_path}/{version}/organizations/{pathv1}/summary/top/switches/byEnergyUsage?{query}</td>
|
|
4424
3718
|
<td style="padding:15px">Yes</td>
|
|
4425
3719
|
</tr>
|