Version v1.68.0 to v1.69.0

Summary of Changes

39 - New

37 - Updated

889 - Total Endpoints

604 - Total Paths

Added

[ appliance ]

Docs

Operation ID: updateNetworkApplianceUplinksNat

PATH /networks/{networkId}/appliance/uplinks/nat

- Path added

- New endpoint

PUT /networks/{networkId}/appliance/uplinks/nat

[ devices ]

camera

Docs

Generate a video clip of up to 5 minutes long.

Operation ID: clipDeviceCamera

PATH /devices/{serial}/camera/clip

- Path added

- New endpoint

GET /devices/{serial}/camera/clip

[ organizations ]

api

Docs

List pipeline jobs, with optional status filtering

Operation ID: getOrganizationApiRestProvisioningPipelinesJobs

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

- Path added

- New endpoint

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

Docs

Retrieves pipeline overviews with aggregated job status counts

Operation ID: getOrganizationApiRestProvisioningPipelinesJobsOverviewsByPipeline

PATH /organizations/{organizationId}/api/rest/provisioning/pipelines/jobs/overviews/byPipeline

- Path added

- New endpoint

GET /organizations/{organizationId}/api/rest/provisioning/pipelines/jobs/overviews/byPipeline

appliance

Docs

Operation ID: getOrganizationApplianceUplinksNatByNetwork

PATH /organizations/{organizationId}/appliance/uplinks/nat/byNetwork

- Path added

- New endpoint

GET /organizations/{organizationId}/appliance/uplinks/nat/byNetwork

policies

Docs

List application categories with their associated applications

Operation ID: getOrganizationPoliciesGlobalFirewallApplicationCategories

PATH /organizations/{organizationId}/policies/global/firewall/applicationCategories

- Path added

- New endpoint

GET /organizations/{organizationId}/policies/global/firewall/applicationCategories

Docs

List Organization-Wide Policy Firewall Rulesets

Operation ID: getOrganizationPoliciesGlobalFirewallRulesets

PATH /organizations/{organizationId}/policies/global/firewall/rulesets

- Path added

- New endpoint

GET /organizations/{organizationId}/policies/global/firewall/rulesets

Docs

Create an Organization-Wide Policy Firewall Ruleset

Operation ID: createOrganizationPoliciesGlobalFirewallRuleset

PATH /organizations/{organizationId}/policies/global/firewall/rulesets

- Path added

- New endpoint

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

Docs

List Organization-Wide Policy Firewall Rules

Operation ID: getOrganizationPoliciesGlobalFirewallRulesetsRules

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

- Path added

- New endpoint

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

Docs

Create an Organization-Wide Policy Firewall Rule

Operation ID: createOrganizationPoliciesGlobalFirewallRulesetsRule

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

- Path added

- New endpoint

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

Docs

Delete an Organization-Wide Policy Firewall Rule

Operation ID: deleteOrganizationPoliciesGlobalFirewallRulesetsRule

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

- Path added

- New endpoint

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

Docs

Update an Organization-Wide Policy Firewall Rule

Operation ID: updateOrganizationPoliciesGlobalFirewallRulesetsRule

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

- Path added

- New endpoint

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

Docs

Delete an Organization-Wide Policy Firewall Ruleset

Operation ID: deleteOrganizationPoliciesGlobalFirewallRuleset

PATH /organizations/{organizationId}/policies/global/firewall/rulesets/{rulesetId}

- Path added

- New endpoint

DELETE /organizations/{organizationId}/policies/global/firewall/rulesets/{rulesetId}

Docs

Update an Organization-Wide Policy Firewall Ruleset

Operation ID: updateOrganizationPoliciesGlobalFirewallRuleset

PATH /organizations/{organizationId}/policies/global/firewall/rulesets/{rulesetId}

- Path added

- New endpoint

PUT /organizations/{organizationId}/policies/global/firewall/rulesets/{rulesetId}

Docs

List Organization-Wide Policies

Operation ID: getOrganizationPoliciesGlobalGroupPolicies

PATH /organizations/{organizationId}/policies/global/group/policies

- Path added

- New endpoint

GET /organizations/{organizationId}/policies/global/group/policies

Docs

Create an Organization-Wide Policy

Operation ID: createOrganizationPoliciesGlobalGroupPolicy

PATH /organizations/{organizationId}/policies/global/group/policies

- Path added

- New endpoint

POST /organizations/{organizationId}/policies/global/group/policies

Docs

Assign adaptive policy groups to a policy

Operation ID: assignOrganizationPoliciesGlobalGroupPoliciesAdaptivePolicyGroups

PATH /organizations/{organizationId}/policies/global/group/policies/adaptivePolicyGroups/assign

- Path added

- New endpoint

POST /organizations/{organizationId}/policies/global/group/policies/adaptivePolicyGroups/assign

Docs

List adaptive policy group assignments

Operation ID: getOrganizationPoliciesGlobalGroupPoliciesAdaptivePolicyGroupsAssignments

PATH /organizations/{organizationId}/policies/global/group/policies/adaptivePolicyGroups/assignments

- Path added

- New endpoint

GET /organizations/{organizationId}/policies/global/group/policies/adaptivePolicyGroups/assignments

Docs

Remove adaptive policy groups from a policy

Operation ID: removeOrganizationPoliciesGlobalGroupPoliciesAdaptivePolicyGroups

PATH /organizations/{organizationId}/policies/global/group/policies/adaptivePolicyGroups/remove

- Path added

- New endpoint

POST /organizations/{organizationId}/policies/global/group/policies/adaptivePolicyGroups/remove

Docs

Assign VLANs to a policy

Operation ID: assignOrganizationPoliciesGlobalGroupPoliciesApplianceVlans

PATH /organizations/{organizationId}/policies/global/group/policies/appliance/vlans/assign

- Path added

- New endpoint

POST /organizations/{organizationId}/policies/global/group/policies/appliance/vlans/assign

Docs

List appliance VLAN policy assignments

Operation ID: getOrganizationPoliciesGlobalGroupPoliciesApplianceVlansAssignments

PATH /organizations/{organizationId}/policies/global/group/policies/appliance/vlans/assignments

- Path added

- New endpoint

GET /organizations/{organizationId}/policies/global/group/policies/appliance/vlans/assignments

Docs

List policies by appliance VLANs

Operation ID: getOrganizationPoliciesGlobalGroupPoliciesApplianceVlansAssignmentsByVlan

PATH /organizations/{organizationId}/policies/global/group/policies/appliance/vlans/assignments/byVlan

- Path added

- New endpoint

GET /organizations/{organizationId}/policies/global/group/policies/appliance/vlans/assignments/byVlan

Docs

Remove VLANs from a policy

Operation ID: removeOrganizationPoliciesGlobalGroupPoliciesApplianceVlans

PATH /organizations/{organizationId}/policies/global/group/policies/appliance/vlans/remove

- Path added

- New endpoint

POST /organizations/{organizationId}/policies/global/group/policies/appliance/vlans/remove

Docs

List Organization-Wide Policy Ruleset Assignments

Operation ID: getOrganizationPoliciesGlobalGroupPoliciesFirewallRulesetsAssignments

PATH /organizations/{organizationId}/policies/global/group/policies/firewall/rulesets/assignments

- Path added

- New endpoint

GET /organizations/{organizationId}/policies/global/group/policies/firewall/rulesets/assignments

Docs

Create an Organization-Wide Policy Ruleset Assignment

Operation ID: createOrganizationPoliciesGlobalGroupPoliciesFirewallRulesetsAssignment

PATH /organizations/{organizationId}/policies/global/group/policies/firewall/rulesets/assignments

- Path added

- New endpoint

POST /organizations/{organizationId}/policies/global/group/policies/firewall/rulesets/assignments

Docs

Delete an Organization-Wide Policy Ruleset Assignment

Operation ID: deleteOrganizationPoliciesGlobalGroupPoliciesFirewallRulesetsAssignment

PATH /organizations/{organizationId}/policies/global/group/policies/firewall/rulesets/assignments/{assignmentId}

- Path added

- New endpoint

DELETE /organizations/{organizationId}/policies/global/group/policies/firewall/rulesets/assignments/{assignmentId}

Docs

Update an Organization-Wide Policy Ruleset Assignment

Operation ID: updateOrganizationPoliciesGlobalGroupPoliciesFirewallRulesetsAssignment

PATH /organizations/{organizationId}/policies/global/group/policies/firewall/rulesets/assignments/{assignmentId}

- Path added

- New endpoint

PUT /organizations/{organizationId}/policies/global/group/policies/firewall/rulesets/assignments/{assignmentId}

Docs

Delete an Organization-Wide Policy

Operation ID: deleteOrganizationPoliciesGlobalGroupPolicy

PATH /organizations/{organizationId}/policies/global/group/policies/{policyId}

- Path added

- New endpoint

DELETE /organizations/{organizationId}/policies/global/group/policies/{policyId}

Docs

Update an Organization-Wide Policy

Operation ID: updateOrganizationPoliciesGlobalGroupPolicy

PATH /organizations/{organizationId}/policies/global/group/policies/{policyId}

- Path added

- New endpoint

PUT /organizations/{organizationId}/policies/global/group/policies/{policyId}

sase

Docs

List SSE Connectors for an organization

Operation ID: getOrganizationSaseConnectors

PATH /organizations/{organizationId}/sase/connectors

- Path added

- New endpoint

GET /organizations/{organizationId}/sase/connectors

Docs

Deploy SSE Connectors for specified regions

Operation ID: batchOrganizationSaseConnectorsCreate

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

- Path added

- New endpoint

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

Docs

Delete SSE Connectors by ID

Operation ID: batchOrganizationSaseConnectorsDelete

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

- Path added

- New endpoint

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

Docs

List regions

Operation ID: getOrganizationSaseRegions

PATH /organizations/{organizationId}/sase/regions

- Path added

- New endpoint

GET /organizations/{organizationId}/sase/regions

Docs

List of enrolled SASE sites in this organization

Operation ID: getOrganizationSaseSites

PATH /organizations/{organizationId}/sase/sites

- Path added

- New endpoint

GET /organizations/{organizationId}/sase/sites

Docs

Attach sites in this organization to Secure Access

Operation ID: attachOrganizationSaseSites

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

- Path added

- New endpoint

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

Docs

Get the connectivity history of SASE sites in this organization

Operation ID: getOrganizationSaseSitesConnectivityHistoryBySite

PATH /organizations/{organizationId}/sase/sites/connectivity/history/bySite

- Path added

- New endpoint

GET /organizations/{organizationId}/sase/sites/connectivity/history/bySite

Docs

List high-level SASE site statuses (healthy, degraded, offline)

Operation ID: getOrganizationSaseSitesConnectivityOverview

PATH /organizations/{organizationId}/sase/sites/connectivity/overview

- Path added

- New endpoint

GET /organizations/{organizationId}/sase/sites/connectivity/overview

Docs

Detach sites in this organization from Secure Access

Operation ID: detachOrganizationSaseSites

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

- Path added

- New endpoint

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

Docs

Update the configuration for a site

Operation ID: updateOrganizationSaseSite

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

- Path added

- New endpoint

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

Changed

[ appliance ]

security

Docs

Returns all supported intrusion settings for an MX network

Operation ID: getNetworkApplianceSecurityIntrusion

GET /networks/{networkId}/appliance/security/intrusion

- added the new 'detection' enum value to the 'mode' response property for the response status '200'

- added the new 'disabled' enum value to the 'mode' response property for the response status '200'

- added the new 'prevention' enum value to the 'mode' response property for the response status '200'

vlans

Docs

Add a VLAN

Operation ID: createNetworkApplianceVlan

POST /networks/{networkId}/appliance/vlans

- added the new optional request property 'uplinks'

Docs

Update a VLAN

Operation ID: updateNetworkApplianceVlan

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

- added the new optional request property 'uplinks'

vpn

Docs

Return a Hub BGP Configuration

Operation ID: getNetworkApplianceVpnBgp

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

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

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

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

Docs

Update a Hub BGP Configuration

Operation ID: updateNetworkApplianceVpnBgp

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

- added the new optional request property 'neighbors/items/communityOut'

- added the new optional request property 'neighbors/items/filterIn'

- added the new optional request property 'routerId'

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

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

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

Docs

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

Operation ID: getNetworkApplianceVpnSiteToSiteVpn

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

- added the optional property 'hostTranslations' 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 'hostTranslations'

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

[ clients ]

splashAuthorizationStatus

Docs

Return the splash authorization for a client, for each SSID they've associated with through splash

Operation ID: getNetworkClientSplashAuthorizationStatus

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

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

Docs

Update a client's splash authorization

Operation ID: updateNetworkClientSplashAuthorizationStatus

PUT /networks/{networkId}/clients/{clientId}/splashAuthorizationStatus

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

[ devices ]

lossAndLatencyHistory

Docs

Operation ID: getDeviceLossAndLatencyHistory

GET /devices/{serial}/lossAndLatencyHistory

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

wireless

Docs

Aggregated latency info for a given AP on this network

Operation ID: getDeviceWirelessLatencyStats

GET /devices/{serial}/wireless/latencyStats

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

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

[ firmwareUpgrades ]

general

Docs

Get firmware upgrade information for a network

Operation ID: getNetworkFirmwareUpgrades

GET /networks/{networkId}/firmwareUpgrades

- added the optional property 'products/wireless/nextUpgrade/predownload' 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 'products/wireless/nextUpgrade/predownload'

- added the optional property 'products/wireless/nextUpgrade/predownload' 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 optional request property 'predownload'

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

[ organizations ]

alerts

Docs

Create an organization-wide alert configuration

Operation ID: createOrganizationAlertsProfile

POST /organizations/{organizationId}/alerts/profiles

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

Docs

Update an organization-wide alert config

Operation ID: updateOrganizationAlertsProfile

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

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

appliance

Docs

Returns all supported intrusion settings for an organization

Operation ID: getOrganizationApplianceSecurityIntrusion

GET /organizations/{organizationId}/appliance/security/intrusion

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

Docs

Sets supported intrusion settings for an organization

Operation ID: updateOrganizationApplianceSecurityIntrusion

PUT /organizations/{organizationId}/appliance/security/intrusion

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

Docs

Show VPN status for networks in an organization

Operation ID: getOrganizationApplianceVpnStatuses

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

- added the optional property '/items/merakiVpnPeers/items/priority' 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 new enum value 'experience_metrics' to the 'query' request parameter 'category'

Docs

Return overview of active health alerts for an organization

Operation ID: getOrganizationAssuranceAlertsOverview

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

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

Docs

Return a Summary of Alerts grouped by network and severity

Operation ID: getOrganizationAssuranceAlertsOverviewByNetwork

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

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

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

Docs

Return a Summary of Alerts grouped by type and severity

Operation ID: getOrganizationAssuranceAlertsOverviewByType

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

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

Docs

Returns historical health alert overviews

Operation ID: getOrganizationAssuranceAlertsOverviewHistorical

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

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

[ wireless ]

clients

Docs

Aggregated connectivity info for this network, grouped by clients

Operation ID: getNetworkWirelessClientsConnectionStats

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

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

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

Docs

Aggregated latency info for this network, grouped by clients

Operation ID: getNetworkWirelessClientsLatencyStats

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

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

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

Docs

Aggregated latency info for a given client on this network

Operation ID: getNetworkWirelessClientLatencyStats

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

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

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

devices

Docs

Aggregated latency info for this network, grouped by node

Operation ID: getNetworkWirelessDevicesLatencyStats

GET /networks/{networkId}/wireless/devices/latencyStats

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

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

electronicShelfLabel

Docs

Return the ESL settings of a wireless network

Operation ID: getNetworkWirelessElectronicShelfLabel

GET /networks/{networkId}/wireless/electronicShelfLabel

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

Docs

Update the ESL settings of a wireless network

Operation ID: updateNetworkWirelessElectronicShelfLabel

PUT /networks/{networkId}/wireless/electronicShelfLabel

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

Docs

Get a list of all ESL eligible devices of a network

Operation ID: getNetworkWirelessElectronicShelfLabelConfiguredDevices

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

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

latencyStats

Docs

Aggregated latency info for this network

Operation ID: getNetworkWirelessLatencyStats

GET /networks/{networkId}/wireless/latencyStats

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

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

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

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

settings

Docs

Return the wireless settings for a network

Operation ID: getNetworkWirelessSettings

GET /networks/{networkId}/wireless/settings

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

Docs

Update the wireless settings for a network

Operation ID: updateNetworkWirelessSettings

PUT /networks/{networkId}/wireless/settings

- added the new optional request property 'upgrade'

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

ssids

Docs

Update the attributes of an MR SSID

Operation ID: updateNetworkWirelessSsid

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

- added the new optional request property 'ssidAdminAccessible'

Docs

List the VPN settings for the SSID.

Operation ID: getNetworkWirelessSsidVpn

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

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

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

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

Docs

Update the VPN settings for the SSID

Operation ID: updateNetworkWirelessSsidVpn

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

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

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

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