Version 1.56.0 to 1.57.0

Summary of Changes

5 - New

51 - Updated

806 - Total Endpoints

544 - Total Paths

What's Changed

[ switch ]

routing

Create a layer 3 interface for a switch

POST /devices/{serial}/switch/routing/interfaces

- Property name became required

- Param createDeviceSwitchRoutingInterface became required

[ networks ]

floorPlans

Upload a floor plan

POST /networks/{networkId}/floorPlans

- Property floorNumber type turn from integer to number

- Property floorNumber type turn from integer to number

List the floor plans that belong to your network

GET /networks/{networkId}/floorPlans

- Property floorNumber type turn from integer to number

Find a floor plan by ID

GET /networks/{networkId}/floorPlans/{floorPlanId}

- Property floorNumber type turn from integer to number

Update a floor plan's geolocation and other meta data

PUT /networks/{networkId}/floorPlans/{floorPlanId}

- Property floorNumber type turn from integer to number

- Property floorNumber type turn from integer to number

Destroy a floor plan

DELETE /networks/{networkId}/floorPlans/{floorPlanId}

- Property floorNumber type turn from integer to number

[ appliance ]

dns

Assign the local DNS profile to networks in the organization

POST /organizations/{organizationId}/appliance/dns/local/profiles/assignments/bulkCreate

- OperationId turned from createOrganizationApplianceDnsLocalProfilesAssignmentsBulkCreate to bulkOrganizationApplianceDnsLocalProfilesAssignmentsCreate

- Required param bulkOrganizationApplianceDnsLocalProfilesAssignmentsCreate Added

What's Updated

[ switch ]

routing

Create a layer 3 interface for a switch

POST /devices/{serial}/switch/routing/interfaces

- Property mode Deleted

- Property switchPortId Deleted

List layer 3 interfaces for a switch

GET /devices/{serial}/switch/routing/interfaces

- Param mode Deleted

- Property mode Deleted

- Property switchPortId Deleted

Return a layer 3 interface for a switch

GET /devices/{serial}/switch/routing/interfaces/{interfaceId}

- Property mode Deleted

- Property switchPortId Deleted

Update a layer 3 interface for a switch

PUT /devices/{serial}/switch/routing/interfaces/{interfaceId}

- Property mode Deleted

- Property switchPortId Deleted

stacks

Create a layer 3 interface for a switch stack

POST /networks/{networkId}/switch/stacks/{switchStackId}/routing/interfaces

- Property mode Deleted

- Property switchPortId Deleted

List layer 3 interfaces for a switch stack

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

- Optional param protocol added

- Property mode Deleted

- Property switchPortId Deleted

Return a layer 3 interface from a switch stack

GET /networks/{networkId}/switch/stacks/{switchStackId}/routing/interfaces/{interfaceId}

- Property mode Deleted

- Property switchPortId Deleted

Update a layer 3 interface for a switch stack

PUT /networks/{networkId}/switch/stacks/{switchStackId}/routing/interfaces/{interfaceId}

- Property mode Deleted

- Property switchPortId Deleted

[ networks ]

floorPlans

List the floor plans that belong to your network

GET /networks/{networkId}/floorPlans

- Response property format value added

Find a floor plan by ID

GET /networks/{networkId}/floorPlans/{floorPlanId}

- Response property format value added

[ appliance ]

dns

Assign the local DNS profile to networks in the organization

POST /organizations/{organizationId}/appliance/dns/local/profiles/assignments/bulkCreate

- Param createOrganizationApplianceDnsLocalProfilesAssignmentsBulkCreate Deleted

[ wireless ]

radio

Return the manually configured radio settings overrides of a device, which take precedence over RF profiles.

GET /devices/{serial}/wireless/radio/settings

- Summary changed from Return the radio settings of a device to Return the manually configured radio settings overrides of a device, which take precedence over RF profiles.

Update the radio settings overrides of a device, which take precedence over RF profiles.

PUT /devices/{serial}/wireless/radio/settings

- Summary changed from Update the radio settings of a device to Update the radio settings overrides of a device, which take precedence over RF profiles.

electronicShelfLabel

Return the ESL settings of a wireless network

GET /networks/{networkId}/wireless/electronicShelfLabel

- Optional property mode Added

- Response property mode value added

Get a list of all ESL eligible devices of a network

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

- Optional property mode Added

- Response property mode value added

Update the ESL settings of a wireless network

PUT /networks/{networkId}/wireless/electronicShelfLabel

- Optional property mode Added

- Optional property mode Added

[ camera ]

qualityRetentionProfiles

Creates new quality retention profile for this network.

POST /networks/{networkId}/camera/qualityRetentionProfiles

- Optional property MV84X Added

Update an existing quality retention profile for this network.

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

- Optional property MV84X Added

[ sensor ]

alerts

Creates a sensor alert profile for a network.

POST /networks/{networkId}/sensor/alerts/profiles

- Optional property includeSensorUrl Added

- Optional property message Added

- Optional property includeSensorUrl Added

- Optional property message Added

Lists all sensor alert profiles for a network.

GET /networks/{networkId}/sensor/alerts/profiles

- Optional property includeSensorUrl Added

- Optional property message Added

- Response property includeSensorUrl value added

- Response property message value added

Show details of a sensor alert profile for a network.

GET /networks/{networkId}/sensor/alerts/profiles/{id}

- Optional property includeSensorUrl Added

- Optional property message Added

- Response property includeSensorUrl value added

- Response property message value added

Updates a sensor alert profile for a network.

PUT /networks/{networkId}/sensor/alerts/profiles/{id}

- Optional property includeSensorUrl Added

- Optional property message Added

- Optional property includeSensorUrl Added

- Optional property message Added

[ organizations ]

loginSecurity

Returns the login security settings for an organization.

GET /organizations/{organizationId}/loginSecurity

- Optional property minimumPasswordLength Added

- Response property minimumPasswordLength value added

Update the login security settings for an organization

PUT /organizations/{organizationId}/loginSecurity

- Optional property minimumPasswordLength Added

- Optional property minimumPasswordLength Added

What's New

[ wireless ]

ssids

PATH /organizations/{organizationId}/wireless/ssids/firewall/isolation/allowlist/entries

- Path added

- New endpoint

List the L2 isolation allow list MAC entry in an organization

GET /organizations/{organizationId}/wireless/ssids/firewall/isolation/allowlist/entries 

{
    "items": [
        {
            "entryId": "1",
            "createdAt": "2024-11-11T07:16:38Z",
            "lastUpdatedAt": "2024-11-11T07:16:38Z",
            "description": "Example mac address",
            "client": {
                "mac": "A1:B2:C3:D4:E5:F6"
            },
            "ssid": {
                "id": "5",
                "name": "Test SSID",
                "number": 2
            },
            "network": {
                "id": "N_123",
                "name": "Test network"
            }
        }
    ],
    "meta": {
        "counts": {
            "items": {
                "total": 1,
                "remaining": 0
            }
        }
    }
}

- New endpoint

Create isolation allow list MAC entry for this organization

POST /organizations/{organizationId}/wireless/ssids/firewall/isolation/allowlist/entries 

{
    "entryId": "1",
    "createdAt": "2024-11-11T07:16:38Z",
    "lastUpdatedAt": "2024-11-11T07:16:38Z",
    "description": "Example mac address",
    "client": {
        "mac": "A1:B2:C3:D4:E5:F6"
    },
    "ssid": {
        "id": "5",
        "name": "Test SSID",
        "number": 2
    },
    "network": {
        "id": "N_123",
        "name": "Test network"
    }
}

PATH /organizations/{organizationId}/wireless/ssids/firewall/isolation/allowlist/entries/{entryId}

- Path added

- New endpoint

Update isolation allow list MAC entry info

PUT /organizations/{organizationId}/wireless/ssids/firewall/isolation/allowlist/entries/{entryId} 

{
    "entryId": "1",
    "createdAt": "2024-11-11T07:16:38Z",
    "lastUpdatedAt": "2024-11-11T07:16:38Z",
    "description": "Example mac address",
    "client": {
        "mac": "A1:B2:C3:D4:E5:F6"
    },
    "ssid": {
        "id": "5",
        "name": "Test SSID",
        "number": 2
    },
    "network": {
        "id": "N_123",
        "name": "Test network"
    }
}

- New endpoint

Destroy isolation allow list MAC entry for this organization

DELETE /organizations/{organizationId}/wireless/ssids/firewall/isolation/allowlist/entries/{entryId}

[ organizations ]

integrations

PATH /organizations/{organizationId}/integrations/xdr/networks

- Path added

- New endpoint

Returns the networks in the organization that have XDR enabled

GET /organizations/{organizationId}/integrations/xdr/networks 

{
    "items": [
        {
            "networkId": "N_1234567",
            "productTypes": [
                "appliance"
            ],
            "name": "Test network",
            "enabled": true,
            "isEligible": true
        }
    ],
    "meta": {
        "counts": {
            "items": {
                "total": 10,
                "remaining": 0
            }
        }
    }
}

PATH /organizations/{organizationId}/integrations/xdr/networks/disable

- Path added

- New endpoint

Disable XDR on networks

POST /organizations/{organizationId}/integrations/xdr/networks/disable 

{
    "networks": [
        {
            "networkId": "N_1234567",
            "productTypes": [
                "appliance"
            ],
            "name": "Test network",
            "enabled": false,
            "isEligible": true
        }
    ]
}

PATH /organizations/{organizationId}/integrations/xdr/networks/enable

- Path added

- New endpoint

Enable XDR on networks

POST /organizations/{organizationId}/integrations/xdr/networks/enable 

{
    "networks": [
        {
            "networkId": "N_1234567",
            "productTypes": [
                "appliance"
            ],
            "name": "Test network",
            "enabled": true,
            "isEligible": true
        }
    ]
}