- What's Changed
- What's Updated
- [ licensing ]
- [ insight ]
- [ organizations ]
- [ devices ]
- [ appliance ]
- [ switch ]
- [ cellularGateway ]
- [ networks ]
- devices
- groupPolicies
- mqttBrokers
- netflow
- networkHealth
- pii
- List the keys required to access Personally Identifiable Information (PII) for a given identifier
- List the PII requests for this network or organization
- Return a PII request
- Given a piece of Personally Identifiable Information (PII), return the Systems Manager device ID(s) associated with that identifier
- Given a piece of Personally Identifiable Information (PII), return the Systems Manager owner ID(s) associated with that identifier
- snmp
- alerts
- splashLoginAttempts
- trafficAnalysis
- [ sensor ]
- [ sm ]
- [ wireless ]
- [ camera ]
- What's New
Version 1.44.0 to 1.45.0
Summary of Changes
6 - New
203 - Updated
700 - Total operations
454 - Total Paths
What's Changed
[ licensing ]
subscription
Get compliance status for requested subscriptions
GET /administered/licensing/subscription/subscriptions/compliance/statuses
- Param
organizationIdsbecame required
[ organizations ]
policyObjects
Creates a new Policy Object.
POST /organizations/{organizationId}/policyObjects
-
paths//organizations/{organizationId}/policyObjects/post/parameters/createOrganizationPolicyObject/schema/properties/groupIds- Array items type turn fromintegerto$s{rhs}
Updates a Policy Object.
PUT /organizations/{organizationId}/policyObjects/{policyObjectId}
-
paths//organizations/{organizationId}/policyObjects/{policyObjectId}/put/parameters/updateOrganizationPolicyObject/schema/properties/groupIds- Array items type turn fromintegerto$s{rhs}
[ switch ]
stacks
Create a switch stack
POST /networks/{networkId}/switch/stacks
- Response
201Deleted
routing
List multicast rendezvous points
GET /networks/{networkId}/switch/routing/multicast/rendezvousPoints
-
paths//networks/{networkId}/switch/routing/multicast/rendezvousPoints/get/responses/200/schema- Array items type turn fromarrayto$s{rhs}
Create a layer 3 static route for a switch
POST /devices/{serial}/switch/routing/staticRoutes
- Response
201Deleted
Update a layer 3 static route for a switch
PUT /devices/{serial}/switch/routing/staticRoutes/{staticRouteId}
- Response
200Deleted
[ global ]
service
PATH /networks/{networkId}/vlansEnabledState
- Deleted
What's Updated
[ licensing ]
subscription
List available subscriptions
GET /administered/licensing/subscription/subscriptions
- Optional property
typeAdded
- Response property
typevalue added
Claim a subscription into an organization.
POST /administered/licensing/subscription/subscriptions/claim
- Optional property
typeAdded
Find a subscription by claim key
POST /administered/licensing/subscription/subscriptions/claimKey/validate
- Optional property
typeAdded
[ insight ]
monitoredMediaServers
Return a monitored media server for this organization
GET /organizations/{organizationId}/insight/monitoredMediaServers/{monitoredMediaServerId}
- Response property
propertiesvalue added
[ organizations ]
clients
Return summary information around client data usage (in kb) across the given organization.
GET /organizations/{organizationId}/clients/overview
- Summary changed from
Return summary information around client data usage (in mb) across the given organization.toReturn summary information around client data usage (in kb) across the given organization.
Return the client details in an organization
GET /organizations/{organizationId}/clients/search
- Response property
propertiesvalue added
- Response property
urlvalue added
- Response property
recentDeviceMacvalue added
snmp
Return the SNMP settings for an organization
GET /organizations/{organizationId}/snmp
- Response property
propertiesvalue added
- Response property
v2CommunityStringvalue added
- Response property
v3Uservalue added
alerts
List all organization-wide alert configurations
GET /organizations/{organizationId}/alerts/profiles
- Response property
propertiesvalue added
Update an organization-wide alert config
PUT /organizations/{organizationId}/alerts/profiles/{alertConfigId}
- Description added:
WAN 1 high utilization
adaptivePolicy
List adaptive policy groups in a organization
GET /organizations/{organizationId}/adaptivePolicy/groups
- Response property
propertiesvalue added
Returns an adaptive policy group
GET /organizations/{organizationId}/adaptivePolicy/groups/{id}
- Response property
propertiesvalue added
List adaptive policies in an organization
GET /organizations/{organizationId}/adaptivePolicy/policies
- Response property
propertiesvalue added
Return an adaptive policy
GET /organizations/{organizationId}/adaptivePolicy/policies/{id}
- Response property
propertiesvalue added
Returns global adaptive policy settings in an organization
GET /organizations/{organizationId}/adaptivePolicy/settings
- Response property
propertiesvalue added
earlyAccess
List the early access feature opt-ins for an organization
GET /organizations/{organizationId}/earlyAccess/features/optIns
- Response property
propertiesvalue added
Show an early access feature opt-in for an organization
GET /organizations/{organizationId}/earlyAccess/features/optIns/{optInId}
- Response property
propertiesvalue added
policyObjects
Lists Policy Objects belonging to the organization.
GET /organizations/{organizationId}/policyObjects
- Response property
propertiesvalue added
Lists Policy Object Groups belonging to the organization.
GET /organizations/{organizationId}/policyObjects/groups
- Response property
propertiesvalue added
Shows details of a Policy Object Group.
GET /organizations/{organizationId}/policyObjects/groups/{policyObjectGroupId}
- Response property
propertiesvalue added
- Response property
createdAtvalue added
- Response property
updatedAtvalue added
Shows details of a Policy Object.
GET /organizations/{organizationId}/policyObjects/{policyObjectId}
- Response property
propertiesvalue added
- Response property
createdAtvalue added
- Response property
updatedAtvalue added
licenses
Return an overview of the license state for an organization
GET /organizations/{organizationId}/licenses/overview
- Response property
propertiesvalue added
- Response property
licenseCountvalue added
- Response property
statesvalue added
- Response property
licenseTypesvalue added
- Response property
systemsManagervalue added
samlRoles
List the SAML roles for this organization
GET /organizations/{organizationId}/samlRoles
- Optional property
cameraAdded
- Response property
cameravalue added
Return a SAML role
GET /organizations/{organizationId}/samlRoles/{samlRoleId}
- Optional property
cameraAdded
- Response property
cameravalue added
Update a SAML role
PUT /organizations/{organizationId}/samlRoles/{samlRoleId}
- Optional property
cameraAdded
[ devices ]
managementInterface
Return the management interface settings for a device
GET /devices/{serial}/managementInterface
- Response property
propertiesvalue added
- Response property
staticIpvalue added
- Response property
staticSubnetMaskvalue added
- Response property
staticGatewayIpvalue added
- Response property
staticDnsvalue added
uplinks
Get the uplink loss percentage and latency in milliseconds, and goodput in kilobits per second for MX, MG and Z devices.
GET /devices/{serial}/lossAndLatencyHistory
- Response property
propertiesvalue added
lldpCdp
List LLDP and CDP information for a device
GET /devices/{serial}/lldpCdp
- Response property
propertiesvalue added
- Response property
22value added
cellular
Return the SIM and APN configurations for a cellular device.
GET /devices/{serial}/cellular/sims
- Response property
propertiesvalue added
- Response property
passwordvalue added
- Response property
simOrderingvalue added
- Response property
simFailovervalue added
service
Return a single device
GET /devices/{serial}
- Response property
propertiesvalue added
- Response property
productTypevalue added
[ appliance ]
trafficShaping
List all custom performance classes for an MX network
GET /networks/{networkId}/appliance/trafficShaping/customPerformanceClasses
- Response property
propertiesvalue added
Return a custom performance class for an MX network
GET /networks/{networkId}/appliance/trafficShaping/customPerformanceClasses/{customPerformanceClassId}
- Response property
propertiesvalue added
Show uplink selection settings for an MX network
GET /networks/{networkId}/appliance/trafficShaping/uplinkSelection
- Optional property
applicationsAdded
- Response property
applicationsvalue added
Update uplink selection settings for an MX network
PUT /networks/{networkId}/appliance/trafficShaping/uplinkSelection
- Optional property
applicationsAdded
vlans
Returns the enabled status of VLANs for the network
GET /networks/{networkId}/appliance/vlans/settings
- Response property
propertiesvalue added
vpn
Return a Hub BGP Configuration
GET /networks/{networkId}/appliance/vpn/bgp
- Response property
propertiesvalue added
- Response property
ipv6value added
- Response property
sourceInterfacevalue added
- Response property
nextHopIpvalue added
- Response property
ttlSecurityvalue added
- Response property
authenticationvalue added
Show VPN status for networks in an organization
GET /organizations/{organizationId}/appliance/vpn/statuses
- Response property
propertiesvalue added
staticRoutes
List the static routes for an MX or teleworker network
GET /networks/{networkId}/appliance/staticRoutes
- Response property
propertiesvalue added
Return a static route for an MX or teleworker network
GET /networks/{networkId}/appliance/staticRoutes/{staticRouteId}
- Response property
propertiesvalue added
security
List the security events for a network
GET /networks/{networkId}/appliance/security/events
- Response property
additionalPropertiesvalue added
Returns all supported intrusion settings for an MX network
GET /networks/{networkId}/appliance/security/intrusion
- Response property
propertiesvalue added
Returns all supported malware settings for an MX network
GET /networks/{networkId}/appliance/security/malware
- Response property
propertiesvalue added
List the security events for an organization
GET /organizations/{organizationId}/appliance/security/events
- Response property
additionalPropertiesvalue added
firewall
List the appliance services and their accessibility rules
GET /networks/{networkId}/appliance/firewall/firewalledServices
- Response property
propertiesvalue added
Return the accessibility settings of the given service ('ICMP', 'web', or 'SNMP')
GET /networks/{networkId}/appliance/firewall/firewalledServices/{service}
- Response property
propertiesvalue added
Return the inbound cellular firewall rules for an MX network
GET /networks/{networkId}/appliance/firewall/inboundCellularFirewallRules
- Response property
propertiesvalue added
Return the port forwarding rules for an MX network
GET /networks/{networkId}/appliance/firewall/portForwardingRules
- Response property
propertiesvalue added
connectivityMonitoringDestinations
Return the connectivity testing destinations for an MX network
GET /networks/{networkId}/appliance/connectivityMonitoringDestinations
- Response property
propertiesvalue added
clients
List the security events for a client
GET /networks/{networkId}/appliance/clients/{clientId}/security/events
- Response property
additionalPropertiesvalue added
warmSpare
Return MX warm spare settings
GET /networks/{networkId}/appliance/warmSpare
- Response property
propertiesvalue added
uplinks
List the uplink status of every Meraki MX and Z series appliances in the organization
GET /organizations/{organizationId}/appliance/uplink/statuses
- Response property
propertiesvalue added
performance
Return the performance score for a single MX
GET /devices/{serial}/appliance/performance
- Optional param
t0added
- Optional param
t1added
- Optional param
timespanadded
[ switch ]
warmSpare
Return warm spare configuration for a switch
GET /devices/{serial}/switch/warmSpare
- Response property
propertiesvalue added
accessPolicies
List the access policies for a switch network
GET /networks/{networkId}/switch/accessPolicies
- Optional property
organizationRadiusServerIdAdded
- Optional property
organizationRadiusServerIdAdded
- Response property
organizationRadiusServerIdvalue added
- Response property
organizationRadiusServerIdvalue added
Return a specific access policy for a switch network
GET /networks/{networkId}/switch/accessPolicies/{accessPolicyNumber}
- Optional property
organizationRadiusServerIdAdded
- Optional property
organizationRadiusServerIdAdded
- Response property
organizationRadiusServerIdvalue added
- Response property
organizationRadiusServerIdvalue added
Create an access policy for a switch network
POST /networks/{networkId}/switch/accessPolicies
- Optional property
organizationRadiusServerIdAdded
- Optional property
organizationRadiusServerIdAdded
- Optional property
organizationRadiusServerIdAdded
- Optional property
organizationRadiusServerIdAdded
Update an access policy for a switch network
PUT /networks/{networkId}/switch/accessPolicies/{accessPolicyNumber}
- Optional property
organizationRadiusServerIdAdded
- Optional property
organizationRadiusServerIdAdded
- Optional property
organizationRadiusServerIdAdded
- Optional property
organizationRadiusServerIdAdded
ports
Return the status for all the ports of a switch
GET /devices/{serial}/switch/ports/statuses
- Optional property
poeAdded
- Response property
poevalue added
Return the packet counters for all the ports of a switch
GET /devices/{serial}/switch/ports/statuses/packets
- Response property
propertiesvalue added
dhcpServerPolicy
Return the DHCP server settings
GET /networks/{networkId}/switch/dhcpServerPolicy
- Optional property
unsupportedModelsAdded
- Response property
unsupportedModelsvalue added
linkAggregations
List link aggregation groups
GET /networks/{networkId}/switch/linkAggregations
- Response property
propertiesvalue added
qosRules
List quality of service rules
GET /networks/{networkId}/switch/qosRules
- Response property
propertiesvalue added
Return the quality of service rule IDs by order in which they will be processed by the switch
GET /networks/{networkId}/switch/qosRules/order
- Response property
propertiesvalue added
stp
Returns STP settings
GET /networks/{networkId}/switch/stp
- Response property
propertiesvalue added
- Response property
stacksvalue added
- Response property
switchProfilesvalue added
stacks
List layer 3 interfaces for a switch stack
GET /networks/{networkId}/switch/stacks/{switchStackId}/routing/interfaces
- Response property
propertiesvalue added
Return a layer 3 interface from a switch stack
GET /networks/{networkId}/switch/stacks/{switchStackId}/routing/interfaces/{interfaceId}
- Response property
propertiesvalue added
Return a layer 3 interface DHCP configuration for a switch stack
GET /networks/{networkId}/switch/stacks/{switchStackId}/routing/interfaces/{interfaceId}/dhcp
- Optional property
dhcpRelayServerIpsAdded
- Response property
dhcpRelayServerIpsvalue added
List layer 3 static routes for a switch stack
GET /networks/{networkId}/switch/stacks/{switchStackId}/routing/staticRoutes
- Response property
propertiesvalue added
Return a layer 3 static route for a switch stack
GET /networks/{networkId}/switch/stacks/{switchStackId}/routing/staticRoutes/{staticRouteId}
- Response property
propertiesvalue added
Create a switch stack
POST /networks/{networkId}/switch/stacks
- Response property
200value added
- Summary changed from
Create a stacktoCreate a switch stack
routing
Return a layer 3 interface DHCP configuration for a switch
GET /devices/{serial}/switch/routing/interfaces/{interfaceId}/dhcp
- Response property
propertiesvalue added
- Response property
dhcpRelayServerIpsvalue added
List layer 3 static routes for a switch
GET /devices/{serial}/switch/routing/staticRoutes
- Response property
propertiesvalue added
List multicast rendezvous points
GET /networks/{networkId}/switch/routing/multicast/rendezvousPoints
- Response property
propertiesvalue added
Return a multicast rendezvous point
GET /networks/{networkId}/switch/routing/multicast/rendezvousPoints/{rendezvousPointId}
- Response property
propertiesvalue added
Return layer 3 OSPF routing configuration
GET /networks/{networkId}/switch/routing/ospf
- Response property
propertiesvalue added
Create a layer 3 static route for a switch
POST /devices/{serial}/switch/routing/staticRoutes
- Response property
200value added
Update a layer 3 static route for a switch
PUT /devices/{serial}/switch/routing/staticRoutes/{staticRouteId}
- Response property
201value added
[ cellularGateway ]
uplink
Returns the uplink settings for your MG network.
GET /networks/{networkId}/cellularGateway/uplink
- Response property
propertiesvalue added
connectivityMonitoringDestinations
Return the connectivity testing destinations for an MG network
GET /networks/{networkId}/cellularGateway/connectivityMonitoringDestinations
- Response property
propertiesvalue added
portForwardingRules
Returns the port forwarding rules for a single MG.
GET /devices/{serial}/cellularGateway/portForwardingRules
- Response property
propertiesvalue added
- Response property
allowedIpsvalue added
lan
Show the LAN Settings of a MG
GET /devices/{serial}/cellularGateway/lan
- Response property
propertiesvalue added
subnetPool
Return the subnet pool and mask configured for MGs in the network.
GET /networks/{networkId}/cellularGateway/subnetPool
- Response property
propertiesvalue added
[ networks ]
devices
List the devices in a network
GET /networks/{networkId}/devices
- Response property
propertiesvalue added
- Response property
productTypevalue added
Claim devices into a network. (Note: for recently claimed devices, it may take a few minutes for API requests against that device to succeed)
POST /networks/{networkId}/devices/claim
- Summary changed from
Claim devices into a network. (Note: for recently claimed devices, it may take a few minutes for API requsts against that device to succeed)toClaim devices into a network. (Note: for recently claimed devices, it may take a few minutes for API requests against that device to succeed)
groupPolicies
List the group policies in a network
GET /networks/{networkId}/groupPolicies
- Response property
propertiesvalue added
- Response property
priorityvalue added
Display a group policy
GET /networks/{networkId}/groupPolicies/{groupPolicyId}
- Response property
propertiesvalue added
- Response property
priorityvalue added
Delete a group policy
DELETE /networks/{networkId}/groupPolicies/{groupPolicyId}
- Optional param
forceadded
mqttBrokers
List the MQTT brokers for this network
GET /networks/{networkId}/mqttBrokers
- Response property
propertiesvalue added
Return an MQTT broker
GET /networks/{networkId}/mqttBrokers/{mqttBrokerId}
- Response property
propertiesvalue added
Add an MQTT broker
POST /networks/{networkId}/mqttBrokers
- Property
securityDeleted
- Optional property
tlsAdded
Update an MQTT broker
PUT /networks/{networkId}/mqttBrokers/{mqttBrokerId}
- Property
securityDeleted
- Optional property
tlsAdded
netflow
Return the NetFlow traffic reporting settings for a network
GET /networks/{networkId}/netflow
- Response property
propertiesvalue added
networkHealth
Get the channel utilization over each radio for all APs in a network.
GET /networks/{networkId}/networkHealth/channelUtilization
- Response property
propertiesvalue added
pii
List the keys required to access Personally Identifiable Information (PII) for a given identifier
GET /networks/{networkId}/pii/piiKeys
- Response property
additionalPropertiesvalue added
List the PII requests for this network or organization
GET /networks/{networkId}/pii/requests
- Response property
propertiesvalue added
Return a PII request
GET /networks/{networkId}/pii/requests/{requestId}
- Response property
propertiesvalue added
Given a piece of Personally Identifiable Information (PII), return the Systems Manager device ID(s) associated with that identifier
GET /networks/{networkId}/pii/smDevicesForKey
- Response property
additionalPropertiesvalue added
Given a piece of Personally Identifiable Information (PII), return the Systems Manager owner ID(s) associated with that identifier
GET /networks/{networkId}/pii/smOwnersForKey
- Response property
additionalPropertiesvalue added
snmp
Return the SNMP settings for a network
GET /networks/{networkId}/snmp
- Response property
propertiesvalue added
- Response property
communityStringvalue added
alerts
Return the alert configuration for this network
GET /networks/{networkId}/alerts/settings
- Response property
propertiesvalue added
- Response property
conditionsvalue added
- Response property
failureTypevalue added
- Response property
lookbackWindowvalue added
- Response property
minDurationvalue added
- Response property
namevalue added
- Response property
periodvalue added
- Response property
priorityvalue added
- Response property
regexvalue added
- Response property
selectorvalue added
- Response property
serialsvalue added
- Response property
ssidNumvalue added
- Response property
tagvalue added
- Response property
thresholdvalue added
- Response property
mutingvalue added
splashLoginAttempts
List the splash login attempts for a network
GET /networks/{networkId}/splashLoginAttempts
- Response property
propertiesvalue added
trafficAnalysis
Return the traffic analysis settings for a network
GET /networks/{networkId}/trafficAnalysis
- Response property
propertiesvalue added
[ sensor ]
alerts
Lists all sensor alert profiles for a network.
GET /networks/{networkId}/sensor/alerts/profiles
- Response property
enumvalue added
Show details of a sensor alert profile for a network.
GET /networks/{networkId}/sensor/alerts/profiles/{id}
- Response property
enumvalue added
[ sm ]
devices
List the restrictions on a device
GET /networks/{networkId}/sm/devices/{deviceId}/restrictions
- Response property
propertiesvalue added
targetGroups
List the target groups in this network
GET /networks/{networkId}/sm/targetGroups
- Response property
propertiesvalue added
- Response property
idvalue added
Return a target group
GET /networks/{networkId}/sm/targetGroups/{targetGroupId}
- Response property
propertiesvalue added
- Response property
idvalue added
[ wireless ]
clients
Aggregated connectivity info for a given client on this network
GET /networks/{networkId}/wireless/clients/{clientId}/connectionStats
- Response property
propertiesvalue added
List the wireless connectivity events for a client within a network in the timespan.
GET /networks/{networkId}/wireless/clients/{clientId}/connectivityEvents
- Response property
propertiesvalue added
Return the latency history for a client
GET /networks/{networkId}/wireless/clients/{clientId}/latencyHistory
- Response property
propertiesvalue added
meshStatuses
List wireless mesh statuses for repeaters
GET /networks/{networkId}/wireless/meshStatuses
- Response property
itemsvalue added
ssids
List the Bonjour forwarding setting and rules for the SSID
GET /networks/{networkId}/wireless/ssids/{number}/bonjourForwarding
- Response property
propertiesvalue added
Return the L3 firewall rules for an SSID on an MR network
GET /networks/{networkId}/wireless/ssids/{number}/firewall/l3FirewallRules
- Response property
propertiesvalue added
Return the L7 firewall rules for an SSID on an MR network
GET /networks/{networkId}/wireless/ssids/{number}/firewall/l7FirewallRules
- Response property
propertiesvalue added
List the outage schedule for the SSID
GET /networks/{networkId}/wireless/ssids/{number}/schedules
- Response property
propertiesvalue added
- Response property
rangesInSecondsvalue added
[ camera ]
wirelessProfiles
List the camera wireless profiles for this network.
GET /networks/{networkId}/camera/wirelessProfiles
- Response property
propertiesvalue added
- Response property
pskvalue added
Retrieve a single camera wireless profile.
GET /networks/{networkId}/camera/wirelessProfiles/{wirelessProfileId}
- Response property
propertiesvalue added
- Response property
pskvalue added
customAnalytics
Return custom analytics settings for a camera
GET /devices/{serial}/camera/customAnalytics
- Response property
propertiesvalue added
List Custom Analytics Artifacts
GET /organizations/{organizationId}/camera/customAnalytics/artifacts
- Response property
propertiesvalue added
Get Custom Analytics Artifact
GET /organizations/{organizationId}/camera/customAnalytics/artifacts/{artifactId}
- Response property
propertiesvalue added
analytics
Returns live state from camera analytics zones
GET /devices/{serial}/camera/analytics/live
- Response property
propertiesvalue added
- Response property
zoneIdvalue added
- Summary changed from
Returns live state from camera of analytics zonestoReturns live state from camera analytics zones
Returns an overview of aggregate analytics data for a timespan
GET /devices/{serial}/camera/analytics/overview
- Response property
propertiesvalue added
Returns most recent record for analytics zones
GET /devices/{serial}/camera/analytics/recent
- Response property
propertiesvalue added
Returns all configured analytic zones for this camera
GET /devices/{serial}/camera/analytics/zones
- Response property
propertiesvalue added
Return historical records for analytic zones
GET /devices/{serial}/camera/analytics/zones/{zoneId}/history
- Response property
propertiesvalue added
What's New
[ appliance ]
sdwan
PATH /networks/{networkId}/appliance/sdwan/internetPolicies
- Path added
- New operation
Update SDWAN internet traffic preferences for an MX network
PUT
/networks/{networkId}/appliance/sdwan/internetPolicies{ "wanTrafficUplinkPreferences": [ { "preferredUplink": "wan1", "failOverCriterion": "poorPerformance", "performanceClass": { "type": "custom", "builtinPerformanceClassName": "VoIP", "customPerformanceClassId": "123456" }, "trafficFilters": [ { "type": "custom", "value": { "protocol": "tcp", "source": { "port": "1-1024", "cidr": "192.168.1.0/24", "vlan": 10, "host": 254 }, "destination": { "port": "any", "cidr": "any", "applications": [ { "id": "meraki:layer7/application/3", "name": "DNS", "type": "major" } ] } } } ] } ] }
[ switch ]
ports
PATH /organizations/{organizationId}/switch/ports/overview
- Path added
- New operation
Returns the counts of all active ports for the requested timespan, grouped by speed. An active port is a port that at any point during the timeframe is observed to be connected to a responsive device and isn't configured to be disabled. For a port that is observed at multiple speeds during the timeframe, it will be counted at the highest speed observed. The number of inactive ports, and the total number of ports are also provided. Only ports on switches online during the timeframe will be represented and a port is only guaranteed to be present if its switch was online for at least 6 hours of the timeframe.
GET
/organizations/{organizationId}/switch/ports/overview{ "counts": { "total": 120, "byStatus": { "active": { "total": 87, "byMediaAndLinkSpeed": { "rj45": { "10": 0, "100": 0, "1000": 24, "2500": 0, "5000": 0, "10000": 0, "total": 24 }, "sfp": { "100": 8, "1000": 40, "10000": 10, "20000": 0, "25000": 0, "40000": 1, "50000": 0, "100000": 0, "total": 63 } } }, "inactive": { "total": 33, "byMedia": { "rj45": { "total": 16 }, "sfp": { "total": 17 } } } } } }
[ sensor ]
commands
PATH /devices/{serial}/sensor/commands
- Path added
- New operation
Returns a historical log of all commands
GET
/devices/{serial}/sensor/commands[ { "commandId": "1284392014819", "createdAt": "2018-02-11T00:00:00Z", "completedAt": "2018-05-12T00:00:00Z", "createdBy": { "adminId": "212406", "name": "Miles Meraki", "email": "miles@meraki.com" }, "operation": "disableDownstreamPower", "status": "completed", "errors": [] } ]
- New operation
Sends a command to a sensor
POST
/devices/{serial}/sensor/commands{ "commandId": "1284392014819", "createdAt": "2018-02-11T00:00:00Z", "completedAt": "2018-05-12T00:00:00Z", "createdBy": { "adminId": "212406", "name": "Miles Meraki", "email": "miles@meraki.com" }, "operation": "disableDownstreamPower", "status": "completed", "errors": [] }
PATH /devices/{serial}/sensor/commands/{commandId}
- Path added
- New operation
Returns information about the command's execution, including the status
GET
/devices/{serial}/sensor/commands/{commandId}{ "commandId": "1284392014819", "createdAt": "2018-02-11T00:00:00Z", "completedAt": "2018-05-12T00:00:00Z", "createdBy": { "adminId": "212406", "name": "Miles Meraki", "email": "miles@meraki.com" }, "operation": "disableDownstreamPower", "status": "completed", "errors": [] }
[ wireless ]
ssids
PATH /organizations/{organizationId}/wireless/ssids/statuses/byDevice
- Path added
- New operation
List status information of all BSSIDs in your organization
GET
/organizations/{organizationId}/wireless/ssids/statuses/byDevice{ "items": [ { "serial": "QQ3A-QHWY-DQ2Z", "name": "My AP", "network": { "id": "N_24329156", "name": "Main Office" }, "basicServiceSets": [ { "bssid": "8A:15:04:00:00:00", "ssid": { "name": "My SSID", "number": 0, "enabled": true, "advertised": true }, "radio": { "band": "2.4", "channel": 11, "channelWidth": 20, "power": 18, "isBroadcasting": true, "index": "0" } } ] } ], "meta": { "counts": { "items": { "total": 1738, "remaining": 1238 } } } }
rfProfiles
PATH /organizations/{organizationId}/wireless/rfProfiles/assignments/byDevice
- Path added
- New operation
List the RF profiles of an organization by device
GET
/organizations/{organizationId}/wireless/rfProfiles/assignments/byDevice[ { "items": [ { "network": { "id": "1234" }, "name": "Device_name", "serial": "Q234-ABCD-0001", "model": "MR34", "rfProfile": { "id": "123456", "name": "Basic Outdoor Profile", "isIndoorDefault": false, "isOutdoorDefault": true } } ], "meta": { "counts": { "items": { "total": 1200, "remaining": 200 } } } } ]