• Added
  • [ wireless ]
    • ssids
      • Update the OpenRoaming setting for the SSID
      • Update the OpenRoaming setting for the SSID
      • Returns an array of objects, each containing SSID OpenRoaming configs for the corresponding network
      • Returns an array of objects, each containing SSID OpenRoaming configs for the corresponding network
• Changed
  • [ organizations ]
    • saml
      • Create a SAML IdP for your organization.
      • Update a SAML IdP in your organization
      • List the SAML IdPs in your organization.
      • Get a SAML IdP from your organization.
    • firmware
      • Get firmware upgrade status for the filtered devices
  • [ camera ]
    • detections
      • Returns analytics data for timespans
  • [ wireless ]
    • failedConnections
      • List of all failed client connection events on this network in a given time range
  • [ switch ]
    • settings
      • Update switch network settings
      • Returns the switch network settings
  • [ networks ]
    • clients
      • Return the client associated with the given identifier

Version 1.63.0 to 1.64.0

Summary of Changes

2 - New

28 - Updated

859 - Total Endpoints

588 - Total Paths

Added

[ wireless ]

ssids

Docs

Update the OpenRoaming setting for the SSID

Operation ID: updateNetworkWirelessSsidOpenRoaming

PATH /networks/{networkId}/wireless/ssids/{number}/openRoaming

{
  "enabled": true,
  "tenantId": "123-456"
}

- Path added

- New endpoint

Update the OpenRoaming setting for the SSID

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

{
    "enabled": true,
    "tenantId": "123-456"
}

---

Docs

Returns an array of objects, each containing SSID OpenRoaming configs for the corresponding network

Operation ID: getOrganizationWirelessSsidsOpenRoamingByNetwork

PATH /organizations/{organizationId}/wireless/ssids/openRoaming/byNetwork

{
  "items": [
    {
      "networkId": "N_1234",
      "networkName": "MR wireless 1",
      "ssid": [
        {
          "name": "SSID 0",
          "number": 0,
          "enabled": true,
          "openRoaming": {
            "enabled": true,
            "tenantId": "12345"
          }
        }
      ]
    }
  ],
  "meta": {
    "counts": {
      "items": {
        "total": 105,
        "remaining": 25
      }
    }
  }
}

- Path added

- New endpoint

Returns an array of objects, each containing SSID OpenRoaming configs for the corresponding network

GET /organizations/{organizationId}/wireless/ssids/openRoaming/byNetwork

{
    "items": [
        {
            "networkId": "N_1234",
            "networkName": "MR wireless 1",
            "ssid": [
                {
                    "name": "SSID 0",
                    "number": 0,
                    "enabled": true,
                    "openRoaming": {
                        "enabled": true,
                        "tenantId": "12345"
                    }
                }
            ]
        }
    ],
    "meta": {
        "counts": {
            "items": {
                "total": 105,
                "remaining": 25
            }
        }
    }
}

---

Changed

[ organizations ]

saml

Docs

Create a SAML IdP for your organization.

Operation ID: createOrganizationSamlIdp

POST /organizations/{organizationId}/saml/idps

- Optional property ssoLoginUrl Added

- Optional property visionConsumerUrl Added

- Optional property ssoLoginUrl Added

Docs

Update a SAML IdP in your organization

Operation ID: updateOrganizationSamlIdp

PUT /organizations/{organizationId}/saml/idps/{idpId}

- Optional property ssoLoginUrl Added

- Optional property visionConsumerUrl Added

- Optional property ssoLoginUrl Added

Docs

List the SAML IdPs in your organization.

Operation ID: getOrganizationSamlIdps

GET /organizations/{organizationId}/saml/idps

- Optional property visionConsumerUrl Added

- Optional property ssoLoginUrl Added

- Response property visionConsumerUrl value added

- Response property ssoLoginUrl value added

Docs

Get a SAML IdP from your organization.

Operation ID: getOrganizationSamlIdp

GET /organizations/{organizationId}/saml/idps/{idpId}

- Optional property visionConsumerUrl Added

- Optional property ssoLoginUrl Added

- Response property visionConsumerUrl value added

- Response property ssoLoginUrl value added

firmware

Docs

Get firmware upgrade status for the filtered devices

Operation ID: getOrganizationFirmwareUpgradesByDevice

GET /organizations/{organizationId}/firmware/upgrades/byDevice

- Optional param limitPerDevice added

[ camera ]

detections

Docs

Returns analytics data for timespans

Operation ID: getOrganizationCameraDetectionsHistoryByBoundaryByInterval

GET /organizations/{organizationId}/camera/detections/history/byBoundary/byInterval

- Param counterMode Deleted

[ wireless ]

failedConnections

Docs

List of all failed client connection events on this network in a given time range

Operation ID: getNetworkWirelessFailedConnections

GET /networks/{networkId}/wireless/failedConnections

- Optional property radio Added

- Response property radio value added

[ switch ]

settings

Docs

Update switch network settings

Operation ID: updateNetworkSwitchSettings

PUT /networks/{networkId}/switch/settings

- Optional property uplinkSelection Added

- Property uacAutomaticFailback Deleted

- Property uacCandidateUplink Deleted

- Optional property uplinkSelection Added

Docs

Returns the switch network settings

Operation ID: getNetworkSwitchSettings

GET /networks/{networkId}/switch/settings

- Property uacAutomaticFailback Deleted

- Property uacCandidateUplink Deleted

- Optional property uplinkSelection Added

- Response property uplinkSelection value added

[ networks ]

clients

Docs

Return the client associated with the given identifier

Operation ID: getNetworkClient

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

- Optional property ip6Local Added

- Response property ip6Local value added