Skip to content

Commit bd31186

Browse files
author
Meraki
committed
API version 1.0.0-beta.19
1 parent 6ca03c4 commit bd31186

File tree

1 file changed

+125
-38
lines changed

1 file changed

+125
-38
lines changed

‎openapi/spec2.json

Lines changed: 125 additions & 38 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.18",
4+
"version": "1.0.0-beta.19",
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: 19 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: 26 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",
@@ -17773,34 +17773,49 @@
1777317773
"required": true
1777417774
},
1777517775
{
17776-
"type": "string",
17776+
"type": "array",
17777+
"items": {
17778+
"type": "string"
17779+
},
1777717780
"name": "fields",
1777817781
"in": "query",
17779-
"description": "Additional fields that will be displayed for each device. Multiple fields can be passed in as comma separated values.\n The default fields are: id, name, tags, ssid, wifiMac, osName, systemModel, uuid, and serialNumber. The additional fields are: ip,\n systemType, availableDeviceCapacity, kioskAppName, biosVersion, lastConnected, missingAppsCount, userSuppliedAddress, location, lastUser,\n ownerEmail, ownerUsername, osBuild, publicIp, phoneNumber, diskInfoJson, deviceCapacity, isManaged, hadMdm, isSupervised, meid, imei, iccid,\n simCarrierNetwork, cellularDataUsed, isHotspotEnabled, createdAt, batteryEstCharge, quarantined, avName, avRunning, asName, fwName,\n isRooted, loginRequired, screenLockEnabled, screenLockDelay, autoLoginDisabled, autoTags, hasMdm, hasDesktopAgent, diskEncryptionEnabled,\n hardwareEncryptionCaps, passCodeLock, usesHardwareKeystore, and androidSecurityPatchVersion."
17782+
"description": "Additional fields that will be displayed for each device.\n The default fields are: id, name, tags, ssid, wifiMac, osName, systemModel, uuid, and serialNumber. The additional fields are: ip,\n systemType, availableDeviceCapacity, kioskAppName, biosVersion, lastConnected, missingAppsCount, userSuppliedAddress, location, lastUser,\n ownerEmail, ownerUsername, osBuild, publicIp, phoneNumber, diskInfoJson, deviceCapacity, isManaged, hadMdm, isSupervised, meid, imei, iccid,\n simCarrierNetwork, cellularDataUsed, isHotspotEnabled, createdAt, batteryEstCharge, quarantined, avName, avRunning, asName, fwName,\n isRooted, loginRequired, screenLockEnabled, screenLockDelay, autoLoginDisabled, autoTags, hasMdm, hasDesktopAgent, diskEncryptionEnabled,\n hardwareEncryptionCaps, passCodeLock, usesHardwareKeystore, and androidSecurityPatchVersion."
1778017783
},
1778117784
{
17782-
"type": "string",
17785+
"type": "array",
17786+
"items": {
17787+
"type": "string"
17788+
},
1778317789
"name": "wifiMacs",
1778417790
"in": "query",
17785-
"description": "Filter devices by wifi mac(s). Multiple wifi macs can be passed in as comma separated values."
17791+
"description": "Filter devices by wifi mac(s)."
1778617792
},
1778717793
{
17788-
"type": "string",
17794+
"type": "array",
17795+
"items": {
17796+
"type": "string"
17797+
},
1778917798
"name": "serials",
1779017799
"in": "query",
17791-
"description": "Filter devices by serial(s). Multiple serials can be passed in as comma separated values."
17800+
"description": "Filter devices by serial(s)."
1779217801
},
1779317802
{
17794-
"type": "string",
17803+
"type": "array",
17804+
"items": {
17805+
"type": "string"
17806+
},
1779517807
"name": "ids",
1779617808
"in": "query",
17797-
"description": "Filter devices by id(s). Multiple ids can be passed in as comma separated values."
17809+
"description": "Filter devices by id(s)."
1779817810
},
1779917811
{
17800-
"type": "string",
17812+
"type": "array",
17813+
"items": {
17814+
"type": "string"
17815+
},
1780117816
"name": "scope",
1780217817
"in": "query",
17803-
"description": "Specify a scope (one of all, none, withAny, withAll, withoutAny, or withoutAll) and a set of tags as comma separated values."
17818+
"description": "Specify a scope (one of all, none, withAny, withAll, withoutAny, or withoutAll) and a set of tags."
1780417819
},
1780517820
{
1780617821
"type": "integer",
@@ -17880,19 +17895,31 @@
1788017895
"type": "object",
1788117896
"properties": {
1788217897
"wifiMacs": {
17883-
"type": "string",
17898+
"type": "array",
17899+
"items": {
17900+
"type": "string"
17901+
},
1788417902
"description": "The wifiMacs of the devices to be checked-in."
1788517903
},
1788617904
"ids": {
17887-
"type": "string",
17905+
"type": "array",
17906+
"items": {
17907+
"type": "string"
17908+
},
1788817909
"description": "The ids of the devices to be checked-in."
1788917910
},
1789017911
"serials": {
17891-
"type": "string",
17912+
"type": "array",
17913+
"items": {
17914+
"type": "string"
17915+
},
1789217916
"description": "The serials of the devices to be checked-in."
1789317917
},
1789417918
"scope": {
17895-
"type": "string",
17919+
"type": "array",
17920+
"items": {
17921+
"type": "string"
17922+
},
1789617923
"description": "The scope (one of all, none, withAny, withAll, withoutAny, or withoutAll) and a set of tags of the devices to be checked-in."
1789717924
}
1789817925
},
@@ -18025,19 +18052,31 @@
1802518052
"type": "object",
1802618053
"properties": {
1802718054
"wifiMacs": {
18028-
"type": "string",
18055+
"type": "array",
18056+
"items": {
18057+
"type": "string"
18058+
},
1802918059
"description": "The wifiMacs of the devices to be locked."
1803018060
},
1803118061
"ids": {
18032-
"type": "string",
18062+
"type": "array",
18063+
"items": {
18064+
"type": "string"
18065+
},
1803318066
"description": "The ids of the devices to be locked."
1803418067
},
1803518068
"serials": {
18036-
"type": "string",
18069+
"type": "array",
18070+
"items": {
18071+
"type": "string"
18072+
},
1803718073
"description": "The serials of the devices to be locked."
1803818074
},
1803918075
"scope": {
18040-
"type": "string",
18076+
"type": "array",
18077+
"items": {
18078+
"type": "string"
18079+
},
1804118080
"description": "The scope (one of all, none, withAny, withAll, withoutAny, or withoutAll) and a set of tags of the devices to be wiped."
1804218081
},
1804318082
"pin": {
@@ -18090,23 +18129,38 @@
1809018129
"type": "object",
1809118130
"properties": {
1809218131
"wifiMacs": {
18093-
"type": "string",
18132+
"type": "array",
18133+
"items": {
18134+
"type": "string"
18135+
},
1809418136
"description": "The wifiMacs of the devices to be modified."
1809518137
},
1809618138
"ids": {
18097-
"type": "string",
18139+
"type": "array",
18140+
"items": {
18141+
"type": "string"
18142+
},
1809818143
"description": "The ids of the devices to be modified."
1809918144
},
1810018145
"serials": {
18101-
"type": "string",
18146+
"type": "array",
18147+
"items": {
18148+
"type": "string"
18149+
},
1810218150
"description": "The serials of the devices to be modified."
1810318151
},
1810418152
"scope": {
18105-
"type": "string",
18153+
"type": "array",
18154+
"items": {
18155+
"type": "string"
18156+
},
1810618157
"description": "The scope (one of all, none, withAny, withAll, withoutAny, or withoutAll) and a set of tags of the devices to be modified."
1810718158
},
1810818159
"tags": {
18109-
"type": "string",
18160+
"type": "array",
18161+
"items": {
18162+
"type": "string"
18163+
},
1811018164
"description": "The tags to be added, deleted, or updated."
1811118165
},
1811218166
"updateAction": {
@@ -18117,7 +18171,10 @@
1811718171
"example": {
1811818172
"scope": "withAny, old_tag",
1811918173
"updateAction": "add",
18120-
"tags": "tag1,tag2"
18174+
"tags": [
18175+
"tag1",
18176+
"tag2"
18177+
]
1812118178
},
1812218179
"required": [
1812318180
"tags",
@@ -18174,19 +18231,31 @@
1817418231
"type": "object",
1817518232
"properties": {
1817618233
"wifiMacs": {
18177-
"type": "string",
18234+
"type": "array",
18235+
"items": {
18236+
"type": "string"
18237+
},
1817818238
"description": "The wifiMacs of the devices to be moved."
1817918239
},
1818018240
"ids": {
18181-
"type": "string",
18241+
"type": "array",
18242+
"items": {
18243+
"type": "string"
18244+
},
1818218245
"description": "The ids of the devices to be moved."
1818318246
},
1818418247
"serials": {
18185-
"type": "string",
18248+
"type": "array",
18249+
"items": {
18250+
"type": "string"
18251+
},
1818618252
"description": "The serials of the devices to be moved."
1818718253
},
1818818254
"scope": {
18189-
"type": "string",
18255+
"type": "array",
18256+
"items": {
18257+
"type": "string"
18258+
},
1819018259
"description": "The scope (one of all, none, withAny, withAll, withoutAny, or withoutAll) and a set of tags of the devices to be moved."
1819118260
},
1819218261
"newNetwork": {
@@ -19354,28 +19423,40 @@
1935419423
"required": true
1935519424
},
1935619425
{
19357-
"type": "string",
19426+
"type": "array",
19427+
"items": {
19428+
"type": "string"
19429+
},
1935819430
"name": "ids",
1935919431
"in": "query",
19360-
"description": "Filter users by id(s). Multiple ids can be passed in as comma separated values."
19432+
"description": "Filter users by id(s)."
1936119433
},
1936219434
{
19363-
"type": "string",
19435+
"type": "array",
19436+
"items": {
19437+
"type": "string"
19438+
},
1936419439
"name": "usernames",
1936519440
"in": "query",
19366-
"description": "Filter users by username(s). Multiple usernames can be passed in as comma separated values."
19441+
"description": "Filter users by username(s)."
1936719442
},
1936819443
{
19369-
"type": "string",
19444+
"type": "array",
19445+
"items": {
19446+
"type": "string"
19447+
},
1937019448
"name": "emails",
1937119449
"in": "query",
19372-
"description": "Filter users by email(s). Multiple emails can be passed in as comma separated values."
19450+
"description": "Filter users by email(s)."
1937319451
},
1937419452
{
19375-
"type": "string",
19453+
"type": "array",
19454+
"items": {
19455+
"type": "string"
19456+
},
1937619457
"name": "scope",
1937719458
"in": "query",
19378-
"description": "Specifiy a scope (one of all, none, withAny, withAll, withoutAny, withoutAll) and a set of tags as comma separated values."
19459+
"description": "Specifiy a scope (one of all, none, withAny, withAll, withoutAny, withoutAll) and a set of tags."
1937919460
}
1938019461
],
1938119462
"responses": {
@@ -34531,6 +34612,12 @@
3453134612
"name": "usedState",
3453234613
"in": "query",
3453334614
"description": "Filter results by used or unused inventory. Accepted values are \"used\" or \"unused\"."
34615+
},
34616+
{
34617+
"type": "string",
34618+
"name": "search",
34619+
"in": "query",
34620+
"description": "Search for devices in inventory based on serial number, mac address, or model."
3453434621
}
3453534622
],
3453634623
"responses": {

0 commit comments

Comments
 (0)