Skip to content

Commit 0ffb2c3

Browse files
author
Meraki
committed
API version 1.0.0-beta.17
1 parent 49c733e commit 0ffb2c3

File tree

1 file changed

+173
-10
lines changed

1 file changed

+173
-10
lines changed

‎openapi/spec2.json

Lines changed: 173 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
11
{
22
"swagger": "2.0",
33
"info": {
4-
"version": "1.0.0-beta.16",
4+
"version": "1.0.0-beta.17",
55
"title": "Meraki Dashboard API",
6-
"description": "The Cisco Meraki Dashboard API is a modern REST API based on the OpenAPI specification.\n\n> Date: 05 August, 2020\n>\n> [What's New](https://meraki.io/whats-new/)\n\n---\n\n[API Documentation](https://meraki.io/api)\n\n[Community Support](https://meraki.io/community)\n\n[Meraki Homepage](https://www.meraki.com)\n"
6+
"description": "The Cisco Meraki Dashboard API is a modern REST API based on the OpenAPI specification.\n\n> Date: 12 August, 2020\n>\n> [What's New](https://meraki.io/whats-new/)\n\n---\n\n[API Documentation](https://meraki.io/api)\n\n[Community Support](https://meraki.io/community)\n\n[Meraki Homepage](https://www.meraki.com)\n"
77
},
88
"host": "api.meraki.com",
99
"basePath": "/api/v1",
@@ -2400,6 +2400,10 @@
24002400
"stormControlEnabled": {
24012401
"type": "boolean",
24022402
"description": "The storm control status of the switch port"
2403+
},
2404+
"flexibleStackingEnabled": {
2405+
"type": "boolean",
2406+
"description": "For supported switches (e.g. MS420/MS425), whether or not the port has flexible stacking enabled."
24032407
}
24042408
},
24052409
"example": {
@@ -3829,7 +3833,16 @@
38293833
"examples": {
38303834
"application/json": {
38313835
"serial": "Q234-ABCD-5678",
3832-
"rfProfileId": "1234"
3836+
"rfProfileId": "1234",
3837+
"twoFourGhzSettings": {
3838+
"channel": 11,
3839+
"targetPower": 21
3840+
},
3841+
"fiveGhzSettings": {
3842+
"channel": 149,
3843+
"channelWidth": 20,
3844+
"targetPower": 15
3845+
}
38333846
}
38343847
}
38353848
}
@@ -3861,10 +3874,101 @@
38613874
"rfProfileId": {
38623875
"type": "integer",
38633876
"description": " The ID of an RF profile to assign to the device. If the value of this parameter is null, the appropriate basic RF profile\n (indoor or outdoor) will be assigned to the device. Assigning an RF profile will clear ALL manually configured overrides\n on the device (channel width, channel, power).\n"
3877+
},
3878+
"twoFourGhzSettings": {
3879+
"type": "object",
3880+
"properties": {
3881+
"channel": {
3882+
"type": "integer",
3883+
"enum": [
3884+
1,
3885+
2,
3886+
3,
3887+
4,
3888+
5,
3889+
6,
3890+
7,
3891+
8,
3892+
9,
3893+
10,
3894+
11,
3895+
12,
3896+
13,
3897+
14
3898+
],
3899+
"description": "Sets a manual channel for 2.4 GHz. Can be '1', '2', '3', '4', '5', '6', '7', '8', '9', '10', '11', '12', '13' or '14' or null for using auto channel."
3900+
},
3901+
"targetPower": {
3902+
"type": "integer",
3903+
"description": "Set a manual target power for 2.4 GHz. Can be between '5' or '30' or null for using auto power range."
3904+
}
3905+
},
3906+
"description": "Manual radio settings for 2.4 GHz."
3907+
},
3908+
"fiveGhzSettings": {
3909+
"type": "object",
3910+
"properties": {
3911+
"channel": {
3912+
"type": "integer",
3913+
"enum": [
3914+
36,
3915+
40,
3916+
44,
3917+
48,
3918+
52,
3919+
56,
3920+
60,
3921+
64,
3922+
100,
3923+
104,
3924+
108,
3925+
112,
3926+
116,
3927+
120,
3928+
124,
3929+
128,
3930+
132,
3931+
136,
3932+
140,
3933+
144,
3934+
149,
3935+
153,
3936+
157,
3937+
161,
3938+
165
3939+
],
3940+
"description": "Sets a manual channel for 5 GHz. Can be '36', '40', '44', '48', '52', '56', '60', '64', '100', '104', '108', '112', '116', '120', '124', '128', '132', '136', '140', '144', '149', '153', '157', '161' or '165' or null for using auto channel."
3941+
},
3942+
"channelWidth": {
3943+
"type": "integer",
3944+
"enum": [
3945+
0,
3946+
20,
3947+
40,
3948+
80,
3949+
160
3950+
],
3951+
"description": "Sets a manual channel for 5 GHz. Can be '0', '20', '40', '80' or '160' or null for using auto channel width."
3952+
},
3953+
"targetPower": {
3954+
"type": "integer",
3955+
"description": "Set a manual target power for 5 GHz. Can be between '8' or '30' or null for using auto power range."
3956+
}
3957+
},
3958+
"description": "Manual radio settings for 5 GHz."
38643959
}
38653960
},
38663961
"example": {
3867-
"rfProfileId": "1234"
3962+
"rfProfileId": "1234",
3963+
"twoFourGhzSettings": {
3964+
"channel": 11,
3965+
"targetPower": 21
3966+
},
3967+
"fiveGhzSettings": {
3968+
"channel": 149,
3969+
"channelWidth": 20,
3970+
"targetPower": 15
3971+
}
38683972
}
38693973
}
38703974
}
@@ -3878,7 +3982,16 @@
38783982
"examples": {
38793983
"application/json": {
38803984
"serial": "Q234-ABCD-5678",
3881-
"rfProfileId": "1234"
3985+
"rfProfileId": "1234",
3986+
"twoFourGhzSettings": {
3987+
"channel": 11,
3988+
"targetPower": 21
3989+
},
3990+
"fiveGhzSettings": {
3991+
"channel": 149,
3992+
"channelWidth": 20,
3993+
"targetPower": 15
3994+
}
38823995
}
38833996
}
38843997
}
@@ -7776,7 +7889,7 @@
77767889
},
77777890
"/networks/{networkId}/appliance/trafficShaping/rules": {
77787891
"put": {
7779-
"description": "Update the traffic shaping settings for an MX network",
7892+
"description": "Update the traffic shaping settings rules for an MX network",
77807893
"operationId": "updateNetworkApplianceTrafficShapingRules",
77817894
"parameters": [
77827895
{
@@ -7994,7 +8107,7 @@
79948107
}
79958108
}
79968109
},
7997-
"summary": "Update the traffic shaping settings for an MX network",
8110+
"summary": "Update the traffic shaping settings rules for an MX network",
79988111
"tags": [
79998112
"appliance",
80008113
"configure",
@@ -8003,7 +8116,7 @@
80038116
]
80048117
},
80058118
"get": {
8006-
"description": "Display the traffic shaping settings for an MX network",
8119+
"description": "Display the traffic shaping settings rules for an MX network",
80078120
"operationId": "getNetworkApplianceTrafficShapingRules",
80088121
"parameters": [
80098122
{
@@ -8079,7 +8192,7 @@
80798192
}
80808193
}
80818194
},
8082-
"summary": "Display the traffic shaping settings for an MX network",
8195+
"summary": "Display the traffic shaping settings rules for an MX network",
80838196
"tags": [
80848197
"appliance",
80858198
"configure",
@@ -28479,6 +28592,10 @@
2847928592
"type": "string"
2848028593
},
2848128594
"description": "Accepts a list of tags for this SSID. If availableOnAllAps is false, then the SSID will only be broadcast by APs with tags matching any of the tags in this list."
28595+
},
28596+
"mandatoryDhcpEnabled": {
28597+
"type": "boolean",
28598+
"description": "If true, Mandatory DHCP will enforce that clients connecting to this SSID must use the IP address assigned by the DHCP server. Clients who use a static IP address won’t be able to associate."
2848228599
}
2848328600
},
2848428601
"example": {
@@ -34344,6 +34461,52 @@
3434434461
]
3434534462
}
3434634463
},
34464+
"/organizations/{organizationId}/inventoryDevices/{serial}": {
34465+
"get": {
34466+
"description": "Return a single device from the inventory of an organization",
34467+
"operationId": "getOrganizationInventoryDevice",
34468+
"parameters": [
34469+
{
34470+
"name": "organizationId",
34471+
"in": "path",
34472+
"type": "string",
34473+
"required": true
34474+
},
34475+
{
34476+
"name": "serial",
34477+
"in": "path",
34478+
"type": "string",
34479+
"required": true
34480+
}
34481+
],
34482+
"responses": {
34483+
"200": {
34484+
"description": "Successful operation",
34485+
"schema": {
34486+
"type": "object"
34487+
},
34488+
"examples": {
34489+
"application/json": {
34490+
"mac": "00:11:22:33:44:55",
34491+
"serial": "Q234-ABCD-5678",
34492+
"name": "My AP",
34493+
"model": "MR34",
34494+
"networkId": "N_24329156",
34495+
"orderNumber": "4C1234567",
34496+
"claimedAt": "2018-02-11T00:00:00.090210Z",
34497+
"licenseExpirationDate": "2020-05-02T10:52:44.012345Z"
34498+
}
34499+
}
34500+
}
34501+
},
34502+
"summary": "Return a single device from the inventory of an organization",
34503+
"tags": [
34504+
"organizations",
34505+
"configure",
34506+
"inventoryDevices"
34507+
]
34508+
}
34509+
},
3434734510
"/organizations/{organizationId}/licenses": {
3434834511
"get": {
3434934512
"description": "List the licenses for an organization",
@@ -37450,7 +37613,7 @@
3745037613
},
3745137614
{
3745237615
"group": "Traffic shaping settings",
37453-
"summary": "Update the traffic shaping settings for an MX network",
37616+
"summary": "Update the traffic shaping settings rules for an MX network",
3745437617
"resource": "/networks/{networkId}/appliance/trafficShaping/rules",
3745537618
"operation": "update"
3745637619
},

0 commit comments

Comments
 (0)