v1.70.0-beta.0

• Added
  • [ campusGateway ]
    • clusters
      • Delete a cluster
  • [ devices ]
    • appliance
      • Update configurations for an appliance's specified port
    • cellular
      • Update the cellular band masks for a device
  • [ organizations ]
    • assurance
      • Return combined wireless and wired connected client counts over time for a network.
    • campusGateway
      • List the details of a Failover Targets for a Campus Gateway cluster
      • Get available backup cluster targets for campus gateway failover configuration
      • List networks tunneling through Campus Gateway clusters with their AP, ssids and client counts
      • Provisions a cluster,adds campus gateways to it and associate/dissociate failover targets.
      • List SSIDs tunneling through Campus Gateway clusters
      • List the details of APs tunneling through the Campus Gateway clusters
      • List the count of connections(APs) with tunneling status up and down through the Campus Gateway clusters
    • devices
      • Assign devices to a Cellular Data Management Profile in batch
• Changed
  • [ appliance ]
    • firewall
      • Return the firewall settings for this network
      • Update the firewall settings for this network
    • interfaces
      • Create wired L3 interface configuration
      • Update wired L3 interface configuration
  • [ devices ]
    • appliance
      • Update configurations for an appliance's specified port
    • cellular
    • switch
      • Cycle a set of switch ports on non-Catalyst MS devices
    • syslog
      • Updates the syslog servers configuration for a network.
  • [ networks ]
    • general
      • Return a network
      • Update a network
  • [ organizations ]
    • appliance
      • Listing of L3 Interface Configurations across networks for the organization
      • Returns port configurations for appliances in a given organization
    • assurance
      • Return all health alerts for an organization
      • Return overview of active health alerts for an organization
      • Return a Summary of Alerts grouped by network and severity
      • Return a Summary of Alerts grouped by type and severity
      • Returns historical health alert overviews
      • Return a list of alert types
      • Summarizes wireless post connection capacity successes and failures by network.
      • Summarizes wireless post connection capacity successes and failures by device.
      • Summarizes wireless post connection capacity successes and failures by ssid.
      • Summarizes wireless coverage successes and failures by client.
      • Summarizes wireless coverage successes and failures by device.
      • Summarizes wireless coverage successes and failures by SSID.
    • devices
      • List devices eligible for Cellular Data Management profile assignment in this organization
      • Add a cellular data management profile to this organization
      • List Cellular Data Management Profile assignments in this organization
      • Unassign devices from a Cellular Data Management Profile in batch
      • Update a Cellular Data Management Profile
      • List current cellular data usage for devices in this organization
      • List historical cellular data usage grouped by device and interval in this organization
      • Returns syslog servers configured for the networks within an organization.
      • Returns roles that can be assigned to a syslog server for a given network.
    • networks
      • List the networks that the user has privileges on in an organization
      • Create a network
      • Combine multiple networks into a single network
  • [ snmp ]
    • general
      • Return the SNMP settings for a network
      • Update the SNMP settings for a network
  • [ split ]
    • general
      • Split a combined network into individual networks for each type of device
  • [ unbind ]
    • general
      • Unbind a network from a template.

Version v1.69.0-beta.4 to v1.70.0-beta.0

Summary of Changes

12 - New

42 - Updated

862 - Total Endpoints

586 - Total Paths

Added

[ campusGateway ]

clusters

Docs

Delete a cluster

Operation ID: deleteNetworkCampusGatewayCluster

PATH /networks/{networkId}/campusGateway/clusters/{clusterId}

- Path added

- New endpoint

DELETE /networks/{networkId}/campusGateway/clusters/{clusterId}

---

[ devices ]

appliance

Docs

Update configurations for an appliance's specified port

Operation ID: createDeviceApplianceInterfacesPortsUpdate

PATH /devices/{serial}/appliance/interfaces/ports/update

- Path added

- New endpoint

POST /devices/{serial}/appliance/interfaces/ports/update

---

cellular

Docs

Update the cellular band masks for a device

Operation ID: createDeviceCellularUplinksBandsMasksUpdate

PATH /devices/{serial}/cellular/uplinks/bands/masks/update

- Path added

- New endpoint

POST /devices/{serial}/cellular/uplinks/bands/masks/update

---

[ organizations ]

assurance

Docs

Return combined wireless and wired connected client counts over time for a network.

Operation ID: getOrganizationAssuranceClientsConnectedCountHistory

PATH /organizations/{organizationId}/assurance/clients/connectedCountHistory

- Path added

- New endpoint

GET /organizations/{organizationId}/assurance/clients/connectedCountHistory

---

campusGateway

Docs

List the details of a Failover Targets for a Campus Gateway cluster

Operation ID: getOrganizationCampusGatewayClustersFailoverTargets

PATH /organizations/{organizationId}/campusGateway/clusters/failover/targets

- Path added

- New endpoint

GET /organizations/{organizationId}/campusGateway/clusters/failover/targets

---

Docs

Get available backup cluster targets for campus gateway failover configuration

Operation ID: getOrganizationCampusGatewayClustersFailoverTargetsByCluster

PATH /organizations/{organizationId}/campusGateway/clusters/failover/targets/byCluster

- Path added

- New endpoint

GET /organizations/{organizationId}/campusGateway/clusters/failover/targets/byCluster

---

Docs

List networks tunneling through Campus Gateway clusters with their AP, ssids and client counts

Operation ID: getOrganizationCampusGatewayClustersNetworksOverviews

PATH /organizations/{organizationId}/campusGateway/clusters/networks/overviews

- Path added

- New endpoint

GET /organizations/{organizationId}/campusGateway/clusters/networks/overviews

---

Docs

Provisions a cluster,adds campus gateways to it and associate/dissociate failover targets.

Operation ID: provisionOrganizationCampusGatewayClusters

PATH /organizations/{organizationId}/campusGateway/clusters/provision

- Path added

- New endpoint

POST /organizations/{organizationId}/campusGateway/clusters/provision

---

Docs

List SSIDs tunneling through Campus Gateway clusters

Operation ID: getOrganizationCampusGatewayClustersSsids

PATH /organizations/{organizationId}/campusGateway/clusters/ssids

- Path added

- New endpoint

GET /organizations/{organizationId}/campusGateway/clusters/ssids

---

Docs

List the details of APs tunneling through the Campus Gateway clusters

Operation ID: getOrganizationCampusGatewayConnections

PATH /organizations/{organizationId}/campusGateway/connections

- Path added

- New endpoint

GET /organizations/{organizationId}/campusGateway/connections

---

Docs

List the count of connections(APs) with tunneling status up and down through the Campus Gateway clusters

Operation ID: getOrganizationCampusGatewayConnectionsOverview

PATH /organizations/{organizationId}/campusGateway/connections/overview

- Path added

- New endpoint

GET /organizations/{organizationId}/campusGateway/connections/overview

---

devices

Docs

Assign devices to a Cellular Data Management Profile in batch

Operation ID: batchOrganizationDevicesCellularDataProfilesAssignmentsCreate

PATH /organizations/{organizationId}/devices/cellular/data/profiles/assignments/batchCreate

- Path added

- New endpoint

POST /organizations/{organizationId}/devices/cellular/data/profiles/assignments/batchCreate

---

Changed

[ appliance ]

firewall

Docs

Return the firewall settings for this network

Operation ID: getNetworkApplianceFirewallSettings

GET /networks/{networkId}/appliance/firewall/settings

- added the optional property spoofingProtection to the response with the 200 status

Docs

Update the firewall settings for this network

Operation ID: updateNetworkApplianceFirewallSettings

PUT /networks/{networkId}/appliance/firewall/settings

- added the optional property spoofingProtection to the response with the 200 status

interfaces

Docs

Create wired L3 interface configuration

Operation ID: createNetworkApplianceInterfacesL3

POST /networks/{networkId}/appliance/interfaces/l3

- removed the request property port/number

- removed the optional property port/number from the response with the 201 status

- added the new optional request property port/interface

- added the optional property port/interface to the response with the 201 status

Docs

Update wired L3 interface configuration

Operation ID: updateNetworkApplianceInterfacesL3

PUT /networks/{networkId}/appliance/interfaces/l3/{interfaceId}

- removed the request property port/number

- removed the optional property port/number from the response with the 200 status

- added the new optional request property port/interface

- added the optional property port/interface to the response with the 200 status

[ devices ]

appliance

PUT /devices/{serial}/appliance/interfaces/ports

- api path removed without deprecation

Docs

Update configurations for an appliance's specified port

Operation ID: updateDeviceApplianceInterfacesPort

PUT /devices/{serial}/appliance/interfaces/ports/{number}

- request property downlink/access/policyType was restricted to a list of enum values

- removed the optional property interfaceName from the response with the 200 status

- added the new 8021x enum value to the downlink/access/policyType response property for the response status 200

- added the new hybrid_8021x_mac enum value to the downlink/access/policyType response property for the response status 200

- added the new mac_radius enum value to the downlink/access/policyType response property for the response status 200

- added the new open enum value to the downlink/access/policyType response property for the response status 200

- added the new 8021x enum value to the request property downlink/access/policyType

- added the new hybrid_8021x_mac enum value to the request property downlink/access/policyType

- added the new mac_radius enum value to the request property downlink/access/policyType

- added the new open enum value to the request property downlink/access/policyType

cellular

PUT /devices/{serial}/cellular/uplinks/bands/masks

- api path removed without deprecation

switch

Docs

Cycle a set of switch ports on non-Catalyst MS devices

Operation ID: cycleDeviceSwitchPorts

POST /devices/{serial}/switch/ports/cycle

- endpoint deprecated

syslog

Docs

Updates the syslog servers configuration for a network.

Operation ID: updateNetworkDevicesSyslogServers

PUT /networks/{networkId}/devices/syslog/servers

- the servers/items/port request property type/format changed from string/ to `integer`/

- the servers/items/port response's property type/format changed from string/ to `integer`/ for status 200

[ networks ]

general

Docs

Return a network

Operation ID: getNetwork

GET /networks/{networkId}

- added the optional property details to the response with the 200 status

Docs

Update a network

Operation ID: updateNetwork

PUT /networks/{networkId}

- added the optional property details to the response with the 200 status

[ organizations ]

appliance

Docs

Listing of L3 Interface Configurations across networks for the organization

Operation ID: getOrganizationApplianceDevicesInterfacesL3ByNetwork

GET /organizations/{organizationId}/appliance/devices/interfaces/l3/byNetwork

- removed the optional property items/items/interfaces/items/port/number from the response with the 200 status

- added the optional property items/items/interfaces/items/port/interface to the response with the 200 status

Docs

Returns port configurations for appliances in a given organization

Operation ID: getOrganizationApplianceDevicesInterfacesPortsByDevice

GET /organizations/{organizationId}/appliance/devices/interfaces/ports/byDevice

- deleted the query request parameter interfaces

- removed the optional property items/items/ports/items/interfaceName from the response with the 200 status

- added the new 8021x enum value to the items/items/ports/items/downlink/access/policyType response property for the response status 200

- added the new hybrid_8021x_mac enum value to the items/items/ports/items/downlink/access/policyType response property for the response status 200

- added the new mac_radius enum value to the items/items/ports/items/downlink/access/policyType response property for the response status 200

- added the new open enum value to the items/items/ports/items/downlink/access/policyType response property for the response status 200

assurance

Docs

Return all health alerts for an organization

Operation ID: getOrganizationAssuranceAlerts

GET /organizations/{organizationId}/assurance/alerts

- added the enum value image_sensor_failure to the property items/ of the query request parameter types

- added the enum value wireless_capacity_degraded to the property items/ of the query request parameter types

- added the enum value wireless_coverage_degraded to the property items/ of the query request parameter types

Docs

Return overview of active health alerts for an organization

Operation ID: getOrganizationAssuranceAlertsOverview

GET /organizations/{organizationId}/assurance/alerts/overview

- added the enum value image_sensor_failure to the property items/ of the query request parameter types

- added the enum value wireless_capacity_degraded to the property items/ of the query request parameter types

- added the enum value wireless_coverage_degraded to the property items/ of the query request parameter types

Docs

Return a Summary of Alerts grouped by network and severity

Operation ID: getOrganizationAssuranceAlertsOverviewByNetwork

GET /organizations/{organizationId}/assurance/alerts/overview/byNetwork

- added the enum value image_sensor_failure to the property items/ of the query request parameter types

- added the enum value wireless_capacity_degraded to the property items/ of the query request parameter types

- added the enum value wireless_coverage_degraded to the property items/ of the query request parameter types

Docs

Return a Summary of Alerts grouped by type and severity

Operation ID: getOrganizationAssuranceAlertsOverviewByType

GET /organizations/{organizationId}/assurance/alerts/overview/byType

- added the enum value image_sensor_failure to the property items/ of the query request parameter types

- added the enum value wireless_capacity_degraded to the property items/ of the query request parameter types

- added the enum value wireless_coverage_degraded to the property items/ of the query request parameter types

Docs

Returns historical health alert overviews

Operation ID: getOrganizationAssuranceAlertsOverviewHistorical

GET /organizations/{organizationId}/assurance/alerts/overview/historical

- added the enum value image_sensor_failure to the property items/ of the query request parameter types

- added the enum value wireless_capacity_degraded to the property items/ of the query request parameter types

- added the enum value wireless_coverage_degraded to the property items/ of the query request parameter types

Docs

Return a list of alert types

Operation ID: getOrganizationAssuranceAlertsTaxonomyTypes

GET /organizations/{organizationId}/assurance/alerts/taxonomy/types

- the endpoint scheme security oauth2 was added to the API

Docs

Summarizes wireless post connection capacity successes and failures by network.

Operation ID: getOrganizationAssuranceWirelessExperienceChannelAvailabilityByNetworkByClient

GET /organizations/{organizationId}/assurance/wireless/experience/channelAvailability/byNetwork/byClient

- removed the optional property items/items/items/connections/observedBands from the response with the 200 status

- added the optional property items/items/items/connections/impactedBands to the response with the 200 status

Docs

Summarizes wireless post connection capacity successes and failures by device.

Operation ID: getOrganizationAssuranceWirelessExperienceChannelAvailabilityByNetworkByDevice

GET /organizations/{organizationId}/assurance/wireless/experience/channelAvailability/byNetwork/byDevice

- removed the optional property items/items/items/connections/observedBands from the response with the 200 status

- added the optional property items/items/items/connections/impactedBands to the response with the 200 status

Docs

Summarizes wireless post connection capacity successes and failures by ssid.

Operation ID: getOrganizationAssuranceWirelessExperienceChannelAvailabilityByNetworkBySsid

GET /organizations/{organizationId}/assurance/wireless/experience/channelAvailability/byNetwork/bySsid

- removed the optional property items/items/items/connections/observedBands from the response with the 200 status

- added the optional property items/items/items/connections/impactedBands to the response with the 200 status

Docs

Summarizes wireless coverage successes and failures by client.

Operation ID: getOrganizationAssuranceWirelessExperienceCoverageByNetworkByClient

GET /organizations/{organizationId}/assurance/wireless/experience/coverage/byNetwork/byClient

- removed the optional property items/items/items/connections/observedBands from the response with the 200 status

- added the optional property items/items/items/connections/impactedBands to the response with the 200 status

Docs

Summarizes wireless coverage successes and failures by device.

Operation ID: getOrganizationAssuranceWirelessExperienceCoverageByNetworkByDevice

GET /organizations/{organizationId}/assurance/wireless/experience/coverage/byNetwork/byDevice

- removed the optional property items/items/items/connections/observedBands from the response with the 200 status

- added the optional property items/items/items/connections/impactedBands to the response with the 200 status

Docs

Summarizes wireless coverage successes and failures by SSID.

Operation ID: getOrganizationAssuranceWirelessExperienceCoverageByNetworkBySsid

GET /organizations/{organizationId}/assurance/wireless/experience/coverage/byNetwork/bySsid

- removed the optional property items/items/items/connections/observedBands from the response with the 200 status

- added the optional property items/items/items/connections/impactedBands to the response with the 200 status

devices

Docs

List devices eligible for Cellular Data Management profile assignment in this organization

Operation ID: getOrganizationDevicesCellularDataDevices

GET /organizations/{organizationId}/devices/cellular/data/devices

- deleted the query request parameter excludedDevices

- deleted the query request parameter excludedProfiles

- deleted the query request parameter includedDevices

- deleted the query request parameter includedProfiles

- removed the optional property items/items/deviceType from the response with the 200 status

- removed the optional property items/items/software/majorNumber from the response with the 200 status

- removed the optional property items/items/software/minorNumber from the response with the 200 status

- removed the optional property items/items/software/patchNumber from the response with the 200 status

- removed the optional property meta/count from the response with the 200 status

- added the new esim enum value to the items/items/modems/items/sims/items/slot response property for the response status 200

- added the new optional query request parameter excludedProfileIds

- added the new optional query request parameter excludedSerials

- added the new optional query request parameter includedProfileIds

- added the new optional query request parameter includedSerials

- added the optional property items/items/model to the response with the 200 status

- added the optional property items/items/software/currentVersion to the response with the 200 status

- added the optional property meta/counts to the response with the 200 status

- removed the sim3 enum value from the items/items/modems/items/sims/items/slot response property for the response status 200

Docs

Add a cellular data management profile to this organization

Operation ID: createOrganizationDevicesCellularDataProfile

POST /organizations/{organizationId}/devices/cellular/data/profiles

- added the new required request property rules/items/cap/term

- added the new required request property rules/items/uplink

- request property rules/items/actions/items/type was restricted to a list of enum values

- request property rules/items/slot was restricted to a list of enum values

- the rules/items/cap/term response's property type/format changed from string/ to `object`/ for status 200

- the rules/items/cap/threshold request property's max was set to 1.00

- the rules/items/cap/value request property's max was set to 1024000.00

- the rules/items/cap/threshold request property's min was set to 0.01

- the rules/items/cap/value request property's min was set to 1.00

- removed the request property rules/items/cap/termStart

- removed the request property rules/items/isPreferredUplink

- removed the request property rules/items/uplinkPriority

- removed the optional property rules/items/cap/termStart from the response with the 200 status

- removed the optional property rules/items/isPreferredUplink from the response with the 200 status

- removed the optional property rules/items/uplinkPriority from the response with the 200 status

- added the new failover enum value to the rules/items/actions/items/type response property for the response status 200

- added the new send_message enum value to the rules/items/actions/items/type response property for the response status 200

- added the new sim1 enum value to the rules/items/slot response property for the response status 200

- added the new sim2 enum value to the rules/items/slot response property for the response status 200

- added the new sim3 enum value to the rules/items/slot response property for the response status 200

- added the new failover enum value to the request property rules/items/actions/items/type

- added the new send_message enum value to the request property rules/items/actions/items/type

- added the new sim1 enum value to the request property rules/items/slot

- added the new sim2 enum value to the request property rules/items/slot

- added the new sim3 enum value to the request property rules/items/slot

- added the optional property rules/items/cap/term/resets to the response with the 200 status

- added the optional property rules/items/cap/term/starts to the response with the 200 status

- added the optional property rules/items/uplink to the response with the 200 status

Docs

List Cellular Data Management Profile assignments in this organization

Operation ID: getOrganizationDevicesCellularDataProfilesAssignments

GET /organizations/{organizationId}/devices/cellular/data/profiles/assignments

- removed the optional property items/items/profileId from the response with the 200 status

- removed the optional property items/items/serial from the response with the 200 status

- removed the optional property meta/counts/remaining from the response with the 200 status

- removed the optional property meta/counts/total from the response with the 200 status

- added the optional property items/items/device to the response with the 200 status

- added the optional property items/items/profile to the response with the 200 status

- added the optional property meta/counts/items to the response with the 200 status

POST /organizations/{organizationId}/devices/cellular/data/profiles/assignments/bulkCreate

- api path removed without deprecation

Docs

Unassign devices from a Cellular Data Management Profile in batch

Operation ID: bulkOrganizationDevicesCellularDataProfilesAssignmentsDelete

POST /organizations/{organizationId}/devices/cellular/data/profiles/assignments/bulkDelete

- added the new required request property items/items/device

- added the new required request property items/items/profile

- removed the request property items/items/profileId

- removed the request property items/items/serial

Docs

Update a Cellular Data Management Profile

Operation ID: updateOrganizationDevicesCellularDataProfile

PUT /organizations/{organizationId}/devices/cellular/data/profiles/{profileId}

- added the new required request property rules/items/cap/term

- added the new required request property rules/items/uplink

- request property rules/items/actions/items/type was restricted to a list of enum values

- request property rules/items/slot was restricted to a list of enum values

- the rules/items/cap/term response's property type/format changed from string/ to `object`/ for status 200

- the rules/items/cap/threshold request property's max was set to 1.00

- the rules/items/cap/value request property's max was set to 1024000.00

- the rules/items/cap/threshold request property's min was set to 0.01

- the rules/items/cap/value request property's min was set to 1.00

- removed the request property rules/items/cap/termStart

- removed the request property rules/items/isPreferredUplink

- removed the request property rules/items/uplinkPriority

- removed the optional property rules/items/cap/termStart from the response with the 200 status

- removed the optional property rules/items/isPreferredUplink from the response with the 200 status

- removed the optional property rules/items/uplinkPriority from the response with the 200 status

- added the new failover enum value to the rules/items/actions/items/type response property for the response status 200

- added the new send_message enum value to the rules/items/actions/items/type response property for the response status 200

- added the new sim1 enum value to the rules/items/slot response property for the response status 200

- added the new sim2 enum value to the rules/items/slot response property for the response status 200

- added the new sim3 enum value to the rules/items/slot response property for the response status 200

- added the new failover enum value to the request property rules/items/actions/items/type

- added the new send_message enum value to the request property rules/items/actions/items/type

- added the new sim1 enum value to the request property rules/items/slot

- added the new sim2 enum value to the request property rules/items/slot

- added the new sim3 enum value to the request property rules/items/slot

- added the optional property rules/items/cap/term/resets to the response with the 200 status

- added the optional property rules/items/cap/term/starts to the response with the 200 status

- added the optional property rules/items/uplink to the response with the 200 status

Docs

List current cellular data usage for devices in this organization

Operation ID: getOrganizationDevicesCellularDataUsageByDevice

GET /organizations/{organizationId}/devices/cellular/data/usage/byDevice

- removed the optional property items/items/bySlot/items/active from the response with the 200 status

- removed the optional property items/items/bySlot/items/dataUsage from the response with the 200 status

- removed the optional property meta/count from the response with the 200 status

- added the new esim enum value to the items/items/bySlot/items/slot response property for the response status 200

- added the new sim1 enum value to the items/items/bySlot/items/slot response property for the response status 200

- added the new sim2 enum value to the items/items/bySlot/items/slot response property for the response status 200

- added the optional property items/items/bySlot/items/endTs to the response with the 200 status

- added the optional property items/items/bySlot/items/isActive to the response with the 200 status

- added the optional property items/items/bySlot/items/lastUpdatedAt to the response with the 200 status

- added the optional property items/items/bySlot/items/limit to the response with the 200 status

- added the optional property items/items/bySlot/items/startTs to the response with the 200 status

- added the optional property items/items/bySlot/items/total to the response with the 200 status

- added the optional property meta/counts to the response with the 200 status

Docs

List historical cellular data usage grouped by device and interval in this organization

Operation ID: getOrganizationDevicesCellularDataUsageHistoryByDeviceByInterval

GET /organizations/{organizationId}/devices/cellular/data/usage/history/byDevice/byInterval

- removed the optional property meta/count from the response with the 200 status

- added the new sim1 enum value to the items/items/intervals/items/usage/bySim/items/name response property for the response status 200

- added the new sim2 enum value to the items/items/intervals/items/usage/bySim/items/name response property for the response status 200

- added the new sim3 enum value to the items/items/intervals/items/usage/bySim/items/name response property for the response status 200

- added the optional property meta/counts to the response with the 200 status

Docs

Returns syslog servers configured for the networks within an organization.

Operation ID: getOrganizationDevicesSyslogServersByNetwork

GET /organizations/{organizationId}/devices/syslog/servers/byNetwork

- the items/items/servers/items/port response's property type/format changed from string/ to `integer`/ for status 200

Docs

Returns roles that can be assigned to a syslog server for a given network.

Operation ID: getOrganizationDevicesSyslogServersRolesByNetwork

GET /organizations/{organizationId}/devices/syslog/servers/roles/byNetwork

- removed the required property items/items/availableRoles from the response with the 200 status

- added the required property items/items/available to the response with the 200 status

networks

Docs

List the networks that the user has privileges on in an organization

Operation ID: getOrganizationNetworks

GET /organizations/{organizationId}/networks

- added the optional property items/details to the response with the 200 status

Docs

Create a network

Operation ID: createOrganizationNetwork

POST /organizations/{organizationId}/networks

- added the optional property details to the response with the 201 status

Docs

Combine multiple networks into a single network

Operation ID: combineOrganizationNetworks

POST /organizations/{organizationId}/networks/combine

- added the optional property resultingNetwork/details to the response with the 200 status

[ snmp ]

general

Docs

Return the SNMP settings for a network

Operation ID: getNetworkSnmp

GET /networks/{networkId}/snmp

- added the optional property authentication to the response with the 200 status

- added the optional property privacy to the response with the 200 status

Docs

Update the SNMP settings for a network

Operation ID: updateNetworkSnmp

PUT /networks/{networkId}/snmp

- added the new optional request property authentication

- added the new optional request property privacy

- added the optional property authentication to the response with the 200 status

- added the optional property privacy to the response with the 200 status

[ split ]

general

Docs

Split a combined network into individual networks for each type of device

Operation ID: splitNetwork

POST /networks/{networkId}/split

- added the optional property resultingNetworks/items/details to the response with the 200 status

[ unbind ]

general

Docs

Unbind a network from a template.

Operation ID: unbindNetwork

POST /networks/{networkId}/unbind

- added the optional property details to the response with the 200 status

v1.69.0-beta.4

• Added
  • [ devices ]
    • appliance
      • Update configurations for an appliance's specified port
    • cellular
      • Update the cellular band masks for a device
    • liveTools
      • Enqueue a job to perform a cycle port for the device on the specified ports
      • Return a cycle port live tool job.
  • [ organizations ]
    • appliance
      • Return the VRF setting for an organization.
      • Update the VRF setting for an organization.
    • assurance
      • Summarizes wired connection successes and failures by client.
      • Summarizes wired connection successes and failures by device.
• Changed
  • [ appliance ]
    • firewall
      • List the MX L7 firewall rules for an MX network
      • Update the MX L7 firewall rules for an MX network
    • ports
      • List per-port VLAN settings for all ports of a secure router or security appliance.
      • Return per-port VLAN settings for a single secure router or security appliance port.
      • Update the per-port VLAN settings for a single secure router or security appliance port.
    • singleLan
      • Return single LAN configuration
      • Update single LAN configuration
    • trafficShaping
      • Display the traffic shaping settings for an MX network
      • Update the traffic shaping settings for an MX network
      • Display the traffic shaping settings rules for an MX network
      • Update the traffic shaping settings rules for an MX network
    • vlans
      • List the VLANs for a Security Appliance network
      • Add a VLAN
      • Return a VLAN
      • Update a VLAN
    • vpn
      • Return the site-to-site VPN settings of a network
      • Update the site-to-site VPN settings of a network
  • [ devices ]
    • appliance
      • Return current delegated IPv6 prefixes on an appliance.
      • Return prefixes assigned to all IPv6 enabled VLANs on an appliance.
    • cellular
    • liveTools
  • [ organizations ]
    • appliance
      • Returns port configurations for appliances in a given organization
      • List the VLANs for an Organization
    • assurance
      • Summarizes wired connection successes and failures by network.
    • devices
      • List cellular data management profiles in this organization
      • List the latest cellular geolocation telemetry for devices in an organization
    • iam
    • webhooks
      • Return the log of webhook POSTs sent

Version v1.69.0-beta.3 to v1.69.0-beta.4

Summary of Changes

8 - New

29 - Updated

858 - Total Endpoints

583 - Total Paths

Added

[ devices ]

appliance

Docs

Update configurations for an appliance's specified port

Operation ID: updateDeviceApplianceInterfacesPorts

PATH /devices/{serial}/appliance/interfaces/ports

- Path added

- New endpoint

PUT /devices/{serial}/appliance/interfaces/ports

---

cellular

Docs

Update the cellular band masks for a device

Operation ID: updateDeviceCellularUplinksBandsMasks

PATH /devices/{serial}/cellular/uplinks/bands/masks

- Path added

- New endpoint

PUT /devices/{serial}/cellular/uplinks/bands/masks

---

liveTools

Docs

Enqueue a job to perform a cycle port for the device on the specified ports

Operation ID: createDeviceLiveToolsPortsCycle

PATH /devices/{serial}/liveTools/ports/cycle

- Path added

- New endpoint

POST /devices/{serial}/liveTools/ports/cycle

---

Docs

Return a cycle port live tool job.

Operation ID: getDeviceLiveToolsPortsCycle

PATH /devices/{serial}/liveTools/ports/cycle/{id}

- Path added

- New endpoint

GET /devices/{serial}/liveTools/ports/cycle/{id}

---

[ organizations ]

appliance

Docs

Return the VRF setting for an organization.

Operation ID: getOrganizationApplianceRoutingVrfsSettings

PATH /organizations/{organizationId}/appliance/routing/vrfs/settings

- Path added

- New endpoint

GET /organizations/{organizationId}/appliance/routing/vrfs/settings

---

Docs

Update the VRF setting for an organization.

Operation ID: updateOrganizationApplianceRoutingVrfsSettings

PATH /organizations/{organizationId}/appliance/routing/vrfs/settings

- Path added

- New endpoint

PUT /organizations/{organizationId}/appliance/routing/vrfs/settings

---

assurance

Docs

Summarizes wired connection successes and failures by client.

Operation ID: getOrganizationAssuranceWiredExperienceSuccessfulConnectionsByNetworkByClient

PATH /organizations/{organizationId}/assurance/wired/experience/successfulConnections/byNetwork/byClient

- Path added

- New endpoint

GET /organizations/{organizationId}/assurance/wired/experience/successfulConnections/byNetwork/byClient

---

Docs

Summarizes wired connection successes and failures by device.

Operation ID: getOrganizationAssuranceWiredExperienceSuccessfulConnectionsByNetworkByDevice

PATH /organizations/{organizationId}/assurance/wired/experience/successfulConnections/byNetwork/byDevice

- Path added

- New endpoint

GET /organizations/{organizationId}/assurance/wired/experience/successfulConnections/byNetwork/byDevice

---

Changed

[ appliance ]

firewall

Docs

List the MX L7 firewall rules for an MX network

Operation ID: getNetworkApplianceFirewallL7FirewallRules

GET /networks/{networkId}/appliance/firewall/l7FirewallRules

- added the optional property rules to the response with the 200 status

Docs

Update the MX L7 firewall rules for an MX network

Operation ID: updateNetworkApplianceFirewallL7FirewallRules

PUT /networks/{networkId}/appliance/firewall/l7FirewallRules

- added the new allowedCountries enum value to the request property rules/items/type

- added the new blacklistedCountries enum value to the request property rules/items/type

- added the new blockedCountries enum value to the request property rules/items/type

- added the new whitelistedCountries enum value to the request property rules/items/type

- added the optional property rules to the response with the 200 status

ports

Docs

List per-port VLAN settings for all ports of a secure router or security appliance.

Operation ID: getNetworkAppliancePorts

GET /networks/{networkId}/appliance/ports

- added the optional property items/adaptivePolicyGroupId to the response with the 200 status

Docs

Return per-port VLAN settings for a single secure router or security appliance port.

Operation ID: getNetworkAppliancePort

GET /networks/{networkId}/appliance/ports/{portId}

- added the optional property adaptivePolicyGroupId to the response with the 200 status

Docs

Update the per-port VLAN settings for a single secure router or security appliance port.

Operation ID: updateNetworkAppliancePort

PUT /networks/{networkId}/appliance/ports/{portId}

- added the optional property adaptivePolicyGroupId to the response with the 200 status

singleLan

Docs

Return single LAN configuration

Operation ID: getNetworkApplianceSingleLan

GET /networks/{networkId}/appliance/singleLan

- added the optional property vrf to the response with the 200 status

Docs

Update single LAN configuration

Operation ID: updateNetworkApplianceSingleLan

PUT /networks/{networkId}/appliance/singleLan

- added the new optional request property vrf

- added the optional property vrf to the response with the 200 status

trafficShaping

Docs

Display the traffic shaping settings for an MX network

Operation ID: getNetworkApplianceTrafficShaping

GET /networks/{networkId}/appliance/trafficShaping

- added the required property globalBandwidthLimits to the response with the 200 status

Docs

Update the traffic shaping settings for an MX network

Operation ID: updateNetworkApplianceTrafficShaping

PUT /networks/{networkId}/appliance/trafficShaping

- request body became required

- the request property globalBandwidthLimits became required

- added the required property globalBandwidthLimits to the response with the 200 status

Docs

Display the traffic shaping settings rules for an MX network

Operation ID: getNetworkApplianceTrafficShapingRules

GET /networks/{networkId}/appliance/trafficShaping/rules

- added the optional property defaultRulesEnabled to the response with the 200 status

- added the optional property rules to the response with the 200 status

Docs

Update the traffic shaping settings rules for an MX network

Operation ID: updateNetworkApplianceTrafficShapingRules

PUT /networks/{networkId}/appliance/trafficShaping/rules

- added the optional property defaultRulesEnabled to the response with the 200 status

- added the optional property rules to the response with the 200 status

vlans

Docs

List the VLANs for a Security Appliance network

Operation ID: getNetworkApplianceVlans

GET /networks/{networkId}/appliance/vlans

- added the optional property items/adaptivePolicyGroupId to the response with the 200 status

- added the optional property items/vrf to the response with the 200 status

Docs

Add a VLAN

Operation ID: createNetworkApplianceVlan

POST /networks/{networkId}/appliance/vlans

- added the new optional request property vrf

- added the optional property adaptivePolicyGroupId to the response with the 201 status

- added the optional property vrf to the response with the 201 status

Docs

Return a VLAN

Operation ID: getNetworkApplianceVlan

GET /networks/{networkId}/appliance/vlans/{vlanId}

- added the optional property adaptivePolicyGroupId to the response with the 200 status

- added the optional property vrf to the response with the 200 status

Docs

Update a VLAN

Operation ID: updateNetworkApplianceVlan

PUT /networks/{networkId}/appliance/vlans/{vlanId}

- added the new optional request property vrf

- added the optional property adaptivePolicyGroupId to the response with the 200 status

- added the optional property vrf to the response with the 200 status

vpn

Docs

Return the site-to-site VPN settings of a network

Operation ID: getNetworkApplianceVpnSiteToSiteVpn

GET /networks/{networkId}/appliance/vpn/siteToSiteVpn

- added the optional property peerSgtCapable to the response with the 200 status

Docs

Update the site-to-site VPN settings of a network

Operation ID: updateNetworkApplianceVpnSiteToSiteVpn

PUT /networks/{networkId}/appliance/vpn/siteToSiteVpn

- added the new optional request property peerSgtCapable

- added the optional property peerSgtCapable to the response with the 200 status

[ devices ]

appliance

Docs

Return current delegated IPv6 prefixes on an appliance.

Operation ID: getDeviceAppliancePrefixesDelegated

GET /devices/{serial}/appliance/prefixes/delegated

- added the optional property items/counts to the response with the 200 status

- added the optional property items/description to the response with the 200 status

- added the optional property items/expiresAt to the response with the 200 status

- added the optional property items/origin to the response with the 200 status

- added the optional property items/staticDelegatedPrefixId to the response with the 200 status

- added the required property items/isPreferred to the response with the 200 status

- added the required property items/method to the response with the 200 status

- added the required property items/prefix to the response with the 200 status

Docs

Return prefixes assigned to all IPv6 enabled VLANs on an appliance.

Operation ID: getDeviceAppliancePrefixesDelegatedVlanAssignments

GET /devices/{serial}/appliance/prefixes/delegated/vlanAssignments

- added the optional property items/ipv6 to the response with the 200 status

- added the optional property items/origin to the response with the 200 status

- added the optional property items/vlan to the response with the 200 status

- added the required property items/status to the response with the 200 status

cellular

PUT /devices/{serial}/cellular/uplinks/bands

- api path removed without deprecation

liveTools

POST /devices/{serial}/liveTools/cyclePort

- api path removed without deprecation

GET /devices/{serial}/liveTools/cyclePort/{id}

- api path removed without deprecation

[ organizations ]

appliance

Docs

Returns port configurations for appliances in a given organization

Operation ID: getOrganizationApplianceDevicesInterfacesPortsByDevice

GET /organizations/{organizationId}/appliance/devices/interfaces/ports/byDevice

- added the new optional query request parameter interfaces

Docs

List the VLANs for an Organization

Operation ID: getOrganizationApplianceVlans

GET /organizations/{organizationId}/appliance/vlans

- added the optional property items/adaptivePolicyGroupId to the response with the 200 status

- added the optional property items/vrf to the response with the 200 status

assurance

Docs

Summarizes wired connection successes and failures by network.

Operation ID: getOrganizationAssuranceWiredExperienceSuccessfulConnectionsByNetwork

GET /organizations/{organizationId}/assurance/wired/experience/successfulConnections/byNetwork

- added the optional property items/items/items/byContributor to the response with the 200 status

devices

Docs

List cellular data management profiles in this organization

Operation ID: getOrganizationDevicesCellularDataProfiles

GET /organizations/{organizationId}/devices/cellular/data/profiles

- the response's body type/format changed from array/ to `object`/ for status 200

- for the query request parameter profileIds, the type/format of property items/ was changed from integer/ to `string`/

- deleted the query request parameter deviceSerial

- added the new optional query request parameter serials

- added the optional property items to the response with the 200 status

- added the optional property meta to the response with the 200 status

Docs

List the latest cellular geolocation telemetry for devices in an organization

Operation ID: getOrganizationDevicesCellularGeolocations

GET /organizations/{organizationId}/devices/cellular/geolocations

- the items/items/geolocation/lastReportedAt response's property type/format changed from string/`` to string/date-time for status 200

- the items/items/geolocation/latitude response's property type/format changed from string/`` to number/float for status 200

- the items/items/geolocation/longitude response's property type/format changed from string/`` to number/float for status 200

iam

POST /organizations/{organizationId}/iam/admins/administrators/me/permissions/resolve

- api path removed without deprecation

webhooks

Docs

Return the log of webhook POSTs sent

Operation ID: getOrganizationWebhooksLogs

GET /organizations/{organizationId}/webhooks/logs

- for the query request parameter timespan, the max was decreased from 2678400.00 to 2592000.00

v1.69.0-beta.3

• Added
  • [ organizations ]
    • assurance
      • Returns count of impacted wireless devices per network on a given organization and time range.
      • Summarizes wired connection successes and failures by network.
      • Time-series of wired connection successes and failures by network.
    • campusGateway
      • Returns client usage details for campus gateway clusters within an organization.
    • devices
      • Bulk update the attributes related to positions for provided devices
      • Returns details about software updates for networks within an organization.
    • iam
      • List the authenticated caller admin's permissions for an organization
    • sites
      • List the buildings belonging to the organization
    • wireless
      • Summarize the number of wireless clients impacted by connection failures on network SSIDs, across an organization.
      • Returns client usage details for wireless networks within an organization.
      • Returns client usage details for wireless network SSIDs within an organization.
      • Returns client usage details for SSIDs within an organization.
      • Returns the SSID profiles for an organization
      • Create a new SSID profile in an organization
      • Unassigns the SSID profile assigned to an SSID
      • List the SSID profile assignments in an organization
      • Assigns an SSID profile to an SSID in the organization
      • List the SSID profile assignments in an organization, grouped by network
      • Returns the SSID profiles' overview information for an organization
      • Delete an SSID profile
      • Update this SSID profile
  • [ sites ]
    • buildings
      • Create a new building
      • Delete a building
      • Update a building
• Changed
  • [ appliance ]
    • firewall
      • Return the L3 firewall rules for an MX network
      • Update the L3 firewall rules of an MX network
    • prefixes
      • List static delegated prefixes for a network
      • Add a static delegated prefix from a network
      • Delete a static delegated prefix from a network
      • Return a static delegated prefix from a network
      • Update a static delegated prefix from a network
    • staticRoutes
      • Add a static route for an MX or teleworker network
      • Update a static route for an MX or teleworker network
  • [ clients ]
    • general
      • Return the client associated with the given identifier
  • [ devices ]
    • appliance
      • Update configurations for an appliance's specified port
      • Return the uplink settings for a secure router or security appliance
      • Update the uplink settings for a secure router or security appliance
    • liveTools
      • Return an OSPF neighbors live tool job.
    • switch
      • List layer 3 interfaces for a switch
      • Create a layer 3 interface for a switch
      • Return a layer 3 interface for a switch
      • Update a layer 3 interface for a switch
    • wireless
      • Return the position for a wireless device
      • Update the position attributes for this device
  • [ floorPlans ]
    • general
      • List the floor plans that belong to your network
      • Upload a floor plan
      • Destroy a floor plan
      • Find a floor plan by ID
      • Update a floor plan's geolocation and other meta data
  • [ organizations ]
    • appliance
      • Returns port configurations for appliances in a given organization
    • assurance
      • Given a client, return current topology
      • Returns the top wireless service-level insights for the specified time window, including each network and the impacted client count per metric.
      • Summarizes wireless connection successes and failures by client.
      • Summarizes wireless connection successes and failures by device.
      • Summarizes wireless connection successes and failures by ssid.
      • Summarizes wireless time to connect metrics by client.
      • Summarizes wireless connection time to connect metrics by device.
      • Summarizes wireless connection time to connect metrics by ssid.
    • inventory
    • sase
    • wireless
      • Returns the current Air Marshal rules for this organization
      • List access point client count at the moment in an organization
      • Show the by-network client information for the organization in the given interval
      • Get average packet loss for the given timespan for all networks in the organization.
      • Return the CPU Load history for a list of wireless devices in the organization.
      • List the AFC power limits of an organization by device
      • List the RF profiles of an organization by device
  • [ switch ]
    • stacks
      • List layer 3 interfaces for a switch stack
      • Create a layer 3 interface for a switch stack
      • Return a layer 3 interface from a switch stack
      • Update a layer 3 interface for a switch stack
  • [ wireless ]
    • clients
      • Fetch the health scores for all clients on this network
      • Return counts of distinct wireless clients connecting to a network over time
    • ssids
      • List the MR SSIDs in a network
      • Return a single MR SSID
      • Update the attributes of an MR SSID

Version v1.69.0-beta.2 to v1.69.0-beta.3

Summary of Changes

24 - New

56 - Updated

874 - Total Endpoints

594 - Total Paths

Added

[ organizations ]

assurance

Docs

Returns count of impacted wireless devices per network on a given organization and time range.

Operation ID: getOrganizationAssuranceImpactedDeviceWirelessByNetwork

PATH /organizations/{organizationId}/assurance/impactedDevice/wireless/byNetwork

- Path added

- New endpoint

GET /organizations/{organizationId}/assurance/impactedDevice/wireless/byNetwork

---

Docs

Summarizes wired connection successes and failures by network.

Operation ID: getOrganizationAssuranceWiredExperienceSuccessfulConnectionsByNetwork

PATH /organizations/{organizationId}/assurance/wired/experience/successfulConnections/byNetwork

- Path added

- New endpoint

GET /organizations/{organizationId}/assurance/wired/experience/successfulConnections/byNetwork

---

Docs

Time-series of wired connection successes and failures by network.

Operation ID: getOrganizationAssuranceWiredExperienceSuccessfulConnectionsByNetworkByInterval

PATH /organizations/{organizationId}/assurance/wired/experience/successfulConnections/byNetwork/byInterval

- Path added

- New endpoint

GET /organizations/{organizationId}/assurance/wired/experience/successfulConnections/byNetwork/byInterval

---

campusGateway

Docs

Returns client usage details for campus gateway clusters within an organization.

Operation ID: getOrganizationCampusGatewayClientsUsageByNetworkByCluster

PATH /organizations/{organizationId}/campusGateway/clients/usage/byNetwork/byCluster

- Path added

- New endpoint

GET /organizations/{organizationId}/campusGateway/clients/usage/byNetwork/byCluster

---

devices

Docs

Bulk update the attributes related to positions for provided devices

Operation ID: bulkOrganizationDevicesPlacementPositionsUpdate

PATH /organizations/{organizationId}/devices/placement/positions/bulkUpdate

- Path added

- New endpoint

POST /organizations/{organizationId}/devices/placement/positions/bulkUpdate

---

Docs

Returns details about software updates for networks within an organization.

Operation ID: getOrganizationDevicesSoftwareUpdatesOverviewsByNetwork

PATH /organizations/{organizationId}/devices/software/updates/overviews/byNetwork

- Path added

- New endpoint

GET /organizations/{organizationId}/devices/software/updates/overviews/byNetwork

---

iam

Docs

List the authenticated caller admin's permissions for an organization

Operation ID: resolveOrganizationIamAdminsAdministratorsMePermissions

PATH /organizations/{organizationId}/iam/admins/administrators/me/permissions/resolve

- Path added

- New endpoint

POST /organizations/{organizationId}/iam/admins/administrators/me/permissions/resolve

---

sites

Docs

List the buildings belonging to the organization

Operation ID: getOrganizationSitesBuildings

PATH /organizations/{organizationId}/sites/buildings

- Path added

- New endpoint

GET /organizations/{organizationId}/sites/buildings

---

wireless

Docs

Summarize the number of wireless clients impacted by connection failures on network SSIDs, across an organization.

Operation ID: getOrganizationWirelessClientsConnectionsImpactedByNetworkBySsid

PATH /organizations/{organizationId}/wireless/clients/connections/impacted/byNetwork/bySsid

- Path added

- New endpoint

GET /organizations/{organizationId}/wireless/clients/connections/impacted/byNetwork/bySsid

---

Docs

Returns client usage details for wireless networks within an organization.

Operation ID: getOrganizationWirelessClientsUsageByNetwork

PATH /organizations/{organizationId}/wireless/clients/usage/byNetwork

- Path added

- New endpoint

GET /organizations/{organizationId}/wireless/clients/usage/byNetwork

---

Docs

Returns client usage details for wireless network SSIDs within an organization.

Operation ID: getOrganizationWirelessClientsUsageByNetworkBySsid

PATH /organizations/{organizationId}/wireless/clients/usage/byNetwork/bySsid

- Path added

- New endpoint

GET /organizations/{organizationId}/wireless/clients/usage/byNetwork/bySsid

---

Docs

Returns client usage details for SSIDs within an organization.

Operation ID: getOrganizationWirelessClientsUsageBySsid

PATH /organizations/{organizationId}/wireless/clients/usage/bySsid

- Path added

- New endpoint

GET /organizations/{organizationId}/wireless/clients/usage/bySsid

---

Docs

Returns the SSID profiles for an organization

Operation ID: getOrganizationWirelessSsidsProfiles

PATH /organizations/{organizationId}/wireless/ssids/profiles

- Path added

- New endpoint

GET /organizations/{organizationId}/wireless/ssids/profiles

---

Docs

Create a new SSID profile in an organization

Operation ID: createOrganizationWirelessSsidsProfile

PATH /organizations/{organizationId}/wireless/ssids/profiles

- Path added

- New endpoint

POST /organizations/{organizationId}/wireless/ssids/profiles

---

Docs

Unassigns the SSID profile assigned to an SSID

Operation ID: deleteOrganizationWirelessSsidsProfilesAssignments

PATH /organizations/{organizationId}/wireless/ssids/profiles/assignments

- Path added

- New endpoint

DELETE /organizations/{organizationId}/wireless/ssids/profiles/assignments

---

Docs

List the SSID profile assignments in an organization

Operation ID: getOrganizationWirelessSsidsProfilesAssignments

PATH /organizations/{organizationId}/wireless/ssids/profiles/assignments

- Path added

- New endpoint

GET /organizations/{organizationId}/wireless/ssids/profiles/assignments

---

Docs

Assigns an SSID profile to an SSID in the organization

Operation ID: createOrganizationWirelessSsidsProfilesAssignment

PATH /organizations/{organizationId}/wireless/ssids/profiles/assignments

- Path added

- New endpoint

POST /organizations/{organizationId}/wireless/ssids/profiles/assignments

---

Docs

List the SSID profile assignments in an organization, grouped by network

Operation ID: getOrganizationWirelessSsidsProfilesAssignmentsByNetwork

PATH /organizations/{organizationId}/wireless/ssids/profiles/assignments/byNetwork

- Path added

- New endpoint

GET /organizations/{organizationId}/wireless/ssids/profiles/assignments/byNetwork

---

Docs

Returns the SSID profiles' overview information for an organization

Operation ID: getOrganizationWirelessSsidsProfilesOverviews

PATH /organizations/{organizationId}/wireless/ssids/profiles/overviews

- Path added

- New endpoint

GET /organizations/{organizationId}/wireless/ssids/profiles/overviews

---

Docs

Delete an SSID profile

Operation ID: deleteOrganizationWirelessSsidsProfile

PATH /organizations/{organizationId}/wireless/ssids/profiles/{id}

- Path added

- New endpoint

DELETE /organizations/{organizationId}/wireless/ssids/profiles/{id}

---

Docs

Update this SSID profile

Operation ID: updateOrganizationWirelessSsidsProfile

PATH /organizations/{organizationId}/wireless/ssids/profiles/{id}

- Path added

- New endpoint

PUT /organizations/{organizationId}/wireless/ssids/profiles/{id}

---

[ sites ]

buildings

Docs

Create a new building

Operation ID: createNetworkSitesBuilding

PATH /networks/{networkId}/sites/buildings

- Path added

- New endpoint

POST /networks/{networkId}/sites/buildings

---

Docs

Delete a building

Operation ID: deleteNetworkSitesBuilding

PATH /networks/{networkId}/sites/buildings/{buildingId}

- Path added

- New endpoint

DELETE /networks/{networkId}/sites/buildings/{buildingId}

---

Docs

Update a building

Operation ID: updateNetworkSitesBuilding

PATH /networks/{networkId}/sites/buildings/{buildingId}

- Path added

- New endpoint

PUT /networks/{networkId}/sites/buildings/{buildingId}

---

Changed

[ appliance ]

firewall

Docs

Return the L3 firewall rules for an MX network

Operation ID: getNetworkApplianceFirewallL3FirewallRules

GET /networks/{networkId}/appliance/firewall/l3FirewallRules

- added the optional property rules to the response with the 200 status

Docs

Update the L3 firewall rules of an MX network

Operation ID: updateNetworkApplianceFirewallL3FirewallRules

PUT /networks/{networkId}/appliance/firewall/l3FirewallRules

- added the optional property rules to the response with the 200 status

prefixes

Docs

List static delegated prefixes for a network

Operation ID: getNetworkAppliancePrefixesDelegatedStatics

GET /networks/{networkId}/appliance/prefixes/delegated/statics

- the response property /items/description became nullable for the status 200

Docs

Add a static delegated prefix from a network

Operation ID: createNetworkAppliancePrefixesDelegatedStatic

POST /networks/{networkId}/appliance/prefixes/delegated/statics

- added the optional property createdAt to the response with the 201 status

- added the optional property description to the response with the 201 status

- added the optional property origin to the response with the 201 status

- added the optional property prefix to the response with the 201 status

- added the optional property staticDelegatedPrefixId to the response with the 201 status

- added the optional property updatedAt to the response with the 201 status

Docs

Delete a static delegated prefix from a network

Operation ID: deleteNetworkAppliancePrefixesDelegatedStatic

DELETE /networks/{networkId}/appliance/prefixes/delegated/statics/{staticDelegatedPrefixId}

- added the media type application/json for the response with the status 204

Docs

Return a static delegated prefix from a network

Operation ID: getNetworkAppliancePrefixesDelegatedStatic

GET /networks/{networkId}/appliance/prefixes/delegated/statics/{staticDelegatedPrefixId}

- the response property description became nullable for the status 200

Docs

Update a static delegated prefix from a network

Operation ID: updateNetworkAppliancePrefixesDelegatedStatic

PUT /networks/{networkId}/appliance/prefixes/delegated/statics/{staticDelegatedPrefixId}

- added the optional property createdAt to the response with the 200 status

- added the optional property description to the response with the 200 status

- added the optional property origin to the response with the 200 status

- added the optional property prefix to the response with the 200 status

- added the optional property staticDelegatedPrefixId to the response with the 200 status

- added the optional property updatedAt to the response with the 200 status

staticRoutes

Docs

Add a static route for an MX or teleworker network

Operation ID: createNetworkApplianceStaticRoute

POST /networks/{networkId}/appliance/staticRoutes

- the gatewayVlanId request property type/format changed from string/ to `integer`/

- the gatewayVlanId request property's max was set to 4094.00

- the gatewayVlanId request property's min was set to 0.00

Docs

Update a static route for an MX or teleworker network

Operation ID: updateNetworkApplianceStaticRoute

PUT /networks/{networkId}/appliance/staticRoutes/{staticRouteId}

- the gatewayVlanId request property type/format changed from string/ to `integer`/

- the gatewayVlanId request property's max was set to 4094.00

- the gatewayVlanId request property's min was set to 0.00

[ clients ]

general

Docs

Return the client associated with the given identifier

Operation ID: getNetworkClient

GET /networks/{networkId}/clients/{clientId}

- added the optional property recentDeviceId to the response with the 200 status

[ devices ]

appliance

Docs

Update configurations for an appliance's specified port

Operation ID: updateDeviceApplianceInterfacesPort

PUT /devices/{serial}/appliance/interfaces/ports/{number}

- added the new optional request property downlink

- added the optional property interface to the response with the 200 status

- added the optional property personality/layer to the response with the 200 status

Docs

Return the uplink settings for a secure router or security appliance

Operation ID: getDeviceApplianceUplinksSettings

GET /devices/{serial}/appliance/uplinks/settings

- added the optional property interfaces/wan1/transition to the response with the 200 status

- added the optional property interfaces/wan2/transition to the response with the 200 status

Docs

Update the uplink settings for a secure router or security appliance

Operation ID: updateDeviceApplianceUplinksSettings

PUT /devices/{serial}/appliance/uplinks/settings

- added the new optional request property interfaces/wan1/transition

- added the new optional request property interfaces/wan2/transition

- added the optional property interfaces/wan1/transition to the response with the 200 status

- added the optional property interfaces/wan2/transition to the response with the 200 status

liveTools

Docs

Return an OSPF neighbors live tool job.

Operation ID: getDeviceLiveToolsOspfNeighbor

GET /devices/{serial}/liveTools/ospfNeighbors/{ospfNeighborsId}

- added the optional property routers/items/interfaceName to the response with the 200 status

switch

Docs

List layer 3 interfaces for a switch

Operation ID: getDeviceSwitchRoutingInterfaces

GET /devices/{serial}/switch/routing/interfaces

- added the optional property /items/mtu to the response with the 200 status

Docs

Create a layer 3 interface for a switch

Operation ID: createDeviceSwitchRoutingInterface

POST /devices/{serial}/switch/routing/interfaces

- added the new optional request property mtu

- added the optional property mtu to the response with the 201 status

Docs

Return a layer 3 interface for a switch

Operation ID: getDeviceSwitchRoutingInterface

GET /devices/{serial}/switch/routing/interfaces/{interfaceId}

- added the optional property mtu to the response with the 200 status

Docs

Update a layer 3 interface for a switch

Operation ID: updateDeviceSwitchRoutingInterface

PUT /devices/{serial}/switch/routing/interfaces/{interfaceId}

- added the new optional request property mtu

- added the optional property mtu to the response with the 200 status

wireless

Docs

Return the position for a wireless device

Operation ID: getDeviceWirelessRadioAfcPosition

GET /devices/{serial}/wireless/radio/afc/position

- added the optional property height/aboveFloor to the response with the 200 status

Docs

Update the position attributes for this device

Operation ID: updateDeviceWirelessRadioAfcPosition

PUT /devices/{serial}/wireless/radio/afc/position

- added the new optional request property height/aboveFloor

- added the optional property height/aboveFloor to the response with the 200 status

[ floorPlans ]

general

Docs

List the floor plans that belong to your network

Operation ID: getNetworkFloorPlans

GET /networks/{networkId}/floorPlans

- added the optional property /items/buildingId to the response with the 200 status

- added the optional property /items/devices/items/height to the response with the 200 status

Docs

Upload a floor plan

Operation ID: createNetworkFloorPlan

POST /networks/{networkId}/floorPlans

- added the new optional request property buildingId

- added the optional property buildingId to the response with the 201 status

- added the optional property devices/items/height to the response with the 201 status

Docs

Destroy a floor plan

Operation ID: deleteNetworkFloorPlan

DELETE /networks/{networkId}/floorPlans/{floorPlanId}

- added the optional property buildingId to the response with the 204 status

- added the optional property devices/items/height to the response with the 204 status

Docs

Find a floor plan by ID

Operation ID: getNetworkFloorPlan

GET /networks/{networkId}/floorPlans/{floorPlanId}

- added the optional property buildingId to the response with the 200 status

- added the optional property devices/items/height to the response with the 200 status

Docs

Update a floor plan's geolocation and other meta data

Operation ID: updateNetworkFloorPlan

PUT /networks/{networkId}/floorPlans/{floorPlanId}

- added the new optional request property buildingId

- added the optional property buildingId to the response with the 200 status

- added the optional property devices/items/height to the response with the 200 status

[ organizations ]

appliance

Docs

Returns port configurations for appliances in a given organization

Operation ID: getOrganizationApplianceDevicesInterfacesPortsByDevice

GET /organizations/{organizationId}/appliance/devices/interfaces/ports/byDevice

- added the optional property items/items/ports/items/interface to the response with the 200 status

- added the optional property items/items/ports/items/personality/layer to the response with the 200 status

assurance

Docs

Given a client, return current topology

Operation ID: getOrganizationAssuranceClientsTopologyNew

GET /organizations/{organizationId}/assurance/clients/topology/new

- added the optional property /items/items/items/topology/path/items/isAurora2 to the response with the 200 status

Docs

Returns the top wireless service-level insights for the specified time window, including each network and the impacted client count per metric.

Operation ID: getOrganizationAssuranceWirelessExperienceClientsInsights

GET /organizations/{organizationId}/assurance/wireless/experience/clients/insights

- added the new coverage enum value to the items/items/metric/name response property for the response status 200

Docs

Summarizes wireless connection successes and failures by client.

Operation ID: getOrganizationAssuranceWirelessExperienceSuccessfulConnectsByNetworkByClient

GET /organizations/{organizationId}/assurance/wireless/experience/successfulConnects/byNetwork/byClient

- removed the optional property /items/items/items/connections from the response with the 200 status

Docs

Summarizes wireless connection successes and failures by device.

Operation ID: getOrganizationAssuranceWirelessExperienceSuccessfulConnectsByNetworkByDevice

GET /organizations/{organizationId}/assurance/wireless/experience/successfulConnects/byNetwork/byDevice

- removed the optional property /items/items/items/connections from the response with the 200 status

Docs

Summarizes wireless connection successes and failures by ssid.

Operation ID: getOrganizationAssuranceWirelessExperienceSuccessfulConnectsByNetworkBySsid

GET /organizations/{organizationId}/assurance/wireless/experience/successfulConnects/byNetwork/bySsid

- removed the optional property /items/items/items/connections from the response with the 200 status

Docs

Summarizes wireless time to connect metrics by client.

Operation ID: getOrganizationAssuranceWirelessExperienceTimeToConnectByNetworkByClient

GET /organizations/{organizationId}/assurance/wireless/experience/timeToConnect/byNetwork/byClient

- removed the optional property /items/items/items/connections from the response with the 200 status

Docs

Summarizes wireless connection time to connect metrics by device.

Operation ID: getOrganizationAssuranceWirelessExperienceTimeToConnectByNetworkByDevice

GET /organizations/{organizationId}/assurance/wireless/experience/timeToConnect/byNetwork/byDevice

- removed the optional property /items/items/items/connections from the response with the 200 status

Docs

Summarizes wireless connection time to connect metrics by ssid.

Operation ID: getOrganizationAssuranceWirelessExperienceTimeToConnectByNetworkBySsid

GET /organizations/{organizationId}/assurance/wireless/experience/timeToConnect/byNetwork/bySsid

- removed the optional property /items/items/items/connections from the response with the 200 status

inventory

POST /organizations/{organizationId}/inventory/onboarding/cloudMonitoring/exportEvents

- api path removed with deprecation

GET /organizations/{organizationId}/inventory/onboarding/cloudMonitoring/imports

- api path removed with deprecation

POST /organizations/{organizationId}/inventory/onboarding/cloudMonitoring/imports

- api path removed with deprecation

GET /organizations/{organizationId}/inventory/onboarding/cloudMonitoring/networks

- api path removed with deprecation

POST /organizations/{organizationId}/inventory/onboarding/cloudMonitoring/prepare

- api path removed with deprecation

sase

POST /organizations/{organizationId}/sase/connectors/batchCreate

- api path removed without deprecation

wireless

Docs

Returns the current Air Marshal rules for this organization

Operation ID: getOrganizationWirelessAirMarshalRules

GET /organizations/{organizationId}/wireless/airMarshal/rules

- the endpoint scheme security oauth2 was added to the API

Docs

List access point client count at the moment in an organization

Operation ID: getOrganizationWirelessClientsOverviewByDevice

GET /organizations/{organizationId}/wireless/clients/overview/byDevice

- the endpoint scheme security oauth2 was added to the API

Docs

Show the by-network client information for the organization in the given interval

Operation ID: byOrganizationWirelessClientsRfHealthOverviewNetwork

GET /organizations/{organizationId}/wireless/clients/rfHealth/overview/byNetwork

- the endpoint scheme security oauth2 was added to the API

Docs

Get average packet loss for the given timespan for all networks in the organization.

Operation ID: getOrganizationWirelessDevicesPacketLossByNetwork

GET /organizations/{organizationId}/wireless/devices/packetLoss/byNetwork

- the endpoint scheme security oauth2 was added to the API

Docs

Return the CPU Load history for a list of wireless devices in the organization.

Operation ID: getOrganizationWirelessDevicesSystemCpuLoadHistory

GET /organizations/{organizationId}/wireless/devices/system/cpu/load/history

- the endpoint scheme security oauth2 was added to the API

Docs

List the AFC power limits of an organization by device

Operation ID: getOrganizationWirelessRadioAfcPositionByDevice

GET /organizations/{organizationId}/wireless/radio/afc/position/byDevice

- added the optional property /items/height/aboveFloor to the response with the 200 status

Docs

List the RF profiles of an organization by device

Operation ID: getOrganizationWirelessRfProfilesAssignmentsByDevice

GET /organizations/{organizationId}/wireless/rfProfiles/assignments/byDevice

- the endpoint scheme security oauth2 was added to the API

[ switch ]

stacks

Docs

List layer 3 interfaces for a switch stack

Operation ID: getNetworkSwitchStackRoutingInterfaces

GET /networks/{networkId}/switch/stacks/{switchStackId}/routing/interfaces

- added the optional property /items/mtu to the response with the 200 status

Docs

Create a layer 3 interface for a switch stack

Operation ID: createNetworkSwitchStackRoutingInterface

POST /networks/{networkId}/switch/stacks/{switchStackId}/routing/interfaces

- added the new optional request property mtu

- added the optional property mtu to the response with the 201 status

Docs

Return a layer 3 interface from a switch stack

Operation ID: getNetworkSwitchStackRoutingInterface

GET /networks/{networkId}/switch/stacks/{switchStackId}/routing/interfaces/{interfaceId}

- added the optional property mtu to the response with the 200 status

Docs

Update a layer 3 interface for a switch stack

Operation ID: updateNetworkSwitchStackRoutingInterface

PUT /networks/{networkId}/switch/stacks/{switchStackId}/routing/interfaces/{interfaceId}

- added the new optional request property mtu

- added the optional property mtu to the response with the 200 status

[ wireless ]

clients

Docs

Fetch the health scores for all clients on this network

Operation ID: getNetworkWirelessClientsHealthScores

GET /networks/{networkId}/wireless/clients/healthScores

- the endpoint scheme security oauth2 was added to the API

Docs

Return counts of distinct wireless clients connecting to a network over time

Operation ID: getNetworkWirelessClientsOnboardingHistory

GET /networks/{networkId}/wireless/clients/onboardingHistory

- the endpoint scheme security oauth2 was added to the API

ssids

Docs

List the MR SSIDs in a network

Operation ID: getNetworkWirelessSsids

GET /networks/{networkId}/wireless/ssids

- added the optional property /items/psk to the response with the 200 status

Docs

Return a single MR SSID

Operation ID: getNetworkWirelessSsid

GET /networks/{networkId}/wireless/ssids/{number}

- added the optional property psk to the response with the 200 status

Docs

Update the attributes of an MR SSID

Operation ID: updateNetworkWirelessSsid

PUT /networks/{networkId}/wireless/ssids/{number}

- added the new optional request property campusGateway

- added the optional property psk to the response with the 200 status

v1.69.0-beta.2

• Added
  • [ organizations ]
    • api
      • List pipeline IDs for the organization, with optional status and timespan filtering
    • assurance
      • Summarizes wireless post connection capacity successes and failures by network.
      • Summarizes wireless post connection capacity successes and failures by band.
      • Summarizes wireless post connection capacity successes and failures by network.
      • Summarizes wireless post connection capacity successes and failures by client OS.
      • Summarizes wireless post connection capacity successes and failures by network.
      • Summarizes wireless post connection capacity successes and failures by device.
      • Time-series of wireless post connection capacity successes and failures by network.
      • Summarizes wireless post connection capacity successes and failures by ssid.
      • Provides insights into wireless capacity experience by network.
    • devices
      • Provides devices that are available to be assigned to a given Cellular Data Management Profile
      • Listing of Cellular Data Management Profiles for the organization.
      • Add a Cellular Data Management Profile to the organization.
      • List assignments
      • Assign a Cellular Data Management Profile to devices
      • Unassign a Cellular Data Management Profile from devices
      • Delete a Cellular Data Management Profile from the organization.
      • Update a Cellular Data Management Profile
      • Provides current usage statistics for devices in the organization
      • Provides the cellular data usage history per device and per SIM.
    • nac
      • Get all known clients for the organization
      • Create a client for the organization
      • Delete existing client(s) for the organization
      • Bulk Update of existing clients for the organization
      • Bulk upload of clients, client groups and their associations for the organization
      • Get all known client groups for the organization
      • Create a client group for the organization
      • Delete an existing client group for the organization
      • Update an existing client group for the organization with bulk member operations
      • Get overview data for all known clients for the organization
      • Update an existing client for the organization
• Changed
  • [ appliance ]
    • firewall
      • Return the cellular firewall rules for an MX network
      • Update the cellular firewall rules of an MX network
      • Return the inbound firewall rules for an MX network
      • Return the 1:Many NAT mapping rules for an MX network
      • Set the 1:Many NAT mapping rules for an MX network
      • Return the 1:1 NAT mapping rules for an MX network
      • Set the 1:1 NAT mapping rules for an MX network
    • sdwan
      • Update SDWAN internet traffic preferences for an MX network
    • trafficShaping
      • Updates the uplink bandwidth settings for your MX network.
  • [ camera ]
    • qualityRetentionProfiles
      • Creates new quality retention profile for this network.
      • Update an existing quality retention profile for this network.
  • [ organizations ]
    • appliance
      • Returns an overview of uplink statuses
      • Return the third party VPN peers for an organization
      • Update the third party VPN peers for an organization
    • assurance
      • Return all health alerts for an organization
      • Return overview of active health alerts for an organization
      • Return a Summary of Alerts grouped by type and severity
      • Return a singular Health Alert by its id
      • Given a client, return current topology
      • Summarizes wireless coverage successes and failures by client.
      • Provides insights into wireless coverage experience by network.
      • Summarizes wireless connection successes and failures by client.
      • Provides insights into wireless successful connects experience by network.
      • Summarizes wireless time to connect metrics by client.
      • Provides insights into wireless time to connect experience by network.
      • Return workflows filtered by organization ID, network ID, type, and category
    • devices
      • Enqueues a task for a specific packet capture
      • Retrieves packet capture analysis result for a specific packet capture task.
    • inventory
      • Return the device inventory for an organization
      • Return a single device from the inventory of an organization
      • Preview the results and status of an order claim by the secure order id
    • switch
      • List the port profiles in an organization
      • List the port profiles in an organization
      • Returns Spanning Tree configuration settings
  • [ switch ]
    • spanningTree
      • Updates Spanning Tree configuration
  • [ traffic ]
    • general
      • Return the traffic analysis data for this network
  • [ trafficShaping ]
    • applicationCategories
      • Returns the application categories for traffic shaping rules

Version v1.69.0-beta.1 to v1.69.0-beta.2

Summary of Changes

31 - New

46 - Updated

881 - Total Endpoints

599 - Total Paths

Added

[ organizations ]

api

Docs

List pipeline IDs for the organization, with optional status and timespan filtering

Operation ID: getOrganizationApiRestProvisioningPipelines

PATH /organizations/{organizationId}/api/rest/provisioning/pipelines

- Path added

- New endpoint

GET /organizations/{organizationId}/api/rest/provisioning/pipelines

---

assurance

Docs

Summarizes wireless post connection capacity successes and failures by network.

Operation ID: getOrganizationAssuranceWirelessExperienceChannelAvailabilityByNetwork

PATH /organizations/{organizationId}/assurance/wireless/experience/channelAvailability/byNetwork

- Path added

- New endpoint

GET /organizations/{organizationId}/assurance/wireless/experience/channelAvailability/byNetwork

---

Docs

Summarizes wireless post connection capacity successes and failures by band.

Operation ID: getOrganizationAssuranceWirelessExperienceChannelAvailabilityByNetworkByBand

PATH /organizations/{organizationId}/assurance/wireless/experience/channelAvailability/byNetwork/byBand

- Path added

- New endpoint

GET /organizations/{organizationId}/assurance/wireless/experience/channelAvailability/byNetwork/byBand

---

Docs

Summarizes wireless post connection capacity successes and failures by network.

Operation ID: getOrganizationAssuranceWirelessExperienceChannelAvailabilityByNetworkByClient

PATH /organizations/{organizationId}/assurance/wireless/experience/channelAvailability/byNetwork/byClient

- Path added

- New endpoint

GET /organizations/{organizationId}/assurance/wireless/experience/channelAvailability/byNetwork/byClient

---

Docs

Summarizes wireless post connection capacity successes and failures by client OS.

Operation ID: getOrganizationAssuranceWirelessExperienceChannelAvailabilityByNetworkByClientOs

PATH /organizations/{organizationId}/assurance/wireless/experience/channelAvailability/byNetwork/byClientOs

- Path added

- New endpoint

GET /organizations/{organizationId}/assurance/wireless/experience/channelAvailability/byNetwork/byClientOs

---

Docs

Summarizes wireless post connection capacity successes and failures by network.

Operation ID: getOrganizationAssuranceWirelessExperienceChannelAvailabilityByNetworkByClientType

PATH /organizations/{organizationId}/assurance/wireless/experience/channelAvailability/byNetwork/byClientType

- Path added

- New endpoint

GET /organizations/{organizationId}/assurance/wireless/experience/channelAvailability/byNetwork/byClientType

---

Docs

Summarizes wireless post connection capacity successes and failures by device.

Operation ID: getOrganizationAssuranceWirelessExperienceChannelAvailabilityByNetworkByDevice

PATH /organizations/{organizationId}/assurance/wireless/experience/channelAvailability/byNetwork/byDevice

- Path added

- New endpoint

GET /organizations/{organizationId}/assurance/wireless/experience/channelAvailability/byNetwork/byDevice

---

Docs

Time-series of wireless post connection capacity successes and failures by network.

Operation ID: getOrganizationAssuranceWirelessExperienceChannelAvailabilityByNetworkByInterval

PATH /organizations/{organizationId}/assurance/wireless/experience/channelAvailability/byNetwork/byInterval

- Path added

- New endpoint

GET /organizations/{organizationId}/assurance/wireless/experience/channelAvailability/byNetwork/byInterval

---

Docs

Summarizes wireless post connection capacity successes and failures by ssid.

Operation ID: getOrganizationAssuranceWirelessExperienceChannelAvailabilityByNetworkBySsid

PATH /organizations/{organizationId}/assurance/wireless/experience/channelAvailability/byNetwork/bySsid

- Path added

- New endpoint

GET /organizations/{organizationId}/assurance/wireless/experience/channelAvailability/byNetwork/bySsid

---

Docs

Provides insights into wireless capacity experience by network.

Operation ID: getOrganizationAssuranceWirelessExperienceChannelAvailabilityInsightsByNetwork

PATH /organizations/{organizationId}/assurance/wireless/experience/channelAvailability/insights/byNetwork

- Path added

- New endpoint

GET /organizations/{organizationId}/assurance/wireless/experience/channelAvailability/insights/byNetwork

---

devices

Docs

Provides devices that are available to be assigned to a given Cellular Data Management Profile

Operation ID: getOrganizationDevicesCellularDataDevices

PATH /organizations/{organizationId}/devices/cellular/data/devices

- Path added

- New endpoint

GET /organizations/{organizationId}/devices/cellular/data/devices

---

Docs

Listing of Cellular Data Management Profiles for the organization.

Operation ID: getOrganizationDevicesCellularDataProfiles

PATH /organizations/{organizationId}/devices/cellular/data/profiles

- Path added

- New endpoint

GET /organizations/{organizationId}/devices/cellular/data/profiles

---

Docs

Add a Cellular Data Management Profile to the organization.

Operation ID: createOrganizationDevicesCellularDataProfile

PATH /organizations/{organizationId}/devices/cellular/data/profiles

- Path added

- New endpoint

POST /organizations/{organizationId}/devices/cellular/data/profiles

---

Docs

List assignments

Operation ID: getOrganizationDevicesCellularDataProfilesAssignments

PATH /organizations/{organizationId}/devices/cellular/data/profiles/assignments

- Path added

- New endpoint

GET /organizations/{organizationId}/devices/cellular/data/profiles/assignments

---

Docs

Assign a Cellular Data Management Profile to devices

Operation ID: bulkOrganizationDevicesCellularDataProfilesAssignmentsCreate

PATH /organizations/{organizationId}/devices/cellular/data/profiles/assignments/bulkCreate

- Path added

- New endpoint

POST /organizations/{organizationId}/devices/cellular/data/profiles/assignments/bulkCreate

---

Docs

Unassign a Cellular Data Management Profile from devices

Operation ID: bulkOrganizationDevicesCellularDataProfilesAssignmentsDelete

PATH /organizations/{organizationId}/devices/cellular/data/profiles/assignments/bulkDelete

- Path added

- New endpoint

POST /organizations/{organizationId}/devices/cellular/data/profiles/assignments/bulkDelete

---

Docs

Delete a Cellular Data Management Profile from the organization.

Operation ID: deleteOrganizationDevicesCellularDataProfile

PATH /organizations/{organizationId}/devices/cellular/data/profiles/{profileId}

- Path added

- New endpoint

DELETE /organizations/{organizationId}/devices/cellular/data/profiles/{profileId}

---

Docs

Update a Cellular Data Management Profile

Operation ID: updateOrganizationDevicesCellularDataProfile

PATH /organizations/{organizationId}/devices/cellular/data/profiles/{profileId}

- Path added

- New endpoint

PUT /organizations/{organizationId}/devices/cellular/data/profiles/{profileId}

---

Docs

Provides current usage statistics for devices in the organization

Operation ID: getOrganizationDevicesCellularDataUsageByDevice

PATH /organizations/{organizationId}/devices/cellular/data/usage/byDevice

- Path added

- New endpoint

GET /organizations/{organizationId}/devices/cellular/data/usage/byDevice

---

Docs

Provides the cellular data usage history per device and per SIM.

Operation ID: getOrganizationDevicesCellularDataUsageHistoryByDeviceByInterval

PATH /organizations/{organizationId}/devices/cellular/data/usage/history/byDevice/byInterval

- Path added

- New endpoint

GET /organizations/{organizationId}/devices/cellular/data/usage/history/byDevice/byInterval

---

nac

Docs

Get all known clients for the organization

Operation ID: getOrganizationNacClients

PATH /organizations/{organizationId}/nac/clients

- Path added

- New endpoint

GET /organizations/{organizationId}/nac/clients

---

Docs

Create a client for the organization

Operation ID: createOrganizationNacClient

PATH /organizations/{organizationId}/nac/clients

- Path added

- New endpoint

POST /organizations/{organizationId}/nac/clients

---

Docs

Delete existing client(s) for the organization

Operation ID: bulkOrganizationNacClientsDelete

PATH /organizations/{organizationId}/nac/clients/bulkDelete

- Path added

- New endpoint

POST /organizations/{organizationId}/nac/clients/bulkDelete

---

Docs

Bulk Update of existing clients for the organization

Operation ID: createOrganizationNacClientsBulkEdit

PATH /organizations/{organizationId}/nac/clients/bulkEdit

- Path added

- New endpoint

POST /organizations/{organizationId}/nac/clients/bulkEdit

---

Docs

Bulk upload of clients, client groups and their associations for the organization

Operation ID: createOrganizationNacClientsBulkUpload

PATH /organizations/{organizationId}/nac/clients/bulkUpload

- Path added

- New endpoint

POST /organizations/{organizationId}/nac/clients/bulkUpload

---

Docs

Get all known client groups for the organization

Operation ID: getOrganizationNacClientsGroups

PATH /organizations/{organizationId}/nac/clients/groups

- Path added

- New endpoint

GET /organizations/{organizationId}/nac/clients/groups

---

Docs

Create a client group for the organization

Operation ID: createOrganizationNacClientsGroup

PATH /organizations/{organizationId}/nac/clients/groups

- Path added

- New endpoint

POST /organizations/{organizationId}/nac/clients/groups

---

Docs

Delete an existing client group for the organization

Operation ID: deleteOrganizationNacClientsGroup

PATH /organizations/{organizationId}/nac/clients/groups/{groupId}

- Path added

- New endpoint

DELETE /organizations/{organizationId}/nac/clients/groups/{groupId}

---

Docs

Update an existing client group for the organization with bulk member operations

Operation ID: updateOrganizationNacClientsGroup

PATH /organizations/{organizationId}/nac/clients/groups/{groupId}

- Path added

- New endpoint

PUT /organizations/{organizationId}/nac/clients/groups/{groupId}

---

Docs

Get overview data for all known clients for the organization

Operation ID: getOrganizationNacClientsOverview

PATH /organizations/{organizationId}/nac/clients/overview

- Path added

- New endpoint

GET /organizations/{organizationId}/nac/clients/overview

---

Docs

Update an existing client for the organization

Operation ID: updateOrganizationNacClient

PATH /organizations/{organizationId}/nac/clients/{clientId}

- Path added

- New endpoint

PUT /organizations/{organizationId}/nac/clients/{clientId}

---

Changed

[ appliance ]

firewall

Docs

Return the cellular firewall rules for an MX network

Operation ID: getNetworkApplianceFirewallCellularFirewallRules

GET /networks/{networkId}/appliance/firewall/cellularFirewallRules

- added the optional property rules to the response with the 200 status

Docs

Update the cellular firewall rules of an MX network

Operation ID: updateNetworkApplianceFirewallCellularFirewallRules

PUT /networks/{networkId}/appliance/firewall/cellularFirewallRules

- added the optional property rules to the response with the 200 status

Docs

Return the inbound firewall rules for an MX network

Operation ID: getNetworkApplianceFirewallInboundFirewallRules

GET /networks/{networkId}/appliance/firewall/inboundFirewallRules

- the endpoint scheme security oauth2 was added to the API

Docs

Return the 1:Many NAT mapping rules for an MX network

Operation ID: getNetworkApplianceFirewallOneToManyNatRules

GET /networks/{networkId}/appliance/firewall/oneToManyNatRules

- added the optional property rules to the response with the 200 status

Docs

Set the 1:Many NAT mapping rules for an MX network

Operation ID: updateNetworkApplianceFirewallOneToManyNatRules

PUT /networks/{networkId}/appliance/firewall/oneToManyNatRules

- added the optional property rules to the response with the 200 status

Docs

Return the 1:1 NAT mapping rules for an MX network

Operation ID: getNetworkApplianceFirewallOneToOneNatRules

GET /networks/{networkId}/appliance/firewall/oneToOneNatRules

- added the optional property rules to the response with the 200 status

Docs

Set the 1:1 NAT mapping rules for an MX network

Operation ID: updateNetworkApplianceFirewallOneToOneNatRules

PUT /networks/{networkId}/appliance/firewall/oneToOneNatRules

- added the optional property rules to the response with the 200 status

sdwan

Docs

Update SDWAN internet traffic preferences for an MX network

Operation ID: updateNetworkApplianceSdwanInternetPolicies

PUT /networks/{networkId}/appliance/sdwan/internetPolicies

- the endpoint scheme security oauth2 was added to the API

trafficShaping

Docs

Updates the uplink bandwidth settings for your MX network.

Operation ID: updateNetworkApplianceTrafficShapingUplinkBandwidth

PUT /networks/{networkId}/appliance/trafficShaping/uplinkBandwidth

- added the optional property bandwidthLimits to the response with the 200 status

[ camera ]

qualityRetentionProfiles

Docs

Creates new quality retention profile for this network.

Operation ID: createNetworkCameraQualityRetentionProfile

POST /networks/{networkId}/camera/qualityRetentionProfiles

- added the new optional request property videoSettings/MV44X

Docs

Update an existing quality retention profile for this network.

Operation ID: updateNetworkCameraQualityRetentionProfile

PUT /networks/{networkId}/camera/qualityRetentionProfiles/{qualityRetentionProfileId}

- added the new optional request property videoSettings/MV44X

[ organizations ]

appliance

Docs

Returns an overview of uplink statuses

Operation ID: getOrganizationApplianceUplinksStatusesOverview

GET /organizations/{organizationId}/appliance/uplinks/statuses/overview

- the endpoint scheme security oauth2 was added to the API

Docs

Return the third party VPN peers for an organization

Operation ID: getOrganizationApplianceVpnThirdPartyVPNPeers

GET /organizations/{organizationId}/appliance/vpn/thirdPartyVPNPeers

- added the optional property peers/items/ebgpNeighbor/receiveLimit to the response with the 200 status

Docs

Update the third party VPN peers for an organization

Operation ID: updateOrganizationApplianceVpnThirdPartyVPNPeers

PUT /organizations/{organizationId}/appliance/vpn/thirdPartyVPNPeers

- added the optional property peers/items/ebgpNeighbor/receiveLimit to the response with the 200 status

assurance

Docs

Return all health alerts for an organization

Operation ID: getOrganizationAssuranceAlerts

GET /organizations/{organizationId}/assurance/alerts

- added the required property /items/network/url to the response with the 200 status

Docs

Return overview of active health alerts for an organization

Operation ID: getOrganizationAssuranceAlertsOverview

GET /organizations/{organizationId}/assurance/alerts/overview

- the endpoint scheme security oauth2 was added to the API

Docs

Return a Summary of Alerts grouped by type and severity

Operation ID: getOrganizationAssuranceAlertsOverviewByType

GET /organizations/{organizationId}/assurance/alerts/overview/byType

- the endpoint scheme security oauth2 was added to the API

Docs

Return a singular Health Alert by its id

Operation ID: getOrganizationAssuranceAlert

GET /organizations/{organizationId}/assurance/alerts/{id}

- added the required property network/url to the response with the 200 status

Docs

Given a client, return current topology

Operation ID: getOrganizationAssuranceClientsTopologyCurrent

GET /organizations/{organizationId}/assurance/clients/topology/current

- the endpoint scheme security oauth2 was added to the API

GET /organizations/{organizationId}/assurance/wireless/experience/capacity/byNetwork

- api path removed without deprecation

GET /organizations/{organizationId}/assurance/wireless/experience/capacity/byNetwork/byBand

- api path removed without deprecation

GET /organizations/{organizationId}/assurance/wireless/experience/capacity/byNetwork/byClient

- api path removed without deprecation

GET /organizations/{organizationId}/assurance/wireless/experience/capacity/byNetwork/byClientOs

- api path removed without deprecation

GET /organizations/{organizationId}/assurance/wireless/experience/capacity/byNetwork/byClientType

- api path removed without deprecation

GET /organizations/{organizationId}/assurance/wireless/experience/capacity/byNetwork/byDevice

- api path removed without deprecation

GET /organizations/{organizationId}/assurance/wireless/experience/capacity/byNetwork/byInterval

- api path removed without deprecation

GET /organizations/{organizationId}/assurance/wireless/experience/capacity/byNetwork/bySsid

- api path removed without deprecation

GET /organizations/{organizationId}/assurance/wireless/experience/capacity/insights/byNetwork

- api path removed without deprecation

Docs

Summarizes wireless coverage successes and failures by client.

Operation ID: getOrganizationAssuranceWirelessExperienceCoverageByNetworkByClient

GET /organizations/{organizationId}/assurance/wireless/experience/coverage/byNetwork/byClient

- added the optional property /items/items/items/client/username to the response with the 200 status

Docs

Provides insights into wireless coverage experience by network.

Operation ID: getOrganizationAssuranceWirelessExperienceCoverageInsightsByNetwork

GET /organizations/{organizationId}/assurance/wireless/experience/coverage/insights/byNetwork

- removed the optional property /items/items/items/insights/items/entities/items/excessFailures from the response with the 200 status

- removed the optional property /items/items/items/insights/items/entities/items/failures from the response with the 200 status

- removed the optional property /items/items/items/insights/items/entities/items/relativeRisk from the response with the 200 status

- removed the optional property /items/items/items/insights/items/entities/items/uncertaintyExplainedPercent from the response with the 200 status

Docs

Summarizes wireless connection successes and failures by client.

Operation ID: getOrganizationAssuranceWirelessExperienceSuccessfulConnectsByNetworkByClient

GET /organizations/{organizationId}/assurance/wireless/experience/successfulConnects/byNetwork/byClient

- added the optional property /items/items/items/client/name to the response with the 200 status

- added the optional property /items/items/items/client/username to the response with the 200 status

Docs

Provides insights into wireless successful connects experience by network.

Operation ID: getOrganizationAssuranceWirelessExperienceSuccessfulConnectsInsightsByNetwork

GET /organizations/{organizationId}/assurance/wireless/experience/successfulConnects/insights/byNetwork

- removed the optional property /items/items/items/insights/items/entities/items/excessFailures from the response with the 200 status

- removed the optional property /items/items/items/insights/items/entities/items/failures from the response with the 200 status

- removed the optional property /items/items/items/insights/items/entities/items/relativeRisk from the response with the 200 status

- removed the optional property /items/items/items/insights/items/entities/items/serverHealth from the response with the 200 status

- removed the optional property /items/items/items/insights/items/entities/items/uncertaintyExplainedPercent from the response with the 200 status

Docs

Summarizes wireless time to connect metrics by client.

Operation ID: getOrganizationAssuranceWirelessExperienceTimeToConnectByNetworkByClient

GET /organizations/{organizationId}/assurance/wireless/experience/timeToConnect/byNetwork/byClient

- added the optional property /items/items/items/client/name to the response with the 200 status

- added the optional property /items/items/items/client/username to the response with the 200 status

Docs

Provides insights into wireless time to connect experience by network.

Operation ID: getOrganizationAssuranceWirelessExperienceTimeToConnectInsightsByNetwork

GET /organizations/{organizationId}/assurance/wireless/experience/timeToConnect/insights/byNetwork

- removed the optional property /items/items/items/insights/items/entities/items/excessFailures from the response with the 200 status

- removed the optional property /items/items/items/insights/items/entities/items/failures from the response with the 200 status

- removed the optional property /items/items/items/insights/items/entities/items/relativeRisk from the response with the 200 status

- removed the optional property /items/items/items/insights/items/entities/items/serverHealth from the response with the 200 status

- removed the optional property /items/items/items/insights/items/entities/items/uncertaintyExplainedPercent from the response with the 200 status

Docs

Return workflows filtered by organization ID, network ID, type, and category

Operation ID: getOrganizationAssuranceWorkflows

GET /organizations/{organizationId}/assurance/workflows

- the endpoint scheme security oauth2 was added to the API

devices

Docs

Enqueues a task for a specific packet capture

Operation ID: tasksOrganizationDevicesPacketCapture

POST /organizations/{organizationId}/devices/packetCaptures/{packetId}/tasks

- the security scope dashboard:general:telemetry:write was added to the endpoint's security scheme oauth2

- the security scope dashboard:general:telemetry:packetcapture:read was removed from the endpoint's security scheme oauth2

Docs

Retrieves packet capture analysis result for a specific packet capture task.

Operation ID: getOrganizationDevicesPacketCaptureTask

GET /organizations/{organizationId}/devices/packetCaptures/{packetId}/tasks/{id}

- the security scope dashboard:general:telemetry:read was added to the endpoint's security scheme oauth2

- the security scope dashboard:general:telemetry:packetcapture:read was removed from the endpoint's security scheme oauth2

inventory

Docs

Return the device inventory for an organization

Operation ID: getOrganizationInventoryDevices

GET /organizations/{organizationId}/inventory/devices

- added the optional property /items/sku to the response with the 200 status

Docs

Return a single device from the inventory of an organization

Operation ID: getOrganizationInventoryDevice

GET /organizations/{organizationId}/inventory/devices/{serial}

- added the optional property sku to the response with the 200 status

Docs

Preview the results and status of an order claim by the secure order id

Operation ID: previewOrganizationInventoryOrders

POST /organizations/{organizationId}/inventory/orders/preview

- added the optional property resolution to the response with the 200 status

switch

Docs

List the port profiles in an organization

Operation ID: getOrganizationSwitchPortsProfiles

GET /organizations/{organizationId}/switch/ports/profiles

- the /items/counts/assigned/automations response's property type/format changed from integer/ to `object`/ for status 200

- the /items/counts/assigned/ports response's property type/format changed from integer/ to `object`/ for status 200

- removed the optional property /items/counts/assigned/switches from the response with the 200 status

- removed the optional property /items/counts/networkCounts from the response with the 200 status

- added the optional property /items/counts/assigned/automations/total to the response with the 200 status

- added the optional property /items/counts/assigned/devices to the response with the 200 status

- added the optional property /items/counts/assigned/ports/byProductType to the response with the 200 status

- added the optional property /items/counts/assigned/ports/total to the response with the 200 status

- added the optional property /items/counts/networks to the response with the 200 status

Docs

List the port profiles in an organization

Operation ID: getOrganizationSwitchPortsProfilesOverviewByProfile

GET /organizations/{organizationId}/switch/ports/profiles/overview/byProfile

- the /items/items/items/counts/assigned/automations response's property type/format changed from integer/ to `object`/ for status 200

- the /items/items/items/counts/assigned/ports response's property type/format changed from integer/ to `object`/ for status 200

- removed the optional property /items/items/items/counts/assigned/switches from the response with the 200 status

- removed the optional property /items/items/items/counts/networkCounts from the response with the 200 status

- added the optional property /items/items/items/counts/assigned/automations/total to the response with the 200 status

- added the optional property /items/items/items/counts/assigned/devices to the response with the 200 status

- added the optional property /items/items/items/counts/assigned/ports/byProductType to the response with the 200 status

- added the optional property /items/items/items/counts/assigned/ports/total to the response with the 200 status

- added the optional property /items/items/items/counts/networks to the response with the 200 status

Docs

Returns Spanning Tree configuration settings

Operation ID: getOrganizationSwitchSpanningTree

GET /organizations/{organizationId}/switch/spanningTree

- deleted the query request parameter networkId

- removed the optional property enabled from the response with the 200 status

- removed the optional property mode from the response with the 200 status

- removed the optional property priorities from the response with the 200 status

- added the new optional query request parameter endingBefore

- added the new optional query request parameter networkIds

- added the new optional query request parameter perPage

- added the new optional query request parameter startingAfter

- added the optional property items to the response with the 200 status

- added the optional property meta to the response with the 200 status

[ switch ]

spanningTree

Docs

Updates Spanning Tree configuration

Operation ID: updateNetworkSwitchSpanningTree

PUT /networks/{networkId}/switch/spanningTree

- added the optional property networkId to the response with the 200 status

[ traffic ]

general

Docs

Return the traffic analysis data for this network

Operation ID: getNetworkTraffic

GET /networks/{networkId}/traffic

- the endpoint scheme security oauth2 was added to the API

[ trafficShaping ]

applicationCategories

Docs

Returns the application categories for traffic shaping rules

Operation ID: getNetworkTrafficShapingApplicationCategories

GET /networks/{networkId}/trafficShaping/applicationCategories

- added the optional property applicationCategories to the response with the 200 status

v1.69.0-beta.1

• Added
  • [ appliance ]
    • devices
      • Update MX warm spare settings
      • Swap MX primary and warm spare appliances
  • [ devices ]
    • liveTools
      • Enqueue a job to retrieve port status for a device
      • Return a port status live tool job.
  • [ organizations ]
    • appliance
      • Return MX warm spare settings
    • wireless
      • Get sticky client events within the specified timespan.
• Changed
  • [ appliance ]
    • contentFiltering
      • List all available content filtering categories for an MX network
    • umbrella
      • Remove one umbrella policy from your network.
  • [ organizations ]
    • assurance
      • Return a Summary of Alerts grouped by type and severity
      • Returns counts of online, offline, and recovered devices by product type, along with offline intervals for impacted devices in the organization.
      • Returns organization wireless experience metrics overview grouped by network.
    • switch
      • Create a port profile in an organization
      • Get detailed information about a port profile
      • Update a port profile in an organization
    • wireless
      • List the wireless device telemetry of an organization
  • [ switch ]
    • ports
      • List the port profiles in a network
      • Create a port profile in a network
      • Update a port profile in a network
    • settings
      • Returns the switch network settings
      • Update switch network settings

Version v1.69.0-beta.0 to v1.69.0-beta.1

Summary of Changes

6 - New

14 - Updated

856 - Total Endpoints

582 - Total Paths

Added

[ appliance ]

devices

Docs

Update MX warm spare settings

Operation ID: updateNetworkApplianceDevicesRedundancy

PATH /networks/{networkId}/appliance/devices/redundancy

- Path added

- New endpoint

PUT /networks/{networkId}/appliance/devices/redundancy

---

Docs

Swap MX primary and warm spare appliances

Operation ID: createNetworkApplianceDevicesRedundancySwap

PATH /networks/{networkId}/appliance/devices/redundancy/swap

- Path added

- New endpoint

POST /networks/{networkId}/appliance/devices/redundancy/swap

---

[ devices ]

liveTools

Docs

Enqueue a job to retrieve port status for a device

Operation ID: createDeviceLiveToolsPortStatus

PATH /devices/{serial}/liveTools/portStatus

- Path added

- New endpoint

POST /devices/{serial}/liveTools/portStatus

---

Docs

Return a port status live tool job.

Operation ID: getDeviceLiveToolsPortStatus

PATH /devices/{serial}/liveTools/portStatus/{portStatusId}

- Path added

- New endpoint

GET /devices/{serial}/liveTools/portStatus/{portStatusId}

---

[ organizations ]

appliance

Docs

Return MX warm spare settings

Operation ID: getOrganizationApplianceDevicesRedundancyByNetwork

PATH /organizations/{organizationId}/appliance/devices/redundancy/byNetwork

- Path added

- New endpoint

GET /organizations/{organizationId}/appliance/devices/redundancy/byNetwork

---

wireless

Docs

Get sticky client events within the specified timespan.

Operation ID: getOrganizationWirelessClientsStickyEvents

PATH /organizations/{organizationId}/wireless/clients/stickyEvents

- Path added

- New endpoint

GET /organizations/{organizationId}/wireless/clients/stickyEvents

---

Changed

[ appliance ]

contentFiltering

Docs

List all available content filtering categories for an MX network

Operation ID: getNetworkApplianceContentFilteringCategories

GET /networks/{networkId}/appliance/contentFiltering/categories

- added the optional property 'categories' to the response with the '200' status

umbrella

Docs

Remove one umbrella policy from your network.

Operation ID: removeNetworkApplianceUmbrellaPolicies

DELETE /networks/{networkId}/appliance/umbrella/policies/remove

- removed the success response with the status '200'

- added the success response with the status '204'

[ organizations ]

assurance

Docs

Return a Summary of Alerts grouped by type and severity

Operation ID: getOrganizationAssuranceAlertsOverviewByType

GET /organizations/{organizationId}/assurance/alerts/overview/byType

- added the new optional 'query' request parameter 'includeDeviceTags'

- added the new optional 'query' request parameter 'includeNetworks'

- added the required property 'items/items/categoryType' to the response with the '200' status

- added the required property 'items/items/deviceTags' to the response with the '200' status

- added the required property 'items/items/deviceTypes' to the response with the '200' status

- added the required property 'items/items/lastAlertedAt' to the response with the '200' status

- added the required property 'items/items/networkCount' to the response with the '200' status

- added the required property 'items/items/networks' to the response with the '200' status

- added the required property 'items/items/severity' to the response with the '200' status

Docs

Returns counts of online, offline, and recovered devices by product type, along with offline intervals for impacted devices in the organization.

Operation ID: getOrganizationAssuranceDevicesStatusesOverview

GET /organizations/{organizationId}/assurance/devices/statuses/overview

- for the 'query' request parameter 'timespan', the max was increased from '604800.00' to '1209600.00'

- for the 'query' request parameter 'timespan', the min was decreased from '3600.00' to '900.00'

Docs

Returns organization wireless experience metrics overview grouped by network.

Operation ID: getOrganizationAssuranceWirelessExperienceMetricsOverviewHistoryByNetwork

GET /organizations/{organizationId}/assurance/wireless/experience/metrics/overview/history/byNetwork

- added the optional property 'items/items/wirelessCoverage' to the response with the '200' status

switch

Docs

Create a port profile in an organization

Operation ID: createOrganizationSwitchPortsProfile

POST /organizations/{organizationId}/switch/ports/profiles

- added the new optional request property 'authentication'

- added the optional property 'authentication' to the response with the '200' status

Docs

Get detailed information about a port profile

Operation ID: getOrganizationSwitchPortsProfile

GET /organizations/{organizationId}/switch/ports/profiles/{id}

- added the optional property 'authentication' to the response with the '200' status

Docs

Update a port profile in an organization

Operation ID: updateOrganizationSwitchPortsProfile

PUT /organizations/{organizationId}/switch/ports/profiles/{id}

- added the new optional request property 'authentication'

- added the optional property 'authentication' to the response with the '200' status

wireless

Docs

List the wireless device telemetry of an organization

Operation ID: getOrganizationWirelessDevicesTelemetry

GET /organizations/{organizationId}/wireless/devices/telemetry

- the endpoint scheme security 'oauth2' was added to the API

[ switch ]

ports

Docs

List the port profiles in a network

Operation ID: getNetworkSwitchPortsProfiles

GET /networks/{networkId}/switch/ports/profiles

- added the optional property '/items/authentication' to the response with the '200' status

Docs

Create a port profile in a network

Operation ID: createNetworkSwitchPortsProfile

POST /networks/{networkId}/switch/ports/profiles

- added the new optional request property 'authentication'

- added the optional property 'authentication' to the response with the '200' status

Docs

Update a port profile in a network

Operation ID: updateNetworkSwitchPortsProfile

PUT /networks/{networkId}/switch/ports/profiles/{id}

- added the new optional request property 'authentication'

- added the optional property 'authentication' to the response with the '200' status

settings

Docs

Returns the switch network settings

Operation ID: getNetworkSwitchSettings

GET /networks/{networkId}/switch/settings

- added the optional property 'portChannelFallback' to the response with the '200' status

Docs

Update switch network settings

Operation ID: updateNetworkSwitchSettings

PUT /networks/{networkId}/switch/settings

- added the new optional request property 'portChannelFallback'

- added the optional property 'portChannelFallback' to the response with the '200' status

v1.69.0-beta.0

API Changelog v1.68.1-beta.0 vs. 1.69.0-beta.0

API Changes

GET /devices/{serial}/camera/clip

• endpoint added

POST /devices/{serial}/liveTools/speedTest

• added the new 'wan3' enum value to the request property 'interface'
• added the new 'wan4' enum value to the request property 'interface'

GET /devices/{serial}/lossAndLatencyHistory

• added the new enum value 'wan4' to the 'query' request parameter 'uplink'

GET /networks/{networkId}/wireless/electronicShelfLabel

• added the optional property 'sepioo' to the response with the '200' status

PUT /networks/{networkId}/wireless/electronicShelfLabel

• added the optional property 'sepioo' to the response with the '200' status

GET /networks/{networkId}/wireless/electronicShelfLabel/configuredDevices

• added the optional property '/items/sepioo' to the response with the '200' status

PUT /networks/{networkId}/wireless/ssids/{number}

• added the new optional request property 'ssidAdminAccessible'

POST /organizations/{organizationId}/alerts/profiles

• added the new 'wan4' enum value to the request property 'alertCondition/interface'

PUT /organizations/{organizationId}/alerts/profiles/{alertConfigId}

• added the new 'wan4' enum value to the request property 'alertCondition/interface'

GET /organizations/{organizationId}/assurance/alerts

• added the new enum value 'experience_metrics' to the 'query' request parameter 'category'

GET /organizations/{organizationId}/assurance/alerts/overview

• added the new enum value 'experience_metrics' to the 'query' request parameter 'category'

GET /organizations/{organizationId}/assurance/alerts/overview/byNetwork

• added the new enum value 'experience_metrics' to the 'query' request parameter 'category'

GET /organizations/{organizationId}/assurance/alerts/overview/byType

• added the new enum value 'experience_metrics' to the 'query' request parameter 'category'

GET /organizations/{organizationId}/assurance/alerts/overview/historical

• added the new enum value 'experience_metrics' to the 'query' request parameter 'category'

GET /organizations/{organizationId}/assurance/wireless/experience/capacity/byNetwork/byClient

• :warning: for the 'query' request parameter 'timespan', the min was set to '900.00'
• :warning: deleted the 'query' request parameter 'interval'
• added the optional property '/items/items/items/connections' to the response with the '200' status

GET /organizations/{organizationId}/assurance/wireless/experience/capacity/byNetwork/byClientType

• :warning: for the 'query' request parameter 'timespan', the min was set to '900.00'
• :warning: deleted the 'query' request parameter 'interval'

GET /organizations/{organizationId}/assurance/wireless/experience/capacity/byNetwork/byDevice

• added the optional property '/items/items/items/connections' to the response with the '200' status

GET /organizations/{organizationId}/assurance/wireless/experience/capacity/byNetwork/bySsid

• added the optional property '/items/items/items/connections' to the response with the '200' status

GET /organizations/{organizationId}/assurance/wireless/experience/coverage/byNetwork/byClient

• added the optional property '/items/items/items/connections' to the response with the '200' status

GET /organizations/{organizationId}/assurance/wireless/experience/coverage/byNetwork/byDevice

• added the optional property '/items/items/items/connections' to the response with the '200' status

GET /organizations/{organizationId}/assurance/wireless/experience/coverage/byNetwork/bySsid

• added the optional property '/items/items/items/connections' to the response with the '200' status

GET /organizations/{organizationId}/assurance/wireless/experience/successfulConnects/byNetwork/byClient

• added the optional property '/items/items/items/connections' to the response with the '200' status

GET /organizations/{organizationId}/assurance/wireless/experience/successfulConnects/byNetwork/byDevice

• added the optional property '/items/items/items/connections' to the response with the '200' status

GET /organizations/{organizationId}/assurance/wireless/experience/successfulConnects/byNetwork/bySsid

• added the optional property '/items/items/items/connections' to the response with the '200' status

GET /organizations/{organizationId}/assurance/wireless/experience/timeToConnect/byNetwork/byClient

• added the optional property '/items/items/items/connections' to the response with the '200' status

GET /organizations/{organizationId}/assurance/wireless/experience/timeToConnect/byNetwork/byDevice

• added the optional property '/items/items/items/connections' to the response with the '200' status

GET /organizations/{organizationId}/assurance/wireless/experience/timeToConnect/byNetwork/bySsid

• added the optional property '/items/items/items/connections' to the response with the '200' status

GET /organizations/{organizationId}/nac/dictionaries/{dictionaryId}/attributes

• added the optional property '/items/sourceGroup' to the response with the '200' status

GET /organizations/{organizationId}/nac/dictionaries/{dictionaryId}/attributes/{attributeName}/values

• endpoint added

POST /organizations/{organizationId}/switch/ports/profiles/assignments/batchAssign

• endpoint added

GET /organizations/{organizationId}/switch/ports/profiles/assignments/byPort

• endpoint added

GET /organizations/{organizationId}/switch/ports/profiles/assignments/bySwitch

• endpoint added

• Added

• [ wirelessController ]
  • regulatoryDomain
    • Generate the regulatory domain package
    • Generate the regulatory domain package
  • connections
    • List of unassigned Catalyst access points and summary information
    • List of unassigned Catalyst access points and summary information
• [ support ]
  • salesRepresentatives
    • Returns the organization's sales representatives
    • Returns the organization's sales representatives
• [ sm ]
  • bulkEnrollment
    • Create a PccBulkEnrollmentToken
    • Create a PccBulkEnrollmentToken
    • Return a BulkEnrollmentToken
    • Return a BulkEnrollmentToken
    • Update a PccBulkEnrollmentToken
    • Delete a PccBulkEnrollmentToken
    • List all BulkEnrollmentTokens for an organization.
    • List all BulkEnrollmentTokens for an organization.
  • apple
    • Enqueue a sync job for an ADE account
    • Enqueue a sync job for an ADE account
    • Retrieve the status of an ADE sync job
    • Retrieve the status of an ADE sync job
• [ secureConnect ]
  • sites
    • List sites in this organization
    • List sites in this organization
    • Enroll sites in this organization to Secure Connect. For an organization, a maximum of 4000 sites can be enrolled if they are in spoke mode or a maximum of 10 sites can be enrolled in hub mode.
    • Detach given sites from Secure Connect
  • remoteAccessLogsExports
    • Provides a list of remote access logs exports for an Organization
    • Provides a list of remote access logs exports for an Organization
    • Creates a export for a provided timestamp interval.
    • Redirects to the download link of the completed export.
    • Redirects to the download link of the completed export.
    • Return the details of a specific remote access logs export
    • Return the details of a specific remote access logs export
  • remoteAccessLog
    • List the latest 5000 events logged by remote access.
    • List the latest 5000 events logged by remote access.
  • regions
    • List deployed cloud hubs and regions in this organization
    • List deployed cloud hubs and regions in this organization
  • publicApplications
    • Provides a list of public applications for an Organization.
    • Provides a list of public applications for an Organization.
  • privateResources
    • Provides a list of private resources for an organization.
    • Provides a list of private resources for an organization.
    • Adds a new private resource to the organization.
    • Updates a specific private resource.
    • Updates a specific private resource.
    • Deletes a specific private resource. If this is the last resource in a resource group you must remove it from that resource group before deleting.
  • privateResourceGroups
    • Provides a list of the private resource groups in an organization.
    • Provides a list of the private resource groups in an organization.
    • Adds a new private resource group to an organization.
    • Updates a specific private resource group.
    • Updates a specific private resource group.
    • Deletes a specific private resource group.
  • privateApplications
    • Provides a list of private applications for an Organization.
    • Provides a list of private applications for an Organization.
    • Adds a new private application to the Organization. A maximum of 300 private applications are allowed for an organization.
    • Updates a specific private application
    • Return the details of a specific private application
    • Updates a specific private application. Updates can be made to Name, Description, Destinations, App Protocol, SNI and SSL verification. Application groups can be added or removed.
    • Deletes a specific private application. Delink the application from any application groups before deleting the app. Cascade delete application group if this is the only application in the group.
  • privateApplicationGroups
    • Provides a list of private application groups for an Organization
    • Provides a list of private application groups for an Organization
    • Creates a group of private applications to apply to policy. A maximum of 300 private application groups are allowed for an organization.
    • Update an application group in an Organization
    • Return the details of a specific private application group
    • Update an application group in an Organization. Updates are allowed on Group Name and Group Description. Applications can be added or removed. Group type and Policy cannot be changed.
    • Deletes private application group from an Organization. Detaches application from groups before deleting
• [ nac ]
  • sessions
    • List the NAC Sessions for this organization
    • List the NAC Sessions for this organization
    • Return the details of selected NAC Sessions
    • Return the details of selected NAC Sessions
  • license
    • Returns license usage data for a specific organization
    • Returns license usage data for a specific organization
  • dictionaries
    • Get all NAC dictionaries
    • Get all NAC dictionaries
    • Get all attributes by dictionary ID
    • Get all attributes by dictionary ID
  • authorization
    • Get all nac authorization policies for this organization
    • Get all nac authorization policies for this organization
    • Create a rule in an authorization policy set of an organization
    • Create a rule in an authorization policy set of an organization
    • Update an existing rule of an authorization policy set within an organization
    • Update an existing rule of an authorization policy set within an organization
    • Delete a rule in an authorization policy set of an organization
  • certificates
    • Gets all certificates for an organization and can filter by certificate status, expiry date and last used date
    • Gets all certificates for an organization and can filter by certificate status, expiry date and last used date
    • Get all the organization's CRL.It's possible to filter results by CRL issuers (CA) or CRL's ID - see caIds and crlIds query parameters.This endpoint could be used for 'show' action when you specify a single CRL ID in crlIds parameter
    • Get all the organization's CRL.It's possible to filter results by CRL issuers (CA) or CRL's ID - see caIds and crlIds query parameters.This endpoint could be used for 'show' action when you specify a single CRL ID in crlIds parameter
    • Create a new CRL (either base or delta) for an existing CA
    • Get all the organization's CRL descriptors (metadata only - revocation list data is excluded)
    • Get all the organization's CRL descriptors (metadata only - revocation list data is excluded). It's possible to filter results by CRL issuers (CA) - see caIds query parameter
    • Deletes a whole CRL, including all its deltas (in case of base CRL removal)
    • Deletes a whole CRL, including all its deltas (in case of base CRL removal)
    • Import certificate for this organization or validate without persisting
    • Import certificate for this organization or validate without persisting
    • Get counts of Enabled, Disabled, Expired and Last Used certificates for this organization
    • Get counts of Enabled, Disabled, Expired and Last Used certificates for this organization
    • Update certificate configuration by certificateId for this organization
    • Update certificate configuration by certificateId for this organization
• [ users ]
  • iam
    • List specific authorizations for the list of Meraki end users.
    • List specific authorizations for the list of Meraki end users.
    • Authorize a Meraki end user for an auth zone.
    • Update a Meraki end user's access to an auth zone.
    • Revoke a Meraki end user's access to an auth zone.
    • Revoke a Meraki end user's access to an auth zone.
    • List all of the available auth zones for an organization.
    • List all of the available auth zones for an organization.
    • Delete an authorization for a Meraki end user.
    • Delete an authorization for a Meraki end user.
    • Create an identity provider for an organization
    • Create an identity provider for an organization. Only Entra ID(Azure AD) is supported at this time.
    • Search all IdP groups for an organization
    • Search all IdP groups for an organization. Filter by IdP IDs and Auth Zone. Parameters are assembled as an AND query.
    • List all available IdP Product Integration urls for the organization
    • List all available IdP Product Integration urls for the organization
    • Search all IdPs for an organization
    • Search all IdPs for an organization. Filter by IdP ID, IdP type, and Auth Zone. Parameters are assembled as an AND query.
    • Get the IdP sync status records for an organization
    • Get the IdP sync status records for an organization. Only Entra ID(Azure AD) is supported at this time.
    • Get the latest IdP sync status records for all IdPs in an organization
    • Get the latest IdP sync status records for all IdPs in an organization. Only Entra ID(Azure AD) is supported at this time.
    • Test connectivity to an Entra ID identity provider.
    • Test connectivity to an Entra ID identity provider.
    • Create a Meraki user
    • Create a Meraki user
    • Update a Meraki user
    • Update a Meraki user
    • Delete a Meraki end user
    • Trigger an IdP sync for an identity provider
    • Trigger an IdP sync for an identity provider. Only Entra ID(Azure AD) is supported at this time.
    • Get the latest IdP sync status for an identity provider
    • Get the latest IdP sync status for an identity provider. Only Entra ID(Azure AD) is supported at this time.
    • Update an identity provider
    • Update an identity provider. Only Entra ID(Azure AD) is supported at this time.
    • Delete a identity provider from an organization. Only Entra ID(Azure AD) is supported at this time.
    • List all auth zones for an identity provider
    • List all auth zones for an identity provider
    • List the end users and their associated identity providers for an organization.
    • List the end users and their associated identity providers for an organization.
    • Get the count of users and user groups for an organization.
    • Get the count of users and user groups for an organization.
• [ camera ]
  • videoWalls
    • Create a new video wall.
    • Create a new video wall.
    • Update the specified video wall.
    • Update the specified video wall.
    • Delete the specified video wall.
    • Return a list of video walls.
    • Return a list of video walls.
    • Return the specified video wall.
    • Return the specified video wall.
    • Returns video wall link to the specified video wall id
    • Returns video wall link to the specified video wall id. If a timestamp is supplied, it links to that timestamp.
  • devices
    • Lists all the capabilities of cameras in this organization
    • Lists all the capabilities of cameras in this organization
• [ devices ]
  • vrrpTable
    • Enqueue a job to perform a VRRP table request for the device
    • Enqueue a job to perform a VRRP table request for the device. This endpoint currently supports Catalyst switches. This endpoint has a sustained rate limit of one request every five seconds per device, with an allowed burst of five requests.
    • Return an VRRP table live tool job.
    • Return an VRRP table live tool job.
  • traceRoute
    • Enqueue a job to run trace route in the device
    • Enqueue a job to run trace route in the device. This endpoint has a sustained rate limit of one request every five seconds per device, with an allowed burst of five requests.
    • Return a trace route job
    • Return a trace route job
  • speedTest
    • Enqueue a job to execute a speed test from a device
    • Enqueue a job to execute a speed test from a device
    • Returns a speed test result in megabits per second
    • Returns a speed test result in megabits per second. If test is not complete, no results are present.
  • routingTable
    • Enqueue a job to perform a routing table request for the device
    • Enqueue a job to perform a routing table request for the device. Only native Catalyst switches are supported. This endpoint has a sustained rate limit of one request every five seconds per device, with an allowed burst of five requests.
    • Enqueue a job to perform a routing table lookup request for the device
    • Enqueue a job to perform a routing table lookup request for the device. Only Cisco routers are supported. Any combination of search filters can be applied.
    • Return a routing table live tool lookup job.
    • Return a routing table live tool lookup job.
    • Enqueue a job to perform a routing table summary request for the device
    • Enqueue a job to perform a routing table summary request for the device. Only Cisco routers are supported.
    • Return a routing table live tool summary job.
    • Return a routing table live tool summary job.
    • Return an routing table live tool job.
    • Return an routing table live tool job.
  • reboot
    • Enqueue a job to reboot a device
    • Enqueue a job to reboot a device. This endpoint has a rate limit of one request every 60 seconds.
    • Return a reboot job
    • Return a reboot job
  • ospfNeighbors
    • Enqueue a job to perform a OSPF neighbors request for the device
    • Enqueue a job to perform a OSPF neighbors request for the device. This endpoint currently supports switches. This endpoint has a sustained rate limit of one request every five seconds per device, with an allowed burst of five requests.
    • Return an OSPF neighbors live tool job.
    • Return an OSPF neighbors live tool job.
  • dhcpLeases
    • Enqueue a job to perform a DHCP leases request for the device
    • Enqueue a job to perform a DHCP leases request for the device. This endpoint currently supports all MS devices. This endpoint has a sustained rate limit of one request every five seconds per device, with an allowed burst of five requests.
    • Return a DHCP leases live tool job.
    • Return a DHCP leases live tool job.
  • cyclePort
    • Enqueue a job to perform a cycle port for the device on the specified ports
    • Enqueue a job to perform a cycle port for the device on the specified ports. This endpoint has a sustained rate limit of one request every five seconds per device, with an allowed burst of five requests.
    • Return a cycle port live tool job.
    • Return a cycle port live tool job.
  • aclHitCount
    • Enqueue a job to perform an ACL hit count for the device
    • Enqueue a job to perform an ACL hit count for the device. This endpoint has a sustained rate limit of one request every five seconds per device, with an allowed burst of five requests.
    • Return an ACL hit count live tool job.
    • Return an ACL hit count live tool job.
  • clients
    • Return a client disconnect job.
    • Return a client disconnect job.
• [ administered ]
  • search
    • List the appropriate results for a given global search utilizing live_search_react
    • List the appropriate results for a given global search utilizing live_search_react
• [ licensing ]
  • subscription
    • Batch change networks to their desired feature tier for specified product types
    • Batch change networks to their desired feature tier for specified product types
• [ insight ]
  • webApps
    • Lists all default web applications rules with counter set rule ids
    • Lists all default web applications rules with counter set rule ids
    • Add a custom web application for Insight to be able to track
    • Update a custom web application for Insight to be able to track
    • Update a custom web application for Insight to be able to track
    • Delete a custom web application by counter set rule id.
  • speedTestResults
    • List the speed tests for the given devices under this organization
    • List the speed tests for the given devices under this organization. Only valid for organizations with Meraki Insight.
  • applications
    • Update an Insight tracked application
    • Update an Insight tracked application
    • Delete an Insight tracked application
• [ organizations ]
  • webhooks
    • List the HTTP servers for this organization
    • List the HTTP servers for this organization
    • Add an HTTP server to an organization
    • Return an HTTP server for an organization
    • Return an HTTP server for an organization
    • Update an HTTP server for an organization
    • Delete an HTTP server from an organization
    • List the webhook payload templates for an organization
    • List the webhook payload templates for an organization
    • Create a webhook payload template for an organization
    • Get the webhook payload template for an organization
    • Get the webhook payload template for an organization
    • Update a webhook payload template for an organization
    • Destroy a webhook payload template for an organization. Does not work for included templates ('wpt_00001', 'wpt_00002', 'wpt_00003', 'wpt_00004', 'wpt_00005', 'wpt_00006', 'wpt_00007' or 'wpt_00008')
    • Send a test webhook for an organization
    • Send a test webhook for an organization
    • Return the status of a webhook test for an organization
    • Return the status of a webhook test for an organization
  • sase
    • Retrieves a batch summary with aggregated job status counts
    • Retrieves a batch summary with aggregated job status counts
    • List jobs within a batch, with optional status filtering
    • List jobs within a batch, with optional status filtering
    • Create a new Secure Access integration
    • Create a new Secure Access integration
    • Get details of a Secure Access integration
    • Get details of a Secure Access integration
    • Remove a Secure Access integration
    • List regions
    • List regions
    • List of enrolled SASE sites in this organization
    • List of enrolled SASE sites in this organization
    • List high-level SASE site statuses (healthy, degraded, offline)
    • List high-level SASE site statuses (healthy, degraded, offline)
    • Get the connectivity history of SASE sites in this organization
    • Get the connectivity history of SASE sites in this organization
    • Detach sites in this organization from Secure Access
    • Detach sites in this organization from Secure Access. This will remove the sites from Secure Access.
    • Enroll sites in this organization to Secure Access
    • Enroll sites in this organization to Secure Access. For an organization, a maximum of 4000 sites can be enrolled if they are in spoke mode or a maximum of 10 sites can be enrolled in hub mode.
    • Update the configuration for a site
    • Update the configuration for a site. Currently, only supports updating default route enablement.
  • policies
    • List application categories with their associated applications
    • List application categories with their associated applications
    • List Organization-Wide Policy Firewall Rulesets
    • List Organization-Wide Policy Firewall Rulesets
    • Create an Organization-Wide Policy Firewall Ruleset
    • Create an Organization-Wide Policy Firewall Rule
    • List Organization-Wide Policy Firewall Rules
    • Create an Organization-Wide Policy Firewall Rule
    • Delete an Organization-Wide Policy Firewall Rule
    • Update an Organization-Wide Policy Firewall Rule
    • Delete an Organization-Wide Policy Firewall Rule
    • Update an Organization-Wide Policy Firewall Ruleset
    • Update an Organization-Wide Policy Firewall Ruleset
    • Delete an Organization-Wide Policy Firewall Ruleset
    • List Organization-Wide Policies
    • List Organization-Wide Policies
    • Create an Organization-Wide Policy
    • Assign adaptive policy groups to a policy
    • Assign adaptive policy groups to a policy
    • List adaptive policy group assignments
    • List adaptive policy group assignments
    • Remove adaptive policy groups from a policy
    • Remove adaptive policy groups from a policy
    • List Organization-Wide Policy Ruleset Assignments
    • List Organization-Wide Policy Ruleset Assignments
    • Create an Organization-Wide Policy Ruleset Assignment
    • Update an Organization-Wide Policy Ruleset Assignment
    • Update an Organization-Wide Policy Ruleset Assignment
    • Delete an Organization-Wide Policy Ruleset Assignment
    • Update an Organization-Wide Policy
    • Update an Organization-Wide Policy
    • Delete an Organization-Wide Policy
  • extensions
    • Update name and status of an Interconnect
    • Update name and status of an Interconnect
    • List the ThousandEyes agent configurations under this organization
    • List the ThousandEyes agent configurations under this organization. Only valid for networks with access to Meraki Insight. Organization must have a ThousandEyes account connected to perform this action.
    • Add a ThousandEyes agent for this network. Only valid for networks with access to Meraki Insight. Organization must have a ThousandEyes account connected to perform this action.
    • List all the networks eligible for ThousandEyes agent activation under this organization.
    • List all the networks eligible for ThousandEyes agent activation under this organization.
    • List the ThousandEyes agent configuration under this network
    • List the ThousandEyes agent configuration under this network. Only valid for networks with access to Meraki Insight. Organization must have a ThousandEyes account connected to perform this action.
    • Update a ThousandEyes agent from this network. Only valid for networks with access to Meraki Insight. Organization must have a ThousandEyes account connected to perform this action.
    • Delete a ThousandEyes agent from this network. Only valid for networks with access to Meraki Insight. Organization must have a ThousandEyes account connected to perform this action.
    • Create a ThousandEyes test based on a provided test template
    • Create a ThousandEyes test based on a provided test template. Only valid for networks with access to Meraki Insight. Organization must have a ThousandEyes account connected to perform this action.
  • cloud
    • List of source/destination traffic rules
    • List of source/destination traffic rules
  • certificates
    • Gets all or specific certificates for an organization
    • Gets all or specific certificates for an organization
    • Import certificate for this organization
    • Import certificate for this organization
    • Download the public RADIUS certificate.
    • Download the public RADIUS certificate.
    • Delete a certificate for an organization
    • Update a certificate's description for an organization
    • Delete a certificate for an organization
    • Download the trusted certificate by certificate id.
    • Download the trusted certificate by certificate id.
  • auth
    • List the organization-wide RADIUS servers in the organization
    • List the organization-wide RADIUS servers in the organization
    • Add an organization-wide RADIUS server
    • Return list of network and policies that organization-wide RADIUS servers are bing used
    • Return list of network and policies that organization-wide RADIUS servers are bing used
    • Return an organization-wide RADIUS server
    • Return an organization-wide RADIUS server
    • Update an organization-wide RADIUS server
    • Delete an organization-wide RADIUS server from a organization
  • workflows
    • Return workflows filtered by organization ID, network ID, type, and category
    • Return workflows filtered by organization ID, network ID, type, and category
  • thousandEyes
    • Get a list of Thousand Eyes applications with their alerts.
    • Get a list of Thousand Eyes applications with their alerts.
  • scores
    • Get network health scores for a list of networks.
    • Get network health scores for a list of networks.
  • productAnnouncements
    • Gets relevant product announcements for a user
    • Gets relevant product announcements for a user
  • optimization
    • Returns an array of checkup results for the organization
    • Returns an array of checkup results for the organization
    • Returns an array of checkup results for the networks
    • Returns an array of checkup results for the networks
  • fetchTableQuery
    • Returns the table data for a given timespan
    • Returns the table data for a given timespan
  • apiRequests
    • Lists API request response codes and their counts aggregated by admin
    • Lists API request response codes and their counts aggregated by admin
    • Lists API request response codes and their counts aggregated by application
    • Lists API request response codes and their counts aggregated by application
    • Aggregates API usage data by operationId
    • Aggregates API usage data by operationId
    • Aggregates API usage by source ip
    • Aggregates API usage by source ip
  • snmp
    • Retrieve the SNMP trap configuration for the networks in an organization
    • Retrieve the SNMP trap configuration for the networks in an organization
  • devices
    • Returns counts of online, offline, and recovered devices by product type, along with offline intervals for impacted devices in the organization.
    • Returns counts of online, offline, and recovered devices by product type, along with offline intervals for impacted devices in the organization.
    • Returns the history of device boots in reverse chronological order (most recent first)
    • Returns the history of device boots in reverse chronological order (most recent first). Currently supported for MS devices only.
    • Summarizes device reboots across an organization.
    • Summarizes device reboots across an organization.
    • Summarizes memory status across devices of a given network
    • Summarizes memory status across devices of a given network
    • List the Opportunistic Pcap settings of an organization by network
    • List the Opportunistic Pcap settings of an organization by network
    • Delete packet capture schedules
    • Delete packet capture schedules
    • Enqueues a task for a specific packet capture
    • Enqueues a task for a specific packet capture. This endpoint has a sustained rate limit of one request every 60 seconds.
    • Retrieves packet capture analysis result for a specific packet capture task.
    • Retrieves packet capture analysis result for a specific packet capture task.
    • Returns syslog servers configured for the networks within an organization.
    • Returns syslog servers configured for the networks within an organization.
    • Returns roles that can be assigned to a syslog server for a given network.
    • Returns roles that can be assigned to a syslog server for a given network.
  • clients
    • Given a client, get all alerts and events for a given timespan
    • Given a client, get all alerts and events for a given timespan
    • Given a client, category, and timespan, return events that have a close connection to each other.
    • Given a client, category, and timespan, return events that have a close connection to each other.
    • Given a client, return current topology
    • Given a client, return current topology
  • routing
    • List existing organization-wide VRFs (Virtual Routing and Forwarding).
    • List existing organization-wide VRFs (Virtual Routing and Forwarding).
    • Add an organization-wide VRF (Virtual Routing and Forwarding)
    • Update an organization-wide VRF (Virtual Routing and Forwarding)
    • Update an organization-wide VRF (Virtual Routing and Forwarding)
    • Delete a VRF (Virtual Routing and Forwarding) from a organization
• [ networks ]
  • snmp
    • Update the SNMP trap configuration for the specified network
    • Update the SNMP trap configuration for the specified network
  • locationScanning
    • Return scanning API settings
    • Return scanning API settings
    • Change scanning API settings
    • Return list of scanning API receivers
    • Return list of scanning API receivers
    • Set the list of scanning API receivers. Old receivers will be removed
  • devices
    • Updates the syslog servers configuration for a network.
    • Updates the syslog servers configuration for a network.
• [ wireless ]
  • roaming
    • Get all wireless clients' roam events within the specified timespan grouped by network and time interval.
    • Get all wireless clients' roam events within the specified timespan grouped by network and time interval.
  • alerts
    • Gets all low power related alerts over a given network and returns information by device
    • Gets all low power related alerts over a given network and returns information by device
  • certificates
    • Query for details on the organization's OpenRoaming Certificate Authority certificate (CAs).
    • Query for details on the organization's OpenRoaming Certificate Authority certificate (CAs).
  • connectivity
    • Show the by-device RF Health score overview information for the organization in the given interval
    • Show the by-device RF Health score overview information for the organization in the given interval. This includes the RF Health score for each device, as well as some more basic device info
  • opportunisticPcap
    • Update the Opportunistic Pcap settings for a wireless network
    • Update the Opportunistic Pcap settings for a wireless network
    • Check the Opportunistic Pcap license status of an organization by network
    • Check the Opportunistic Pcap license status of an organization by network
  • radio
    • Return the position for a wireless device
    • Return the position for a wireless device
    • Update the position attributes for this device
    • Return the AFC power limits for a wireless device
    • Return the AFC power limits for a wireless device
    • Return the radio overrides of a device
    • Return the radio overrides of a device
    • Update the radio overrides of a device
    • Show the status of this device's radios
    • Show the status of this device's radios
    • Update the AutoRF settings for a wireless network
    • Update the AutoRF settings for a wireless network
    • List the AFC power limits of an organization by device
    • List the AFC power limits of an organization by device
    • List the AFC power limits of an organization by device
    • List the AFC power limits of an organization by device
    • List the AutoRF settings of an organization by network
    • List the AutoRF settings of an organization by network
    • List the channel planning activities of an organization
    • List the channel planning activities of an organization
    • Return a list of radio overrides
    • Return a list of radio overrides
    • Show the by-device neighbor rssi information for the organization in the given interval
    • Show the by-device neighbor rssi information for the organization in the given interval. This includes some basic device and network data, the number of neighbors for each device (total and by band), and the rssi and information of each neighbor
    • Show the by-network RF Health score overview information for the organization in the given interval
    • Show the by-network RF Health score overview information for the organization in the given interval. This includes RF Health score, high interference APs, number of APs and of clients
    • Show the status of this organization's radios, categorized by network and device
    • Show the status of this organization's radios, categorized by network and device
  • healthScores
    • Fetch the health scores for a given AP on this network
    • Fetch the health scores for a given AP on this network
  • devices
    • Fetch the health scores of all APs on this network
    • Fetch the health scores of all APs on this network
    • List the most recent AP accelerometer status information for wireless devices that support it.
    • List the most recent AP accelerometer status information for wireless devices that support it.
    • Get average uplink and downlink datarates for all clients in the organization
    • Get average uplink and downlink datarates for all clients in the organization
    • Get latency summaries for all wireless devices in an organization.
    • Get latency summaries for all wireless devices in an organization.
    • Get latency summaries for all wireless devices in an organization.
    • Get latency summaries for all wireless devices in an organization.
    • Get per-network latency summaries for all wireless networks in an organization.
    • Get per-network latency summaries for all wireless networks in an organization.
    • Enqueue a job to disconnect a client from an AP
    • Enqueue a job to disconnect a client from an AP. This endpoint has a sustained rate limit of one request every five seconds per device, with an allowed burst of five requests.
    • Returns deployment IDs for the given new node serial numbers
    • Returns deployment IDs for the given new node serial numbers
    • List the recommended device tags for zero touch deployments available for the organization
    • List the recommended device tags for zero touch deployments available for the organization
    • Get average signal quality for all clients in the organization
    • Get average signal quality for all clients in the organization
    • Get average signal quality for all devices in the organization
    • Get average signal quality for all devices in the organization
    • Get average signal quality for all networks in the organization
    • Get average signal quality for all networks in the organization
    • List the wireless device telemetry of an organization
    • List the wireless device telemetry of an organization
  • clients
    • Fetch the health scores for all clients on this network
    • Fetch the health scores for all clients on this network
    • Return counts of distinct wireless clients connecting to a network over time
    • Return counts of distinct wireless clients connecting to a network over time
    • Fetch the health scores for a given client on this network
    • Fetch the health scores for a given client on this network. Clients are identified by their MAC or ID
    • Get client roam events within the specified timespan.
    • Get client roam events within the specified timespan.
    • Summarize association outcomes per wireless client across an organization.
    • Summarize association outcomes per wireless client across an organization.
    • Summarize authentication outcomes per wireless client across an organization.
    • Summarize authentication outcomes per wireless client across an organization.
    • Get IP assignment for all clients in the organization
    • Get IP assignment for all clients in the organization
    • Returns failed wireless client connections for this organization by device
    • Returns failed wireless client connections for this organization by device
    • Show the by-network client information for the organization in the given interval
    • Show the by-network client information for the organization in the given interval. This includes average SNR
  • ssids
    • Update the client exclusion status configuration for a given SSID
    • Update the client exclusion status configuration for a given SSID
    • Set the static client exclusion list for the given SSID
    • Set the static client exclusion list for the given SSID
    • Add a list of MAC addresses to the static client exclusion list for the given SSID
    • Add a list of MAC addresses to the static client exclusion list for the given SSID
    • Delete a list of MAC addresses from the static client exclusion list for the given SSID
    • Delete a list of MAC addresses from the static client exclusion list for the given SSID
    • Returns an array of objects, each containing client exclusion enablement statuses for one SSID
    • Returns an array of objects, each containing client exclusion enablement statuses for one SSID
    • Returns an array of objects, each containing a list of MAC's excluded from a given SSID
    • Returns an array of objects, each containing a list of MAC's excluded from a given SSID
• [ switch ]
  • alerts
    • Gets all poe related alerts over a given network and returns information by device
    • Gets all poe related alerts over a given network and returns information by device
  • configTemplates
    • list the port mirror configurations in an organization by switch profile
    • list the port mirror configurations in an organization by switch profile
    • Update a port mirror
    • Update a port mirror
  • connectivity
    • Lan link errors by device and port.
    • Lan link errors by device and port.
    • Lan STP errors by device and port.
    • Lan STP errors by device and port.
    • Gets all vrrp related alerts over a given network and returns information by device
    • Gets all vrrp related alerts over a given network and returns information by device
  • spanningTree
    • Updates Spanning Tree configuration
    • Updates Spanning Tree configuration
    • Returns Spanning Tree configuration settings
    • Returns Spanning Tree configuration settings
  • raGuardPolicy
    • Return RA Guard settings
    • Return RA Guard settings. Blocked servers are applied when default policy is allowed, and vice versa for allowed servers and blocked default policy.
    • Update RA Guard settings
  • devices
    • Return a historical record of packet transmission and loss, broken down by protocol, for insight into switch device health.
    • Return a historical record of packet transmission and loss, broken down by protocol, for insight into switch device health.
  • clients
    • Summarizes authentication outcomes per switch client across an organization.
    • Summarizes authentication outcomes per switch client across an organization.
    • Get IP assignment for all clients in the organization
    • Get IP assignment for all clients in the organization
    • Switch port status by client.
    • Switch port status by client.
  • stacks
    • Update switch port mirrors for switch stacks
    • Update switch port mirrors for switch stacks
    • List the port mirror configurations in an organization by switch
    • List the port mirror configurations in an organization by switch
  • routing
    • List the autonomous systems configured for BGP in the given organization
    • List the autonomous systems configured for BGP in the given organization. Border Gateway Protocol requires IOS XE 17.18 or higher
    • Create an autonomous system. Border Gateway Protocol requires IOS XE 17.18 or higher
    • List the overview of the autonomous systems configured for BGP in the given organization
    • List the overview of the autonomous systems configured for BGP in the given organization. Border Gateway Protocol requires IOS XE 17.18 or higher
    • Update an autonomous system
    • Update an autonomous system. Border Gateway Protocol requires IOS XE 17.18 or higher
    • Delete an autonomous system from an organization. Border Gateway Protocol requires IOS XE 17.18 or higher
    • List the filter lists configured for BGP in the given organization
    • List the filter lists configured for BGP in the given organization. Border Gateway Protocol requires IOS XE 17.18 or higher
    • Create or update a filter list, in addition to its associated rules
    • Create or update a filter list, in addition to its associated rules. Border Gateway Protocol requires IOS XE 17.18 or higher
    • List the overview of the filter lists configured for BGP in the given organization
    • List the overview of the filter lists configured for BGP in the given organization. Border Gateway Protocol requires IOS XE 17.18 or higher
    • List the filter list rules configured for BGP in the given organization
    • List the filter list rules configured for BGP in the given organization. Border Gateway Protocol requires IOS XE 17.18 or higher
    • Delete a filter list
    • Delete a filter list. Border Gateway Protocol requires IOS XE 17.18 or higher
    • List the prefix lists configured for BGP in the given organization
    • List the prefix lists configured for BGP in the given organization. Border Gateway Protocol requires IOS XE 17.18 or higher
    • Create or update a prefix list, in addition to its associated rules
    • Create or update a prefix list, in addition to its associated rules. Border Gateway Protocol requires IOS XE 17.18 or higher
    • List the overview of the prefix lists configured for BGP in the given organization
    • List the overview of the prefix lists configured for BGP in the given organization. Border Gateway Protocol requires IOS XE 17.18 or higher
    • List the prefix list rules configured for BGP in the given organization
    • List the prefix list rules configured for BGP in the given organization. Border Gateway Protocol requires IOS XE 17.18 or higher
    • Delete a prefix list
    • Delete a prefix list. Border Gateway Protocol requires IOS XE 17.18 or higher
    • List the BGP peer groups configured in the given organization
    • List the BGP peer groups configured in the given organization. Border Gateway Protocol requires IOS XE 17.18 or higher
    • List all BGP deployment information for multiple peer groups or address families configured in the given organization, including profile information, peer group address family information, neighbors, and listen ranges
    • List all BGP deployment information for multiple peer groups or address families configured in the given organization, including profile information, peer group address family information, neighbors, and listen ranges. Border Gateway Protocol requires IOS XE 17.18 or higher
    • Create or update a peer group, in addition to an associated peer group profile, peer group address family binding, peer group address family binding profile and routing policies associated with the peer group
    • Create or update a peer group, in addition to an associated peer group profile, peer group address family binding, peer group address family binding profile and routing policies associated with the peer group. Border Gateway Protocol requires IOS XE 17.18 or higher
    • List all BGP deployment information for peer groups configured in the given organization, including peer group address family information, as well as routing policies
    • List all BGP deployment information for peer groups configured in the given organization, including peer group address family information, as well as routing policies. Border Gateway Protocol requires IOS XE 17.18 or higher
    • List the overview of the BGP peer groups configured in the given organization
    • List the overview of the BGP peer groups configured in the given organization
    • List the listen ranges configured for BGP in the given organization
    • List the listen ranges configured for BGP in the given organization. Border Gateway Protocol requires IOS XE 17.18 or higher
    • List the neighbors configured for BGP in the given organization
    • List the neighbors configured for BGP in the given organization. Border Gateway Protocol requires IOS XE 17.18 or higher
    • Create or update a neighor, in addition to an associated neighbor address family binding and routing policies associated with the neighbor
    • Create or update a neighor, in addition to an associated neighbor address family binding and routing policies associated with the neighbor. Border Gateway Protocol requires IOS XE 17.18 or higher
    • List all BGP deployment information for neighbors configured in the given organization, including address family information, as well as routing policies
    • List all BGP deployment information for neighbors configured in the given organization, including address family information, as well as routing policies. Border Gateway Protocol requires IOS XE 17.18 or higher
    • List the routers configured in the given organization
    • List the routers configured in the given organization. Border Gateway Protocol requires IOS XE 17.18 or higher
    • Create a BGP router, in addition to an associated address family, address family prefixes, and address family profile
    • Create a BGP router, in addition to an associated address family, address family prefixes, and address family profile. This is helpful for the initial deployment of a BGP router.. Border Gateway Protocol requires IOS XE 17.18 or higher
    • List all BGP deployment information for routers configured in a given organization, including all address families
    • List all BGP deployment information for routers configured in a given organization, including all address families. Border Gateway Protocol requires IOS XE 17.18 or higher
    • List the overview of the routers configured in the given organization
    • List the overview of the routers configured in the given organization. Border Gateway Protocol requires IOS XE 17.18 or higher
    • Create and update listen ranges, update peers' enabled flag, and delete peer groups for a BGP router
    • Create and update listen ranges, update peers' enabled flag, and delete peer groups for a BGP router. Border Gateway Protocol requires IOS XE 17.18 or higher
    • Delete a router from an organization
    • Delete a router from an organization. Border Gateway Protocol requires IOS XE 17.18 or higher
    • List layer 3 static routes for switches within an organization
    • List layer 3 static routes for switches within an organization
  • ports
    • Update a port mirror
    • Update a port mirror
    • List the port profiles in a network
    • List the port profiles in a network
    • Create a port profile in a network
    • Update a port profile in a network
    • Update a port profile in a network
    • Delete a port profile from a network
    • list the port mirror configurations in an organization by switch
    • list the port mirror configurations in an organization by switch
    • List the port profiles in an organization
    • List the port profiles in an organization
    • Create a port profile in an organization
    • list the automation port profiles in an organization
    • list the automation port profiles in an organization
    • Create a port profile automation for an organization
    • Update a port profile automation in an organization
    • Update a port profile automation in an organization
    • Delete an automation port profile from an organization
    • Fetch all Network - Smart Port Profile associations for an organization
    • Fetch all Network - Smart Port Profile associations for an organization
    • Create Network and Smart Ports Profile association for a specific profile
    • Batch Create Network and Smart Ports Profile associations for a specific profile
    • Batch Create Network and Smart Ports Profile associations for a specific profile
    • Bulk delete Network and Smart Port Profile associations
    • Bulk delete Network and Smart Port Profile associations
    • Delete Network and Smart Port profile association for a specific profile
    • Delete Network and Smart Port profile association for a specific profile
    • List the port profiles in an organization
    • List the port profiles in an organization
    • Get detailed information about a port profile
    • Get detailed information about a port profile
    • Update a port profile in an organization
    • Delete a port profile from an organization
    • Switch port packets by device and port.
    • Switch port packets by device and port.
    • Return time-series digital optical monitoring (DOM) readings for ports on each DOM-enabled switch in an organization, in addition to thresholds for each relevant Small Form Factor Pluggable (SFP) module.
    • Return time-series digital optical monitoring (DOM) readings for ports on each DOM-enabled switch in an organization, in addition to thresholds for each relevant Small Form Factor Pluggable (SFP) module.
  • service
    • List switch templates running IOS XE Catalyst firmware.
    • List switch templates running IOS XE Catalyst firmware.
    • Clone existing switch templates into a destination template network.
    • Clone existing switch templates into a destination template network.
• [ sensor ]
  • readings
    • Return all reported readings from sensors in a given timespan, summarized as a series of intervals, sorted by interval start time in descending order
    • Return all reported readings from sensors in a given timespan, summarized as a series of intervals, sorted by interval start time in descending order
  • alerts
    • Return a list of sensor alert events
    • Return a list of sensor alert events
  • schedules
    • Returns a list of all sensor schedules.
    • Returns a list of all sensor schedules.
• [ appliance ]
  • policies
    • Assign VLANs to a policy
    • Assign VLANs to a policy
    • List appliance VLAN policy assignments
    • List appliance VLAN policy assignments
    • List policies by appliance VLANs
    • List policies by appliance VLANs
    • Remove VLANs from a policy
    • Remove VLANs from a policy
  • sdwan
    • Get the SDWAN internet traffic preferences for an MX network
    • Get the SDWAN internet traffic preferences for an MX network
  • umbrella
    • Disable umbrella protection for an MX network
    • Disable umbrella protection for an MX network
    • Enable umbrella protection for an MX network
    • Enable umbrella protection for an MX network
    • Specify one or more domain names to be excluded from being routed to Cisco Umbrella.
    • Specify one or more domain names to be excluded from being routed to Cisco Umbrella.
    • Update umbrella policies applied to MX network.
    • Update umbrella policies applied to MX network.
    • Enable or disable umbrella protection for an MX network
    • Enable or disable umbrella protection for an MX network. When disabling, the umbrella property will be omitted from the response.
  • interfaces
    • Update configurations for an appliance's specified port
    • Update configurations for an appliance's specified port
    • Create wired L3 interface configuration
    • Create wired L3 interface configuration
    • Update wired L3 interface configuration
    • Update wired L3 interface configuration
    • Delete wired L3 interface configuration
  • devices
    • Listing of L3 Interface Configurations across networks for the organization
    • Listing of L3 Interface Configurations across networks for the organization
    • Returns port configurations for appliances in a given organization
    • Returns port configurations for appliances in a given organization
    • Return the appliance utilization history for devices in the organization
    • Return the appliance utilization history for devices in the organization. Only primary MX devices are supported.
  • vpn
    • Summarizes by-device vpn peers for the organization in the given interval.
    • Summarizes by-device vpn peers for the organization in the given interval.
    • Get authentication for all clients in organization
    • Get authentication for all clients in organization
    • Get IP assignment for all clients in the organization
    • Get IP assignment for all clients in the organization
    • Get tunnel creation events for all clients in the organization
    • Get tunnel creation events for all clients in the organization
  • vlans
    • List the VLANs for an Organization
    • List the VLANs for an Organization
  • uplinks
    • Update uplink NAT settings of the specified network
    • Update uplink NAT settings of the specified network
    • Fetch uplink NAT settings of each network in the organization
    • Fetch uplink NAT settings of each network in the organization

• Changed
  • [ insight ]
    • applications
      • Add an Insight tracked application
      • Add an Insight tracked application
  • [ organizations ]
    • summary
      • Return the top 10 appliances sorted by utilization over given time range.
      • Return metrics for organization's top 10 clients by data usage (in mb) over given time range.
      • Return metrics for organization's top clients by data usage (in mb) over given time range, grouped by manufacturer.
      • Return metrics for organization's top 10 devices sorted by data usage over given time range
      • Return metrics for organization's top 10 device models sorted by data usage over given time range
      • List the client and status overview information for the networks in an organization
      • Return metrics for organization's top 10 ssids by data usage over given time range
      • Return metrics for organization's top 10 switches by energy usage over given time range
    • networks
      • Create a network
    • devices
      • List the availability history information for devices in an organization.
      • List the status of every Meraki device in the organization
    • clients
      • Return data usage (in megabits per second) over time for all clients in the given organization within a given time range.
  • [ networks ]
    • settings
      • Update the settings for a network
    • firmwareUpgrades
      • Rollback a Firmware Upgrade For A Network
      • Get firmware upgrade information for a network
      • Update firmware upgrade information for a network
  • [ wireless ]
    • ssids
      • Display the splash page settings for the given SSID
      • Modify the splash page settings for the given SSID
    • rfProfiles
      • Creates new RF profile for this network
      • List RF profiles for this network
      • Return a RF profile
      • Updates specified RF profile for this network
    • settings
      • Return the wireless settings for a network
      • Update the wireless settings for a network
    • bluetooth
      • Return the bluetooth settings for a wireless device
      • Return the Bluetooth settings for a network. Bluetooth settings must be enabled on the network.
      • Update the bluetooth settings for a wireless device
      • Update the Bluetooth settings for a network
  • [ switch ]
    • stacks
      • Create a layer 3 interface for a switch stack
      • List layer 3 interfaces for a switch stack
      • Return a layer 3 interface from a switch stack
      • Update a layer 3 interface for a switch stack
    • linkAggregations
      • List link aggregation groups
    • routing
      • Create a layer 3 interface for a switch
      • Create a multicast rendezvous point
      • List layer 3 interfaces for a switch
      • Return a layer 3 interface for a switch
      • List multicast rendezvous points
      • Return a multicast rendezvous point
      • Update a layer 3 interface for a switch
      • Update a multicast rendezvous point
    • ports
      • List the switch ports for a switch
      • List the switchports in an organization by switch
  • [ sensor ]
    • commands
      • Sends a command to a sensor
  • [ appliance ]
    • vpn
      • Return a Hub BGP Configuration
      • Return the site-to-site VPN settings of a network
      • Update a Hub BGP Configuration
      • Update the site-to-site VPN settings of a network
    • vlans
      • Add a VLAN
      • Update a VLAN
    • ports
      • List per-port VLAN settings for all ports of a secure router or security appliance.
      • Return per-port VLAN settings for a single secure router or security appliance port.
      • Update the per-port VLAN settings for a single secure router or security appliance port.
    • uplinks
      • Return the uplink settings for an MX appliance
      • Update the uplink settings for an MX appliance
    • trafficShaping
      • Display VPN exclusion rules for MX networks.
      • Update VPN exclusion rules for an MX network.
• Changed
  • [ appliance ]
    • trafficShaping
      • Display VPN exclusion rules for MX networks.
      • Update VPN exclusion rules for an MX network.

Version 1.68.0 to 1.68.0-beta.0

Summary of Changes

301 - New

260 - Updated

1242 - Total Endpoints

902 - Total Paths

Added

[ wirelessController ]

regulatoryDomain

Docs

Generate the regulatory domain package

Operation ID: generateOrganizationWirelessControllerRegulatoryDomainPackage

PATH /organizations/{organizationId}/wirelessController/regulatoryDomain/package/generate

{
  "content": {
    "devices": [
      {
        "serial": "Q234-ABCD-5678",
        "mac": "00:11:22:33:44:55",
        "regulatoryDomain": {
          "country": "US",
          "method": "manual"
        }
      }
    ],
    "details": {
      "schemaVersion": "1.0.0",
      "organizationId": "2930418",
      "createdAt": "2018-05-12T00:00:00Z",
      "counts": {
        "devices": 1
      },
      "createdBy": {
        "id": "212406",
        "email": "miles@meraki.com"
      }
    }
  },
  "signature": "a1b2c3d4e5f6g7h8i9j0",
  "certificates": [
    {
      "purpose": "signature",
      "content": "LS0tLS1CRUdJTiBDRVJUSUZJQ0FURS0tLS0tIE1JSUZZRENDQTBpZ0F3SUJBZ0lRQ2dGQ2dBQUFBVVVqeQ=="
    }
  ]
}

- Path added

- New endpoint

Generate the regulatory domain package

POST /organizations/{organizationId}/wirelessController/regulatoryDomain/package/generate

---

connections

Docs

List of unassigned Catalyst access points and summary information

Operation ID: getOrganizationWirelessControllerConnectionsUnassigned

PATH /organizations/{organizationId}/wirelessController/connections/unassigned

{
  "items": [
    {
      "id": "958271979973",
      "name": "MBY-CON-NCC_HLWY-24",
      "model": "AIR-AP1815I-B-K9",
      "serial": "",
      "mac": "8c:94:1f:97:54:01",
      "onboarding": {
        "isSupported": true,
        "status": "unregistered",
        "errors": [
          "DNS failure"
        ]
      },
      "tags": {
        "policy": "default-policy-tag",
        "site": "default-site-tag",
        "rf": "default-rf-tag"
      },
      "details": [
        {
          "name": "Catalyst serial",
          "value": "FCW2325N3RY"
        }
      ],
      "uplinks": [
        {
          "addresses": [
            {
              "address": "10.104.55.4"
            }
          ]
        }
      ],
      "controller": {
        "serial": "A2CC-8TYV-VCO9"
      }
    }
  ],
  "meta": {
    "counts": {
      "items": {
        "total": 1,
        "remaining": 0
      }
    }
  }
}

- Path added

- New endpoint

List of unassigned Catalyst access points and summary information

GET /organizations/{organizationId}/wirelessController/connections/unassigned

---

[ support ]

salesRepresentatives

Docs

Returns the organization's sales representatives

Operation ID: getOrganizationSupportSalesRepresentatives

PATH /organizations/{organizationId}/support/salesRepresentatives

[
  {
    "name": "Miles Meraki",
    "email": "miles@meraki.com",
    "phone": "+15555555555"
  }
]

- Path added

- New endpoint

Returns the organization's sales representatives

GET /organizations/{organizationId}/support/salesRepresentatives

---

[ sm ]

bulkEnrollment

Docs

Create a PccBulkEnrollmentToken

Operation ID: createOrganizationSmBulkEnrollmentToken

PATH /organizations/{organizationId}/sm/bulkEnrollment/token

{
  "id": "1284392014819",
  "networkId": "N_24329156",
  "expiresAt": "2023-10-15T00:00:00Z",
  "rawToken": "MMbCbpHZtG3TKUCr9B9uc5"
}

- Path added

- New endpoint

Create a PccBulkEnrollmentToken

POST /organizations/{organizationId}/sm/bulkEnrollment/token

---

Docs

Return a BulkEnrollmentToken

Operation ID: getOrganizationSmBulkEnrollmentToken

PATH /organizations/{organizationId}/sm/bulkEnrollment/token/{tokenId}

{
  "id": "1284392014819",
  "networkId": "N_24329156",
  "expiresAt": "2023-10-15T00:00:00Z"
}

- Path added

- New endpoint

Return a BulkEnrollmentToken

GET /organizations/{organizationId}/sm/bulkEnrollment/token/{tokenId}

---

- New endpoint

Update a PccBulkEnrollmentToken

PUT /organizations/{organizationId}/sm/bulkEnrollment/token/{tokenId}

---

- New endpoint

Delete a PccBulkEnrollmentToken

DELETE /organizations/{organizationId}/sm/bulkEnrollment/token/{tokenId}

---

Docs

List all BulkEnrollmentTokens for an organization.

Operation ID: getOrganizationSmBulkEnrollmentTokens

PATH /organizations/{organizationId}/sm/bulkEnrollment/tokens

[
  {
    "id": "1284392014819",
    "networkId": "N_24329156",
    "expiresAt": "2023-10-15T00:00:00Z"
  }
]

- Path added

- New endpoint

List all BulkEnrollmentTokens for an organization.

GET /organizations/{organizationId}/sm/bulkEnrollment/tokens

---

apple

Docs

Enqueue a sync job for an ADE account

Operation ID: createOrganizationSmAppleCloudEnrollmentSyncJob

PATH /organizations/{organizationId}/sm/apple/cloudEnrollment/syncJobs

{
  "syncJobId": "1284392014819",
  "adeAccountId": "1284392014819",
  "status": "pending"
}

- Path added

- New endpoint

Enqueue a sync job for an ADE account

POST /organizations/{organizationId}/sm/apple/cloudEnrollment/syncJobs

---

Docs

Retrieve the status of an ADE sync job

Operation ID: getOrganizationSmAppleCloudEnrollmentSyncJob

PATH /organizations/{organizationId}/sm/apple/cloudEnrollment/syncJobs/{syncJobId}

{
  "syncJobId": "1284392014819",
  "adeAccountId": "1284392014819",
  "status": "pending"
}

- Path added

- New endpoint

Retrieve the status of an ADE sync job

GET /organizations/{organizationId}/sm/apple/cloudEnrollment/syncJobs/{syncJobId}

---

[ secureConnect ]

sites

Docs

List sites in this organization

Operation ID: getOrganizationSecureConnectSites

PATH /organizations/{organizationId}/secureConnect/sites

{
  "data": [
    {
      "id": "123",
      "type": "MerakiSpoke",
      "name": "London Office",
      "region": "US East",
      "deviceType": "MX95-HW",
      "address": "123 Main St",
      "enrolled": true,
      "vpnType": "Hub",
      "defaultRoute": true
    }
  ],
  "meta": {
    "total": 1
  }
}

- Path added

- New endpoint

List sites in this organization

GET /organizations/{organizationId}/secureConnect/sites

---

- New endpoint

Enroll sites in this organization to Secure Connect. For an organization, a maximum of 4000 sites can be enrolled if they are in spoke mode or a maximum of 10 sites can be enrolled in hub mode.

POST /organizations/{organizationId}/secureConnect/sites

---

- New endpoint

Detach given sites from Secure Connect

DELETE /organizations/{organizationId}/secureConnect/sites

---

remoteAccessLogsExports

Docs

Provides a list of remote access logs exports for an Organization

Operation ID: getOrganizationSecureConnectRemoteAccessLogsExports

PATH /organizations/{organizationId}/secureConnect/remoteAccessLogsExports

{
  "data": [
    {
      "id": "123",
      "from": "2023-05-16 04:23:43 UTC",
      "to": "2023-06-14 04:23:52 UTC",
      "userEmail": "joe@meraki.net",
      "status": "new",
      "metadata": {
        "fileCount": 0,
        "logCount": 0,
        "currentFileLogCount": 0,
        "generatorCount": 0,
        "limitReached": false,
        "startedAt": "2023-05-15 21:23:43.388597",
        "endedAt": "2023-05-15 21:23:43.388597",
        "duration": 60
      }
    }
  ],
  "meta": {
    "total": 1
  }
}

- Path added

- New endpoint

Provides a list of remote access logs exports for an Organization

GET /organizations/{organizationId}/secureConnect/remoteAccessLogsExports

---

- New endpoint

Creates a export for a provided timestamp interval.

POST /organizations/{organizationId}/secureConnect/remoteAccessLogsExports

---

Docs

Redirects to the download link of the completed export.

Operation ID: getOrganizationSecureConnectRemoteAccessLogsExportsDownload

PATH /organizations/{organizationId}/secureConnect/remoteAccessLogsExports/download

{
  "link": "download"
}

- Path added

- New endpoint

Redirects to the download link of the completed export.

GET /organizations/{organizationId}/secureConnect/remoteAccessLogsExports/download

---

Docs

Return the details of a specific remote access logs export

Operation ID: getOrganizationSecureConnectRemoteAccessLogsExport

PATH /organizations/{organizationId}/secureConnect/remoteAccessLogsExports/{id}

{
  "id": "123",
  "from": "2023-05-16 04:23:43 UTC",
  "to": "2023-06-14 04:23:52 UTC",
  "userEmail": "joe@meraki.net",
  "status": "new",
  "metadata": {
    "fileCount": 0,
    "logCount": 0,
    "currentFileLogCount": 0,
    "generatorCount": 0,
    "limitReached": false,
    "startedAt": "2023-05-15 21:23:43.388597",
    "endedAt": "2023-05-15 21:23:43.388597",
    "duration": 60
  }
}

- Path added

- New endpoint

Return the details of a specific remote access logs export

GET /organizations/{organizationId}/secureConnect/remoteAccessLogsExports/{id}

---