{"openapi": "3.1.0", "info": {"title": "UniFi Network API", "description": "", "license": {}, "version": "10.0.162"}, "servers": [{"url": "https://{host}/proxy/network/integration", "description": "Local — console direto na LAN (header X-API-KEY)", "variables": {"host": {"default": "192.168.1.1", "description": "IP/host do console UniFi"}}}, {"url": "https://api.ui.com/v1/connector/consoles/{consoleId}/network/integration", "description": "Remoto — Cloud Connector via Site Manager (header X-API-Key)", "variables": {"consoleId": {"default": "CONSOLE_ID", "description": "id do console (GET /v1/hosts)"}}}], "tags": [{"name": "Getting Started", "description": "Provides an overview of the UniFi Network API, including authentication using API keys and request format. \nStart here to understand how to connect and make your first request.\n\n### Introduction\n\nEach UniFi Application has its own API endpoints running locally on each site,\noffering detailed analytics and control related to that specific application.\nFor a single endpoint with high-level insights across all your UniFi sites,\nrefer to the [UniFi Site Manager API](https://developer.ui.com).\n\n### Authentication and Request Format\n\nAn API Key is a unique identifier used to authenticate API requests.\nTo generate API Keys and view an example of the API Request Format,\nvisit the Integrations section of your UniFi application."}, {"name": "Filtering", "description": ""}, {"name": "Error Handling", "description": "Describes the standard API error response structure, including error codes,\nstatus names, and troubleshooting guidance."}, {"name": "Application Info", "description": "Returns general details about the UniFi Network application,\nincluding version and runtime metadata. Useful for integration validation."}, {"name": "Sites", "description": "Endpoints for listing and managing UniFi sites within a local Network application.\nSite ID is required for most other API requests."}, {"name": "UniFi Devices", "description": "Endpoints to list, inspect, and interact with UniFi devices, including adopted and pending devices.\nProvides device stats, port control, and actions."}, {"name": "Clients", "description": "Endpoints for viewing and managing connected clients (wired, wireless, VPN, and guest).\nSupports actions such as authorizing or unauthorizing guest access."}, {"name": "Networks", "description": "Endpoints for creating, updating, deleting, and inspecting network configurations\nincluding VLANs, DHCP, NAT, and IPv4/IPv6 settings."}, {"name": "WiFi Broadcasts", "description": "Endpoints to create, update, or remove WiFi networks (SSIDs).\nSupports configuration of security, band steering, multicast filtering, and captive portals."}, {"name": "Hotspot", "description": "Endpoints for managing guest access via Hotspot vouchers — create, list, or revoke vouchers\nand track their usage and expiration."}, {"name": "Firewall", "description": "Endpoints for managing custom firewall zones and policies within a site.\nDefine or update network segmentation and security boundaries."}, {"name": "Access Control (ACL Rules)", "description": "Endpoints for creating, listing, and managing ACL (Access Control List) rule\nthat enforce traffic filtering across devices and networks."}, {"name": "Traffic Matching Lists", "description": "Endpoints for managing port and IP address lists used across firewall policy configurations."}, {"name": "Supporting Resources", "description": "Contains read-only reference endpoints used to retrieve supporting data\nsuch as WAN interfaces, DPI categories, country codes, RADIUS profiles, and device tags."}], "paths": {"/v1/sites/{siteId}/wifi/broadcasts/{wifiBroadcastId}": {"get": {"tags": ["WiFi Broadcasts"], "summary": "Get Wifi Broadcast Details", "description": "Retrieve detailed information about a specific Wifi.", "operationId": "getWifiBroadcastDetails", "parameters": [{"name": "wifiBroadcastId", "in": "path", "required": true, "schema": {"type": "string", "format": "uuid"}}, {"name": "siteId", "in": "path", "required": true, "schema": {"type": "string", "format": "uuid"}}], "responses": {"200": {"description": "OK", "content": {"application/json": {"schema": {"discriminator": {"propertyName": "type", "mapping": {"STANDARD": "#/components/schemas/IntegrationStandardWifiBroadcastDetailDto", "IOT_OPTIMIZED": "#/components/schemas/IntegrationIotOptimizedWifiBroadcastDetailDto"}}, "properties": {"type": {"type": "string"}, "id": {"type": "string", "format": "uuid"}, "name": {"type": "string"}, "metadata": {"discriminator": {"propertyName": "origin", "mapping": {"USER_DEFINED": "#/components/schemas/User defined entity metadata", "DERIVED": "#/components/schemas/Derived entity metadata", "ORCHESTRATED": "#/components/schemas/Orchestrated entity metadata"}}, "properties": {"origin": {"type": "string"}}, "required": ["origin"], "title": "User or derived or orchestrated entity metadata"}, "enabled": {"type": "boolean"}, "network": {"discriminator": {"propertyName": "type", "mapping": {"NATIVE": "#/components/schemas/IntegrationWifiNativeNetworkDto", "SPECIFIC": "#/components/schemas/IntegrationWifiSpecificNetworkDto"}}, "properties": {"type": {"type": "string"}}, "required": ["type"], "title": "Wifi network reference"}, "securityConfiguration": {"discriminator": {"propertyName": "type", "mapping": {"OPEN": "#/components/schemas/IntegrationWifiOpenSecurityConfigurationDetailDto", "WPA2_PERSONAL": "#/components/schemas/IntegrationWifiWpa2PersonalSecurityConfigurationDetailDto", "WPA3_PERSONAL": "#/components/schemas/IntegrationWifiWpa3PersonalSecurityConfigurationDetailDto", "WPA2_WPA3_PERSONAL": "#/components/schemas/IntegrationWifiWpa2Wpa3PersonalSecurityConfigurationDetailDto", "WPA2_ENTERPRISE": "#/components/schemas/IntegrationWifiWpa2EnterpriseSecurityConfigurationDetailDto", "WPA3_ENTERPRISE": "#/components/schemas/IntegrationWifiWpa3EnterpriseSecurityConfigurationDetailDto", "WPA2_WPA3_ENTERPRISE": "#/components/schemas/IntegrationWifiWpa2Wpa3EnterpriseSecurityConfigurationDetailDto"}}, "properties": {"type": {"type": "string"}, "radiusConfiguration": {}}, "required": ["type"], "title": "Wifi security configuration detailObject"}, "broadcastingDeviceFilter": {"description": "Defines the custom scope of devices that will broadcast this WiFi network. If null, the WiFi network will be broadcast by all Access Point capable devices.", "discriminator": {"propertyName": "type", "mapping": {"DEVICES": "#/components/schemas/IntegrationWifiDevicesFilterDto", "DEVICE_TAGS": "#/components/schemas/IntegrationWifiDeviceTagsFilterDto"}}, "properties": {"type": {"type": "string"}}, "required": ["type"], "title": "Broadcasting device filter"}, "mdnsProxyConfiguration": {"discriminator": {"propertyName": "mode", "mapping": {"AUTO": "#/components/schemas/IntegrationWifiMdnsProxyAutoConfigurationDto", "CUSTOM": "#/components/schemas/IntegrationWifiMdnsProxyCustomConfigurationDto"}}, "properties": {"mode": {"type": "string"}}, "required": ["mode"], "title": "mDNS filtering configuration"}, "multicastFilteringPolicy": {"discriminator": {"propertyName": "action", "mapping": {"ALLOW": "#/components/schemas/IntegrationWifiMulticastFilteringAllowPolicyDto", "BLOCK": "#/components/schemas/IntegrationWifiMulticastFilteringBlockPolicyDto"}}, "properties": {"action": {"type": "string"}}, "required": ["action"], "title": "Multicast filtering policy"}, "multicastToUnicastConversionEnabled": {"type": "boolean"}, "clientIsolationEnabled": {"type": "boolean"}, "hideName": {"type": "boolean"}, "uapsdEnabled": {"type": "boolean", "description": "Indicates whether Unscheduled Automatic Power Save Delivery (U-APSD) is enabled"}, "basicDataRateKbpsByFrequencyGHz": {"properties": {"5": {"type": "integer", "format": "int32", "enum": ["6000", "9000", "12000", "24000"], "example": 6000}, "2.4": {"type": "integer", "format": "int32", "enum": ["1000", "2000", "5500", "6000", "9000", "11000", "12000", "24000"], "example": 2000}}, "required": ["2.4", "5"], "title": "IntegrationWifiBasicDataRateConfigurationDto"}, "clientFilteringPolicy": {"description": "Client connection filtering policy. Allow/restrict access to the WiFi network based on client device MAC addresses.", "properties": {"action": {"type": "string", "enum": ["ALLOW", "BLOCK"]}, "macAddressFilter": {"type": "array", "items": {"type": "string"}, "maxItems": 512, "minItems": 1, "uniqueItems": true}}, "required": ["action", "macAddressFilter"], "title": "IntegrationWifiClientFilteringPolicyDto"}, "blackoutScheduleConfiguration": {"properties": {"days": {"type": "array", "items": {"discriminator": {"propertyName": "type", "mapping": {"ALL_DAY": "#/components/schemas/IntegrationWifiBlackoutScheduleConfigurationPerAllDayDto", "TIME_RANGE": "#/components/schemas/IntegrationWifiBlackoutScheduleConfigurationPerDayWithTimeRangeDto"}}, "properties": {"type": {"type": "string"}, "day": {"type": "string", "enum": ["SUN", "MON", "TUE", "WED", "THU", "FRI", "SAT"]}}, "required": ["day", "type"], "title": "Blackout schedule configuration per day"}, "minItems": 1}}, "required": ["days"], "title": "Integration blackout schedule configuration"}}, "required": ["clientIsolationEnabled", "enabled", "hideName", "id", "metadata", "multicastToUnicastConversionEnabled", "name", "securityConfiguration", "type", "uapsdEnabled"], "title": "Wifi broadcast details"}}}}}}, "put": {"tags": ["WiFi Broadcasts"], "summary": "Update Wifi Broadcast", "description": "Update an existing Wifi Broadcast on the specified site.", "operationId": "updateWifiBroadcast", "parameters": [{"name": "wifiBroadcastId", "in": "path", "required": true, "schema": {"type": "string", "format": "uuid"}}, {"name": "siteId", "in": "path", "required": true, "schema": {"type": "string", "format": "uuid"}}], "requestBody": {"content": {"application/json": {"schema": {"discriminator": {"propertyName": "type", "mapping": {"STANDARD": "#/components/schemas/IntegrationStandardWifiBroadcastCreateUpdateDto", "IOT_OPTIMIZED": "#/components/schemas/IntegrationIotOptimizedWifiBroadcastCreateUpdateDto"}}, "properties": {"type": {"type": "string"}, "name": {"type": "string"}, "network": {"discriminator": {"propertyName": "type", "mapping": {"NATIVE": "#/components/schemas/IntegrationWifiNativeNetworkDto", "SPECIFIC": "#/components/schemas/IntegrationWifiSpecificNetworkDto"}}, "properties": {"type": {"type": "string"}}, "required": ["type"], "title": "Wifi network reference"}, "enabled": {"type": "boolean"}, "securityConfiguration": {"discriminator": {"propertyName": "type", "mapping": {"OPEN": "#/components/schemas/IntegrationWifiOpenSecurityConfigurationDetailDto", "WPA2_PERSONAL": "#/components/schemas/IntegrationWifiWpa2PersonalSecurityConfigurationDetailDto", "WPA3_PERSONAL": "#/components/schemas/IntegrationWifiWpa3PersonalSecurityConfigurationDetailDto", "WPA2_WPA3_PERSONAL": "#/components/schemas/IntegrationWifiWpa2Wpa3PersonalSecurityConfigurationDetailDto", "WPA2_ENTERPRISE": "#/components/schemas/IntegrationWifiWpa2EnterpriseSecurityConfigurationDetailDto", "WPA3_ENTERPRISE": "#/components/schemas/IntegrationWifiWpa3EnterpriseSecurityConfigurationDetailDto", "WPA2_WPA3_ENTERPRISE": "#/components/schemas/IntegrationWifiWpa2Wpa3EnterpriseSecurityConfigurationDetailDto"}}, "properties": {"type": {"type": "string"}, "radiusConfiguration": {}}, "required": ["type"], "title": "Wifi security configuration detailObject"}, "broadcastingDeviceFilter": {"description": "Defines the custom scope of devices that will broadcast this WiFi network. If null, the WiFi network will be broadcast by all Access Point capable devices.", "discriminator": {"propertyName": "type", "mapping": {"DEVICES": "#/components/schemas/IntegrationWifiDevicesFilterDto", "DEVICE_TAGS": "#/components/schemas/IntegrationWifiDeviceTagsFilterDto"}}, "properties": {"type": {"type": "string"}}, "required": ["type"], "title": "Broadcasting device filter"}, "mdnsProxyConfiguration": {"discriminator": {"propertyName": "mode", "mapping": {"AUTO": "#/components/schemas/IntegrationWifiMdnsProxyAutoConfigurationDto", "CUSTOM": "#/components/schemas/IntegrationWifiMdnsProxyCustomConfigurationDto"}}, "properties": {"mode": {"type": "string"}}, "required": ["mode"], "title": "mDNS filtering configuration"}, "multicastFilteringPolicy": {"discriminator": {"propertyName": "action", "mapping": {"ALLOW": "#/components/schemas/IntegrationWifiMulticastFilteringAllowPolicyDto", "BLOCK": "#/components/schemas/IntegrationWifiMulticastFilteringBlockPolicyDto"}}, "properties": {"action": {"type": "string"}}, "required": ["action"], "title": "Multicast filtering policy"}, "multicastToUnicastConversionEnabled": {"type": "boolean"}, "clientIsolationEnabled": {"type": "boolean"}, "hideName": {"type": "boolean"}, "uapsdEnabled": {"type": "boolean", "description": "Indicates whether Unscheduled Automatic Power Save Delivery (U-APSD) is enabled"}, "basicDataRateKbpsByFrequencyGHz": {"properties": {"5": {"type": "integer", "format": "int32", "enum": ["6000", "9000", "12000", "24000"], "example": 6000}, "2.4": {"type": "integer", "format": "int32", "enum": ["1000", "2000", "5500", "6000", "9000", "11000", "12000", "24000"], "example": 2000}}, "required": ["2.4", "5"], "title": "IntegrationWifiBasicDataRateConfigurationDto"}, "clientFilteringPolicy": {"description": "Client connection filtering policy. Allow/restrict access to the WiFi network based on client device MAC addresses.", "properties": {"action": {"type": "string", "enum": ["ALLOW", "BLOCK"]}, "macAddressFilter": {"type": "array", "items": {"type": "string"}, "maxItems": 512, "minItems": 1, "uniqueItems": true}}, "required": ["action", "macAddressFilter"], "title": "IntegrationWifiClientFilteringPolicyDto"}, "blackoutScheduleConfiguration": {"properties": {"days": {"type": "array", "items": {"discriminator": {"propertyName": "type", "mapping": {"ALL_DAY": "#/components/schemas/IntegrationWifiBlackoutScheduleConfigurationPerAllDayDto", "TIME_RANGE": "#/components/schemas/IntegrationWifiBlackoutScheduleConfigurationPerDayWithTimeRangeDto"}}, "properties": {"type": {"type": "string"}, "day": {"type": "string", "enum": ["SUN", "MON", "TUE", "WED", "THU", "FRI", "SAT"]}}, "required": ["day", "type"], "title": "Blackout schedule configuration per day"}, "minItems": 1}}, "required": ["days"], "title": "Integration blackout schedule configuration"}}, "required": ["clientIsolationEnabled", "enabled", "hideName", "multicastToUnicastConversionEnabled", "name", "securityConfiguration", "type", "uapsdEnabled"], "title": "Wifi broadcast create or update"}}}, "required": true}, "responses": {"200": {"description": "OK", "content": {"application/json": {"schema": {"discriminator": {"propertyName": "type", "mapping": {"STANDARD": "#/components/schemas/IntegrationStandardWifiBroadcastDetailDto", "IOT_OPTIMIZED": "#/components/schemas/IntegrationIotOptimizedWifiBroadcastDetailDto"}}, "properties": {"type": {"type": "string"}, "id": {"type": "string", "format": "uuid"}, "name": {"type": "string"}, "metadata": {"discriminator": {"propertyName": "origin", "mapping": {"USER_DEFINED": "#/components/schemas/User defined entity metadata", "DERIVED": "#/components/schemas/Derived entity metadata", "ORCHESTRATED": "#/components/schemas/Orchestrated entity metadata"}}, "properties": {"origin": {"type": "string"}}, "required": ["origin"], "title": "User or derived or orchestrated entity metadata"}, "enabled": {"type": "boolean"}, "network": {"discriminator": {"propertyName": "type", "mapping": {"NATIVE": "#/components/schemas/IntegrationWifiNativeNetworkDto", "SPECIFIC": "#/components/schemas/IntegrationWifiSpecificNetworkDto"}}, "properties": {"type": {"type": "string"}}, "required": ["type"], "title": "Wifi network reference"}, "securityConfiguration": {"discriminator": {"propertyName": "type", "mapping": {"OPEN": "#/components/schemas/IntegrationWifiOpenSecurityConfigurationDetailDto", "WPA2_PERSONAL": "#/components/schemas/IntegrationWifiWpa2PersonalSecurityConfigurationDetailDto", "WPA3_PERSONAL": "#/components/schemas/IntegrationWifiWpa3PersonalSecurityConfigurationDetailDto", "WPA2_WPA3_PERSONAL": "#/components/schemas/IntegrationWifiWpa2Wpa3PersonalSecurityConfigurationDetailDto", "WPA2_ENTERPRISE": "#/components/schemas/IntegrationWifiWpa2EnterpriseSecurityConfigurationDetailDto", "WPA3_ENTERPRISE": "#/components/schemas/IntegrationWifiWpa3EnterpriseSecurityConfigurationDetailDto", "WPA2_WPA3_ENTERPRISE": "#/components/schemas/IntegrationWifiWpa2Wpa3EnterpriseSecurityConfigurationDetailDto"}}, "properties": {"type": {"type": "string"}, "radiusConfiguration": {}}, "required": ["type"], "title": "Wifi security configuration detailObject"}, "broadcastingDeviceFilter": {"description": "Defines the custom scope of devices that will broadcast this WiFi network. If null, the WiFi network will be broadcast by all Access Point capable devices.", "discriminator": {"propertyName": "type", "mapping": {"DEVICES": "#/components/schemas/IntegrationWifiDevicesFilterDto", "DEVICE_TAGS": "#/components/schemas/IntegrationWifiDeviceTagsFilterDto"}}, "properties": {"type": {"type": "string"}}, "required": ["type"], "title": "Broadcasting device filter"}, "mdnsProxyConfiguration": {"discriminator": {"propertyName": "mode", "mapping": {"AUTO": "#/components/schemas/IntegrationWifiMdnsProxyAutoConfigurationDto", "CUSTOM": "#/components/schemas/IntegrationWifiMdnsProxyCustomConfigurationDto"}}, "properties": {"mode": {"type": "string"}}, "required": ["mode"], "title": "mDNS filtering configuration"}, "multicastFilteringPolicy": {"discriminator": {"propertyName": "action", "mapping": {"ALLOW": "#/components/schemas/IntegrationWifiMulticastFilteringAllowPolicyDto", "BLOCK": "#/components/schemas/IntegrationWifiMulticastFilteringBlockPolicyDto"}}, "properties": {"action": {"type": "string"}}, "required": ["action"], "title": "Multicast filtering policy"}, "multicastToUnicastConversionEnabled": {"type": "boolean"}, "clientIsolationEnabled": {"type": "boolean"}, "hideName": {"type": "boolean"}, "uapsdEnabled": {"type": "boolean", "description": "Indicates whether Unscheduled Automatic Power Save Delivery (U-APSD) is enabled"}, "basicDataRateKbpsByFrequencyGHz": {"properties": {"5": {"type": "integer", "format": "int32", "enum": ["6000", "9000", "12000", "24000"], "example": 6000}, "2.4": {"type": "integer", "format": "int32", "enum": ["1000", "2000", "5500", "6000", "9000", "11000", "12000", "24000"], "example": 2000}}, "required": ["2.4", "5"], "title": "IntegrationWifiBasicDataRateConfigurationDto"}, "clientFilteringPolicy": {"description": "Client connection filtering policy. Allow/restrict access to the WiFi network based on client device MAC addresses.", "properties": {"action": {"type": "string", "enum": ["ALLOW", "BLOCK"]}, "macAddressFilter": {"type": "array", "items": {"type": "string"}, "maxItems": 512, "minItems": 1, "uniqueItems": true}}, "required": ["action", "macAddressFilter"], "title": "IntegrationWifiClientFilteringPolicyDto"}, "blackoutScheduleConfiguration": {"properties": {"days": {"type": "array", "items": {"discriminator": {"propertyName": "type", "mapping": {"ALL_DAY": "#/components/schemas/IntegrationWifiBlackoutScheduleConfigurationPerAllDayDto", "TIME_RANGE": "#/components/schemas/IntegrationWifiBlackoutScheduleConfigurationPerDayWithTimeRangeDto"}}, "properties": {"type": {"type": "string"}, "day": {"type": "string", "enum": ["SUN", "MON", "TUE", "WED", "THU", "FRI", "SAT"]}}, "required": ["day", "type"], "title": "Blackout schedule configuration per day"}, "minItems": 1}}, "required": ["days"], "title": "Integration blackout schedule configuration"}}, "required": ["clientIsolationEnabled", "enabled", "hideName", "id", "metadata", "multicastToUnicastConversionEnabled", "name", "securityConfiguration", "type", "uapsdEnabled"], "title": "Wifi broadcast details"}}}}}}, "delete": {"tags": ["WiFi Broadcasts"], "summary": "Delete Wifi Broadcast", "description": "Delete an existing Wifi Broadcast from the specified site.", "operationId": "deleteWifiBroadcast", "parameters": [{"name": "wifiBroadcastId", "in": "path", "required": true, "schema": {"type": "string", "format": "uuid"}}, {"name": "force", "in": "query", "required": false, "schema": {"type": "boolean", "default": false}}, {"name": "siteId", "in": "path", "required": true, "schema": {"type": "string", "format": "uuid"}}], "responses": {"200": {"description": "OK"}}}}, "/v1/sites/{siteId}/traffic-matching-lists/{trafficMatchingListId}": {"get": {"tags": ["Traffic Matching Lists"], "summary": "Get Traffic Matching List", "description": "Get an exist traffic matching list on a site.", "operationId": "getTrafficMatchingList", "parameters": [{"name": "trafficMatchingListId", "in": "path", "required": true, "schema": {"type": "string", "format": "uuid"}}, {"name": "siteId", "in": "path", "required": true, "schema": {"type": "string", "format": "uuid"}}], "responses": {"200": {"description": "OK", "content": {"application/json": {"schema": {"discriminator": {"propertyName": "type", "mapping": {"PORTS": "#/components/schemas/IntegrationPortTrafficMatchingListDto", "IPV4_ADDRESSES": "#/components/schemas/IntegrationIpV4TrafficMatchingListDto", "IPV6_ADDRESSES": "#/components/schemas/IntegrationIpV6TrafficMatchingListDto"}}, "properties": {"type": {"type": "string"}, "id": {"type": "string", "format": "uuid", "example": "ffcdb32c-6278-4364-8947-df4f77118df8"}, "name": {"type": "string", "example": "Allowed port list|Protected IP list"}}, "required": ["id", "name", "type"], "title": "Traffic matching list"}}}}}}, "put": {"tags": ["Traffic Matching Lists"], "summary": "Update Traffic Matching List", "description": "Update an exist traffic matching list on a site.", "operationId": "updateTrafficMatchingList", "parameters": [{"name": "trafficMatchingListId", "in": "path", "required": true, "schema": {"type": "string", "format": "uuid"}}, {"name": "siteId", "in": "path", "required": true, "schema": {"type": "string", "format": "uuid"}}], "requestBody": {"content": {"application/json": {"schema": {"discriminator": {"propertyName": "type", "mapping": {"PORTS": "#/components/schemas/IntegrationPortTrafficMatchingListCreateUpdateDto", "IPV4_ADDRESSES": "#/components/schemas/IntegrationIpV4TrafficMatchingListCreateUpdateDto", "IPV6_ADDRESSES": "#/components/schemas/IntegrationIpV6TrafficMatchingListCreateUpdateDto"}}, "properties": {"type": {"type": "string"}, "name": {"type": "string", "example": "Allowed port list|Protected IP list"}}, "required": ["name", "type"], "title": "Create or update traffic matching list"}}}, "required": true}, "responses": {"200": {"description": "OK", "content": {"application/json": {"schema": {"discriminator": {"propertyName": "type", "mapping": {"PORTS": "#/components/schemas/IntegrationPortTrafficMatchingListDto", "IPV4_ADDRESSES": "#/components/schemas/IntegrationIpV4TrafficMatchingListDto", "IPV6_ADDRESSES": "#/components/schemas/IntegrationIpV6TrafficMatchingListDto"}}, "properties": {"type": {"type": "string"}, "id": {"type": "string", "format": "uuid", "example": "ffcdb32c-6278-4364-8947-df4f77118df8"}, "name": {"type": "string", "example": "Allowed port list|Protected IP list"}}, "required": ["id", "name", "type"], "title": "Traffic matching list"}}}}}}, "delete": {"tags": ["Traffic Matching Lists"], "summary": "Delete Traffic Matching List", "description": "Delete an exist traffic matching list on a site.", "operationId": "deleteTrafficMatchingList", "parameters": [{"name": "trafficMatchingListId", "in": "path", "required": true, "schema": {"type": "string", "format": "uuid"}}, {"name": "siteId", "in": "path", "required": true, "schema": {"type": "string", "format": "uuid"}}], "responses": {"200": {"description": "OK"}}}}, "/v1/sites/{siteId}/networks/{networkId}": {"get": {"tags": ["Networks"], "summary": "Get Network Details", "description": "Retrieve detailed information about a specific network.", "operationId": "getNetworkDetails", "parameters": [{"name": "networkId", "in": "path", "required": true, "schema": {"type": "string", "format": "uuid"}}, {"name": "siteId", "in": "path", "required": true, "schema": {"type": "string", "format": "uuid"}}], "responses": {"200": {"description": "OK", "content": {"application/json": {"schema": {"discriminator": {"propertyName": "management", "mapping": {"UNMANAGED": "#/components/schemas/Unmanaged network details", "GATEWAY": "#/components/schemas/Gateway managed network details", "SWITCH": "#/components/schemas/Switch managed network details"}}, "properties": {"management": {"type": "string"}, "id": {"type": "string", "format": "uuid"}, "name": {"type": "string", "example": "Default Network"}, "enabled": {"type": "boolean"}, "vlanId": {"type": "integer", "format": "int32", "minimum": 2}, "metadata": {"description": "Orchestrated or System-defined configurable network support", "discriminator": {"propertyName": "origin", "mapping": {"USER_DEFINED": "#/components/schemas/User defined entity metadata", "SYSTEM_DEFINED": "#/components/schemas/System defined entity metadata", "ORCHESTRATED": "#/components/schemas/Orchestrated entity metadata"}}, "properties": {"origin": {"type": "string"}}, "required": ["origin"], "title": "User or system defined or orchestrated entity metadata"}, "dhcpGuarding": {"description": "DHCP Guarding settings for this Network. If this field is omitted or null, the feature is disabled", "properties": {"trustedDhcpServerIpAddresses": {"type": "array", "description": "List of trusted DHCP server IP addresses.", "items": {"type": "string"}, "minItems": 1}}, "required": ["trustedDhcpServerIpAddresses"], "title": "Network DHCP Guarding"}}, "required": ["enabled", "id", "management", "metadata", "name", "vlanId"], "title": "Network details"}}}}}}, "put": {"tags": ["Networks"], "summary": "Update Network", "description": "Update an existing network on a site.", "operationId": "updateNetwork", "parameters": [{"name": "networkId", "in": "path", "required": true, "schema": {"type": "string", "format": "uuid"}}, {"name": "siteId", "in": "path", "required": true, "schema": {"type": "string", "format": "uuid"}}], "requestBody": {"content": {"application/json": {"schema": {"discriminator": {"propertyName": "management", "mapping": {"UNMANAGED": "#/components/schemas/IntegrationUnmanagedNetworkCreateUpdateDto", "GATEWAY": "#/components/schemas/IntegrationGatewayManagedNetworkCreateUpdateDto", "SWITCH": "#/components/schemas/IntegrationSwitchManagedNetworkCreateUpdateDto"}}, "properties": {"management": {"type": "string"}, "name": {"type": "string", "example": "Default Network"}, "enabled": {"type": "boolean"}, "vlanId": {"type": "integer", "format": "int32", "maximum": 4000, "minimum": 2}, "dhcpGuarding": {"description": "DHCP Guarding settings for this Network. If this field is omitted or null, the feature is disabled", "properties": {"trustedDhcpServerIpAddresses": {"type": "array", "description": "List of trusted DHCP server IP addresses.", "items": {"type": "string"}, "minItems": 1}}, "required": ["trustedDhcpServerIpAddresses"], "title": "Network DHCP Guarding"}}, "required": ["enabled", "management", "name", "vlanId"], "title": "Create or update Network"}}}, "required": true}, "responses": {"200": {"description": "OK", "content": {"application/json": {"schema": {"discriminator": {"propertyName": "management", "mapping": {"UNMANAGED": "#/components/schemas/Unmanaged network details", "GATEWAY": "#/components/schemas/Gateway managed network details", "SWITCH": "#/components/schemas/Switch managed network details"}}, "properties": {"management": {"type": "string"}, "id": {"type": "string", "format": "uuid"}, "name": {"type": "string", "example": "Default Network"}, "enabled": {"type": "boolean"}, "vlanId": {"type": "integer", "format": "int32", "minimum": 2}, "metadata": {"description": "Orchestrated or System-defined configurable network support", "discriminator": {"propertyName": "origin", "mapping": {"USER_DEFINED": "#/components/schemas/User defined entity metadata", "SYSTEM_DEFINED": "#/components/schemas/System defined entity metadata", "ORCHESTRATED": "#/components/schemas/Orchestrated entity metadata"}}, "properties": {"origin": {"type": "string"}}, "required": ["origin"], "title": "User or system defined or orchestrated entity metadata"}, "dhcpGuarding": {"description": "DHCP Guarding settings for this Network. If this field is omitted or null, the feature is disabled", "properties": {"trustedDhcpServerIpAddresses": {"type": "array", "description": "List of trusted DHCP server IP addresses.", "items": {"type": "string"}, "minItems": 1}}, "required": ["trustedDhcpServerIpAddresses"], "title": "Network DHCP Guarding"}}, "required": ["enabled", "id", "management", "metadata", "name", "vlanId"], "title": "Network details"}}}}}}, "delete": {"tags": ["Networks"], "summary": "Delete Network", "description": "Delete an existing network on a site.", "operationId": "deleteNetwork", "parameters": [{"name": "networkId", "in": "path", "required": true, "schema": {"type": "string", "format": "uuid"}}, {"name": "cascade", "in": "query", "required": false, "schema": {"type": "boolean", "default": false}}, {"name": "force", "in": "query", "required": false, "schema": {"type": "boolean", "default": false}}, {"name": "siteId", "in": "path", "required": true, "schema": {"type": "string", "format": "uuid"}}], "responses": {"200": {"description": "OK"}}}}, "/v1/sites/{siteId}/firewall/zones/{firewallZoneId}": {"get": {"tags": ["Firewall"], "summary": "Get Firewall Zone", "description": "Get a firewall zone on a site.", "operationId": "getFirewallZone", "parameters": [{"name": "firewallZoneId", "in": "path", "required": true, "schema": {"type": "string", "format": "uuid"}}, {"name": "siteId", "in": "path", "required": true, "schema": {"type": "string", "format": "uuid"}}], "responses": {"200": {"description": "OK", "content": {"application/json": {"schema": {"properties": {"id": {"type": "string", "format": "uuid", "example": "ffcdb32c-6278-4364-8947-df4f77118df8"}, "name": {"type": "string", "description": "Name of a firewall zone", "example": "Hotspot|My custom zone"}, "networkIds": {"type": "array", "description": "List of Network IDs", "items": {"example": "dfb21062-8ea0-4dca-b1d8-1eb3da00e58b"}, "minItems": 0}, "metadata": {"description": "System-defined configurable zones support configuring only attached networks", "discriminator": {"propertyName": "origin", "mapping": {"USER_DEFINED": "#/components/schemas/User defined entity metadata", "SYSTEM_DEFINED": "#/components/schemas/System defined entity metadata"}}, "properties": {"origin": {"type": "string"}}, "required": ["origin"], "title": "User or system defined entity metadata"}}, "required": ["id", "metadata", "name", "networkIds"], "title": "Firewall zone"}}}}}}, "put": {"tags": ["Firewall"], "summary": "Update Firewall Zone", "description": "Update a firewall zone on a site.", "operationId": "updateFirewallZone", "parameters": [{"name": "firewallZoneId", "in": "path", "required": true, "schema": {"type": "string", "format": "uuid"}}, {"name": "siteId", "in": "path", "required": true, "schema": {"type": "string", "format": "uuid"}}], "requestBody": {"content": {"application/json": {"schema": {"properties": {"name": {"type": "string", "description": "Name of a firewall zone", "example": "Hotspot|My custom zone"}, "networkIds": {"type": "array", "description": "List of Network IDs", "items": {"example": "dfb21062-8ea0-4dca-b1d8-1eb3da00e58b"}, "minItems": 0}}, "required": ["name", "networkIds"], "title": "Create or update firewall zone"}}}, "required": true}, "responses": {"200": {"description": "OK", "content": {"application/json": {"schema": {"properties": {"id": {"type": "string", "format": "uuid", "example": "ffcdb32c-6278-4364-8947-df4f77118df8"}, "name": {"type": "string", "description": "Name of a firewall zone", "example": "Hotspot|My custom zone"}, "networkIds": {"type": "array", "description": "List of Network IDs", "items": {"example": "dfb21062-8ea0-4dca-b1d8-1eb3da00e58b"}, "minItems": 0}, "metadata": {"description": "System-defined configurable zones support configuring only attached networks", "discriminator": {"propertyName": "origin", "mapping": {"USER_DEFINED": "#/components/schemas/User defined entity metadata", "SYSTEM_DEFINED": "#/components/schemas/System defined entity metadata"}}, "properties": {"origin": {"type": "string"}}, "required": ["origin"], "title": "User or system defined entity metadata"}}, "required": ["id", "metadata", "name", "networkIds"], "title": "Firewall zone"}}}}}}, "delete": {"tags": ["Firewall"], "summary": "Delete Custom Firewall Zone", "description": "Delete a custom firewall zone from a site.", "operationId": "deleteFirewallZone", "parameters": [{"name": "firewallZoneId", "in": "path", "required": true, "schema": {"type": "string", "format": "uuid"}}, {"name": "siteId", "in": "path", "required": true, "schema": {"type": "string", "format": "uuid"}}], "responses": {"200": {"description": "OK"}}}}, "/v1/sites/{siteId}/acl-rules/{aclRuleId}": {"get": {"tags": ["Access Control (ACL Rules)"], "summary": "Get ACL Rule", "operationId": "getAclRule", "parameters": [{"name": "aclRuleId", "in": "path", "required": true, "schema": {"type": "string", "format": "uuid"}}, {"name": "siteId", "in": "path", "required": true, "schema": {"type": "string", "format": "uuid"}}], "responses": {"200": {"description": "OK", "content": {"application/json": {"schema": {"discriminator": {"propertyName": "type", "mapping": {"IPV4": "#/components/schemas/IntegrationIpAclRuleDto", "MAC": "#/components/schemas/IntegrationMacAclRuleDto"}}, "properties": {"type": {"type": "string"}, "id": {"type": "string", "format": "uuid"}, "enabled": {"type": "boolean", "example": true}, "name": {"type": "string", "description": "ACL rule name"}, "description": {"type": "string", "description": "ACL rule description"}, "action": {"type": "string", "description": "ACL rule action", "enum": ["ALLOW", "BLOCK"], "example": "ALLOW|BLOCK"}, "enforcingDeviceFilter": {"description": "IDs of the Switch-capable devices used to enforce the ACL rule. When null, the rule will be provisioned to all switches on the site.", "discriminator": {"propertyName": "type", "mapping": {"DEVICES": "#/components/schemas/IntegrationAclRuleDevicesFilterDto"}}, "properties": {"type": {"type": "string"}}, "required": ["type"], "title": "ACL rule device filter"}, "index": {"type": "integer", "format": "int32", "description": "ACL rule index. Lower index has higher priority", "minimum": 0}, "sourceFilter": {"description": "Traffic source filter"}, "destinationFilter": {"description": "Traffic destination filter"}, "metadata": {"description": "Only user-defined rules can be deleted or modified", "discriminator": {"propertyName": "origin", "mapping": {"USER_DEFINED": "#/components/schemas/User defined entity metadata", "SYSTEM_DEFINED": "#/components/schemas/System defined entity metadata", "DERIVED": "#/components/schemas/Derived entity metadata", "ORCHESTRATED": "#/components/schemas/Orchestrated entity metadata"}}, "properties": {"origin": {"type": "string"}}, "required": ["origin"], "title": "Entity metadata"}}, "required": ["action", "enabled", "id", "index", "metadata", "name", "type"], "title": "ACL rule"}}}}}}, "put": {"tags": ["Access Control (ACL Rules)"], "summary": "Update ACL Rule", "description": "Update an existing user defined ACL rule", "operationId": "updateAclRule", "parameters": [{"name": "aclRuleId", "in": "path", "required": true, "schema": {"type": "string", "format": "uuid"}}, {"name": "siteId", "in": "path", "required": true, "schema": {"type": "string", "format": "uuid"}}], "requestBody": {"content": {"application/json": {"schema": {"discriminator": {"propertyName": "type", "mapping": {"IPV4": "#/components/schemas/IntegrationIpAclRuleCreateUpdateDto", "MAC": "#/components/schemas/IntegrationMacAclRuleCreateUpdateDto"}}, "properties": {"type": {"type": "string"}, "enabled": {"type": "boolean", "example": true}, "name": {"type": "string", "description": "ACL rule name"}, "description": {"type": "string", "description": "ACL rule description"}, "action": {"type": "string", "description": "ACL rule action", "enum": ["ALLOW", "BLOCK"], "example": "ALLOW|BLOCK"}, "enforcingDeviceFilter": {"description": "IDs of the Switch-capable devices used to enforce the ACL rule. When null, the rule will be provisioned to all switches on the site.", "discriminator": {"propertyName": "type", "mapping": {"DEVICES": "#/components/schemas/IntegrationAclRuleDevicesFilterDto"}}, "properties": {"type": {"type": "string"}}, "required": ["type"], "title": "ACL rule device filter"}, "index": {"type": "integer", "format": "int32", "description": "ACL rule index. Lower index has higher priority", "minimum": 0}, "sourceFilter": {"description": "Traffic source filter"}, "destinationFilter": {"description": "Traffic destination filter"}}, "required": ["action", "enabled", "index", "name", "type"], "title": "ACL rule update"}}}, "required": true}, "responses": {"200": {"description": "OK", "content": {"application/json": {"schema": {"discriminator": {"propertyName": "type", "mapping": {"IPV4": "#/components/schemas/IntegrationIpAclRuleDto", "MAC": "#/components/schemas/IntegrationMacAclRuleDto"}}, "properties": {"type": {"type": "string"}, "id": {"type": "string", "format": "uuid"}, "enabled": {"type": "boolean", "example": true}, "name": {"type": "string", "description": "ACL rule name"}, "description": {"type": "string", "description": "ACL rule description"}, "action": {"type": "string", "description": "ACL rule action", "enum": ["ALLOW", "BLOCK"], "example": "ALLOW|BLOCK"}, "enforcingDeviceFilter": {"description": "IDs of the Switch-capable devices used to enforce the ACL rule. When null, the rule will be provisioned to all switches on the site.", "discriminator": {"propertyName": "type", "mapping": {"DEVICES": "#/components/schemas/IntegrationAclRuleDevicesFilterDto"}}, "properties": {"type": {"type": "string"}}, "required": ["type"], "title": "ACL rule device filter"}, "index": {"type": "integer", "format": "int32", "description": "ACL rule index. Lower index has higher priority", "minimum": 0}, "sourceFilter": {"description": "Traffic source filter"}, "destinationFilter": {"description": "Traffic destination filter"}, "metadata": {"description": "Only user-defined rules can be deleted or modified", "discriminator": {"propertyName": "origin", "mapping": {"USER_DEFINED": "#/components/schemas/User defined entity metadata", "SYSTEM_DEFINED": "#/components/schemas/System defined entity metadata", "DERIVED": "#/components/schemas/Derived entity metadata", "ORCHESTRATED": "#/components/schemas/Orchestrated entity metadata"}}, "properties": {"origin": {"type": "string"}}, "required": ["origin"], "title": "Entity metadata"}}, "required": ["action", "enabled", "id", "index", "metadata", "name", "type"], "title": "ACL rule"}}}}}}, "delete": {"tags": ["Access Control (ACL Rules)"], "summary": "Delete ACL Rule", "description": "Delete an existing user defined ACL rule", "operationId": "deleteAclRule", "parameters": [{"name": "aclRuleId", "in": "path", "required": true, "schema": {"type": "string", "format": "uuid"}}, {"name": "siteId", "in": "path", "required": true, "schema": {"type": "string", "format": "uuid"}}], "responses": {"200": {"description": "OK"}}}}, "/v1/sites/{siteId}/wifi/broadcasts": {"get": {"tags": ["WiFi Broadcasts"], "summary": "List Wifi Broadcasts", "description": "$1d", "operationId": "getWifiBroadcastPage", "parameters": [{"name": "offset", "in": "query", "required": false, "schema": {"format": "int32", "default": 0, "minimum": 0}}, {"name": "limit", "in": "query", "required": false, "schema": {"format": "int32", "default": 25, "maximum": 200, "minimum": 0}}, {"name": "filter", "in": "query", "required": false, "schema": {"type": "string"}}, {"name": "siteId", "in": "path", "required": true, "schema": {"type": "string", "format": "uuid"}}], "responses": {"200": {"description": "OK", "content": {"application/json": {"schema": {"properties": {"offset": {"type": "integer", "format": "int64", "example": 0}, "limit": {"type": "integer", "format": "int32", "example": 25}, "count": {"type": "integer", "format": "int32", "example": 10}, "totalCount": {"type": "integer", "format": "int64", "example": 1000}, "data": {"type": "array", "items": {"discriminator": {"propertyName": "type", "mapping": {"STANDARD": "#/components/schemas/IntegrationStandardWifiBroadcastOverviewDto", "IOT_OPTIMIZED": "#/components/schemas/IntegrationIotOptimizedWifiBroadcastOverviewDto"}}, "properties": {"type": {"type": "string"}, "id": {"type": "string", "format": "uuid"}, "name": {"type": "string"}, "enabled": {"type": "boolean"}, "metadata": {"discriminator": {"propertyName": "origin", "mapping": {"USER_DEFINED": "#/components/schemas/User defined entity metadata", "DERIVED": "#/components/schemas/Derived entity metadata", "ORCHESTRATED": "#/components/schemas/Orchestrated entity metadata"}}, "properties": {"origin": {"type": "string"}}, "required": ["origin"], "title": "User or derived or orchestrated entity metadata"}, "network": {"discriminator": {"propertyName": "type", "mapping": {"NATIVE": "#/components/schemas/IntegrationWifiNativeNetworkDto", "SPECIFIC": "#/components/schemas/IntegrationWifiSpecificNetworkDto"}}, "properties": {"type": {"type": "string"}}, "required": ["type"], "title": "Wifi network reference"}, "securityConfiguration": {"discriminator": {"propertyName": "type", "mapping": {"OPEN": "#/components/schemas/IntegrationWifiOpenSecurityConfigurationOverviewDto", "WPA2_PERSONAL": "#/components/schemas/IntegrationWifiWpa2PersonalSecurityConfigurationOverviewDto", "WPA3_PERSONAL": "#/components/schemas/IntegrationWifiWpa3PersonalSecurityConfigurationOverviewDto", "WPA2_WPA3_PERSONAL": "#/components/schemas/IntegrationWifiWpa2Wpa3PersonalSecurityConfigurationOverviewDto", "WPA2_ENTERPRISE": "#/components/schemas/IntegrationWifiWpa2EnterpriseSecurityConfigurationOverviewDto", "WPA3_ENTERPRISE": "#/components/schemas/IntegrationWifiWpa3EnterpriseSecurityConfigurationOverviewDto", "WPA2_WPA3_ENTERPRISE": "#/components/schemas/IntegrationWifiWpa2Wpa3EnterpriseSecurityConfigurationOverviewDto"}}, "properties": {"type": {"type": "string"}}, "required": ["type"], "title": "Wifi security configuration overview"}, "broadcastingDeviceFilter": {"description": "Defines the custom scope of devices that will broadcast this WiFi network. If null, the WiFi network will be broadcast by all Access Point capable devices.", "discriminator": {"propertyName": "type", "mapping": {"DEVICES": "#/components/schemas/IntegrationWifiDevicesFilterDto", "DEVICE_TAGS": "#/components/schemas/IntegrationWifiDeviceTagsFilterDto"}}, "properties": {"type": {"type": "string"}}, "required": ["type"], "title": "Broadcasting device filter"}}, "required": ["enabled", "id", "metadata", "name", "securityConfiguration", "type"], "title": "Wifi broadcast overview"}}}, "required": ["count", "data", "limit", "offset", "totalCount"], "title": "IntegrationWifiBroadcastPageDto"}}}}}}, "post": {"tags": ["WiFi Broadcasts"], "summary": "Create Wifi Broadcast", "description": "Create a new Wifi Broadcast on the specified site.", "operationId": "createWifiBroadcast", "parameters": [{"name": "siteId", "in": "path", "required": true, "schema": {"type": "string", "format": "uuid"}}], "requestBody": {"content": {"application/json": {"schema": {"discriminator": {"propertyName": "type", "mapping": {"STANDARD": "#/components/schemas/IntegrationStandardWifiBroadcastCreateUpdateDto", "IOT_OPTIMIZED": "#/components/schemas/IntegrationIotOptimizedWifiBroadcastCreateUpdateDto"}}, "properties": {"type": {"type": "string"}, "name": {"type": "string"}, "network": {"discriminator": {"propertyName": "type", "mapping": {"NATIVE": "#/components/schemas/IntegrationWifiNativeNetworkDto", "SPECIFIC": "#/components/schemas/IntegrationWifiSpecificNetworkDto"}}, "properties": {"type": {"type": "string"}}, "required": ["type"], "title": "Wifi network reference"}, "enabled": {"type": "boolean"}, "securityConfiguration": {"discriminator": {"propertyName": "type", "mapping": {"OPEN": "#/components/schemas/IntegrationWifiOpenSecurityConfigurationDetailDto", "WPA2_PERSONAL": "#/components/schemas/IntegrationWifiWpa2PersonalSecurityConfigurationDetailDto", "WPA3_PERSONAL": "#/components/schemas/IntegrationWifiWpa3PersonalSecurityConfigurationDetailDto", "WPA2_WPA3_PERSONAL": "#/components/schemas/IntegrationWifiWpa2Wpa3PersonalSecurityConfigurationDetailDto", "WPA2_ENTERPRISE": "#/components/schemas/IntegrationWifiWpa2EnterpriseSecurityConfigurationDetailDto", "WPA3_ENTERPRISE": "#/components/schemas/IntegrationWifiWpa3EnterpriseSecurityConfigurationDetailDto", "WPA2_WPA3_ENTERPRISE": "#/components/schemas/IntegrationWifiWpa2Wpa3EnterpriseSecurityConfigurationDetailDto"}}, "properties": {"type": {"type": "string"}, "radiusConfiguration": {}}, "required": ["type"], "title": "Wifi security configuration detailObject"}, "broadcastingDeviceFilter": {"description": "Defines the custom scope of devices that will broadcast this WiFi network. If null, the WiFi network will be broadcast by all Access Point capable devices.", "discriminator": {"propertyName": "type", "mapping": {"DEVICES": "#/components/schemas/IntegrationWifiDevicesFilterDto", "DEVICE_TAGS": "#/components/schemas/IntegrationWifiDeviceTagsFilterDto"}}, "properties": {"type": {"type": "string"}}, "required": ["type"], "title": "Broadcasting device filter"}, "mdnsProxyConfiguration": {"discriminator": {"propertyName": "mode", "mapping": {"AUTO": "#/components/schemas/IntegrationWifiMdnsProxyAutoConfigurationDto", "CUSTOM": "#/components/schemas/IntegrationWifiMdnsProxyCustomConfigurationDto"}}, "properties": {"mode": {"type": "string"}}, "required": ["mode"], "title": "mDNS filtering configuration"}, "multicastFilteringPolicy": {"discriminator": {"propertyName": "action", "mapping": {"ALLOW": "#/components/schemas/IntegrationWifiMulticastFilteringAllowPolicyDto", "BLOCK": "#/components/schemas/IntegrationWifiMulticastFilteringBlockPolicyDto"}}, "properties": {"action": {"type": "string"}}, "required": ["action"], "title": "Multicast filtering policy"}, "multicastToUnicastConversionEnabled": {"type": "boolean"}, "clientIsolationEnabled": {"type": "boolean"}, "hideName": {"type": "boolean"}, "uapsdEnabled": {"type": "boolean", "description": "Indicates whether Unscheduled Automatic Power Save Delivery (U-APSD) is enabled"}, "basicDataRateKbpsByFrequencyGHz": {"properties": {"5": {"type": "integer", "format": "int32", "enum": ["6000", "9000", "12000", "24000"], "example": 6000}, "2.4": {"type": "integer", "format": "int32", "enum": ["1000", "2000", "5500", "6000", "9000", "11000", "12000", "24000"], "example": 2000}}, "required": ["2.4", "5"], "title": "IntegrationWifiBasicDataRateConfigurationDto"}, "clientFilteringPolicy": {"description": "Client connection filtering policy. Allow/restrict access to the WiFi network based on client device MAC addresses.", "properties": {"action": {"type": "string", "enum": ["ALLOW", "BLOCK"]}, "macAddressFilter": {"type": "array", "items": {"type": "string"}, "maxItems": 512, "minItems": 1, "uniqueItems": true}}, "required": ["action", "macAddressFilter"], "title": "IntegrationWifiClientFilteringPolicyDto"}, "blackoutScheduleConfiguration": {"properties": {"days": {"type": "array", "items": {"discriminator": {"propertyName": "type", "mapping": {"ALL_DAY": "#/components/schemas/IntegrationWifiBlackoutScheduleConfigurationPerAllDayDto", "TIME_RANGE": "#/components/schemas/IntegrationWifiBlackoutScheduleConfigurationPerDayWithTimeRangeDto"}}, "properties": {"type": {"type": "string"}, "day": {"type": "string", "enum": ["SUN", "MON", "TUE", "WED", "THU", "FRI", "SAT"]}}, "required": ["day", "type"], "title": "Blackout schedule configuration per day"}, "minItems": 1}}, "required": ["days"], "title": "Integration blackout schedule configuration"}}, "required": ["clientIsolationEnabled", "enabled", "hideName", "multicastToUnicastConversionEnabled", "name", "securityConfiguration", "type", "uapsdEnabled"], "title": "Wifi broadcast create or update"}}}, "required": true}, "responses": {"201": {"description": "Created", "content": {"application/json": {"schema": {"discriminator": {"propertyName": "type", "mapping": {"STANDARD": "#/components/schemas/IntegrationStandardWifiBroadcastDetailDto", "IOT_OPTIMIZED": "#/components/schemas/IntegrationIotOptimizedWifiBroadcastDetailDto"}}, "properties": {"type": {"type": "string"}, "id": {"type": "string", "format": "uuid"}, "name": {"type": "string"}, "metadata": {"discriminator": {"propertyName": "origin", "mapping": {"USER_DEFINED": "#/components/schemas/User defined entity metadata", "DERIVED": "#/components/schemas/Derived entity metadata", "ORCHESTRATED": "#/components/schemas/Orchestrated entity metadata"}}, "properties": {"origin": {"type": "string"}}, "required": ["origin"], "title": "User or derived or orchestrated entity metadata"}, "enabled": {"type": "boolean"}, "network": {"discriminator": {"propertyName": "type", "mapping": {"NATIVE": "#/components/schemas/IntegrationWifiNativeNetworkDto", "SPECIFIC": "#/components/schemas/IntegrationWifiSpecificNetworkDto"}}, "properties": {"type": {"type": "string"}}, "required": ["type"], "title": "Wifi network reference"}, "securityConfiguration": {"discriminator": {"propertyName": "type", "mapping": {"OPEN": "#/components/schemas/IntegrationWifiOpenSecurityConfigurationDetailDto", "WPA2_PERSONAL": "#/components/schemas/IntegrationWifiWpa2PersonalSecurityConfigurationDetailDto", "WPA3_PERSONAL": "#/components/schemas/IntegrationWifiWpa3PersonalSecurityConfigurationDetailDto", "WPA2_WPA3_PERSONAL": "#/components/schemas/IntegrationWifiWpa2Wpa3PersonalSecurityConfigurationDetailDto", "WPA2_ENTERPRISE": "#/components/schemas/IntegrationWifiWpa2EnterpriseSecurityConfigurationDetailDto", "WPA3_ENTERPRISE": "#/components/schemas/IntegrationWifiWpa3EnterpriseSecurityConfigurationDetailDto", "WPA2_WPA3_ENTERPRISE": "#/components/schemas/IntegrationWifiWpa2Wpa3EnterpriseSecurityConfigurationDetailDto"}}, "properties": {"type": {"type": "string"}, "radiusConfiguration": {}}, "required": ["type"], "title": "Wifi security configuration detailObject"}, "broadcastingDeviceFilter": {"description": "Defines the custom scope of devices that will broadcast this WiFi network. If null, the WiFi network will be broadcast by all Access Point capable devices.", "discriminator": {"propertyName": "type", "mapping": {"DEVICES": "#/components/schemas/IntegrationWifiDevicesFilterDto", "DEVICE_TAGS": "#/components/schemas/IntegrationWifiDeviceTagsFilterDto"}}, "properties": {"type": {"type": "string"}}, "required": ["type"], "title": "Broadcasting device filter"}, "mdnsProxyConfiguration": {"discriminator": {"propertyName": "mode", "mapping": {"AUTO": "#/components/schemas/IntegrationWifiMdnsProxyAutoConfigurationDto", "CUSTOM": "#/components/schemas/IntegrationWifiMdnsProxyCustomConfigurationDto"}}, "properties": {"mode": {"type": "string"}}, "required": ["mode"], "title": "mDNS filtering configuration"}, "multicastFilteringPolicy": {"discriminator": {"propertyName": "action", "mapping": {"ALLOW": "#/components/schemas/IntegrationWifiMulticastFilteringAllowPolicyDto", "BLOCK": "#/components/schemas/IntegrationWifiMulticastFilteringBlockPolicyDto"}}, "properties": {"action": {"type": "string"}}, "required": ["action"], "title": "Multicast filtering policy"}, "multicastToUnicastConversionEnabled": {"type": "boolean"}, "clientIsolationEnabled": {"type": "boolean"}, "hideName": {"type": "boolean"}, "uapsdEnabled": {"type": "boolean", "description": "Indicates whether Unscheduled Automatic Power Save Delivery (U-APSD) is enabled"}, "basicDataRateKbpsByFrequencyGHz": {"properties": {"5": {"type": "integer", "format": "int32", "enum": ["6000", "9000", "12000", "24000"], "example": 6000}, "2.4": {"type": "integer", "format": "int32", "enum": ["1000", "2000", "5500", "6000", "9000", "11000", "12000", "24000"], "example": 2000}}, "required": ["2.4", "5"], "title": "IntegrationWifiBasicDataRateConfigurationDto"}, "clientFilteringPolicy": {"description": "Client connection filtering policy. Allow/restrict access to the WiFi network based on client device MAC addresses.", "properties": {"action": {"type": "string", "enum": ["ALLOW", "BLOCK"]}, "macAddressFilter": {"type": "array", "items": {"type": "string"}, "maxItems": 512, "minItems": 1, "uniqueItems": true}}, "required": ["action", "macAddressFilter"], "title": "IntegrationWifiClientFilteringPolicyDto"}, "blackoutScheduleConfiguration": {"properties": {"days": {"type": "array", "items": {"discriminator": {"propertyName": "type", "mapping": {"ALL_DAY": "#/components/schemas/IntegrationWifiBlackoutScheduleConfigurationPerAllDayDto", "TIME_RANGE": "#/components/schemas/IntegrationWifiBlackoutScheduleConfigurationPerDayWithTimeRangeDto"}}, "properties": {"type": {"type": "string"}, "day": {"type": "string", "enum": ["SUN", "MON", "TUE", "WED", "THU", "FRI", "SAT"]}}, "required": ["day", "type"], "title": "Blackout schedule configuration per day"}, "minItems": 1}}, "required": ["days"], "title": "Integration blackout schedule configuration"}}, "required": ["clientIsolationEnabled", "enabled", "hideName", "id", "metadata", "multicastToUnicastConversionEnabled", "name", "securityConfiguration", "type", "uapsdEnabled"], "title": "Wifi broadcast details"}}}}}}}, "/v1/sites/{siteId}/traffic-matching-lists": {"get": {"tags": ["Traffic Matching Lists"], "summary": "List Traffic Matching Lists", "description": "Retrieve all traffic matching lists on a site.\n\n<details>\n<summary>Filterable properties (click to expand)</summary>\n\n|Name|Type|Allowed functions|\n|-|-|-|\n|`id`|`UUID`|`eq` `ne` `in` `notIn`|\n|`name`|`STRING`|`eq` `ne` `in` `notIn` `like`|\n</details>", "operationId": "getTrafficMatchingLists", "parameters": [{"name": "offset", "in": "query", "required": false, "schema": {"format": "int32", "default": 0, "minimum": 0}}, {"name": "limit", "in": "query", "required": false, "schema": {"format": "int32", "default": 25, "maximum": 200, "minimum": 0}}, {"name": "filter", "in": "query", "required": false, "schema": {"type": "string"}}, {"name": "siteId", "in": "path", "required": true, "schema": {"type": "string", "format": "uuid"}}], "responses": {"200": {"description": "OK", "content": {"application/json": {"schema": {"properties": {"offset": {"type": "integer", "format": "int64", "example": 0}, "limit": {"type": "integer", "format": "int32", "example": 25}, "count": {"type": "integer", "format": "int32", "example": 10}, "totalCount": {"type": "integer", "format": "int64", "example": 1000}, "data": {"type": "array", "items": {"discriminator": {"propertyName": "type", "mapping": {"PORTS": "#/components/schemas/IntegrationPortTrafficMatchingListDto", "IPV4_ADDRESSES": "#/components/schemas/IntegrationIpV4TrafficMatchingListDto", "IPV6_ADDRESSES": "#/components/schemas/IntegrationIpV6TrafficMatchingListDto"}}, "properties": {"type": {"type": "string"}, "id": {"type": "string", "format": "uuid", "example": "ffcdb32c-6278-4364-8947-df4f77118df8"}, "name": {"type": "string", "example": "Allowed port list|Protected IP list"}}, "required": ["id", "name", "type"], "title": "Traffic matching list"}}}, "required": ["count", "data", "limit", "offset", "totalCount"], "title": "Traffic matching lists page"}}}}}}, "post": {"tags": ["Traffic Matching Lists"], "summary": "Create Traffic Matching List", "description": "Create a new traffic matching list on a site.", "operationId": "createTrafficMatchingList", "parameters": [{"name": "siteId", "in": "path", "required": true, "schema": {"type": "string", "format": "uuid"}}], "requestBody": {"content": {"application/json": {"schema": {"discriminator": {"propertyName": "type", "mapping": {"PORTS": "#/components/schemas/IntegrationPortTrafficMatchingListCreateUpdateDto", "IPV4_ADDRESSES": "#/components/schemas/IntegrationIpV4TrafficMatchingListCreateUpdateDto", "IPV6_ADDRESSES": "#/components/schemas/IntegrationIpV6TrafficMatchingListCreateUpdateDto"}}, "properties": {"type": {"type": "string"}, "name": {"type": "string", "example": "Allowed port list|Protected IP list"}}, "required": ["name", "type"], "title": "Create or update traffic matching list"}}}, "required": true}, "responses": {"201": {"description": "Created", "content": {"application/json": {"schema": {"discriminator": {"propertyName": "type", "mapping": {"PORTS": "#/components/schemas/IntegrationPortTrafficMatchingListDto", "IPV4_ADDRESSES": "#/components/schemas/IntegrationIpV4TrafficMatchingListDto", "IPV6_ADDRESSES": "#/components/schemas/IntegrationIpV6TrafficMatchingListDto"}}, "properties": {"type": {"type": "string"}, "id": {"type": "string", "format": "uuid", "example": "ffcdb32c-6278-4364-8947-df4f77118df8"}, "name": {"type": "string", "example": "Allowed port list|Protected IP list"}}, "required": ["id", "name", "type"], "title": "Traffic matching list"}}}}}}}, "/v1/sites/{siteId}/networks": {"get": {"tags": ["Networks"], "summary": "List Networks", "description": "Retrieve a paginated list of all Networks on a site.\n\n<details>\n<summary>Filterable properties (click to expand)</summary>\n\n|Name|Type|Allowed functions|\n|-|-|-|\n|`management`|`STRING`|`eq` `ne` `in` `notIn`|\n|`id`|`UUID`|`eq` `ne` `in` `notIn`|\n|`name`|`STRING`|`eq` `ne` `in` `notIn` `like`|\n|`enabled`|`BOOLEAN`|`eq` `ne`|\n|`vlanId`|`INTEGER`|`eq` `ne` `gt` `ge` `lt` `le` `in` `notIn`|\n|`deviceId`|`UUID`|`eq` `ne` `in` `notIn` `isNull` `isNotNull`|\n|`metadata.origin`|`STRING`|`eq` `ne` `in` `notIn`|\n</details>", "operationId": "getNetworksOverviewPage", "parameters": [{"name": "offset", "in": "query", "required": false, "schema": {"format": "int32", "default": 0, "minimum": 0}}, {"name": "limit", "in": "query", "required": false, "schema": {"format": "int32", "default": 25, "maximum": 200, "minimum": 0}}, {"name": "filter", "in": "query", "required": false, "schema": {"type": "string"}}, {"name": "siteId", "in": "path", "required": true, "schema": {"type": "string", "format": "uuid"}}], "responses": {"200": {"description": "OK", "content": {"application/json": {"schema": {"properties": {"offset": {"type": "integer", "format": "int64", "example": 0}, "limit": {"type": "integer", "format": "int32", "example": 25}, "count": {"type": "integer", "format": "int32", "example": 10}, "totalCount": {"type": "integer", "format": "int64", "example": 1000}, "data": {"type": "array", "items": {"discriminator": {"propertyName": "management", "mapping": {"UNMANAGED": "#/components/schemas/Unmanaged network overview", "GATEWAY": "#/components/schemas/Gateway managed network overview", "SWITCH": "#/components/schemas/Switch managed network overview"}}, "properties": {"management": {"type": "string"}, "id": {"type": "string", "format": "uuid"}, "name": {"type": "string", "example": "Default Network"}, "enabled": {"type": "boolean"}, "vlanId": {"type": "integer", "format": "int32", "minimum": 2}, "metadata": {"description": "Orchestrated or System-defined configurable network support", "discriminator": {"propertyName": "origin", "mapping": {"USER_DEFINED": "#/components/schemas/User defined entity metadata", "SYSTEM_DEFINED": "#/components/schemas/System defined entity metadata", "ORCHESTRATED": "#/components/schemas/Orchestrated entity metadata"}}, "properties": {"origin": {"type": "string"}}, "required": ["origin"], "title": "User or system defined or orchestrated entity metadata"}}, "required": ["enabled", "id", "management", "metadata", "name", "vlanId"], "title": "Network overview"}}}, "required": ["count", "data", "limit", "offset", "totalCount"], "title": "Network overview page"}}}}}}, "post": {"tags": ["Networks"], "summary": "Create Network", "description": "Create a new network on a site.", "operationId": "createNetwork", "parameters": [{"name": "siteId", "in": "path", "required": true, "schema": {"type": "string", "format": "uuid"}}], "requestBody": {"content": {"application/json": {"schema": {"discriminator": {"propertyName": "management", "mapping": {"UNMANAGED": "#/components/schemas/IntegrationUnmanagedNetworkCreateUpdateDto", "GATEWAY": "#/components/schemas/IntegrationGatewayManagedNetworkCreateUpdateDto", "SWITCH": "#/components/schemas/IntegrationSwitchManagedNetworkCreateUpdateDto"}}, "properties": {"management": {"type": "string"}, "name": {"type": "string", "example": "Default Network"}, "enabled": {"type": "boolean"}, "vlanId": {"type": "integer", "format": "int32", "maximum": 4000, "minimum": 2}, "dhcpGuarding": {"description": "DHCP Guarding settings for this Network. If this field is omitted or null, the feature is disabled", "properties": {"trustedDhcpServerIpAddresses": {"type": "array", "description": "List of trusted DHCP server IP addresses.", "items": {"type": "string"}, "minItems": 1}}, "required": ["trustedDhcpServerIpAddresses"], "title": "Network DHCP Guarding"}}, "required": ["enabled", "management", "name", "vlanId"], "title": "Create or update Network"}}}, "required": true}, "responses": {"201": {"description": "Created", "content": {"application/json": {"schema": {"discriminator": {"propertyName": "management", "mapping": {"UNMANAGED": "#/components/schemas/Unmanaged network details", "GATEWAY": "#/components/schemas/Gateway managed network details", "SWITCH": "#/components/schemas/Switch managed network details"}}, "properties": {"management": {"type": "string"}, "id": {"type": "string", "format": "uuid"}, "name": {"type": "string", "example": "Default Network"}, "enabled": {"type": "boolean"}, "vlanId": {"type": "integer", "format": "int32", "minimum": 2}, "metadata": {"description": "Orchestrated or System-defined configurable network support", "discriminator": {"propertyName": "origin", "mapping": {"USER_DEFINED": "#/components/schemas/User defined entity metadata", "SYSTEM_DEFINED": "#/components/schemas/System defined entity metadata", "ORCHESTRATED": "#/components/schemas/Orchestrated entity metadata"}}, "properties": {"origin": {"type": "string"}}, "required": ["origin"], "title": "User or system defined or orchestrated entity metadata"}, "dhcpGuarding": {"description": "DHCP Guarding settings for this Network. If this field is omitted or null, the feature is disabled", "properties": {"trustedDhcpServerIpAddresses": {"type": "array", "description": "List of trusted DHCP server IP addresses.", "items": {"type": "string"}, "minItems": 1}}, "required": ["trustedDhcpServerIpAddresses"], "title": "Network DHCP Guarding"}}, "required": ["enabled", "id", "management", "metadata", "name", "vlanId"], "title": "Network details"}}}}}}}, "/v1/sites/{siteId}/hotspot/vouchers": {"get": {"tags": ["Hotspot"], "summary": "List Vouchers", "description": "Retrieve a paginated list of Hotspot vouchers.\n\n<details>\n<summary>Filterable properties (click to expand)</summary>\n\n|Name|Type|Allowed functions|\n|-|-|-|\n|`id`|`UUID`|`eq` `ne` `in` `notIn`|\n|`createdAt`|`TIMESTAMP`|`eq` `ne` `gt` `ge` `lt` `le`|\n|`name`|`STRING`|`eq` `ne` `in` `notIn` `like`|\n|`code`|`STRING`|`eq` `ne` `in` `notIn`|\n|`authorizedGuestLimit`|`INTEGER`|`isNull` `isNotNull` `eq` `ne` `gt` `ge` `lt` `le`|\n|`authorizedGuestCount`|`INTEGER`|`eq` `ne` `gt` `ge` `lt` `le`|\n|`activatedAt`|`TIMESTAMP`|`eq` `ne` `gt` `ge` `lt` `le`|\n|`expiresAt`|`TIMESTAMP`|`eq` `ne` `gt` `ge` `lt` `le`|\n|`expired`|`BOOLEAN`|`eq` `ne`|\n|`timeLimitMinutes`|`INTEGER`|`eq` `ne` `gt` `ge` `lt` `le`|\n|`dataUsageLimitMBytes`|`INTEGER`|`isNull` `isNotNull` `eq` `ne` `gt` `ge` `lt` `le`|\n|`rxRateLimitKbps`|`INTEGER`|`isNull` `isNotNull` `eq` `ne` `gt` `ge` `lt` `le`|\n|`txRateLimitKbps`|`INTEGER`|`isNull` `isNotNull` `eq` `ne` `gt` `ge` `lt` `le`|\n</details>", "operationId": "getVouchers", "parameters": [{"name": "offset", "in": "query", "required": false, "schema": {"format": "int32", "default": 0, "minimum": 0}}, {"name": "limit", "in": "query", "required": false, "schema": {"format": "int32", "default": 100, "maximum": 1000, "minimum": 0}}, {"name": "filter", "in": "query", "required": false, "schema": {"type": "string"}}, {"name": "siteId", "in": "path", "required": true, "schema": {"type": "string", "format": "uuid"}}], "responses": {"200": {"description": "OK", "content": {"application/json": {"schema": {"properties": {"offset": {"type": "integer", "format": "int64", "example": 0}, "limit": {"type": "integer", "format": "int32", "example": 25}, "count": {"type": "integer", "format": "int32", "example": 10}, "totalCount": {"type": "integer", "format": "int64", "example": 1000}, "data": {"type": "array", "items": {"properties": {"id": {"type": "string", "format": "uuid"}, "createdAt": {"type": "string", "format": "date-time"}, "name": {"type": "string", "description": "Voucher note, may contain duplicate values across multiple vouchers", "example": "hotel-guest"}, "code": {"type": "string", "description": "Secret code to active the voucher using the Hotspot portal", "example": 4861409510}, "authorizedGuestLimit": {"type": "integer", "format": "int64", "description": "(Optional) limit for how many different guests can use the same voucher to authorize network access", "example": 1}, "authorizedGuestCount": {"type": "integer", "format": "int64", "description": "For how many guests the voucher has been used to authorize network access", "example": 0}, "activatedAt": {"type": "string", "format": "date-time", "description": "(Optional) timestamp when the voucher has been activated (authorization time of the first guest)"}, "expiresAt": {"type": "string", "format": "date-time", "description": "(Optional) timestamp when the voucher will become expired. All guests using the voucher will be unauthorized from network access"}, "expired": {"type": "boolean", "description": "Whether the voucher has been expired and can no longer be used to authorize network access"}, "timeLimitMinutes": {"type": "integer", "format": "int64", "description": "How long (in minutes) the voucher will provide access to the network since authorization of the first guest.\nSubsequently connected guests, if allowed, will share the same expiration time.", "example": 1440}, "dataUsageLimitMBytes": {"type": "integer", "format": "int64", "description": "(Optional) data usage limit in megabytes", "example": 1024}, "rxRateLimitKbps": {"type": "integer", "format": "int64", "description": "(Optional) download rate limit in kilobits per second", "example": 1000}, "txRateLimitKbps": {"type": "integer", "format": "int64", "description": "(Optional) upload rate limit in kilobits per second", "example": 1000}}, "required": ["authorizedGuestCount", "code", "createdAt", "expired", "id", "name", "timeLimitMinutes"], "title": "Hotspot voucher details"}}}, "required": ["count", "data", "limit", "offset", "totalCount"], "title": "Hotspot voucher detail page"}}}}}}, "post": {"tags": ["Hotspot"], "summary": "Generate Vouchers", "description": "Create one or more Hotspot vouchers.", "operationId": "createVouchers", "parameters": [{"name": "siteId", "in": "path", "required": true, "schema": {"type": "string", "format": "uuid"}}], "requestBody": {"content": {"application/json": {"schema": {"properties": {"count": {"type": "integer", "format": "int32", "default": "1", "description": "Number of vouchers to generate", "maximum": 1000, "minimum": 1}, "name": {"type": "string", "description": "Voucher note, duplicated across all generated vouchers"}, "authorizedGuestLimit": {"type": "integer", "format": "int64", "description": "(Optional) limit for how many different guests can use the same voucher to authorize network access", "example": 1, "minimum": 1}, "timeLimitMinutes": {"type": "integer", "format": "int64", "description": "How long (in minutes) the voucher will provide access to the network since authorization of the first guest.\nSubsequently connected guests, if allowed, will share the same expiration time.", "maximum": 1000000, "minimum": 1}, "dataUsageLimitMBytes": {"type": "integer", "format": "int64", "description": "(Optional) data usage limit in megabytes", "maximum": 1048576, "minimum": 1}, "rxRateLimitKbps": {"type": "integer", "format": "int64", "description": "(Optional) download rate limit in kilobits per second", "maximum": 100000, "minimum": 2}, "txRateLimitKbps": {"type": "integer", "format": "int64", "description": "(Optional) upload rate limit in kilobits per second", "maximum": 100000, "minimum": 2}}, "required": ["name", "timeLimitMinutes"], "title": "Hotspot voucher creation request"}}}, "required": true}, "responses": {"201": {"description": "Created", "content": {"application/json": {"schema": {"properties": {"vouchers": {"type": "array", "items": {"properties": {"id": {"type": "string", "format": "uuid"}, "createdAt": {"type": "string", "format": "date-time"}, "name": {"type": "string", "description": "Voucher note, may contain duplicate values across multiple vouchers", "example": "hotel-guest"}, "code": {"type": "string", "description": "Secret code to active the voucher using the Hotspot portal", "example": 4861409510}, "authorizedGuestLimit": {"type": "integer", "format": "int64", "description": "(Optional) limit for how many different guests can use the same voucher to authorize network access", "example": 1}, "authorizedGuestCount": {"type": "integer", "format": "int64", "description": "For how many guests the voucher has been used to authorize network access", "example": 0}, "activatedAt": {"type": "string", "format": "date-time", "description": "(Optional) timestamp when the voucher has been activated (authorization time of the first guest)"}, "expiresAt": {"type": "string", "format": "date-time", "description": "(Optional) timestamp when the voucher will become expired. All guests using the voucher will be unauthorized from network access"}, "expired": {"type": "boolean", "description": "Whether the voucher has been expired and can no longer be used to authorize network access"}, "timeLimitMinutes": {"type": "integer", "format": "int64", "description": "How long (in minutes) the voucher will provide access to the network since authorization of the first guest.\nSubsequently connected guests, if allowed, will share the same expiration time.", "example": 1440}, "dataUsageLimitMBytes": {"type": "integer", "format": "int64", "description": "(Optional) data usage limit in megabytes", "example": 1024}, "rxRateLimitKbps": {"type": "integer", "format": "int64", "description": "(Optional) download rate limit in kilobits per second", "example": 1000}, "txRateLimitKbps": {"type": "integer", "format": "int64", "description": "(Optional) upload rate limit in kilobits per second", "example": 1000}}, "required": ["authorizedGuestCount", "code", "createdAt", "expired", "id", "name", "timeLimitMinutes"], "title": "Hotspot voucher details"}}}, "title": "IntegrationVoucherCreationResultDto"}}}}}}, "delete": {"tags": ["Hotspot"], "summary": "Delete Vouchers", "description": "Remove Hotspot vouchers based on the specified filter criteria.\n\n<details>\n<summary>Filterable properties (click to expand)</summary>\n\n|Name|Type|Allowed functions|\n|-|-|-|\n|`id`|`UUID`|`eq` `ne` `in` `notIn`|\n|`createdAt`|`TIMESTAMP`|`eq` `ne` `gt` `ge` `lt` `le`|\n|`name`|`STRING`|`eq` `ne` `in` `notIn` `like`|\n|`code`|`STRING`|`eq` `ne` `in` `notIn`|\n|`authorizedGuestLimit`|`INTEGER`|`isNull` `isNotNull` `eq` `ne` `gt` `ge` `lt` `le`|\n|`authorizedGuestCount`|`INTEGER`|`eq` `ne` `gt` `ge` `lt` `le`|\n|`activatedAt`|`TIMESTAMP`|`eq` `ne` `gt` `ge` `lt` `le`|\n|`expiresAt`|`TIMESTAMP`|`eq` `ne` `gt` `ge` `lt` `le`|\n|`expired`|`BOOLEAN`|`eq` `ne`|\n|`timeLimitMinutes`|`INTEGER`|`eq` `ne` `gt` `ge` `lt` `le`|\n|`dataUsageLimitMBytes`|`INTEGER`|`isNull` `isNotNull` `eq` `ne` `gt` `ge` `lt` `le`|\n|`rxRateLimitKbps`|`INTEGER`|`isNull` `isNotNull` `eq` `ne` `gt` `ge` `lt` `le`|\n|`txRateLimitKbps`|`INTEGER`|`isNull` `isNotNull` `eq` `ne` `gt` `ge` `lt` `le`|\n</details>", "operationId": "deleteVouchers", "parameters": [{"name": "filter", "in": "query", "required": true, "schema": {"type": "string"}}, {"name": "siteId", "in": "path", "required": true, "schema": {"type": "string", "format": "uuid"}}], "responses": {"200": {"description": "OK", "content": {"application/json": {"schema": {"properties": {"vouchersDeleted": {"type": "integer", "format": "int64"}}, "title": "Voucher deletion results"}}}}}}}, "/v1/sites/{siteId}/firewall/zones": {"get": {"tags": ["Firewall"], "summary": "List Firewall Zones", "description": "Retrieve a list of all firewall zones on a site.\n\n<details>\n<summary>Filterable properties (click to expand)</summary>\n\n|Name|Type|Allowed functions|\n|-|-|-|\n|`id`|`UUID`|`eq` `ne` `in` `notIn`|\n|`name`|`STRING`|`eq` `ne` `in` `notIn` `like`|\n|`metadata.origin`|`STRING`|`eq` `ne` `in` `notIn`|\n|`metadata.configurable`|`BOOLEAN`|`eq` `ne` `isNull` `isNotNull`|\n</details>", "operationId": "getFirewallZones", "parameters": [{"name": "offset", "in": "query", "required": false, "schema": {"format": "int32", "default": 0, "minimum": 0}}, {"name": "limit", "in": "query", "required": false, "schema": {"format": "int32", "default": 25, "maximum": 200, "minimum": 0}}, {"name": "filter", "in": "query", "required": false, "schema": {"type": "string"}}, {"name": "siteId", "in": "path", "required": true, "schema": {"type": "string", "format": "uuid"}}], "responses": {"200": {"description": "OK", "content": {"application/json": {"schema": {"properties": {"offset": {"type": "integer", "format": "int64", "example": 0}, "limit": {"type": "integer", "format": "int32", "example": 25}, "count": {"type": "integer", "format": "int32", "example": 10}, "totalCount": {"type": "integer", "format": "int64", "example": 1000}, "data": {"type": "array", "items": {"properties": {"id": {"type": "string", "format": "uuid", "example": "ffcdb32c-6278-4364-8947-df4f77118df8"}, "name": {"type": "string", "description": "Name of a firewall zone", "example": "Hotspot|My custom zone"}, "networkIds": {"type": "array", "description": "List of Network IDs", "items": {"example": "dfb21062-8ea0-4dca-b1d8-1eb3da00e58b"}, "minItems": 0}, "metadata": {"description": "System-defined configurable zones support configuring only attached networks", "discriminator": {"propertyName": "origin", "mapping": {"USER_DEFINED": "#/components/schemas/User defined entity metadata", "SYSTEM_DEFINED": "#/components/schemas/System defined entity metadata"}}, "properties": {"origin": {"type": "string"}}, "required": ["origin"], "title": "User or system defined entity metadata"}}, "required": ["id", "metadata", "name", "networkIds"], "title": "Firewall zone"}}}, "required": ["count", "data", "limit", "offset", "totalCount"], "title": "Firewall zones page"}}}}}}, "post": {"tags": ["Firewall"], "summary": "Create Custom Firewall Zone", "description": "Create a new custom firewall zone on a site.", "operationId": "createFirewallZone", "parameters": [{"name": "siteId", "in": "path", "required": true, "schema": {"type": "string", "format": "uuid"}}], "requestBody": {"content": {"application/json": {"schema": {"properties": {"name": {"type": "string", "description": "Name of a firewall zone", "example": "Hotspot|My custom zone"}, "networkIds": {"type": "array", "description": "List of Network IDs", "items": {"example": "dfb21062-8ea0-4dca-b1d8-1eb3da00e58b"}, "minItems": 0}}, "required": ["name", "networkIds"], "title": "Create or update firewall zone"}}}, "required": true}, "responses": {"201": {"description": "Created", "content": {"application/json": {"schema": {"properties": {"id": {"type": "string", "format": "uuid", "example": "ffcdb32c-6278-4364-8947-df4f77118df8"}, "name": {"type": "string", "description": "Name of a firewall zone", "example": "Hotspot|My custom zone"}, "networkIds": {"type": "array", "description": "List of Network IDs", "items": {"example": "dfb21062-8ea0-4dca-b1d8-1eb3da00e58b"}, "minItems": 0}, "metadata": {"description": "System-defined configurable zones support configuring only attached networks", "discriminator": {"propertyName": "origin", "mapping": {"USER_DEFINED": "#/components/schemas/User defined entity metadata", "SYSTEM_DEFINED": "#/components/schemas/System defined entity metadata"}}, "properties": {"origin": {"type": "string"}}, "required": ["origin"], "title": "User or system defined entity metadata"}}, "required": ["id", "metadata", "name", "networkIds"], "title": "Firewall zone"}}}}}}}, "/v1/sites/{siteId}/devices/{deviceId}/interfaces/ports/{portIdx}/actions": {"post": {"tags": ["UniFi Devices"], "summary": "Execute Port Action", "description": "Perform an action on a specific device port. The request body must include the action name and any applicable input arguments.", "operationId": "executePortAction", "parameters": [{"name": "portIdx", "in": "path", "required": true, "schema": {"type": "integer", "format": "int32"}}, {"name": "siteId", "in": "path", "required": true, "schema": {"type": "string", "format": "uuid"}}, {"name": "deviceId", "in": "path", "required": true, "schema": {"type": "string", "format": "uuid"}}], "requestBody": {"content": {"application/json": {"schema": {"discriminator": {"propertyName": "action", "mapping": {"POWER_CYCLE": "#/components/schemas/Port PoE power-cycle request"}}, "properties": {"action": {"type": "string"}}, "required": ["action"], "title": "Port action request"}}}, "required": true}, "responses": {"200": {"description": "OK"}}}}, "/v1/sites/{siteId}/devices/{deviceId}/actions": {"post": {"tags": ["UniFi Devices"], "summary": "Execute Adopted Device Action", "description": "Perform an action on an specific adopted device. The request body must include the action name and any applicable input arguments.", "operationId": "executeAdoptedDeviceAction", "parameters": [{"name": "siteId", "in": "path", "required": true, "schema": {"type": "string", "format": "uuid"}}, {"name": "deviceId", "in": "path", "required": true, "schema": {"type": "string", "format": "uuid"}}], "requestBody": {"content": {"application/json": {"schema": {"discriminator": {"propertyName": "action", "mapping": {"RESTART": "#/components/schemas/Device restart request"}}, "properties": {"action": {"type": "string"}}, "required": ["action"], "title": "Device action request"}}}, "required": true}, "responses": {"200": {"description": "OK"}}}}, "/v1/sites/{siteId}/clients/{clientId}/actions": {"post": {"tags": ["Clients"], "summary": "Execute Client Action", "description": "Perform an action on a specific connected client. The request body must include the action name and any applicable input arguments.", "operationId": "executeConnectedClientAction", "parameters": [{"name": "clientId", "in": "path", "required": true, "schema": {"type": "string", "format": "uuid"}}, {"name": "siteId", "in": "path", "required": true, "schema": {"type": "string", "format": "uuid"}}], "requestBody": {"content": {"application/json": {"schema": {"discriminator": {"propertyName": "action", "mapping": {"AUTHORIZE_GUEST_ACCESS": "#/components/schemas/Guest access authorization request", "UNAUTHORIZE_GUEST_ACCESS": "#/components/schemas/Guest access unauthorization request"}}, "properties": {"action": {"type": "string"}}, "required": ["action"], "title": "Client action request"}}}, "required": true}, "responses": {"200": {"description": "OK", "content": {"application/json": {"schema": {"discriminator": {"propertyName": "action", "mapping": {"AUTHORIZE_GUEST_ACCESS": "#/components/schemas/Guest access authorization response", "UNAUTHORIZE_GUEST_ACCESS": "#/components/schemas/Guest access unauthorization response"}}, "properties": {"action": {"type": "string"}}, "required": ["action"], "title": "Client action response"}}}}}}}, "/v1/sites/{siteId}/acl-rules": {"get": {"tags": ["Access Control (ACL Rules)"], "summary": "List ACL Rules", "description": "$1e", "operationId": "getAclRulePage", "parameters": [{"name": "offset", "in": "query", "required": false, "schema": {"format": "int32", "default": 0, "minimum": 0}}, {"name": "limit", "in": "query", "required": false, "schema": {"format": "int32", "default": 25, "maximum": 200, "minimum": 0}}, {"name": "filter", "in": "query", "required": false, "schema": {"type": "string"}}, {"name": "siteId", "in": "path", "required": true, "schema": {"type": "string", "format": "uuid"}}], "responses": {"200": {"description": "OK", "content": {"application/json": {"schema": {"properties": {"offset": {"type": "integer", "format": "int64", "example": 0}, "limit": {"type": "integer", "format": "int32", "example": 25}, "count": {"type": "integer", "format": "int32", "example": 10}, "totalCount": {"type": "integer", "format": "int64", "example": 1000}, "data": {"type": "array", "items": {"discriminator": {"propertyName": "type", "mapping": {"IPV4": "#/components/schemas/IntegrationIpAclRuleDto", "MAC": "#/components/schemas/IntegrationMacAclRuleDto"}}, "properties": {"type": {"type": "string"}, "id": {"type": "string", "format": "uuid"}, "enabled": {"type": "boolean", "example": true}, "name": {"type": "string", "description": "ACL rule name"}, "description": {"type": "string", "description": "ACL rule description"}, "action": {"type": "string", "description": "ACL rule action", "enum": ["ALLOW", "BLOCK"], "example": "ALLOW|BLOCK"}, "enforcingDeviceFilter": {"description": "IDs of the Switch-capable devices used to enforce the ACL rule. When null, the rule will be provisioned to all switches on the site.", "discriminator": {"propertyName": "type", "mapping": {"DEVICES": "#/components/schemas/IntegrationAclRuleDevicesFilterDto"}}, "properties": {"type": {"type": "string"}}, "required": ["type"], "title": "ACL rule device filter"}, "index": {"type": "integer", "format": "int32", "description": "ACL rule index. Lower index has higher priority", "minimum": 0}, "sourceFilter": {"description": "Traffic source filter"}, "destinationFilter": {"description": "Traffic destination filter"}, "metadata": {"description": "Only user-defined rules can be deleted or modified", "discriminator": {"propertyName": "origin", "mapping": {"USER_DEFINED": "#/components/schemas/User defined entity metadata", "SYSTEM_DEFINED": "#/components/schemas/System defined entity metadata", "DERIVED": "#/components/schemas/Derived entity metadata", "ORCHESTRATED": "#/components/schemas/Orchestrated entity metadata"}}, "properties": {"origin": {"type": "string"}}, "required": ["origin"], "title": "Entity metadata"}}, "required": ["action", "enabled", "id", "index", "metadata", "name", "type"], "title": "ACL ruleObject"}}}, "required": ["count", "data", "limit", "offset", "totalCount"], "title": "IntegrationAclRulePageDto"}}}}}}, "post": {"tags": ["Access Control (ACL Rules)"], "summary": "Create ACL Rule", "description": "Create a new user defined ACL rule", "operationId": "createAclRule", "parameters": [{"name": "siteId", "in": "path", "required": true, "schema": {"type": "string", "format": "uuid"}}], "requestBody": {"content": {"application/json": {"schema": {"discriminator": {"propertyName": "type", "mapping": {"IPV4": "#/components/schemas/IntegrationIpAclRuleCreateUpdateDto", "MAC": "#/components/schemas/IntegrationMacAclRuleCreateUpdateDto"}}, "properties": {"type": {"type": "string"}, "enabled": {"type": "boolean", "example": true}, "name": {"type": "string", "description": "ACL rule name"}, "description": {"type": "string", "description": "ACL rule description"}, "action": {"type": "string", "description": "ACL rule action", "enum": ["ALLOW", "BLOCK"], "example": "ALLOW|BLOCK"}, "enforcingDeviceFilter": {"description": "IDs of the Switch-capable devices used to enforce the ACL rule. When null, the rule will be provisioned to all switches on the site.", "discriminator": {"propertyName": "type", "mapping": {"DEVICES": "#/components/schemas/IntegrationAclRuleDevicesFilterDto"}}, "properties": {"type": {"type": "string"}}, "required": ["type"], "title": "ACL rule device filter"}, "index": {"type": "integer", "format": "int32", "description": "ACL rule index. Lower index has higher priority", "minimum": 0}, "sourceFilter": {"description": "Traffic source filter"}, "destinationFilter": {"description": "Traffic destination filter"}}, "required": ["action", "enabled", "index", "name", "type"], "title": "ACL rule update"}}}, "required": true}, "responses": {"201": {"description": "Created", "content": {"application/json": {"schema": {"discriminator": {"propertyName": "type", "mapping": {"IPV4": "#/components/schemas/IntegrationIpAclRuleDto", "MAC": "#/components/schemas/IntegrationMacAclRuleDto"}}, "properties": {"type": {"type": "string"}, "id": {"type": "string", "format": "uuid"}, "enabled": {"type": "boolean", "example": true}, "name": {"type": "string", "description": "ACL rule name"}, "description": {"type": "string", "description": "ACL rule description"}, "action": {"type": "string", "description": "ACL rule action", "enum": ["ALLOW", "BLOCK"], "example": "ALLOW|BLOCK"}, "enforcingDeviceFilter": {"description": "IDs of the Switch-capable devices used to enforce the ACL rule. When null, the rule will be provisioned to all switches on the site.", "discriminator": {"propertyName": "type", "mapping": {"DEVICES": "#/components/schemas/IntegrationAclRuleDevicesFilterDto"}}, "properties": {"type": {"type": "string"}}, "required": ["type"], "title": "ACL rule device filter"}, "index": {"type": "integer", "format": "int32", "description": "ACL rule index. Lower index has higher priority", "minimum": 0}, "sourceFilter": {"description": "Traffic source filter"}, "destinationFilter": {"description": "Traffic destination filter"}, "metadata": {"description": "Only user-defined rules can be deleted or modified", "discriminator": {"propertyName": "origin", "mapping": {"USER_DEFINED": "#/components/schemas/User defined entity metadata", "SYSTEM_DEFINED": "#/components/schemas/System defined entity metadata", "DERIVED": "#/components/schemas/Derived entity metadata", "ORCHESTRATED": "#/components/schemas/Orchestrated entity metadata"}}, "properties": {"origin": {"type": "string"}}, "required": ["origin"], "title": "Entity metadata"}}, "required": ["action", "enabled", "id", "index", "metadata", "name", "type"], "title": "ACL rule"}}}}}}}, "/v1/sites": {"get": {"tags": ["Sites"], "summary": "List Local Sites", "description": "Retrieve a paginated list of local sites managed by this Network application.\nSite ID is required for other UniFi Network API calls.\n\n<details>\n<summary>Filterable properties (click to expand)</summary>\n\n|Name|Type|Allowed functions|\n|-|-|-|\n|`id`|`UUID`|`eq` `ne` `in` `notIn`|\n|`internalReference`|`STRING`|`eq` `ne` `in` `notIn`|\n|`name`|`STRING`|`eq` `ne` `in` `notIn`|\n</details>", "operationId": "getSiteOverviewPage", "parameters": [{"name": "offset", "in": "query", "required": false, "schema": {"format": "int32", "default": 0, "minimum": 0}}, {"name": "limit", "in": "query", "required": false, "schema": {"format": "int32", "default": 25, "maximum": 200, "minimum": 0}}, {"name": "filter", "in": "query", "required": false, "schema": {"type": "string"}}], "responses": {"200": {"description": "OK", "content": {"application/json": {"schema": {"properties": {"offset": {"type": "integer", "format": "int64", "example": 0}, "limit": {"type": "integer", "format": "int32", "example": 25}, "count": {"type": "integer", "format": "int32", "example": 10}, "totalCount": {"type": "integer", "format": "int64", "example": 1000}, "data": {"type": "array", "items": {"properties": {"id": {"type": "string", "format": "uuid"}, "internalReference": {"type": "string", "description": "Internal unique name of the site used in older APIs"}, "name": {"type": "string"}}, "required": ["id", "internalReference", "name"], "title": "Site overview"}}}, "required": ["count", "data", "limit", "offset", "totalCount"], "title": "Site overview page"}}}}}}}, "/v1/sites/{siteId}/wans": {"get": {"tags": ["Supporting Resources"], "summary": "List WAN Interfaces", "description": "Returns available WAN interface definitions for a given site,\nincluding identifiers and names. Useful for network and NAT configuration.", "operationId": "getWansOverviewPage", "parameters": [{"name": "offset", "in": "query", "required": false, "schema": {"format": "int32", "default": 0, "minimum": 0}}, {"name": "limit", "in": "query", "required": false, "schema": {"format": "int32", "default": 25, "maximum": 200, "minimum": 0}}, {"name": "siteId", "in": "path", "required": true, "schema": {"type": "string", "format": "uuid"}}], "responses": {"200": {"description": "OK", "content": {"application/json": {"schema": {"properties": {"offset": {"type": "integer", "format": "int64", "example": 0}, "limit": {"type": "integer", "format": "int32", "example": 25}, "count": {"type": "integer", "format": "int32", "example": 10}, "totalCount": {"type": "integer", "format": "int64", "example": 1000}, "data": {"type": "array", "items": {"properties": {"id": {"type": "string", "format": "uuid"}, "name": {"type": "string", "example": "Internet 1"}}, "required": ["id", "name"], "title": "WAN overview"}}}, "required": ["count", "data", "limit", "offset", "totalCount"], "title": "WAN overview page"}}}}}}}, "/v1/sites/{siteId}/vpn/site-to-site-tunnels": {"get": {"tags": ["Supporting Resources"], "summary": "List Site-To-Site VPN Tunnels", "description": "Retrieve a paginated list of all site-to-site VPN tunnels on a site.\n\n<details>\n<summary>Filterable properties (click to expand)</summary>\n\n|Name|Type|Allowed functions|\n|-|-|-|\n|`type`|`STRING`|`eq` `ne` `in` `notIn`|\n|`id`|`UUID`|`eq` `ne` `in` `notIn`|\n|`name`|`STRING`|`eq` `ne` `in` `notIn` `like`|\n|`metadata.origin`|`STRING`|`eq` `ne` `in` `notIn`|\n|`metadata.source`|`STRING`|`eq` `ne` `in` `notIn` `isNull` `isNotNull`|\n</details>", "operationId": "getSiteToSiteVpnTunnelPage", "parameters": [{"name": "offset", "in": "query", "required": false, "schema": {"format": "int32", "default": 0, "minimum": 0}}, {"name": "limit", "in": "query", "required": false, "schema": {"format": "int32", "default": 25, "maximum": 200, "minimum": 0}}, {"name": "filter", "in": "query", "required": false, "schema": {"type": "string"}}, {"name": "siteId", "in": "path", "required": true, "schema": {"type": "string", "format": "uuid"}}], "responses": {"200": {"description": "OK", "content": {"application/json": {"schema": {"properties": {"offset": {"type": "integer", "format": "int64", "example": 0}, "limit": {"type": "integer", "format": "int32", "example": 25}, "count": {"type": "integer", "format": "int32", "example": 10}, "totalCount": {"type": "integer", "format": "int64", "example": 1000}, "data": {"type": "array", "items": {"discriminator": {"propertyName": "type", "mapping": {"OPENVPN": "#/components/schemas/IntegrationSiteToSiteOpenVpnTunnelOverviewDto", "IPSEC": "#/components/schemas/IntegrationSiteToSiteIpsecTunnelOverviewDto", "WIREGUARD": "#/components/schemas/IntegrationSiteToSiteWireguardTunnelOverviewDto"}}, "properties": {"type": {"type": "string"}, "id": {"type": "string", "format": "uuid"}, "name": {"type": "string"}, "metadata": {"discriminator": {"propertyName": "origin", "mapping": {"USER_DEFINED": "#/components/schemas/User defined entity metadata", "DERIVED": "#/components/schemas/IntegrationDerivedSiteToSiteTunnelMetadata"}}, "properties": {"origin": {"type": "string"}}, "required": ["origin"], "title": "Site-to-site VPN tunnel metadata"}}, "required": ["id", "metadata", "name", "type"], "title": "Site-to-site VPN tunnel overview"}}}, "required": ["count", "data", "limit", "offset", "totalCount"], "title": "IntegrationSiteToSiteVpnTunnelOverviewPageDto"}}}}}}}, "/v1/sites/{siteId}/vpn/servers": {"get": {"tags": ["Supporting Resources"], "summary": "List VPN Servers", "description": "Retrieve a paginated list of all VPN servers on a site.\n\n<details>\n<summary>Filterable properties (click to expand)</summary>\n\n|Name|Type|Allowed functions|\n|-|-|-|\n|`type`|`STRING`|`eq` `ne` `in` `notIn`|\n|`id`|`UUID`|`eq` `ne` `in` `notIn`|\n|`name`|`STRING`|`eq` `ne` `in` `notIn` `like`|\n|`enabled`|`BOOLEAN`|`eq` `ne`|\n|`metadata.origin`|`STRING`|`eq` `ne` `in` `notIn`|\n</details>", "operationId": "getVpnServerPage", "parameters": [{"name": "offset", "in": "query", "required": false, "schema": {"format": "int32", "default": 0, "minimum": 0}}, {"name": "limit", "in": "query", "required": false, "schema": {"format": "int32", "default": 25, "maximum": 200, "minimum": 0}}, {"name": "filter", "in": "query", "required": false, "schema": {"type": "string"}}, {"name": "siteId", "in": "path", "required": true, "schema": {"type": "string", "format": "uuid"}}], "responses": {"200": {"description": "OK", "content": {"application/json": {"schema": {"properties": {"offset": {"type": "integer", "format": "int64", "example": 0}, "limit": {"type": "integer", "format": "int32", "example": 25}, "count": {"type": "integer", "format": "int32", "example": 10}, "totalCount": {"type": "integer", "format": "int64", "example": 1000}, "data": {"type": "array", "items": {"discriminator": {"propertyName": "type", "mapping": {"OPENVPN": "#/components/schemas/IntegrationOpenVpnServerOverviewDto", "WIREGUARD": "#/components/schemas/IntegrationWireguardServerOverviewDto", "L2TP": "#/components/schemas/IntegrationL2tpServerOverviewDto", "PPTP": "#/components/schemas/IntegrationPptpServerOverviewDto", "UID": "#/components/schemas/IntegrationUidVpnServerOverviewDto"}}, "properties": {"type": {"type": "string"}, "id": {"type": "string", "format": "uuid"}, "name": {"type": "string"}, "enabled": {"type": "boolean"}, "metadata": {"discriminator": {"propertyName": "origin", "mapping": {"USER_DEFINED": "#/components/schemas/User defined entity metadata", "DERIVED": "#/components/schemas/Derived entity metadata"}}, "properties": {"origin": {"type": "string"}}, "required": ["origin"], "title": "User defined or derived entity metadata"}}, "required": ["enabled", "id", "metadata", "name", "type"], "title": "VPN server overview"}}}, "required": ["count", "data", "limit", "offset", "totalCount"], "title": "IntegrationVpnServerOverviewPageDto"}}}}}}}, "/v1/sites/{siteId}/radius/profiles": {"get": {"tags": ["Supporting Resources"], "summary": "List Radius Profiles", "description": "Returns available RADIUS authentication profiles, including configuration origin metadata.\n\n<details>\n<summary>Filterable properties (click to expand)</summary>\n\n|Name|Type|Allowed functions|\n|-|-|-|\n|`id`|`UUID`|`eq` `ne` `in` `notIn`|\n|`name`|`STRING`|`eq` `ne` `in` `notIn` `like`|\n|`metadata.origin`|`STRING`|`eq` `ne` `in` `notIn`|\n</details>", "operationId": "getRadiusProfileOverviewPage", "parameters": [{"name": "offset", "in": "query", "required": false, "schema": {"format": "int32", "default": 0, "minimum": 0}}, {"name": "limit", "in": "query", "required": false, "schema": {"format": "int32", "default": 25, "maximum": 200, "minimum": 0}}, {"name": "filter", "in": "query", "required": false, "schema": {"type": "string"}}, {"name": "siteId", "in": "path", "required": true, "schema": {"type": "string", "format": "uuid"}}], "responses": {"200": {"description": "OK", "content": {"application/json": {"schema": {"properties": {"offset": {"type": "integer", "format": "int64", "example": 0}, "limit": {"type": "integer", "format": "int32", "example": 25}, "count": {"type": "integer", "format": "int32", "example": 10}, "totalCount": {"type": "integer", "format": "int64", "example": 1000}, "data": {"type": "array", "items": {"properties": {"id": {"type": "string", "format": "uuid"}, "name": {"type": "string"}, "metadata": {"discriminator": {"propertyName": "origin", "mapping": {"USER_DEFINED": "#/components/schemas/User defined entity metadata", "SYSTEM_DEFINED": "#/components/schemas/System defined entity metadata", "DERIVED": "#/components/schemas/Derived entity metadata"}}, "properties": {"origin": {"type": "string"}}, "required": ["origin"], "title": "User or system defined or derived entity metadata"}}, "required": ["id", "metadata", "name"], "title": "Radius Profile Overview"}}}, "required": ["count", "data", "limit", "offset", "totalCount"], "title": "Radius Profile Overview Page"}}}}}}}, "/v1/sites/{siteId}/networks/{networkId}/references": {"get": {"tags": ["Networks"], "summary": "Get Network References", "description": "Retrieve references to a specific network.", "operationId": "getNetworkReferences", "parameters": [{"name": "networkId", "in": "path", "required": true, "schema": {"type": "string", "format": "uuid"}}, {"name": "siteId", "in": "path", "required": true, "schema": {"type": "string", "format": "uuid"}}], "responses": {"200": {"description": "OK", "content": {"application/json": {"schema": {"properties": {"referenceResources": {"type": "array", "description": "List of network reference resources", "items": {"properties": {"resourceType": {"type": "string", "enum": ["CLIENT", "DEVICE", "STATIC_ROUTE", "OSPF_ROUTE", "NEXT_AI", "WIFI", "NAT_RULE", "SD_WAN"]}, "referenceCount": {"type": "integer", "format": "int32", "description": "Number of references of this type", "minimum": 1}, "references": {"type": "array", "description": "List of references, present only if resourceType has API model defined", "items": {"properties": {"referenceId": {"type": "string", "format": "uuid"}}, "required": ["referenceId"], "title": "Network reference detail"}}}, "required": ["referenceCount", "resourceType"], "title": "Network reference resource"}}}, "required": ["referenceResources"], "title": "Network references"}}}}}}}, "/v1/sites/{siteId}/hotspot/vouchers/{voucherId}": {"get": {"tags": ["Hotspot"], "summary": "Get Voucher Details", "description": "Retrieve details of a specific Hotspot voucher.", "operationId": "getVoucher", "parameters": [{"name": "voucherId", "in": "path", "required": true, "schema": {"type": "string", "format": "uuid"}}, {"name": "siteId", "in": "path", "required": true, "schema": {"type": "string", "format": "uuid"}}], "responses": {"200": {"description": "OK", "content": {"application/json": {"schema": {"properties": {"id": {"type": "string", "format": "uuid"}, "createdAt": {"type": "string", "format": "date-time"}, "name": {"type": "string", "description": "Voucher note, may contain duplicate values across multiple vouchers", "example": "hotel-guest"}, "code": {"type": "string", "description": "Secret code to active the voucher using the Hotspot portal", "example": 4861409510}, "authorizedGuestLimit": {"type": "integer", "format": "int64", "description": "(Optional) limit for how many different guests can use the same voucher to authorize network access", "example": 1}, "authorizedGuestCount": {"type": "integer", "format": "int64", "description": "For how many guests the voucher has been used to authorize network access", "example": 0}, "activatedAt": {"type": "string", "format": "date-time", "description": "(Optional) timestamp when the voucher has been activated (authorization time of the first guest)"}, "expiresAt": {"type": "string", "format": "date-time", "description": "(Optional) timestamp when the voucher will become expired. All guests using the voucher will be unauthorized from network access"}, "expired": {"type": "boolean", "description": "Whether the voucher has been expired and can no longer be used to authorize network access"}, "timeLimitMinutes": {"type": "integer", "format": "int64", "description": "How long (in minutes) the voucher will provide access to the network since authorization of the first guest.\nSubsequently connected guests, if allowed, will share the same expiration time.", "example": 1440}, "dataUsageLimitMBytes": {"type": "integer", "format": "int64", "description": "(Optional) data usage limit in megabytes", "example": 1024}, "rxRateLimitKbps": {"type": "integer", "format": "int64", "description": "(Optional) download rate limit in kilobits per second", "example": 1000}, "txRateLimitKbps": {"type": "integer", "format": "int64", "description": "(Optional) upload rate limit in kilobits per second", "example": 1000}}, "required": ["authorizedGuestCount", "code", "createdAt", "expired", "id", "name", "timeLimitMinutes"], "title": "Hotspot voucher details"}}}}}}, "delete": {"tags": ["Hotspot"], "summary": "Delete Voucher", "description": "Remove a specific Hotspot voucher.", "operationId": "deleteVoucher", "parameters": [{"name": "voucherId", "in": "path", "required": true, "schema": {"type": "string", "format": "uuid"}}, {"name": "siteId", "in": "path", "required": true, "schema": {"type": "string", "format": "uuid"}}], "responses": {"200": {"description": "OK", "content": {"application/json": {"schema": {"properties": {"vouchersDeleted": {"type": "integer", "format": "int64"}}, "title": "Voucher deletion results"}}}}}}}, "/v1/sites/{siteId}/devices": {"get": {"tags": ["UniFi Devices"], "summary": "List Adopted Devices", "description": "Retrieve a paginated list of all adopted devices on a site, including basic device information.\n\n<details>\n<summary>Filterable properties (click to expand)</summary>\n\n|Name|Type|Allowed functions|\n|-|-|-|\n|`id`|`UUID`|`eq` `ne` `in` `notIn`|\n|`macAddress`|`STRING`|`eq` `ne` `in` `notIn`|\n|`ipAddress`|`STRING`|`eq` `ne` `in` `notIn`|\n|`name`|`STRING`|`eq` `ne` `in` `notIn` `like`|\n|`model`|`STRING`|`eq` `ne` `in` `notIn`|\n|`state`|`STRING`|`eq` `ne` `in` `notIn`|\n|`supported`|`BOOLEAN`|`eq` `ne`|\n|`firmwareVersion`|`STRING`|`isNull` `isNotNull` `eq` `ne` `gt` `ge` `lt` `le` `like` `in` `notIn`|\n|`firmwareUpdatable`|`BOOLEAN`|`eq` `ne`|\n|`features`|`SET(STRING)`|`isEmpty` `contains` `containsAny` `containsAll` `containsExactly`|\n|`interfaces`|`SET(STRING)`|`isEmpty` `contains` `containsAny` `containsAll` `containsExactly`|\n</details>", "operationId": "getAdoptedDeviceOverviewPage", "parameters": [{"name": "offset", "in": "query", "required": false, "schema": {"format": "int32", "default": 0, "minimum": 0}}, {"name": "limit", "in": "query", "required": false, "schema": {"format": "int32", "default": 25, "maximum": 200, "minimum": 0}}, {"name": "filter", "in": "query", "required": false, "schema": {"type": "string"}}, {"name": "siteId", "in": "path", "required": true, "schema": {"type": "string", "format": "uuid"}}], "responses": {"200": {"description": "OK", "content": {"application/json": {"schema": {"properties": {"offset": {"type": "integer", "format": "int64", "example": 0}, "limit": {"type": "integer", "format": "int32", "example": 25}, "count": {"type": "integer", "format": "int32", "example": 10}, "totalCount": {"type": "integer", "format": "int64", "example": 1000}, "data": {"type": "array", "items": {"properties": {"id": {"type": "string", "format": "uuid"}, "macAddress": {"type": "string", "example": "94:2a:6f:26:c6:ca"}, "ipAddress": {"type": "string", "example": "192.168.1.55"}, "name": {"type": "string", "example": "IW HD"}, "model": {"type": "string", "example": "UHDIW"}, "state": {"type": "string", "enum": ["ONLINE", "OFFLINE", "PENDING_ADOPTION", "UPDATING", "GETTING_READY", "ADOPTING", "DELETING", "CONNECTION_INTERRUPTED", "ISOLATED", "U5G_INCORRECT_TOPOLOGY"]}, "supported": {"type": "boolean"}, "firmwareVersion": {"type": "string", "example": "6.6.55"}, "firmwareUpdatable": {"type": "boolean"}, "features": {"type": "array", "items": {"type": "string", "enum": ["switching", "accessPoint", "gateway"]}, "uniqueItems": true}, "interfaces": {"type": "array", "items": {"type": "string", "enum": ["ports", "radios"]}, "uniqueItems": true}}, "required": ["features", "firmwareUpdatable", "id", "interfaces", "ipAddress", "macAddress", "model", "name", "state", "supported"], "title": "Adopted device overview"}}}, "required": ["count", "data", "limit", "offset", "totalCount"], "title": "Adopted device overview page"}}}}}}}, "/v1/sites/{siteId}/devices/{deviceId}": {"get": {"tags": ["UniFi Devices"], "summary": "Get Adopted Device Details", "description": "Retrieve detailed information about a specific adopted device, including firmware versioning, uplink state, details about device features and interfaces (ports, radios) and other key attributes.", "operationId": "getAdoptedDeviceDetails", "parameters": [{"name": "siteId", "in": "path", "required": true, "schema": {"type": "string", "format": "uuid"}}, {"name": "deviceId", "in": "path", "required": true, "schema": {"type": "string", "format": "uuid"}}], "responses": {"200": {"description": "OK", "content": {"application/json": {"schema": {"properties": {"id": {"type": "string", "format": "uuid"}, "macAddress": {"type": "string", "example": "94:2a:6f:26:c6:ca"}, "ipAddress": {"type": "string", "example": "192.168.1.55"}, "name": {"type": "string", "example": "IW HD"}, "model": {"type": "string", "example": "UHDIW"}, "supported": {"type": "boolean"}, "state": {"type": "string", "enum": ["ONLINE", "OFFLINE", "PENDING_ADOPTION", "UPDATING", "GETTING_READY", "ADOPTING", "DELETING", "CONNECTION_INTERRUPTED", "ISOLATED", "U5G_INCORRECT_TOPOLOGY"]}, "firmwareVersion": {"type": "string", "example": "6.6.55"}, "firmwareUpdatable": {"type": "boolean"}, "adoptedAt": {"type": "string", "format": "date-time"}, "provisionedAt": {"type": "string", "format": "date-time"}, "configurationId": {"type": "string", "example": "7596498d2f367dc2"}, "uplink": {"description": "Uplink interface is device's connection to the parent device in the network topology", "properties": {"deviceId": {"type": "string", "format": "uuid"}}, "required": ["deviceId"], "title": "Device uplink interface overview"}, "features": {"properties": {"switching": {"example": {}, "title": "Switch feature overview"}, "accessPoint": {"example": {}, "title": "Access point feature overview"}}, "title": "Device features"}, "interfaces": {"properties": {"ports": {"type": "array", "items": {"properties": {"idx": {"type": "integer", "format": "int32", "example": 1, "minimum": 1}, "state": {"type": "string", "enum": ["UP", "DOWN", "UNKNOWN"]}, "connector": {"type": "string", "enum": ["RJ45", "SFP", "SFPPLUS", "SFP28", "QSFP28"]}, "maxSpeedMbps": {"type": "integer", "format": "int32", "example": 10000}, "speedMbps": {"type": "integer", "format": "int32", "example": 1000}, "poe": {"properties": {"standard": {"type": "string", "enum": ["802.3af", "802.3at", "802.3bt"], "example": "802.3bt"}, "type": {"type": "integer", "format": "int32", "enum": ["1", "2", "3", "4"], "example": 3}, "enabled": {"type": "boolean", "description": "Whether the PoE feature is enabled on the port"}, "state": {"type": "string", "description": "Whether the port currently supplies power to the (connected) device.", "enum": ["UP", "DOWN", "LIMITED", "UNKNOWN"]}}, "required": ["enabled", "standard", "state", "type"], "title": "Port PoE overview"}}, "required": ["connector", "idx", "maxSpeedMbps", "state"], "title": "Port overview"}}, "radios": {"type": "array", "items": {"properties": {"wlanStandard": {"type": "string", "enum": ["802.11a", "802.11b", "802.11g", "802.11n", "802.11ac", "802.11ax", "802.11be"]}, "frequencyGHz": {"type": "string", "enum": ["2.4", "5", "6", "60"]}, "channelWidthMHz": {"type": "integer", "format": "int32", "example": 40}, "channel": {"type": "integer", "format": "int32", "example": 36}}, "required": ["channelWidthMHz", "frequencyGHz", "wlanStandard"], "title": "Wireless radio overview"}}}, "title": "Device physical interfaces"}}, "required": ["configurationId", "features", "firmwareUpdatable", "id", "interfaces", "ipAddress", "macAddress", "model", "name", "state", "supported"], "title": "Adopted device details"}}}}}}}, "/v1/sites/{siteId}/devices/{deviceId}/statistics/latest": {"get": {"tags": ["UniFi Devices"], "summary": "Get Latest Adopted Device Statistics", "description": "Retrieve the latest real-time statistics of a specific adopted device, such as uptime, data transmission rates, CPU and memory utilization.", "operationId": "getAdoptedDeviceLatestStatistics", "parameters": [{"name": "siteId", "in": "path", "required": true, "schema": {"type": "string", "format": "uuid"}}, {"name": "deviceId", "in": "path", "required": true, "schema": {"type": "string", "format": "uuid"}}], "responses": {"200": {"description": "OK", "content": {"application/json": {"schema": {"properties": {"uptimeSec": {"type": "integer", "format": "int64"}, "lastHeartbeatAt": {"type": "string", "format": "date-time"}, "nextHeartbeatAt": {"type": "string", "format": "date-time"}, "loadAverage1Min": {"type": "number", "format": "double"}, "loadAverage5Min": {"type": "number", "format": "double"}, "loadAverage15Min": {"type": "number", "format": "double"}, "cpuUtilizationPct": {"type": "number", "format": "double"}, "memoryUtilizationPct": {"type": "number", "format": "double"}, "uplink": {"properties": {"txRateBps": {"type": "integer", "format": "int64"}, "rxRateBps": {"type": "integer", "format": "int64"}}, "title": "Latest statistics for a device uplink interface"}, "interfaces": {"properties": {"radios": {"type": "array", "items": {"properties": {"frequencyGHz": {"type": "string", "enum": ["2.4", "5", "6", "60"]}, "txRetriesPct": {"type": "number", "format": "double"}}, "required": ["frequencyGHz"], "title": "Latest statistics for wireless radio"}}}, "title": "Latest statistics for device interfaces"}}, "required": ["interfaces"], "title": "Latest statistics for a device"}}}}}}}, "/v1/sites/{siteId}/device-tags": {"get": {"tags": ["Supporting Resources"], "summary": "List Device Tags", "description": "Returns all device tags defined within a site, which can be used for WiFi Broadcast assignments.\n\n<details>\n<summary>Filterable properties (click to expand)</summary>\n\n|Name|Type|Allowed functions|\n|-|-|-|\n|`id`|`UUID`|`eq` `ne` `in` `notIn`|\n|`name`|`STRING`|`eq` `ne` `in` `notIn` `like`|\n|`deviceIds`|`SET(UUID)`|`contains` `containsAny` `containsAll` `containsExactly`|\n</details>", "operationId": "getDeviceTagPage", "parameters": [{"name": "offset", "in": "query", "required": false, "schema": {"format": "int32", "default": 0, "minimum": 0}}, {"name": "limit", "in": "query", "required": false, "schema": {"format": "int32", "default": 25, "maximum": 200, "minimum": 0}}, {"name": "filter", "in": "query", "required": false, "schema": {"title": "FilterExpression"}}, {"name": "siteId", "in": "path", "required": true, "schema": {"type": "string", "format": "uuid"}}], "responses": {"200": {"description": "OK", "content": {"application/json": {"schema": {"properties": {"offset": {"type": "integer", "format": "int64", "example": 0}, "limit": {"type": "integer", "format": "int32", "example": 25}, "count": {"type": "integer", "format": "int32", "example": 10}, "totalCount": {"type": "integer", "format": "int64", "example": 1000}, "data": {"type": "array", "items": {"properties": {"id": {"type": "string", "format": "uuid"}, "name": {"type": "string"}, "deviceIds": {"type": "array", "items": {"type": "string", "format": "uuid"}, "minItems": 1}, "metadata": {"discriminator": {"propertyName": "origin", "mapping": {"USER_DEFINED": "#/components/schemas/User defined entity metadata", "ORCHESTRATED": "#/components/schemas/Orchestrated entity metadata"}}, "properties": {"origin": {"type": "string"}}, "required": ["origin"], "title": "User or orchestrated entity metadata"}}, "required": ["deviceIds", "id", "metadata", "name"], "title": "Device tag"}}}, "required": ["count", "data", "limit", "offset", "totalCount"], "title": "IntegrationDeviceTagPageDto"}}}}}}}, "/v1/sites/{siteId}/clients": {"get": {"tags": ["Clients"], "summary": "List Connected Clients", "description": "Retrieve a paginated list of all connected clients on a site, including physical devices (computers, smartphones) and active VPN connections.\n\n<details>\n<summary>Filterable properties (click to expand)</summary>\n\n|Name|Type|Allowed functions|\n|-|-|-|\n|`id`|`UUID`|`eq` `ne` `in` `notIn`|\n|`type`|`STRING`|`eq` `ne` `in` `notIn`|\n|`macAddress`|`STRING`|`isNull` `isNotNull` `eq` `ne` `in` `notIn`|\n|`ipAddress`|`STRING`|`isNull` `isNotNull` `eq` `ne` `in` `notIn`|\n|`connectedAt`|`TIMESTAMP`|`isNull` `isNotNull` `eq` `ne` `gt` `ge` `lt` `le`|\n|`access.type`|`STRING`|`eq` `ne` `in` `notIn`|\n|`access.authorized`|`BOOLEAN`|`isNull` `isNotNull` `eq` `ne`|\n</details>", "operationId": "getConnectedClientOverviewPage", "parameters": [{"name": "offset", "in": "query", "required": false, "schema": {"format": "int32", "default": 0, "minimum": 0}}, {"name": "limit", "in": "query", "required": false, "schema": {"format": "int32", "default": 25, "maximum": 200, "minimum": 0}}, {"name": "filter", "in": "query", "required": false, "schema": {"type": "string"}}, {"name": "siteId", "in": "path", "required": true, "schema": {"type": "string", "format": "uuid"}}], "responses": {"200": {"description": "OK", "content": {"application/json": {"schema": {"properties": {"offset": {"type": "integer", "format": "int64", "example": 0}, "limit": {"type": "integer", "format": "int32", "example": 25}, "count": {"type": "integer", "format": "int32", "example": 10}, "totalCount": {"type": "integer", "format": "int64", "example": 1000}, "data": {"type": "array", "items": {"discriminator": {"propertyName": "type", "mapping": {"WIRED": "#/components/schemas/Wired client overview", "WIRELESS": "#/components/schemas/Wireless client overview", "VPN": "#/components/schemas/VPN client (connection) overview", "TELEPORT": "#/components/schemas/Teleport client (connection) overview"}}, "properties": {"type": {"type": "string"}, "id": {"type": "string", "format": "uuid"}, "name": {"type": "string"}, "connectedAt": {"type": "string", "format": "date-time"}, "ipAddress": {"type": "string"}, "access": {"example": {"type": "DEFAULT"}, "title": "Client access overview"}}, "required": ["access", "id", "name", "type"], "title": "Client overview"}}}, "required": ["count", "data", "limit", "offset", "totalCount"], "title": "Client overview page"}}}}}}}, "/v1/sites/{siteId}/clients/{clientId}": {"get": {"tags": ["Clients"], "summary": "Get Connected Client Details", "description": "Retrieve detailed information about a specific connected client, including name, IP address, MAC address, connection type and access information.", "operationId": "getConnectedClientDetails", "parameters": [{"name": "clientId", "in": "path", "required": true, "schema": {"type": "string", "format": "uuid"}}, {"name": "siteId", "in": "path", "required": true, "schema": {"type": "string", "format": "uuid"}}], "responses": {"200": {"description": "OK", "content": {"application/json": {"schema": {"discriminator": {"propertyName": "type", "mapping": {"WIRED": "#/components/schemas/Wired client details", "WIRELESS": "#/components/schemas/Wireless client details", "VPN": "#/components/schemas/VPN client (connection) details", "TELEPORT": "#/components/schemas/Teleport client (connection) details"}}, "properties": {"type": {"type": "string"}, "id": {"type": "string", "format": "uuid"}, "name": {"type": "string"}, "connectedAt": {"type": "string", "format": "date-time"}, "ipAddress": {"type": "string"}, "access": {}}, "required": ["access", "id", "name", "type"], "title": "Client details"}}}}}}}, "/v1/pending-devices": {"get": {"tags": ["UniFi Devices"], "summary": "List Devices Pending Adoption", "description": "Retrieve a paginated list of devices pending adoption, including basic device information.\n\n<details>\n<summary>Filterable properties (click to expand)</summary>\n\n|Name|Type|Allowed functions|\n|-|-|-|\n|`macAddress`|`STRING`|`eq` `ne` `in` `notIn`|\n|`ipAddress`|`STRING`|`eq` `ne` `in` `notIn`|\n|`model`|`STRING`|`eq` `ne` `in` `notIn`|\n|`state`|`STRING`|`eq` `ne` `in` `notIn`|\n|`supported`|`BOOLEAN`|`eq` `ne`|\n|`firmwareVersion`|`STRING`|`isNull` `isNotNull` `eq` `ne` `gt` `ge` `lt` `le` `like` `in` `notIn`|\n|`firmwareUpdatable`|`BOOLEAN`|`eq` `ne`|\n|`features`|`SET(STRING)`|`isEmpty` `contains` `containsAny` `containsAll` `containsExactly`|\n</details>", "operationId": "getPendingDevicePage", "parameters": [{"name": "offset", "in": "query", "required": false, "schema": {"format": "int32", "default": 0, "minimum": 0}}, {"name": "limit", "in": "query", "required": false, "schema": {"format": "int32", "default": 25, "maximum": 200, "minimum": 0}}, {"name": "filter", "in": "query", "required": false, "schema": {"type": "string"}}], "responses": {"200": {"description": "OK", "content": {"application/json": {"schema": {"properties": {"offset": {"type": "integer", "format": "int64", "example": 0}, "limit": {"type": "integer", "format": "int32", "example": 25}, "count": {"type": "integer", "format": "int32", "example": 10}, "totalCount": {"type": "integer", "format": "int64", "example": 1000}, "data": {"type": "array", "items": {"properties": {"macAddress": {"type": "string", "example": "94:2a:6f:26:c6:ca"}, "ipAddress": {"type": "string", "example": "192.168.1.55"}, "model": {"type": "string", "example": "UHDIW"}, "state": {"type": "string", "enum": ["ONLINE", "OFFLINE", "PENDING_ADOPTION", "UPDATING", "GETTING_READY", "ADOPTING", "DELETING", "CONNECTION_INTERRUPTED", "ISOLATED", "U5G_INCORRECT_TOPOLOGY"]}, "supported": {"type": "boolean"}, "firmwareVersion": {"type": "string", "example": "6.6.55"}, "firmwareUpdatable": {"type": "boolean"}, "features": {"type": "array", "items": {"type": "string", "enum": ["switching", "accessPoint", "gateway"]}, "uniqueItems": true}}, "required": ["features", "firmwareUpdatable", "ipAddress", "macAddress", "model", "state", "supported"], "title": "Device pending adoption"}}}, "required": ["count", "data", "limit", "offset", "totalCount"], "title": "Device pending adoption page"}}}}}}}, "/v1/info": {"get": {"tags": ["Application Info"], "summary": "Get Application Info", "description": "Retrieve general information about the UniFi Network application.", "operationId": "getInfo", "responses": {"200": {"description": "OK", "content": {"application/json": {"schema": {"properties": {"applicationVersion": {"type": "string", "example": "9.1.0"}}, "required": ["applicationVersion"], "title": "Application info"}}}}}}}, "/v1/dpi/categories": {"get": {"tags": ["Supporting Resources"], "summary": "List DPI Categories", "description": "Returns predefined Deep Packet Inspection (DPI) categories used for traffic identification and filtering.\n\n<details>\n<summary>Filterable properties (click to expand)</summary>\n\n|Name|Type|Allowed functions|\n|-|-|-|\n|`id`|`INTEGER`|`eq` `ne` `in` `notIn`|\n|`name`|`STRING`|`eq` `ne` `in` `notIn` `like`|\n</details>", "operationId": "getCategories", "parameters": [{"name": "offset", "in": "query", "required": false, "schema": {"format": "int32", "default": 0, "minimum": 0}}, {"name": "limit", "in": "query", "required": false, "schema": {"format": "int32", "default": 25, "maximum": 200, "minimum": 0}}, {"name": "filter", "in": "query", "required": false, "schema": {"type": "string"}}], "responses": {"200": {"description": "OK", "content": {"application/json": {"schema": {"properties": {"offset": {"type": "integer", "format": "int64", "example": 0}, "limit": {"type": "integer", "format": "int32", "example": 25}, "count": {"type": "integer", "format": "int32", "example": 10}, "totalCount": {"type": "integer", "format": "int64", "example": 1000}, "data": {"type": "array", "items": {"properties": {"id": {"type": "integer", "format": "int32", "example": "3|5"}, "name": {"type": "string", "example": "Network protocols|Business tools"}}, "required": ["id", "name"], "title": "DPI category"}}}, "required": ["count", "data", "limit", "offset", "totalCount"], "title": "DPI category page"}}}}}}}, "/v1/dpi/applications": {"get": {"tags": ["Supporting Resources"], "summary": "List DPI Applications", "description": "Lists DPI-recognized applications grouped under categories. Useful for firewall or traffic analytics integration.\n\n<details>\n<summary>Filterable properties (click to expand)</summary>\n\n|Name|Type|Allowed functions|\n|-|-|-|\n|`id`|`INTEGER`|`eq` `ne` `in` `notIn`|\n|`name`|`STRING`|`eq` `ne` `in` `notIn` `like`|\n</details>", "operationId": "getApplications", "parameters": [{"name": "offset", "in": "query", "required": false, "schema": {"format": "int32", "default": 0, "minimum": 0}}, {"name": "limit", "in": "query", "required": false, "schema": {"format": "int32", "default": 25, "maximum": 200, "minimum": 0}}, {"name": "filter", "in": "query", "required": false, "schema": {"type": "string"}}], "responses": {"200": {"description": "OK", "content": {"application/json": {"schema": {"properties": {"offset": {"type": "integer", "format": "int64", "example": 0}, "limit": {"type": "integer", "format": "int32", "example": 25}, "count": {"type": "integer", "format": "int32", "example": 10}, "totalCount": {"type": "integer", "format": "int64", "example": 1000}, "data": {"type": "array", "items": {"properties": {"id": {"type": "integer", "format": "int32", "example": "786435|720973"}, "name": {"type": "string", "example": "Adobe Express|Zoom"}}, "required": ["id", "name"], "title": "DPI application"}}}, "required": ["count", "data", "limit", "offset", "totalCount"], "title": "DPI application page"}}}}}}}, "/v1/countries": {"get": {"tags": ["Supporting Resources"], "summary": "List Countries", "description": "Returns ISO-standard country codes and names,\nused for region-based configuration or regulatory compliance.\n\n<details>\n<summary>Filterable properties (click to expand)</summary>\n\n|Name|Type|Allowed functions|\n|-|-|-|\n|`code`|`STRING`|`eq` `ne` `in` `notIn`|\n|`name`|`STRING`|`eq` `ne` `in` `notIn` `like`|\n</details>", "operationId": "getCountries", "parameters": [{"name": "offset", "in": "query", "required": false, "schema": {"format": "int32", "default": 0, "minimum": 0}}, {"name": "limit", "in": "query", "required": false, "schema": {"format": "int32", "default": 25, "maximum": 200, "minimum": 0}}, {"name": "filter", "in": "query", "required": false, "schema": {"type": "string"}}], "responses": {"200": {"description": "OK", "content": {"application/json": {"schema": {"properties": {"offset": {"type": "integer", "format": "int64", "example": 0}, "limit": {"type": "integer", "format": "int32", "example": 25}, "count": {"type": "integer", "format": "int32", "example": 10}, "totalCount": {"type": "integer", "format": "int64", "example": 1000}, "data": {"type": "array", "items": {"properties": {"code": {"type": "string", "description": "The country code in ISO 3166-1 alpha-2 format.", "example": "CK|FK|KY"}, "name": {"type": "string", "description": "The country name.", "example": "Cook Islands|Falkland Islands, Malvinas|Cayman Islands"}}, "required": ["code", "name"], "title": "Country Definition"}}}, "required": ["count", "data", "limit", "offset", "totalCount"], "title": "Country definition page"}}}}}}}}, "components": {"schemas": {"Error Message": {"properties": {"statusCode": {"type": "integer", "format": "int32", "example": 400}, "statusName": {"type": "string", "example": "UNAUTHORIZED"}, "code": {"type": "string", "example": "api.authentication.missing-credentials"}, "message": {"type": "string", "example": "Missing credentials"}, "timestamp": {"type": "string", "format": "date-time", "example": "2024-11-27T08:13:46.966Z"}, "requestPath": {"type": "string", "example": "/integration/v1/sites/123"}, "requestId": {"type": "string", "format": "uuid", "description": "In case of Internal Server Error (core = 500), request ID can be used to track down the error in the server log", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6"}}, "x-tags": "Error Handling"}, "Blackout schedule configuration per day": {"discriminator": {"propertyName": "type", "mapping": {"ALL_DAY": "#/components/schemas/IntegrationWifiBlackoutScheduleConfigurationPerAllDayDto", "TIME_RANGE": "#/components/schemas/IntegrationWifiBlackoutScheduleConfigurationPerDayWithTimeRangeDto"}}, "properties": {"type": {"type": "string"}, "day": {"type": "string", "enum": ["SUN", "MON", "TUE", "WED", "THU", "FRI", "SAT"]}}, "required": ["day", "type"]}, "Broadcasting device filter": {"discriminator": {"propertyName": "type", "mapping": {"DEVICES": "#/components/schemas/IntegrationWifiDevicesFilterDto", "DEVICE_TAGS": "#/components/schemas/IntegrationWifiDeviceTagsFilterDto"}}, "properties": {"type": {"type": "string"}}, "required": ["type"]}, "Integration blackout schedule configuration": {"properties": {"days": {"type": "array", "items": {"discriminator": {"propertyName": "type", "mapping": {"ALL_DAY": "#/components/schemas/IntegrationWifiBlackoutScheduleConfigurationPerAllDayDto", "TIME_RANGE": "#/components/schemas/IntegrationWifiBlackoutScheduleConfigurationPerDayWithTimeRangeDto"}}, "properties": {"type": {"type": "string"}, "day": {"type": "string", "enum": ["SUN", "MON", "TUE", "WED", "THU", "FRI", "SAT"]}}, "required": ["day", "type"], "title": "Blackout schedule configuration per day"}, "minItems": 1}}, "required": ["days"]}, "IntegrationIotOptimizedWifiBroadcastCreateUpdateDto": {"allOf": [{"discriminator": {"propertyName": "type", "mapping": {"STANDARD": "#/components/schemas/IntegrationStandardWifiBroadcastCreateUpdateDto", "IOT_OPTIMIZED": "#/components/schemas/IntegrationIotOptimizedWifiBroadcastCreateUpdateDto"}}, "properties": {"type": {"type": "string"}, "name": {"type": "string"}, "network": {"discriminator": {"propertyName": "type", "mapping": {"NATIVE": "#/components/schemas/IntegrationWifiNativeNetworkDto", "SPECIFIC": "#/components/schemas/IntegrationWifiSpecificNetworkDto"}}, "properties": {"type": {"type": "string"}}, "required": ["type"], "title": "Wifi network reference"}, "enabled": {"type": "boolean"}, "securityConfiguration": {"discriminator": {"propertyName": "type", "mapping": {"OPEN": "#/components/schemas/IntegrationWifiOpenSecurityConfigurationDetailDto", "WPA2_PERSONAL": "#/components/schemas/IntegrationWifiWpa2PersonalSecurityConfigurationDetailDto", "WPA3_PERSONAL": "#/components/schemas/IntegrationWifiWpa3PersonalSecurityConfigurationDetailDto", "WPA2_WPA3_PERSONAL": "#/components/schemas/IntegrationWifiWpa2Wpa3PersonalSecurityConfigurationDetailDto", "WPA2_ENTERPRISE": "#/components/schemas/IntegrationWifiWpa2EnterpriseSecurityConfigurationDetailDto", "WPA3_ENTERPRISE": "#/components/schemas/IntegrationWifiWpa3EnterpriseSecurityConfigurationDetailDto", "WPA2_WPA3_ENTERPRISE": "#/components/schemas/IntegrationWifiWpa2Wpa3EnterpriseSecurityConfigurationDetailDto"}}, "properties": {"type": {"type": "string"}, "radiusConfiguration": {}}, "required": ["type"], "title": "Wifi security configuration detailObject"}, "broadcastingDeviceFilter": {"description": "Defines the custom scope of devices that will broadcast this WiFi network. If null, the WiFi network will be broadcast by all Access Point capable devices.", "discriminator": {"propertyName": "type", "mapping": {"DEVICES": "#/components/schemas/IntegrationWifiDevicesFilterDto", "DEVICE_TAGS": "#/components/schemas/IntegrationWifiDeviceTagsFilterDto"}}, "properties": {"type": {"type": "string"}}, "required": ["type"], "title": "Broadcasting device filter"}, "mdnsProxyConfiguration": {"discriminator": {"propertyName": "mode", "mapping": {"AUTO": "#/components/schemas/IntegrationWifiMdnsProxyAutoConfigurationDto", "CUSTOM": "#/components/schemas/IntegrationWifiMdnsProxyCustomConfigurationDto"}}, "properties": {"mode": {"type": "string"}}, "required": ["mode"], "title": "mDNS filtering configuration"}, "multicastFilteringPolicy": {"discriminator": {"propertyName": "action", "mapping": {"ALLOW": "#/components/schemas/IntegrationWifiMulticastFilteringAllowPolicyDto", "BLOCK": "#/components/schemas/IntegrationWifiMulticastFilteringBlockPolicyDto"}}, "properties": {"action": {"type": "string"}}, "required": ["action"], "title": "Multicast filtering policy"}, "multicastToUnicastConversionEnabled": {"type": "boolean"}, "clientIsolationEnabled": {"type": "boolean"}, "hideName": {"type": "boolean"}, "uapsdEnabled": {"type": "boolean", "description": "Indicates whether Unscheduled Automatic Power Save Delivery (U-APSD) is enabled"}, "basicDataRateKbpsByFrequencyGHz": {"properties": {"5": {"type": "integer", "format": "int32", "enum": ["6000", "9000", "12000", "24000"], "example": 6000}, "2.4": {"type": "integer", "format": "int32", "enum": ["1000", "2000", "5500", "6000", "9000", "11000", "12000", "24000"], "example": 2000}}, "required": ["2.4", "5"], "title": "IntegrationWifiBasicDataRateConfigurationDto"}, "clientFilteringPolicy": {"description": "Client connection filtering policy. Allow/restrict access to the WiFi network based on client device MAC addresses.", "properties": {"action": {"type": "string", "enum": ["ALLOW", "BLOCK"]}, "macAddressFilter": {"type": "array", "items": {"type": "string"}, "maxItems": 512, "minItems": 1, "uniqueItems": true}}, "required": ["action", "macAddressFilter"], "title": "IntegrationWifiClientFilteringPolicyDto"}, "blackoutScheduleConfiguration": {"properties": {"days": {"type": "array", "items": {"discriminator": {"propertyName": "type", "mapping": {"ALL_DAY": "#/components/schemas/IntegrationWifiBlackoutScheduleConfigurationPerAllDayDto", "TIME_RANGE": "#/components/schemas/IntegrationWifiBlackoutScheduleConfigurationPerDayWithTimeRangeDto"}}, "properties": {"type": {"type": "string"}, "day": {"type": "string", "enum": ["SUN", "MON", "TUE", "WED", "THU", "FRI", "SAT"]}}, "required": ["day", "type"], "title": "Blackout schedule configuration per day"}, "minItems": 1}}, "required": ["days"], "title": "Integration blackout schedule configuration"}}, "required": ["clientIsolationEnabled", "enabled", "hideName", "multicastToUnicastConversionEnabled", "name", "securityConfiguration", "type", "uapsdEnabled"], "title": "Wifi broadcast create or update"}], "required": ["clientIsolationEnabled", "enabled", "hideName", "multicastToUnicastConversionEnabled", "name", "securityConfiguration", "uapsdEnabled"]}, "IntegrationStandardWifiBroadcastCreateUpdateDto": {"allOf": [{"discriminator": {"propertyName": "type", "mapping": {"STANDARD": "#/components/schemas/IntegrationStandardWifiBroadcastCreateUpdateDto", "IOT_OPTIMIZED": "#/components/schemas/IntegrationIotOptimizedWifiBroadcastCreateUpdateDto"}}, "properties": {"type": {"type": "string"}, "name": {"type": "string"}, "network": {"discriminator": {"propertyName": "type", "mapping": {"NATIVE": "#/components/schemas/IntegrationWifiNativeNetworkDto", "SPECIFIC": "#/components/schemas/IntegrationWifiSpecificNetworkDto"}}, "properties": {"type": {"type": "string"}}, "required": ["type"], "title": "Wifi network reference"}, "enabled": {"type": "boolean"}, "securityConfiguration": {"discriminator": {"propertyName": "type", "mapping": {"OPEN": "#/components/schemas/IntegrationWifiOpenSecurityConfigurationDetailDto", "WPA2_PERSONAL": "#/components/schemas/IntegrationWifiWpa2PersonalSecurityConfigurationDetailDto", "WPA3_PERSONAL": "#/components/schemas/IntegrationWifiWpa3PersonalSecurityConfigurationDetailDto", "WPA2_WPA3_PERSONAL": "#/components/schemas/IntegrationWifiWpa2Wpa3PersonalSecurityConfigurationDetailDto", "WPA2_ENTERPRISE": "#/components/schemas/IntegrationWifiWpa2EnterpriseSecurityConfigurationDetailDto", "WPA3_ENTERPRISE": "#/components/schemas/IntegrationWifiWpa3EnterpriseSecurityConfigurationDetailDto", "WPA2_WPA3_ENTERPRISE": "#/components/schemas/IntegrationWifiWpa2Wpa3EnterpriseSecurityConfigurationDetailDto"}}, "properties": {"type": {"type": "string"}, "radiusConfiguration": {}}, "required": ["type"], "title": "Wifi security configuration detailObject"}, "broadcastingDeviceFilter": {"description": "Defines the custom scope of devices that will broadcast this WiFi network. If null, the WiFi network will be broadcast by all Access Point capable devices.", "discriminator": {"propertyName": "type", "mapping": {"DEVICES": "#/components/schemas/IntegrationWifiDevicesFilterDto", "DEVICE_TAGS": "#/components/schemas/IntegrationWifiDeviceTagsFilterDto"}}, "properties": {"type": {"type": "string"}}, "required": ["type"], "title": "Broadcasting device filter"}, "mdnsProxyConfiguration": {"discriminator": {"propertyName": "mode", "mapping": {"AUTO": "#/components/schemas/IntegrationWifiMdnsProxyAutoConfigurationDto", "CUSTOM": "#/components/schemas/IntegrationWifiMdnsProxyCustomConfigurationDto"}}, "properties": {"mode": {"type": "string"}}, "required": ["mode"], "title": "mDNS filtering configuration"}, "multicastFilteringPolicy": {"discriminator": {"propertyName": "action", "mapping": {"ALLOW": "#/components/schemas/IntegrationWifiMulticastFilteringAllowPolicyDto", "BLOCK": "#/components/schemas/IntegrationWifiMulticastFilteringBlockPolicyDto"}}, "properties": {"action": {"type": "string"}}, "required": ["action"], "title": "Multicast filtering policy"}, "multicastToUnicastConversionEnabled": {"type": "boolean"}, "clientIsolationEnabled": {"type": "boolean"}, "hideName": {"type": "boolean"}, "uapsdEnabled": {"type": "boolean", "description": "Indicates whether Unscheduled Automatic Power Save Delivery (U-APSD) is enabled"}, "basicDataRateKbpsByFrequencyGHz": {"properties": {"5": {"type": "integer", "format": "int32", "enum": ["6000", "9000", "12000", "24000"], "example": 6000}, "2.4": {"type": "integer", "format": "int32", "enum": ["1000", "2000", "5500", "6000", "9000", "11000", "12000", "24000"], "example": 2000}}, "required": ["2.4", "5"], "title": "IntegrationWifiBasicDataRateConfigurationDto"}, "clientFilteringPolicy": {"description": "Client connection filtering policy. Allow/restrict access to the WiFi network based on client device MAC addresses.", "properties": {"action": {"type": "string", "enum": ["ALLOW", "BLOCK"]}, "macAddressFilter": {"type": "array", "items": {"type": "string"}, "maxItems": 512, "minItems": 1, "uniqueItems": true}}, "required": ["action", "macAddressFilter"], "title": "IntegrationWifiClientFilteringPolicyDto"}, "blackoutScheduleConfiguration": {"properties": {"days": {"type": "array", "items": {"discriminator": {"propertyName": "type", "mapping": {"ALL_DAY": "#/components/schemas/IntegrationWifiBlackoutScheduleConfigurationPerAllDayDto", "TIME_RANGE": "#/components/schemas/IntegrationWifiBlackoutScheduleConfigurationPerDayWithTimeRangeDto"}}, "properties": {"type": {"type": "string"}, "day": {"type": "string", "enum": ["SUN", "MON", "TUE", "WED", "THU", "FRI", "SAT"]}}, "required": ["day", "type"], "title": "Blackout schedule configuration per day"}, "minItems": 1}}, "required": ["days"], "title": "Integration blackout schedule configuration"}}, "required": ["clientIsolationEnabled", "enabled", "hideName", "multicastToUnicastConversionEnabled", "name", "securityConfiguration", "type", "uapsdEnabled"], "title": "Wifi broadcast create or update"}, {"type": "object", "properties": {"broadcastingFrequenciesGHz": {"type": "array", "example": [2.4, 5], "items": {"type": "string", "enum": ["2.4", "5", "6"]}, "minItems": 1, "uniqueItems": true}, "hotspotConfiguration": {"discriminator": {"propertyName": "type", "mapping": {"CAPTIVE_PORTAL": "#/components/schemas/IntegrationWifiCaptivePortalConfigurationDetailDto", "PASSPOINT": "#/components/schemas/IntegrationWifiPasspointConfigurationDetailDto"}}, "properties": {"type": {"type": "string"}}, "required": ["type"], "title": "Wifi hotspot configuration"}, "mloEnabled": {"type": "boolean"}, "bandSteeringEnabled": {"type": "boolean"}, "arpProxyEnabled": {"type": "boolean"}, "bssTransitionEnabled": {"type": "boolean"}, "dtimPeriodByFrequencyGHzOverride": {"properties": {"5": {"type": "integer", "format": "int32", "maximum": 255, "minimum": 1}, "6": {"type": "integer", "format": "int32", "maximum": 255, "minimum": 1}, "2.4": {"type": "integer", "format": "int32", "maximum": 255, "minimum": 1}}, "required": ["2.4", "5", "6"], "title": "IntegrationWifiDtimPeriodConfigurationDto"}}}], "required": ["arpProxyEnabled", "broadcastingFrequenciesGHz", "bssTransitionEnabled", "clientIsolationEnabled", "enabled", "hideName", "multicastToUnicastConversionEnabled", "name", "securityConfiguration", "uapsdEnabled"]}, "IntegrationWifiBasicDataRateConfigurationDto": {"properties": {"5": {"type": "integer", "format": "int32", "enum": ["6000", "9000", "12000", "24000"], "example": 6000}, "2.4": {"type": "integer", "format": "int32", "enum": ["1000", "2000", "5500", "6000", "9000", "11000", "12000", "24000"], "example": 2000}}, "required": ["2.4", "5"]}, "IntegrationWifiBlackoutScheduleConfigurationPerAllDayDto": {"allOf": [{"discriminator": {"propertyName": "type", "mapping": {"ALL_DAY": "#/components/schemas/IntegrationWifiBlackoutScheduleConfigurationPerAllDayDto", "TIME_RANGE": "#/components/schemas/IntegrationWifiBlackoutScheduleConfigurationPerDayWithTimeRangeDto"}}, "properties": {"type": {"type": "string"}, "day": {"type": "string", "enum": ["SUN", "MON", "TUE", "WED", "THU", "FRI", "SAT"]}}, "required": ["day", "type"], "title": "Blackout schedule configuration per day"}], "required": ["day"]}, "IntegrationWifiBlackoutScheduleConfigurationPerDayWithTimeRangeDto": {"allOf": [{"discriminator": {"propertyName": "type", "mapping": {"ALL_DAY": "#/components/schemas/IntegrationWifiBlackoutScheduleConfigurationPerAllDayDto", "TIME_RANGE": "#/components/schemas/IntegrationWifiBlackoutScheduleConfigurationPerDayWithTimeRangeDto"}}, "properties": {"type": {"type": "string"}, "day": {"type": "string", "enum": ["SUN", "MON", "TUE", "WED", "THU", "FRI", "SAT"]}}, "required": ["day", "type"], "title": "Blackout schedule configuration per day"}, {"type": "object", "properties": {"timeRanges": {"type": "array", "items": {"properties": {"startTime": {"type": "string", "format": "partial-time", "description": "Start time in 24-hour format (HH:mm)"}, "endTime": {"type": "string", "format": "partial-time", "description": "End time in 24-hour format (HH:mm)"}}, "required": ["endTime", "startTime"], "title": "IntegrationWifiBlackoutScheduleConfigurationTimeRangeDto"}, "minItems": 1}}}], "required": ["day", "timeRanges"]}, "IntegrationWifiBlackoutScheduleConfigurationTimeRangeDto": {"properties": {"startTime": {"type": "string", "format": "partial-time", "description": "Start time in 24-hour format (HH:mm)"}, "endTime": {"type": "string", "format": "partial-time", "description": "End time in 24-hour format (HH:mm)"}}, "required": ["endTime", "startTime"]}, "IntegrationWifiCaptivePortalConfigurationDetailDto": {"allOf": [{"discriminator": {"propertyName": "type", "mapping": {"CAPTIVE_PORTAL": "#/components/schemas/IntegrationWifiCaptivePortalConfigurationDetailDto", "PASSPOINT": "#/components/schemas/IntegrationWifiPasspointConfigurationDetailDto"}}, "properties": {"type": {"type": "string"}}, "required": ["type"], "title": "Wifi hotspot configuration"}]}, "IntegrationWifiClientFilteringPolicyDto": {"properties": {"action": {"type": "string", "enum": ["ALLOW", "BLOCK"]}, "macAddressFilter": {"type": "array", "items": {"type": "string"}, "maxItems": 512, "minItems": 1, "uniqueItems": true}}, "required": ["action", "macAddressFilter"]}, "IntegrationWifiDerivedNasIdDto": {"allOf": [{"discriminator": {"propertyName": "type", "mapping": {"DERIVED": "#/components/schemas/IntegrationWifiDerivedNasIdDto", "USER_DEFINED": "#/components/schemas/IntegrationWifiUserDefinedNasIdDto"}}, "properties": {"type": {"type": "string"}}, "required": ["type"], "title": "Wifi Radius NAS ID configuration"}, {"type": "object", "properties": {"source": {"type": "string", "enum": ["DEVICE_MAC_ADDRESS", "DEVICE_NAME", "SITE_NAME", "BSSID"]}}}], "required": ["source"]}, "IntegrationWifiDeviceTagsFilterDto": {"allOf": [{"discriminator": {"propertyName": "type", "mapping": {"DEVICES": "#/components/schemas/IntegrationWifiDevicesFilterDto", "DEVICE_TAGS": "#/components/schemas/IntegrationWifiDeviceTagsFilterDto"}}, "properties": {"type": {"type": "string"}}, "required": ["type"], "title": "Broadcasting device filter"}, {"type": "object", "properties": {"deviceTagIds": {"type": "array", "items": {"type": "string", "format": "uuid"}, "minItems": 1, "uniqueItems": true}}}], "required": ["deviceTagIds"]}, "IntegrationWifiDevicesFilterDto": {"allOf": [{"discriminator": {"propertyName": "type", "mapping": {"DEVICES": "#/components/schemas/IntegrationWifiDevicesFilterDto", "DEVICE_TAGS": "#/components/schemas/IntegrationWifiDeviceTagsFilterDto"}}, "properties": {"type": {"type": "string"}}, "required": ["type"], "title": "Broadcasting device filter"}, {"type": "object", "properties": {"deviceIds": {"type": "array", "description": "List of Access Point capable device IDs to which the WiFi broadcast applies.", "items": {"type": "string", "format": "uuid"}, "minItems": 1, "uniqueItems": true}}}], "required": ["deviceIds"]}, "IntegrationWifiDtimPeriodConfigurationDto": {"properties": {"5": {"type": "integer", "format": "int32", "maximum": 255, "minimum": 1}, "6": {"type": "integer", "format": "int32", "maximum": 255, "minimum": 1}, "2.4": {"type": "integer", "format": "int32", "maximum": 255, "minimum": 1}}, "required": ["2.4", "5", "6"]}, "IntegrationWifiEnterpriseRadiusConfigurationDto": {"properties": {"profileId": {"type": "string", "format": "uuid"}, "nasId": {"discriminator": {"propertyName": "type", "mapping": {"DERIVED": "#/components/schemas/IntegrationWifiDerivedNasIdDto", "USER_DEFINED": "#/components/schemas/IntegrationWifiUserDefinedNasIdDto"}}, "properties": {"type": {"type": "string"}}, "required": ["type"], "title": "Wifi Radius NAS ID configuration"}, "macAuthenticationConfiguration": {"properties": {"macAddressFormat": {"type": "string", "enum": ["UPPERCASE_NOT_SEPARATED", "UPPERCASE_DASH_SEPARATED", "UPPERCASE_COLON_SEPARATED", "LOWERCASE_NOT_SEPARATED", "LOWERCASE_COLON_SEPARATED", "LOWERCASE_DASH_SEPARATED"]}}, "required": ["macAddressFormat"], "title": "IntegrationWifiRadiusMacAuthenticationConfigurationDto"}}, "required": ["nasId", "profileId"]}, "IntegrationWifiMdnsProxyAllowPolicyDto": {"allOf": [{"discriminator": {"propertyName": "action", "mapping": {"ALLOW": "#/components/schemas/IntegrationWifiMdnsProxyAllowPolicyDto", "BLOCK": "#/components/schemas/IntegrationWifiMdnsProxyBlockPolicyDto"}}, "properties": {"action": {"type": "string"}, "deviceFilter": {"description": "Defines the custom scope of devices that will filter Mdns. If null, the mDNS filtering will be added to all Access Point capable devices.", "discriminator": {"propertyName": "type", "mapping": {"DEVICES": "#/components/schemas/IntegrationWifiDevicesFilterDto", "DEVICE_TAGS": "#/components/schemas/IntegrationWifiDeviceTagsFilterDto"}}, "properties": {"type": {"type": "string"}}, "required": ["type"], "title": "Broadcasting device filter"}}, "required": ["action"], "title": "mDNS proxy policy"}, {"type": "object", "properties": {"serviceFilter": {"type": "array", "items": {"discriminator": {"propertyName": "type", "mapping": {"PREDEFINED": "#/components/schemas/IntegrationWifiMdnsProxyPredefinedServiceDto", "CUSTOM": "#/components/schemas/IntegrationWifiMdnsProxyCustomServiceDto"}}, "properties": {"type": {"type": "string"}}, "required": ["type"], "title": "mDNS service"}, "minItems": 1}, "bridgingNetworkIds": {"type": "array", "items": {"type": "string", "format": "uuid"}, "minItems": 1, "uniqueItems": true}}}]}, "IntegrationWifiMdnsProxyAutoConfigurationDto": {"allOf": [{"discriminator": {"propertyName": "mode", "mapping": {"AUTO": "#/components/schemas/IntegrationWifiMdnsProxyAutoConfigurationDto", "CUSTOM": "#/components/schemas/IntegrationWifiMdnsProxyCustomConfigurationDto"}}, "properties": {"mode": {"type": "string"}}, "required": ["mode"], "title": "mDNS filtering configuration"}]}, "IntegrationWifiMdnsProxyBlockPolicyDto": {"allOf": [{"discriminator": {"propertyName": "action", "mapping": {"ALLOW": "#/components/schemas/IntegrationWifiMdnsProxyAllowPolicyDto", "BLOCK": "#/components/schemas/IntegrationWifiMdnsProxyBlockPolicyDto"}}, "properties": {"action": {"type": "string"}, "deviceFilter": {"description": "Defines the custom scope of devices that will filter Mdns. If null, the mDNS filtering will be added to all Access Point capable devices.", "discriminator": {"propertyName": "type", "mapping": {"DEVICES": "#/components/schemas/IntegrationWifiDevicesFilterDto", "DEVICE_TAGS": "#/components/schemas/IntegrationWifiDeviceTagsFilterDto"}}, "properties": {"type": {"type": "string"}}, "required": ["type"], "title": "Broadcasting device filter"}}, "required": ["action"], "title": "mDNS proxy policy"}]}, "IntegrationWifiMdnsProxyCustomConfigurationDto": {"allOf": [{"discriminator": {"propertyName": "mode", "mapping": {"AUTO": "#/components/schemas/IntegrationWifiMdnsProxyAutoConfigurationDto", "CUSTOM": "#/components/schemas/IntegrationWifiMdnsProxyCustomConfigurationDto"}}, "properties": {"mode": {"type": "string"}}, "required": ["mode"], "title": "mDNS filtering configuration"}, {"type": "object", "properties": {"policies": {"type": "array", "items": {"discriminator": {"propertyName": "action", "mapping": {"ALLOW": "#/components/schemas/IntegrationWifiMdnsProxyAllowPolicyDto", "BLOCK": "#/components/schemas/IntegrationWifiMdnsProxyBlockPolicyDto"}}, "properties": {"action": {"type": "string"}, "deviceFilter": {"description": "Defines the custom scope of devices that will filter Mdns. If null, the mDNS filtering will be added to all Access Point capable devices.", "discriminator": {"propertyName": "type", "mapping": {"DEVICES": "#/components/schemas/IntegrationWifiDevicesFilterDto", "DEVICE_TAGS": "#/components/schemas/IntegrationWifiDeviceTagsFilterDto"}}, "properties": {"type": {"type": "string"}}, "required": ["type"], "title": "Broadcasting device filter"}}, "required": ["action"], "title": "mDNS proxy policy"}, "minItems": 1}}}], "required": ["policies"]}, "IntegrationWifiMdnsProxyCustomServiceDto": {"allOf": [{"discriminator": {"propertyName": "type", "mapping": {"PREDEFINED": "#/components/schemas/IntegrationWifiMdnsProxyPredefinedServiceDto", "CUSTOM": "#/components/schemas/IntegrationWifiMdnsProxyCustomServiceDto"}}, "properties": {"type": {"type": "string"}}, "required": ["type"], "title": "mDNS service"}, {"type": "object", "properties": {"name": {"type": "string"}, "typeDomain": {"type": "string"}}}], "required": ["name", "typeDomain"]}, "IntegrationWifiMdnsProxyPredefinedServiceDto": {"allOf": [{"discriminator": {"propertyName": "type", "mapping": {"PREDEFINED": "#/components/schemas/IntegrationWifiMdnsProxyPredefinedServiceDto", "CUSTOM": "#/components/schemas/IntegrationWifiMdnsProxyCustomServiceDto"}}, "properties": {"type": {"type": "string"}}, "required": ["type"], "title": "mDNS service"}, {"type": "object", "properties": {"name": {"type": "string", "enum": ["AMAZON_DEVICES", "ANDROID_TV_REMOTE", "APPLE_AIR_DROP", "APPLE_AIR_PLAY", "APPLE_FILE_SHARING", "APPLE_ICHAT", "APPLE_ITUNES", "AQARA", "BOSE", "DNS_SERVICE_DISCOVERY", "FTP_SERVERS", "GOOGLE_CHROMECAST", "HOMEKIT", "MATTER_NETWORK", "PHILIPS_HUE", "PRINTERS", "ROKU", "SCANNERS", "SONOS", "SPOTIFY_CONNECT", "SSH_SERVERS", "TIME_CAPSULE", "WEB_SERVERS", "WINDOWS_FILE_SHARING_SAMBA"]}}}], "required": ["name"]}, "IntegrationWifiMulticastFilteringAllowPolicyDto": {"allOf": [{"discriminator": {"propertyName": "action", "mapping": {"ALLOW": "#/components/schemas/IntegrationWifiMulticastFilteringAllowPolicyDto", "BLOCK": "#/components/schemas/IntegrationWifiMulticastFilteringBlockPolicyDto"}}, "properties": {"action": {"type": "string"}}, "required": ["action"], "title": "Multicast filtering policy"}, {"type": "object", "properties": {"sourceMacAddressFilter": {"type": "array", "description": "List of multicast source MAC addresses allowed. Multicast traffic from gateways is always allowed.", "items": {"type": "string"}, "maxItems": 256, "minItems": 1, "uniqueItems": true}}}], "required": ["sourceMacAddressFilter"]}, "IntegrationWifiMulticastFilteringBlockPolicyDto": {"allOf": [{"discriminator": {"propertyName": "action", "mapping": {"ALLOW": "#/components/schemas/IntegrationWifiMulticastFilteringAllowPolicyDto", "BLOCK": "#/components/schemas/IntegrationWifiMulticastFilteringBlockPolicyDto"}}, "properties": {"action": {"type": "string"}}, "required": ["action"], "title": "Multicast filtering policy"}]}, "IntegrationWifiNativeNetworkDto": {"allOf": [{"discriminator": {"propertyName": "type", "mapping": {"NATIVE": "#/components/schemas/IntegrationWifiNativeNetworkDto", "SPECIFIC": "#/components/schemas/IntegrationWifiSpecificNetworkDto"}}, "properties": {"type": {"type": "string"}}, "required": ["type"], "title": "Wifi network reference"}]}, "IntegrationWifiNonEnterpriseRadiusConfigurationDto": {"properties": {"profileId": {"type": "string", "format": "uuid"}, "nasId": {"discriminator": {"propertyName": "type", "mapping": {"DERIVED": "#/components/schemas/IntegrationWifiDerivedNasIdDto", "USER_DEFINED": "#/components/schemas/IntegrationWifiUserDefinedNasIdDto"}}, "properties": {"type": {"type": "string"}}, "required": ["type"], "title": "Wifi Radius NAS ID configuration"}, "macAuthenticationConfiguration": {"properties": {"macAddressFormat": {"type": "string", "enum": ["UPPERCASE_NOT_SEPARATED", "UPPERCASE_DASH_SEPARATED", "UPPERCASE_COLON_SEPARATED", "LOWERCASE_NOT_SEPARATED", "LOWERCASE_COLON_SEPARATED", "LOWERCASE_DASH_SEPARATED"]}}, "required": ["macAddressFormat"], "title": "IntegrationWifiRadiusMacAuthenticationConfigurationDto"}}, "required": ["macAuthenticationConfiguration", "nasId", "profileId"]}, "IntegrationWifiOpenSecurityConfigurationDetailDto": {"allOf": [{"discriminator": {"propertyName": "type", "mapping": {"OPEN": "#/components/schemas/IntegrationWifiOpenSecurityConfigurationDetailDto", "WPA2_PERSONAL": "#/components/schemas/IntegrationWifiWpa2PersonalSecurityConfigurationDetailDto", "WPA3_PERSONAL": "#/components/schemas/IntegrationWifiWpa3PersonalSecurityConfigurationDetailDto", "WPA2_WPA3_PERSONAL": "#/components/schemas/IntegrationWifiWpa2Wpa3PersonalSecurityConfigurationDetailDto", "WPA2_ENTERPRISE": "#/components/schemas/IntegrationWifiWpa2EnterpriseSecurityConfigurationDetailDto", "WPA3_ENTERPRISE": "#/components/schemas/IntegrationWifiWpa3EnterpriseSecurityConfigurationDetailDto", "WPA2_WPA3_ENTERPRISE": "#/components/schemas/IntegrationWifiWpa2Wpa3EnterpriseSecurityConfigurationDetailDto"}}, "properties": {"type": {"type": "string"}, "radiusConfiguration": {}}, "required": ["type"], "title": "Wifi security configuration detailObject"}, {"type": "object", "properties": {"radiusConfiguration": {"properties": {"profileId": {"type": "string", "format": "uuid"}, "nasId": {"discriminator": {"propertyName": "type", "mapping": {"DERIVED": "#/components/schemas/IntegrationWifiDerivedNasIdDto", "USER_DEFINED": "#/components/schemas/IntegrationWifiUserDefinedNasIdDto"}}, "properties": {"type": {"type": "string"}}, "required": ["type"], "title": "Wifi Radius NAS ID configuration"}, "macAuthenticationConfiguration": {"properties": {"macAddressFormat": {"type": "string", "enum": ["UPPERCASE_NOT_SEPARATED", "UPPERCASE_DASH_SEPARATED", "UPPERCASE_COLON_SEPARATED", "LOWERCASE_NOT_SEPARATED", "LOWERCASE_COLON_SEPARATED", "LOWERCASE_DASH_SEPARATED"]}}, "required": ["macAddressFormat"], "title": "IntegrationWifiRadiusMacAuthenticationConfigurationDto"}}, "required": ["macAuthenticationConfiguration", "nasId", "profileId"], "title": "IntegrationWifiNonEnterpriseRadiusConfigurationDto"}}}]}, "IntegrationWifiPasspointConfigurationDetailDto": {"allOf": [{"discriminator": {"propertyName": "type", "mapping": {"CAPTIVE_PORTAL": "#/components/schemas/IntegrationWifiCaptivePortalConfigurationDetailDto", "PASSPOINT": "#/components/schemas/IntegrationWifiPasspointConfigurationDetailDto"}}, "properties": {"type": {"type": "string"}}, "required": ["type"], "title": "Wifi hotspot configuration"}]}, "IntegrationWifiPresharedKeyDto": {"properties": {"network": {"discriminator": {"propertyName": "type", "mapping": {"NATIVE": "#/components/schemas/IntegrationWifiNativeNetworkDto", "SPECIFIC": "#/components/schemas/IntegrationWifiSpecificNetworkDto"}}, "properties": {"type": {"type": "string"}}, "required": ["type"], "title": "Wifi network reference"}, "passphrase": {"type": "string"}}, "required": ["network", "passphrase"]}, "IntegrationWifiRadiusMacAuthenticationConfigurationDto": {"properties": {"macAddressFormat": {"type": "string", "enum": ["UPPERCASE_NOT_SEPARATED", "UPPERCASE_DASH_SEPARATED", "UPPERCASE_COLON_SEPARATED", "LOWERCASE_NOT_SEPARATED", "LOWERCASE_COLON_SEPARATED", "LOWERCASE_DASH_SEPARATED"]}}, "required": ["macAddressFormat"]}, "IntegrationWifiSaeConfigurationDto": {"properties": {"anticloggingThresholdSeconds": {"type": "integer", "format": "int32", "maximum": 60, "minimum": 1}, "syncTimeSeconds": {"type": "integer", "format": "int32", "maximum": 60, "minimum": 1}}, "required": ["anticloggingThresholdSeconds", "syncTimeSeconds"]}, "IntegrationWifiSpecificNetworkDto": {"allOf": [{"discriminator": {"propertyName": "type", "mapping": {"NATIVE": "#/components/schemas/IntegrationWifiNativeNetworkDto", "SPECIFIC": "#/components/schemas/IntegrationWifiSpecificNetworkDto"}}, "properties": {"type": {"type": "string"}}, "required": ["type"], "title": "Wifi network reference"}, {"type": "object", "properties": {"networkId": {"type": "string", "format": "uuid"}}}], "required": ["networkId"]}, "IntegrationWifiUserDefinedNasIdDto": {"allOf": [{"discriminator": {"propertyName": "type", "mapping": {"DERIVED": "#/components/schemas/IntegrationWifiDerivedNasIdDto", "USER_DEFINED": "#/components/schemas/IntegrationWifiUserDefinedNasIdDto"}}, "properties": {"type": {"type": "string"}}, "required": ["type"], "title": "Wifi Radius NAS ID configuration"}, {"type": "object", "properties": {"value": {"type": "string"}}}], "required": ["value"]}, "IntegrationWifiWpa2EnterpriseSecurityConfigurationDetailDto": {"allOf": [{"discriminator": {"propertyName": "type", "mapping": {"OPEN": "#/components/schemas/IntegrationWifiOpenSecurityConfigurationDetailDto", "WPA2_PERSONAL": "#/components/schemas/IntegrationWifiWpa2PersonalSecurityConfigurationDetailDto", "WPA3_PERSONAL": "#/components/schemas/IntegrationWifiWpa3PersonalSecurityConfigurationDetailDto", "WPA2_WPA3_PERSONAL": "#/components/schemas/IntegrationWifiWpa2Wpa3PersonalSecurityConfigurationDetailDto", "WPA2_ENTERPRISE": "#/components/schemas/IntegrationWifiWpa2EnterpriseSecurityConfigurationDetailDto", "WPA3_ENTERPRISE": "#/components/schemas/IntegrationWifiWpa3EnterpriseSecurityConfigurationDetailDto", "WPA2_WPA3_ENTERPRISE": "#/components/schemas/IntegrationWifiWpa2Wpa3EnterpriseSecurityConfigurationDetailDto"}}, "properties": {"type": {"type": "string"}, "radiusConfiguration": {}}, "required": ["type"], "title": "Wifi security configuration detailObject"}, {"type": "object", "properties": {"groupRekeyIntervalSeconds": {"type": "integer", "format": "int32", "description": "Group rekey interval in seconds. Sets how often connected device groups are assigned a new key. If null, then it is disabled. This feature is not available for IoT configuration.", "maximum": 86400, "minimum": 1}, "fastRoamingEnabled": {"type": "boolean", "description": "Fast roaming enabled flag. This feature is not available for IoT configuration."}, "radiusConfiguration": {"properties": {"profileId": {"type": "string", "format": "uuid"}, "nasId": {"discriminator": {"propertyName": "type", "mapping": {"DERIVED": "#/components/schemas/IntegrationWifiDerivedNasIdDto", "USER_DEFINED": "#/components/schemas/IntegrationWifiUserDefinedNasIdDto"}}, "properties": {"type": {"type": "string"}}, "required": ["type"], "title": "Wifi Radius NAS ID configuration"}, "macAuthenticationConfiguration": {"properties": {"macAddressFormat": {"type": "string", "enum": ["UPPERCASE_NOT_SEPARATED", "UPPERCASE_DASH_SEPARATED", "UPPERCASE_COLON_SEPARATED", "LOWERCASE_NOT_SEPARATED", "LOWERCASE_COLON_SEPARATED", "LOWERCASE_DASH_SEPARATED"]}}, "required": ["macAddressFormat"], "title": "IntegrationWifiRadiusMacAuthenticationConfigurationDto"}}, "required": ["nasId", "profileId"], "title": "IntegrationWifiEnterpriseRadiusConfigurationDto"}, "coaEnabled": {"type": "boolean", "description": "Indicates whether Change of Authorization (COA) is enabled"}, "pmfMode": {"type": "string", "description": "Protected Management Frames mode. If null, then it is disabled. This feature is not available for IoT configuration.", "enum": ["REQUIRED", "OPTIONAL"]}}}], "required": ["coaEnabled", "radiusConfiguration"]}, "IntegrationWifiWpa2PersonalSecurityConfigurationDetailDto": {"allOf": [{"discriminator": {"propertyName": "type", "mapping": {"OPEN": "#/components/schemas/IntegrationWifiOpenSecurityConfigurationDetailDto", "WPA2_PERSONAL": "#/components/schemas/IntegrationWifiWpa2PersonalSecurityConfigurationDetailDto", "WPA3_PERSONAL": "#/components/schemas/IntegrationWifiWpa3PersonalSecurityConfigurationDetailDto", "WPA2_WPA3_PERSONAL": "#/components/schemas/IntegrationWifiWpa2Wpa3PersonalSecurityConfigurationDetailDto", "WPA2_ENTERPRISE": "#/components/schemas/IntegrationWifiWpa2EnterpriseSecurityConfigurationDetailDto", "WPA3_ENTERPRISE": "#/components/schemas/IntegrationWifiWpa3EnterpriseSecurityConfigurationDetailDto", "WPA2_WPA3_ENTERPRISE": "#/components/schemas/IntegrationWifiWpa2Wpa3EnterpriseSecurityConfigurationDetailDto"}}, "properties": {"type": {"type": "string"}, "radiusConfiguration": {}}, "required": ["type"], "title": "Wifi security configuration detailObject"}, {"type": "object", "properties": {"groupRekeyIntervalSeconds": {"type": "integer", "format": "int32", "description": "Group rekey interval in seconds. Sets how often connected device groups are assigned a new key. If null, then it is disabled. This feature is not available for IoT configuration.", "maximum": 86400, "minimum": 1}, "fastRoamingEnabled": {"type": "boolean", "description": "Fast roaming enabled flag. This feature is not available for IoT configuration."}, "radiusConfiguration": {"properties": {"profileId": {"type": "string", "format": "uuid"}, "nasId": {"discriminator": {"propertyName": "type", "mapping": {"DERIVED": "#/components/schemas/IntegrationWifiDerivedNasIdDto", "USER_DEFINED": "#/components/schemas/IntegrationWifiUserDefinedNasIdDto"}}, "properties": {"type": {"type": "string"}}, "required": ["type"], "title": "Wifi Radius NAS ID configuration"}, "macAuthenticationConfiguration": {"properties": {"macAddressFormat": {"type": "string", "enum": ["UPPERCASE_NOT_SEPARATED", "UPPERCASE_DASH_SEPARATED", "UPPERCASE_COLON_SEPARATED", "LOWERCASE_NOT_SEPARATED", "LOWERCASE_COLON_SEPARATED", "LOWERCASE_DASH_SEPARATED"]}}, "required": ["macAddressFormat"], "title": "IntegrationWifiRadiusMacAuthenticationConfigurationDto"}}, "required": ["macAuthenticationConfiguration", "nasId", "profileId"], "title": "IntegrationWifiNonEnterpriseRadiusConfigurationDto"}, "passphrase": {"type": "string", "maxLength": 63, "minLength": 8}, "presharedKeys": {"type": "array", "items": {"properties": {"network": {"discriminator": {"propertyName": "type", "mapping": {"NATIVE": "#/components/schemas/IntegrationWifiNativeNetworkDto", "SPECIFIC": "#/components/schemas/IntegrationWifiSpecificNetworkDto"}}, "properties": {"type": {"type": "string"}}, "required": ["type"], "title": "Wifi network reference"}, "passphrase": {"type": "string"}}, "required": ["network", "passphrase"], "title": "IntegrationWifiPresharedKeyDto"}, "minItems": 1}, "pmfMode": {"type": "string", "description": "Protected Management Frames mode. If null, then it is disabled. This feature is not available for IoT configuration.", "enum": ["REQUIRED", "OPTIONAL"]}}}]}, "IntegrationWifiWpa2Wpa3EnterpriseSecurityConfigurationDetailDto": {"allOf": [{"discriminator": {"propertyName": "type", "mapping": {"OPEN": "#/components/schemas/IntegrationWifiOpenSecurityConfigurationDetailDto", "WPA2_PERSONAL": "#/components/schemas/IntegrationWifiWpa2PersonalSecurityConfigurationDetailDto", "WPA3_PERSONAL": "#/components/schemas/IntegrationWifiWpa3PersonalSecurityConfigurationDetailDto", "WPA2_WPA3_PERSONAL": "#/components/schemas/IntegrationWifiWpa2Wpa3PersonalSecurityConfigurationDetailDto", "WPA2_ENTERPRISE": "#/components/schemas/IntegrationWifiWpa2EnterpriseSecurityConfigurationDetailDto", "WPA3_ENTERPRISE": "#/components/schemas/IntegrationWifiWpa3EnterpriseSecurityConfigurationDetailDto", "WPA2_WPA3_ENTERPRISE": "#/components/schemas/IntegrationWifiWpa2Wpa3EnterpriseSecurityConfigurationDetailDto"}}, "properties": {"type": {"type": "string"}, "radiusConfiguration": {}}, "required": ["type"], "title": "Wifi security configuration detailObject"}, {"type": "object", "properties": {"groupRekeyIntervalSeconds": {"type": "integer", "format": "int32", "description": "Group rekey interval in seconds. Sets how often connected device groups are assigned a new key. If null, then it is disabled. This feature is not available for IoT configuration.", "maximum": 86400, "minimum": 1}, "fastRoamingEnabled": {"type": "boolean", "description": "Fast roaming enabled flag. This feature is not available for IoT configuration."}, "radiusConfiguration": {"properties": {"profileId": {"type": "string", "format": "uuid"}, "nasId": {"discriminator": {"propertyName": "type", "mapping": {"DERIVED": "#/components/schemas/IntegrationWifiDerivedNasIdDto", "USER_DEFINED": "#/components/schemas/IntegrationWifiUserDefinedNasIdDto"}}, "properties": {"type": {"type": "string"}}, "required": ["type"], "title": "Wifi Radius NAS ID configuration"}, "macAuthenticationConfiguration": {"properties": {"macAddressFormat": {"type": "string", "enum": ["UPPERCASE_NOT_SEPARATED", "UPPERCASE_DASH_SEPARATED", "UPPERCASE_COLON_SEPARATED", "LOWERCASE_NOT_SEPARATED", "LOWERCASE_COLON_SEPARATED", "LOWERCASE_DASH_SEPARATED"]}}, "required": ["macAddressFormat"], "title": "IntegrationWifiRadiusMacAuthenticationConfigurationDto"}}, "required": ["nasId", "profileId"], "title": "IntegrationWifiEnterpriseRadiusConfigurationDto"}, "coaEnabled": {"type": "boolean", "description": "Indicates whether Change of Authorization (COA) is enabled"}, "pmfMode": {"type": "string", "description": "Protected Management Frames mode. If null, then it is disabled. This feature is not available for IoT configuration.", "enum": ["REQUIRED", "OPTIONAL"]}, "wpa3FastRoamingEnabled": {"type": "boolean", "description": "WPA3 fast roaming can be enabled only if the default fast roaming is enabled"}}}], "required": ["coaEnabled", "pmfMode", "radiusConfiguration", "wpa3FastRoamingEnabled"]}, "IntegrationWifiWpa2Wpa3PersonalSecurityConfigurationDetailDto": {"allOf": [{"discriminator": {"propertyName": "type", "mapping": {"OPEN": "#/components/schemas/IntegrationWifiOpenSecurityConfigurationDetailDto", "WPA2_PERSONAL": "#/components/schemas/IntegrationWifiWpa2PersonalSecurityConfigurationDetailDto", "WPA3_PERSONAL": "#/components/schemas/IntegrationWifiWpa3PersonalSecurityConfigurationDetailDto", "WPA2_WPA3_PERSONAL": "#/components/schemas/IntegrationWifiWpa2Wpa3PersonalSecurityConfigurationDetailDto", "WPA2_ENTERPRISE": "#/components/schemas/IntegrationWifiWpa2EnterpriseSecurityConfigurationDetailDto", "WPA3_ENTERPRISE": "#/components/schemas/IntegrationWifiWpa3EnterpriseSecurityConfigurationDetailDto", "WPA2_WPA3_ENTERPRISE": "#/components/schemas/IntegrationWifiWpa2Wpa3EnterpriseSecurityConfigurationDetailDto"}}, "properties": {"type": {"type": "string"}, "radiusConfiguration": {}}, "required": ["type"], "title": "Wifi security configuration detailObject"}, {"type": "object", "properties": {"groupRekeyIntervalSeconds": {"type": "integer", "format": "int32", "description": "Group rekey interval in seconds. Sets how often connected device groups are assigned a new key. If null, then it is disabled. This feature is not available for IoT configuration.", "maximum": 86400, "minimum": 1}, "fastRoamingEnabled": {"type": "boolean", "description": "Fast roaming enabled flag. This feature is not available for IoT configuration."}, "radiusConfiguration": {"properties": {"profileId": {"type": "string", "format": "uuid"}, "nasId": {"discriminator": {"propertyName": "type", "mapping": {"DERIVED": "#/components/schemas/IntegrationWifiDerivedNasIdDto", "USER_DEFINED": "#/components/schemas/IntegrationWifiUserDefinedNasIdDto"}}, "properties": {"type": {"type": "string"}}, "required": ["type"], "title": "Wifi Radius NAS ID configuration"}, "macAuthenticationConfiguration": {"properties": {"macAddressFormat": {"type": "string", "enum": ["UPPERCASE_NOT_SEPARATED", "UPPERCASE_DASH_SEPARATED", "UPPERCASE_COLON_SEPARATED", "LOWERCASE_NOT_SEPARATED", "LOWERCASE_COLON_SEPARATED", "LOWERCASE_DASH_SEPARATED"]}}, "required": ["macAddressFormat"], "title": "IntegrationWifiRadiusMacAuthenticationConfigurationDto"}}, "required": ["macAuthenticationConfiguration", "nasId", "profileId"], "title": "IntegrationWifiNonEnterpriseRadiusConfigurationDto"}, "passphrase": {"type": "string", "maxLength": 63, "minLength": 8}, "pmfMode": {"type": "string", "description": "Protected Management Frames mode. If null, then it is disabled. This feature is not available for IoT configuration.", "enum": ["REQUIRED", "OPTIONAL"]}, "saeConfiguration": {"description": "Configuration for SAE (Simultaneous Authentication of Equals).", "properties": {"anticloggingThresholdSeconds": {"type": "integer", "format": "int32", "maximum": 60, "minimum": 1}, "syncTimeSeconds": {"type": "integer", "format": "int32", "maximum": 60, "minimum": 1}}, "required": ["anticloggingThresholdSeconds", "syncTimeSeconds"], "title": "IntegrationWifiSaeConfigurationDto"}, "wpa3FastRoamingEnabled": {"type": "boolean", "description": "WPA3 fast roaming can be enabled only if the default fast roaming is enabled"}}}], "required": ["passphrase", "pmfMode", "saeConfiguration", "wpa3FastRoamingEnabled"]}, "IntegrationWifiWpa3EnterpriseSecurityConfigurationDetailDto": {"allOf": [{"discriminator": {"propertyName": "type", "mapping": {"OPEN": "#/components/schemas/IntegrationWifiOpenSecurityConfigurationDetailDto", "WPA2_PERSONAL": "#/components/schemas/IntegrationWifiWpa2PersonalSecurityConfigurationDetailDto", "WPA3_PERSONAL": "#/components/schemas/IntegrationWifiWpa3PersonalSecurityConfigurationDetailDto", "WPA2_WPA3_PERSONAL": "#/components/schemas/IntegrationWifiWpa2Wpa3PersonalSecurityConfigurationDetailDto", "WPA2_ENTERPRISE": "#/components/schemas/IntegrationWifiWpa2EnterpriseSecurityConfigurationDetailDto", "WPA3_ENTERPRISE": "#/components/schemas/IntegrationWifiWpa3EnterpriseSecurityConfigurationDetailDto", "WPA2_WPA3_ENTERPRISE": "#/components/schemas/IntegrationWifiWpa2Wpa3EnterpriseSecurityConfigurationDetailDto"}}, "properties": {"type": {"type": "string"}, "radiusConfiguration": {}}, "required": ["type"], "title": "Wifi security configuration detailObject"}, {"type": "object", "properties": {"groupRekeyIntervalSeconds": {"type": "integer", "format": "int32", "description": "Group rekey interval in seconds. Sets how often connected device groups are assigned a new key. If null, then it is disabled. This feature is not available for IoT configuration.", "maximum": 86400, "minimum": 1}, "fastRoamingEnabled": {"type": "boolean", "description": "Fast roaming enabled flag. This feature is not available for IoT configuration."}, "radiusConfiguration": {"properties": {"profileId": {"type": "string", "format": "uuid"}, "nasId": {"discriminator": {"propertyName": "type", "mapping": {"DERIVED": "#/components/schemas/IntegrationWifiDerivedNasIdDto", "USER_DEFINED": "#/components/schemas/IntegrationWifiUserDefinedNasIdDto"}}, "properties": {"type": {"type": "string"}}, "required": ["type"], "title": "Wifi Radius NAS ID configuration"}, "macAuthenticationConfiguration": {"properties": {"macAddressFormat": {"type": "string", "enum": ["UPPERCASE_NOT_SEPARATED", "UPPERCASE_DASH_SEPARATED", "UPPERCASE_COLON_SEPARATED", "LOWERCASE_NOT_SEPARATED", "LOWERCASE_COLON_SEPARATED", "LOWERCASE_DASH_SEPARATED"]}}, "required": ["macAddressFormat"], "title": "IntegrationWifiRadiusMacAuthenticationConfigurationDto"}}, "required": ["nasId", "profileId"], "title": "IntegrationWifiEnterpriseRadiusConfigurationDto"}, "coaEnabled": {"type": "boolean", "description": "Indicates whether Change of Authorization (COA) is enabled"}, "securityMode": {"type": "string", "enum": ["DEFAULT", "HIGH_SECURITY_192_BIT"]}}}], "required": ["coaEnabled", "radiusConfiguration", "securityMode"]}, "IntegrationWifiWpa3PersonalSecurityConfigurationDetailDto": {"allOf": [{"discriminator": {"propertyName": "type", "mapping": {"OPEN": "#/components/schemas/IntegrationWifiOpenSecurityConfigurationDetailDto", "WPA2_PERSONAL": "#/components/schemas/IntegrationWifiWpa2PersonalSecurityConfigurationDetailDto", "WPA3_PERSONAL": "#/components/schemas/IntegrationWifiWpa3PersonalSecurityConfigurationDetailDto", "WPA2_WPA3_PERSONAL": "#/components/schemas/IntegrationWifiWpa2Wpa3PersonalSecurityConfigurationDetailDto", "WPA2_ENTERPRISE": "#/components/schemas/IntegrationWifiWpa2EnterpriseSecurityConfigurationDetailDto", "WPA3_ENTERPRISE": "#/components/schemas/IntegrationWifiWpa3EnterpriseSecurityConfigurationDetailDto", "WPA2_WPA3_ENTERPRISE": "#/components/schemas/IntegrationWifiWpa2Wpa3EnterpriseSecurityConfigurationDetailDto"}}, "properties": {"type": {"type": "string"}, "radiusConfiguration": {}}, "required": ["type"], "title": "Wifi security configuration detailObject"}, {"type": "object", "properties": {"groupRekeyIntervalSeconds": {"type": "integer", "format": "int32", "description": "Group rekey interval in seconds. Sets how often connected device groups are assigned a new key. If null, then it is disabled. This feature is not available for IoT configuration.", "maximum": 86400, "minimum": 1}, "fastRoamingEnabled": {"type": "boolean", "description": "Fast roaming enabled flag. This feature is not available for IoT configuration."}, "radiusConfiguration": {"properties": {"profileId": {"type": "string", "format": "uuid"}, "nasId": {"discriminator": {"propertyName": "type", "mapping": {"DERIVED": "#/components/schemas/IntegrationWifiDerivedNasIdDto", "USER_DEFINED": "#/components/schemas/IntegrationWifiUserDefinedNasIdDto"}}, "properties": {"type": {"type": "string"}}, "required": ["type"], "title": "Wifi Radius NAS ID configuration"}, "macAuthenticationConfiguration": {"properties": {"macAddressFormat": {"type": "string", "enum": ["UPPERCASE_NOT_SEPARATED", "UPPERCASE_DASH_SEPARATED", "UPPERCASE_COLON_SEPARATED", "LOWERCASE_NOT_SEPARATED", "LOWERCASE_COLON_SEPARATED", "LOWERCASE_DASH_SEPARATED"]}}, "required": ["macAddressFormat"], "title": "IntegrationWifiRadiusMacAuthenticationConfigurationDto"}}, "required": ["macAuthenticationConfiguration", "nasId", "profileId"], "title": "IntegrationWifiNonEnterpriseRadiusConfigurationDto"}, "passphrase": {"type": "string", "maxLength": 63, "minLength": 8}, "saeConfiguration": {"description": "Configuration for SAE (Simultaneous Authentication of Equals).", "properties": {"anticloggingThresholdSeconds": {"type": "integer", "format": "int32", "maximum": 60, "minimum": 1}, "syncTimeSeconds": {"type": "integer", "format": "int32", "maximum": 60, "minimum": 1}}, "required": ["anticloggingThresholdSeconds", "syncTimeSeconds"], "title": "IntegrationWifiSaeConfigurationDto"}}}], "required": ["passphrase", "saeConfiguration"]}, "Multicast filtering policy": {"discriminator": {"propertyName": "action", "mapping": {"ALLOW": "#/components/schemas/IntegrationWifiMulticastFilteringAllowPolicyDto", "BLOCK": "#/components/schemas/IntegrationWifiMulticastFilteringBlockPolicyDto"}}, "properties": {"action": {"type": "string"}}, "required": ["action"]}, "Wifi Radius NAS ID configuration": {"discriminator": {"propertyName": "type", "mapping": {"DERIVED": "#/components/schemas/IntegrationWifiDerivedNasIdDto", "USER_DEFINED": "#/components/schemas/IntegrationWifiUserDefinedNasIdDto"}}, "properties": {"type": {"type": "string"}}, "required": ["type"]}, "Wifi broadcast create or update": {"discriminator": {"propertyName": "type", "mapping": {"STANDARD": "#/components/schemas/IntegrationStandardWifiBroadcastCreateUpdateDto", "IOT_OPTIMIZED": "#/components/schemas/IntegrationIotOptimizedWifiBroadcastCreateUpdateDto"}}, "properties": {"type": {"type": "string"}, "name": {"type": "string"}, "network": {"discriminator": {"propertyName": "type", "mapping": {"NATIVE": "#/components/schemas/IntegrationWifiNativeNetworkDto", "SPECIFIC": "#/components/schemas/IntegrationWifiSpecificNetworkDto"}}, "properties": {"type": {"type": "string"}}, "required": ["type"], "title": "Wifi network reference"}, "enabled": {"type": "boolean"}, "securityConfiguration": {"discriminator": {"propertyName": "type", "mapping": {"OPEN": "#/components/schemas/IntegrationWifiOpenSecurityConfigurationDetailDto", "WPA2_PERSONAL": "#/components/schemas/IntegrationWifiWpa2PersonalSecurityConfigurationDetailDto", "WPA3_PERSONAL": "#/components/schemas/IntegrationWifiWpa3PersonalSecurityConfigurationDetailDto", "WPA2_WPA3_PERSONAL": "#/components/schemas/IntegrationWifiWpa2Wpa3PersonalSecurityConfigurationDetailDto", "WPA2_ENTERPRISE": "#/components/schemas/IntegrationWifiWpa2EnterpriseSecurityConfigurationDetailDto", "WPA3_ENTERPRISE": "#/components/schemas/IntegrationWifiWpa3EnterpriseSecurityConfigurationDetailDto", "WPA2_WPA3_ENTERPRISE": "#/components/schemas/IntegrationWifiWpa2Wpa3EnterpriseSecurityConfigurationDetailDto"}}, "properties": {"type": {"type": "string"}, "radiusConfiguration": {}}, "required": ["type"], "title": "Wifi security configuration detailObject"}, "broadcastingDeviceFilter": {"description": "Defines the custom scope of devices that will broadcast this WiFi network. If null, the WiFi network will be broadcast by all Access Point capable devices.", "discriminator": {"propertyName": "type", "mapping": {"DEVICES": "#/components/schemas/IntegrationWifiDevicesFilterDto", "DEVICE_TAGS": "#/components/schemas/IntegrationWifiDeviceTagsFilterDto"}}, "properties": {"type": {"type": "string"}}, "required": ["type"], "title": "Broadcasting device filter"}, "mdnsProxyConfiguration": {"discriminator": {"propertyName": "mode", "mapping": {"AUTO": "#/components/schemas/IntegrationWifiMdnsProxyAutoConfigurationDto", "CUSTOM": "#/components/schemas/IntegrationWifiMdnsProxyCustomConfigurationDto"}}, "properties": {"mode": {"type": "string"}}, "required": ["mode"], "title": "mDNS filtering configuration"}, "multicastFilteringPolicy": {"discriminator": {"propertyName": "action", "mapping": {"ALLOW": "#/components/schemas/IntegrationWifiMulticastFilteringAllowPolicyDto", "BLOCK": "#/components/schemas/IntegrationWifiMulticastFilteringBlockPolicyDto"}}, "properties": {"action": {"type": "string"}}, "required": ["action"], "title": "Multicast filtering policy"}, "multicastToUnicastConversionEnabled": {"type": "boolean"}, "clientIsolationEnabled": {"type": "boolean"}, "hideName": {"type": "boolean"}, "uapsdEnabled": {"type": "boolean", "description": "Indicates whether Unscheduled Automatic Power Save Delivery (U-APSD) is enabled"}, "basicDataRateKbpsByFrequencyGHz": {"properties": {"5": {"type": "integer", "format": "int32", "enum": ["6000", "9000", "12000", "24000"], "example": 6000}, "2.4": {"type": "integer", "format": "int32", "enum": ["1000", "2000", "5500", "6000", "9000", "11000", "12000", "24000"], "example": 2000}}, "required": ["2.4", "5"], "title": "IntegrationWifiBasicDataRateConfigurationDto"}, "clientFilteringPolicy": {"description": "Client connection filtering policy. Allow/restrict access to the WiFi network based on client device MAC addresses.", "properties": {"action": {"type": "string", "enum": ["ALLOW", "BLOCK"]}, "macAddressFilter": {"type": "array", "items": {"type": "string"}, "maxItems": 512, "minItems": 1, "uniqueItems": true}}, "required": ["action", "macAddressFilter"], "title": "IntegrationWifiClientFilteringPolicyDto"}, "blackoutScheduleConfiguration": {"properties": {"days": {"type": "array", "items": {"discriminator": {"propertyName": "type", "mapping": {"ALL_DAY": "#/components/schemas/IntegrationWifiBlackoutScheduleConfigurationPerAllDayDto", "TIME_RANGE": "#/components/schemas/IntegrationWifiBlackoutScheduleConfigurationPerDayWithTimeRangeDto"}}, "properties": {"type": {"type": "string"}, "day": {"type": "string", "enum": ["SUN", "MON", "TUE", "WED", "THU", "FRI", "SAT"]}}, "required": ["day", "type"], "title": "Blackout schedule configuration per day"}, "minItems": 1}}, "required": ["days"], "title": "Integration blackout schedule configuration"}}, "required": ["clientIsolationEnabled", "enabled", "hideName", "multicastToUnicastConversionEnabled", "name", "securityConfiguration", "type", "uapsdEnabled"]}, "Wifi hotspot configuration": {"discriminator": {"propertyName": "type", "mapping": {"CAPTIVE_PORTAL": "#/components/schemas/IntegrationWifiCaptivePortalConfigurationDetailDto", "PASSPOINT": "#/components/schemas/IntegrationWifiPasspointConfigurationDetailDto"}}, "properties": {"type": {"type": "string"}}, "required": ["type"]}, "Wifi network reference": {"discriminator": {"propertyName": "type", "mapping": {"NATIVE": "#/components/schemas/IntegrationWifiNativeNetworkDto", "SPECIFIC": "#/components/schemas/IntegrationWifiSpecificNetworkDto"}}, "properties": {"type": {"type": "string"}}, "required": ["type"]}, "Wifi security configuration detailObject": {"discriminator": {"propertyName": "type", "mapping": {"OPEN": "#/components/schemas/IntegrationWifiOpenSecurityConfigurationDetailDto", "WPA2_PERSONAL": "#/components/schemas/IntegrationWifiWpa2PersonalSecurityConfigurationDetailDto", "WPA3_PERSONAL": "#/components/schemas/IntegrationWifiWpa3PersonalSecurityConfigurationDetailDto", "WPA2_WPA3_PERSONAL": "#/components/schemas/IntegrationWifiWpa2Wpa3PersonalSecurityConfigurationDetailDto", "WPA2_ENTERPRISE": "#/components/schemas/IntegrationWifiWpa2EnterpriseSecurityConfigurationDetailDto", "WPA3_ENTERPRISE": "#/components/schemas/IntegrationWifiWpa3EnterpriseSecurityConfigurationDetailDto", "WPA2_WPA3_ENTERPRISE": "#/components/schemas/IntegrationWifiWpa2Wpa3EnterpriseSecurityConfigurationDetailDto"}}, "properties": {"type": {"type": "string"}, "radiusConfiguration": {}}, "required": ["type"]}, "mDNS filtering configuration": {"discriminator": {"propertyName": "mode", "mapping": {"AUTO": "#/components/schemas/IntegrationWifiMdnsProxyAutoConfigurationDto", "CUSTOM": "#/components/schemas/IntegrationWifiMdnsProxyCustomConfigurationDto"}}, "properties": {"mode": {"type": "string"}}, "required": ["mode"]}, "mDNS proxy policy": {"discriminator": {"propertyName": "action", "mapping": {"ALLOW": "#/components/schemas/IntegrationWifiMdnsProxyAllowPolicyDto", "BLOCK": "#/components/schemas/IntegrationWifiMdnsProxyBlockPolicyDto"}}, "properties": {"action": {"type": "string"}, "deviceFilter": {"description": "Defines the custom scope of devices that will filter Mdns. If null, the mDNS filtering will be added to all Access Point capable devices.", "discriminator": {"propertyName": "type", "mapping": {"DEVICES": "#/components/schemas/IntegrationWifiDevicesFilterDto", "DEVICE_TAGS": "#/components/schemas/IntegrationWifiDeviceTagsFilterDto"}}, "properties": {"type": {"type": "string"}}, "required": ["type"], "title": "Broadcasting device filter"}}, "required": ["action"]}, "mDNS service": {"discriminator": {"propertyName": "type", "mapping": {"PREDEFINED": "#/components/schemas/IntegrationWifiMdnsProxyPredefinedServiceDto", "CUSTOM": "#/components/schemas/IntegrationWifiMdnsProxyCustomServiceDto"}}, "properties": {"type": {"type": "string"}}, "required": ["type"]}, "Derived entity metadata": {"allOf": [{"discriminator": {"propertyName": "origin", "mapping": {"USER_DEFINED": "#/components/schemas/User defined entity metadata", "SYSTEM_DEFINED": "#/components/schemas/System defined entity metadata", "DERIVED": "#/components/schemas/Derived entity metadata", "ORCHESTRATED": "#/components/schemas/Orchestrated entity metadata"}}, "properties": {"origin": {"type": "string"}}, "required": ["origin"], "title": "Entity metadata"}, {"discriminator": {"propertyName": "origin", "mapping": {"USER_DEFINED": "#/components/schemas/User defined entity metadata", "DERIVED": "#/components/schemas/Derived entity metadata"}}, "properties": {"origin": {"type": "string"}}, "required": ["origin"], "title": "User defined or derived entity metadata"}, {"discriminator": {"propertyName": "origin", "mapping": {"USER_DEFINED": "#/components/schemas/User defined entity metadata", "DERIVED": "#/components/schemas/Derived entity metadata", "ORCHESTRATED": "#/components/schemas/Orchestrated entity metadata"}}, "properties": {"origin": {"type": "string"}}, "required": ["origin"], "title": "User or derived or orchestrated entity metadata"}]}, "Entity metadata": {"discriminator": {"propertyName": "origin", "mapping": {"USER_DEFINED": "#/components/schemas/User defined entity metadata", "SYSTEM_DEFINED": "#/components/schemas/System defined entity metadata", "DERIVED": "#/components/schemas/Derived entity metadata", "ORCHESTRATED": "#/components/schemas/Orchestrated entity metadata"}}, "properties": {"origin": {"type": "string"}}, "required": ["origin"]}, "IntegrationDerivedSiteToSiteTunnelMetadata": {"allOf": [{"discriminator": {"propertyName": "origin", "mapping": {"USER_DEFINED": "#/components/schemas/User defined entity metadata", "DERIVED": "#/components/schemas/IntegrationDerivedSiteToSiteTunnelMetadata"}}, "properties": {"origin": {"type": "string"}}, "required": ["origin"], "title": "Site-to-site VPN tunnel metadata"}, {"type": "object", "properties": {"source": {"type": "string", "enum": ["SDWAN"]}}}], "required": ["source"]}, "IntegrationIotOptimizedWifiBroadcastDetailDto": {"allOf": [{"discriminator": {"propertyName": "type", "mapping": {"STANDARD": "#/components/schemas/IntegrationStandardWifiBroadcastDetailDto", "IOT_OPTIMIZED": "#/components/schemas/IntegrationIotOptimizedWifiBroadcastDetailDto"}}, "properties": {"type": {"type": "string"}, "id": {"type": "string", "format": "uuid"}, "name": {"type": "string"}, "metadata": {"discriminator": {"propertyName": "origin", "mapping": {"USER_DEFINED": "#/components/schemas/User defined entity metadata", "DERIVED": "#/components/schemas/Derived entity metadata", "ORCHESTRATED": "#/components/schemas/Orchestrated entity metadata"}}, "properties": {"origin": {"type": "string"}}, "required": ["origin"], "title": "User or derived or orchestrated entity metadata"}, "enabled": {"type": "boolean"}, "network": {"discriminator": {"propertyName": "type", "mapping": {"NATIVE": "#/components/schemas/IntegrationWifiNativeNetworkDto", "SPECIFIC": "#/components/schemas/IntegrationWifiSpecificNetworkDto"}}, "properties": {"type": {"type": "string"}}, "required": ["type"], "title": "Wifi network reference"}, "securityConfiguration": {"discriminator": {"propertyName": "type", "mapping": {"OPEN": "#/components/schemas/IntegrationWifiOpenSecurityConfigurationDetailDto", "WPA2_PERSONAL": "#/components/schemas/IntegrationWifiWpa2PersonalSecurityConfigurationDetailDto", "WPA3_PERSONAL": "#/components/schemas/IntegrationWifiWpa3PersonalSecurityConfigurationDetailDto", "WPA2_WPA3_PERSONAL": "#/components/schemas/IntegrationWifiWpa2Wpa3PersonalSecurityConfigurationDetailDto", "WPA2_ENTERPRISE": "#/components/schemas/IntegrationWifiWpa2EnterpriseSecurityConfigurationDetailDto", "WPA3_ENTERPRISE": "#/components/schemas/IntegrationWifiWpa3EnterpriseSecurityConfigurationDetailDto", "WPA2_WPA3_ENTERPRISE": "#/components/schemas/IntegrationWifiWpa2Wpa3EnterpriseSecurityConfigurationDetailDto"}}, "properties": {"type": {"type": "string"}, "radiusConfiguration": {}}, "required": ["type"], "title": "Wifi security configuration detailObject"}, "broadcastingDeviceFilter": {"description": "Defines the custom scope of devices that will broadcast this WiFi network. If null, the WiFi network will be broadcast by all Access Point capable devices.", "discriminator": {"propertyName": "type", "mapping": {"DEVICES": "#/components/schemas/IntegrationWifiDevicesFilterDto", "DEVICE_TAGS": "#/components/schemas/IntegrationWifiDeviceTagsFilterDto"}}, "properties": {"type": {"type": "string"}}, "required": ["type"], "title": "Broadcasting device filter"}, "mdnsProxyConfiguration": {"discriminator": {"propertyName": "mode", "mapping": {"AUTO": "#/components/schemas/IntegrationWifiMdnsProxyAutoConfigurationDto", "CUSTOM": "#/components/schemas/IntegrationWifiMdnsProxyCustomConfigurationDto"}}, "properties": {"mode": {"type": "string"}}, "required": ["mode"], "title": "mDNS filtering configuration"}, "multicastFilteringPolicy": {"discriminator": {"propertyName": "action", "mapping": {"ALLOW": "#/components/schemas/IntegrationWifiMulticastFilteringAllowPolicyDto", "BLOCK": "#/components/schemas/IntegrationWifiMulticastFilteringBlockPolicyDto"}}, "properties": {"action": {"type": "string"}}, "required": ["action"], "title": "Multicast filtering policy"}, "multicastToUnicastConversionEnabled": {"type": "boolean"}, "clientIsolationEnabled": {"type": "boolean"}, "hideName": {"type": "boolean"}, "uapsdEnabled": {"type": "boolean", "description": "Indicates whether Unscheduled Automatic Power Save Delivery (U-APSD) is enabled"}, "basicDataRateKbpsByFrequencyGHz": {"properties": {"5": {"type": "integer", "format": "int32", "enum": ["6000", "9000", "12000", "24000"], "example": 6000}, "2.4": {"type": "integer", "format": "int32", "enum": ["1000", "2000", "5500", "6000", "9000", "11000", "12000", "24000"], "example": 2000}}, "required": ["2.4", "5"], "title": "IntegrationWifiBasicDataRateConfigurationDto"}, "clientFilteringPolicy": {"description": "Client connection filtering policy. Allow/restrict access to the WiFi network based on client device MAC addresses.", "properties": {"action": {"type": "string", "enum": ["ALLOW", "BLOCK"]}, "macAddressFilter": {"type": "array", "items": {"type": "string"}, "maxItems": 512, "minItems": 1, "uniqueItems": true}}, "required": ["action", "macAddressFilter"], "title": "IntegrationWifiClientFilteringPolicyDto"}, "blackoutScheduleConfiguration": {"properties": {"days": {"type": "array", "items": {"discriminator": {"propertyName": "type", "mapping": {"ALL_DAY": "#/components/schemas/IntegrationWifiBlackoutScheduleConfigurationPerAllDayDto", "TIME_RANGE": "#/components/schemas/IntegrationWifiBlackoutScheduleConfigurationPerDayWithTimeRangeDto"}}, "properties": {"type": {"type": "string"}, "day": {"type": "string", "enum": ["SUN", "MON", "TUE", "WED", "THU", "FRI", "SAT"]}}, "required": ["day", "type"], "title": "Blackout schedule configuration per day"}, "minItems": 1}}, "required": ["days"], "title": "Integration blackout schedule configuration"}}, "required": ["clientIsolationEnabled", "enabled", "hideName", "id", "metadata", "multicastToUnicastConversionEnabled", "name", "securityConfiguration", "type", "uapsdEnabled"], "title": "Wifi broadcast details"}], "required": ["clientIsolationEnabled", "enabled", "hideName", "id", "metadata", "multicastToUnicastConversionEnabled", "name", "securityConfiguration", "uapsdEnabled"]}, "IntegrationStandardWifiBroadcastDetailDto": {"allOf": [{"discriminator": {"propertyName": "type", "mapping": {"STANDARD": "#/components/schemas/IntegrationStandardWifiBroadcastDetailDto", "IOT_OPTIMIZED": "#/components/schemas/IntegrationIotOptimizedWifiBroadcastDetailDto"}}, "properties": {"type": {"type": "string"}, "id": {"type": "string", "format": "uuid"}, "name": {"type": "string"}, "metadata": {"discriminator": {"propertyName": "origin", "mapping": {"USER_DEFINED": "#/components/schemas/User defined entity metadata", "DERIVED": "#/components/schemas/Derived entity metadata", "ORCHESTRATED": "#/components/schemas/Orchestrated entity metadata"}}, "properties": {"origin": {"type": "string"}}, "required": ["origin"], "title": "User or derived or orchestrated entity metadata"}, "enabled": {"type": "boolean"}, "network": {"discriminator": {"propertyName": "type", "mapping": {"NATIVE": "#/components/schemas/IntegrationWifiNativeNetworkDto", "SPECIFIC": "#/components/schemas/IntegrationWifiSpecificNetworkDto"}}, "properties": {"type": {"type": "string"}}, "required": ["type"], "title": "Wifi network reference"}, "securityConfiguration": {"discriminator": {"propertyName": "type", "mapping": {"OPEN": "#/components/schemas/IntegrationWifiOpenSecurityConfigurationDetailDto", "WPA2_PERSONAL": "#/components/schemas/IntegrationWifiWpa2PersonalSecurityConfigurationDetailDto", "WPA3_PERSONAL": "#/components/schemas/IntegrationWifiWpa3PersonalSecurityConfigurationDetailDto", "WPA2_WPA3_PERSONAL": "#/components/schemas/IntegrationWifiWpa2Wpa3PersonalSecurityConfigurationDetailDto", "WPA2_ENTERPRISE": "#/components/schemas/IntegrationWifiWpa2EnterpriseSecurityConfigurationDetailDto", "WPA3_ENTERPRISE": "#/components/schemas/IntegrationWifiWpa3EnterpriseSecurityConfigurationDetailDto", "WPA2_WPA3_ENTERPRISE": "#/components/schemas/IntegrationWifiWpa2Wpa3EnterpriseSecurityConfigurationDetailDto"}}, "properties": {"type": {"type": "string"}, "radiusConfiguration": {}}, "required": ["type"], "title": "Wifi security configuration detailObject"}, "broadcastingDeviceFilter": {"description": "Defines the custom scope of devices that will broadcast this WiFi network. If null, the WiFi network will be broadcast by all Access Point capable devices.", "discriminator": {"propertyName": "type", "mapping": {"DEVICES": "#/components/schemas/IntegrationWifiDevicesFilterDto", "DEVICE_TAGS": "#/components/schemas/IntegrationWifiDeviceTagsFilterDto"}}, "properties": {"type": {"type": "string"}}, "required": ["type"], "title": "Broadcasting device filter"}, "mdnsProxyConfiguration": {"discriminator": {"propertyName": "mode", "mapping": {"AUTO": "#/components/schemas/IntegrationWifiMdnsProxyAutoConfigurationDto", "CUSTOM": "#/components/schemas/IntegrationWifiMdnsProxyCustomConfigurationDto"}}, "properties": {"mode": {"type": "string"}}, "required": ["mode"], "title": "mDNS filtering configuration"}, "multicastFilteringPolicy": {"discriminator": {"propertyName": "action", "mapping": {"ALLOW": "#/components/schemas/IntegrationWifiMulticastFilteringAllowPolicyDto", "BLOCK": "#/components/schemas/IntegrationWifiMulticastFilteringBlockPolicyDto"}}, "properties": {"action": {"type": "string"}}, "required": ["action"], "title": "Multicast filtering policy"}, "multicastToUnicastConversionEnabled": {"type": "boolean"}, "clientIsolationEnabled": {"type": "boolean"}, "hideName": {"type": "boolean"}, "uapsdEnabled": {"type": "boolean", "description": "Indicates whether Unscheduled Automatic Power Save Delivery (U-APSD) is enabled"}, "basicDataRateKbpsByFrequencyGHz": {"properties": {"5": {"type": "integer", "format": "int32", "enum": ["6000", "9000", "12000", "24000"], "example": 6000}, "2.4": {"type": "integer", "format": "int32", "enum": ["1000", "2000", "5500", "6000", "9000", "11000", "12000", "24000"], "example": 2000}}, "required": ["2.4", "5"], "title": "IntegrationWifiBasicDataRateConfigurationDto"}, "clientFilteringPolicy": {"description": "Client connection filtering policy. Allow/restrict access to the WiFi network based on client device MAC addresses.", "properties": {"action": {"type": "string", "enum": ["ALLOW", "BLOCK"]}, "macAddressFilter": {"type": "array", "items": {"type": "string"}, "maxItems": 512, "minItems": 1, "uniqueItems": true}}, "required": ["action", "macAddressFilter"], "title": "IntegrationWifiClientFilteringPolicyDto"}, "blackoutScheduleConfiguration": {"properties": {"days": {"type": "array", "items": {"discriminator": {"propertyName": "type", "mapping": {"ALL_DAY": "#/components/schemas/IntegrationWifiBlackoutScheduleConfigurationPerAllDayDto", "TIME_RANGE": "#/components/schemas/IntegrationWifiBlackoutScheduleConfigurationPerDayWithTimeRangeDto"}}, "properties": {"type": {"type": "string"}, "day": {"type": "string", "enum": ["SUN", "MON", "TUE", "WED", "THU", "FRI", "SAT"]}}, "required": ["day", "type"], "title": "Blackout schedule configuration per day"}, "minItems": 1}}, "required": ["days"], "title": "Integration blackout schedule configuration"}}, "required": ["clientIsolationEnabled", "enabled", "hideName", "id", "metadata", "multicastToUnicastConversionEnabled", "name", "securityConfiguration", "type", "uapsdEnabled"], "title": "Wifi broadcast details"}, {"type": "object", "properties": {"broadcastingFrequenciesGHz": {"type": "array", "example": [2.4, 5], "items": {"type": "string", "enum": ["2.4", "5", "6"]}, "minItems": 1, "uniqueItems": true}, "hotspotConfiguration": {"discriminator": {"propertyName": "type", "mapping": {"CAPTIVE_PORTAL": "#/components/schemas/IntegrationWifiCaptivePortalConfigurationDetailDto", "PASSPOINT": "#/components/schemas/IntegrationWifiPasspointConfigurationDetailDto"}}, "properties": {"type": {"type": "string"}}, "required": ["type"], "title": "Wifi hotspot configuration"}, "mloEnabled": {"type": "boolean"}, "bandSteeringEnabled": {"type": "boolean"}, "arpProxyEnabled": {"type": "boolean"}, "bssTransitionEnabled": {"type": "boolean"}, "dtimPeriodByFrequencyGHzOverride": {"properties": {"5": {"type": "integer", "format": "int32", "maximum": 255, "minimum": 1}, "6": {"type": "integer", "format": "int32", "maximum": 255, "minimum": 1}, "2.4": {"type": "integer", "format": "int32", "maximum": 255, "minimum": 1}}, "required": ["2.4", "5", "6"], "title": "IntegrationWifiDtimPeriodConfigurationDto"}}}], "required": ["arpProxyEnabled", "broadcastingFrequenciesGHz", "bssTransitionEnabled", "clientIsolationEnabled", "enabled", "hideName", "id", "metadata", "multicastToUnicastConversionEnabled", "name", "securityConfiguration", "uapsdEnabled"]}, "Orchestrated entity metadata": {"allOf": [{"discriminator": {"propertyName": "origin", "mapping": {"USER_DEFINED": "#/components/schemas/User defined entity metadata", "SYSTEM_DEFINED": "#/components/schemas/System defined entity metadata", "DERIVED": "#/components/schemas/Derived entity metadata", "ORCHESTRATED": "#/components/schemas/Orchestrated entity metadata"}}, "properties": {"origin": {"type": "string"}}, "required": ["origin"], "title": "Entity metadata"}, {"discriminator": {"propertyName": "origin", "mapping": {"USER_DEFINED": "#/components/schemas/User defined entity metadata", "SYSTEM_DEFINED": "#/components/schemas/System defined entity metadata", "ORCHESTRATED": "#/components/schemas/Orchestrated entity metadata"}}, "properties": {"origin": {"type": "string"}}, "required": ["origin"], "title": "User or system defined or orchestrated entity metadata"}, {"discriminator": {"propertyName": "origin", "mapping": {"USER_DEFINED": "#/components/schemas/User defined entity metadata", "ORCHESTRATED": "#/components/schemas/Orchestrated entity metadata"}}, "properties": {"origin": {"type": "string"}}, "required": ["origin"], "title": "User or orchestrated entity metadata"}, {"discriminator": {"propertyName": "origin", "mapping": {"USER_DEFINED": "#/components/schemas/User defined entity metadata", "DERIVED": "#/components/schemas/Derived entity metadata", "ORCHESTRATED": "#/components/schemas/Orchestrated entity metadata"}}, "properties": {"origin": {"type": "string"}}, "required": ["origin"], "title": "User or derived or orchestrated entity metadata"}]}, "Site-to-site VPN tunnel metadata": {"discriminator": {"propertyName": "origin", "mapping": {"USER_DEFINED": "#/components/schemas/User defined entity metadata", "DERIVED": "#/components/schemas/IntegrationDerivedSiteToSiteTunnelMetadata"}}, "properties": {"origin": {"type": "string"}}, "required": ["origin"]}, "System defined entity metadata": {"allOf": [{"discriminator": {"propertyName": "origin", "mapping": {"USER_DEFINED": "#/components/schemas/User defined entity metadata", "SYSTEM_DEFINED": "#/components/schemas/System defined entity metadata", "DERIVED": "#/components/schemas/Derived entity metadata", "ORCHESTRATED": "#/components/schemas/Orchestrated entity metadata"}}, "properties": {"origin": {"type": "string"}}, "required": ["origin"], "title": "Entity metadata"}, {"discriminator": {"propertyName": "origin", "mapping": {"USER_DEFINED": "#/components/schemas/User defined entity metadata", "SYSTEM_DEFINED": "#/components/schemas/System defined entity metadata"}}, "properties": {"origin": {"type": "string"}}, "required": ["origin"], "title": "User or system defined entity metadata"}, {"discriminator": {"propertyName": "origin", "mapping": {"USER_DEFINED": "#/components/schemas/User defined entity metadata", "SYSTEM_DEFINED": "#/components/schemas/System defined entity metadata", "ORCHESTRATED": "#/components/schemas/Orchestrated entity metadata"}}, "properties": {"origin": {"type": "string"}}, "required": ["origin"], "title": "User or system defined or orchestrated entity metadata"}, {"type": "object", "properties": {"configurable": {"type": "boolean"}}}]}, "User defined entity metadata": {"allOf": [{"discriminator": {"propertyName": "origin", "mapping": {"USER_DEFINED": "#/components/schemas/User defined entity metadata", "SYSTEM_DEFINED": "#/components/schemas/System defined entity metadata", "DERIVED": "#/components/schemas/Derived entity metadata", "ORCHESTRATED": "#/components/schemas/Orchestrated entity metadata"}}, "properties": {"origin": {"type": "string"}}, "required": ["origin"], "title": "Entity metadata"}, {"discriminator": {"propertyName": "origin", "mapping": {"USER_DEFINED": "#/components/schemas/User defined entity metadata", "SYSTEM_DEFINED": "#/components/schemas/System defined entity metadata"}}, "properties": {"origin": {"type": "string"}}, "required": ["origin"], "title": "User or system defined entity metadata"}, {"discriminator": {"propertyName": "origin", "mapping": {"USER_DEFINED": "#/components/schemas/User defined entity metadata", "DERIVED": "#/components/schemas/Derived entity metadata"}}, "properties": {"origin": {"type": "string"}}, "required": ["origin"], "title": "User defined or derived entity metadata"}, {"discriminator": {"propertyName": "origin", "mapping": {"USER_DEFINED": "#/components/schemas/User defined entity metadata", "SYSTEM_DEFINED": "#/components/schemas/System defined entity metadata", "ORCHESTRATED": "#/components/schemas/Orchestrated entity metadata"}}, "properties": {"origin": {"type": "string"}}, "required": ["origin"], "title": "User or system defined or orchestrated entity metadata"}, {"discriminator": {"propertyName": "origin", "mapping": {"USER_DEFINED": "#/components/schemas/User defined entity metadata", "ORCHESTRATED": "#/components/schemas/Orchestrated entity metadata"}}, "properties": {"origin": {"type": "string"}}, "required": ["origin"], "title": "User or orchestrated entity metadata"}, {"discriminator": {"propertyName": "origin", "mapping": {"USER_DEFINED": "#/components/schemas/User defined entity metadata", "DERIVED": "#/components/schemas/Derived entity metadata", "ORCHESTRATED": "#/components/schemas/Orchestrated entity metadata"}}, "properties": {"origin": {"type": "string"}}, "required": ["origin"], "title": "User or derived or orchestrated entity metadata"}, {"discriminator": {"propertyName": "origin", "mapping": {"USER_DEFINED": "#/components/schemas/User defined entity metadata", "DERIVED": "#/components/schemas/IntegrationDerivedSiteToSiteTunnelMetadata"}}, "properties": {"origin": {"type": "string"}}, "required": ["origin"], "title": "Site-to-site VPN tunnel metadata"}]}, "User defined or derived entity metadata": {"discriminator": {"propertyName": "origin", "mapping": {"USER_DEFINED": "#/components/schemas/User defined entity metadata", "DERIVED": "#/components/schemas/Derived entity metadata"}}, "properties": {"origin": {"type": "string"}}, "required": ["origin"]}, "User or derived or orchestrated entity metadata": {"discriminator": {"propertyName": "origin", "mapping": {"USER_DEFINED": "#/components/schemas/User defined entity metadata", "DERIVED": "#/components/schemas/Derived entity metadata", "ORCHESTRATED": "#/components/schemas/Orchestrated entity metadata"}}, "properties": {"origin": {"type": "string"}}, "required": ["origin"]}, "User or orchestrated entity metadata": {"discriminator": {"propertyName": "origin", "mapping": {"USER_DEFINED": "#/components/schemas/User defined entity metadata", "ORCHESTRATED": "#/components/schemas/Orchestrated entity metadata"}}, "properties": {"origin": {"type": "string"}}, "required": ["origin"]}, "User or system defined entity metadata": {"discriminator": {"propertyName": "origin", "mapping": {"USER_DEFINED": "#/components/schemas/User defined entity metadata", "SYSTEM_DEFINED": "#/components/schemas/System defined entity metadata"}}, "properties": {"origin": {"type": "string"}}, "required": ["origin"]}, "User or system defined or orchestrated entity metadata": {"discriminator": {"propertyName": "origin", "mapping": {"USER_DEFINED": "#/components/schemas/User defined entity metadata", "SYSTEM_DEFINED": "#/components/schemas/System defined entity metadata", "ORCHESTRATED": "#/components/schemas/Orchestrated entity metadata"}}, "properties": {"origin": {"type": "string"}}, "required": ["origin"]}, "Wifi broadcast details": {"discriminator": {"propertyName": "type", "mapping": {"STANDARD": "#/components/schemas/IntegrationStandardWifiBroadcastDetailDto", "IOT_OPTIMIZED": "#/components/schemas/IntegrationIotOptimizedWifiBroadcastDetailDto"}}, "properties": {"type": {"type": "string"}, "id": {"type": "string", "format": "uuid"}, "name": {"type": "string"}, "metadata": {"discriminator": {"propertyName": "origin", "mapping": {"USER_DEFINED": "#/components/schemas/User defined entity metadata", "DERIVED": "#/components/schemas/Derived entity metadata", "ORCHESTRATED": "#/components/schemas/Orchestrated entity metadata"}}, "properties": {"origin": {"type": "string"}}, "required": ["origin"], "title": "User or derived or orchestrated entity metadata"}, "enabled": {"type": "boolean"}, "network": {"discriminator": {"propertyName": "type", "mapping": {"NATIVE": "#/components/schemas/IntegrationWifiNativeNetworkDto", "SPECIFIC": "#/components/schemas/IntegrationWifiSpecificNetworkDto"}}, "properties": {"type": {"type": "string"}}, "required": ["type"], "title": "Wifi network reference"}, "securityConfiguration": {"discriminator": {"propertyName": "type", "mapping": {"OPEN": "#/components/schemas/IntegrationWifiOpenSecurityConfigurationDetailDto", "WPA2_PERSONAL": "#/components/schemas/IntegrationWifiWpa2PersonalSecurityConfigurationDetailDto", "WPA3_PERSONAL": "#/components/schemas/IntegrationWifiWpa3PersonalSecurityConfigurationDetailDto", "WPA2_WPA3_PERSONAL": "#/components/schemas/IntegrationWifiWpa2Wpa3PersonalSecurityConfigurationDetailDto", "WPA2_ENTERPRISE": "#/components/schemas/IntegrationWifiWpa2EnterpriseSecurityConfigurationDetailDto", "WPA3_ENTERPRISE": "#/components/schemas/IntegrationWifiWpa3EnterpriseSecurityConfigurationDetailDto", "WPA2_WPA3_ENTERPRISE": "#/components/schemas/IntegrationWifiWpa2Wpa3EnterpriseSecurityConfigurationDetailDto"}}, "properties": {"type": {"type": "string"}, "radiusConfiguration": {}}, "required": ["type"], "title": "Wifi security configuration detailObject"}, "broadcastingDeviceFilter": {"description": "Defines the custom scope of devices that will broadcast this WiFi network. If null, the WiFi network will be broadcast by all Access Point capable devices.", "discriminator": {"propertyName": "type", "mapping": {"DEVICES": "#/components/schemas/IntegrationWifiDevicesFilterDto", "DEVICE_TAGS": "#/components/schemas/IntegrationWifiDeviceTagsFilterDto"}}, "properties": {"type": {"type": "string"}}, "required": ["type"], "title": "Broadcasting device filter"}, "mdnsProxyConfiguration": {"discriminator": {"propertyName": "mode", "mapping": {"AUTO": "#/components/schemas/IntegrationWifiMdnsProxyAutoConfigurationDto", "CUSTOM": "#/components/schemas/IntegrationWifiMdnsProxyCustomConfigurationDto"}}, "properties": {"mode": {"type": "string"}}, "required": ["mode"], "title": "mDNS filtering configuration"}, "multicastFilteringPolicy": {"discriminator": {"propertyName": "action", "mapping": {"ALLOW": "#/components/schemas/IntegrationWifiMulticastFilteringAllowPolicyDto", "BLOCK": "#/components/schemas/IntegrationWifiMulticastFilteringBlockPolicyDto"}}, "properties": {"action": {"type": "string"}}, "required": ["action"], "title": "Multicast filtering policy"}, "multicastToUnicastConversionEnabled": {"type": "boolean"}, "clientIsolationEnabled": {"type": "boolean"}, "hideName": {"type": "boolean"}, "uapsdEnabled": {"type": "boolean", "description": "Indicates whether Unscheduled Automatic Power Save Delivery (U-APSD) is enabled"}, "basicDataRateKbpsByFrequencyGHz": {"properties": {"5": {"type": "integer", "format": "int32", "enum": ["6000", "9000", "12000", "24000"], "example": 6000}, "2.4": {"type": "integer", "format": "int32", "enum": ["1000", "2000", "5500", "6000", "9000", "11000", "12000", "24000"], "example": 2000}}, "required": ["2.4", "5"], "title": "IntegrationWifiBasicDataRateConfigurationDto"}, "clientFilteringPolicy": {"description": "Client connection filtering policy. Allow/restrict access to the WiFi network based on client device MAC addresses.", "properties": {"action": {"type": "string", "enum": ["ALLOW", "BLOCK"]}, "macAddressFilter": {"type": "array", "items": {"type": "string"}, "maxItems": 512, "minItems": 1, "uniqueItems": true}}, "required": ["action", "macAddressFilter"], "title": "IntegrationWifiClientFilteringPolicyDto"}, "blackoutScheduleConfiguration": {"properties": {"days": {"type": "array", "items": {"discriminator": {"propertyName": "type", "mapping": {"ALL_DAY": "#/components/schemas/IntegrationWifiBlackoutScheduleConfigurationPerAllDayDto", "TIME_RANGE": "#/components/schemas/IntegrationWifiBlackoutScheduleConfigurationPerDayWithTimeRangeDto"}}, "properties": {"type": {"type": "string"}, "day": {"type": "string", "enum": ["SUN", "MON", "TUE", "WED", "THU", "FRI", "SAT"]}}, "required": ["day", "type"], "title": "Blackout schedule configuration per day"}, "minItems": 1}}, "required": ["days"], "title": "Integration blackout schedule configuration"}}, "required": ["clientIsolationEnabled", "enabled", "hideName", "id", "metadata", "multicastToUnicastConversionEnabled", "name", "securityConfiguration", "type", "uapsdEnabled"]}, "Address IPv4 matching": {"allOf": [{"discriminator": {"propertyName": "type", "mapping": {"IP_ADDRESS": "#/components/schemas/Address IPv4 matching", "SUBNET": "#/components/schemas/Subnet IPv4 matching", "IP_ADDRESS_RANGE": "#/components/schemas/Address range IPv4 matching"}}, "properties": {"type": {"type": "string"}}, "required": ["type"], "title": "IPv4 matching"}, {"type": "object", "properties": {"value": {"type": "string", "description": "IPv4 address", "example": "192.168.1.5"}}}], "required": ["value"]}, "Address IPv6 matching": {"allOf": [{"discriminator": {"propertyName": "type", "mapping": {"IP_ADDRESS": "#/components/schemas/Address IPv6 matching", "SUBNET": "#/components/schemas/Subnet IPv6 matching"}}, "properties": {"type": {"type": "string"}}, "required": ["type"], "title": "IPv6 matching"}, {"type": "object", "properties": {"value": {"type": "string", "description": "IPv6 address", "example": "2001:0db8:85a3:0000:0000:8a2e:0370:7334"}}}], "required": ["value"]}, "Address range IPv4 matching": {"allOf": [{"discriminator": {"propertyName": "type", "mapping": {"IP_ADDRESS": "#/components/schemas/Address IPv4 matching", "SUBNET": "#/components/schemas/Subnet IPv4 matching", "IP_ADDRESS_RANGE": "#/components/schemas/Address range IPv4 matching"}}, "properties": {"type": {"type": "string"}}, "required": ["type"], "title": "IPv4 matching"}, {"type": "object", "properties": {"start": {"type": "string", "description": "IPv4 start address", "example": "192.168.1.10"}, "stop": {"type": "string", "description": "IPv4 stop address", "example": "192.168.1.20"}}}], "required": ["start", "stop"]}, "Create or update traffic matching list": {"discriminator": {"propertyName": "type", "mapping": {"PORTS": "#/components/schemas/IntegrationPortTrafficMatchingListCreateUpdateDto", "IPV4_ADDRESSES": "#/components/schemas/IntegrationIpV4TrafficMatchingListCreateUpdateDto", "IPV6_ADDRESSES": "#/components/schemas/IntegrationIpV6TrafficMatchingListCreateUpdateDto"}}, "properties": {"type": {"type": "string"}, "name": {"type": "string", "example": "Allowed port list|Protected IP list"}}, "required": ["name", "type"]}, "IPv4 matching": {"discriminator": {"propertyName": "type", "mapping": {"IP_ADDRESS": "#/components/schemas/Address IPv4 matching", "SUBNET": "#/components/schemas/Subnet IPv4 matching", "IP_ADDRESS_RANGE": "#/components/schemas/Address range IPv4 matching"}}, "properties": {"type": {"type": "string"}}, "required": ["type"]}, "IPv6 matching": {"discriminator": {"propertyName": "type", "mapping": {"IP_ADDRESS": "#/components/schemas/Address IPv6 matching", "SUBNET": "#/components/schemas/Subnet IPv6 matching"}}, "properties": {"type": {"type": "string"}}, "required": ["type"]}, "IntegrationIpV4TrafficMatchingListCreateUpdateDto": {"allOf": [{"discriminator": {"propertyName": "type", "mapping": {"PORTS": "#/components/schemas/IntegrationPortTrafficMatchingListCreateUpdateDto", "IPV4_ADDRESSES": "#/components/schemas/IntegrationIpV4TrafficMatchingListCreateUpdateDto", "IPV6_ADDRESSES": "#/components/schemas/IntegrationIpV6TrafficMatchingListCreateUpdateDto"}}, "properties": {"type": {"type": "string"}, "name": {"type": "string", "example": "Allowed port list|Protected IP list"}}, "required": ["name", "type"], "title": "Create or update traffic matching list"}, {"type": "object", "properties": {"items": {"type": "array", "items": {"discriminator": {"propertyName": "type", "mapping": {"IP_ADDRESS": "#/components/schemas/Address IPv4 matching", "SUBNET": "#/components/schemas/Subnet IPv4 matching", "IP_ADDRESS_RANGE": "#/components/schemas/Address range IPv4 matching"}}, "properties": {"type": {"type": "string"}}, "required": ["type"], "title": "IPv4 matching"}, "minItems": 1}}}], "required": ["items", "name"]}, "IntegrationIpV6TrafficMatchingListCreateUpdateDto": {"allOf": [{"discriminator": {"propertyName": "type", "mapping": {"PORTS": "#/components/schemas/IntegrationPortTrafficMatchingListCreateUpdateDto", "IPV4_ADDRESSES": "#/components/schemas/IntegrationIpV4TrafficMatchingListCreateUpdateDto", "IPV6_ADDRESSES": "#/components/schemas/IntegrationIpV6TrafficMatchingListCreateUpdateDto"}}, "properties": {"type": {"type": "string"}, "name": {"type": "string", "example": "Allowed port list|Protected IP list"}}, "required": ["name", "type"], "title": "Create or update traffic matching list"}, {"type": "object", "properties": {"items": {"type": "array", "items": {"discriminator": {"propertyName": "type", "mapping": {"IP_ADDRESS": "#/components/schemas/Address IPv6 matching", "SUBNET": "#/components/schemas/Subnet IPv6 matching"}}, "properties": {"type": {"type": "string"}}, "required": ["type"], "title": "IPv6 matching"}, "minItems": 1}}}], "required": ["items", "name"]}, "IntegrationPortTrafficMatchingListCreateUpdateDto": {"allOf": [{"discriminator": {"propertyName": "type", "mapping": {"PORTS": "#/components/schemas/IntegrationPortTrafficMatchingListCreateUpdateDto", "IPV4_ADDRESSES": "#/components/schemas/IntegrationIpV4TrafficMatchingListCreateUpdateDto", "IPV6_ADDRESSES": "#/components/schemas/IntegrationIpV6TrafficMatchingListCreateUpdateDto"}}, "properties": {"type": {"type": "string"}, "name": {"type": "string", "example": "Allowed port list|Protected IP list"}}, "required": ["name", "type"], "title": "Create or update traffic matching list"}, {"type": "object", "properties": {"items": {"type": "array", "items": {"discriminator": {"propertyName": "type", "mapping": {"PORT_NUMBER": "#/components/schemas/Number port matching", "PORT_NUMBER_RANGE": "#/components/schemas/Number range port matching"}}, "properties": {"type": {"type": "string"}}, "required": ["type"], "title": "Port matching"}, "minItems": 1}}}], "required": ["items", "name"]}, "Number port matching": {"allOf": [{"discriminator": {"propertyName": "type", "mapping": {"PORT_NUMBER": "#/components/schemas/Number port matching", "PORT_NUMBER_RANGE": "#/components/schemas/Number range port matching"}}, "properties": {"type": {"type": "string"}}, "required": ["type"], "title": "Port matching"}, {"type": "object", "properties": {"value": {"type": "integer", "format": "int32", "description": "Port number", "example": "80|443|8080", "maximum": 65535, "minimum": 1}}}], "required": ["value"]}, "Number range port matching": {"allOf": [{"discriminator": {"propertyName": "type", "mapping": {"PORT_NUMBER": "#/components/schemas/Number port matching", "PORT_NUMBER_RANGE": "#/components/schemas/Number range port matching"}}, "properties": {"type": {"type": "string"}}, "required": ["type"], "title": "Port matching"}, {"type": "object", "properties": {"start": {"type": "integer", "format": "int32", "description": "Start port number", "example": "80|443|8080", "maximum": 65535, "minimum": 1}, "stop": {"type": "integer", "format": "int32", "description": "Stop port number", "example": "80|443|8080", "maximum": 65535, "minimum": 1}}}], "required": ["start", "stop"]}, "Port matching": {"discriminator": {"propertyName": "type", "mapping": {"PORT_NUMBER": "#/components/schemas/Number port matching", "PORT_NUMBER_RANGE": "#/components/schemas/Number range port matching"}}, "properties": {"type": {"type": "string"}}, "required": ["type"]}, "Subnet IPv4 matching": {"allOf": [{"discriminator": {"propertyName": "type", "mapping": {"IP_ADDRESS": "#/components/schemas/Address IPv4 matching", "SUBNET": "#/components/schemas/Subnet IPv4 matching", "IP_ADDRESS_RANGE": "#/components/schemas/Address range IPv4 matching"}}, "properties": {"type": {"type": "string"}}, "required": ["type"], "title": "IPv4 matching"}, {"type": "object", "properties": {"value": {"type": "string", "description": "IPv4 subnet in CIDR notation", "example": "192.168.1.0/24"}}}], "required": ["value"]}, "Subnet IPv6 matching": {"allOf": [{"discriminator": {"propertyName": "type", "mapping": {"IP_ADDRESS": "#/components/schemas/Address IPv6 matching", "SUBNET": "#/components/schemas/Subnet IPv6 matching"}}, "properties": {"type": {"type": "string"}}, "required": ["type"], "title": "IPv6 matching"}, {"type": "object", "properties": {"value": {"type": "string", "description": "IPv6 subnet in CIDR notation", "example": "2001:db8:1:0::/64"}}}], "required": ["value"]}, "IntegrationIpV4TrafficMatchingListDto": {"allOf": [{"discriminator": {"propertyName": "type", "mapping": {"PORTS": "#/components/schemas/IntegrationPortTrafficMatchingListDto", "IPV4_ADDRESSES": "#/components/schemas/IntegrationIpV4TrafficMatchingListDto", "IPV6_ADDRESSES": "#/components/schemas/IntegrationIpV6TrafficMatchingListDto"}}, "properties": {"type": {"type": "string"}, "id": {"type": "string", "format": "uuid", "example": "ffcdb32c-6278-4364-8947-df4f77118df8"}, "name": {"type": "string", "example": "Allowed port list|Protected IP list"}}, "required": ["id", "name", "type"], "title": "Traffic matching list"}, {"type": "object", "properties": {"items": {"type": "array", "items": {"discriminator": {"propertyName": "type", "mapping": {"IP_ADDRESS": "#/components/schemas/Address IPv4 matching", "SUBNET": "#/components/schemas/Subnet IPv4 matching", "IP_ADDRESS_RANGE": "#/components/schemas/Address range IPv4 matching"}}, "properties": {"type": {"type": "string"}}, "required": ["type"], "title": "IPv4 matching"}, "minItems": 1}}}], "required": ["id", "items", "name"]}, "IntegrationIpV6TrafficMatchingListDto": {"allOf": [{"discriminator": {"propertyName": "type", "mapping": {"PORTS": "#/components/schemas/IntegrationPortTrafficMatchingListDto", "IPV4_ADDRESSES": "#/components/schemas/IntegrationIpV4TrafficMatchingListDto", "IPV6_ADDRESSES": "#/components/schemas/IntegrationIpV6TrafficMatchingListDto"}}, "properties": {"type": {"type": "string"}, "id": {"type": "string", "format": "uuid", "example": "ffcdb32c-6278-4364-8947-df4f77118df8"}, "name": {"type": "string", "example": "Allowed port list|Protected IP list"}}, "required": ["id", "name", "type"], "title": "Traffic matching list"}, {"type": "object", "properties": {"items": {"type": "array", "items": {"discriminator": {"propertyName": "type", "mapping": {"IP_ADDRESS": "#/components/schemas/Address IPv6 matching", "SUBNET": "#/components/schemas/Subnet IPv6 matching"}}, "properties": {"type": {"type": "string"}}, "required": ["type"], "title": "IPv6 matching"}, "minItems": 1}}}], "required": ["id", "items", "name"]}, "IntegrationPortTrafficMatchingListDto": {"allOf": [{"discriminator": {"propertyName": "type", "mapping": {"PORTS": "#/components/schemas/IntegrationPortTrafficMatchingListDto", "IPV4_ADDRESSES": "#/components/schemas/IntegrationIpV4TrafficMatchingListDto", "IPV6_ADDRESSES": "#/components/schemas/IntegrationIpV6TrafficMatchingListDto"}}, "properties": {"type": {"type": "string"}, "id": {"type": "string", "format": "uuid", "example": "ffcdb32c-6278-4364-8947-df4f77118df8"}, "name": {"type": "string", "example": "Allowed port list|Protected IP list"}}, "required": ["id", "name", "type"], "title": "Traffic matching list"}, {"type": "object", "properties": {"items": {"type": "array", "items": {"discriminator": {"propertyName": "type", "mapping": {"PORT_NUMBER": "#/components/schemas/Number port matching", "PORT_NUMBER_RANGE": "#/components/schemas/Number range port matching"}}, "properties": {"type": {"type": "string"}}, "required": ["type"], "title": "Port matching"}, "minItems": 1}}}], "required": ["id", "items", "name"]}, "Traffic matching list": {"discriminator": {"propertyName": "type", "mapping": {"PORTS": "#/components/schemas/IntegrationPortTrafficMatchingListDto", "IPV4_ADDRESSES": "#/components/schemas/IntegrationIpV4TrafficMatchingListDto", "IPV6_ADDRESSES": "#/components/schemas/IntegrationIpV6TrafficMatchingListDto"}}, "properties": {"type": {"type": "string"}, "id": {"type": "string", "format": "uuid", "example": "ffcdb32c-6278-4364-8947-df4f77118df8"}, "name": {"type": "string", "example": "Allowed port list|Protected IP list"}}, "required": ["id", "name", "type"]}, "Create or update Network": {"discriminator": {"propertyName": "management", "mapping": {"UNMANAGED": "#/components/schemas/IntegrationUnmanagedNetworkCreateUpdateDto", "GATEWAY": "#/components/schemas/IntegrationGatewayManagedNetworkCreateUpdateDto", "SWITCH": "#/components/schemas/IntegrationSwitchManagedNetworkCreateUpdateDto"}}, "properties": {"management": {"type": "string"}, "name": {"type": "string", "example": "Default Network"}, "enabled": {"type": "boolean"}, "vlanId": {"type": "integer", "format": "int32", "maximum": 4000, "minimum": 2}, "dhcpGuarding": {"description": "DHCP Guarding settings for this Network. If this field is omitted or null, the feature is disabled", "properties": {"trustedDhcpServerIpAddresses": {"type": "array", "description": "List of trusted DHCP server IP addresses.", "items": {"type": "string"}, "minItems": 1}}, "required": ["trustedDhcpServerIpAddresses"], "title": "Network DHCP Guarding"}}, "required": ["enabled", "management", "name", "vlanId"]}, "DHCP Configuration for IPv6 Network": {"properties": {"ipAddressSuffixRange": {"properties": {"start": {"type": "string", "description": "Start suffix of the DHCPv6 address pool."}, "stop": {"type": "string", "description": "End suffix of the DHCPv6 address pool."}}, "required": ["start", "stop"], "title": "IntegrationIpv6AddressSuffixRangeSelectorDto"}, "leaseTimeSeconds": {"type": "integer", "format": "int32", "description": "The lease time in seconds for IP addresses in this range.", "maximum": 31536000, "minimum": 0}}, "required": ["ipAddressSuffixRange", "leaseTimeSeconds"]}, "Gateway Managed IPv4 Configuration": {"properties": {"autoScaleEnabled": {"type": "boolean", "description": "Whether the Network can automatically scale its subnet size based on the number of active DHCP leases."}, "hostIpAddress": {"type": "string"}, "prefixLength": {"type": "integer", "format": "int32", "maximum": 30, "minimum": 8}, "additionalHostIpSubnets": {"type": "array", "description": "Additional host IP subnets assigned to this VLAN.", "items": {"type": "string"}, "maxItems": 64, "minItems": 1}, "dhcpConfiguration": {"description": "IPv4 DHCP configuration for this network. If this field is omitted or null, DHCP is not working and hosts must get an address statically or from another server in this broadcast domain.", "discriminator": {"propertyName": "mode", "mapping": {"SERVER": "#/components/schemas/Gateway Managed IPv4 DHCP Server Configuration", "RELAY": "#/components/schemas/IPv4 DHCP Relay Configuration"}}, "properties": {"mode": {"type": "string"}}, "required": ["mode"], "title": "Gateway Managed IPv4 DHCP Configuration"}, "natOutboundIpAddressConfiguration": {"type": "array", "description": "List of NAT Outbound Configurations defining which IP addresses are used for NAT translation. This array must contain all WAN interfaces with `static` or `PPPoE` IPv4 connection configuration.", "items": {"discriminator": {"propertyName": "type", "mapping": {"AUTO": "#/components/schemas/NAT Outbound Auto Configuration", "STATIC": "#/components/schemas/NAT Outbound Static Configuration"}}, "properties": {"type": {"type": "string"}, "wanInterfaceId": {"type": "string", "format": "uuid"}}, "required": ["type", "wanInterfaceId"], "title": "WAN NAT Outbound Configuration"}, "minItems": 1}}, "required": ["autoScaleEnabled", "hostIpAddress", "prefixLength"]}, "Gateway Managed IPv4 DHCP Configuration": {"discriminator": {"propertyName": "mode", "mapping": {"SERVER": "#/components/schemas/Gateway Managed IPv4 DHCP Server Configuration", "RELAY": "#/components/schemas/IPv4 DHCP Relay Configuration"}}, "properties": {"mode": {"type": "string"}}, "required": ["mode"]}, "Gateway Managed IPv4 DHCP Server Configuration": {"allOf": [{"discriminator": {"propertyName": "mode", "mapping": {"SERVER": "#/components/schemas/Gateway Managed IPv4 DHCP Server Configuration", "RELAY": "#/components/schemas/IPv4 DHCP Relay Configuration"}}, "properties": {"mode": {"type": "string"}}, "required": ["mode"], "title": "Gateway Managed IPv4 DHCP Configuration"}, {"type": "object", "properties": {"ipAddressRange": {"properties": {"start": {"type": "string"}, "stop": {"type": "string"}}, "required": ["start", "stop"], "title": "IP address range"}, "gatewayIpAddressOverride": {"type": "string", "description": "Gateway IP address provided to DHCP clients. If null, the default gateway will be assigned."}, "dnsServerIpAddressesOverride": {"type": "array", "description": "List of DNS servers assigned to client devices by the DHCP server. If none are specified, they will be selected automatically.", "items": {"type": "string"}, "maxItems": 4, "minItems": 1}, "leaseTimeSeconds": {"type": "integer", "format": "int32", "description": "The lease time in seconds for addresses in this range.", "maximum": 31536000, "minimum": 0}, "domainName": {"type": "string", "description": "Domain name that can be used to access network in the browser."}, "pingConflictDetectionEnabled": {"type": "boolean"}, "pxeConfiguration": {"description": "Pre execution environment configuration for network boot", "properties": {"serverIpAddress": {"type": "string"}, "filename": {"type": "string"}}, "required": ["filename", "serverIpAddress"], "title": "PXE Configuration"}, "ntpServerIpAddresses": {"type": "array", "description": "Network Time Protocol (NTP) server IP addresses.", "items": {"type": "string"}, "maxItems": 2, "minItems": 1}, "option43Value": {"type": "string", "description": "Custom DHCP option (43) — the value MUST be the UniFi Network application's host IP address."}, "tftpServerAddress": {"type": "string", "description": "Trivial File Transfer Protocol (TFTP) server address — accepts a hostname, URL or IP address."}, "timeOffsetSeconds": {"type": "integer", "format": "int32", "description": "Time offset in seconds from UTC.", "maximum": 86400, "minimum": -86400}, "wpadUrl": {"type": "string", "description": "Web Proxy Auto-Discovery (WPAD) URL."}, "winsServerIpAddresses": {"type": "array", "description": "Windows Internet Name Service (WINS) server IP addresses.", "items": {"type": "string"}, "maxItems": 2, "minItems": 1}}}], "required": ["ipAddressRange", "leaseTimeSeconds", "pingConflictDetectionEnabled"]}, "IP Address selector": {"allOf": [{"discriminator": {"propertyName": "type", "mapping": {"IP_ADDRESS": "#/components/schemas/IP Address selector", "IP_ADDRESS_RANGE": "#/components/schemas/IP address range selector"}}, "properties": {"type": {"type": "string"}}, "required": ["type"], "title": "IP address selector"}, {"type": "object", "properties": {"value": {"type": "string"}}}], "required": ["value"]}, "IP address range": {"properties": {"start": {"type": "string"}, "stop": {"type": "string"}}, "required": ["start", "stop"]}, "IP address range selector": {"allOf": [{"discriminator": {"propertyName": "type", "mapping": {"IP_ADDRESS": "#/components/schemas/IP Address selector", "IP_ADDRESS_RANGE": "#/components/schemas/IP address range selector"}}, "properties": {"type": {"type": "string"}}, "required": ["type"], "title": "IP address selector"}, {"type": "object", "properties": {"start": {"type": "string"}, "stop": {"type": "string"}}}], "required": ["start", "stop"]}, "IP address selector": {"discriminator": {"propertyName": "type", "mapping": {"IP_ADDRESS": "#/components/schemas/IP Address selector", "IP_ADDRESS_RANGE": "#/components/schemas/IP address range selector"}}, "properties": {"type": {"type": "string"}}, "required": ["type"]}, "IPv4 DHCP Relay Configuration": {"allOf": [{"discriminator": {"propertyName": "mode", "mapping": {"SERVER": "#/components/schemas/Gateway Managed IPv4 DHCP Server Configuration", "RELAY": "#/components/schemas/IPv4 DHCP Relay Configuration"}}, "properties": {"mode": {"type": "string"}}, "required": ["mode"], "title": "Gateway Managed IPv4 DHCP Configuration"}, {"type": "object", "properties": {"dhcpServerIpAddresses": {"type": "array", "description": "DHCP Server IP addresses", "items": {"type": "string"}, "minItems": 1}}}, {"discriminator": {"propertyName": "mode", "mapping": {"SERVER": "#/components/schemas/IPv4 DHCP Server Configuration", "RELAY": "#/components/schemas/IPv4 DHCP Relay Configuration"}}, "properties": {"mode": {"type": "string"}}, "required": ["mode"], "title": "Switch Managed IPv4 DHCP Configuration"}], "required": ["dhcpServerIpAddresses"]}, "IPv4 DHCP Server Configuration": {"allOf": [{"discriminator": {"propertyName": "mode", "mapping": {"SERVER": "#/components/schemas/IPv4 DHCP Server Configuration", "RELAY": "#/components/schemas/IPv4 DHCP Relay Configuration"}}, "properties": {"mode": {"type": "string"}}, "required": ["mode"], "title": "Switch Managed IPv4 DHCP Configuration"}, {"type": "object", "properties": {"ipAddressRange": {"properties": {"start": {"type": "string"}, "stop": {"type": "string"}}, "required": ["start", "stop"], "title": "IP address range"}, "gatewayIpAddressOverride": {"type": "string", "description": "Gateway IP address provided to DHCP clients. If null, the default gateway will be assigned."}, "dnsServerIpAddressesOverride": {"type": "array", "description": "List of DNS servers assigned to client devices by the DHCP server. If none are specified, they will be selected automatically.", "items": {"type": "string"}, "maxItems": 4, "minItems": 1}, "leaseTimeSeconds": {"type": "integer", "format": "int32", "description": "The lease time in seconds for addresses in this range.", "maximum": 31536000, "minimum": 0}, "domainName": {"type": "string", "description": "Domain name that can be used to access network in the browser."}}}], "required": ["ipAddressRange", "leaseTimeSeconds"]}, "IPv6 Client Address Assignment": {"properties": {"dhcpConfiguration": {"description": "IPv6 DHCP configuration for this network. At least one addressing method must be active: either enable SLAAC or provide DHCP configuration. If this field is null, SLAAC must be enabled.", "properties": {"ipAddressSuffixRange": {"properties": {"start": {"type": "string", "description": "Start suffix of the DHCPv6 address pool."}, "stop": {"type": "string", "description": "End suffix of the DHCPv6 address pool."}}, "required": ["start", "stop"], "title": "IntegrationIpv6AddressSuffixRangeSelectorDto"}, "leaseTimeSeconds": {"type": "integer", "format": "int32", "description": "The lease time in seconds for IP addresses in this range.", "maximum": 31536000, "minimum": 0}}, "required": ["ipAddressSuffixRange", "leaseTimeSeconds"], "title": "DHCP Configuration for IPv6 Network"}, "slaacEnabled": {"type": "boolean", "description": "Allows devices to obtain IPv6 addresses via SLAAC (Stateless Address Autoconfiguration) without DHCPv6. At least one addressing method must be active: either enable SLAAC or provide DHCP configuration."}}, "required": ["slaacEnabled"]}, "IPv6 Static Configuration": {"allOf": [{"discriminator": {"propertyName": "interfaceType", "mapping": {"PREFIX_DELEGATION": "#/components/schemas/Prefix delegation IPv6 Configuration", "STATIC": "#/components/schemas/IPv6 Static Configuration"}}, "properties": {"interfaceType": {"type": "string"}, "clientAddressAssignment": {"description": "Client Address Assignment", "properties": {"dhcpConfiguration": {"description": "IPv6 DHCP configuration for this network. At least one addressing method must be active: either enable SLAAC or provide DHCP configuration. If this field is null, SLAAC must be enabled.", "properties": {"ipAddressSuffixRange": {"properties": {"start": {"type": "string", "description": "Start suffix of the DHCPv6 address pool."}, "stop": {"type": "string", "description": "End suffix of the DHCPv6 address pool."}}, "required": ["start", "stop"], "title": "IntegrationIpv6AddressSuffixRangeSelectorDto"}, "leaseTimeSeconds": {"type": "integer", "format": "int32", "description": "The lease time in seconds for IP addresses in this range.", "maximum": 31536000, "minimum": 0}}, "required": ["ipAddressSuffixRange", "leaseTimeSeconds"], "title": "DHCP Configuration for IPv6 Network"}, "slaacEnabled": {"type": "boolean", "description": "Allows devices to obtain IPv6 addresses via SLAAC (Stateless Address Autoconfiguration) without DHCPv6. At least one addressing method must be active: either enable SLAAC or provide DHCP configuration."}}, "required": ["slaacEnabled"], "title": "IPv6 Client Address Assignment"}, "routerAdvertisement": {"description": "Router advertisement. Without it, hosts will not autoconfigure addresses and will lack a default route even with DHCPv6.", "properties": {"priority": {"type": "string", "description": "Router advertisement priority.", "enum": ["LOW", "MEDIUM", "HIGH"]}}, "required": ["priority"], "title": "Router advertisement Configuration"}, "dnsServerIpAddressesOverride": {"type": "array", "description": "The IPv6 DNS server addresses assigned to this Network. If none are specified, they will be selected automatically.", "items": {"type": "string"}, "maxItems": 4, "minItems": 1}, "additionalHostIpSubnets": {"type": "array", "description": "Additional host IP subnets assigned to this VLAN.", "items": {"type": "string"}, "maxItems": 4, "minItems": 1}}, "required": ["clientAddressAssignment", "interfaceType"], "title": "Network IPv6 Configuration"}, {"type": "object", "properties": {"hostIpAddress": {"type": "string", "description": "The static IPv6 address assigned to this Network."}, "prefixLength": {"type": "integer", "format": "int32", "maximum": 127, "minimum": 64}}}], "required": ["clientAddressAssignment", "hostIpAddress", "prefixLength"]}, "IntegrationGatewayManagedNetworkCreateUpdateDto": {"allOf": [{"discriminator": {"propertyName": "management", "mapping": {"UNMANAGED": "#/components/schemas/IntegrationUnmanagedNetworkCreateUpdateDto", "GATEWAY": "#/components/schemas/IntegrationGatewayManagedNetworkCreateUpdateDto", "SWITCH": "#/components/schemas/IntegrationSwitchManagedNetworkCreateUpdateDto"}}, "properties": {"management": {"type": "string"}, "name": {"type": "string", "example": "Default Network"}, "enabled": {"type": "boolean"}, "vlanId": {"type": "integer", "format": "int32", "maximum": 4000, "minimum": 2}, "dhcpGuarding": {"description": "DHCP Guarding settings for this Network. If this field is omitted or null, the feature is disabled", "properties": {"trustedDhcpServerIpAddresses": {"type": "array", "description": "List of trusted DHCP server IP addresses.", "items": {"type": "string"}, "minItems": 1}}, "required": ["trustedDhcpServerIpAddresses"], "title": "Network DHCP Guarding"}}, "required": ["enabled", "management", "name", "vlanId"], "title": "Create or update Network"}, {"type": "object", "properties": {"isolationEnabled": {"type": "boolean", "description": "Whether this network is isolated from all other networks."}, "cellularBackupEnabled": {"type": "boolean", "description": "Whether this network is allowed to use cellular data when WAN connection(s) are down."}, "zoneId": {"type": "string", "format": "uuid", "description": "Firewall zone ID associated with this Network."}, "internetAccessEnabled": {"type": "boolean", "description": "Whether the internet access is allowed for the device on this network."}, "mdnsForwardingEnabled": {"type": "boolean", "description": "Whether this network should participate in mDNS traffic forwarding."}, "ipv4Configuration": {"description": "Details about IPv4 configuration for this Network.", "properties": {"autoScaleEnabled": {"type": "boolean", "description": "Whether the Network can automatically scale its subnet size based on the number of active DHCP leases."}, "hostIpAddress": {"type": "string"}, "prefixLength": {"type": "integer", "format": "int32", "maximum": 30, "minimum": 8}, "additionalHostIpSubnets": {"type": "array", "description": "Additional host IP subnets assigned to this VLAN.", "items": {"type": "string"}, "maxItems": 64, "minItems": 1}, "dhcpConfiguration": {"description": "IPv4 DHCP configuration for this network. If this field is omitted or null, DHCP is not working and hosts must get an address statically or from another server in this broadcast domain.", "discriminator": {"propertyName": "mode", "mapping": {"SERVER": "#/components/schemas/Gateway Managed IPv4 DHCP Server Configuration", "RELAY": "#/components/schemas/IPv4 DHCP Relay Configuration"}}, "properties": {"mode": {"type": "string"}}, "required": ["mode"], "title": "Gateway Managed IPv4 DHCP Configuration"}, "natOutboundIpAddressConfiguration": {"type": "array", "description": "List of NAT Outbound Configurations defining which IP addresses are used for NAT translation. This array must contain all WAN interfaces with `static` or `PPPoE` IPv4 connection configuration.", "items": {"discriminator": {"propertyName": "type", "mapping": {"AUTO": "#/components/schemas/NAT Outbound Auto Configuration", "STATIC": "#/components/schemas/NAT Outbound Static Configuration"}}, "properties": {"type": {"type": "string"}, "wanInterfaceId": {"type": "string", "format": "uuid"}}, "required": ["type", "wanInterfaceId"], "title": "WAN NAT Outbound Configuration"}, "minItems": 1}}, "required": ["autoScaleEnabled", "hostIpAddress", "prefixLength"], "title": "Gateway Managed IPv4 Configuration"}, "ipv6Configuration": {"description": "Details about IPv6 configuration for this Network. If this field is omitted or null then IPv6 is not configured on this Network.", "discriminator": {"propertyName": "interfaceType", "mapping": {"PREFIX_DELEGATION": "#/components/schemas/Prefix delegation IPv6 Configuration", "STATIC": "#/components/schemas/IPv6 Static Configuration"}}, "properties": {"interfaceType": {"type": "string"}, "clientAddressAssignment": {"description": "Client Address Assignment", "properties": {"dhcpConfiguration": {"description": "IPv6 DHCP configuration for this network. At least one addressing method must be active: either enable SLAAC or provide DHCP configuration. If this field is null, SLAAC must be enabled.", "properties": {"ipAddressSuffixRange": {"properties": {"start": {"type": "string", "description": "Start suffix of the DHCPv6 address pool."}, "stop": {"type": "string", "description": "End suffix of the DHCPv6 address pool."}}, "required": ["start", "stop"], "title": "IntegrationIpv6AddressSuffixRangeSelectorDto"}, "leaseTimeSeconds": {"type": "integer", "format": "int32", "description": "The lease time in seconds for IP addresses in this range.", "maximum": 31536000, "minimum": 0}}, "required": ["ipAddressSuffixRange", "leaseTimeSeconds"], "title": "DHCP Configuration for IPv6 Network"}, "slaacEnabled": {"type": "boolean", "description": "Allows devices to obtain IPv6 addresses via SLAAC (Stateless Address Autoconfiguration) without DHCPv6. At least one addressing method must be active: either enable SLAAC or provide DHCP configuration."}}, "required": ["slaacEnabled"], "title": "IPv6 Client Address Assignment"}, "routerAdvertisement": {"description": "Router advertisement. Without it, hosts will not autoconfigure addresses and will lack a default route even with DHCPv6.", "properties": {"priority": {"type": "string", "description": "Router advertisement priority.", "enum": ["LOW", "MEDIUM", "HIGH"]}}, "required": ["priority"], "title": "Router advertisement Configuration"}, "dnsServerIpAddressesOverride": {"type": "array", "description": "The IPv6 DNS server addresses assigned to this Network. If none are specified, they will be selected automatically.", "items": {"type": "string"}, "maxItems": 4, "minItems": 1}, "additionalHostIpSubnets": {"type": "array", "description": "Additional host IP subnets assigned to this VLAN.", "items": {"type": "string"}, "maxItems": 4, "minItems": 1}}, "required": ["clientAddressAssignment", "interfaceType"], "title": "Network IPv6 Configuration"}}}], "required": ["cellularBackupEnabled", "enabled", "internetAccessEnabled", "ipv4Configuration", "isolationEnabled", "mdnsForwardingEnabled", "name", "vlanId", "zoneId"]}, "IntegrationIpv6AddressSuffixRangeSelectorDto": {"properties": {"start": {"type": "string", "description": "Start suffix of the DHCPv6 address pool."}, "stop": {"type": "string", "description": "End suffix of the DHCPv6 address pool."}}, "required": ["start", "stop"]}, "IntegrationSwitchManagedNetworkCreateUpdateDto": {"allOf": [{"discriminator": {"propertyName": "management", "mapping": {"UNMANAGED": "#/components/schemas/IntegrationUnmanagedNetworkCreateUpdateDto", "GATEWAY": "#/components/schemas/IntegrationGatewayManagedNetworkCreateUpdateDto", "SWITCH": "#/components/schemas/IntegrationSwitchManagedNetworkCreateUpdateDto"}}, "properties": {"management": {"type": "string"}, "name": {"type": "string", "example": "Default Network"}, "enabled": {"type": "boolean"}, "vlanId": {"type": "integer", "format": "int32", "maximum": 4000, "minimum": 2}, "dhcpGuarding": {"description": "DHCP Guarding settings for this Network. If this field is omitted or null, the feature is disabled", "properties": {"trustedDhcpServerIpAddresses": {"type": "array", "description": "List of trusted DHCP server IP addresses.", "items": {"type": "string"}, "minItems": 1}}, "required": ["trustedDhcpServerIpAddresses"], "title": "Network DHCP Guarding"}}, "required": ["enabled", "management", "name", "vlanId"], "title": "Create or update Network"}, {"type": "object", "properties": {"isolationEnabled": {"type": "boolean", "description": "Whether this network is isolated from all other networks."}, "cellularBackupEnabled": {"type": "boolean", "description": "Whether this network is allowed to use cellular data when WAN connection(s) are down."}, "deviceId": {"type": "string", "format": "uuid", "description": "ID of the L3 switching capable device that manages this network."}, "ipv4Configuration": {"description": "Details about IPv4 configuration for this Network.", "properties": {"autoScaleEnabled": {"type": "boolean", "description": "Whether the Network can automatically scale its subnet size based on the number of active DHCP leases."}, "hostIpAddress": {"type": "string"}, "prefixLength": {"type": "integer", "format": "int32", "maximum": 30, "minimum": 8}, "additionalHostIpSubnets": {"type": "array", "description": "Additional host IP subnets assigned to this VLAN.", "items": {"type": "string"}, "maxItems": 64, "minItems": 1}, "dhcpConfiguration": {"description": "IPv4 DHCP configuration for this network. If this field is omitted or null, DHCP is not working and hosts must get an address statically or from another server in this broadcast domain.", "discriminator": {"propertyName": "mode", "mapping": {"SERVER": "#/components/schemas/IPv4 DHCP Server Configuration", "RELAY": "#/components/schemas/IPv4 DHCP Relay Configuration"}}, "properties": {"mode": {"type": "string"}}, "required": ["mode"], "title": "Switch Managed IPv4 DHCP Configuration"}}, "required": ["autoScaleEnabled", "hostIpAddress", "prefixLength"], "title": "Switch Managed IPv4 Configuration"}}}], "required": ["cellularBackupEnabled", "deviceId", "enabled", "ipv4Configuration", "isolationEnabled", "name", "vlanId"]}, "IntegrationUnmanagedNetworkCreateUpdateDto": {"allOf": [{"discriminator": {"propertyName": "management", "mapping": {"UNMANAGED": "#/components/schemas/IntegrationUnmanagedNetworkCreateUpdateDto", "GATEWAY": "#/components/schemas/IntegrationGatewayManagedNetworkCreateUpdateDto", "SWITCH": "#/components/schemas/IntegrationSwitchManagedNetworkCreateUpdateDto"}}, "properties": {"management": {"type": "string"}, "name": {"type": "string", "example": "Default Network"}, "enabled": {"type": "boolean"}, "vlanId": {"type": "integer", "format": "int32", "maximum": 4000, "minimum": 2}, "dhcpGuarding": {"description": "DHCP Guarding settings for this Network. If this field is omitted or null, the feature is disabled", "properties": {"trustedDhcpServerIpAddresses": {"type": "array", "description": "List of trusted DHCP server IP addresses.", "items": {"type": "string"}, "minItems": 1}}, "required": ["trustedDhcpServerIpAddresses"], "title": "Network DHCP Guarding"}}, "required": ["enabled", "management", "name", "vlanId"], "title": "Create or update Network"}], "required": ["enabled", "name", "vlanId"]}, "NAT Outbound Auto Configuration": {"allOf": [{"discriminator": {"propertyName": "type", "mapping": {"AUTO": "#/components/schemas/NAT Outbound Auto Configuration", "STATIC": "#/components/schemas/NAT Outbound Static Configuration"}}, "properties": {"type": {"type": "string"}, "wanInterfaceId": {"type": "string", "format": "uuid"}}, "required": ["type", "wanInterfaceId"], "title": "WAN NAT Outbound Configuration"}, {"type": "object", "properties": {"ipAddressSelectionMode": {"type": "string", "description": "IP address selection mode which determines how the IP address will be selected from the group of IP addresses to translate the traffic on network using NAT.", "enum": ["MAIN", "ALL"]}}}], "required": ["ipAddressSelectionMode", "wanInterfaceId"]}, "NAT Outbound Static Configuration": {"allOf": [{"discriminator": {"propertyName": "type", "mapping": {"AUTO": "#/components/schemas/NAT Outbound Auto Configuration", "STATIC": "#/components/schemas/NAT Outbound Static Configuration"}}, "properties": {"type": {"type": "string"}, "wanInterfaceId": {"type": "string", "format": "uuid"}}, "required": ["type", "wanInterfaceId"], "title": "WAN NAT Outbound Configuration"}, {"type": "object", "properties": {"ipAddressSelectors": {"type": "array", "description": "List of IP addresses or address ranges which determines which IP addresses will be used to translate the traffic on network using NAT.", "items": {"discriminator": {"propertyName": "type", "mapping": {"IP_ADDRESS": "#/components/schemas/IP Address selector", "IP_ADDRESS_RANGE": "#/components/schemas/IP address range selector"}}, "properties": {"type": {"type": "string"}}, "required": ["type"], "title": "IP address selector"}, "minItems": 1}}}], "required": ["ipAddressSelectors", "wanInterfaceId"]}, "Network DHCP Guarding": {"description": "Details about DHCP Guarding settings for this Network.", "properties": {"trustedDhcpServerIpAddresses": {"type": "array", "description": "List of trusted DHCP server IP addresses.", "items": {"type": "string"}, "minItems": 1}}, "required": ["trustedDhcpServerIpAddresses"]}, "Network IPv6 Configuration": {"discriminator": {"propertyName": "interfaceType", "mapping": {"PREFIX_DELEGATION": "#/components/schemas/Prefix delegation IPv6 Configuration", "STATIC": "#/components/schemas/IPv6 Static Configuration"}}, "properties": {"interfaceType": {"type": "string"}, "clientAddressAssignment": {"description": "Client Address Assignment", "properties": {"dhcpConfiguration": {"description": "IPv6 DHCP configuration for this network. At least one addressing method must be active: either enable SLAAC or provide DHCP configuration. If this field is null, SLAAC must be enabled.", "properties": {"ipAddressSuffixRange": {"properties": {"start": {"type": "string", "description": "Start suffix of the DHCPv6 address pool."}, "stop": {"type": "string", "description": "End suffix of the DHCPv6 address pool."}}, "required": ["start", "stop"], "title": "IntegrationIpv6AddressSuffixRangeSelectorDto"}, "leaseTimeSeconds": {"type": "integer", "format": "int32", "description": "The lease time in seconds for IP addresses in this range.", "maximum": 31536000, "minimum": 0}}, "required": ["ipAddressSuffixRange", "leaseTimeSeconds"], "title": "DHCP Configuration for IPv6 Network"}, "slaacEnabled": {"type": "boolean", "description": "Allows devices to obtain IPv6 addresses via SLAAC (Stateless Address Autoconfiguration) without DHCPv6. At least one addressing method must be active: either enable SLAAC or provide DHCP configuration."}}, "required": ["slaacEnabled"], "title": "IPv6 Client Address Assignment"}, "routerAdvertisement": {"description": "Router advertisement. Without it, hosts will not autoconfigure addresses and will lack a default route even with DHCPv6.", "properties": {"priority": {"type": "string", "description": "Router advertisement priority.", "enum": ["LOW", "MEDIUM", "HIGH"]}}, "required": ["priority"], "title": "Router advertisement Configuration"}, "dnsServerIpAddressesOverride": {"type": "array", "description": "The IPv6 DNS server addresses assigned to this Network. If none are specified, they will be selected automatically.", "items": {"type": "string"}, "maxItems": 4, "minItems": 1}, "additionalHostIpSubnets": {"type": "array", "description": "Additional host IP subnets assigned to this VLAN.", "items": {"type": "string"}, "maxItems": 4, "minItems": 1}}, "required": ["clientAddressAssignment", "interfaceType"]}, "PXE Configuration": {"properties": {"serverIpAddress": {"type": "string"}, "filename": {"type": "string"}}, "required": ["filename", "serverIpAddress"]}, "Prefix delegation IPv6 Configuration": {"allOf": [{"discriminator": {"propertyName": "interfaceType", "mapping": {"PREFIX_DELEGATION": "#/components/schemas/Prefix delegation IPv6 Configuration", "STATIC": "#/components/schemas/IPv6 Static Configuration"}}, "properties": {"interfaceType": {"type": "string"}, "clientAddressAssignment": {"description": "Client Address Assignment", "properties": {"dhcpConfiguration": {"description": "IPv6 DHCP configuration for this network. At least one addressing method must be active: either enable SLAAC or provide DHCP configuration. If this field is null, SLAAC must be enabled.", "properties": {"ipAddressSuffixRange": {"properties": {"start": {"type": "string", "description": "Start suffix of the DHCPv6 address pool."}, "stop": {"type": "string", "description": "End suffix of the DHCPv6 address pool."}}, "required": ["start", "stop"], "title": "IntegrationIpv6AddressSuffixRangeSelectorDto"}, "leaseTimeSeconds": {"type": "integer", "format": "int32", "description": "The lease time in seconds for IP addresses in this range.", "maximum": 31536000, "minimum": 0}}, "required": ["ipAddressSuffixRange", "leaseTimeSeconds"], "title": "DHCP Configuration for IPv6 Network"}, "slaacEnabled": {"type": "boolean", "description": "Allows devices to obtain IPv6 addresses via SLAAC (Stateless Address Autoconfiguration) without DHCPv6. At least one addressing method must be active: either enable SLAAC or provide DHCP configuration."}}, "required": ["slaacEnabled"], "title": "IPv6 Client Address Assignment"}, "routerAdvertisement": {"description": "Router advertisement. Without it, hosts will not autoconfigure addresses and will lack a default route even with DHCPv6.", "properties": {"priority": {"type": "string", "description": "Router advertisement priority.", "enum": ["LOW", "MEDIUM", "HIGH"]}}, "required": ["priority"], "title": "Router advertisement Configuration"}, "dnsServerIpAddressesOverride": {"type": "array", "description": "The IPv6 DNS server addresses assigned to this Network. If none are specified, they will be selected automatically.", "items": {"type": "string"}, "maxItems": 4, "minItems": 1}, "additionalHostIpSubnets": {"type": "array", "description": "Additional host IP subnets assigned to this VLAN.", "items": {"type": "string"}, "maxItems": 4, "minItems": 1}}, "required": ["clientAddressAssignment", "interfaceType"], "title": "Network IPv6 Configuration"}, {"type": "object", "properties": {"prefixDelegationWanInterfaceId": {"type": "string", "format": "uuid", "description": "ID of the WAN interface from which the prefix is delegated."}}}], "required": ["clientAddressAssignment", "prefixDelegationWanInterfaceId"]}, "Router advertisement Configuration": {"properties": {"priority": {"type": "string", "description": "Router advertisement priority.", "enum": ["LOW", "MEDIUM", "HIGH"]}}, "required": ["priority"]}, "Switch Managed IPv4 Configuration": {"properties": {"autoScaleEnabled": {"type": "boolean", "description": "Whether the Network can automatically scale its subnet size based on the number of active DHCP leases."}, "hostIpAddress": {"type": "string"}, "prefixLength": {"type": "integer", "format": "int32", "maximum": 30, "minimum": 8}, "additionalHostIpSubnets": {"type": "array", "description": "Additional host IP subnets assigned to this VLAN.", "items": {"type": "string"}, "maxItems": 64, "minItems": 1}, "dhcpConfiguration": {"description": "IPv4 DHCP configuration for this network. If this field is omitted or null, DHCP is not working and hosts must get an address statically or from another server in this broadcast domain.", "discriminator": {"propertyName": "mode", "mapping": {"SERVER": "#/components/schemas/IPv4 DHCP Server Configuration", "RELAY": "#/components/schemas/IPv4 DHCP Relay Configuration"}}, "properties": {"mode": {"type": "string"}}, "required": ["mode"], "title": "Switch Managed IPv4 DHCP Configuration"}}, "required": ["autoScaleEnabled", "hostIpAddress", "prefixLength"]}, "Switch Managed IPv4 DHCP Configuration": {"discriminator": {"propertyName": "mode", "mapping": {"SERVER": "#/components/schemas/IPv4 DHCP Server Configuration", "RELAY": "#/components/schemas/IPv4 DHCP Relay Configuration"}}, "properties": {"mode": {"type": "string"}}, "required": ["mode"]}, "WAN NAT Outbound Configuration": {"discriminator": {"propertyName": "type", "mapping": {"AUTO": "#/components/schemas/NAT Outbound Auto Configuration", "STATIC": "#/components/schemas/NAT Outbound Static Configuration"}}, "properties": {"type": {"type": "string"}, "wanInterfaceId": {"type": "string", "format": "uuid"}}, "required": ["type", "wanInterfaceId"]}, "Gateway managed network details": {"allOf": [{"discriminator": {"propertyName": "management", "mapping": {"UNMANAGED": "#/components/schemas/Unmanaged network details", "GATEWAY": "#/components/schemas/Gateway managed network details", "SWITCH": "#/components/schemas/Switch managed network details"}}, "properties": {"management": {"type": "string"}, "id": {"type": "string", "format": "uuid"}, "name": {"type": "string", "example": "Default Network"}, "enabled": {"type": "boolean"}, "vlanId": {"type": "integer", "format": "int32", "minimum": 2}, "metadata": {"description": "Orchestrated or System-defined configurable network support", "discriminator": {"propertyName": "origin", "mapping": {"USER_DEFINED": "#/components/schemas/User defined entity metadata", "SYSTEM_DEFINED": "#/components/schemas/System defined entity metadata", "ORCHESTRATED": "#/components/schemas/Orchestrated entity metadata"}}, "properties": {"origin": {"type": "string"}}, "required": ["origin"], "title": "User or system defined or orchestrated entity metadata"}, "dhcpGuarding": {"description": "DHCP Guarding settings for this Network. If this field is omitted or null, the feature is disabled", "properties": {"trustedDhcpServerIpAddresses": {"type": "array", "description": "List of trusted DHCP server IP addresses.", "items": {"type": "string"}, "minItems": 1}}, "required": ["trustedDhcpServerIpAddresses"], "title": "Network DHCP Guarding"}}, "required": ["enabled", "id", "management", "metadata", "name", "vlanId"], "title": "Network details"}, {"type": "object", "properties": {"isolationEnabled": {"type": "boolean", "description": "Whether this network is isolated from all other networks."}, "cellularBackupEnabled": {"type": "boolean", "description": "Whether this network is allowed to use cellular data when WAN connection(s) are down."}, "zoneId": {"type": "string", "format": "uuid", "description": "Firewall zone ID associated with this Network."}, "internetAccessEnabled": {"type": "boolean", "description": "Whether the internet access is allowed for the device on this network."}, "mdnsForwardingEnabled": {"type": "boolean", "description": "Whether this network should participate in mDNS traffic forwarding."}, "ipv4Configuration": {"description": "Details about IPv4 configuration for this Network.", "properties": {"autoScaleEnabled": {"type": "boolean", "description": "Whether the Network can automatically scale its subnet size based on the number of active DHCP leases."}, "hostIpAddress": {"type": "string"}, "prefixLength": {"type": "integer", "format": "int32", "maximum": 30, "minimum": 8}, "additionalHostIpSubnets": {"type": "array", "description": "Additional host IP subnets assigned to this VLAN.", "items": {"type": "string"}, "maxItems": 64, "minItems": 1}, "dhcpConfiguration": {"description": "IPv4 DHCP configuration for this network. If this field is omitted or null, DHCP is not working and hosts must get an address statically or from another server in this broadcast domain.", "discriminator": {"propertyName": "mode", "mapping": {"SERVER": "#/components/schemas/Gateway Managed IPv4 DHCP Server Configuration", "RELAY": "#/components/schemas/IPv4 DHCP Relay Configuration"}}, "properties": {"mode": {"type": "string"}}, "required": ["mode"], "title": "Gateway Managed IPv4 DHCP Configuration"}, "natOutboundIpAddressConfiguration": {"type": "array", "description": "List of NAT Outbound Configurations defining which IP addresses are used for NAT translation. This array must contain all WAN interfaces with `static` or `PPPoE` IPv4 connection configuration.", "items": {"discriminator": {"propertyName": "type", "mapping": {"AUTO": "#/components/schemas/NAT Outbound Auto Configuration", "STATIC": "#/components/schemas/NAT Outbound Static Configuration"}}, "properties": {"type": {"type": "string"}, "wanInterfaceId": {"type": "string", "format": "uuid"}}, "required": ["type", "wanInterfaceId"], "title": "WAN NAT Outbound Configuration"}, "minItems": 1}}, "required": ["autoScaleEnabled", "hostIpAddress", "prefixLength"], "title": "Gateway Managed IPv4 Configuration"}, "ipv6Configuration": {"description": "Details about IPv6 configuration for this Network. If this field is omitted or null then IPv6 is not configured on this Network.", "discriminator": {"propertyName": "interfaceType", "mapping": {"PREFIX_DELEGATION": "#/components/schemas/Prefix delegation IPv6 Configuration", "STATIC": "#/components/schemas/IPv6 Static Configuration"}}, "properties": {"interfaceType": {"type": "string"}, "clientAddressAssignment": {"description": "Client Address Assignment", "properties": {"dhcpConfiguration": {"description": "IPv6 DHCP configuration for this network. At least one addressing method must be active: either enable SLAAC or provide DHCP configuration. If this field is null, SLAAC must be enabled.", "properties": {"ipAddressSuffixRange": {"properties": {"start": {"type": "string", "description": "Start suffix of the DHCPv6 address pool."}, "stop": {"type": "string", "description": "End suffix of the DHCPv6 address pool."}}, "required": ["start", "stop"], "title": "IntegrationIpv6AddressSuffixRangeSelectorDto"}, "leaseTimeSeconds": {"type": "integer", "format": "int32", "description": "The lease time in seconds for IP addresses in this range.", "maximum": 31536000, "minimum": 0}}, "required": ["ipAddressSuffixRange", "leaseTimeSeconds"], "title": "DHCP Configuration for IPv6 Network"}, "slaacEnabled": {"type": "boolean", "description": "Allows devices to obtain IPv6 addresses via SLAAC (Stateless Address Autoconfiguration) without DHCPv6. At least one addressing method must be active: either enable SLAAC or provide DHCP configuration."}}, "required": ["slaacEnabled"], "title": "IPv6 Client Address Assignment"}, "routerAdvertisement": {"description": "Router advertisement. Without it, hosts will not autoconfigure addresses and will lack a default route even with DHCPv6.", "properties": {"priority": {"type": "string", "description": "Router advertisement priority.", "enum": ["LOW", "MEDIUM", "HIGH"]}}, "required": ["priority"], "title": "Router advertisement Configuration"}, "dnsServerIpAddressesOverride": {"type": "array", "description": "The IPv6 DNS server addresses assigned to this Network. If none are specified, they will be selected automatically.", "items": {"type": "string"}, "maxItems": 4, "minItems": 1}, "additionalHostIpSubnets": {"type": "array", "description": "Additional host IP subnets assigned to this VLAN.", "items": {"type": "string"}, "maxItems": 4, "minItems": 1}}, "required": ["clientAddressAssignment", "interfaceType"], "title": "Network IPv6 Configuration"}}}], "required": ["cellularBackupEnabled", "enabled", "id", "internetAccessEnabled", "ipv4Configuration", "isolationEnabled", "mdnsForwardingEnabled", "metadata", "name", "vlanId", "zoneId"]}, "Network details": {"discriminator": {"propertyName": "management", "mapping": {"UNMANAGED": "#/components/schemas/Unmanaged network details", "GATEWAY": "#/components/schemas/Gateway managed network details", "SWITCH": "#/components/schemas/Switch managed network details"}}, "properties": {"management": {"type": "string"}, "id": {"type": "string", "format": "uuid"}, "name": {"type": "string", "example": "Default Network"}, "enabled": {"type": "boolean"}, "vlanId": {"type": "integer", "format": "int32", "minimum": 2}, "metadata": {"description": "Orchestrated or System-defined configurable network support", "discriminator": {"propertyName": "origin", "mapping": {"USER_DEFINED": "#/components/schemas/User defined entity metadata", "SYSTEM_DEFINED": "#/components/schemas/System defined entity metadata", "ORCHESTRATED": "#/components/schemas/Orchestrated entity metadata"}}, "properties": {"origin": {"type": "string"}}, "required": ["origin"], "title": "User or system defined or orchestrated entity metadata"}, "dhcpGuarding": {"description": "DHCP Guarding settings for this Network. If this field is omitted or null, the feature is disabled", "properties": {"trustedDhcpServerIpAddresses": {"type": "array", "description": "List of trusted DHCP server IP addresses.", "items": {"type": "string"}, "minItems": 1}}, "required": ["trustedDhcpServerIpAddresses"], "title": "Network DHCP Guarding"}}, "required": ["enabled", "id", "management", "metadata", "name", "vlanId"]}, "Switch managed network details": {"allOf": [{"discriminator": {"propertyName": "management", "mapping": {"UNMANAGED": "#/components/schemas/Unmanaged network details", "GATEWAY": "#/components/schemas/Gateway managed network details", "SWITCH": "#/components/schemas/Switch managed network details"}}, "properties": {"management": {"type": "string"}, "id": {"type": "string", "format": "uuid"}, "name": {"type": "string", "example": "Default Network"}, "enabled": {"type": "boolean"}, "vlanId": {"type": "integer", "format": "int32", "minimum": 2}, "metadata": {"description": "Orchestrated or System-defined configurable network support", "discriminator": {"propertyName": "origin", "mapping": {"USER_DEFINED": "#/components/schemas/User defined entity metadata", "SYSTEM_DEFINED": "#/components/schemas/System defined entity metadata", "ORCHESTRATED": "#/components/schemas/Orchestrated entity metadata"}}, "properties": {"origin": {"type": "string"}}, "required": ["origin"], "title": "User or system defined or orchestrated entity metadata"}, "dhcpGuarding": {"description": "DHCP Guarding settings for this Network. If this field is omitted or null, the feature is disabled", "properties": {"trustedDhcpServerIpAddresses": {"type": "array", "description": "List of trusted DHCP server IP addresses.", "items": {"type": "string"}, "minItems": 1}}, "required": ["trustedDhcpServerIpAddresses"], "title": "Network DHCP Guarding"}}, "required": ["enabled", "id", "management", "metadata", "name", "vlanId"], "title": "Network details"}, {"type": "object", "properties": {"isolationEnabled": {"type": "boolean", "description": "Whether this network is isolated from all other networks."}, "cellularBackupEnabled": {"type": "boolean", "description": "Whether this network is allowed to use cellular data when WAN connection(s) are down."}, "deviceId": {"type": "string", "format": "uuid", "description": "ID of the L3 switching capable device that manages this network."}, "ipv4Configuration": {"description": "Details about IPv4 configuration for this Network.", "properties": {"autoScaleEnabled": {"type": "boolean", "description": "Whether the Network can automatically scale its subnet size based on the number of active DHCP leases."}, "hostIpAddress": {"type": "string"}, "prefixLength": {"type": "integer", "format": "int32", "maximum": 30, "minimum": 8}, "additionalHostIpSubnets": {"type": "array", "description": "Additional host IP subnets assigned to this VLAN.", "items": {"type": "string"}, "maxItems": 64, "minItems": 1}, "dhcpConfiguration": {"description": "IPv4 DHCP configuration for this network. If this field is omitted or null, DHCP is not working and hosts must get an address statically or from another server in this broadcast domain.", "discriminator": {"propertyName": "mode", "mapping": {"SERVER": "#/components/schemas/IPv4 DHCP Server Configuration", "RELAY": "#/components/schemas/IPv4 DHCP Relay Configuration"}}, "properties": {"mode": {"type": "string"}}, "required": ["mode"], "title": "Switch Managed IPv4 DHCP Configuration"}}, "required": ["autoScaleEnabled", "hostIpAddress", "prefixLength"], "title": "Switch Managed IPv4 Configuration"}}}], "required": ["cellularBackupEnabled", "deviceId", "enabled", "id", "ipv4Configuration", "isolationEnabled", "metadata", "name", "vlanId"]}, "Unmanaged network details": {"allOf": [{"discriminator": {"propertyName": "management", "mapping": {"UNMANAGED": "#/components/schemas/Unmanaged network details", "GATEWAY": "#/components/schemas/Gateway managed network details", "SWITCH": "#/components/schemas/Switch managed network details"}}, "properties": {"management": {"type": "string"}, "id": {"type": "string", "format": "uuid"}, "name": {"type": "string", "example": "Default Network"}, "enabled": {"type": "boolean"}, "vlanId": {"type": "integer", "format": "int32", "minimum": 2}, "metadata": {"description": "Orchestrated or System-defined configurable network support", "discriminator": {"propertyName": "origin", "mapping": {"USER_DEFINED": "#/components/schemas/User defined entity metadata", "SYSTEM_DEFINED": "#/components/schemas/System defined entity metadata", "ORCHESTRATED": "#/components/schemas/Orchestrated entity metadata"}}, "properties": {"origin": {"type": "string"}}, "required": ["origin"], "title": "User or system defined or orchestrated entity metadata"}, "dhcpGuarding": {"description": "DHCP Guarding settings for this Network. If this field is omitted or null, the feature is disabled", "properties": {"trustedDhcpServerIpAddresses": {"type": "array", "description": "List of trusted DHCP server IP addresses.", "items": {"type": "string"}, "minItems": 1}}, "required": ["trustedDhcpServerIpAddresses"], "title": "Network DHCP Guarding"}}, "required": ["enabled", "id", "management", "metadata", "name", "vlanId"], "title": "Network details"}], "required": ["enabled", "id", "metadata", "name", "vlanId"]}, "Create or update firewall zone": {"properties": {"name": {"type": "string", "description": "Name of a firewall zone", "example": "Hotspot|My custom zone"}, "networkIds": {"type": "array", "description": "List of Network IDs", "items": {"example": "dfb21062-8ea0-4dca-b1d8-1eb3da00e58b"}, "minItems": 0}}, "required": ["name", "networkIds"]}, "Firewall zone": {"properties": {"id": {"type": "string", "format": "uuid", "example": "ffcdb32c-6278-4364-8947-df4f77118df8"}, "name": {"type": "string", "description": "Name of a firewall zone", "example": "Hotspot|My custom zone"}, "networkIds": {"type": "array", "description": "List of Network IDs", "items": {"example": "dfb21062-8ea0-4dca-b1d8-1eb3da00e58b"}, "minItems": 0}, "metadata": {"description": "System-defined configurable zones support configuring only attached networks", "discriminator": {"propertyName": "origin", "mapping": {"USER_DEFINED": "#/components/schemas/User defined entity metadata", "SYSTEM_DEFINED": "#/components/schemas/System defined entity metadata"}}, "properties": {"origin": {"type": "string"}}, "required": ["origin"], "title": "User or system defined entity metadata"}}, "required": ["id", "metadata", "name", "networkIds"]}, "ACL rule device filter": {"discriminator": {"propertyName": "type", "mapping": {"DEVICES": "#/components/schemas/IntegrationAclRuleDevicesFilterDto"}}, "properties": {"type": {"type": "string"}}, "required": ["type"]}, "ACL rule update": {"discriminator": {"propertyName": "type", "mapping": {"IPV4": "#/components/schemas/IntegrationIpAclRuleCreateUpdateDto", "MAC": "#/components/schemas/IntegrationMacAclRuleCreateUpdateDto"}}, "properties": {"type": {"type": "string"}, "enabled": {"type": "boolean", "example": true}, "name": {"type": "string", "description": "ACL rule name"}, "description": {"type": "string", "description": "ACL rule description"}, "action": {"type": "string", "description": "ACL rule action", "enum": ["ALLOW", "BLOCK"], "example": "ALLOW|BLOCK"}, "enforcingDeviceFilter": {"description": "IDs of the Switch-capable devices used to enforce the ACL rule. When null, the rule will be provisioned to all switches on the site.", "discriminator": {"propertyName": "type", "mapping": {"DEVICES": "#/components/schemas/IntegrationAclRuleDevicesFilterDto"}}, "properties": {"type": {"type": "string"}}, "required": ["type"], "title": "ACL rule device filter"}, "index": {"type": "integer", "format": "int32", "description": "ACL rule index. Lower index has higher priority", "minimum": 0}, "sourceFilter": {"description": "Traffic source filter"}, "destinationFilter": {"description": "Traffic destination filter"}}, "required": ["action", "enabled", "index", "name", "type"]}, "IP ACL rule endpoint": {"discriminator": {"propertyName": "type", "mapping": {"IP_ADDRESSES_OR_SUBNETS": "#/components/schemas/IntegrationIpAclRuleSubnetEndpointFilterDto", "NETWORKS": "#/components/schemas/IntegrationIpAclRuleNetworkEndpointFilterDto"}}, "properties": {"type": {"type": "string"}}, "required": ["type"]}, "IntegrationAclRuleDevicesFilterDto": {"allOf": [{"discriminator": {"propertyName": "type", "mapping": {"DEVICES": "#/components/schemas/IntegrationAclRuleDevicesFilterDto"}}, "properties": {"type": {"type": "string"}}, "required": ["type"], "title": "ACL rule device filter"}, {"type": "object", "properties": {"deviceIds": {"type": "array", "description": "List of Switch capable device IDs to which the ACL rule will be provisioned.", "items": {"type": "string", "format": "uuid"}, "minItems": 1, "uniqueItems": true}}}], "required": ["deviceIds"]}, "IntegrationIpAclRuleCreateUpdateDto": {"allOf": [{"discriminator": {"propertyName": "type", "mapping": {"IPV4": "#/components/schemas/IntegrationIpAclRuleCreateUpdateDto", "MAC": "#/components/schemas/IntegrationMacAclRuleCreateUpdateDto"}}, "properties": {"type": {"type": "string"}, "enabled": {"type": "boolean", "example": true}, "name": {"type": "string", "description": "ACL rule name"}, "description": {"type": "string", "description": "ACL rule description"}, "action": {"type": "string", "description": "ACL rule action", "enum": ["ALLOW", "BLOCK"], "example": "ALLOW|BLOCK"}, "enforcingDeviceFilter": {"description": "IDs of the Switch-capable devices used to enforce the ACL rule. When null, the rule will be provisioned to all switches on the site.", "discriminator": {"propertyName": "type", "mapping": {"DEVICES": "#/components/schemas/IntegrationAclRuleDevicesFilterDto"}}, "properties": {"type": {"type": "string"}}, "required": ["type"], "title": "ACL rule device filter"}, "index": {"type": "integer", "format": "int32", "description": "ACL rule index. Lower index has higher priority", "minimum": 0}, "sourceFilter": {"description": "Traffic source filter"}, "destinationFilter": {"description": "Traffic destination filter"}}, "required": ["action", "enabled", "index", "name", "type"], "title": "ACL rule update"}, {"type": "object", "properties": {"sourceFilter": {"description": "Traffic source filter", "discriminator": {"propertyName": "type", "mapping": {"IP_ADDRESSES_OR_SUBNETS": "#/components/schemas/IntegrationIpAclRuleSubnetEndpointFilterDto", "NETWORKS": "#/components/schemas/IntegrationIpAclRuleNetworkEndpointFilterDto"}}, "properties": {"type": {"type": "string"}}, "required": ["type"], "title": "IP ACL rule endpoint"}, "destinationFilter": {"description": "Traffic destination filter", "discriminator": {"propertyName": "type", "mapping": {"IP_ADDRESSES_OR_SUBNETS": "#/components/schemas/IntegrationIpAclRuleSubnetEndpointFilterDto", "NETWORKS": "#/components/schemas/IntegrationIpAclRuleNetworkEndpointFilterDto"}}, "properties": {"type": {"type": "string"}}, "required": ["type"], "title": "IP ACL rule endpoint"}, "protocolFilter": {"type": "array", "description": "Protocols this ACL rule will be applied to. When null, the rule will be applied to all protocols.", "items": {"type": "string", "enum": ["TCP", "UDP"]}, "minItems": 1, "uniqueItems": true}}}], "required": ["action", "enabled", "index", "name"]}, "IntegrationIpAclRuleNetworkEndpointFilterDto": {"allOf": [{"discriminator": {"propertyName": "type", "mapping": {"IP_ADDRESSES_OR_SUBNETS": "#/components/schemas/IntegrationIpAclRuleSubnetEndpointFilterDto", "NETWORKS": "#/components/schemas/IntegrationIpAclRuleNetworkEndpointFilterDto"}}, "properties": {"type": {"type": "string"}}, "required": ["type"], "title": "IP ACL rule endpoint"}, {"type": "object", "properties": {"networkIds": {"type": "array", "description": "Network IDs", "items": {"type": "string", "format": "uuid"}, "minItems": 1, "uniqueItems": true}}}], "required": ["networkIds"]}, "IntegrationIpAclRuleSubnetEndpointFilterDto": {"allOf": [{"discriminator": {"propertyName": "type", "mapping": {"IP_ADDRESSES_OR_SUBNETS": "#/components/schemas/IntegrationIpAclRuleSubnetEndpointFilterDto", "NETWORKS": "#/components/schemas/IntegrationIpAclRuleNetworkEndpointFilterDto"}}, "properties": {"type": {"type": "string"}}, "required": ["type"], "title": "IP ACL rule endpoint"}, {"type": "object", "properties": {"ipAddressesOrSubnets": {"type": "array", "description": "IP addresses or subnets", "items": {"type": "string"}, "minItems": 1}, "portFilter": {"type": "array", "description": "Ports this ACL rule will be applied to. If null, all the rule will be applied to all ports.", "items": {"type": "integer", "format": "int32"}, "minItems": 1, "minimum": 1}}}], "required": ["ipAddressesOrSubnets"]}, "IntegrationMacAclRuleCreateUpdateDto": {"allOf": [{"discriminator": {"propertyName": "type", "mapping": {"IPV4": "#/components/schemas/IntegrationIpAclRuleCreateUpdateDto", "MAC": "#/components/schemas/IntegrationMacAclRuleCreateUpdateDto"}}, "properties": {"type": {"type": "string"}, "enabled": {"type": "boolean", "example": true}, "name": {"type": "string", "description": "ACL rule name"}, "description": {"type": "string", "description": "ACL rule description"}, "action": {"type": "string", "description": "ACL rule action", "enum": ["ALLOW", "BLOCK"], "example": "ALLOW|BLOCK"}, "enforcingDeviceFilter": {"description": "IDs of the Switch-capable devices used to enforce the ACL rule. When null, the rule will be provisioned to all switches on the site.", "discriminator": {"propertyName": "type", "mapping": {"DEVICES": "#/components/schemas/IntegrationAclRuleDevicesFilterDto"}}, "properties": {"type": {"type": "string"}}, "required": ["type"], "title": "ACL rule device filter"}, "index": {"type": "integer", "format": "int32", "description": "ACL rule index. Lower index has higher priority", "minimum": 0}, "sourceFilter": {"description": "Traffic source filter"}, "destinationFilter": {"description": "Traffic destination filter"}}, "required": ["action", "enabled", "index", "name", "type"], "title": "ACL rule update"}, {"type": "object", "properties": {"sourceFilter": {"description": "Traffic source filter", "discriminator": {"propertyName": "type", "mapping": {"MAC_ADDRESSES": "#/components/schemas/IntegrationMacAclRuleMacAddressEndpointFilterDto"}}, "properties": {"type": {"type": "string"}}, "required": ["type"], "title": "MAC ACL rule endpoint"}, "destinationFilter": {"description": "Traffic destination filter", "discriminator": {"propertyName": "type", "mapping": {"MAC_ADDRESSES": "#/components/schemas/IntegrationMacAclRuleMacAddressEndpointFilterDto"}}, "properties": {"type": {"type": "string"}}, "required": ["type"], "title": "MAC ACL rule endpoint"}, "networkIdFilter": {"type": "string", "format": "uuid", "description": "Network ID to which this ACL rule applies"}}}], "required": ["action", "enabled", "index", "name", "networkIdFilter"]}, "IntegrationMacAclRuleMacAddressEndpointFilterDto": {"allOf": [{"discriminator": {"propertyName": "type", "mapping": {"MAC_ADDRESSES": "#/components/schemas/IntegrationMacAclRuleMacAddressEndpointFilterDto"}}, "properties": {"type": {"type": "string"}}, "required": ["type"], "title": "MAC ACL rule endpoint"}, {"type": "object", "properties": {"macAddresses": {"type": "array", "description": "Source/destination MAC addresses this ACL rule will apply to.", "items": {"type": "string"}, "minItems": 1}, "prefixLength": {"type": "integer", "format": "int32", "description": "MAC address prefix length. When null, full MAC address(-es) will be used.", "maximum": 48, "minimum": 1}}}], "required": ["macAddresses"]}, "MAC ACL rule endpoint": {"discriminator": {"propertyName": "type", "mapping": {"MAC_ADDRESSES": "#/components/schemas/IntegrationMacAclRuleMacAddressEndpointFilterDto"}}, "properties": {"type": {"type": "string"}}, "required": ["type"]}, "ACL rule": {"discriminator": {"propertyName": "type", "mapping": {"IPV4": "#/components/schemas/IntegrationIpAclRuleDto", "MAC": "#/components/schemas/IntegrationMacAclRuleDto"}}, "properties": {"type": {"type": "string"}, "id": {"type": "string", "format": "uuid"}, "enabled": {"type": "boolean", "example": true}, "name": {"type": "string", "description": "ACL rule name"}, "description": {"type": "string", "description": "ACL rule description"}, "action": {"type": "string", "description": "ACL rule action", "enum": ["ALLOW", "BLOCK"], "example": "ALLOW|BLOCK"}, "enforcingDeviceFilter": {"description": "IDs of the Switch-capable devices used to enforce the ACL rule. When null, the rule will be provisioned to all switches on the site.", "discriminator": {"propertyName": "type", "mapping": {"DEVICES": "#/components/schemas/IntegrationAclRuleDevicesFilterDto"}}, "properties": {"type": {"type": "string"}}, "required": ["type"], "title": "ACL rule device filter"}, "index": {"type": "integer", "format": "int32", "description": "ACL rule index. Lower index has higher priority", "minimum": 0}, "sourceFilter": {"description": "Traffic source filter"}, "destinationFilter": {"description": "Traffic destination filter"}, "metadata": {"description": "Only user-defined rules can be deleted or modified", "discriminator": {"propertyName": "origin", "mapping": {"USER_DEFINED": "#/components/schemas/User defined entity metadata", "SYSTEM_DEFINED": "#/components/schemas/System defined entity metadata", "DERIVED": "#/components/schemas/Derived entity metadata", "ORCHESTRATED": "#/components/schemas/Orchestrated entity metadata"}}, "properties": {"origin": {"type": "string"}}, "required": ["origin"], "title": "Entity metadata"}}, "required": ["action", "enabled", "id", "index", "metadata", "name", "type"]}, "IntegrationIpAclRuleDto": {"allOf": [{"discriminator": {"propertyName": "type", "mapping": {"IPV4": "#/components/schemas/IntegrationIpAclRuleDto", "MAC": "#/components/schemas/IntegrationMacAclRuleDto"}}, "properties": {"type": {"type": "string"}, "id": {"type": "string", "format": "uuid"}, "enabled": {"type": "boolean", "example": true}, "name": {"type": "string", "description": "ACL rule name"}, "description": {"type": "string", "description": "ACL rule description"}, "action": {"type": "string", "description": "ACL rule action", "enum": ["ALLOW", "BLOCK"], "example": "ALLOW|BLOCK"}, "enforcingDeviceFilter": {"description": "IDs of the Switch-capable devices used to enforce the ACL rule. When null, the rule will be provisioned to all switches on the site.", "discriminator": {"propertyName": "type", "mapping": {"DEVICES": "#/components/schemas/IntegrationAclRuleDevicesFilterDto"}}, "properties": {"type": {"type": "string"}}, "required": ["type"], "title": "ACL rule device filter"}, "index": {"type": "integer", "format": "int32", "description": "ACL rule index. Lower index has higher priority", "minimum": 0}, "sourceFilter": {"description": "Traffic source filter"}, "destinationFilter": {"description": "Traffic destination filter"}, "metadata": {"description": "Only user-defined rules can be deleted or modified", "discriminator": {"propertyName": "origin", "mapping": {"USER_DEFINED": "#/components/schemas/User defined entity metadata", "SYSTEM_DEFINED": "#/components/schemas/System defined entity metadata", "DERIVED": "#/components/schemas/Derived entity metadata", "ORCHESTRATED": "#/components/schemas/Orchestrated entity metadata"}}, "properties": {"origin": {"type": "string"}}, "required": ["origin"], "title": "Entity metadata"}}, "required": ["action", "enabled", "id", "index", "metadata", "name", "type"], "title": "ACL rule"}, {"type": "object", "properties": {"sourceFilter": {"description": "Traffic source filter", "discriminator": {"propertyName": "type", "mapping": {"IP_ADDRESSES_OR_SUBNETS": "#/components/schemas/IntegrationIpAclRuleSubnetEndpointFilterDto", "NETWORKS": "#/components/schemas/IntegrationIpAclRuleNetworkEndpointFilterDto"}}, "properties": {"type": {"type": "string"}}, "required": ["type"], "title": "IP ACL rule endpoint"}, "destinationFilter": {"description": "Traffic destination filter", "discriminator": {"propertyName": "type", "mapping": {"IP_ADDRESSES_OR_SUBNETS": "#/components/schemas/IntegrationIpAclRuleSubnetEndpointFilterDto", "NETWORKS": "#/components/schemas/IntegrationIpAclRuleNetworkEndpointFilterDto"}}, "properties": {"type": {"type": "string"}}, "required": ["type"], "title": "IP ACL rule endpoint"}, "protocolFilter": {"type": "array", "description": "Protocols this ACL rule will be applied to. When null, the rule will be applied to all protocols.", "items": {"type": "string", "enum": ["TCP", "UDP"]}, "minItems": 1, "uniqueItems": true}}}, {"discriminator": {"propertyName": "type", "mapping": {"IPV4": "#/components/schemas/IntegrationIpAclRuleDto", "MAC": "#/components/schemas/IntegrationMacAclRuleDto"}}, "properties": {"type": {"type": "string"}, "id": {"type": "string", "format": "uuid"}, "enabled": {"type": "boolean", "example": true}, "name": {"type": "string", "description": "ACL rule name"}, "description": {"type": "string", "description": "ACL rule description"}, "action": {"type": "string", "description": "ACL rule action", "enum": ["ALLOW", "BLOCK"], "example": "ALLOW|BLOCK"}, "enforcingDeviceFilter": {"description": "IDs of the Switch-capable devices used to enforce the ACL rule. When null, the rule will be provisioned to all switches on the site.", "discriminator": {"propertyName": "type", "mapping": {"DEVICES": "#/components/schemas/IntegrationAclRuleDevicesFilterDto"}}, "properties": {"type": {"type": "string"}}, "required": ["type"], "title": "ACL rule device filter"}, "index": {"type": "integer", "format": "int32", "description": "ACL rule index. Lower index has higher priority", "minimum": 0}, "sourceFilter": {"description": "Traffic source filter"}, "destinationFilter": {"description": "Traffic destination filter"}, "metadata": {"description": "Only user-defined rules can be deleted or modified", "discriminator": {"propertyName": "origin", "mapping": {"USER_DEFINED": "#/components/schemas/User defined entity metadata", "SYSTEM_DEFINED": "#/components/schemas/System defined entity metadata", "DERIVED": "#/components/schemas/Derived entity metadata", "ORCHESTRATED": "#/components/schemas/Orchestrated entity metadata"}}, "properties": {"origin": {"type": "string"}}, "required": ["origin"], "title": "Entity metadata"}}, "required": ["action", "enabled", "id", "index", "metadata", "name", "type"], "title": "ACL ruleObject"}], "required": ["action", "enabled", "id", "index", "metadata", "name"]}, "IntegrationMacAclRuleDto": {"allOf": [{"discriminator": {"propertyName": "type", "mapping": {"IPV4": "#/components/schemas/IntegrationIpAclRuleDto", "MAC": "#/components/schemas/IntegrationMacAclRuleDto"}}, "properties": {"type": {"type": "string"}, "id": {"type": "string", "format": "uuid"}, "enabled": {"type": "boolean", "example": true}, "name": {"type": "string", "description": "ACL rule name"}, "description": {"type": "string", "description": "ACL rule description"}, "action": {"type": "string", "description": "ACL rule action", "enum": ["ALLOW", "BLOCK"], "example": "ALLOW|BLOCK"}, "enforcingDeviceFilter": {"description": "IDs of the Switch-capable devices used to enforce the ACL rule. When null, the rule will be provisioned to all switches on the site.", "discriminator": {"propertyName": "type", "mapping": {"DEVICES": "#/components/schemas/IntegrationAclRuleDevicesFilterDto"}}, "properties": {"type": {"type": "string"}}, "required": ["type"], "title": "ACL rule device filter"}, "index": {"type": "integer", "format": "int32", "description": "ACL rule index. Lower index has higher priority", "minimum": 0}, "sourceFilter": {"description": "Traffic source filter"}, "destinationFilter": {"description": "Traffic destination filter"}, "metadata": {"description": "Only user-defined rules can be deleted or modified", "discriminator": {"propertyName": "origin", "mapping": {"USER_DEFINED": "#/components/schemas/User defined entity metadata", "SYSTEM_DEFINED": "#/components/schemas/System defined entity metadata", "DERIVED": "#/components/schemas/Derived entity metadata", "ORCHESTRATED": "#/components/schemas/Orchestrated entity metadata"}}, "properties": {"origin": {"type": "string"}}, "required": ["origin"], "title": "Entity metadata"}}, "required": ["action", "enabled", "id", "index", "metadata", "name", "type"], "title": "ACL rule"}, {"type": "object", "properties": {"sourceFilter": {"description": "Traffic source filter", "discriminator": {"propertyName": "type", "mapping": {"MAC_ADDRESSES": "#/components/schemas/IntegrationMacAclRuleMacAddressEndpointFilterDto"}}, "properties": {"type": {"type": "string"}}, "required": ["type"], "title": "MAC ACL rule endpoint"}, "destinationFilter": {"description": "Traffic destination filter", "discriminator": {"propertyName": "type", "mapping": {"MAC_ADDRESSES": "#/components/schemas/IntegrationMacAclRuleMacAddressEndpointFilterDto"}}, "properties": {"type": {"type": "string"}}, "required": ["type"], "title": "MAC ACL rule endpoint"}, "networkIdFilter": {"type": "string", "format": "uuid", "description": "Network ID to which this ACL rule applies"}}}, {"discriminator": {"propertyName": "type", "mapping": {"IPV4": "#/components/schemas/IntegrationIpAclRuleDto", "MAC": "#/components/schemas/IntegrationMacAclRuleDto"}}, "properties": {"type": {"type": "string"}, "id": {"type": "string", "format": "uuid"}, "enabled": {"type": "boolean", "example": true}, "name": {"type": "string", "description": "ACL rule name"}, "description": {"type": "string", "description": "ACL rule description"}, "action": {"type": "string", "description": "ACL rule action", "enum": ["ALLOW", "BLOCK"], "example": "ALLOW|BLOCK"}, "enforcingDeviceFilter": {"description": "IDs of the Switch-capable devices used to enforce the ACL rule. When null, the rule will be provisioned to all switches on the site.", "discriminator": {"propertyName": "type", "mapping": {"DEVICES": "#/components/schemas/IntegrationAclRuleDevicesFilterDto"}}, "properties": {"type": {"type": "string"}}, "required": ["type"], "title": "ACL rule device filter"}, "index": {"type": "integer", "format": "int32", "description": "ACL rule index. Lower index has higher priority", "minimum": 0}, "sourceFilter": {"description": "Traffic source filter"}, "destinationFilter": {"description": "Traffic destination filter"}, "metadata": {"description": "Only user-defined rules can be deleted or modified", "discriminator": {"propertyName": "origin", "mapping": {"USER_DEFINED": "#/components/schemas/User defined entity metadata", "SYSTEM_DEFINED": "#/components/schemas/System defined entity metadata", "DERIVED": "#/components/schemas/Derived entity metadata", "ORCHESTRATED": "#/components/schemas/Orchestrated entity metadata"}}, "properties": {"origin": {"type": "string"}}, "required": ["origin"], "title": "Entity metadata"}}, "required": ["action", "enabled", "id", "index", "metadata", "name", "type"], "title": "ACL ruleObject"}], "required": ["action", "enabled", "id", "index", "metadata", "name", "networkIdFilter"]}, "Hotspot voucher creation request": {"properties": {"count": {"type": "integer", "format": "int32", "default": "1", "description": "Number of vouchers to generate", "maximum": 1000, "minimum": 1}, "name": {"type": "string", "description": "Voucher note, duplicated across all generated vouchers"}, "authorizedGuestLimit": {"type": "integer", "format": "int64", "description": "(Optional) limit for how many different guests can use the same voucher to authorize network access", "example": 1, "minimum": 1}, "timeLimitMinutes": {"type": "integer", "format": "int64", "description": "How long (in minutes) the voucher will provide access to the network since authorization of the first guest.\nSubsequently connected guests, if allowed, will share the same expiration time.", "maximum": 1000000, "minimum": 1}, "dataUsageLimitMBytes": {"type": "integer", "format": "int64", "description": "(Optional) data usage limit in megabytes", "maximum": 1048576, "minimum": 1}, "rxRateLimitKbps": {"type": "integer", "format": "int64", "description": "(Optional) download rate limit in kilobits per second", "maximum": 100000, "minimum": 2}, "txRateLimitKbps": {"type": "integer", "format": "int64", "description": "(Optional) upload rate limit in kilobits per second", "maximum": 100000, "minimum": 2}}, "required": ["name", "timeLimitMinutes"]}, "Hotspot voucher details": {"properties": {"id": {"type": "string", "format": "uuid"}, "createdAt": {"type": "string", "format": "date-time"}, "name": {"type": "string", "description": "Voucher note, may contain duplicate values across multiple vouchers", "example": "hotel-guest"}, "code": {"type": "string", "description": "Secret code to active the voucher using the Hotspot portal", "example": 4861409510}, "authorizedGuestLimit": {"type": "integer", "format": "int64", "description": "(Optional) limit for how many different guests can use the same voucher to authorize network access", "example": 1}, "authorizedGuestCount": {"type": "integer", "format": "int64", "description": "For how many guests the voucher has been used to authorize network access", "example": 0}, "activatedAt": {"type": "string", "format": "date-time", "description": "(Optional) timestamp when the voucher has been activated (authorization time of the first guest)"}, "expiresAt": {"type": "string", "format": "date-time", "description": "(Optional) timestamp when the voucher will become expired. All guests using the voucher will be unauthorized from network access"}, "expired": {"type": "boolean", "description": "Whether the voucher has been expired and can no longer be used to authorize network access"}, "timeLimitMinutes": {"type": "integer", "format": "int64", "description": "How long (in minutes) the voucher will provide access to the network since authorization of the first guest.\nSubsequently connected guests, if allowed, will share the same expiration time.", "example": 1440}, "dataUsageLimitMBytes": {"type": "integer", "format": "int64", "description": "(Optional) data usage limit in megabytes", "example": 1024}, "rxRateLimitKbps": {"type": "integer", "format": "int64", "description": "(Optional) download rate limit in kilobits per second", "example": 1000}, "txRateLimitKbps": {"type": "integer", "format": "int64", "description": "(Optional) upload rate limit in kilobits per second", "example": 1000}}, "required": ["authorizedGuestCount", "code", "createdAt", "expired", "id", "name", "timeLimitMinutes"]}, "IntegrationVoucherCreationResultDto": {"properties": {"vouchers": {"type": "array", "items": {"properties": {"id": {"type": "string", "format": "uuid"}, "createdAt": {"type": "string", "format": "date-time"}, "name": {"type": "string", "description": "Voucher note, may contain duplicate values across multiple vouchers", "example": "hotel-guest"}, "code": {"type": "string", "description": "Secret code to active the voucher using the Hotspot portal", "example": 4861409510}, "authorizedGuestLimit": {"type": "integer", "format": "int64", "description": "(Optional) limit for how many different guests can use the same voucher to authorize network access", "example": 1}, "authorizedGuestCount": {"type": "integer", "format": "int64", "description": "For how many guests the voucher has been used to authorize network access", "example": 0}, "activatedAt": {"type": "string", "format": "date-time", "description": "(Optional) timestamp when the voucher has been activated (authorization time of the first guest)"}, "expiresAt": {"type": "string", "format": "date-time", "description": "(Optional) timestamp when the voucher will become expired. All guests using the voucher will be unauthorized from network access"}, "expired": {"type": "boolean", "description": "Whether the voucher has been expired and can no longer be used to authorize network access"}, "timeLimitMinutes": {"type": "integer", "format": "int64", "description": "How long (in minutes) the voucher will provide access to the network since authorization of the first guest.\nSubsequently connected guests, if allowed, will share the same expiration time.", "example": 1440}, "dataUsageLimitMBytes": {"type": "integer", "format": "int64", "description": "(Optional) data usage limit in megabytes", "example": 1024}, "rxRateLimitKbps": {"type": "integer", "format": "int64", "description": "(Optional) download rate limit in kilobits per second", "example": 1000}, "txRateLimitKbps": {"type": "integer", "format": "int64", "description": "(Optional) upload rate limit in kilobits per second", "example": 1000}}, "required": ["authorizedGuestCount", "code", "createdAt", "expired", "id", "name", "timeLimitMinutes"], "title": "Hotspot voucher details"}}}}, "Port PoE power-cycle request": {"allOf": [{"discriminator": {"propertyName": "action", "mapping": {"POWER_CYCLE": "#/components/schemas/Port PoE power-cycle request"}}, "properties": {"action": {"type": "string"}}, "required": ["action"], "title": "Port action request"}]}, "Port action request": {"discriminator": {"propertyName": "action", "mapping": {"POWER_CYCLE": "#/components/schemas/Port PoE power-cycle request"}}, "properties": {"action": {"type": "string"}}, "required": ["action"]}, "Device action request": {"discriminator": {"propertyName": "action", "mapping": {"RESTART": "#/components/schemas/Device restart request"}}, "properties": {"action": {"type": "string"}}, "required": ["action"]}, "Device restart request": {"allOf": [{"discriminator": {"propertyName": "action", "mapping": {"RESTART": "#/components/schemas/Device restart request"}}, "properties": {"action": {"type": "string"}}, "required": ["action"], "title": "Device action request"}]}, "Client action request": {"discriminator": {"propertyName": "action", "mapping": {"AUTHORIZE_GUEST_ACCESS": "#/components/schemas/Guest access authorization request", "UNAUTHORIZE_GUEST_ACCESS": "#/components/schemas/Guest access unauthorization request"}}, "properties": {"action": {"type": "string"}}, "required": ["action"]}, "Guest access authorization request": {"allOf": [{"discriminator": {"propertyName": "action", "mapping": {"AUTHORIZE_GUEST_ACCESS": "#/components/schemas/Guest access authorization request", "UNAUTHORIZE_GUEST_ACCESS": "#/components/schemas/Guest access unauthorization request"}}, "properties": {"action": {"type": "string"}}, "required": ["action"], "title": "Client action request"}, {"type": "object", "properties": {"timeLimitMinutes": {"type": "integer", "format": "int64", "description": "(Optional) how long (in minutes) the guest will be authorized to access the network.\nIf not specified, the default limit is used from the site settings", "maximum": 1000000, "minimum": 1}, "dataUsageLimitMBytes": {"type": "integer", "format": "int64", "description": "(Optional) data usage limit in megabytes", "maximum": 1048576, "minimum": 1}, "rxRateLimitKbps": {"type": "integer", "format": "int64", "description": "(Optional) download rate limit in kilobits per second", "maximum": 100000, "minimum": 2}, "txRateLimitKbps": {"type": "integer", "format": "int64", "description": "(Optional) upload rate limit in kilobits per second", "maximum": 100000, "minimum": 2}}}], "description": "Authorizes network access to a guest client. Client must be a guest.\nThis action cancels existing active authorization (if exists), creates a new one with new limits\nand resets guest traffic counters."}, "Guest access unauthorization request": {"allOf": [{"discriminator": {"propertyName": "action", "mapping": {"AUTHORIZE_GUEST_ACCESS": "#/components/schemas/Guest access authorization request", "UNAUTHORIZE_GUEST_ACCESS": "#/components/schemas/Guest access unauthorization request"}}, "properties": {"action": {"type": "string"}}, "required": ["action"], "title": "Client action request"}], "description": "Unauthorizes network access and disconnects a guest client."}, "Client action response": {"discriminator": {"propertyName": "action", "mapping": {"AUTHORIZE_GUEST_ACCESS": "#/components/schemas/Guest access authorization response", "UNAUTHORIZE_GUEST_ACCESS": "#/components/schemas/Guest access unauthorization response"}}, "properties": {"action": {"type": "string"}}, "required": ["action"]}, "Guest access authorization response": {"allOf": [{"discriminator": {"propertyName": "action", "mapping": {"AUTHORIZE_GUEST_ACCESS": "#/components/schemas/Guest access authorization response", "UNAUTHORIZE_GUEST_ACCESS": "#/components/schemas/Guest access unauthorization response"}}, "properties": {"action": {"type": "string"}}, "required": ["action"], "title": "Client action response"}, {"type": "object", "properties": {"revokedAuthorization": {"description": "(Optional) Revoked authorization in case the guest was already authorized at the time of this request", "properties": {"authorizedAt": {"type": "string", "format": "date-time", "description": "Timestamp when the guest has been authorized"}, "authorizationMethod": {"type": "string", "description": "Guest authorization method (API, Voucher etc)", "enum": ["VOUCHER", "API", "OTHER"]}, "expiresAt": {"type": "string", "format": "date-time", "description": "Timestamp when the guest will get automatically unauthorized"}, "dataUsageLimitMBytes": {"type": "integer", "format": "int64", "description": "(Optional) data usage limit in megabytes", "example": 1024}, "rxRateLimitKbps": {"type": "integer", "format": "int64", "description": "(Optional) download rate limit in kilobits per second", "example": 1000}, "txRateLimitKbps": {"type": "integer", "format": "int64", "description": "(Optional) upload rate limit in kilobits per second", "example": 1000}, "usage": {"properties": {"durationSec": {"type": "integer", "format": "int64"}, "rxBytes": {"type": "integer", "format": "int64"}, "txBytes": {"type": "integer", "format": "int64"}, "bytes": {"type": "integer", "format": "int64"}}, "required": ["bytes", "durationSec", "rxBytes", "txBytes"], "title": "Guest authorization usage details"}}, "required": ["authorizationMethod", "authorizedAt", "expiresAt"], "title": "Guest authorization details"}, "grantedAuthorization": {"description": "Granted guest authorization", "properties": {"authorizedAt": {"type": "string", "format": "date-time", "description": "Timestamp when the guest has been authorized"}, "authorizationMethod": {"type": "string", "description": "Guest authorization method (API, Voucher etc)", "enum": ["VOUCHER", "API", "OTHER"]}, "expiresAt": {"type": "string", "format": "date-time", "description": "Timestamp when the guest will get automatically unauthorized"}, "dataUsageLimitMBytes": {"type": "integer", "format": "int64", "description": "(Optional) data usage limit in megabytes", "example": 1024}, "rxRateLimitKbps": {"type": "integer", "format": "int64", "description": "(Optional) download rate limit in kilobits per second", "example": 1000}, "txRateLimitKbps": {"type": "integer", "format": "int64", "description": "(Optional) upload rate limit in kilobits per second", "example": 1000}, "usage": {"properties": {"durationSec": {"type": "integer", "format": "int64"}, "rxBytes": {"type": "integer", "format": "int64"}, "txBytes": {"type": "integer", "format": "int64"}, "bytes": {"type": "integer", "format": "int64"}}, "required": ["bytes", "durationSec", "rxBytes", "txBytes"], "title": "Guest authorization usage details"}}, "required": ["authorizationMethod", "authorizedAt", "expiresAt"], "title": "Guest authorization details"}}}], "required": ["grantedAuthorization"]}, "Guest access unauthorization response": {"allOf": [{"discriminator": {"propertyName": "action", "mapping": {"AUTHORIZE_GUEST_ACCESS": "#/components/schemas/Guest access authorization response", "UNAUTHORIZE_GUEST_ACCESS": "#/components/schemas/Guest access unauthorization response"}}, "properties": {"action": {"type": "string"}}, "required": ["action"], "title": "Client action response"}, {"type": "object", "properties": {"revokedAuthorization": {"description": "Revoked guest authorization", "properties": {"authorizedAt": {"type": "string", "format": "date-time", "description": "Timestamp when the guest has been authorized"}, "authorizationMethod": {"type": "string", "description": "Guest authorization method (API, Voucher etc)", "enum": ["VOUCHER", "API", "OTHER"]}, "expiresAt": {"type": "string", "format": "date-time", "description": "Timestamp when the guest will get automatically unauthorized"}, "dataUsageLimitMBytes": {"type": "integer", "format": "int64", "description": "(Optional) data usage limit in megabytes", "example": 1024}, "rxRateLimitKbps": {"type": "integer", "format": "int64", "description": "(Optional) download rate limit in kilobits per second", "example": 1000}, "txRateLimitKbps": {"type": "integer", "format": "int64", "description": "(Optional) upload rate limit in kilobits per second", "example": 1000}, "usage": {"properties": {"durationSec": {"type": "integer", "format": "int64"}, "rxBytes": {"type": "integer", "format": "int64"}, "txBytes": {"type": "integer", "format": "int64"}, "bytes": {"type": "integer", "format": "int64"}}, "required": ["bytes", "durationSec", "rxBytes", "txBytes"], "title": "Guest authorization usage details"}}, "required": ["authorizationMethod", "authorizedAt", "expiresAt"], "title": "Guest authorization details"}}}], "required": ["revokedAuthorization"]}, "Guest authorization details": {"properties": {"authorizedAt": {"type": "string", "format": "date-time", "description": "Timestamp when the guest has been authorized"}, "authorizationMethod": {"type": "string", "description": "Guest authorization method (API, Voucher etc)", "enum": ["VOUCHER", "API", "OTHER"]}, "expiresAt": {"type": "string", "format": "date-time", "description": "Timestamp when the guest will get automatically unauthorized"}, "dataUsageLimitMBytes": {"type": "integer", "format": "int64", "description": "(Optional) data usage limit in megabytes", "example": 1024}, "rxRateLimitKbps": {"type": "integer", "format": "int64", "description": "(Optional) download rate limit in kilobits per second", "example": 1000}, "txRateLimitKbps": {"type": "integer", "format": "int64", "description": "(Optional) upload rate limit in kilobits per second", "example": 1000}, "usage": {"properties": {"durationSec": {"type": "integer", "format": "int64"}, "rxBytes": {"type": "integer", "format": "int64"}, "txBytes": {"type": "integer", "format": "int64"}, "bytes": {"type": "integer", "format": "int64"}}, "required": ["bytes", "durationSec", "rxBytes", "txBytes"], "title": "Guest authorization usage details"}}, "required": ["authorizationMethod", "authorizedAt", "expiresAt"]}, "Guest authorization usage details": {"properties": {"durationSec": {"type": "integer", "format": "int64"}, "rxBytes": {"type": "integer", "format": "int64"}, "txBytes": {"type": "integer", "format": "int64"}, "bytes": {"type": "integer", "format": "int64"}}, "required": ["bytes", "durationSec", "rxBytes", "txBytes"]}, "Site overview": {"properties": {"id": {"type": "string", "format": "uuid"}, "internalReference": {"type": "string", "description": "Internal unique name of the site used in older APIs"}, "name": {"type": "string"}}, "required": ["id", "internalReference", "name"]}, "Site overview page": {"properties": {"offset": {"type": "integer", "format": "int64", "example": 0}, "limit": {"type": "integer", "format": "int32", "example": 25}, "count": {"type": "integer", "format": "int32", "example": 10}, "totalCount": {"type": "integer", "format": "int64", "example": 1000}, "data": {"type": "array", "items": {"properties": {"id": {"type": "string", "format": "uuid"}, "internalReference": {"type": "string", "description": "Internal unique name of the site used in older APIs"}, "name": {"type": "string"}}, "required": ["id", "internalReference", "name"], "title": "Site overview"}}}, "required": ["count", "data", "limit", "offset", "totalCount"]}, "IntegrationIotOptimizedWifiBroadcastOverviewDto": {"allOf": [{"discriminator": {"propertyName": "type", "mapping": {"STANDARD": "#/components/schemas/IntegrationStandardWifiBroadcastOverviewDto", "IOT_OPTIMIZED": "#/components/schemas/IntegrationIotOptimizedWifiBroadcastOverviewDto"}}, "properties": {"type": {"type": "string"}, "id": {"type": "string", "format": "uuid"}, "name": {"type": "string"}, "enabled": {"type": "boolean"}, "metadata": {"discriminator": {"propertyName": "origin", "mapping": {"USER_DEFINED": "#/components/schemas/User defined entity metadata", "DERIVED": "#/components/schemas/Derived entity metadata", "ORCHESTRATED": "#/components/schemas/Orchestrated entity metadata"}}, "properties": {"origin": {"type": "string"}}, "required": ["origin"], "title": "User or derived or orchestrated entity metadata"}, "network": {"discriminator": {"propertyName": "type", "mapping": {"NATIVE": "#/components/schemas/IntegrationWifiNativeNetworkDto", "SPECIFIC": "#/components/schemas/IntegrationWifiSpecificNetworkDto"}}, "properties": {"type": {"type": "string"}}, "required": ["type"], "title": "Wifi network reference"}, "securityConfiguration": {"discriminator": {"propertyName": "type", "mapping": {"OPEN": "#/components/schemas/IntegrationWifiOpenSecurityConfigurationOverviewDto", "WPA2_PERSONAL": "#/components/schemas/IntegrationWifiWpa2PersonalSecurityConfigurationOverviewDto", "WPA3_PERSONAL": "#/components/schemas/IntegrationWifiWpa3PersonalSecurityConfigurationOverviewDto", "WPA2_WPA3_PERSONAL": "#/components/schemas/IntegrationWifiWpa2Wpa3PersonalSecurityConfigurationOverviewDto", "WPA2_ENTERPRISE": "#/components/schemas/IntegrationWifiWpa2EnterpriseSecurityConfigurationOverviewDto", "WPA3_ENTERPRISE": "#/components/schemas/IntegrationWifiWpa3EnterpriseSecurityConfigurationOverviewDto", "WPA2_WPA3_ENTERPRISE": "#/components/schemas/IntegrationWifiWpa2Wpa3EnterpriseSecurityConfigurationOverviewDto"}}, "properties": {"type": {"type": "string"}}, "required": ["type"], "title": "Wifi security configuration overview"}, "broadcastingDeviceFilter": {"description": "Defines the custom scope of devices that will broadcast this WiFi network. If null, the WiFi network will be broadcast by all Access Point capable devices.", "discriminator": {"propertyName": "type", "mapping": {"DEVICES": "#/components/schemas/IntegrationWifiDevicesFilterDto", "DEVICE_TAGS": "#/components/schemas/IntegrationWifiDeviceTagsFilterDto"}}, "properties": {"type": {"type": "string"}}, "required": ["type"], "title": "Broadcasting device filter"}}, "required": ["enabled", "id", "metadata", "name", "securityConfiguration", "type"], "title": "Wifi broadcast overview"}], "required": ["enabled", "id", "metadata", "name", "securityConfiguration"]}, "IntegrationStandardWifiBroadcastOverviewDto": {"allOf": [{"discriminator": {"propertyName": "type", "mapping": {"STANDARD": "#/components/schemas/IntegrationStandardWifiBroadcastOverviewDto", "IOT_OPTIMIZED": "#/components/schemas/IntegrationIotOptimizedWifiBroadcastOverviewDto"}}, "properties": {"type": {"type": "string"}, "id": {"type": "string", "format": "uuid"}, "name": {"type": "string"}, "enabled": {"type": "boolean"}, "metadata": {"discriminator": {"propertyName": "origin", "mapping": {"USER_DEFINED": "#/components/schemas/User defined entity metadata", "DERIVED": "#/components/schemas/Derived entity metadata", "ORCHESTRATED": "#/components/schemas/Orchestrated entity metadata"}}, "properties": {"origin": {"type": "string"}}, "required": ["origin"], "title": "User or derived or orchestrated entity metadata"}, "network": {"discriminator": {"propertyName": "type", "mapping": {"NATIVE": "#/components/schemas/IntegrationWifiNativeNetworkDto", "SPECIFIC": "#/components/schemas/IntegrationWifiSpecificNetworkDto"}}, "properties": {"type": {"type": "string"}}, "required": ["type"], "title": "Wifi network reference"}, "securityConfiguration": {"discriminator": {"propertyName": "type", "mapping": {"OPEN": "#/components/schemas/IntegrationWifiOpenSecurityConfigurationOverviewDto", "WPA2_PERSONAL": "#/components/schemas/IntegrationWifiWpa2PersonalSecurityConfigurationOverviewDto", "WPA3_PERSONAL": "#/components/schemas/IntegrationWifiWpa3PersonalSecurityConfigurationOverviewDto", "WPA2_WPA3_PERSONAL": "#/components/schemas/IntegrationWifiWpa2Wpa3PersonalSecurityConfigurationOverviewDto", "WPA2_ENTERPRISE": "#/components/schemas/IntegrationWifiWpa2EnterpriseSecurityConfigurationOverviewDto", "WPA3_ENTERPRISE": "#/components/schemas/IntegrationWifiWpa3EnterpriseSecurityConfigurationOverviewDto", "WPA2_WPA3_ENTERPRISE": "#/components/schemas/IntegrationWifiWpa2Wpa3EnterpriseSecurityConfigurationOverviewDto"}}, "properties": {"type": {"type": "string"}}, "required": ["type"], "title": "Wifi security configuration overview"}, "broadcastingDeviceFilter": {"description": "Defines the custom scope of devices that will broadcast this WiFi network. If null, the WiFi network will be broadcast by all Access Point capable devices.", "discriminator": {"propertyName": "type", "mapping": {"DEVICES": "#/components/schemas/IntegrationWifiDevicesFilterDto", "DEVICE_TAGS": "#/components/schemas/IntegrationWifiDeviceTagsFilterDto"}}, "properties": {"type": {"type": "string"}}, "required": ["type"], "title": "Broadcasting device filter"}}, "required": ["enabled", "id", "metadata", "name", "securityConfiguration", "type"], "title": "Wifi broadcast overview"}, {"type": "object", "properties": {"broadcastingFrequenciesGHz": {"type": "array", "items": {"type": "string", "enum": ["2.4", "5", "6"]}, "minItems": 1, "uniqueItems": true}, "hotspotConfiguration": {"properties": {"type": {"type": "string", "enum": ["CAPTIVE_PORTAL", "PASSPOINT"]}}, "required": ["type"], "title": "IntegrationWifiHotspotConfigurationOverviewDto"}}}], "required": ["broadcastingFrequenciesGHz", "enabled", "id", "metadata", "name", "securityConfiguration"]}, "IntegrationWifiBroadcastPageDto": {"properties": {"offset": {"type": "integer", "format": "int64", "example": 0}, "limit": {"type": "integer", "format": "int32", "example": 25}, "count": {"type": "integer", "format": "int32", "example": 10}, "totalCount": {"type": "integer", "format": "int64", "example": 1000}, "data": {"type": "array", "items": {"discriminator": {"propertyName": "type", "mapping": {"STANDARD": "#/components/schemas/IntegrationStandardWifiBroadcastOverviewDto", "IOT_OPTIMIZED": "#/components/schemas/IntegrationIotOptimizedWifiBroadcastOverviewDto"}}, "properties": {"type": {"type": "string"}, "id": {"type": "string", "format": "uuid"}, "name": {"type": "string"}, "enabled": {"type": "boolean"}, "metadata": {"discriminator": {"propertyName": "origin", "mapping": {"USER_DEFINED": "#/components/schemas/User defined entity metadata", "DERIVED": "#/components/schemas/Derived entity metadata", "ORCHESTRATED": "#/components/schemas/Orchestrated entity metadata"}}, "properties": {"origin": {"type": "string"}}, "required": ["origin"], "title": "User or derived or orchestrated entity metadata"}, "network": {"discriminator": {"propertyName": "type", "mapping": {"NATIVE": "#/components/schemas/IntegrationWifiNativeNetworkDto", "SPECIFIC": "#/components/schemas/IntegrationWifiSpecificNetworkDto"}}, "properties": {"type": {"type": "string"}}, "required": ["type"], "title": "Wifi network reference"}, "securityConfiguration": {"discriminator": {"propertyName": "type", "mapping": {"OPEN": "#/components/schemas/IntegrationWifiOpenSecurityConfigurationOverviewDto", "WPA2_PERSONAL": "#/components/schemas/IntegrationWifiWpa2PersonalSecurityConfigurationOverviewDto", "WPA3_PERSONAL": "#/components/schemas/IntegrationWifiWpa3PersonalSecurityConfigurationOverviewDto", "WPA2_WPA3_PERSONAL": "#/components/schemas/IntegrationWifiWpa2Wpa3PersonalSecurityConfigurationOverviewDto", "WPA2_ENTERPRISE": "#/components/schemas/IntegrationWifiWpa2EnterpriseSecurityConfigurationOverviewDto", "WPA3_ENTERPRISE": "#/components/schemas/IntegrationWifiWpa3EnterpriseSecurityConfigurationOverviewDto", "WPA2_WPA3_ENTERPRISE": "#/components/schemas/IntegrationWifiWpa2Wpa3EnterpriseSecurityConfigurationOverviewDto"}}, "properties": {"type": {"type": "string"}}, "required": ["type"], "title": "Wifi security configuration overview"}, "broadcastingDeviceFilter": {"description": "Defines the custom scope of devices that will broadcast this WiFi network. If null, the WiFi network will be broadcast by all Access Point capable devices.", "discriminator": {"propertyName": "type", "mapping": {"DEVICES": "#/components/schemas/IntegrationWifiDevicesFilterDto", "DEVICE_TAGS": "#/components/schemas/IntegrationWifiDeviceTagsFilterDto"}}, "properties": {"type": {"type": "string"}}, "required": ["type"], "title": "Broadcasting device filter"}}, "required": ["enabled", "id", "metadata", "name", "securityConfiguration", "type"], "title": "Wifi broadcast overview"}}}, "required": ["count", "data", "limit", "offset", "totalCount"]}, "IntegrationWifiHotspotConfigurationOverviewDto": {"properties": {"type": {"type": "string", "enum": ["CAPTIVE_PORTAL", "PASSPOINT"]}}, "required": ["type"]}, "IntegrationWifiOpenSecurityConfigurationOverviewDto": {"allOf": [{"discriminator": {"propertyName": "type", "mapping": {"OPEN": "#/components/schemas/IntegrationWifiOpenSecurityConfigurationOverviewDto", "WPA2_PERSONAL": "#/components/schemas/IntegrationWifiWpa2PersonalSecurityConfigurationOverviewDto", "WPA3_PERSONAL": "#/components/schemas/IntegrationWifiWpa3PersonalSecurityConfigurationOverviewDto", "WPA2_WPA3_PERSONAL": "#/components/schemas/IntegrationWifiWpa2Wpa3PersonalSecurityConfigurationOverviewDto", "WPA2_ENTERPRISE": "#/components/schemas/IntegrationWifiWpa2EnterpriseSecurityConfigurationOverviewDto", "WPA3_ENTERPRISE": "#/components/schemas/IntegrationWifiWpa3EnterpriseSecurityConfigurationOverviewDto", "WPA2_WPA3_ENTERPRISE": "#/components/schemas/IntegrationWifiWpa2Wpa3EnterpriseSecurityConfigurationOverviewDto"}}, "properties": {"type": {"type": "string"}}, "required": ["type"], "title": "Wifi security configuration overview"}]}, "IntegrationWifiWpa2EnterpriseSecurityConfigurationOverviewDto": {"allOf": [{"discriminator": {"propertyName": "type", "mapping": {"OPEN": "#/components/schemas/IntegrationWifiOpenSecurityConfigurationOverviewDto", "WPA2_PERSONAL": "#/components/schemas/IntegrationWifiWpa2PersonalSecurityConfigurationOverviewDto", "WPA3_PERSONAL": "#/components/schemas/IntegrationWifiWpa3PersonalSecurityConfigurationOverviewDto", "WPA2_WPA3_PERSONAL": "#/components/schemas/IntegrationWifiWpa2Wpa3PersonalSecurityConfigurationOverviewDto", "WPA2_ENTERPRISE": "#/components/schemas/IntegrationWifiWpa2EnterpriseSecurityConfigurationOverviewDto", "WPA3_ENTERPRISE": "#/components/schemas/IntegrationWifiWpa3EnterpriseSecurityConfigurationOverviewDto", "WPA2_WPA3_ENTERPRISE": "#/components/schemas/IntegrationWifiWpa2Wpa3EnterpriseSecurityConfigurationOverviewDto"}}, "properties": {"type": {"type": "string"}}, "required": ["type"], "title": "Wifi security configuration overview"}]}, "IntegrationWifiWpa2PersonalSecurityConfigurationOverviewDto": {"allOf": [{"discriminator": {"propertyName": "type", "mapping": {"OPEN": "#/components/schemas/IntegrationWifiOpenSecurityConfigurationOverviewDto", "WPA2_PERSONAL": "#/components/schemas/IntegrationWifiWpa2PersonalSecurityConfigurationOverviewDto", "WPA3_PERSONAL": "#/components/schemas/IntegrationWifiWpa3PersonalSecurityConfigurationOverviewDto", "WPA2_WPA3_PERSONAL": "#/components/schemas/IntegrationWifiWpa2Wpa3PersonalSecurityConfigurationOverviewDto", "WPA2_ENTERPRISE": "#/components/schemas/IntegrationWifiWpa2EnterpriseSecurityConfigurationOverviewDto", "WPA3_ENTERPRISE": "#/components/schemas/IntegrationWifiWpa3EnterpriseSecurityConfigurationOverviewDto", "WPA2_WPA3_ENTERPRISE": "#/components/schemas/IntegrationWifiWpa2Wpa3EnterpriseSecurityConfigurationOverviewDto"}}, "properties": {"type": {"type": "string"}}, "required": ["type"], "title": "Wifi security configuration overview"}, {"type": "object", "properties": {"presharedKeyNetworkIds": {"type": "array", "items": {"discriminator": {"propertyName": "type", "mapping": {"NATIVE": "#/components/schemas/IntegrationWifiNativeNetworkDto", "SPECIFIC": "#/components/schemas/IntegrationWifiSpecificNetworkDto"}}, "properties": {"type": {"type": "string"}}, "required": ["type"], "title": "Wifi network reference"}}}}]}, "IntegrationWifiWpa2Wpa3EnterpriseSecurityConfigurationOverviewDto": {"allOf": [{"discriminator": {"propertyName": "type", "mapping": {"OPEN": "#/components/schemas/IntegrationWifiOpenSecurityConfigurationOverviewDto", "WPA2_PERSONAL": "#/components/schemas/IntegrationWifiWpa2PersonalSecurityConfigurationOverviewDto", "WPA3_PERSONAL": "#/components/schemas/IntegrationWifiWpa3PersonalSecurityConfigurationOverviewDto", "WPA2_WPA3_PERSONAL": "#/components/schemas/IntegrationWifiWpa2Wpa3PersonalSecurityConfigurationOverviewDto", "WPA2_ENTERPRISE": "#/components/schemas/IntegrationWifiWpa2EnterpriseSecurityConfigurationOverviewDto", "WPA3_ENTERPRISE": "#/components/schemas/IntegrationWifiWpa3EnterpriseSecurityConfigurationOverviewDto", "WPA2_WPA3_ENTERPRISE": "#/components/schemas/IntegrationWifiWpa2Wpa3EnterpriseSecurityConfigurationOverviewDto"}}, "properties": {"type": {"type": "string"}}, "required": ["type"], "title": "Wifi security configuration overview"}]}, "IntegrationWifiWpa2Wpa3PersonalSecurityConfigurationOverviewDto": {"allOf": [{"discriminator": {"propertyName": "type", "mapping": {"OPEN": "#/components/schemas/IntegrationWifiOpenSecurityConfigurationOverviewDto", "WPA2_PERSONAL": "#/components/schemas/IntegrationWifiWpa2PersonalSecurityConfigurationOverviewDto", "WPA3_PERSONAL": "#/components/schemas/IntegrationWifiWpa3PersonalSecurityConfigurationOverviewDto", "WPA2_WPA3_PERSONAL": "#/components/schemas/IntegrationWifiWpa2Wpa3PersonalSecurityConfigurationOverviewDto", "WPA2_ENTERPRISE": "#/components/schemas/IntegrationWifiWpa2EnterpriseSecurityConfigurationOverviewDto", "WPA3_ENTERPRISE": "#/components/schemas/IntegrationWifiWpa3EnterpriseSecurityConfigurationOverviewDto", "WPA2_WPA3_ENTERPRISE": "#/components/schemas/IntegrationWifiWpa2Wpa3EnterpriseSecurityConfigurationOverviewDto"}}, "properties": {"type": {"type": "string"}}, "required": ["type"], "title": "Wifi security configuration overview"}]}, "IntegrationWifiWpa3EnterpriseSecurityConfigurationOverviewDto": {"allOf": [{"discriminator": {"propertyName": "type", "mapping": {"OPEN": "#/components/schemas/IntegrationWifiOpenSecurityConfigurationOverviewDto", "WPA2_PERSONAL": "#/components/schemas/IntegrationWifiWpa2PersonalSecurityConfigurationOverviewDto", "WPA3_PERSONAL": "#/components/schemas/IntegrationWifiWpa3PersonalSecurityConfigurationOverviewDto", "WPA2_WPA3_PERSONAL": "#/components/schemas/IntegrationWifiWpa2Wpa3PersonalSecurityConfigurationOverviewDto", "WPA2_ENTERPRISE": "#/components/schemas/IntegrationWifiWpa2EnterpriseSecurityConfigurationOverviewDto", "WPA3_ENTERPRISE": "#/components/schemas/IntegrationWifiWpa3EnterpriseSecurityConfigurationOverviewDto", "WPA2_WPA3_ENTERPRISE": "#/components/schemas/IntegrationWifiWpa2Wpa3EnterpriseSecurityConfigurationOverviewDto"}}, "properties": {"type": {"type": "string"}}, "required": ["type"], "title": "Wifi security configuration overview"}]}, "IntegrationWifiWpa3PersonalSecurityConfigurationOverviewDto": {"allOf": [{"discriminator": {"propertyName": "type", "mapping": {"OPEN": "#/components/schemas/IntegrationWifiOpenSecurityConfigurationOverviewDto", "WPA2_PERSONAL": "#/components/schemas/IntegrationWifiWpa2PersonalSecurityConfigurationOverviewDto", "WPA3_PERSONAL": "#/components/schemas/IntegrationWifiWpa3PersonalSecurityConfigurationOverviewDto", "WPA2_WPA3_PERSONAL": "#/components/schemas/IntegrationWifiWpa2Wpa3PersonalSecurityConfigurationOverviewDto", "WPA2_ENTERPRISE": "#/components/schemas/IntegrationWifiWpa2EnterpriseSecurityConfigurationOverviewDto", "WPA3_ENTERPRISE": "#/components/schemas/IntegrationWifiWpa3EnterpriseSecurityConfigurationOverviewDto", "WPA2_WPA3_ENTERPRISE": "#/components/schemas/IntegrationWifiWpa2Wpa3EnterpriseSecurityConfigurationOverviewDto"}}, "properties": {"type": {"type": "string"}}, "required": ["type"], "title": "Wifi security configuration overview"}]}, "Wifi broadcast overview": {"discriminator": {"propertyName": "type", "mapping": {"STANDARD": "#/components/schemas/IntegrationStandardWifiBroadcastOverviewDto", "IOT_OPTIMIZED": "#/components/schemas/IntegrationIotOptimizedWifiBroadcastOverviewDto"}}, "properties": {"type": {"type": "string"}, "id": {"type": "string", "format": "uuid"}, "name": {"type": "string"}, "enabled": {"type": "boolean"}, "metadata": {"discriminator": {"propertyName": "origin", "mapping": {"USER_DEFINED": "#/components/schemas/User defined entity metadata", "DERIVED": "#/components/schemas/Derived entity metadata", "ORCHESTRATED": "#/components/schemas/Orchestrated entity metadata"}}, "properties": {"origin": {"type": "string"}}, "required": ["origin"], "title": "User or derived or orchestrated entity metadata"}, "network": {"discriminator": {"propertyName": "type", "mapping": {"NATIVE": "#/components/schemas/IntegrationWifiNativeNetworkDto", "SPECIFIC": "#/components/schemas/IntegrationWifiSpecificNetworkDto"}}, "properties": {"type": {"type": "string"}}, "required": ["type"], "title": "Wifi network reference"}, "securityConfiguration": {"discriminator": {"propertyName": "type", "mapping": {"OPEN": "#/components/schemas/IntegrationWifiOpenSecurityConfigurationOverviewDto", "WPA2_PERSONAL": "#/components/schemas/IntegrationWifiWpa2PersonalSecurityConfigurationOverviewDto", "WPA3_PERSONAL": "#/components/schemas/IntegrationWifiWpa3PersonalSecurityConfigurationOverviewDto", "WPA2_WPA3_PERSONAL": "#/components/schemas/IntegrationWifiWpa2Wpa3PersonalSecurityConfigurationOverviewDto", "WPA2_ENTERPRISE": "#/components/schemas/IntegrationWifiWpa2EnterpriseSecurityConfigurationOverviewDto", "WPA3_ENTERPRISE": "#/components/schemas/IntegrationWifiWpa3EnterpriseSecurityConfigurationOverviewDto", "WPA2_WPA3_ENTERPRISE": "#/components/schemas/IntegrationWifiWpa2Wpa3EnterpriseSecurityConfigurationOverviewDto"}}, "properties": {"type": {"type": "string"}}, "required": ["type"], "title": "Wifi security configuration overview"}, "broadcastingDeviceFilter": {"description": "Defines the custom scope of devices that will broadcast this WiFi network. If null, the WiFi network will be broadcast by all Access Point capable devices.", "discriminator": {"propertyName": "type", "mapping": {"DEVICES": "#/components/schemas/IntegrationWifiDevicesFilterDto", "DEVICE_TAGS": "#/components/schemas/IntegrationWifiDeviceTagsFilterDto"}}, "properties": {"type": {"type": "string"}}, "required": ["type"], "title": "Broadcasting device filter"}}, "required": ["enabled", "id", "metadata", "name", "securityConfiguration", "type"]}, "Wifi security configuration overview": {"discriminator": {"propertyName": "type", "mapping": {"OPEN": "#/components/schemas/IntegrationWifiOpenSecurityConfigurationOverviewDto", "WPA2_PERSONAL": "#/components/schemas/IntegrationWifiWpa2PersonalSecurityConfigurationOverviewDto", "WPA3_PERSONAL": "#/components/schemas/IntegrationWifiWpa3PersonalSecurityConfigurationOverviewDto", "WPA2_WPA3_PERSONAL": "#/components/schemas/IntegrationWifiWpa2Wpa3PersonalSecurityConfigurationOverviewDto", "WPA2_ENTERPRISE": "#/components/schemas/IntegrationWifiWpa2EnterpriseSecurityConfigurationOverviewDto", "WPA3_ENTERPRISE": "#/components/schemas/IntegrationWifiWpa3EnterpriseSecurityConfigurationOverviewDto", "WPA2_WPA3_ENTERPRISE": "#/components/schemas/IntegrationWifiWpa2Wpa3EnterpriseSecurityConfigurationOverviewDto"}}, "properties": {"type": {"type": "string"}}, "required": ["type"]}, "WAN overview": {"properties": {"id": {"type": "string", "format": "uuid"}, "name": {"type": "string", "example": "Internet 1"}}, "required": ["id", "name"]}, "WAN overview page": {"properties": {"offset": {"type": "integer", "format": "int64", "example": 0}, "limit": {"type": "integer", "format": "int32", "example": 25}, "count": {"type": "integer", "format": "int32", "example": 10}, "totalCount": {"type": "integer", "format": "int64", "example": 1000}, "data": {"type": "array", "items": {"properties": {"id": {"type": "string", "format": "uuid"}, "name": {"type": "string", "example": "Internet 1"}}, "required": ["id", "name"], "title": "WAN overview"}}}, "required": ["count", "data", "limit", "offset", "totalCount"]}, "IntegrationSiteToSiteIpsecTunnelOverviewDto": {"allOf": [{"discriminator": {"propertyName": "type", "mapping": {"OPENVPN": "#/components/schemas/IntegrationSiteToSiteOpenVpnTunnelOverviewDto", "IPSEC": "#/components/schemas/IntegrationSiteToSiteIpsecTunnelOverviewDto", "WIREGUARD": "#/components/schemas/IntegrationSiteToSiteWireguardTunnelOverviewDto"}}, "properties": {"type": {"type": "string"}, "id": {"type": "string", "format": "uuid"}, "name": {"type": "string"}, "metadata": {"discriminator": {"propertyName": "origin", "mapping": {"USER_DEFINED": "#/components/schemas/User defined entity metadata", "DERIVED": "#/components/schemas/IntegrationDerivedSiteToSiteTunnelMetadata"}}, "properties": {"origin": {"type": "string"}}, "required": ["origin"], "title": "Site-to-site VPN tunnel metadata"}}, "required": ["id", "metadata", "name", "type"], "title": "Site-to-site VPN tunnel overview"}], "required": ["id", "metadata", "name"]}, "IntegrationSiteToSiteOpenVpnTunnelOverviewDto": {"allOf": [{"discriminator": {"propertyName": "type", "mapping": {"OPENVPN": "#/components/schemas/IntegrationSiteToSiteOpenVpnTunnelOverviewDto", "IPSEC": "#/components/schemas/IntegrationSiteToSiteIpsecTunnelOverviewDto", "WIREGUARD": "#/components/schemas/IntegrationSiteToSiteWireguardTunnelOverviewDto"}}, "properties": {"type": {"type": "string"}, "id": {"type": "string", "format": "uuid"}, "name": {"type": "string"}, "metadata": {"discriminator": {"propertyName": "origin", "mapping": {"USER_DEFINED": "#/components/schemas/User defined entity metadata", "DERIVED": "#/components/schemas/IntegrationDerivedSiteToSiteTunnelMetadata"}}, "properties": {"origin": {"type": "string"}}, "required": ["origin"], "title": "Site-to-site VPN tunnel metadata"}}, "required": ["id", "metadata", "name", "type"], "title": "Site-to-site VPN tunnel overview"}], "required": ["id", "metadata", "name"]}, "IntegrationSiteToSiteVpnTunnelOverviewPageDto": {"properties": {"offset": {"type": "integer", "format": "int64", "example": 0}, "limit": {"type": "integer", "format": "int32", "example": 25}, "count": {"type": "integer", "format": "int32", "example": 10}, "totalCount": {"type": "integer", "format": "int64", "example": 1000}, "data": {"type": "array", "items": {"discriminator": {"propertyName": "type", "mapping": {"OPENVPN": "#/components/schemas/IntegrationSiteToSiteOpenVpnTunnelOverviewDto", "IPSEC": "#/components/schemas/IntegrationSiteToSiteIpsecTunnelOverviewDto", "WIREGUARD": "#/components/schemas/IntegrationSiteToSiteWireguardTunnelOverviewDto"}}, "properties": {"type": {"type": "string"}, "id": {"type": "string", "format": "uuid"}, "name": {"type": "string"}, "metadata": {"discriminator": {"propertyName": "origin", "mapping": {"USER_DEFINED": "#/components/schemas/User defined entity metadata", "DERIVED": "#/components/schemas/IntegrationDerivedSiteToSiteTunnelMetadata"}}, "properties": {"origin": {"type": "string"}}, "required": ["origin"], "title": "Site-to-site VPN tunnel metadata"}}, "required": ["id", "metadata", "name", "type"], "title": "Site-to-site VPN tunnel overview"}}}, "required": ["count", "data", "limit", "offset", "totalCount"]}, "IntegrationSiteToSiteWireguardTunnelOverviewDto": {"allOf": [{"discriminator": {"propertyName": "type", "mapping": {"OPENVPN": "#/components/schemas/IntegrationSiteToSiteOpenVpnTunnelOverviewDto", "IPSEC": "#/components/schemas/IntegrationSiteToSiteIpsecTunnelOverviewDto", "WIREGUARD": "#/components/schemas/IntegrationSiteToSiteWireguardTunnelOverviewDto"}}, "properties": {"type": {"type": "string"}, "id": {"type": "string", "format": "uuid"}, "name": {"type": "string"}, "metadata": {"discriminator": {"propertyName": "origin", "mapping": {"USER_DEFINED": "#/components/schemas/User defined entity metadata", "DERIVED": "#/components/schemas/IntegrationDerivedSiteToSiteTunnelMetadata"}}, "properties": {"origin": {"type": "string"}}, "required": ["origin"], "title": "Site-to-site VPN tunnel metadata"}}, "required": ["id", "metadata", "name", "type"], "title": "Site-to-site VPN tunnel overview"}], "required": ["id", "metadata", "name"]}, "Site-to-site VPN tunnel overview": {"discriminator": {"propertyName": "type", "mapping": {"OPENVPN": "#/components/schemas/IntegrationSiteToSiteOpenVpnTunnelOverviewDto", "IPSEC": "#/components/schemas/IntegrationSiteToSiteIpsecTunnelOverviewDto", "WIREGUARD": "#/components/schemas/IntegrationSiteToSiteWireguardTunnelOverviewDto"}}, "properties": {"type": {"type": "string"}, "id": {"type": "string", "format": "uuid"}, "name": {"type": "string"}, "metadata": {"discriminator": {"propertyName": "origin", "mapping": {"USER_DEFINED": "#/components/schemas/User defined entity metadata", "DERIVED": "#/components/schemas/IntegrationDerivedSiteToSiteTunnelMetadata"}}, "properties": {"origin": {"type": "string"}}, "required": ["origin"], "title": "Site-to-site VPN tunnel metadata"}}, "required": ["id", "metadata", "name", "type"]}, "IntegrationL2tpServerOverviewDto": {"allOf": [{"discriminator": {"propertyName": "type", "mapping": {"OPENVPN": "#/components/schemas/IntegrationOpenVpnServerOverviewDto", "WIREGUARD": "#/components/schemas/IntegrationWireguardServerOverviewDto", "L2TP": "#/components/schemas/IntegrationL2tpServerOverviewDto", "PPTP": "#/components/schemas/IntegrationPptpServerOverviewDto", "UID": "#/components/schemas/IntegrationUidVpnServerOverviewDto"}}, "properties": {"type": {"type": "string"}, "id": {"type": "string", "format": "uuid"}, "name": {"type": "string"}, "enabled": {"type": "boolean"}, "metadata": {"discriminator": {"propertyName": "origin", "mapping": {"USER_DEFINED": "#/components/schemas/User defined entity metadata", "DERIVED": "#/components/schemas/Derived entity metadata"}}, "properties": {"origin": {"type": "string"}}, "required": ["origin"], "title": "User defined or derived entity metadata"}}, "required": ["enabled", "id", "metadata", "name", "type"], "title": "VPN server overview"}], "required": ["enabled", "id", "metadata", "name"]}, "IntegrationOpenVpnServerOverviewDto": {"allOf": [{"discriminator": {"propertyName": "type", "mapping": {"OPENVPN": "#/components/schemas/IntegrationOpenVpnServerOverviewDto", "WIREGUARD": "#/components/schemas/IntegrationWireguardServerOverviewDto", "L2TP": "#/components/schemas/IntegrationL2tpServerOverviewDto", "PPTP": "#/components/schemas/IntegrationPptpServerOverviewDto", "UID": "#/components/schemas/IntegrationUidVpnServerOverviewDto"}}, "properties": {"type": {"type": "string"}, "id": {"type": "string", "format": "uuid"}, "name": {"type": "string"}, "enabled": {"type": "boolean"}, "metadata": {"discriminator": {"propertyName": "origin", "mapping": {"USER_DEFINED": "#/components/schemas/User defined entity metadata", "DERIVED": "#/components/schemas/Derived entity metadata"}}, "properties": {"origin": {"type": "string"}}, "required": ["origin"], "title": "User defined or derived entity metadata"}}, "required": ["enabled", "id", "metadata", "name", "type"], "title": "VPN server overview"}], "required": ["enabled", "id", "metadata", "name"]}, "IntegrationPptpServerOverviewDto": {"allOf": [{"discriminator": {"propertyName": "type", "mapping": {"OPENVPN": "#/components/schemas/IntegrationOpenVpnServerOverviewDto", "WIREGUARD": "#/components/schemas/IntegrationWireguardServerOverviewDto", "L2TP": "#/components/schemas/IntegrationL2tpServerOverviewDto", "PPTP": "#/components/schemas/IntegrationPptpServerOverviewDto", "UID": "#/components/schemas/IntegrationUidVpnServerOverviewDto"}}, "properties": {"type": {"type": "string"}, "id": {"type": "string", "format": "uuid"}, "name": {"type": "string"}, "enabled": {"type": "boolean"}, "metadata": {"discriminator": {"propertyName": "origin", "mapping": {"USER_DEFINED": "#/components/schemas/User defined entity metadata", "DERIVED": "#/components/schemas/Derived entity metadata"}}, "properties": {"origin": {"type": "string"}}, "required": ["origin"], "title": "User defined or derived entity metadata"}}, "required": ["enabled", "id", "metadata", "name", "type"], "title": "VPN server overview"}], "required": ["enabled", "id", "metadata", "name"]}, "IntegrationUidVpnServerOverviewDto": {"allOf": [{"discriminator": {"propertyName": "type", "mapping": {"OPENVPN": "#/components/schemas/IntegrationOpenVpnServerOverviewDto", "WIREGUARD": "#/components/schemas/IntegrationWireguardServerOverviewDto", "L2TP": "#/components/schemas/IntegrationL2tpServerOverviewDto", "PPTP": "#/components/schemas/IntegrationPptpServerOverviewDto", "UID": "#/components/schemas/IntegrationUidVpnServerOverviewDto"}}, "properties": {"type": {"type": "string"}, "id": {"type": "string", "format": "uuid"}, "name": {"type": "string"}, "enabled": {"type": "boolean"}, "metadata": {"discriminator": {"propertyName": "origin", "mapping": {"USER_DEFINED": "#/components/schemas/User defined entity metadata", "DERIVED": "#/components/schemas/Derived entity metadata"}}, "properties": {"origin": {"type": "string"}}, "required": ["origin"], "title": "User defined or derived entity metadata"}}, "required": ["enabled", "id", "metadata", "name", "type"], "title": "VPN server overview"}], "required": ["enabled", "id", "metadata", "name"]}, "IntegrationVpnServerOverviewPageDto": {"properties": {"offset": {"type": "integer", "format": "int64", "example": 0}, "limit": {"type": "integer", "format": "int32", "example": 25}, "count": {"type": "integer", "format": "int32", "example": 10}, "totalCount": {"type": "integer", "format": "int64", "example": 1000}, "data": {"type": "array", "items": {"discriminator": {"propertyName": "type", "mapping": {"OPENVPN": "#/components/schemas/IntegrationOpenVpnServerOverviewDto", "WIREGUARD": "#/components/schemas/IntegrationWireguardServerOverviewDto", "L2TP": "#/components/schemas/IntegrationL2tpServerOverviewDto", "PPTP": "#/components/schemas/IntegrationPptpServerOverviewDto", "UID": "#/components/schemas/IntegrationUidVpnServerOverviewDto"}}, "properties": {"type": {"type": "string"}, "id": {"type": "string", "format": "uuid"}, "name": {"type": "string"}, "enabled": {"type": "boolean"}, "metadata": {"discriminator": {"propertyName": "origin", "mapping": {"USER_DEFINED": "#/components/schemas/User defined entity metadata", "DERIVED": "#/components/schemas/Derived entity metadata"}}, "properties": {"origin": {"type": "string"}}, "required": ["origin"], "title": "User defined or derived entity metadata"}}, "required": ["enabled", "id", "metadata", "name", "type"], "title": "VPN server overview"}}}, "required": ["count", "data", "limit", "offset", "totalCount"]}, "IntegrationWireguardServerOverviewDto": {"allOf": [{"discriminator": {"propertyName": "type", "mapping": {"OPENVPN": "#/components/schemas/IntegrationOpenVpnServerOverviewDto", "WIREGUARD": "#/components/schemas/IntegrationWireguardServerOverviewDto", "L2TP": "#/components/schemas/IntegrationL2tpServerOverviewDto", "PPTP": "#/components/schemas/IntegrationPptpServerOverviewDto", "UID": "#/components/schemas/IntegrationUidVpnServerOverviewDto"}}, "properties": {"type": {"type": "string"}, "id": {"type": "string", "format": "uuid"}, "name": {"type": "string"}, "enabled": {"type": "boolean"}, "metadata": {"discriminator": {"propertyName": "origin", "mapping": {"USER_DEFINED": "#/components/schemas/User defined entity metadata", "DERIVED": "#/components/schemas/Derived entity metadata"}}, "properties": {"origin": {"type": "string"}}, "required": ["origin"], "title": "User defined or derived entity metadata"}}, "required": ["enabled", "id", "metadata", "name", "type"], "title": "VPN server overview"}], "required": ["enabled", "id", "metadata", "name"]}, "VPN server overview": {"discriminator": {"propertyName": "type", "mapping": {"OPENVPN": "#/components/schemas/IntegrationOpenVpnServerOverviewDto", "WIREGUARD": "#/components/schemas/IntegrationWireguardServerOverviewDto", "L2TP": "#/components/schemas/IntegrationL2tpServerOverviewDto", "PPTP": "#/components/schemas/IntegrationPptpServerOverviewDto", "UID": "#/components/schemas/IntegrationUidVpnServerOverviewDto"}}, "properties": {"type": {"type": "string"}, "id": {"type": "string", "format": "uuid"}, "name": {"type": "string"}, "enabled": {"type": "boolean"}, "metadata": {"discriminator": {"propertyName": "origin", "mapping": {"USER_DEFINED": "#/components/schemas/User defined entity metadata", "DERIVED": "#/components/schemas/Derived entity metadata"}}, "properties": {"origin": {"type": "string"}}, "required": ["origin"], "title": "User defined or derived entity metadata"}}, "required": ["enabled", "id", "metadata", "name", "type"]}, "Traffic matching lists page": {"properties": {"offset": {"type": "integer", "format": "int64", "example": 0}, "limit": {"type": "integer", "format": "int32", "example": 25}, "count": {"type": "integer", "format": "int32", "example": 10}, "totalCount": {"type": "integer", "format": "int64", "example": 1000}, "data": {"type": "array", "items": {"discriminator": {"propertyName": "type", "mapping": {"PORTS": "#/components/schemas/IntegrationPortTrafficMatchingListDto", "IPV4_ADDRESSES": "#/components/schemas/IntegrationIpV4TrafficMatchingListDto", "IPV6_ADDRESSES": "#/components/schemas/IntegrationIpV6TrafficMatchingListDto"}}, "properties": {"type": {"type": "string"}, "id": {"type": "string", "format": "uuid", "example": "ffcdb32c-6278-4364-8947-df4f77118df8"}, "name": {"type": "string", "example": "Allowed port list|Protected IP list"}}, "required": ["id", "name", "type"], "title": "Traffic matching list"}}}, "required": ["count", "data", "limit", "offset", "totalCount"]}, "Radius Profile Overview": {"properties": {"id": {"type": "string", "format": "uuid"}, "name": {"type": "string"}, "metadata": {"discriminator": {"propertyName": "origin", "mapping": {"USER_DEFINED": "#/components/schemas/User defined entity metadata", "SYSTEM_DEFINED": "#/components/schemas/System defined entity metadata", "DERIVED": "#/components/schemas/Derived entity metadata"}}, "properties": {"origin": {"type": "string"}}, "required": ["origin"], "title": "User or system defined or derived entity metadata"}}, "required": ["id", "metadata", "name"]}, "Radius Profile Overview Page": {"properties": {"offset": {"type": "integer", "format": "int64", "example": 0}, "limit": {"type": "integer", "format": "int32", "example": 25}, "count": {"type": "integer", "format": "int32", "example": 10}, "totalCount": {"type": "integer", "format": "int64", "example": 1000}, "data": {"type": "array", "items": {"properties": {"id": {"type": "string", "format": "uuid"}, "name": {"type": "string"}, "metadata": {"discriminator": {"propertyName": "origin", "mapping": {"USER_DEFINED": "#/components/schemas/User defined entity metadata", "SYSTEM_DEFINED": "#/components/schemas/System defined entity metadata", "DERIVED": "#/components/schemas/Derived entity metadata"}}, "properties": {"origin": {"type": "string"}}, "required": ["origin"], "title": "User or system defined or derived entity metadata"}}, "required": ["id", "metadata", "name"], "title": "Radius Profile Overview"}}}, "required": ["count", "data", "limit", "offset", "totalCount"]}, "User or system defined or derived entity metadata": {"discriminator": {"propertyName": "origin", "mapping": {"USER_DEFINED": "#/components/schemas/User defined entity metadata", "SYSTEM_DEFINED": "#/components/schemas/System defined entity metadata", "DERIVED": "#/components/schemas/Derived entity metadata"}}, "properties": {"origin": {"type": "string"}}, "required": ["origin"]}, "Gateway managed network overview": {"allOf": [{"discriminator": {"propertyName": "management", "mapping": {"UNMANAGED": "#/components/schemas/Unmanaged network overview", "GATEWAY": "#/components/schemas/Gateway managed network overview", "SWITCH": "#/components/schemas/Switch managed network overview"}}, "properties": {"management": {"type": "string"}, "id": {"type": "string", "format": "uuid"}, "name": {"type": "string", "example": "Default Network"}, "enabled": {"type": "boolean"}, "vlanId": {"type": "integer", "format": "int32", "minimum": 2}, "metadata": {"description": "Orchestrated or System-defined configurable network support", "discriminator": {"propertyName": "origin", "mapping": {"USER_DEFINED": "#/components/schemas/User defined entity metadata", "SYSTEM_DEFINED": "#/components/schemas/System defined entity metadata", "ORCHESTRATED": "#/components/schemas/Orchestrated entity metadata"}}, "properties": {"origin": {"type": "string"}}, "required": ["origin"], "title": "User or system defined or orchestrated entity metadata"}}, "required": ["enabled", "id", "management", "metadata", "name", "vlanId"], "title": "Network overview"}], "required": ["enabled", "id", "metadata", "name", "vlanId"]}, "Network overview": {"discriminator": {"propertyName": "management", "mapping": {"UNMANAGED": "#/components/schemas/Unmanaged network overview", "GATEWAY": "#/components/schemas/Gateway managed network overview", "SWITCH": "#/components/schemas/Switch managed network overview"}}, "properties": {"management": {"type": "string"}, "id": {"type": "string", "format": "uuid"}, "name": {"type": "string", "example": "Default Network"}, "enabled": {"type": "boolean"}, "vlanId": {"type": "integer", "format": "int32", "minimum": 2}, "metadata": {"description": "Orchestrated or System-defined configurable network support", "discriminator": {"propertyName": "origin", "mapping": {"USER_DEFINED": "#/components/schemas/User defined entity metadata", "SYSTEM_DEFINED": "#/components/schemas/System defined entity metadata", "ORCHESTRATED": "#/components/schemas/Orchestrated entity metadata"}}, "properties": {"origin": {"type": "string"}}, "required": ["origin"], "title": "User or system defined or orchestrated entity metadata"}}, "required": ["enabled", "id", "management", "metadata", "name", "vlanId"]}, "Network overview page": {"properties": {"offset": {"type": "integer", "format": "int64", "example": 0}, "limit": {"type": "integer", "format": "int32", "example": 25}, "count": {"type": "integer", "format": "int32", "example": 10}, "totalCount": {"type": "integer", "format": "int64", "example": 1000}, "data": {"type": "array", "items": {"discriminator": {"propertyName": "management", "mapping": {"UNMANAGED": "#/components/schemas/Unmanaged network overview", "GATEWAY": "#/components/schemas/Gateway managed network overview", "SWITCH": "#/components/schemas/Switch managed network overview"}}, "properties": {"management": {"type": "string"}, "id": {"type": "string", "format": "uuid"}, "name": {"type": "string", "example": "Default Network"}, "enabled": {"type": "boolean"}, "vlanId": {"type": "integer", "format": "int32", "minimum": 2}, "metadata": {"description": "Orchestrated or System-defined configurable network support", "discriminator": {"propertyName": "origin", "mapping": {"USER_DEFINED": "#/components/schemas/User defined entity metadata", "SYSTEM_DEFINED": "#/components/schemas/System defined entity metadata", "ORCHESTRATED": "#/components/schemas/Orchestrated entity metadata"}}, "properties": {"origin": {"type": "string"}}, "required": ["origin"], "title": "User or system defined or orchestrated entity metadata"}}, "required": ["enabled", "id", "management", "metadata", "name", "vlanId"], "title": "Network overview"}}}, "required": ["count", "data", "limit", "offset", "totalCount"]}, "Switch managed network overview": {"allOf": [{"discriminator": {"propertyName": "management", "mapping": {"UNMANAGED": "#/components/schemas/Unmanaged network overview", "GATEWAY": "#/components/schemas/Gateway managed network overview", "SWITCH": "#/components/schemas/Switch managed network overview"}}, "properties": {"management": {"type": "string"}, "id": {"type": "string", "format": "uuid"}, "name": {"type": "string", "example": "Default Network"}, "enabled": {"type": "boolean"}, "vlanId": {"type": "integer", "format": "int32", "minimum": 2}, "metadata": {"description": "Orchestrated or System-defined configurable network support", "discriminator": {"propertyName": "origin", "mapping": {"USER_DEFINED": "#/components/schemas/User defined entity metadata", "SYSTEM_DEFINED": "#/components/schemas/System defined entity metadata", "ORCHESTRATED": "#/components/schemas/Orchestrated entity metadata"}}, "properties": {"origin": {"type": "string"}}, "required": ["origin"], "title": "User or system defined or orchestrated entity metadata"}}, "required": ["enabled", "id", "management", "metadata", "name", "vlanId"], "title": "Network overview"}, {"type": "object", "properties": {"deviceId": {"type": "string", "format": "uuid", "description": "ID of the switch this Network is managed by.", "example": "550e8400-e29b-41d4-a716-446655440000"}}}], "required": ["deviceId", "enabled", "id", "metadata", "name", "vlanId"]}, "Unmanaged network overview": {"allOf": [{"discriminator": {"propertyName": "management", "mapping": {"UNMANAGED": "#/components/schemas/Unmanaged network overview", "GATEWAY": "#/components/schemas/Gateway managed network overview", "SWITCH": "#/components/schemas/Switch managed network overview"}}, "properties": {"management": {"type": "string"}, "id": {"type": "string", "format": "uuid"}, "name": {"type": "string", "example": "Default Network"}, "enabled": {"type": "boolean"}, "vlanId": {"type": "integer", "format": "int32", "minimum": 2}, "metadata": {"description": "Orchestrated or System-defined configurable network support", "discriminator": {"propertyName": "origin", "mapping": {"USER_DEFINED": "#/components/schemas/User defined entity metadata", "SYSTEM_DEFINED": "#/components/schemas/System defined entity metadata", "ORCHESTRATED": "#/components/schemas/Orchestrated entity metadata"}}, "properties": {"origin": {"type": "string"}}, "required": ["origin"], "title": "User or system defined or orchestrated entity metadata"}}, "required": ["enabled", "id", "management", "metadata", "name", "vlanId"], "title": "Network overview"}], "required": ["enabled", "id", "metadata", "name", "vlanId"]}, "Network reference detail": {"properties": {"referenceId": {"type": "string", "format": "uuid"}}, "required": ["referenceId"]}, "Network reference resource": {"properties": {"resourceType": {"type": "string", "enum": ["CLIENT", "DEVICE", "STATIC_ROUTE", "OSPF_ROUTE", "NEXT_AI", "WIFI", "NAT_RULE", "SD_WAN"]}, "referenceCount": {"type": "integer", "format": "int32", "description": "Number of references of this type", "minimum": 1}, "references": {"type": "array", "description": "List of references, present only if resourceType has API model defined", "items": {"properties": {"referenceId": {"type": "string", "format": "uuid"}}, "required": ["referenceId"], "title": "Network reference detail"}}}, "required": ["referenceCount", "resourceType"]}, "Network references": {"properties": {"referenceResources": {"type": "array", "description": "List of network reference resources", "items": {"properties": {"resourceType": {"type": "string", "enum": ["CLIENT", "DEVICE", "STATIC_ROUTE", "OSPF_ROUTE", "NEXT_AI", "WIFI", "NAT_RULE", "SD_WAN"]}, "referenceCount": {"type": "integer", "format": "int32", "description": "Number of references of this type", "minimum": 1}, "references": {"type": "array", "description": "List of references, present only if resourceType has API model defined", "items": {"properties": {"referenceId": {"type": "string", "format": "uuid"}}, "required": ["referenceId"], "title": "Network reference detail"}}}, "required": ["referenceCount", "resourceType"], "title": "Network reference resource"}}}, "required": ["referenceResources"]}, "Hotspot voucher detail page": {"properties": {"offset": {"type": "integer", "format": "int64", "example": 0}, "limit": {"type": "integer", "format": "int32", "example": 25}, "count": {"type": "integer", "format": "int32", "example": 10}, "totalCount": {"type": "integer", "format": "int64", "example": 1000}, "data": {"type": "array", "items": {"properties": {"id": {"type": "string", "format": "uuid"}, "createdAt": {"type": "string", "format": "date-time"}, "name": {"type": "string", "description": "Voucher note, may contain duplicate values across multiple vouchers", "example": "hotel-guest"}, "code": {"type": "string", "description": "Secret code to active the voucher using the Hotspot portal", "example": 4861409510}, "authorizedGuestLimit": {"type": "integer", "format": "int64", "description": "(Optional) limit for how many different guests can use the same voucher to authorize network access", "example": 1}, "authorizedGuestCount": {"type": "integer", "format": "int64", "description": "For how many guests the voucher has been used to authorize network access", "example": 0}, "activatedAt": {"type": "string", "format": "date-time", "description": "(Optional) timestamp when the voucher has been activated (authorization time of the first guest)"}, "expiresAt": {"type": "string", "format": "date-time", "description": "(Optional) timestamp when the voucher will become expired. All guests using the voucher will be unauthorized from network access"}, "expired": {"type": "boolean", "description": "Whether the voucher has been expired and can no longer be used to authorize network access"}, "timeLimitMinutes": {"type": "integer", "format": "int64", "description": "How long (in minutes) the voucher will provide access to the network since authorization of the first guest.\nSubsequently connected guests, if allowed, will share the same expiration time.", "example": 1440}, "dataUsageLimitMBytes": {"type": "integer", "format": "int64", "description": "(Optional) data usage limit in megabytes", "example": 1024}, "rxRateLimitKbps": {"type": "integer", "format": "int64", "description": "(Optional) download rate limit in kilobits per second", "example": 1000}, "txRateLimitKbps": {"type": "integer", "format": "int64", "description": "(Optional) upload rate limit in kilobits per second", "example": 1000}}, "required": ["authorizedGuestCount", "code", "createdAt", "expired", "id", "name", "timeLimitMinutes"], "title": "Hotspot voucher details"}}}, "required": ["count", "data", "limit", "offset", "totalCount"]}, "Firewall zones page": {"properties": {"offset": {"type": "integer", "format": "int64", "example": 0}, "limit": {"type": "integer", "format": "int32", "example": 25}, "count": {"type": "integer", "format": "int32", "example": 10}, "totalCount": {"type": "integer", "format": "int64", "example": 1000}, "data": {"type": "array", "items": {"properties": {"id": {"type": "string", "format": "uuid", "example": "ffcdb32c-6278-4364-8947-df4f77118df8"}, "name": {"type": "string", "description": "Name of a firewall zone", "example": "Hotspot|My custom zone"}, "networkIds": {"type": "array", "description": "List of Network IDs", "items": {"example": "dfb21062-8ea0-4dca-b1d8-1eb3da00e58b"}, "minItems": 0}, "metadata": {"description": "System-defined configurable zones support configuring only attached networks", "discriminator": {"propertyName": "origin", "mapping": {"USER_DEFINED": "#/components/schemas/User defined entity metadata", "SYSTEM_DEFINED": "#/components/schemas/System defined entity metadata"}}, "properties": {"origin": {"type": "string"}}, "required": ["origin"], "title": "User or system defined entity metadata"}}, "required": ["id", "metadata", "name", "networkIds"], "title": "Firewall zone"}}}, "required": ["count", "data", "limit", "offset", "totalCount"]}, "Adopted device overview": {"properties": {"id": {"type": "string", "format": "uuid"}, "macAddress": {"type": "string", "example": "94:2a:6f:26:c6:ca"}, "ipAddress": {"type": "string", "example": "192.168.1.55"}, "name": {"type": "string", "example": "IW HD"}, "model": {"type": "string", "example": "UHDIW"}, "state": {"type": "string", "enum": ["ONLINE", "OFFLINE", "PENDING_ADOPTION", "UPDATING", "GETTING_READY", "ADOPTING", "DELETING", "CONNECTION_INTERRUPTED", "ISOLATED", "U5G_INCORRECT_TOPOLOGY"]}, "supported": {"type": "boolean"}, "firmwareVersion": {"type": "string", "example": "6.6.55"}, "firmwareUpdatable": {"type": "boolean"}, "features": {"type": "array", "items": {"type": "string", "enum": ["switching", "accessPoint", "gateway"]}, "uniqueItems": true}, "interfaces": {"type": "array", "items": {"type": "string", "enum": ["ports", "radios"]}, "uniqueItems": true}}, "required": ["features", "firmwareUpdatable", "id", "interfaces", "ipAddress", "macAddress", "model", "name", "state", "supported"]}, "Adopted device overview page": {"properties": {"offset": {"type": "integer", "format": "int64", "example": 0}, "limit": {"type": "integer", "format": "int32", "example": 25}, "count": {"type": "integer", "format": "int32", "example": 10}, "totalCount": {"type": "integer", "format": "int64", "example": 1000}, "data": {"type": "array", "items": {"properties": {"id": {"type": "string", "format": "uuid"}, "macAddress": {"type": "string", "example": "94:2a:6f:26:c6:ca"}, "ipAddress": {"type": "string", "example": "192.168.1.55"}, "name": {"type": "string", "example": "IW HD"}, "model": {"type": "string", "example": "UHDIW"}, "state": {"type": "string", "enum": ["ONLINE", "OFFLINE", "PENDING_ADOPTION", "UPDATING", "GETTING_READY", "ADOPTING", "DELETING", "CONNECTION_INTERRUPTED", "ISOLATED", "U5G_INCORRECT_TOPOLOGY"]}, "supported": {"type": "boolean"}, "firmwareVersion": {"type": "string", "example": "6.6.55"}, "firmwareUpdatable": {"type": "boolean"}, "features": {"type": "array", "items": {"type": "string", "enum": ["switching", "accessPoint", "gateway"]}, "uniqueItems": true}, "interfaces": {"type": "array", "items": {"type": "string", "enum": ["ports", "radios"]}, "uniqueItems": true}}, "required": ["features", "firmwareUpdatable", "id", "interfaces", "ipAddress", "macAddress", "model", "name", "state", "supported"], "title": "Adopted device overview"}}}, "required": ["count", "data", "limit", "offset", "totalCount"]}, "Access point feature overview": {}, "Adopted device details": {"properties": {"id": {"type": "string", "format": "uuid"}, "macAddress": {"type": "string", "example": "94:2a:6f:26:c6:ca"}, "ipAddress": {"type": "string", "example": "192.168.1.55"}, "name": {"type": "string", "example": "IW HD"}, "model": {"type": "string", "example": "UHDIW"}, "supported": {"type": "boolean"}, "state": {"type": "string", "enum": ["ONLINE", "OFFLINE", "PENDING_ADOPTION", "UPDATING", "GETTING_READY", "ADOPTING", "DELETING", "CONNECTION_INTERRUPTED", "ISOLATED", "U5G_INCORRECT_TOPOLOGY"]}, "firmwareVersion": {"type": "string", "example": "6.6.55"}, "firmwareUpdatable": {"type": "boolean"}, "adoptedAt": {"type": "string", "format": "date-time"}, "provisionedAt": {"type": "string", "format": "date-time"}, "configurationId": {"type": "string", "example": "7596498d2f367dc2"}, "uplink": {"description": "Uplink interface is device's connection to the parent device in the network topology", "properties": {"deviceId": {"type": "string", "format": "uuid"}}, "required": ["deviceId"], "title": "Device uplink interface overview"}, "features": {"properties": {"switching": {"example": {}, "title": "Switch feature overview"}, "accessPoint": {"example": {}, "title": "Access point feature overview"}}, "title": "Device features"}, "interfaces": {"properties": {"ports": {"type": "array", "items": {"properties": {"idx": {"type": "integer", "format": "int32", "example": 1, "minimum": 1}, "state": {"type": "string", "enum": ["UP", "DOWN", "UNKNOWN"]}, "connector": {"type": "string", "enum": ["RJ45", "SFP", "SFPPLUS", "SFP28", "QSFP28"]}, "maxSpeedMbps": {"type": "integer", "format": "int32", "example": 10000}, "speedMbps": {"type": "integer", "format": "int32", "example": 1000}, "poe": {"properties": {"standard": {"type": "string", "enum": ["802.3af", "802.3at", "802.3bt"], "example": "802.3bt"}, "type": {"type": "integer", "format": "int32", "enum": ["1", "2", "3", "4"], "example": 3}, "enabled": {"type": "boolean", "description": "Whether the PoE feature is enabled on the port"}, "state": {"type": "string", "description": "Whether the port currently supplies power to the (connected) device.", "enum": ["UP", "DOWN", "LIMITED", "UNKNOWN"]}}, "required": ["enabled", "standard", "state", "type"], "title": "Port PoE overview"}}, "required": ["connector", "idx", "maxSpeedMbps", "state"], "title": "Port overview"}}, "radios": {"type": "array", "items": {"properties": {"wlanStandard": {"type": "string", "enum": ["802.11a", "802.11b", "802.11g", "802.11n", "802.11ac", "802.11ax", "802.11be"]}, "frequencyGHz": {"type": "string", "enum": ["2.4", "5", "6", "60"]}, "channelWidthMHz": {"type": "integer", "format": "int32", "example": 40}, "channel": {"type": "integer", "format": "int32", "example": 36}}, "required": ["channelWidthMHz", "frequencyGHz", "wlanStandard"], "title": "Wireless radio overview"}}}, "title": "Device physical interfaces"}}, "required": ["configurationId", "features", "firmwareUpdatable", "id", "interfaces", "ipAddress", "macAddress", "model", "name", "state", "supported"]}, "Device features": {"properties": {"switching": {"example": {}, "title": "Switch feature overview"}, "accessPoint": {"example": {}, "title": "Access point feature overview"}}}, "Device physical interfaces": {"properties": {"ports": {"type": "array", "items": {"properties": {"idx": {"type": "integer", "format": "int32", "example": 1, "minimum": 1}, "state": {"type": "string", "enum": ["UP", "DOWN", "UNKNOWN"]}, "connector": {"type": "string", "enum": ["RJ45", "SFP", "SFPPLUS", "SFP28", "QSFP28"]}, "maxSpeedMbps": {"type": "integer", "format": "int32", "example": 10000}, "speedMbps": {"type": "integer", "format": "int32", "example": 1000}, "poe": {"properties": {"standard": {"type": "string", "enum": ["802.3af", "802.3at", "802.3bt"], "example": "802.3bt"}, "type": {"type": "integer", "format": "int32", "enum": ["1", "2", "3", "4"], "example": 3}, "enabled": {"type": "boolean", "description": "Whether the PoE feature is enabled on the port"}, "state": {"type": "string", "description": "Whether the port currently supplies power to the (connected) device.", "enum": ["UP", "DOWN", "LIMITED", "UNKNOWN"]}}, "required": ["enabled", "standard", "state", "type"], "title": "Port PoE overview"}}, "required": ["connector", "idx", "maxSpeedMbps", "state"], "title": "Port overview"}}, "radios": {"type": "array", "items": {"properties": {"wlanStandard": {"type": "string", "enum": ["802.11a", "802.11b", "802.11g", "802.11n", "802.11ac", "802.11ax", "802.11be"]}, "frequencyGHz": {"type": "string", "enum": ["2.4", "5", "6", "60"]}, "channelWidthMHz": {"type": "integer", "format": "int32", "example": 40}, "channel": {"type": "integer", "format": "int32", "example": 36}}, "required": ["channelWidthMHz", "frequencyGHz", "wlanStandard"], "title": "Wireless radio overview"}}}}, "Device uplink interface overview": {"description": "Uplink interface is device's connection to the parent device in the network topology", "properties": {"deviceId": {"type": "string", "format": "uuid"}}, "required": ["deviceId"]}, "Port PoE overview": {"properties": {"standard": {"type": "string", "enum": ["802.3af", "802.3at", "802.3bt"], "example": "802.3bt"}, "type": {"type": "integer", "format": "int32", "enum": ["1", "2", "3", "4"], "example": 3}, "enabled": {"type": "boolean", "description": "Whether the PoE feature is enabled on the port"}, "state": {"type": "string", "description": "Whether the port currently supplies power to the (connected) device.", "enum": ["UP", "DOWN", "LIMITED", "UNKNOWN"]}}, "required": ["enabled", "standard", "state", "type"]}, "Port overview": {"properties": {"idx": {"type": "integer", "format": "int32", "example": 1, "minimum": 1}, "state": {"type": "string", "enum": ["UP", "DOWN", "UNKNOWN"]}, "connector": {"type": "string", "enum": ["RJ45", "SFP", "SFPPLUS", "SFP28", "QSFP28"]}, "maxSpeedMbps": {"type": "integer", "format": "int32", "example": 10000}, "speedMbps": {"type": "integer", "format": "int32", "example": 1000}, "poe": {"properties": {"standard": {"type": "string", "enum": ["802.3af", "802.3at", "802.3bt"], "example": "802.3bt"}, "type": {"type": "integer", "format": "int32", "enum": ["1", "2", "3", "4"], "example": 3}, "enabled": {"type": "boolean", "description": "Whether the PoE feature is enabled on the port"}, "state": {"type": "string", "description": "Whether the port currently supplies power to the (connected) device.", "enum": ["UP", "DOWN", "LIMITED", "UNKNOWN"]}}, "required": ["enabled", "standard", "state", "type"], "title": "Port PoE overview"}}, "required": ["connector", "idx", "maxSpeedMbps", "state"]}, "Switch feature overview": {}, "Wireless radio overview": {"properties": {"wlanStandard": {"type": "string", "enum": ["802.11a", "802.11b", "802.11g", "802.11n", "802.11ac", "802.11ax", "802.11be"]}, "frequencyGHz": {"type": "string", "enum": ["2.4", "5", "6", "60"]}, "channelWidthMHz": {"type": "integer", "format": "int32", "example": 40}, "channel": {"type": "integer", "format": "int32", "example": 36}}, "required": ["channelWidthMHz", "frequencyGHz", "wlanStandard"]}, "Latest statistics for a device": {"properties": {"uptimeSec": {"type": "integer", "format": "int64"}, "lastHeartbeatAt": {"type": "string", "format": "date-time"}, "nextHeartbeatAt": {"type": "string", "format": "date-time"}, "loadAverage1Min": {"type": "number", "format": "double"}, "loadAverage5Min": {"type": "number", "format": "double"}, "loadAverage15Min": {"type": "number", "format": "double"}, "cpuUtilizationPct": {"type": "number", "format": "double"}, "memoryUtilizationPct": {"type": "number", "format": "double"}, "uplink": {"properties": {"txRateBps": {"type": "integer", "format": "int64"}, "rxRateBps": {"type": "integer", "format": "int64"}}, "title": "Latest statistics for a device uplink interface"}, "interfaces": {"properties": {"radios": {"type": "array", "items": {"properties": {"frequencyGHz": {"type": "string", "enum": ["2.4", "5", "6", "60"]}, "txRetriesPct": {"type": "number", "format": "double"}}, "required": ["frequencyGHz"], "title": "Latest statistics for wireless radio"}}}, "title": "Latest statistics for device interfaces"}}, "required": ["interfaces"]}, "Latest statistics for a device uplink interface": {"properties": {"txRateBps": {"type": "integer", "format": "int64"}, "rxRateBps": {"type": "integer", "format": "int64"}}}, "Latest statistics for device interfaces": {"properties": {"radios": {"type": "array", "items": {"properties": {"frequencyGHz": {"type": "string", "enum": ["2.4", "5", "6", "60"]}, "txRetriesPct": {"type": "number", "format": "double"}}, "required": ["frequencyGHz"], "title": "Latest statistics for wireless radio"}}}}, "Latest statistics for wireless radio": {"properties": {"frequencyGHz": {"type": "string", "enum": ["2.4", "5", "6", "60"]}, "txRetriesPct": {"type": "number", "format": "double"}}, "required": ["frequencyGHz"]}, "FilterExpression": {}, "Device tag": {"properties": {"id": {"type": "string", "format": "uuid"}, "name": {"type": "string"}, "deviceIds": {"type": "array", "items": {"type": "string", "format": "uuid"}, "minItems": 1}, "metadata": {"discriminator": {"propertyName": "origin", "mapping": {"USER_DEFINED": "#/components/schemas/User defined entity metadata", "ORCHESTRATED": "#/components/schemas/Orchestrated entity metadata"}}, "properties": {"origin": {"type": "string"}}, "required": ["origin"], "title": "User or orchestrated entity metadata"}}, "required": ["deviceIds", "id", "metadata", "name"]}, "IntegrationDeviceTagPageDto": {"properties": {"offset": {"type": "integer", "format": "int64", "example": 0}, "limit": {"type": "integer", "format": "int32", "example": 25}, "count": {"type": "integer", "format": "int32", "example": 10}, "totalCount": {"type": "integer", "format": "int64", "example": 1000}, "data": {"type": "array", "items": {"properties": {"id": {"type": "string", "format": "uuid"}, "name": {"type": "string"}, "deviceIds": {"type": "array", "items": {"type": "string", "format": "uuid"}, "minItems": 1}, "metadata": {"discriminator": {"propertyName": "origin", "mapping": {"USER_DEFINED": "#/components/schemas/User defined entity metadata", "ORCHESTRATED": "#/components/schemas/Orchestrated entity metadata"}}, "properties": {"origin": {"type": "string"}}, "required": ["origin"], "title": "User or orchestrated entity metadata"}}, "required": ["deviceIds", "id", "metadata", "name"], "title": "Device tag"}}}, "required": ["count", "data", "limit", "offset", "totalCount"]}, "Client access overview": {"example": {"type": "DEFAULT"}}, "Client overview": {"discriminator": {"propertyName": "type", "mapping": {"WIRED": "#/components/schemas/Wired client overview", "WIRELESS": "#/components/schemas/Wireless client overview", "VPN": "#/components/schemas/VPN client (connection) overview", "TELEPORT": "#/components/schemas/Teleport client (connection) overview"}}, "properties": {"type": {"type": "string"}, "id": {"type": "string", "format": "uuid"}, "name": {"type": "string"}, "connectedAt": {"type": "string", "format": "date-time"}, "ipAddress": {"type": "string"}, "access": {"example": {"type": "DEFAULT"}, "title": "Client access overview"}}, "required": ["access", "id", "name", "type"]}, "Client overview page": {"properties": {"offset": {"type": "integer", "format": "int64", "example": 0}, "limit": {"type": "integer", "format": "int32", "example": 25}, "count": {"type": "integer", "format": "int32", "example": 10}, "totalCount": {"type": "integer", "format": "int64", "example": 1000}, "data": {"type": "array", "items": {"discriminator": {"propertyName": "type", "mapping": {"WIRED": "#/components/schemas/Wired client overview", "WIRELESS": "#/components/schemas/Wireless client overview", "VPN": "#/components/schemas/VPN client (connection) overview", "TELEPORT": "#/components/schemas/Teleport client (connection) overview"}}, "properties": {"type": {"type": "string"}, "id": {"type": "string", "format": "uuid"}, "name": {"type": "string"}, "connectedAt": {"type": "string", "format": "date-time"}, "ipAddress": {"type": "string"}, "access": {"example": {"type": "DEFAULT"}, "title": "Client access overview"}}, "required": ["access", "id", "name", "type"], "title": "Client overview"}}}, "required": ["count", "data", "limit", "offset", "totalCount"]}, "Default client access overview": {"allOf": [{"description": "Represents the type of network access and/or any applicable authorization status the client is using.\n\n- **Wired clients** may have direct access without additional authorization.\n- **Wireless clients** can be connected via a protected network or an open network\n  that may require additional authorization (e.g., a guest portal).\n- **VPN clients** may have different authorization mechanisms.\n\nCurrently, the only two supported access types are `GUEST` (used for wired and wireless guest clients)\nand `DEFAULT` (a placeholder, which might be refined in the future releases, used for all other clients).\n\nFiltering is possible by `access.type`, for example `access.type.eq('GUEST')` to list guest clients.", "discriminator": {"propertyName": "type", "mapping": {"DEFAULT": "#/components/schemas/Default client access overview", "GUEST": "#/components/schemas/Guest access overview"}}, "properties": {"type": {"type": "string"}}, "required": ["type"], "title": "Local client access overview"}, {"description": "Represents the type of network access and/or any applicable authorization status the client is using.\n\n- **Wired clients** may have direct access without additional authorization.\n- **Wireless clients** can be connected via a protected network or an open network\n  that may require additional authorization (e.g., a guest portal).\n- **VPN clients** may have different authorization mechanisms.\n\nCurrently, the only two supported access types are `GUEST` (used for wired and wireless guest clients)\nand `DEFAULT` (a placeholder, which might be refined in the future releases, used for all other clients).\n\nFiltering is possible by `access.type`, for example `access.type.eq('GUEST')` to list guest clients.", "discriminator": {"propertyName": "type", "mapping": {"DEFAULT": "#/components/schemas/Default client access overview"}}, "properties": {"type": {"type": "string"}}, "required": ["type"], "title": "VPN client access overview"}, {"description": "Represents the type of network access and/or any applicable authorization status the client is using.\n\n- **Wired clients** may have direct access without additional authorization.\n- **Wireless clients** can be connected via a protected network or an open network\n  that may require additional authorization (e.g., a guest portal).\n- **VPN clients** may have different authorization mechanisms.\n\nCurrently, the only two supported access types are `GUEST` (used for wired and wireless guest clients)\nand `DEFAULT` (a placeholder, which might be refined in the future releases, used for all other clients).\n\nFiltering is possible by `access.type`, for example `access.type.eq('GUEST')` to list guest clients.", "discriminator": {"propertyName": "type", "mapping": {"DEFAULT": "#/components/schemas/Default client access overview"}}, "properties": {"type": {"type": "string"}}, "required": ["type"], "title": "Teleport client access overview"}]}, "Guest access overview": {"allOf": [{"description": "Represents the type of network access and/or any applicable authorization status the client is using.\n\n- **Wired clients** may have direct access without additional authorization.\n- **Wireless clients** can be connected via a protected network or an open network\n  that may require additional authorization (e.g., a guest portal).\n- **VPN clients** may have different authorization mechanisms.\n\nCurrently, the only two supported access types are `GUEST` (used for wired and wireless guest clients)\nand `DEFAULT` (a placeholder, which might be refined in the future releases, used for all other clients).\n\nFiltering is possible by `access.type`, for example `access.type.eq('GUEST')` to list guest clients.", "discriminator": {"propertyName": "type", "mapping": {"DEFAULT": "#/components/schemas/Default client access overview", "GUEST": "#/components/schemas/Guest access overview"}}, "properties": {"type": {"type": "string"}}, "required": ["type"], "title": "Local client access overview"}, {"type": "object", "properties": {"authorized": {"type": "boolean"}}}], "required": ["authorized"]}, "Local client access overview": {"description": "Represents the type of network access and/or any applicable authorization status the client is using.\n\n- **Wired clients** may have direct access without additional authorization.\n- **Wireless clients** can be connected via a protected network or an open network\n  that may require additional authorization (e.g., a guest portal).\n- **VPN clients** may have different authorization mechanisms.\n\nCurrently, the only two supported access types are `GUEST` (used for wired and wireless guest clients)\nand `DEFAULT` (a placeholder, which might be refined in the future releases, used for all other clients).\n\nFiltering is possible by `access.type`, for example `access.type.eq('GUEST')` to list guest clients.", "discriminator": {"propertyName": "type", "mapping": {"DEFAULT": "#/components/schemas/Default client access overview", "GUEST": "#/components/schemas/Guest access overview"}}, "properties": {"type": {"type": "string"}}, "required": ["type"]}, "Teleport client (connection) overview": {"allOf": [{"discriminator": {"propertyName": "type", "mapping": {"WIRED": "#/components/schemas/Wired client overview", "WIRELESS": "#/components/schemas/Wireless client overview", "VPN": "#/components/schemas/VPN client (connection) overview", "TELEPORT": "#/components/schemas/Teleport client (connection) overview"}}, "properties": {"type": {"type": "string"}, "id": {"type": "string", "format": "uuid"}, "name": {"type": "string"}, "connectedAt": {"type": "string", "format": "date-time"}, "ipAddress": {"type": "string"}, "access": {"example": {"type": "DEFAULT"}, "title": "Client access overview"}}, "required": ["access", "id", "name", "type"], "title": "Client overview"}, {"type": "object", "properties": {"access": {"description": "Represents the type of network access and/or any applicable authorization status the client is using.\n\n- **Wired clients** may have direct access without additional authorization.\n- **Wireless clients** can be connected via a protected network or an open network\n  that may require additional authorization (e.g., a guest portal).\n- **VPN clients** may have different authorization mechanisms.\n\nCurrently, the only two supported access types are `GUEST` (used for wired and wireless guest clients)\nand `DEFAULT` (a placeholder, which might be refined in the future releases, used for all other clients).\n\nFiltering is possible by `access.type`, for example `access.type.eq('GUEST')` to list guest clients.", "discriminator": {"propertyName": "type", "mapping": {"DEFAULT": "#/components/schemas/Default client access overview"}}, "properties": {"type": {"type": "string"}}, "required": ["type"], "title": "Teleport client access overview"}}}], "required": ["access", "id", "name"]}, "Teleport client access overview": {"description": "Represents the type of network access and/or any applicable authorization status the client is using.\n\n- **Wired clients** may have direct access without additional authorization.\n- **Wireless clients** can be connected via a protected network or an open network\n  that may require additional authorization (e.g., a guest portal).\n- **VPN clients** may have different authorization mechanisms.\n\nCurrently, the only two supported access types are `GUEST` (used for wired and wireless guest clients)\nand `DEFAULT` (a placeholder, which might be refined in the future releases, used for all other clients).\n\nFiltering is possible by `access.type`, for example `access.type.eq('GUEST')` to list guest clients.", "discriminator": {"propertyName": "type", "mapping": {"DEFAULT": "#/components/schemas/Default client access overview"}}, "properties": {"type": {"type": "string"}}, "required": ["type"]}, "VPN client (connection) overview": {"allOf": [{"discriminator": {"propertyName": "type", "mapping": {"WIRED": "#/components/schemas/Wired client overview", "WIRELESS": "#/components/schemas/Wireless client overview", "VPN": "#/components/schemas/VPN client (connection) overview", "TELEPORT": "#/components/schemas/Teleport client (connection) overview"}}, "properties": {"type": {"type": "string"}, "id": {"type": "string", "format": "uuid"}, "name": {"type": "string"}, "connectedAt": {"type": "string", "format": "date-time"}, "ipAddress": {"type": "string"}, "access": {"example": {"type": "DEFAULT"}, "title": "Client access overview"}}, "required": ["access", "id", "name", "type"], "title": "Client overview"}, {"type": "object", "properties": {"access": {"description": "Represents the type of network access and/or any applicable authorization status the client is using.\n\n- **Wired clients** may have direct access without additional authorization.\n- **Wireless clients** can be connected via a protected network or an open network\n  that may require additional authorization (e.g., a guest portal).\n- **VPN clients** may have different authorization mechanisms.\n\nCurrently, the only two supported access types are `GUEST` (used for wired and wireless guest clients)\nand `DEFAULT` (a placeholder, which might be refined in the future releases, used for all other clients).\n\nFiltering is possible by `access.type`, for example `access.type.eq('GUEST')` to list guest clients.", "discriminator": {"propertyName": "type", "mapping": {"DEFAULT": "#/components/schemas/Default client access overview"}}, "properties": {"type": {"type": "string"}}, "required": ["type"], "title": "VPN client access overview"}}}], "required": ["access", "id", "name"]}, "VPN client access overview": {"description": "Represents the type of network access and/or any applicable authorization status the client is using.\n\n- **Wired clients** may have direct access without additional authorization.\n- **Wireless clients** can be connected via a protected network or an open network\n  that may require additional authorization (e.g., a guest portal).\n- **VPN clients** may have different authorization mechanisms.\n\nCurrently, the only two supported access types are `GUEST` (used for wired and wireless guest clients)\nand `DEFAULT` (a placeholder, which might be refined in the future releases, used for all other clients).\n\nFiltering is possible by `access.type`, for example `access.type.eq('GUEST')` to list guest clients.", "discriminator": {"propertyName": "type", "mapping": {"DEFAULT": "#/components/schemas/Default client access overview"}}, "properties": {"type": {"type": "string"}}, "required": ["type"]}, "Wired client overview": {"allOf": [{"discriminator": {"propertyName": "type", "mapping": {"WIRED": "#/components/schemas/Wired client overview", "WIRELESS": "#/components/schemas/Wireless client overview", "VPN": "#/components/schemas/VPN client (connection) overview", "TELEPORT": "#/components/schemas/Teleport client (connection) overview"}}, "properties": {"type": {"type": "string"}, "id": {"type": "string", "format": "uuid"}, "name": {"type": "string"}, "connectedAt": {"type": "string", "format": "date-time"}, "ipAddress": {"type": "string"}, "access": {"example": {"type": "DEFAULT"}, "title": "Client access overview"}}, "required": ["access", "id", "name", "type"], "title": "Client overview"}, {"type": "object", "properties": {"macAddress": {"type": "string"}, "uplinkDeviceId": {"type": "string", "format": "uuid"}, "access": {"description": "Represents the type of network access and/or any applicable authorization status the client is using.\n\n- **Wired clients** may have direct access without additional authorization.\n- **Wireless clients** can be connected via a protected network or an open network\n  that may require additional authorization (e.g., a guest portal).\n- **VPN clients** may have different authorization mechanisms.\n\nCurrently, the only two supported access types are `GUEST` (used for wired and wireless guest clients)\nand `DEFAULT` (a placeholder, which might be refined in the future releases, used for all other clients).\n\nFiltering is possible by `access.type`, for example `access.type.eq('GUEST')` to list guest clients.", "discriminator": {"propertyName": "type", "mapping": {"DEFAULT": "#/components/schemas/Default client access overview", "GUEST": "#/components/schemas/Guest access overview"}}, "properties": {"type": {"type": "string"}}, "required": ["type"], "title": "Local client access overview"}}}], "required": ["access", "id", "macAddress", "name", "uplinkDeviceId"]}, "Wireless client overview": {"allOf": [{"discriminator": {"propertyName": "type", "mapping": {"WIRED": "#/components/schemas/Wired client overview", "WIRELESS": "#/components/schemas/Wireless client overview", "VPN": "#/components/schemas/VPN client (connection) overview", "TELEPORT": "#/components/schemas/Teleport client (connection) overview"}}, "properties": {"type": {"type": "string"}, "id": {"type": "string", "format": "uuid"}, "name": {"type": "string"}, "connectedAt": {"type": "string", "format": "date-time"}, "ipAddress": {"type": "string"}, "access": {"example": {"type": "DEFAULT"}, "title": "Client access overview"}}, "required": ["access", "id", "name", "type"], "title": "Client overview"}, {"type": "object", "properties": {"macAddress": {"type": "string"}, "uplinkDeviceId": {"type": "string", "format": "uuid"}, "access": {"description": "Represents the type of network access and/or any applicable authorization status the client is using.\n\n- **Wired clients** may have direct access without additional authorization.\n- **Wireless clients** can be connected via a protected network or an open network\n  that may require additional authorization (e.g., a guest portal).\n- **VPN clients** may have different authorization mechanisms.\n\nCurrently, the only two supported access types are `GUEST` (used for wired and wireless guest clients)\nand `DEFAULT` (a placeholder, which might be refined in the future releases, used for all other clients).\n\nFiltering is possible by `access.type`, for example `access.type.eq('GUEST')` to list guest clients.", "discriminator": {"propertyName": "type", "mapping": {"DEFAULT": "#/components/schemas/Default client access overview", "GUEST": "#/components/schemas/Guest access overview"}}, "properties": {"type": {"type": "string"}}, "required": ["type"], "title": "Local client access overview"}}}], "required": ["access", "id", "macAddress", "name", "uplinkDeviceId"]}, "Client details": {"discriminator": {"propertyName": "type", "mapping": {"WIRED": "#/components/schemas/Wired client details", "WIRELESS": "#/components/schemas/Wireless client details", "VPN": "#/components/schemas/VPN client (connection) details", "TELEPORT": "#/components/schemas/Teleport client (connection) details"}}, "properties": {"type": {"type": "string"}, "id": {"type": "string", "format": "uuid"}, "name": {"type": "string"}, "connectedAt": {"type": "string", "format": "date-time"}, "ipAddress": {"type": "string"}, "access": {}}, "required": ["access", "id", "name", "type"]}, "Default client access details": {"allOf": [{"description": "Represents the type of network access and/or any applicable authorization status the client is using.\n\n- **Wired clients** may have direct access without additional authorization.\n- **Wireless clients** can be connected via a protected network or an open network\n  that may require additional authorization (e.g., a guest portal).\n- **VPN clients** may have different authorization mechanisms.\n\nCurrently, the only two supported access types are `GUEST` (used for wired and wireless guest clients)\nand `DEFAULT` (a placeholder, which might be refined in the future releases, used for all other clients).\n\nFiltering is possible by `access.type`, for example `access.type.eq('GUEST')` to list guest clients.", "discriminator": {"propertyName": "type", "mapping": {"DEFAULT": "#/components/schemas/Default client access details", "GUEST": "#/components/schemas/Guest access details"}}, "properties": {"type": {"type": "string"}}, "required": ["type"], "title": "Local client access details"}, {"description": "Represents the type of network access and/or any applicable authorization status the client is using.\n\n- **Wired clients** may have direct access without additional authorization.\n- **Wireless clients** can be connected via a protected network or an open network\n  that may require additional authorization (e.g., a guest portal).\n- **VPN clients** may have different authorization mechanisms.\n\nCurrently, the only two supported access types are `GUEST` (used for wired and wireless guest clients)\nand `DEFAULT` (a placeholder, which might be refined in the future releases, used for all other clients).\n\nFiltering is possible by `access.type`, for example `access.type.eq('GUEST')` to list guest clients.", "discriminator": {"propertyName": "type", "mapping": {"DEFAULT": "#/components/schemas/Default client access details"}}, "properties": {"type": {"type": "string"}}, "required": ["type"], "title": "VPN client access details"}, {"description": "Represents the type of network access and/or any applicable authorization status the client is using.\n\n- **Wired clients** may have direct access without additional authorization.\n- **Wireless clients** can be connected via a protected network or an open network\n  that may require additional authorization (e.g., a guest portal).\n- **VPN clients** may have different authorization mechanisms.\n\nCurrently, the only two supported access types are `GUEST` (used for wired and wireless guest clients)\nand `DEFAULT` (a placeholder, which might be refined in the future releases, used for all other clients).\n\nFiltering is possible by `access.type`, for example `access.type.eq('GUEST')` to list guest clients.", "discriminator": {"propertyName": "type", "mapping": {"DEFAULT": "#/components/schemas/Default client access details"}}, "properties": {"type": {"type": "string"}}, "required": ["type"], "title": "Teleport client access details"}]}, "Guest access details": {"allOf": [{"description": "Represents the type of network access and/or any applicable authorization status the client is using.\n\n- **Wired clients** may have direct access without additional authorization.\n- **Wireless clients** can be connected via a protected network or an open network\n  that may require additional authorization (e.g., a guest portal).\n- **VPN clients** may have different authorization mechanisms.\n\nCurrently, the only two supported access types are `GUEST` (used for wired and wireless guest clients)\nand `DEFAULT` (a placeholder, which might be refined in the future releases, used for all other clients).\n\nFiltering is possible by `access.type`, for example `access.type.eq('GUEST')` to list guest clients.", "discriminator": {"propertyName": "type", "mapping": {"DEFAULT": "#/components/schemas/Default client access details", "GUEST": "#/components/schemas/Guest access details"}}, "properties": {"type": {"type": "string"}}, "required": ["type"], "title": "Local client access details"}, {"type": "object", "properties": {"authorized": {"type": "boolean"}, "authorization": {"properties": {"authorizedAt": {"type": "string", "format": "date-time", "description": "Timestamp when the guest has been authorized"}, "authorizationMethod": {"type": "string", "description": "Guest authorization method (API, Voucher etc)", "enum": ["VOUCHER", "API", "OTHER"]}, "expiresAt": {"type": "string", "format": "date-time", "description": "Timestamp when the guest will get automatically unauthorized"}, "dataUsageLimitMBytes": {"type": "integer", "format": "int64", "description": "(Optional) data usage limit in megabytes", "example": 1024}, "rxRateLimitKbps": {"type": "integer", "format": "int64", "description": "(Optional) download rate limit in kilobits per second", "example": 1000}, "txRateLimitKbps": {"type": "integer", "format": "int64", "description": "(Optional) upload rate limit in kilobits per second", "example": 1000}, "usage": {"properties": {"durationSec": {"type": "integer", "format": "int64"}, "rxBytes": {"type": "integer", "format": "int64"}, "txBytes": {"type": "integer", "format": "int64"}, "bytes": {"type": "integer", "format": "int64"}}, "required": ["bytes", "durationSec", "rxBytes", "txBytes"], "title": "Guest authorization usage details"}}, "required": ["authorizationMethod", "authorizedAt", "expiresAt"], "title": "Guest authorization details"}}}], "required": ["authorized"]}, "Local client access details": {"description": "Represents the type of network access and/or any applicable authorization status the client is using.\n\n- **Wired clients** may have direct access without additional authorization.\n- **Wireless clients** can be connected via a protected network or an open network\n  that may require additional authorization (e.g., a guest portal).\n- **VPN clients** may have different authorization mechanisms.\n\nCurrently, the only two supported access types are `GUEST` (used for wired and wireless guest clients)\nand `DEFAULT` (a placeholder, which might be refined in the future releases, used for all other clients).\n\nFiltering is possible by `access.type`, for example `access.type.eq('GUEST')` to list guest clients.", "discriminator": {"propertyName": "type", "mapping": {"DEFAULT": "#/components/schemas/Default client access details", "GUEST": "#/components/schemas/Guest access details"}}, "properties": {"type": {"type": "string"}}, "required": ["type"]}, "Teleport client (connection) details": {"properties": {"id": {"type": "string", "format": "uuid"}, "name": {"type": "string"}, "connectedAt": {"type": "string", "format": "date-time"}, "ipAddress": {"type": "string"}, "access": {"description": "Represents the type of network access and/or any applicable authorization status the client is using.\n\n- **Wired clients** may have direct access without additional authorization.\n- **Wireless clients** can be connected via a protected network or an open network\n  that may require additional authorization (e.g., a guest portal).\n- **VPN clients** may have different authorization mechanisms.\n\nCurrently, the only two supported access types are `GUEST` (used for wired and wireless guest clients)\nand `DEFAULT` (a placeholder, which might be refined in the future releases, used for all other clients).\n\nFiltering is possible by `access.type`, for example `access.type.eq('GUEST')` to list guest clients.", "discriminator": {"propertyName": "type", "mapping": {"DEFAULT": "#/components/schemas/Default client access details"}}, "properties": {"type": {"type": "string"}}, "required": ["type"], "title": "Teleport client access details"}}, "required": ["access", "id", "name"]}, "Teleport client access details": {"description": "Represents the type of network access and/or any applicable authorization status the client is using.\n\n- **Wired clients** may have direct access without additional authorization.\n- **Wireless clients** can be connected via a protected network or an open network\n  that may require additional authorization (e.g., a guest portal).\n- **VPN clients** may have different authorization mechanisms.\n\nCurrently, the only two supported access types are `GUEST` (used for wired and wireless guest clients)\nand `DEFAULT` (a placeholder, which might be refined in the future releases, used for all other clients).\n\nFiltering is possible by `access.type`, for example `access.type.eq('GUEST')` to list guest clients.", "discriminator": {"propertyName": "type", "mapping": {"DEFAULT": "#/components/schemas/Default client access details"}}, "properties": {"type": {"type": "string"}}, "required": ["type"]}, "VPN client (connection) details": {"allOf": [{"discriminator": {"propertyName": "type", "mapping": {"WIRED": "#/components/schemas/Wired client details", "WIRELESS": "#/components/schemas/Wireless client details", "VPN": "#/components/schemas/VPN client (connection) details", "TELEPORT": "#/components/schemas/Teleport client (connection) details"}}, "properties": {"type": {"type": "string"}, "id": {"type": "string", "format": "uuid"}, "name": {"type": "string"}, "connectedAt": {"type": "string", "format": "date-time"}, "ipAddress": {"type": "string"}, "access": {}}, "required": ["access", "id", "name", "type"], "title": "Client details"}, {"type": "object", "properties": {"access": {"description": "Represents the type of network access and/or any applicable authorization status the client is using.\n\n- **Wired clients** may have direct access without additional authorization.\n- **Wireless clients** can be connected via a protected network or an open network\n  that may require additional authorization (e.g., a guest portal).\n- **VPN clients** may have different authorization mechanisms.\n\nCurrently, the only two supported access types are `GUEST` (used for wired and wireless guest clients)\nand `DEFAULT` (a placeholder, which might be refined in the future releases, used for all other clients).\n\nFiltering is possible by `access.type`, for example `access.type.eq('GUEST')` to list guest clients.", "discriminator": {"propertyName": "type", "mapping": {"DEFAULT": "#/components/schemas/Default client access details"}}, "properties": {"type": {"type": "string"}}, "required": ["type"], "title": "VPN client access details"}}}], "required": ["access", "id", "name"]}, "VPN client access details": {"description": "Represents the type of network access and/or any applicable authorization status the client is using.\n\n- **Wired clients** may have direct access without additional authorization.\n- **Wireless clients** can be connected via a protected network or an open network\n  that may require additional authorization (e.g., a guest portal).\n- **VPN clients** may have different authorization mechanisms.\n\nCurrently, the only two supported access types are `GUEST` (used for wired and wireless guest clients)\nand `DEFAULT` (a placeholder, which might be refined in the future releases, used for all other clients).\n\nFiltering is possible by `access.type`, for example `access.type.eq('GUEST')` to list guest clients.", "discriminator": {"propertyName": "type", "mapping": {"DEFAULT": "#/components/schemas/Default client access details"}}, "properties": {"type": {"type": "string"}}, "required": ["type"]}, "Wired client details": {"allOf": [{"discriminator": {"propertyName": "type", "mapping": {"WIRED": "#/components/schemas/Wired client details", "WIRELESS": "#/components/schemas/Wireless client details", "VPN": "#/components/schemas/VPN client (connection) details", "TELEPORT": "#/components/schemas/Teleport client (connection) details"}}, "properties": {"type": {"type": "string"}, "id": {"type": "string", "format": "uuid"}, "name": {"type": "string"}, "connectedAt": {"type": "string", "format": "date-time"}, "ipAddress": {"type": "string"}, "access": {}}, "required": ["access", "id", "name", "type"], "title": "Client details"}, {"type": "object", "properties": {"macAddress": {"type": "string"}, "uplinkDeviceId": {"type": "string", "format": "uuid"}, "access": {"description": "Represents the type of network access and/or any applicable authorization status the client is using.\n\n- **Wired clients** may have direct access without additional authorization.\n- **Wireless clients** can be connected via a protected network or an open network\n  that may require additional authorization (e.g., a guest portal).\n- **VPN clients** may have different authorization mechanisms.\n\nCurrently, the only two supported access types are `GUEST` (used for wired and wireless guest clients)\nand `DEFAULT` (a placeholder, which might be refined in the future releases, used for all other clients).\n\nFiltering is possible by `access.type`, for example `access.type.eq('GUEST')` to list guest clients.", "discriminator": {"propertyName": "type", "mapping": {"DEFAULT": "#/components/schemas/Default client access details", "GUEST": "#/components/schemas/Guest access details"}}, "properties": {"type": {"type": "string"}}, "required": ["type"], "title": "Local client access details"}}}], "required": ["access", "id", "macAddress", "name", "uplinkDeviceId"]}, "Wireless client details": {"allOf": [{"discriminator": {"propertyName": "type", "mapping": {"WIRED": "#/components/schemas/Wired client details", "WIRELESS": "#/components/schemas/Wireless client details", "VPN": "#/components/schemas/VPN client (connection) details", "TELEPORT": "#/components/schemas/Teleport client (connection) details"}}, "properties": {"type": {"type": "string"}, "id": {"type": "string", "format": "uuid"}, "name": {"type": "string"}, "connectedAt": {"type": "string", "format": "date-time"}, "ipAddress": {"type": "string"}, "access": {}}, "required": ["access", "id", "name", "type"], "title": "Client details"}, {"type": "object", "properties": {"macAddress": {"type": "string"}, "uplinkDeviceId": {"type": "string", "format": "uuid"}, "access": {"description": "Represents the type of network access and/or any applicable authorization status the client is using.\n\n- **Wired clients** may have direct access without additional authorization.\n- **Wireless clients** can be connected via a protected network or an open network\n  that may require additional authorization (e.g., a guest portal).\n- **VPN clients** may have different authorization mechanisms.\n\nCurrently, the only two supported access types are `GUEST` (used for wired and wireless guest clients)\nand `DEFAULT` (a placeholder, which might be refined in the future releases, used for all other clients).\n\nFiltering is possible by `access.type`, for example `access.type.eq('GUEST')` to list guest clients.", "discriminator": {"propertyName": "type", "mapping": {"DEFAULT": "#/components/schemas/Default client access details", "GUEST": "#/components/schemas/Guest access details"}}, "properties": {"type": {"type": "string"}}, "required": ["type"], "title": "Local client access details"}}}], "required": ["access", "id", "macAddress", "name", "uplinkDeviceId"]}, "ACL ruleObject": {"discriminator": {"propertyName": "type", "mapping": {"IPV4": "#/components/schemas/IntegrationIpAclRuleDto", "MAC": "#/components/schemas/IntegrationMacAclRuleDto"}}, "properties": {"type": {"type": "string"}, "id": {"type": "string", "format": "uuid"}, "enabled": {"type": "boolean", "example": true}, "name": {"type": "string", "description": "ACL rule name"}, "description": {"type": "string", "description": "ACL rule description"}, "action": {"type": "string", "description": "ACL rule action", "enum": ["ALLOW", "BLOCK"], "example": "ALLOW|BLOCK"}, "enforcingDeviceFilter": {"description": "IDs of the Switch-capable devices used to enforce the ACL rule. When null, the rule will be provisioned to all switches on the site.", "discriminator": {"propertyName": "type", "mapping": {"DEVICES": "#/components/schemas/IntegrationAclRuleDevicesFilterDto"}}, "properties": {"type": {"type": "string"}}, "required": ["type"], "title": "ACL rule device filter"}, "index": {"type": "integer", "format": "int32", "description": "ACL rule index. Lower index has higher priority", "minimum": 0}, "sourceFilter": {"description": "Traffic source filter"}, "destinationFilter": {"description": "Traffic destination filter"}, "metadata": {"description": "Only user-defined rules can be deleted or modified", "discriminator": {"propertyName": "origin", "mapping": {"USER_DEFINED": "#/components/schemas/User defined entity metadata", "SYSTEM_DEFINED": "#/components/schemas/System defined entity metadata", "DERIVED": "#/components/schemas/Derived entity metadata", "ORCHESTRATED": "#/components/schemas/Orchestrated entity metadata"}}, "properties": {"origin": {"type": "string"}}, "required": ["origin"], "title": "Entity metadata"}}, "required": ["action", "enabled", "id", "index", "metadata", "name", "type"]}, "IntegrationAclRulePageDto": {"properties": {"offset": {"type": "integer", "format": "int64", "example": 0}, "limit": {"type": "integer", "format": "int32", "example": 25}, "count": {"type": "integer", "format": "int32", "example": 10}, "totalCount": {"type": "integer", "format": "int64", "example": 1000}, "data": {"type": "array", "items": {"discriminator": {"propertyName": "type", "mapping": {"IPV4": "#/components/schemas/IntegrationIpAclRuleDto", "MAC": "#/components/schemas/IntegrationMacAclRuleDto"}}, "properties": {"type": {"type": "string"}, "id": {"type": "string", "format": "uuid"}, "enabled": {"type": "boolean", "example": true}, "name": {"type": "string", "description": "ACL rule name"}, "description": {"type": "string", "description": "ACL rule description"}, "action": {"type": "string", "description": "ACL rule action", "enum": ["ALLOW", "BLOCK"], "example": "ALLOW|BLOCK"}, "enforcingDeviceFilter": {"description": "IDs of the Switch-capable devices used to enforce the ACL rule. When null, the rule will be provisioned to all switches on the site.", "discriminator": {"propertyName": "type", "mapping": {"DEVICES": "#/components/schemas/IntegrationAclRuleDevicesFilterDto"}}, "properties": {"type": {"type": "string"}}, "required": ["type"], "title": "ACL rule device filter"}, "index": {"type": "integer", "format": "int32", "description": "ACL rule index. Lower index has higher priority", "minimum": 0}, "sourceFilter": {"description": "Traffic source filter"}, "destinationFilter": {"description": "Traffic destination filter"}, "metadata": {"description": "Only user-defined rules can be deleted or modified", "discriminator": {"propertyName": "origin", "mapping": {"USER_DEFINED": "#/components/schemas/User defined entity metadata", "SYSTEM_DEFINED": "#/components/schemas/System defined entity metadata", "DERIVED": "#/components/schemas/Derived entity metadata", "ORCHESTRATED": "#/components/schemas/Orchestrated entity metadata"}}, "properties": {"origin": {"type": "string"}}, "required": ["origin"], "title": "Entity metadata"}}, "required": ["action", "enabled", "id", "index", "metadata", "name", "type"], "title": "ACL ruleObject"}}}, "required": ["count", "data", "limit", "offset", "totalCount"]}, "Device pending adoption": {"properties": {"macAddress": {"type": "string", "example": "94:2a:6f:26:c6:ca"}, "ipAddress": {"type": "string", "example": "192.168.1.55"}, "model": {"type": "string", "example": "UHDIW"}, "state": {"type": "string", "enum": ["ONLINE", "OFFLINE", "PENDING_ADOPTION", "UPDATING", "GETTING_READY", "ADOPTING", "DELETING", "CONNECTION_INTERRUPTED", "ISOLATED", "U5G_INCORRECT_TOPOLOGY"]}, "supported": {"type": "boolean"}, "firmwareVersion": {"type": "string", "example": "6.6.55"}, "firmwareUpdatable": {"type": "boolean"}, "features": {"type": "array", "items": {"type": "string", "enum": ["switching", "accessPoint", "gateway"]}, "uniqueItems": true}}, "required": ["features", "firmwareUpdatable", "ipAddress", "macAddress", "model", "state", "supported"]}, "Device pending adoption page": {"properties": {"offset": {"type": "integer", "format": "int64", "example": 0}, "limit": {"type": "integer", "format": "int32", "example": 25}, "count": {"type": "integer", "format": "int32", "example": 10}, "totalCount": {"type": "integer", "format": "int64", "example": 1000}, "data": {"type": "array", "items": {"properties": {"macAddress": {"type": "string", "example": "94:2a:6f:26:c6:ca"}, "ipAddress": {"type": "string", "example": "192.168.1.55"}, "model": {"type": "string", "example": "UHDIW"}, "state": {"type": "string", "enum": ["ONLINE", "OFFLINE", "PENDING_ADOPTION", "UPDATING", "GETTING_READY", "ADOPTING", "DELETING", "CONNECTION_INTERRUPTED", "ISOLATED", "U5G_INCORRECT_TOPOLOGY"]}, "supported": {"type": "boolean"}, "firmwareVersion": {"type": "string", "example": "6.6.55"}, "firmwareUpdatable": {"type": "boolean"}, "features": {"type": "array", "items": {"type": "string", "enum": ["switching", "accessPoint", "gateway"]}, "uniqueItems": true}}, "required": ["features", "firmwareUpdatable", "ipAddress", "macAddress", "model", "state", "supported"], "title": "Device pending adoption"}}}, "required": ["count", "data", "limit", "offset", "totalCount"]}, "Application info": {"properties": {"applicationVersion": {"type": "string", "example": "9.1.0"}}, "required": ["applicationVersion"]}, "DPI category": {"properties": {"id": {"type": "integer", "format": "int32", "example": "3|5"}, "name": {"type": "string", "example": "Network protocols|Business tools"}}, "required": ["id", "name"]}, "DPI category page": {"properties": {"offset": {"type": "integer", "format": "int64", "example": 0}, "limit": {"type": "integer", "format": "int32", "example": 25}, "count": {"type": "integer", "format": "int32", "example": 10}, "totalCount": {"type": "integer", "format": "int64", "example": 1000}, "data": {"type": "array", "items": {"properties": {"id": {"type": "integer", "format": "int32", "example": "3|5"}, "name": {"type": "string", "example": "Network protocols|Business tools"}}, "required": ["id", "name"], "title": "DPI category"}}}, "required": ["count", "data", "limit", "offset", "totalCount"]}, "DPI application": {"properties": {"id": {"type": "integer", "format": "int32", "example": "786435|720973"}, "name": {"type": "string", "example": "Adobe Express|Zoom"}}, "required": ["id", "name"]}, "DPI application page": {"properties": {"offset": {"type": "integer", "format": "int64", "example": 0}, "limit": {"type": "integer", "format": "int32", "example": 25}, "count": {"type": "integer", "format": "int32", "example": 10}, "totalCount": {"type": "integer", "format": "int64", "example": 1000}, "data": {"type": "array", "items": {"properties": {"id": {"type": "integer", "format": "int32", "example": "786435|720973"}, "name": {"type": "string", "example": "Adobe Express|Zoom"}}, "required": ["id", "name"], "title": "DPI application"}}}, "required": ["count", "data", "limit", "offset", "totalCount"]}, "Country Definition": {"properties": {"code": {"type": "string", "description": "The country code in ISO 3166-1 alpha-2 format.", "example": "CK|FK|KY"}, "name": {"type": "string", "description": "The country name.", "example": "Cook Islands|Falkland Islands, Malvinas|Cayman Islands"}}, "required": ["code", "name"]}, "Country definition page": {"properties": {"offset": {"type": "integer", "format": "int64", "example": 0}, "limit": {"type": "integer", "format": "int32", "example": 25}, "count": {"type": "integer", "format": "int32", "example": 10}, "totalCount": {"type": "integer", "format": "int64", "example": 1000}, "data": {"type": "array", "items": {"properties": {"code": {"type": "string", "description": "The country code in ISO 3166-1 alpha-2 format.", "example": "CK|FK|KY"}, "name": {"type": "string", "description": "The country name.", "example": "Cook Islands|Falkland Islands, Malvinas|Cayman Islands"}}, "required": ["code", "name"], "title": "Country Definition"}}}, "required": ["count", "data", "limit", "offset", "totalCount"]}, "Voucher deletion results": {"properties": {"vouchersDeleted": {"type": "integer", "format": "int64"}}}}}}