Version 1.61.0 to 1.62.0


Summary of Changes

3 - New

855 - Total Endpoints

585 - Total Paths



Added

[ devices ]

multicastRouting

Docs

Enqueue a job to perform a Multicast routing request for the device

Operation ID: createDeviceLiveToolsMulticastRouting

PATH /devices/{serial}/liveTools/multicastRouting

{
  "multicastRoutingId": "1284392014819",
  "url": "/devices/Q234-ABCD-5678/liveTools/multicastRouting/1284392014819",
  "request": {
    "serial": "Q234-ABCD-5678"
  },
  "status": "complete",
  "callback": {
    "id": "1284392014819",
    "url": "https://webhook.site/28efa24e-f830-4d9f-a12b-fbb9e5035031",
    "status": "new"
  }
}

- Path added

- New endpoint

Enqueue a job to perform a Multicast routing 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.

POST /devices/{serial}/liveTools/multicastRouting

{
    "multicastRoutingId": "1284392014819",
    "url": "/devices/Q234-ABCD-5678/liveTools/multicastRouting/1284392014819",
    "request": {
        "serial": "Q234-ABCD-5678"
    },
    "status": "complete",
    "callback": {
        "id": "1284392014819",
        "url": "https://webhook.site/28efa24e-f830-4d9f-a12b-fbb9e5035031",
        "status": "new"
    }
}


Docs

Return a Multicast routing live tool job.

Operation ID: getDeviceLiveToolsMulticastRouting

PATH /devices/{serial}/liveTools/multicastRouting/{multicastRoutingId}

{
  "multicastRoutingId": "1284392014819",
  "url": "/devices/Q234-ABCD-5678/liveTools/multicastRouting/1284392014819",
  "request": {
    "serial": "Q234-ABCD-5678"
  },
  "status": "complete",
  "interfaces": [
    {
      "ip": "1.2.3.4",
      "name": "Vlan20",
      "subnet": "192.168.1.0/24",
      "flags": [
        "PIM"
      ],
      "neighbors": [
        "123.123.123.1"
      ]
    }
  ],
  "routes": [
    {
      "source": "1.2.3.4",
      "group": "1.2.3.5",
      "rendezvousPoint": "10.0.0.0/24",
      "incomingInterfaceName": "Vlan100",
      "outgoingInterfaceNames": [
        "Vlan20",
        "Vlan50"
      ],
      "flags": [
        "SPT"
      ]
    }
  ],
  "error": "The device is unreachable."
}

- Path added

- New endpoint

Return a Multicast routing live tool job.

GET /devices/{serial}/liveTools/multicastRouting/{multicastRoutingId}

{
    "multicastRoutingId": "1284392014819",
    "url": "/devices/Q234-ABCD-5678/liveTools/multicastRouting/1284392014819",
    "request": {
        "serial": "Q234-ABCD-5678"
    },
    "status": "complete",
    "interfaces": [
        {
            "ip": "1.2.3.4",
            "name": "Vlan20",
            "subnet": "192.168.1.0/24",
            "flags": [
                "PIM"
            ],
            "neighbors": [
                "123.123.123.1"
            ]
        }
    ],
    "routes": [
        {
            "source": "1.2.3.4",
            "group": "1.2.3.5",
            "rendezvousPoint": "10.0.0.0/24",
            "incomingInterfaceName": "Vlan100",
            "outgoingInterfaceNames": [
                "Vlan20",
                "Vlan50"
            ],
            "flags": [
                "SPT"
            ]
        }
    ],
    "error": "The device is unreachable."
}


[ organizations ]

policies

Docs

Get policies for all clients with policies

Operation ID: getOrganizationPoliciesAssignmentsByClient

PATH /organizations/{organizationId}/policies/assignments/byClient

[
  {
    "name": "Miles's phone",
    "clientId": "k74272e",
    "mac": "22:33:44:55:66:77",
    "networkId": "N_24329156",
    "assigned": [
      {
        "name": "My group policy",
        "type": "Group",
        "id": "102",
        "limitTo": [
          {
            "appliance": false,
            "ssids": [
              {
                "number": 1
              }
            ]
          }
        ]
      }
    ]
  }
]

- Path added

- New endpoint

Get policies for all clients with policies

GET /organizations/{organizationId}/policies/assignments/byClient

[
    {
        "name": "Miles's phone",
        "clientId": "k74272e",
        "mac": "22:33:44:55:66:77",
        "networkId": "N_24329156",
        "assigned": [
            {
                "name": "My group policy",
                "type": "Group",
                "id": "102",
                "limitTo": [
                    {
                        "appliance": false,
                        "ssids": [
                            {
                                "number": 1
                            }
                        ]
                    }
                ]
            }
        ]
    }
]


Changed

[ organizations ]

devices

Docs

List Packet Captures

Operation ID: getOrganizationDevicesPacketCaptureCaptures

GET /organizations/{organizationId}/devices/packetCapture/captures

- Optional param t0 added

- Optional param t1 added

- Optional param timespan added


[ wireless ]

ssids

Docs

Return the L3 firewall rules for an SSID on an MR network

Operation ID: getNetworkWirelessSsidFirewallL3FirewallRules

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

- Optional property ipVer Added

- Response property ipVer value added


Docs

Update the L3 firewall rules of an SSID on an MR network

Operation ID: updateNetworkWirelessSsidFirewallL3FirewallRules

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

- Optional property ipVer Added

- Optional property ipVer Added


[ switch ]

configTemplates

Docs

Return all the ports of a switch template

Operation ID: getOrganizationConfigTemplateSwitchProfilePorts

GET /organizations/{organizationId}/configTemplates/{configTemplateId}/switch/profiles/{profileId}/ports

- Optional property highSpeed Added

- Response property highSpeed value added


Docs

Return a switch template port

Operation ID: getOrganizationConfigTemplateSwitchProfilePort

GET /organizations/{organizationId}/configTemplates/{configTemplateId}/switch/profiles/{profileId}/ports/{portId}

- Optional property highSpeed Added

- Response property highSpeed value added


Docs

Update a switch template port

Operation ID: updateOrganizationConfigTemplateSwitchProfilePort

PUT /organizations/{organizationId}/configTemplates/{configTemplateId}/switch/profiles/{profileId}/ports/{portId}

- Optional property highSpeed Added

- Optional property highSpeed Added


stacks

Docs

List the switch stacks in a network

Operation ID: getNetworkSwitchStacks

GET /networks/{networkId}/switch/stacks

- Optional property virtualMac Added

- Response property virtualMac value added


Docs

Show a switch stack

Operation ID: getNetworkSwitchStack

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

- Optional property virtualMac Added

- Response property virtualMac value added


Docs

Add a switch to a stack

Operation ID: addNetworkSwitchStack

POST /networks/{networkId}/switch/stacks/{switchStackId}/add

- Optional property virtualMac Added


Docs

Remove a switch from a stack

Operation ID: removeNetworkSwitchStack

POST /networks/{networkId}/switch/stacks/{switchStackId}/remove

- Optional property virtualMac Added


ports

Docs

List the switch ports for a switch

Operation ID: getDeviceSwitchPorts

GET /devices/{serial}/switch/ports

- Optional property highSpeed Added

- Response property highSpeed value added


Docs

Return a switch port

Operation ID: getDeviceSwitchPort

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

- Optional property highSpeed Added

- Response property highSpeed value added


Docs

Update a switch port

Operation ID: updateDeviceSwitchPort

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

- Optional property highSpeed Added

- Optional property highSpeed Added


[ appliance ]

vpn

Docs

Show VPN status for networks in an organization

Operation ID: getOrganizationApplianceVpnStatuses

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

- Response property items value added


[ camera ]

detections

Docs

Returns analytics data for timespans

Operation ID: getOrganizationCameraDetectionsHistoryByBoundaryByInterval

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

- Optional param counterMode added