Version v1.72.0 to v1.73.0

Summary of Changes

36 - New

39 - Updated

886 - Total Endpoints

602 - 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}

[ organizations ]

assurance

Docs

List the alert profiles for this organization

Operation ID: getOrganizationAssuranceAlertsProfiles

PATH /organizations/{organizationId}/assurance/alerts/profiles

- Path added

- New endpoint

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

Docs

Create an alert profile

Operation ID: createOrganizationAssuranceAlertsProfile

PATH /organizations/{organizationId}/assurance/alerts/profiles

- Path added

- New endpoint

POST /organizations/{organizationId}/assurance/alerts/profiles

Docs

Delete an alert profile for this organization

Operation ID: deleteOrganizationAssuranceAlertsProfile

PATH /organizations/{organizationId}/assurance/alerts/profiles/{profileId}

- Path added

- New endpoint

DELETE /organizations/{organizationId}/assurance/alerts/profiles/{profileId}

Docs

Update an alert profile

Operation ID: updateOrganizationAssuranceAlertsProfile

PATH /organizations/{organizationId}/assurance/alerts/profiles/{profileId}

- Path added

- New endpoint

PUT /organizations/{organizationId}/assurance/alerts/profiles/{profileId}

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

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

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 available campus gateway clusters that can be used for wireless network tunneling

Operation ID: getOrganizationCampusGatewayClustersTunnelable

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

- Path added

- New endpoint

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

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

networks

Docs

List the network groups in an organization

Operation ID: getOrganizationNetworksGroups

PATH /organizations/{organizationId}/networks/groups

- Path added

- New endpoint

GET /organizations/{organizationId}/networks/groups

Docs

Create a network group

Operation ID: createOrganizationNetworksGroup

PATH /organizations/{organizationId}/networks/groups

- Path added

- New endpoint

POST /organizations/{organizationId}/networks/groups

Docs

List the client and status overview information for the network groups in an organization

Operation ID: getOrganizationNetworksGroupsOverviewByGroup

PATH /organizations/{organizationId}/networks/groups/overview/byGroup

- Path added

- New endpoint

GET /organizations/{organizationId}/networks/groups/overview/byGroup

Docs

Delete a network group

Operation ID: deleteOrganizationNetworksGroup

PATH /organizations/{organizationId}/networks/groups/{groupId}

- Path added

- New endpoint

DELETE /organizations/{organizationId}/networks/groups/{groupId}

Docs

Update a network group

Operation ID: updateOrganizationNetworksGroup

PATH /organizations/{organizationId}/networks/groups/{groupId}

- Path added

- New endpoint

PUT /organizations/{organizationId}/networks/groups/{groupId}

Docs

Add networks to a network group

Operation ID: bulkOrganizationNetworksGroupAssign

PATH /organizations/{organizationId}/networks/groups/{groupId}/bulkAssign

- Path added

- New endpoint

POST /organizations/{organizationId}/networks/groups/{groupId}/bulkAssign

Docs

Remove networks from a network group

Operation ID: bulkOrganizationNetworksGroupUnassign

PATH /organizations/{organizationId}/networks/groups/{groupId}/bulkUnassign

- Path added

- New endpoint

POST /organizations/{organizationId}/networks/groups/{groupId}/bulkUnassign

sase

Docs

Detach sites in this organization from Secure Access

Operation ID: detachOrganizationSaseSites

PATH /organizations/{organizationId}/sase/sites/detach

- Path added

- New endpoint

POST /organizations/{organizationId}/sase/sites/detach

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}

Changed

[ appliance ]

devices

Docs

Update MX warm spare settings

Operation ID: updateNetworkApplianceDevicesRedundancy

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

- removed the request property uplink/loadBalancing

- removed the optional property uplink/loadBalancing from the response with the 200 status

Docs

Swap MX primary and warm spare appliances

Operation ID: createNetworkApplianceDevicesRedundancySwap

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

- removed the optional property uplink/loadBalancing from 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

- added the new optional request property enabled

[ camera ]

qualityRetentionProfiles

Docs

Creates new quality retention profile for this network.

Operation ID: createNetworkCameraQualityRetentionProfile

POST /networks/{networkId}/camera/qualityRetentionProfiles

- removed the request property videoSettings/MV14

- removed the request property videoSettings/MV24

- removed the request property videoSettings/MV34

- removed the request property videoSettings/MV54N

- removed the request property videoSettings/MV64

- removed the request property videoSettings/MV74

- removed the request property videoSettings/MV94

Docs

Update an existing quality retention profile for this network.

Operation ID: updateNetworkCameraQualityRetentionProfile

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

- removed the request property videoSettings/MV14

- removed the request property videoSettings/MV24

- removed the request property videoSettings/MV34

- removed the request property videoSettings/MV54N

- removed the request property videoSettings/MV64

- removed the request property videoSettings/MV74

- removed the request property videoSettings/MV94

[ devices ]

liveTools

Docs

Return an ARP table live tool job.

Operation ID: getDeviceLiveToolsArpTable

GET /devices/{serial}/liveTools/arpTable/{arpTableId}

- the response property entries/items/interface became nullable for the status 200

- the response property error became nullable for the status 200

Docs

Enqueue a job to request the MAC table from the device

Operation ID: createDeviceLiveToolsMacTable

POST /devices/{serial}/liveTools/macTable

- added the new optional request property mac

- added the optional property request/mac to the response with the 201 status

Docs

Return a MAC table live tool job.

Operation ID: getDeviceLiveToolsMacTable

GET /devices/{serial}/liveTools/macTable/{macTableId}

- added the optional property request/mac to the response with the 200 status

switch

Docs

List the switch ports for a switch

Operation ID: getDeviceSwitchPorts

GET /devices/{serial}/switch/ports

- added the new Disabled enum value to the items/udld response property for the response status 200

- added the new N/A enum value to the items/udld response property for the response status 200

Docs

Return the status for all the ports of a switch

Operation ID: getDeviceSwitchPortsStatuses

GET /devices/{serial}/switch/ports/statuses

- added the new 400 Gbps enum value to the items/speed response property for the response status 200

Docs

Return a switch port

Operation ID: getDeviceSwitchPort

GET /devices/{serial}/switch/ports/{portId}

- added the new Disabled enum value to the udld response property for the response status 200

- added the new N/A enum value to the udld response property for the response status 200

Docs

Update a switch port

Operation ID: updateDeviceSwitchPort

PUT /devices/{serial}/switch/ports/{portId}

- added the new Disabled enum value to the udld response property for the response status 200

- added the new N/A enum value to the udld response property for the response status 200

[ firmwareUpgrades ]

general

Docs

Get firmware upgrade information for a network

Operation ID: getNetworkFirmwareUpgrades

GET /networks/{networkId}/firmwareUpgrades

- added the optional property products/campusGateway to the response with the 200 status

- added the optional property products/wireless/nextUpgrade/strategy to the response with the 200 status

Docs

Update firmware upgrade information for a network

Operation ID: updateNetworkFirmwareUpgrades

PUT /networks/{networkId}/firmwareUpgrades

- added the new optional request property featureLossAcknowledgements

- added the new optional request property products/campusGateway

- added the new optional request property products/wireless/nextUpgrade/strategy

- added the optional property products/campusGateway to the response with the 200 status

- added the optional property products/wireless/nextUpgrade/strategy to the response with the 200 status

rollbacks

Docs

Rollback a Firmware Upgrade For A Network

Operation ID: createNetworkFirmwareUpgradesRollback

POST /networks/{networkId}/firmwareUpgrades/rollbacks

- added the new campusGateway enum value to the product response property for the response status 200

- added the new campusGateway enum value to the request property product

[ organizations ]

appliance

Docs

Return MX warm spare settings

Operation ID: getOrganizationApplianceDevicesRedundancyByNetwork

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

- removed the optional property uplink/loadBalancing from 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

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

- removed the sim3 enum value from the items/items/rules/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

- removed the enum value sim3 of the request property rules/items/slot

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

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

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

Docs

Update a Cellular Data Management Profile

Operation ID: updateOrganizationDevicesCellularDataProfile

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

- removed the enum value sim3 of the request property rules/items/slot

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

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

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

earlyAccess

Docs

List the available early access features for organization

Operation ID: getOrganizationEarlyAccessFeatures

GET /organizations/{organizationId}/earlyAccess/features

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

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

policies

Docs

Create an Organization-Wide Policy Firewall Rule

Operation ID: createOrganizationPoliciesGlobalFirewallRulesetsRule

POST /organizations/{organizationId}/policies/global/firewall/rulesets/rules

- added the new countries enum value to the request property destinations/matchCriteria/items/

- added the new fqdns enum value to the request property destinations/matchCriteria/items/

- added the new siteSpecificVlans enum value to the request property destinations/matchCriteria/items/

- added the new siteSpecificVlans enum value to the request property sources/matchCriteria/items/

Docs

Update an Organization-Wide Policy Firewall Rule

Operation ID: updateOrganizationPoliciesGlobalFirewallRulesetsRule

PUT /organizations/{organizationId}/policies/global/firewall/rulesets/rules/{ruleId}

- added the new countries enum value to the request property destinations/matchCriteria/items/

- added the new fqdns enum value to the request property destinations/matchCriteria/items/

- added the new siteSpecificVlans enum value to the request property destinations/matchCriteria/items/

- added the new siteSpecificVlans enum value to the request property sources/matchCriteria/items/

sase

Docs

Delete SSE Connectors by ID

Operation ID: batchOrganizationSaseConnectorsDelete

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

- removed the optional property items from the response with the 202 status

- removed the optional property meta from the response with the 202 status

- added the optional property counts to the response with the 202 status

- added the optional property operation to the response with the 202 status

- added the optional property pipelineId to the response with the 202 status

- added the optional property status to the response with the 202 status

Docs

Attach sites in this organization to Secure Access

Operation ID: attachOrganizationSaseSites

POST /organizations/{organizationId}/sase/sites/attach

- request body became required

- the request property items became required

- the request property items/items/network became required

- the request property items/items/region became required

- removed the request property callback

- removed the optional property items from the response with the 202 status

- removed the optional property meta from the response with the 202 status

- added the optional property counts to the response with the 202 status

- added the optional property operation to the response with the 202 status

- added the optional property pipelineId to the response with the 202 status

- added the optional property status to the response with the 202 status

DELETE /organizations/{organizationId}/sase/sites/detach

- api removed without deprecation

Docs

Update the configuration for a site

Operation ID: updateOrganizationSaseSite

PUT /organizations/{organizationId}/sase/sites/{siteId}

- request body became optional

- the request property siteId became optional

summary

Docs

List the client and status overview information for the networks in an organization

Operation ID: getOrganizationSummaryTopNetworksByStatus

GET /organizations/{organizationId}/summary/top/networks/byStatus

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

switch

Docs

List the switchports in an organization

Operation ID: getOrganizationSwitchPortsStatusesBySwitch

GET /organizations/{organizationId}/switch/ports/statuses/bySwitch

- added the new 400 Gbps enum value to the items/items/ports/items/speed response property for the response status 200

[ sm ]

profiles

Docs

List profiles in a network

Operation ID: getNetworkSmProfiles

GET /networks/{networkId}/sm/profiles

- added the new optional query request parameter endingBefore

- added the new optional query request parameter perPage

- added the new optional query request parameter startingAfter

- the response header link was added for the status 200

[ trafficShaping ]

dscpTaggingOptions

Docs

Returns the available DSCP tagging options for your traffic shaping rules.

Operation ID: getNetworkTrafficShapingDscpTaggingOptions

GET /networks/{networkId}/trafficShaping/dscpTaggingOptions

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

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

[ webhooks ]

httpServers

Docs

List the HTTP servers for a network

Operation ID: getNetworkWebhooksHttpServers

GET /networks/{networkId}/webhooks/httpServers

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

Docs

Add an HTTP server to a network

Operation ID: createNetworkWebhooksHttpServer

POST /networks/{networkId}/webhooks/httpServers

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

Docs

Return an HTTP server for a network

Operation ID: getNetworkWebhooksHttpServer

GET /networks/{networkId}/webhooks/httpServers/{httpServerId}

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

Docs

Update an HTTP server

Operation ID: updateNetworkWebhooksHttpServer

PUT /networks/{networkId}/webhooks/httpServers/{httpServerId}

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

[ wireless ]

ssids

Docs

List the MR SSIDs in a network

Operation ID: getNetworkWirelessSsids

GET /networks/{networkId}/wireless/ssids

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

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

- removed the Google Apps domain enum value from the items/splashPage response property for the response status 200

Docs

Return a single MR SSID

Operation ID: getNetworkWirelessSsid

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

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

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

- removed the Google Apps domain enum value from the splashPage response property for the response status 200

Docs

Update the attributes of an MR SSID

Operation ID: updateNetworkWirelessSsid

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

- removed the enum value Google Apps domain of the request property splashPage

- added the new optional request property campusGateway

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

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

- removed the Google Apps domain enum value from the splashPage response property for the response status 200

Docs

List the device type group policies for the SSID

Operation ID: getNetworkWirelessSsidDeviceTypeGroupPolicies

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

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

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

Docs

Update the device type group policies for the SSID

Operation ID: updateNetworkWirelessSsidDeviceTypeGroupPolicies

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

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

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