Version 1.29.0 to v1.30.0

Summary of Changes

3 - New

39 - Updated

614 - Total operations

386 - Total Paths

What's Changed

[ global ]

service

PATH /organizations/{organizationId}/webhookLogs

- Deleted

What's Updated

[ switch ]

configTemplates

List the switch profiles for your switch template configuration

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

- Response property properties value added

Return all the ports of a switch profile

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

- Optional property profile Added

- Response property profile value added

Return a switch profile port

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

- Optional property profile Added

- Response property profile value added

Update a switch profile port

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

- Optional property profile Added

- Optional property profile Added

ports

List the switch ports for a switch

GET /devices/{serial}/switch/ports

- Optional property profile Added

- Response property profile value added

Return the status for all the ports of a switch

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

- Response property properties value added

Return a switch port

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

- Optional property profile Added

- Response property profile value added

Update a switch port

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

- Optional property profile Added

- Optional property profile Added

stormControl

Return the storm control configuration for a switch network

GET /networks/{networkId}/switch/stormControl

- Response property properties value added

[ camera ]

qualityRetentionProfiles

Creates new quality retention profile for this network.

POST /networks/{networkId}/camera/qualityRetentionProfiles

- Optional property MV33 Added

- Optional property MV13 Added

Update an existing quality retention profile for this network.

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

- Optional property MV33 Added

- Optional property MV13 Added

[ networks ]

clients

List the clients that have used this network in the timespan

GET /networks/{networkId}/clients

- Response property properties value added

policies

Get policies for all clients with policies

GET /networks/{networkId}/policies/byClient

- Optional property groupPolicyId Added

- Response property groupPolicyId value added

[ sm ]

profiles

List all the profiles in the network

GET /networks/{networkId}/sm/profiles

- Summary changed from List all profiles in a network to List all the profiles in the network

[ wireless ]

bluetooth

Return the Bluetooth settings for a network. Bluetooth settings must be enabled on the network.

GET /networks/{networkId}/wireless/bluetooth/settings

- Optional property eslEnabled Added

- Response property eslEnabled value added

Update the Bluetooth settings for a network

PUT /networks/{networkId}/wireless/bluetooth/settings

- Optional property eslEnabled Added

rfProfiles

List the non-basic RF profiles for this network

GET /networks/{networkId}/wireless/rfProfiles

- Response property afcEnabled value added

Return a RF profile

GET /networks/{networkId}/wireless/rfProfiles/{rfProfileId}

- Response property afcEnabled value added

ssids

List all Identity PSKs in a wireless network

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

- Optional property expiresAt Added

- Response property expiresAt value added

Return an Identity PSK

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

- Optional property expiresAt Added

- Response property expiresAt value added

[ organizations ]

brandingPolicies

Add a new branding policy to an organization

POST /organizations/{organizationId}/brandingPolicies

- Optional property helpWidget Added

List the branding policies of an organization

GET /organizations/{organizationId}/brandingPolicies

- Response property properties value added

- Response property helpWidget value added

Return the branding policy IDs of an organization in priority order

GET /organizations/{organizationId}/brandingPolicies/priorities

- Response property properties value added

Return a branding policy

GET /organizations/{organizationId}/brandingPolicies/{brandingPolicyId}

- Response property properties value added

- Response property helpWidget value added

Update a branding policy

PUT /organizations/{organizationId}/brandingPolicies/{brandingPolicyId}

- Optional property helpWidget Added

What's New

[ sensor ]

relationships

PATH /devices/{serial}/sensor/relationships

- Path added

- New operation

List the sensor roles for a given sensor or camera device.

GET /devices/{serial}/sensor/relationships 

[
    {
        "livestream": {
            "relatedDevices": [
                {
                    "serial": "Q234-ABCD-5678",
                    "productType": "camera"
                }
            ]
        }
    }
]

- New operation

Assign one or more sensor roles to a given sensor or camera device.

PUT /devices/{serial}/sensor/relationships 

{
    "livestream": {
        "relatedDevices": [
            {
                "serial": "Q234-ABCD-5678",
                "productType": "camera"
            }
        ]
    }
}

PATH /networks/{networkId}/sensor/relationships

- Path added

- New operation

List the sensor roles for devices in a given network

GET /networks/{networkId}/sensor/relationships 

[
    {
        "device": {
            "name": "My sensor",
            "serial": "Q234-ABCD-0001",
            "productType": "sensor"
        },
        "relationships": {
            "livestream": {
                "relatedDevices": [
                    {
                        "serial": "Q234-ABCD-5678",
                        "productType": "camera"
                    }
                ]
            }
        }
    }
]

[ organizations ]

apiRequests

PATH /organizations/{organizationId}/apiRequests/overview/responseCodes/byInterval

- Path added

- New operation

Tracks organizations' API requests by response code across a given time period

GET /organizations/{organizationId}/apiRequests/overview/responseCodes/byInterval 

[
    {
        "startTs": "2018-02-11T00:00:00Z",
        "endTs": "2018-05-12T00:00:00Z",
        "counts": [
            {
                "code": 200,
                "count": 198938
            }
        ]
    }
]